NeoMutt  2025-12-11-1039-g550ac6
Teaching an old dog new tricks
DOXYGEN
Loading...
Searching...
No Matches
expando.c
Go to the documentation of this file.
1
23
29
30#include "config.h"
31#include <stdbool.h>
32#include <stddef.h>
33#include "mutt/lib.h"
34#include "expando.h"
35#include "node.h"
36#include "node_container.h"
37#include "node_padding.h"
38#include "node_text.h"
39#include "parse.h"
40#include "render.h"
41
43
49struct Expando *expando_new(const char *format)
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}
56
61void expando_free(struct Expando **ptr)
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}
73
82static const struct ExpandoNode *node_find(const struct ExpandoNode *node, int did, int uid)
83{
84 if (!node)
85 return NULL;
86
87 if ((node->did == did) && (node->uid == uid))
88 return node;
89
90 struct ExpandoNode **np = NULL;
91 ARRAY_FOREACH(np, &node->children)
92 {
93 const struct ExpandoNode *match = node_find(*np, did, uid);
94 if (match)
95 return match;
96 }
97
98 return NULL;
99}
100
109const struct ExpandoNode *expando_find_node(const struct Expando *exp, int did, int uid)
110{
111 if (!exp)
112 return NULL;
113
114 return node_find(exp->node, did, uid);
115}
116
124struct Expando *expando_parse(const char *str, const struct ExpandoDefinition *defs,
125 struct Buffer *err)
126{
127 if (!str || (*str == '\0') || !defs)
128 return NULL;
129
130 struct Expando *exp = expando_new(str);
131
132 struct ExpandoParseError error = { 0 };
133
134 const char *parsed_until = NULL;
135 node_parse_many(exp->node, str, NTE_NONE, defs, &parsed_until, &error);
136
137 if (error.position)
138 {
139 buf_strcpy(err, error.message);
140 expando_free(&exp);
141 return NULL;
142 }
143
144 // Optimise the tree layout
147
148 return exp;
149}
150
161int expando_render(const struct Expando *exp, const struct ExpandoRenderCallback *erc,
162 void *data, MuttFormatFlags flags, int max_cols, struct Buffer *buf)
163{
164 if (!exp || !exp->node || !erc)
165 return 0;
166
167 // Give enough space for a long command line
168 if (max_cols == -1)
169 max_cols = 8192;
170
171 return node_render(exp->node, erc, buf, max_cols, data, flags);
172}
173
180bool expando_equal(const struct Expando *a, const struct Expando *b)
181{
182 if (!a && !b) /* both empty */
183 return true;
184 if (!a ^ !b) /* one is empty, but not the other */
185 return false;
186
187 return mutt_str_equal(a->string, b->string);
188}
#define ARRAY_FOREACH(elem, head)
Iterate over all elements of the array.
Definition array.h:223
size_t buf_strcpy(struct Buffer *buf, const char *s)
Copy a string into a Buffer.
Definition buffer.c:401
static const struct ExpandoNode * node_find(const struct ExpandoNode *node, int did, int uid)
Find a Node in a tree.
Definition expando.c:82
struct Expando * expando_new(const char *format)
Create an Expando from a string.
Definition expando.c:49
const struct ExpandoNode * expando_find_node(const struct Expando *exp, int did, int uid)
Find a Node in an Expando tree.
Definition expando.c:109
struct Expando * expando_parse(const char *str, const struct ExpandoDefinition *defs, struct Buffer *err)
Parse an Expando string.
Definition expando.c:124
void expando_free(struct Expando **ptr)
Free an Expando object.
Definition expando.c:61
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.
Definition expando.c:161
bool expando_equal(const struct Expando *a, const struct Expando *b)
Compare two expandos.
Definition expando.c:180
Parsed Expando.
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:83
Expando Parsing.
#define FREE(x)
Free memory and set the pointer to NULL.
Definition memory.h:68
#define MUTT_MEM_CALLOC(n, type)
Definition memory.h:52
Convenience wrapper for the library headers.
char * mutt_str_dup(const char *str)
Copy a string, safely.
Definition string.c:257
bool mutt_str_equal(const char *a, const char *b)
Compare two strings.
Definition string.c:666
void node_free(struct ExpandoNode **ptr)
Free an ExpandoNode and its private data.
Definition node.c:48
Basic Expando Node.
struct ExpandoNode * node_container_new(void)
Create a new Container ExpandoNode.
void node_container_collapse_all(struct ExpandoNode **ptr)
Remove unnecessary Containers.
Expando Node for a Container.
void node_padding_repad(struct ExpandoNode **ptr)
Rearrange Padding in a tree of ExpandoNodes.
Expando Node for Padding.
Expando Node for Text.
@ NTE_NONE
No flags are set.
Definition node_text.h:34
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
Render Expandos using Data.
uint8_t MuttFormatFlags
Definition render.h:45
String manipulation buffer.
Definition buffer.h:36
Definition of a format string.
Definition definition.h:49
Basic Expando Node.
Definition node.h:67
int uid
Unique ID, e.g. ED_EMA_SIZE.
Definition node.h:70
int did
Domain ID, e.g. ED_EMAIL.
Definition node.h:69
struct ExpandoNodeArray children
Children nodes.
Definition node.h:75
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
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