2 extern HashList *Conditionals;
3 extern HashList *GlobalNS;
4 extern HashList *Iterators;
5 extern HashList *WirelessTemplateCache;
6 extern HashList *WirelessLocalTemplateCache;
7 extern HashList *TemplateCache;
8 extern HashList *LocalTemplateCache;
13 #define TYPE_PREFSTR 3
14 #define TYPE_PREFINT 4
15 #define TYPE_GETTEXT 5
17 #define TYPE_SUBTEMPLATE 7
22 * \brief Values for wcs_type
25 WCS_STRING, /* its a string */
26 WCS_FUNCTION, /* its a function callback */
27 WCS_SERVCMD, /* its a command to send to the citadel server */
28 WCS_STRBUF, /* its a strbuf we own */
29 WCS_STRBUF_REF, /* its a strbuf we mustn't free */
30 WCS_LONG /* its an integer */
33 #define CTX TP->Context
34 #define CCTX TP->ControlContext
43 #define CTX_NODECONF 7
44 #define CTX_USERLIST 8
46 #define CTX_MIME_ATACH 10
47 #define CTX_FILELIST 11
49 #define CTX_LONGVECTOR 13
52 #define CTX_ITERATE 16
54 #define CTX_UNKNOWN 17
58 * ContextFilter resembles our RTTI information. With this structure
59 * we can make shure a tmplput function can live with the environment
61 * if not, we will log/print an error and refuse to call it.
63 typedef struct _contexts {
64 int ContextType; /* do we require a User Context ? */
65 int ControlContextType; /* are we inside of a control structure? */
66 int nMinArgs; /* How many arguments do we need at least? */
67 int nMaxArgs; /* up to how many arguments can we handle? */
71 /* Forward declarations... */
72 typedef struct WCTemplateToken WCTemplateToken;
73 typedef struct WCTemplputParams WCTemplputParams;
75 /* this is the signature of a tmplput function */
76 typedef void (*WCHandlerFunc)(StrBuf *Target, WCTemplputParams *TP);
78 /* make a template token a lookup key: */
79 #define TKEY(a) TP->Tokens->Params[a]->Start, TP->Tokens->Params[a]->len
81 /* TODO: wcsubst should be private! */
84 * \brief Dynamic content for variable substitution in templates
86 typedef struct _wcsubst {
88 int wcs_type; /* which type of Substitution are we */
89 char wcs_key[32]; /* copy of our hashkey for debugging */
90 StrBuf *wcs_value; /* if we're a string, keep it here */
91 long lvalue; /* type long? keep data here */
92 WCHandlerFunc wcs_function; /* funcion hook ???*/
97 * this is the signature of a conditional function
98 * Note: Target is just passed in for error messages; don't write onto it in regular cases.
100 typedef int (*WCConditionalFunc)(StrBuf *Target, WCTemplputParams *TP);
103 typedef struct _TemplateParam {
104 /* are we a string or a number? */
109 /* if we're a number: */
115 * Representation of a token; everything thats inbetween <? and >
117 struct WCTemplateToken {
118 /* Reference to the filename we're in to print error messages; not to be freed */
119 const StrBuf *FileName;
120 /* Raw copy of our original token; for error printing */
122 /* Which line did the template parser pick us up in? For error printing */
125 /* our position in the template cache buffer */
126 const char *pTokenStart;
127 /* our token length */
131 const char *pTokenEnd;
132 /* just our token name: */
136 /* stuff the pre-evaluater finds out: */
138 /* pointer to our runntime evaluator; so we can cache this and save hash-lookups */
141 /* if we have parameters here we go: */
142 /* do we have parameters or not? */
144 /* How many of them? */
147 TemplateParam *Params[MAXPARAM];
152 struct WCTemplputParams {
153 ContextFilter Filter;
155 void *ControlContext;
157 WCTemplateToken *Tokens;
162 typedef struct _ConditionalStruct {
163 ContextFilter Filter;
164 const char *PlainName;
165 WCConditionalFunc CondF;
168 /** IterateStruct TODO: SHOULD BE PRIVATE */
169 typedef struct _iteratestruct {
178 typedef void (*SubTemplFunc)(StrBuf *TemplBuffer, WCTemplputParams *TP);
179 typedef HashList *(*RetrieveHashlistFunc)(StrBuf *Target, WCTemplputParams *TP);
180 typedef void (*HashDestructorFunc) (HashList **KillMe);
183 extern WCTemplputParams NoCtx;
185 #define HAVE_PARAM(a) (TP->Tokens->nParameters > a)
192 * \Brief log an error while evaluating a token; print it to the actual template
193 * \param Target your Target Buffer to print the error message next to the log
194 * \param Type What sort of thing are we talking about? Tokens? Conditionals?
195 * \param TP grab our set of default information here
196 * \param Format for the custom error message
198 void LogTemplateError (StrBuf *Target,
201 WCTemplputParams *TP,
202 const char *Format, ...)__attribute__((__format__(__printf__,5,6)));
205 * \Brief get the actual value of a token parameter
206 * in your tmplputs or conditionals use this function to access parameters that can also be
207 * retrieved from dynamic facilities:
208 * _ -> Gettext; retrieve this token from the i18n facilities
209 * : -> lookup a setting of that name
210 * B -> bstr; an URL-Parameter
211 * = -> subtemplate; parse a template by this name, and treat its content as this tokens value
213 * \param N which token do you want to lookup?
214 * \param Value reference to the string of the token; don't free me.
215 * \param len the length of Value
217 void GetTemplateTokenString(StrBuf *Target,
218 WCTemplputParams *TP,
226 * \Brief get the actual integer value of a token parameter
227 * in your tmplputs or conditionals use this function to access parameters that can also be
228 * retrieved from dynamic facilities:
229 * _ -> Gettext; retrieve this token from the i18n facilities
230 * : -> lookup a setting of that name
231 * B -> bstr; an URL-Parameter
232 * = -> subtemplate; parse a template by this name, and treat its content as this tokens value
234 * \param N which token do you want to lookup?
235 * \param dflt default value to be retrieved if not found in preferences
236 * \returns the long value
238 long GetTemplateTokenNumber(StrBuf *Target,
239 WCTemplputParams *TP,
243 * \Brief put a token value into the template
244 * use this function to append your strings into a Template.
245 * it can escape your string according to the token at FormattypeIndex:
246 * H: de-QP and utf8-ify
247 * X: escapize for HTML
249 * \param Target the destination buffer
250 * \param TP the template token information
251 * \param Source string to append
252 * \param FormatTypeIndex which parameter contains the escaping functionality?
253 * if this token doesn't have as much parameters, plain append is done.
255 void StrBufAppendTemplate(StrBuf *Target,
256 WCTemplputParams *TP,
257 const StrBuf *Source,
258 int FormatTypeIndex);
261 #define RegisterNamespace(a, b, c, d, e) RegisterNS(a, sizeof(a)-1, b, c, d, e)
262 void RegisterNS(const char *NSName, long len,
265 WCHandlerFunc HandlerFunc,
266 int ContextRequired);
268 void RegisterConditional(const char *Name, long len,
270 WCConditionalFunc CondF,
271 int ContextRequired);
276 #define IT_FLAG_DETECT_GROUPCHANGE (1<<0)
277 #define RegisterIterator(a, b, c, d, e, f, g, h, i) RegisterITERATOR(a, sizeof(a)-1, b, c, d, e, f, g, h, i)
278 void RegisterITERATOR(const char *Name, long len, /* Our identifier */
279 int AdditionalParams, /* doe we use more parameters? */
280 HashList *StaticList, /* pointer to webcit lifetime hashlists */
281 RetrieveHashlistFunc GetHash, /* else retrieve the hashlist by calling this function */
282 SubTemplFunc DoSubTempl, /* call this function on each iteration for svput & friends */
283 HashDestructorFunc Destructor, /* use this function to shut down the hash; NULL if its a reference */
284 int ContextType, /* which context do we provide to the subtemplate? */
285 int XPectContextType, /* which context do we expct to be called in? */
293 CompareFunc RetrieveSort(WCTemplputParams *TP,
294 const char *OtherPrefix, long OtherPrefixLen,
295 const char *Default, long ldefault,
296 long DefaultDirection);
297 void RegisterSortFunc(const char *name, long len,
298 const char *prepend, long preplen,
301 CompareFunc GroupChange,
307 void dbg_print_longvector(long *LongVector);
313 #define do_template(a, b) DoTemplate(a, sizeof(a) -1, NULL, &NoCtx);
314 const StrBuf *DoTemplate(const char *templatename, long len, StrBuf *Target, WCTemplputParams *TP);
315 void url_do_template(void);
321 int CompareSubstToToken(TemplateParam *ParamToCompare, TemplateParam *ParamToLookup);
322 int CompareSubstToStrBuf(StrBuf *Compare, TemplateParam *ParamToLookup);
324 void SVPut(char *keyname, size_t keylen, int keytype, char *Data);
325 #define svput(a, b, c) SVPut(a, sizeof(a) - 1, b, c)
326 void SVPutLong(char *keyname, size_t keylen, long Data);
327 #define svputlong(a, b) SVPutLong(a, sizeof(a) - 1, b)
328 void svprintf(char *keyname, size_t keylen, int keytype, const char *format,...) __attribute__((__format__(__printf__,4,5)));
329 void SVPRINTF(char *keyname, int keytype, const char *format,...) __attribute__((__format__(__printf__,3,4)));
330 void SVCALLBACK(char *keyname, WCHandlerFunc fcn_ptr);
331 void SVCallback(char *keyname, size_t keylen, WCHandlerFunc fcn_ptr);
332 #define svcallback(a, b) SVCallback(a, sizeof(a) - 1, b)
334 void SVPUTBuf(const char *keyname, int keylen, const StrBuf *Buf, int ref);
335 #define SVPutBuf(a, b, c); SVPUTBuf(a, sizeof(a) - 1, b, c)