sample/funclist-cont-gen-test.txt

   1 #
   2 #   Copyright (C) 2022- Free Software Foundation, Inc.
   3 #
   4 #   Copying and distribution of this file, with or without modification,
   5 #   are permitted in any medium without royalty provided the copyright
   6 #   notice and this notice are preserved.
   7 #
   8 # The following contributions warranted legal paper exchanges with the
   9 # Free Software Foundation.
  10 #
  11 #
  12 # syntax: <NCATAID> [NTYPE] NNAME "NDESC"
  13 # NTYPE:
  14 # @ dir/item/cont
  15 # @ srcdir/libdir/bindir/shlibdir
  16 # # ignrdir, dir
  17 # @ item
  18 # # shitem/shbuiltin/shloadables
  19 # # shlibitem/shlibmodule/shlibbuiltin/shlibloadables
  20 # # cfile/hfile/citem/cunititem/cunit/cmodule/cmdlitem
  21 # # libcfile/libhfile/libcitem/libcunititem/libcunit/libcmodule/libcmdlitem
  22 # # libapiitem/libapiunititem/libapiunit/libapimodule/libapimdlitem
  23 # # libitfitem/libitfunititem/libitfunit/libitfmodule/libitfmdlitem
  24 # @ cont
  25 #
  26
  27 #
  28 # fundamental file gen in srcdir.
  29 #
  30     <1> [srcdir] env_testing "Testing for running environment"
  31         <1> [citem] aqstk \
  32                         "stack and queue data structure with array feature"
  33                         <-> [var] buffer "char *buffer;"
  34                         <-> [func] create "void AQStackIF_InitQueue (PAQSTACK pstAQStack, \
  35                                                                                                                 uint8 * pu8Buff, \
  36                                                                                                                 uint32 u32Size, \
  37                                                                                                                 int a)"
  38                                 this doc txt.
  39                                 this doc txt2.
  40         <2> [citem] fix_shebang_testing "Testing example for fix-shebang"
  41         <3> [citem] cmdlist "check cmd list for shlib"
  42
  43     <-> [dir] env_testing2 "Testing for running environment2"
  44
  45 <<<861874>>> [citem] aqstk "stack and queue data structure with array feature"
  46         <-> [var] buffer "char *buffer;"
  47         <-> [func] create "void AQStackIF_InitQueue (PAQSTACK pstAQStack, \
  48                                                                                                 uint8 * pu8Buff, \
  49                                                                                                 uint32 u32Size, \
  50                                                                                                 int a)"
  51
  52 <<<197686>>> [citem] fix_shebang_testing "Testing example for fix-shebang"
  53         <-> [var] buffer "char *buffer;"
  54         <-> [func] create "void AQStackIF_InitQueue (PAQSTACK pstAQStack, \
  55                                                                                                 uint8 * pu8Buff, \
  56                                                                                                 uint32 u32Size, \
  57                                                                                                 int a)"
  58
  59     <-> [libdir] env_testing3 "Testing for running environment3"
  60
  61 <<<197686>>> [citem] cmdlist "check cmd list for shlib"
  62         <-> [var] buffer "char *buffer;"
  63         <-> [func] create "void AQStackIF_InitQueue (PAQSTACK pstAQStack, \
  64                                                                                                 uint8 * pu8Buff, \
  65                                                                                                 uint32 u32Size, \
  66                                                                                                 int a)"
  67
  68 #
  69 # in different SRC_TYPE dir.
  70 #
  71     <2> [libdir] env_testing2 "Testing for running environment2"
  72         <1> [citem] fix_shebang_testing2 "Testing for fix-shebang2"
  73         <2> [citem] cmdlist2 "Checking cmd list for shlib 2"
  74
  75 #
  76 # ÔÚµ÷ÊÔÊ±£¬Ìí¼Ócmd
  77 # @ exit£¬½áÊøµ±Ç°ÎÄ¼þµÄ½âÎö¡£
  78 # @ ignore <cnt>£¬¶Ôµ±Ç°ÐÐÖ®ºóµÄcntÐÐÄÚÈÝ²»½øÐÐ½âÎö¡£
  79 # @ print [var-name-list]£¬ÔÚ½âÎöÊ±Êä³ö¶ÔÓ¦µÄ»·¾³±äÁ¿
  80 #
  81
  82 #
  83 # without id number specified.
  84 # or bring reference id
  85 #
  86     <-> [srcdir] env_testing3 "Testing for running environment3"
  87         <-> [cunit] fix_shebang_testing3 "Testing for fix-shebang3"
  88         <-> [cunit] cmdlist3 "Checking cmd list for shlib 3"
  89                 <-> [dir] test1 "test code set 1"
  90                         <-> [cunit] test_func11 "test func set 1_1"
  91                         <-> [cunit] test_func12 "test func set 1_2"
  92                 <-> [dir] test2 "test code set 2"
  93                         <-> [cunit] test_func21 "test func set 2_1"
  94                         <-> [cunit] test_func22 "test func set 2_2"
  95
  96         <-> [srcdir] LangDataType "language data type"
  97         <1> [cunit] TInteger "digital data"
  98         <-> [cunit] TFloat "float data"
  99         <-> [cunit] TString "string"
 100         <-> [cunit] TBit "bit"
 101         <-> [cunit] TBool "bool"
 102                 <-> [cunit] TVector "vector"
 103         <-> [cunit] TComplex "complex"
 104
 105                 <-> [cunit] TBitmap "bitmap"
 106         <-> [cunit] TBcd "bcd"
 107
 108                 <-> [cunit] TTexture "text data"
 109                         this doc text.
 110                         next line this doc text.
 111 ignore 7
 112
 113                 <-> [cunit] TTexture2 "text data2"
 114
 115 #
 116 # content define in catalog file is not very well.
 117 # define it in a UML file, user can edit it more easily.
 118 #
 119 <<<b3Blbn>>> [citem] aqstk "stack and queue data structure with array feature"
 120         <-> [var] buffer "char *buffer;"
 121         <-> [var] head "volatile int head;"
 122         <-> [var] tail "volatile int tail;"
 123     <-> [var] size "volatile int size;"
 124     <-> [var] count "volatile int count;"
 125     <-> [var] mutex "TMUTEX mutex;"
 126     <-> [var] mode "unsigned int mode;"
 127                 # opr bit cnt, 8/16/32/cw/str.
 128                 # queue/stack mode.
 129                 # over write data if buffer is full.
 130 exit
 131         <-> [func] create "void AQStackIF_InitQueue (PAQSTACK pstAQStack, \
 132                                                                                                 uint8 * pu8Buff, \
 133                                                                                                 uint32 u32Size)"
 134         <-> [func] destroy "void AQStackIF_Release (AQSTACK *pstAQStack)"
 135         <-> [func] initQueue "void AQStackIF_InitQueue (PAQSTACK pstAQStack, \
 136                                                                                                         uint8 * pu8Buff, \
 137                                                                                                         uint32 u32Size)"
 138         <-> [func] initStack "void AQStackIF_InitStack (AQSTACK *pstAQStack, \
 139                                                                                                         uint8 * pu8Buff, \
 140                                                                                                         uint32 u32Size)"
 141         <-> [func] clear "void AQStackIF_Clear (AQSTACK *pstAQStack)"
 142
 143         # <8/16/32/64/CW/str>
 144
 145         <-> [func] enq "bool AQStackIF_EnQueue (AQSTACK *pstAQStack, char cData)"
 146         <-> [func] deq "char AQStackIF_DeQueue (AQSTACK *pstAQStack)"
 147         <-> [func] push "bool AQStackIF_Push (AQSTACK *pstAQStack, char cData)"
 148         <-> [func] pop "char AQStackIF_Pop (AQSTACK *pstAQStack)"
 149
 150         <-> [func] headdata "char AQStackIF_GetHeadData (AQSTACK *pstAQStack)"
 151         <-> [func] taildata "char AQStackIF_GetTailData (AQSTACK *pstAQStack)"
 152
 153         <-> [func] enqn "bool AQStackIF_EnQueueN (  AQSTACK *pstAQStack, \
 154                                                                                                 char *pszBuff, \
 155                                                                                                 uint32 u32Size)"
 156         <-> [func] deqn "char * AQStackIF_DeQueueN (AQSTACK *pstAQStack, \
 157                                                                                                 char *pszBuff, \
 158                                                                                                 uint32 u32Size)"
 159         <-> [func] pushn "bool AQStackIF_PushN (AQSTACK *pstAQStack, \
 160                                                                                         char *pszBuff, \
 161                                                                                         uint32 u32Size)"
 162         <-> [func] popn "char * AQStackIF_PopN (AQSTACK *pstAQStack, \
 163                                                                                         char *pszBuff, \
 164                                                                                         uint32 u32Size)"
 165
 166         <-> [func] index "char AQStackIF_Index (AQSTACK *pstAQStack, \
 167                                                                                         uint32 u32Pos)"
 168         <-> [func] validcnt "uint32 AQStackIF_ValidCnt (AQSTACK *pstAQStack)"
 169         <-> [func] blankcnt "uint32 AQStackIF_BlankCnt (AQSTACK *pstAQStack)"
 170         <-> [func] sizecnt "uint32 AQStackIF_GetBuffSize (AQSTACK *pstAQStack)"
 171
 172         <-> [func] memcpy "char * AQStackIF_MemCpy (AQSTACK *pstAQStack, \
 173                                                                                                 uint32 u32SrcOffset, \
 174                                                                                                 char *pu8DstBuff, \
 175                                                                                                 uint32 u32DstOffset, \
 176                                                                                                 uint32 u32Size)"
 177         <-> [func] amemcpy "char * AQStackIF_AMemCpy (AQSTACK *pstSrcAQStack, \
 178                                                                                                 uint32 u32SrcOffset, \
 179                                                                                                 AQSTACK *pstDstAQStack, \
 180                                                                                                 uint32 u32DstOffset, \
 181                                                                                                 uint32 u32Size)"
 182                 # memory copy from an array to an array
 183         <-> [func] memcmp "char * AQStackIF_MemCmp (AQSTACK *pstAQStack, \
 184                                                                                                 uint32 u32SrcOffset, \
 185                                                                                                 char *pu8DstBuff, \
 186                                                                                                 uint32 u32DstOffset, \
 187                                                                                                 uint32 u32Size)"
 188                 # memcmp between an array and buffer
 189         <-> [func] amemcmp "char * AQStackIF_AMemCmp (AQSTACK *pstSrcAQStack, \
 190                                                                                                 uint32 u32SrcOffset, \
 191                                                                                                 AQSTACK *pstDstAQStack, \
 192                                                                                                 uint32 u32DstOffset, \
 193                                                                                                 uint32 u32Size)"
 194                 # memcmp between an array and another array
 195
 196         <-> [func] average "uint8 AQStackIF_Average (AQSTACK *pstAQStack)"
 197         <-> [func] chksum "uint16 AQStackIF_CheckSum (AQSTACK *pstAQStack)"
 198         <-> [func] addsum "uint8 AQStackIF_Average (AQSTACK *pstAQStack)"
 199         <-> [func] isempty "bool AQStackIF_IsEmpty (AQSTACK *pstAQStack)"
 200         <-> [func] isfull "bool AQStackIF_IsFull (AQSTACK *pstAQStack)"
 201