FLAMCLEP-Reference
Command Line Executor/Parser Source Reference
|
Go to the documentation of this file.
46 #define CLE_DOCTYP_COVER 1U
47 #define CLE_DOCTYP_CHAPTER 2U
48 #define CLE_DOCTYP_PROGRAM 10U
49 #define CLE_DOCTYP_PGMSYNOPSIS 11U
50 #define CLE_DOCTYP_PGMSYNTAX 12U
51 #define CLE_DOCTYP_PGMHELP 13U
52 #define CLE_DOCTYP_COMMANDS 20U
53 #define CLE_DOCTYP_OTHERCLP 21U
54 #define CLE_DOCTYP_BUILTIN 22U
55 #define CLE_DOCTYP_LEXEMES 30U
56 #define CLE_DOCTYP_GRAMMAR 31U
57 #define CLE_DOCTYP_VERSION 32U
58 #define CLE_DOCTYP_ABOUT 33U
59 #define CLE_DOCTYP_PROPREMAIN 41U
60 #define CLE_DOCTYP_PROPDEFAULTS 42U
61 #define CLE_DOCTYP_SPECIALCODES 51U
62 #define CLE_DOCTYP_REASONCODES 52U
70 #define CLE_DOCKYW_PREFACE "preface"
71 #define CLE_DOCKYW_APPENDIX "appendix"
72 #define CLE_DOCKYW_GLOSSARY "glossary"
73 #define CLE_DOCKYW_COLOPHON "colophon"
84 #define CLE_ANCHOR_BUILTIN_FUNCTIONS "CLEP.BUILTIN.FUNCTIONS"
85 #define CLE_ANCHOR_APPENDIX_ABOUT "CLEP.APPENDIX.ABOUT"
86 #define CLE_ANCHOR_APPENDIX_VERSION "CLEP.APPENDIX.VERSION"
87 #define CLE_ANCHOR_APPENDIX_LEXEMES "CLEP.APPENDIX.LEXEMES"
88 #define CLE_ANCHOR_APPENDIX_GRAMMAR "CLEP.APPENDIX.GRAMMAR"
89 #define CLE_ANCHOR_APPENDIX_RETURNCODES "CLEP.APPENDIX.RETURNCODES"
90 #define CLE_ANCHOR_APPENDIX_REASONCODES "CLEP.APPENDIX.REASONCODES"
91 #define CLE_ANCHOR_APPENDIX_PROPERTIES "CLEP.APPENDIX.PROPERTIES"
107 typedef struct CleDoc {
123 #define CLEDOC_OPN(name) TsCleDoc name[]
137 #define CLETAB_DOC(typ,lev,num,kyw,anc,hdl,man,idt) {(typ),(lev),(num),(kyw),(anc),(hdl),(man),(idt)},
142 #define CLEDOC_CLS { 0 , 0 , NULL, NULL, NULL, NULL, NULL, NULL}
178 typedef void* (
TfCleOpenPrint)(FILE* pfOut, FILE* pfErr,
const char* pcPat,
const char* pcOwn,
const char* pcPgm,
const char* pcBld,
int* piHdr,
int* piAnc,
int* piIdt,
int* piPat,
int* psPs1,
int* piPs2,
int* piPr3);
365 typedef const char* (
TfMsg)(
const int siRsn);
406 #define CLECMD_OPN(name) TsCleCommand name[]
429 #define CLETAB_CMD(kyw,tab,clp,par,oid,ini,map,run,fin,flg,man,hlp) {(kyw),(tab),(clp),(par),(oid),(ini),(map),(run),(fin),(flg),(man),(hlp)},
434 #define CLECMD_CLS { NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, 0 , NULL, NULL}
467 #define CLEOTH_OPN(name) TsCleOtherClp name[]
483 #define CLETAB_OTH(rot,kyw,tab,man,hlp,ovl) {(rot),(kyw),(tab),(man),(hlp),(ovl)},
489 #define CLEOTH_CLS { NULL, NULL, NULL, NULL, NULL, 0}
const char * pcKyw
Pointer to the key word for this command (:alpha:[:alnum:|'_']*).
int() TfRun(void *pvHdl, FILE *pfOut, FILE *pfTrc, void *pvGbl, const char *pcOwn, const char *pcPgm, const char *pcVsn, const char *pcAbo, const char *pcLic, const char *pcFkt, const char *pcCmd, const char *pcLst, const void *pvPar, int *piWrn, int *piScc)
Type definition for CLE run function.
struct CleDoc TsCleDoc
CLE Structure for documentation table.
int() TfFin(FILE *pfOut, FILE *pfTrc, void *pvGbl, void *pvPar)
Type definition for the CLE fin function.
const char * pcKyw
Pointer to the key word for this string (:alpha:[:alnum:|'_']*).
unsigned int uiLev
The level of the chapter in the document (cover page is 1 all other chapter > 1).
int * piOid
Pointer to the object identifier for overlay commands (filled up by the parser, see siCleExecute()).
int() TfCleClosePrint(void *pvHdl)
Function 'clsHtmlDoc' of library 'libhtmldoc' called if built-in function HTMLDOC used.
const char * pcHlp
String for a short context sensitive help to this command (converted on EBCDIC systems).
const char * pcMan
Pointer to a null-terminated string for a detailed description of this command (in ASCIDOC format,...
int() TfIni(void *pvHdl, FILE *pfOut, FILE *pfTrc, void *pvGbl, const char *pcOwn, const char *pcPgm, void *pvClp)
Type definition for initialization FLAMCLE command structure.
TfRun * pfRun
Pointer to the executed function (use the mapped parameter structure to execute the command....
Table structure for arguments.
const char * pcNum
String for numbering or NULL for no number prefix.
CLE structure for command table.
struct CleOtherClp TsCleOtherClp
CLE table structure for other CLP strings.
unsigned int uiTyp
One of the documentation types above.
void * pvPar
Pointer to the corresponding parameter structure (filled up by the mapping function).
TfFin * pfFin
Pointer to the finish function for cleanup (free memory, close files in parameter structure).
struct CleCommand TsCleCommand
CLE structure for command table.
const char *() TfMsg(const int siRsn)
Type definition for the CLE message function.
const char * pcMan
Optional or required manual page with the content of this chapter).
const char * pcIdt
Optional new line separated list of index term for this chapter (printed at the end (indexterm:[])).
const char * pcRot
Pointer to the program/root key word for this string (:alpha:[:alnum:|'_']*).
const char * pcMan
Pointer to a null-terminated string for a detailed description for this CLP string (in ASCIDOC format...
int() TfMap(void *pvHdl, FILE *pfOut, FILE *pfTrc, void *pvGbl, int *piOid, void *pvClp, void *pvPar)
Type definition for mapping parsed values from the FLAMCLP structure.
CLE table structure for other CLP strings.
TfIni * pfIni
Pointer to the initialization function (initialize the argument structure in front of parsing).
const char * pcHdl
Headline for this chapter.
TfMap * pfMap
Pointer to the mapping function (transfers the argument structure to the parameter structure).
const char * pcAnc
Optional anchor for this chapter (printed in front of headline in double square brackets).
Definitions for Command Line Parsing.
const TsClpArgument * psTab
Pointer to the main argument table for this command (defines the semantic for the parser).
void * pvClp
Pointer to the corresponding argument structure (filled up by the parser).
const int isOvl
True if provided table must be interpreted as overlay else as object.
const char * pcHlp
String for a short context sensitive help for this CLP string (converted on EBCDIC systems).
const TsClpArgument * psTab
Pointer to the main argument table for this command (defines the semantic for the parser).
int siFlg
Flag to indicate a hidden (==0) or visible (!=0) command. For correct numbering, put hidden commands ...
const char * pcKyw
Optional ASCIIDOC key word (printed in front of headline in single square brackets).
void *() TfCleOpenPrint(FILE *pfOut, FILE *pfErr, const char *pcPat, const char *pcOwn, const char *pcPgm, const char *pcBld, int *piHdr, int *piAnc, int *piIdt, int *piPat, int *psPs1, int *piPs2, int *piPr3)
Function 'opnHtmlDoc' of library 'libhtmldoc' called if built-in function HTMLDOC used.