NeoMutt  2024-11-14-138-ge5ca67
Teaching an old dog new tricks
DOXYGEN
Loading...
Searching...
No Matches
expando.h File Reference

Parsed Expando. More...

#include <stdbool.h>
#include "render.h"
+ Include dependency graph for expando.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  Expando
 Parsed Expando trees. More...
 

Functions

void expando_free (struct Expando **ptr)
 Free an Expando object.
 
struct Expandoexpando_new (const char *format)
 Create an Expando from a string.
 
bool expando_equal (const struct Expando *a, const struct Expando *b)
 Compare two expandos.
 
struct Expandoexpando_parse (const char *str, const struct ExpandoDefinition *defs, struct Buffer *err)
 Parse an Expando string.
 
int expando_render (const struct Expando *exp, const struct ExpandoRenderCallback *erc, void *data, MuttFormatFlags flags, int max_cols, struct Buffer *buf)
 Render an Expando + data into a string.
 

Detailed Description

Parsed Expando.

Authors
  • Tóth János
  • Richard Russon

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

Definition in file expando.h.

Function Documentation

◆ expando_free()

void expando_free ( struct Expando **  ptr)

Free an Expando object.

Parameters
[out]ptrExpando to free

Definition at line 61 of file expando.c.

62{
63 if (!ptr || !*ptr)
64 return;
65
66 struct Expando *exp = *ptr;
67
68 node_free(&exp->node);
69 FREE(&exp->string);
70
71 FREE(ptr);
72}
#define FREE(x)
Definition: memory.h:55
void node_free(struct ExpandoNode **ptr)
Free an ExpandoNode and its private data.
Definition: node.c:48
Parsed Expando trees.
Definition: expando.h:41
struct ExpandoNode * node
Parsed tree.
Definition: expando.h:43
const char * string
Pointer to the parsed string.
Definition: expando.h:42
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ expando_new()

struct Expando * expando_new ( const char *  format)

Create an Expando from a string.

Parameters
formatFormat string to parse
Return values
ptrNew Expando object

Definition at line 49 of file expando.c.

50{
51 struct Expando *exp = MUTT_MEM_CALLOC(1, struct Expando);
52 exp->string = mutt_str_dup(format);
53 exp->node = node_container_new();
54 return exp;
55}
#define MUTT_MEM_CALLOC(n, type)
Definition: memory.h:40
char * mutt_str_dup(const char *str)
Copy a string, safely.
Definition: string.c:253
struct ExpandoNode * node_container_new(void)
Create a new Container ExpandoNode.
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ expando_equal()

bool expando_equal ( const struct Expando a,
const struct Expando b 
)

Compare two expandos.

Parameters
aFirst Expando
bSecond Expando
Return values
trueThey are identical

Definition at line 137 of file expando.c.

138{
139 if (!a && !b) /* both empty */
140 return true;
141 if (!a ^ !b) /* one is empty, but not the other */
142 return false;
143
144 return mutt_str_equal(a->string, b->string);
145}
bool mutt_str_equal(const char *a, const char *b)
Compare two strings.
Definition: string.c:660
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ expando_parse()

struct Expando * expando_parse ( const char *  str,
const struct ExpandoDefinition defs,
struct Buffer err 
)

Parse an Expando string.

Parameters
strString to parse
defsData defining Expando
errBuffer for error messages
Return values
ptrNew Expando

Definition at line 81 of file expando.c.

83{
84 if (!str || (*str == '\0') || !defs)
85 return NULL;
86
87 struct Expando *exp = expando_new(str);
88
89 struct ExpandoParseError error = { 0 };
90
91 const char *parsed_until = NULL;
92 node_parse_many(exp->node, str, NTE_NO_FLAGS, defs, &parsed_until, &error);
93
94 if (error.position)
95 {
96 buf_strcpy(err, error.message);
97 expando_free(&exp);
98 return NULL;
99 }
100
101 // Optimise the tree layout
104
105 return exp;
106}
size_t buf_strcpy(struct Buffer *buf, const char *s)
Copy a string into a Buffer.
Definition: buffer.c:395
struct Expando * expando_new(const char *format)
Create an Expando from a string.
Definition: expando.c:49
void expando_free(struct Expando **ptr)
Free an Expando object.
Definition: expando.c:61
bool node_parse_many(struct ExpandoNode *node_cont, const char *str, NodeTextTermFlags term_chars, const struct ExpandoDefinition *defs, const char **parsed_until, struct ExpandoParseError *err)
Parse a format string.
Definition: parse.c:81
void node_container_collapse_all(struct ExpandoNode **ptr)
Remove unnecessary Containers.
void node_padding_repad(struct ExpandoNode **ptr)
Rearrange Padding in a tree of ExpandoNodes.
Definition: node_padding.c:291
#define NTE_NO_FLAGS
No flags are set.
Definition: node_text.h:33
Buffer for parsing errors.
Definition: parse.h:37
char message[1024]
Error message.
Definition: parse.h:38
const char * position
Position of error in original string.
Definition: parse.h:39
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ expando_render()

int expando_render ( const struct Expando exp,
const struct ExpandoRenderCallback erc,
void *  data,
MuttFormatFlags  flags,
int  max_cols,
struct Buffer buf 
)

Render an Expando + data into a string.

Parameters
[in]expExpando containing the expando tree
[in]ercExpando render callback functions
[in]dataCallback data
[in]flagsCallback flags
[in]max_colsNumber of screen columns (-1 means unlimited)
[out]bufBuffer in which to save string
Return values
numNumber of bytes written to buf and screen columns used

Definition at line 118 of file expando.c.

120{
121 if (!exp || !exp->node || !erc)
122 return 0;
123
124 // Give enough space for a long command line
125 if (max_cols == -1)
126 max_cols = 8192;
127
128 return node_render(exp->node, erc, buf, max_cols, data, flags);
129}
int node_render(const struct ExpandoNode *node, const struct ExpandoRenderCallback *erc, struct Buffer *buf, int max_cols, void *data, MuttFormatFlags flags)
Render a tree of ExpandoNodes into a string.
Definition: render.c:45
+ Here is the call graph for this function:
+ Here is the caller graph for this function: