src/cmdmapper.h

   1 /******************************************************************************
   2  *
   3  *
   4  *
   5  *
   6  * Copyright (C) 1997-2014 by Dimitri van Heesch.
   7  *
   8  * Permission to use, copy, modify, and distribute this software and its
   9  * documentation under the terms of the GNU General Public License is hereby
  10  * granted. No representations are made about the suitability of this software
  11  * for any purpose. It is provided "as is" without express or implied warranty.
  12  * See the GNU General Public License for more details.
  13  *
  14  * Documents produced by Doxygen are derivative works derived from the
  15  * input used in their production; they are not affected by this license.
  16  *
  17  */
  18
  19 #ifndef _CMDMAPPER_H
  20 #define _CMDMAPPER_H
  21
  22 #include <qdict.h>
  23
  24 struct CommandMap;
  25
  26 const int SIMPLESECT_BIT = 0x1000;
  27
  28 enum CommandType
  29 {
  30   CMD_UNKNOWN      = 0,
  31   CMD_ADDINDEX     = 1,
  32   CMD_AMP          = 2,
  33   CMD_ANCHOR       = 3,
  34   CMD_AT           = 4,
  35   CMD_ATTENTION    = 5  | SIMPLESECT_BIT,
  36   CMD_AUTHOR       = 6  | SIMPLESECT_BIT,
  37   CMD_AUTHORS      = 7  | SIMPLESECT_BIT,
  38   CMD_BOLD         = 8,
  39   CMD_BSLASH       = 9,
  40   CMD_CODE         = 10,
  41   CMD_COPYDOC      = 11,
  42   CMD_DATE         = 12 | SIMPLESECT_BIT,
  43   CMD_DOLLAR       = 13,
  44   CMD_DONTINCLUDE  = 14,
  45   CMD_DOTFILE      = 15,
  46   CMD_EMPHASIS     = 16,
  47   CMD_ENDCODE      = 17,
  48   CMD_ENDHTMLONLY  = 18,
  49   CMD_ENDLATEXONLY = 19,
  50   CMD_ENDLINK      = 20,
  51   CMD_ENDSECREFLIST= 21,
  52   CMD_ENDVERBATIM  = 22,
  53   CMD_ENDXMLONLY   = 23,
  54   CMD_EXCEPTION    = 24 | SIMPLESECT_BIT,
  55   CMD_FORMULA      = 25,
  56   CMD_GREATER      = 26,
  57   CMD_HASH         = 27,
  58   CMD_HTMLINCLUDE  = 28,
  59   CMD_HTMLONLY     = 29,
  60   CMD_IMAGE        = 30,
  61   CMD_INCLUDE      = 31,
  62   CMD_INTERNAL     = 32,
  63   CMD_INTERNALREF  = 33,
  64   CMD_INVARIANT    = 34 | SIMPLESECT_BIT ,
  65   CMD_LATEXONLY    = 35,
  66   CMD_LESS         = 36,
  67   CMD_LI           = 37,
  68   CMD_LINE         = 38,
  69   CMD_LINEBREAK    = 39,
  70   CMD_LINK         = 40,
  71   CMD_NOTE         = 41 | SIMPLESECT_BIT,
  72   CMD_PAR          = 42 | SIMPLESECT_BIT,
  73   CMD_PARAM        = 43 | SIMPLESECT_BIT,
  74   CMD_PERCENT      = 44,
  75   CMD_POST         = 45 | SIMPLESECT_BIT,
  76   CMD_PRE          = 46 | SIMPLESECT_BIT,
  77   CMD_REF          = 47,
  78   CMD_SECREFITEM   = 48,
  79   CMD_REMARK       = 49 | SIMPLESECT_BIT ,
  80   CMD_RETURN       = 50 | SIMPLESECT_BIT ,
  81   CMD_RETVAL       = 51 | SIMPLESECT_BIT,
  82   CMD_SA           = 52 | SIMPLESECT_BIT ,
  83   CMD_SECREFLIST   = 53,
  84   CMD_SECTION      = 54,
  85   CMD_SUBPAGE      = 55,
  86   CMD_SUBSECTION   = 56,
  87   CMD_SUBSUBSECTION= 57,
  88   CMD_PARAGRAPH    = 58,
  89   CMD_SINCE        = 59 | SIMPLESECT_BIT,
  90   CMD_SKIP         = 60,
  91   CMD_SKIPLINE     = 61,
  92   CMD_STARTCODE    = 62,
  93   CMD_JAVALINK     = 63,
  94   CMD_UNTIL        = 64,
  95   CMD_VERBATIM     = 65,
  96   CMD_VERBINCLUDE  = 66,
  97   CMD_VERSION      = 67 | SIMPLESECT_BIT,
  98   CMD_WARNING      = 68 | SIMPLESECT_BIT,
  99   CMD_XREFITEM     = 69 | SIMPLESECT_BIT,
 100   CMD_XMLONLY      = 70,
 101   CMD_DOT          = 71,
 102   CMD_ENDDOT       = 72,
 103   CMD_MSC          = 73,
 104   CMD_ENDMSC       = 74,
 105   CMD_MANONLY      = 75,
 106   CMD_ENDMANONLY   = 76,
 107   CMD_INCWITHLINES = 77,
 108   CMD_INHERITDOC   = 78,
 109   CMD_TPARAM       = 79 | SIMPLESECT_BIT,
 110   CMD_COPYBRIEF    = 80,
 111   CMD_COPYDETAILS  = 81,
 112   CMD_QUOTE        = 82,
 113   CMD_MSCFILE      = 83,
 114   CMD_DCOLON       = 84,
 115   CMD_COPYRIGHT    = 85 | SIMPLESECT_BIT,
 116   CMD_CITE         = 86,
 117   CMD_SNIPPET      = 87,
 118   CMD_RTFONLY      = 88,
 119   CMD_ENDRTFONLY   = 89,
 120   CMD_PIPE         = 90,
 121   CMD_VHDLFLOW     = 91,
 122   CMD_DBONLY       = 92,
 123   CMD_ENDDBONLY    = 93,
 124   CMD_ENDINTERNAL  = 94,
 125   CMD_PARBLOCK     = 95,
 126   CMD_ENDPARBLOCK  = 96,
 127   CMD_DIAFILE      = 97,
 128   CMD_LATEXINCLUDE = 98,
 129   CMD_NDASH        = 99,
 130   CMD_MDASH        = 100
 131 };
 132
 133 enum HtmlTagType
 134 {
 135   HTML_UNKNOWN   = 0,
 136   HTML_CENTER    = 1,
 137   HTML_TABLE     = 2,
 138   HTML_CAPTION   = 3,
 139   HTML_SMALL     = 4,
 140   HTML_CODE      = 5,
 141   HTML_IMG       = 6,
 142   HTML_PRE       = 7,
 143   HTML_SUB       = 8,
 144   HTML_SUP       = 9,
 145   HTML_TR        = 10,
 146   HTML_TD        = 11,
 147   HTML_TH        = 12,
 148   HTML_OL        = 13,
 149   HTML_UL        = 14,
 150   HTML_LI        = 15,
 151   HTML_EMPHASIS  = 16,
 152   HTML_HR        = 17,
 153   HTML_DL        = 18,
 154   HTML_DT        = 19,
 155   HTML_DD        = 20,
 156   HTML_BR        = 21,
 157   HTML_A         = 22,
 158   HTML_BOLD      = 23,
 159   HTML_P         = 24,
 160   HTML_H1        = 25,
 161   HTML_H2        = 26,
 162   HTML_H3        = 27,
 163   HTML_H4        = 28,
 164   HTML_H5        = 29,
 165   HTML_H6        = 30,
 166   HTML_SPAN      = 31,
 167   HTML_DIV       = 32,
 168   HTML_BLOCKQUOTE= 33,
 169
 170   XML_CmdMask    = 0x100,
 171
 172   XML_C            = XML_CmdMask + 0,
 173   XML_CODE         = XML_CmdMask + 1,
 174   XML_DESCRIPTION  = XML_CmdMask + 2,
 175   XML_EXAMPLE      = XML_CmdMask + 3,
 176   XML_EXCEPTION    = XML_CmdMask + 4,
 177   XML_INCLUDE      = XML_CmdMask + 5,
 178   XML_ITEM         = XML_CmdMask + 6,
 179   XML_LIST         = XML_CmdMask + 7,
 180   XML_LISTHEADER   = XML_CmdMask + 8,
 181   XML_PARA         = XML_CmdMask + 9,
 182   XML_PARAM        = XML_CmdMask + 10,
 183   XML_PARAMREF     = XML_CmdMask + 11,
 184   XML_PERMISSION   = XML_CmdMask + 12,
 185   XML_REMARKS      = XML_CmdMask + 13,
 186   XML_RETURNS      = XML_CmdMask + 14,
 187   XML_SEE          = XML_CmdMask + 15,
 188   XML_SEEALSO      = XML_CmdMask + 16,
 189   XML_SUMMARY      = XML_CmdMask + 17,
 190   XML_TERM         = XML_CmdMask + 18,
 191   XML_TYPEPARAM    = XML_CmdMask + 19,
 192   XML_TYPEPARAMREF = XML_CmdMask + 20,
 193   XML_VALUE        = XML_CmdMask + 21,
 194   XML_INHERITDOC   = XML_CmdMask + 22
 195 };
 196
 197 /** Class representing a mapping from command names to command IDs. */
 198 class Mapper
 199 {
 200   public:
 201     int map(const char *n);
 202     Mapper(const CommandMap *cm,bool caseSensitive);
 203   private:
 204     QDict<int> m_map;
 205     bool m_cs;
 206 };
 207
 208 /** Class representing a namespace for the doxygen and HTML command mappers. */
 209 struct Mappers
 210 {
 211   static void freeMappers();
 212   static Mapper *cmdMapper;
 213   static Mapper *htmlTagMapper;
 214 };
 215
 216
 217 #endif