X-Git-Url: https://code.citadel.org/?a=blobdiff_plain;f=webcit%2Fsubst.h;h=063f46d211e0883fe2be28a773943f4fd83b661a;hb=HEAD;hp=b44b33a5217061a3a01a8753d3d1a748a46d2070;hpb=652b652cad9114c63dc064cb208d926bd403ca7a;p=citadel.git diff --git a/webcit/subst.h b/webcit/subst.h index b44b33a52..063f46d21 100644 --- a/webcit/subst.h +++ b/webcit/subst.h @@ -1,5 +1,15 @@ -/** - * @defgroup subst Template processing functions +/* + * Copyright (c) 1996-2013 by the citadel.org team + * + * This program is open source software. You can redistribute it and/or + * modify it under the terms of the GNU General Public License, version 3. + * + * 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. + * + * subst template processing functions */ extern HashList *Conditionals; @@ -14,11 +24,12 @@ extern HashList *LocalTemplateCache; #define TYPE_STR 1 #define TYPE_LONG 2 #define TYPE_PREFSTR 3 -#define TYPE_PREFINT 4 -#define TYPE_GETTEXT 5 -#define TYPE_BSTR 6 -#define TYPE_SUBTEMPLATE 7 -#define TYPE_INTDEFINE 8 +#define TYPE_ROOMPREFSTR 4 +#define TYPE_PREFINT 5 +#define TYPE_GETTEXT 6 +#define TYPE_BSTR 7 +#define TYPE_SUBTEMPLATE 8 +#define TYPE_INTDEFINE 9 #define MAXPARAM 25 #define IS_NUMBER(a) ((a == TYPE_LONG) || (a == TYPE_PREFINT) || (a == TYPE_INTDEFINE)) @@ -35,39 +46,21 @@ enum { WCS_LONG /* its an integer */ }; -#define CTX TP->Context -#define CCTX TP->ControlContext - #define CTX_NONE 0 -#define CTX_SITECFG 1 -#define CTX_SESSION 2 -#define CTX_INETCFG 3 -#define CTX_VNOTE 4 -#define CTX_WHO 5 -#define CTX_PREF 6 -#define CTX_NODECONF 7 -#define CTX_USERLIST 8 -#define CTX_MAILSUM 9 -#define CTX_MIME_ATACH 10 -#define CTX_FILELIST 11 -#define CTX_STRBUF 12 -#define CTX_STRBUFARR 13 -#define CTX_LONGVECTOR 14 -#define CTX_ROOMS 15 -#define CTX_FLOORS 16 -#define CTX_ITERATE 17 -#define CTX_ICAL 18 -#define CTX_DAVNS 19 -#define CTX_TAB 20 -#define CTX_VCARD 21 -#define CTX_SIEVELIST 22 -#define CTX_SIEVESCRIPT 23 -#define CTX_MAILQITEM 24 -#define CTX_MAILQ_RCPT 25 -#define CTX_SRVLOG 26 - -#define CTX_UNKNOWN 27 +typedef int CtxType; +typedef struct __CtxTypeStruct { + CtxType Type; + StrBuf *Name; +} CtxTypeStruct; + +CtxTypeStruct *GetContextType(CtxType Type); +void RegisterContextType(const char *name, long len, CtxType *TheCtx); +#define RegisterCTX(a) RegisterContextType(#a, sizeof(#a) - 1, &a) + +extern CtxType CTX_STRBUF; +extern CtxType CTX_STRBUFARR; +extern CtxType CTX_LONGVECTOR; /** * @ingroup subst @@ -77,8 +70,7 @@ enum { * if not, we will log/print an error and refuse to call it. */ typedef struct _contexts { - int ContextType; /* do we require a User Context ? */ - int ControlContextType; /* are we inside of a control structure? */ + CtxType ContextType; /* do we require a User Context ? */ int nMinArgs; /* How many arguments do we need at least? */ int nMaxArgs; /* up to how many arguments can we handle? */ } ContextFilter; @@ -97,6 +89,9 @@ typedef int (*WCPreevalFunc)(WCTemplateToken *Token); /* make a template token a lookup key: */ #define TKEY(a) TP->Tokens->Params[a]->Start, TP->Tokens->Params[a]->len +void *GetContextPayload(WCTemplputParams *TP, CtxType ContextType); +#define CTX(a) GetContextPayload(TP, a) + /** * @ingroup subst * this is the signature of a conditional function @@ -165,9 +160,11 @@ struct WCTemplateToken { struct WCTemplputParams { ContextFilter Filter; void *Context; - void *ControlContext; int nArgs; WCTemplateToken *Tokens; + WCTemplputParams *Sub, *Super; + WCConditionalFunc ExitCtx; + long ExitCTXID; }; @@ -176,13 +173,14 @@ typedef struct _ConditionalStruct { ContextFilter Filter; const char *PlainName; WCConditionalFunc CondF; + WCConditionalFunc CondExitCtx; } ConditionalStruct; typedef void (*SubTemplFunc)(StrBuf *TemplBuffer, WCTemplputParams *TP); typedef HashList *(*RetrieveHashlistFunc)(StrBuf *Target, WCTemplputParams *TP); typedef void (*HashDestructorFunc) (HashList **KillMe); - +typedef int (*FilterByParamFunc)(const char* key, long len, void *Context, StrBuf *Target, WCTemplputParams *TP); extern WCTemplputParams NoCtx; @@ -283,6 +281,11 @@ void StrBufAppendTemplate(StrBuf *Target, const StrBuf *Source, int FormatTypeIndex); +void StrBufAppendTemplateStr(StrBuf *Target, + WCTemplputParams *TP, + const char *Source, + int FormatTypeIndex); + #define RegisterNamespace(a, b, c, d, e, f) RegisterNS(a, sizeof(a)-1, b, c, d, e, f) /** @@ -312,12 +315,21 @@ void RegisterNS(const char *NSName, long len, * @param len the token length so we don't have to measure it. * @param nParams how many parameters does your conditional need on top of the default conditional parameters * @param CondF your Callback to be called when the template is evaluated at runtime; return 0 or 1 to us please. + * @param ExitCtxCond if non-NULL, will be called after the area of the conditional is left behind. * @param ContextRequired if your token requires a specific context, else say CTX_NONE here. */ -void RegisterConditional(const char *Name, long len, - int nParams, - WCConditionalFunc CondF, - int ContextRequired); +void RegisterContextConditional(const char *Name, long len, + int nParams, + WCConditionalFunc CondF, + WCConditionalFunc ExitCtxCond, + int ContextRequired); + +#define RegisterCtxConditional(Name, nParams, CondF, ExitCtxCond, ContextRequired) \ + RegisterContextConditional(Name, sizeof(Name) -1, nParams, CondF, ExitCtxCond, ContextRequired) + +#define RegisterConditional(Name, nParams, CondF, ContextRequired) \ + RegisterContextConditional(Name, sizeof(Name) -1, nParams, CondF, NULL, ContextRequired) + /** * @ingroup subst @@ -350,19 +362,36 @@ long GetTokenDefine(const char *Name, #define IT_NOFLAG 0 #define IT_FLAG_DETECT_GROUPCHANGE (1<<0) -#define RegisterIterator(a, b, c, d, e, f, g, h, i) RegisterITERATOR(a, sizeof(a)-1, b, c, d, e, f, g, h, i) +#define IT_ADDT_PARAM(n) 5 + n /* If you have AdditionalParams, use this macro to fetch them. */ +#define RegisterIterator(a, b, c, d, e, f, g, h, i) RegisterITERATOR(a, sizeof(a)-1, b, c, d, e, f, NULL, g, h, i) +#define RegisterFilteredIterator(a, b, c, d, e, f, g, h, i, j) RegisterITERATOR(a, sizeof(a)-1, b, c, d, e, f, g, h, i, j) void RegisterITERATOR(const char *Name, long len, /* Our identifier */ - int AdditionalParams, /* doe we use more parameters? */ + int AdditionalParams, /* do we use more parameters? */ HashList *StaticList, /* pointer to webcit lifetime hashlists */ RetrieveHashlistFunc GetHash, /* else retrieve the hashlist by calling this function */ SubTemplFunc DoSubTempl, /* call this function on each iteration for svput & friends */ HashDestructorFunc Destructor, /* use this function to shut down the hash; NULL if its a reference */ - int ContextType, /* which context do we provide to the subtemplate? */ - int XPectContextType, /* which context do we expct to be called in? */ + FilterByParamFunc Filter, /* use this function if you want to skip items */ + CtxType ContextType, /* which context do we provide to the subtemplate? */ + CtxType XPectContextType, /* which context do we expct to be called in? */ int Flags); +void StackDynamicContext(WCTemplputParams *Super, + WCTemplputParams *Sub, + void *Context, + CtxType ContextType, + int nArgs, + WCTemplateToken *Tokens, + WCConditionalFunc ExitCtx, + long ExitCTXID); + +#define StackContext(Super, Sub, Context, ContextType, nArgs, Tokens) \ + StackDynamicContext(Super, Sub, Context, ContextType, nArgs, Tokens, NULL, 0) + + +void UnStackContext(WCTemplputParams *Sub); @@ -375,7 +404,7 @@ void RegisterSortFunc(const char *name, long len, CompareFunc Forward, CompareFunc Reverse, CompareFunc GroupChange, - long ContextType); + CtxType ContextType); void dbg_print_longvector(long *LongVector);