src/config/lxrgmr-code/token/cmnt.var

   1
   2 /*
   3  * cmnt:
   4  * comment equal to normal text string. but in some application, it defines
   5  * reserved-word in it, and is used for api-doc.
   6  */
   7
   8 /**
   9  ** prefix char.
  10  **/
  11 const struct token_id cmnt_pfx_char_array[] = {
  12         /* doxygen uses '\' or '@' for reserved-word prefix */
  13         { .chars={"@"},                         "T_AT",                         STATE_CODE,                     T_AT,                   TF_PFX,                 NULL },
  14         { .chars={"\\"},                        "T_BACKSLASH",          STATE_CODE,                     T_BACKSLASH,    TF_PFX,                 NULL },
  15
  16         { .chars={"::"},                        "T_DCOLON",             STATE_CODE,                     T_DCOLON,       TF_PFX,                 NULL },
  17         { .chars={":"},                 "T_COLON",              STATE_CODE,                     T_COLON,        TF_PFX,                 NULL },
  18         { {NULL},                                       NULL,                           0,                                      0,                              0,                              NULL },
  19 };
  20
  21 int on_dollar_proc (int evt, int token, register const char *str, register unsigned int len, SRC_FILE_DESC *psrcfile);
  22
  23 int on_ext_cmnt (int evt, int token, register const char *str, register unsigned int len, SRC_FILE_DESC *psrcfile);
  24 int on_c89_cmnt (int evt, int token, register const char *str, register unsigned int len, SRC_FILE_DESC *psrcfile);
  25
  26 /*
  27  * eg: (), it is used in sh-script in those kinds.
  28  * @ $(), sub-script. it seperate $ and (). $ is a pfx char, it set 'dollar' flags,
  29  * @ (), sub-script. if '(' is detected, it check 'dollar' flags to entering $() sub-script state.
  30  *   if no 'dollar' flags, it checks if it is first token in curr statement.
  31  * @ func(), function parameter.
  32  *
  33  */
  34 const struct token_id cmnt_paired_char_array[] = {
  35         /* in comment, comment tag is used. */
  36         { {"<>"},                               "T_CMNT_LTAG",                  STATE_CODE,                     T_CMNT_LTAG,            TF_OPCHAR,              on_ext_cmnt },
  37
  38         { {NULL},                               NULL,                                   0,                                      0,                              0,                              NULL },
  39 };
  40
  41 /**
  42  ** calc-expr opr char.
  43  **/
  44 const struct token_id cmnt_opr_char_array[] = {
  45
  46         { {NULL},                               NULL,                                   0,                                      0,                              0,                      NULL },
  47 };
  48
  49 /**
  50  ** reserved-word.
  51  **/
  52 const struct token_id cmnt_token_id_array[] = {
  53         /* use string instead of {}, if string longer then 3 char. */
  54         { "var",                                "T_TAG_VAR",                    STATE_CODE,                     T_TAG_VAR,              STATE_CODE,             NULL },
  55         { "file",                               "T_TAG_FILE",                   STATE_CODE,                     T_TAG_FILE,             STATE_CODE,             NULL },
  56         { "func",                               "T_TAG_FUNC",                           STATE_CODE,                     T_TAG_FUNC,             TF_COMMAND },
  57         { "brief",                              "T_TAG_BRIEF",                          STATE_CODE,                     T_TAG_BRIEF,                    TF_COMMAND },
  58         { "param",                              "T_TAG_PARAM",                          STATE_CODE,                     T_TAG_PARAM,                    TF_COMMAND },
  59         { "return",                             "T_TAG_RETURN",                         STATE_CODE,                     T_TAG_RETURN,                   TF_COMMAND },
  60         { "retval",                             "T_TAG_RETVAL",                         STATE_CODE,                     T_TAG_RETVAL,                   TF_COMMAND },
  61         { "note",                               "T_TAG_NOTE",                           STATE_CODE,                     T_TAG_NOTE,                     TF_COMMAND },
  62         { "error",                              "T_TAG_ERROR",                          STATE_CODE,                     T_TAG_ERROR,                    TF_COMMAND },
  63         { "tag",                                "T_TAG_TAG",                            STATE_CODE,                     T_TAG_TAG,                      TF_COMMAND },
  64         { "section",                    "T_TAG_SECTION",                                STATE_CODE,                     T_TAG_SECTION,                  TF_COMMAND },
  65
  66         { NULL,                                 NULL,                                   0,                                      0,                              0 },
  67 };
  68