FLAMCLE/P-API
Command Line Executor/Parser Application Programming Interface
|
Go to the documentation of this file.
48 # define __BUILDNR__ 0
51 # define __BUILD__ "RELEASE"
54 # define __BUILD__ "DEBUG"
57 # define __BUILD__ "UNKNOWN"
61 # include <inttypes.h>
105 #define CLPERR_LEX -1
106 #define CLPERR_SYN -2
107 #define CLPERR_SEM -3
108 #define CLPERR_TYP -4
109 #define CLPERR_TAB -5
110 #define CLPERR_SIZ -6
111 #define CLPERR_PAR -7
112 #define CLPERR_MEM -8
113 #define CLPERR_INT -9
114 #define CLPERR_SYS -10
115 #define CLPERR_AUT -11
116 #define CLPSRC_CMD ":command line:"
117 #define CLPSRC_PRO ":property list:"
118 #define CLPSRC_DEF ":default value:"
119 #define CLPSRC_ENV ":environment variable:"
120 #define CLPSRC_PRF ":property file:"
121 #define CLPSRC_CMF ":command file:"
122 #define CLPSRC_PAF ":parameter file:"
123 #define CLPSRC_SRF ":string file:"
133 typedef struct ClpError {
153 #define CLPTYP_SWITCH 1
154 #define CLPTYP_NUMBER 2
155 #define CLPTYP_FLOATN 3
156 #define CLPTYP_STRING 4
157 #define CLPTYP_OBJECT 5
158 #define CLPTYP_OVRLAY 6
159 #define CLPTYP_XALIAS -1
167 #define CLPCLS_MTD_ALL 1
168 #define CLPCLS_MTD_KEP 0
169 #define CLPCLS_MTD_EXC 2
177 #define CLPPRO_MTD_ALL 0
178 #define CLPPRO_MTD_SET 1
179 #define CLPPRO_MTD_CMT 2
180 #define CLPPRO_MTD_DOC 3
188 #define CLPFLG_NON 0x00000000U
189 #define CLPFLG_ALI 0x00000001U
190 #define CLPFLG_CON 0x00000002U
191 #define CLPFLG_CMD 0x00000004U
192 #define CLPFLG_PRO 0x00000008U
193 #define CLPFLG_SEL 0x00000010U
194 #define CLPFLG_FIX 0x00000020U
195 #define CLPFLG_BIN 0x00000040U
196 #define CLPFLG_DMY 0x00000080U
197 #define CLPFLG_CNT 0x00000100U
198 #define CLPFLG_OID 0x00000200U
199 #define CLPFLG_IND 0x00000400U
200 #define CLPFLG_HID 0x00000800U
201 #define CLPFLG_ELN 0x00001000U
202 #define CLPFLG_SLN 0x00002000U
203 #define CLPFLG_TLN 0x00004000U
204 #define CLPFLG_DEF 0x00010000U
205 #define CLPFLG_CHR 0x00020000U
206 #define CLPFLG_ASC 0x00040000U
207 #define CLPFLG_EBC 0x00080000U
208 #define CLPFLG_HEX 0x00100000U
209 #define CLPFLG_PDF 0x00200000U
210 #define CLPFLG_TIM 0x00400000U
211 #define CLPFLG_DYN 0x00800000U
212 #define CLPFLG_PWD 0x01000000U
213 #define CLPFLG_DLM 0x02000000U
214 #define CLPFLG_UNS 0x04000000U
215 #define CLPFLG_XML 0x08000000U
216 #define CLPFLG_FIL 0x10000000U
217 #define CLPFLG_LAB 0x20000000U
218 #define CLPFLG_UPP 0x40000000U
219 #define CLPFLG_LOW 0x80000000U
271 typedef struct ClpArgument {
324 signed long long int siVal;
326 const unsigned char* pcVal;
336 #define CLPCONTAB_OPN(name) TsClpArgument name[]
351 #define CLPCONTAB_NUMBER(kyw,dat,man,hlp) {CLPTYP_NUMBER,(kyw),NULL,0,0, 0 ,0,0,CLPFLG_CON ,NULL,NULL,(man),(hlp),(dat), 0.0 ,NULL ,NULL},
365 #define CLPCONTAB_FLOATN(kyw,dat,man,hlp) {CLPTYP_FLOATN,(kyw),NULL,0,0, 0 ,0,0,CLPFLG_CON ,NULL,NULL,(man),(hlp), 0 ,(dat),NULL ,NULL},
379 #define CLPCONTAB_STRING(kyw,dat,man,hlp) {CLPTYP_STRING,(kyw),NULL,0,0, 0 ,0,0,CLPFLG_CON ,NULL,NULL,(man),(hlp), 0 , 0.0 ,(U08*)(dat),NULL},
393 #define CLPCONTAB_HEXSTR(kyw,dat,man,hlp) {CLPTYP_STRING,(kyw),NULL,0,0, 0 ,0,0,CLPFLG_CON|CLPFLG_HEX,NULL,NULL,(man),(hlp), 0 , 0.0 ,(U08*)(dat),NULL},
407 #define CLPCONTAB_ASCSTR(kyw,dat,man,hlp) {CLPTYP_STRING,(kyw),NULL,0,0, 0 ,0,0,CLPFLG_CON|CLPFLG_ASC,NULL,NULL,(man),(hlp), 0 , 0.0 ,(U08*)(dat),NULL},
421 #define CLPCONTAB_EBCSTR(kyw,dat,man,hlp) {CLPTYP_STRING,(kyw),NULL,0,0, 0 ,0,0,CLPFLG_CON|CLPFLG_EBC,NULL,NULL,(man),(hlp), 0 , 0.0 ,(U08*)(dat),NULL},
436 #define CLPCONTAB_BINARY(kyw,dat,siz,man,hlp) {CLPTYP_STRING,(kyw),NULL,0,0,(siz),0,0,CLPFLG_CON|CLPFLG_BIN,NULL,NULL,(man),(hlp), 0 , 0.0 ,(U08*)(dat),NULL},
440 #define CLPCONTAB_CLS {CLPTYP_NON , NULL,NULL,0,0, 0 ,0,0,CLPFLG_NON ,NULL,NULL, NULL, NULL, 0 , 0.0 ,NULL ,NULL}
529 #define CLPISF_ALI(flg) ((flg)&CLPFLG_ALI)
530 #define CLPISF_CON(flg) ((flg)&CLPFLG_CON)
531 #define CLPISF_CMD(flg) ((flg)&CLPFLG_CMD)
532 #define CLPISF_PRO(flg) ((flg)&CLPFLG_PRO)
533 #define CLPISF_DMY(flg) ((flg)&CLPFLG_DMY)
534 #define CLPISF_HID(flg) ((flg)&CLPFLG_HID)
535 #define CLPISF_SEL(flg) ((flg)&CLPFLG_SEL)
536 #define CLPISF_FIX(flg) ((flg)&CLPFLG_FIX)
537 #define CLPISF_BIN(flg) ((flg)&CLPFLG_BIN)
538 #define CLPISF_CNT(flg) ((flg)&CLPFLG_CNT)
539 #define CLPISF_OID(flg) ((flg)&CLPFLG_OID)
540 #define CLPISF_IND(flg) ((flg)&CLPFLG_IND)
541 #define CLPISF_ELN(flg) ((flg)&CLPFLG_ELN)
542 #define CLPISF_SLN(flg) ((flg)&CLPFLG_SLN)
543 #define CLPISF_TLN(flg) ((flg)&CLPFLG_TLN)
544 #define CLPISF_DEF(flg) ((flg)&CLPFLG_DEF)
545 #define CLPISF_PWD(flg) ((flg)&CLPFLG_PWD)
546 #define CLPISF_CHR(flg) ((flg)&CLPFLG_CHR)
547 #define CLPISF_ASC(flg) ((flg)&CLPFLG_ASC)
548 #define CLPISF_EBC(flg) ((flg)&CLPFLG_EBC)
549 #define CLPISF_HEX(flg) ((flg)&CLPFLG_HEX)
550 #define CLPISF_PDF(flg) ((flg)&CLPFLG_PDF)
551 #define CLPISF_TIM(flg) ((flg)&CLPFLG_TIM)
552 #define CLPISF_DYN(flg) ((flg)&CLPFLG_DYN)
553 #define CLPISF_DLM(flg) ((flg)&CLPFLG_DLM)
554 #define CLPISF_UNS(flg) ((flg)&CLPFLG_UNS)
555 #define CLPISF_XML(flg) ((flg)&CLPFLG_XML)
556 #define CLPISF_FIL(flg) ((flg)&CLPFLG_FIL)
557 #define CLPISF_LAB(flg) ((flg)&CLPFLG_LAB)
558 #define CLPISF_UPP(flg) ((flg)&CLPFLG_UPP)
559 #define CLPISF_LOW(flg) ((flg)&CLPFLG_LOW)
560 #define CLPISF_LNK(flg) (CLPISF_CNT(flg) || CLPISF_OID(flg) || CLPISF_IND(flg) || CLPISF_ELN(flg) || CLPISF_SLN(flg) || CLPISF_TLN(flg))
561 #define CLPISF_ARG(flg) ((!CLPISF_LNK(flg)) && (!CLPISF_CON(flg)) && (!CLPISF_ALI(flg)))
562 #define CLPISF_ENT(flg) ((!CLPISF_LNK(flg)) && (!CLPISF_ALI(flg)))
564 #define CLPSYM_NON 0x00000000U
565 #define CLPSYM_ROOT 0x00000001U
566 #define CLPSYM_OLD 0x00000002U
567 #define CLPSYM_NEXT 0x00000004U
568 #define CLPSYM_BACK 0x00000008U
569 #define CLPSYM_DEP 0x00000010U
570 #define CLPSYM_HIH 0x00000020U
571 #define CLPSYM_ALIAS 0x00000100U
572 #define CLPSYM_COUNT 0x00001000U
573 #define CLPSYM_LINK 0x00004000U
574 #define CLPSYM_OID 0x00008000U
575 #define CLPSYM_ELN 0x00002000U
576 #define CLPSYM_SLN 0x00010000U
577 #define CLPSYM_TLN 0x00020000U
579 #define CLPISS_ROOT(flg) ((flg)&CLPSYM_ROOT)
580 #define CLPISS_OLD(flg) ((flg)&CLPSYM_OLD)
581 #define CLPISS_NEXT(flg) ((flg)&CLPSYM_NEXT)
582 #define CLPISS_BACK(flg) ((flg)&CLPSYM_BACK)
583 #define CLPISS_DEP(flg) ((flg)&CLPSYM_DEP)
584 #define CLPISS_HIH(flg) ((flg)&CLPSYM_HIH)
585 #define CLPISS_ALIAS(flg) ((flg)&CLPSYM_ALIAS)
586 #define CLPISS_COUNT(flg) ((flg)&CLPSYM_COUNT)
587 #define CLPISS_ELN(flg) ((flg)&CLPSYM_ELN)
588 #define CLPISS_LINK(flg) ((flg)&CLPSYM_LINK)
589 #define CLPISS_OID(flg) ((flg)&CLPSYM_OID )
590 #define CLPISS_SLN(flg) ((flg)&CLPSYM_SLN)
591 #define CLPISS_TLN(flg) ((flg)&CLPSYM_TLN)
593 typedef struct ClpSymWlk {
610 typedef struct ClpSymUpd {
614 #endif // INC_CLPDEF_H
int siSiz
Data size If fixed size type (switch, number, float, object, overlay) then size of this type else (st...
Definition: CLPDEF.h:277
const int * piRow
Points to an integer containing the current row for the error in *pcSrc*e.
Definition: CLPDEF.h:142
const char ** ppSrc
If a parameter file assigned and cause of the error pcSrc points to this file name.
Definition: CLPDEF.h:141
const char * pcHlp
Help message.
Definition: CLPDEF.h:321
int siOfs
Data Offset Offset of an argument in a structure used for address calculation (the offset of(t,...
Definition: CLPDEF.h:280
const char * pcDft
Default value.
Definition: CLPDEF.h:301
const char * pcAli
Alias (other name for a existing parameter) Pointer to another key word to define an alias (:alpha:[:...
Definition: CLPDEF.h:274
struct ClpArgument TsClpArgument
Table structure for arguments.
int() TfF2S(void *pvGbl, void *pvHdl, const char *pcFil, char **ppBuf, int *piBuf, char *pcMsg, const int siMsg)
Type definition for string to file call back function.
Definition: CLPDEF.h:466
const int * piCol
Points to an integer containing the current column for the error in pcSrc.
Definition: CLPDEF.h:143
struct ClpError TsClpError
Defines a structure with error information.
int() TfSaf(void *pvGbl, void *pvHdl, const char *pcVal)
Type definition for resource access check.
Definition: CLPDEF.h:486
struct ClpArgument * psTab
Table for next level Pointer to another parameter table for CLPTYP_OBJECT and CLPTYP_OVRLAY describin...
Definition: CLPDEF.h:283
const char * pcMan
Manual page.
Definition: CLPDEF.h:312
const char * pcKyw
Keyword (Parameter name) Pointer to a null-terminated key word for this parameter (:alpha:[:alnum:|'_...
Definition: CLPDEF.h:273
int() TfClpPrintPage(void *pvHdl, const int siLev, const char *pcHdl, const char *pcPat, const char *pcFil, const char *pcOrg, const char *pcPge)
Function 'prnHtmlDoc' of library 'libhtmldoc' called if built-in function HTMLDOC used.
Definition: CLPDEF.h:516
int siTyp
Data type Type of this parameter (CLPTYP_xxxxxx). The type will be displayed in context sensitive hel...
Definition: CLPDEF.h:272
int siMin
Minimum amount of entries for this argument (0-optional n-required).
Definition: CLPDEF.h:275
Table structure for arguments.
Definition: CLPDEF.h:271
const char ** ppMsg
Points to the pointer of a zero-terminated string containing the current error message.
Definition: CLPDEF.h:134
int siMax
Maximum amount of entries for this argument (1-scalar n-array (n=0 unlimited array,...
Definition: CLPDEF.h:276
unsigned int uiFlg
Control Flag Flag value which can be assigned with CLPFLG_SEL/CON/FIX/CNT/SEN/ELN/TLN/OID/ALI to defi...
Definition: CLPDEF.h:282
int siOid
Object identifier Unique integer value representing the argument (object identifier,...
Definition: CLPDEF.h:281