doctokenizer.h File Reference

#include <stdio.h>
#include <memory>
#include "htmlattrib.h"
#include "qcstring.h"
#include "construct.h"

Include dependency graph for doctokenizer.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	Token
struct	TokenInfo
	Data associated with a token used by the comment block parser. More...
class	DocTokenizer

Macros
#define	TOKEN_SPECIFICATIONS
#define	RETVAL_SPECIFICATIONS
#define	TKSPEC(x, y)
#define	TKSPEC(x, y)
#define	TKSPEC(x, y)

Enumerations
enum class	TokenRetval { TKSPEC , RETVAL_SPECIFICATIONS }

Macro Definition Documentation

RETVAL_SPECIFICATIONS

#define RETVAL_SPECIFICATIONS

Value:

  TKSPEC(RetVal_OK,              0x10000)  \
  TKSPEC(RetVal_SimpleSec,       0x10001)  \
  TKSPEC(RetVal_ListItem,        0x10002)  \
  TKSPEC(RetVal_Section,         0x10003)  \
  TKSPEC(RetVal_Subsection,      0x10004)  \
  TKSPEC(RetVal_Subsubsection,   0x10005)  \
  TKSPEC(RetVal_Paragraph,       0x10006)  \
  TKSPEC(RetVal_SubParagraph,    0x10007)  \
  TKSPEC(RetVal_EndList,         0x10008)  \
  TKSPEC(RetVal_EndPre,          0x10009)  \
  TKSPEC(RetVal_DescData,        0x1000A)  \
  TKSPEC(RetVal_DescTitle,       0x1000B)  \
  TKSPEC(RetVal_EndDesc,         0x1000C)  \
  TKSPEC(RetVal_TableRow,        0x1000D)  \
  TKSPEC(RetVal_TableCell,       0x1000E)  \
  TKSPEC(RetVal_TableHCell,      0x1000F)  \
  TKSPEC(RetVal_EndTable,        0x10010)  \
  TKSPEC(RetVal_Internal,        0x10011)  \
  TKSPEC(RetVal_SwitchLang,      0x10012)  \
  TKSPEC(RetVal_CloseXml,        0x10013)  \
  TKSPEC(RetVal_EndBlockQuote,   0x10014)  \
  TKSPEC(RetVal_CopyDoc,         0x10015)  \
  TKSPEC(RetVal_EndInternal,     0x10016)  \
  TKSPEC(RetVal_EndParBlock,     0x10017)  \
  TKSPEC(RetVal_EndHtmlDetails,  0x10018)  \
  TKSPEC(RetVal_SubSubParagraph, 0x10019)

Definition at line 45 of file doctokenizer.h.

#define RETVAL_SPECIFICATIONS \
  TKSPEC(RetVal_OK,              0x10000)  \
  TKSPEC(RetVal_SimpleSec,       0x10001)  \
  TKSPEC(RetVal_ListItem,        0x10002)  \
  TKSPEC(RetVal_Section,         0x10003)  \
  TKSPEC(RetVal_Subsection,      0x10004)  \
  TKSPEC(RetVal_Subsubsection,   0x10005)  \
  TKSPEC(RetVal_Paragraph,       0x10006)  \
  TKSPEC(RetVal_SubParagraph,    0x10007)  \
  TKSPEC(RetVal_EndList,         0x10008)  \
  TKSPEC(RetVal_EndPre,          0x10009)  \
  TKSPEC(RetVal_DescData,        0x1000A)  \
  TKSPEC(RetVal_DescTitle,       0x1000B)  \
  TKSPEC(RetVal_EndDesc,         0x1000C)  \
  TKSPEC(RetVal_TableRow,        0x1000D)  \
  TKSPEC(RetVal_TableCell,       0x1000E)  \
  TKSPEC(RetVal_TableHCell,      0x1000F)  \
  TKSPEC(RetVal_EndTable,        0x10010)  \
  TKSPEC(RetVal_Internal,        0x10011)  \
  TKSPEC(RetVal_SwitchLang,      0x10012)  \
  TKSPEC(RetVal_CloseXml,        0x10013)  \
  TKSPEC(RetVal_EndBlockQuote,   0x10014)  \
  TKSPEC(RetVal_CopyDoc,         0x10015)  \
  TKSPEC(RetVal_EndInternal,     0x10016)  \
  TKSPEC(RetVal_EndParBlock,     0x10017)  \
  TKSPEC(RetVal_EndHtmlDetails,  0x10018)  \
  TKSPEC(RetVal_SubSubParagraph, 0x10019)

Referenced by Token::to_string().

TKSPEC [1/3]

#define TKSPEC	(		x,
			y )

Value:

x = y,

Definition at line 75 of file doctokenizer.h.

TKSPEC [2/3]

#define TKSPEC	(		x,
			y )

Value:

static Token make_##x() { return Token(TokenRetval::x); }

Definition at line 75 of file doctokenizer.h.

TKSPEC [3/3]

#define TKSPEC	(		x,
			y )

Value:

case TokenRetval::x: result = #x; break;

Definition at line 75 of file doctokenizer.h.

TOKEN_SPECIFICATIONS

#define TOKEN_SPECIFICATIONS

Value:

  TKSPEC(TK_EOF,          -1)                                   \
  TKSPEC(TK_NONE,          0)                                   \
  TKSPEC(TK_WORD,          1)                                   \
  TKSPEC(TK_LNKWORD,       2)                                   \
  TKSPEC(TK_WHITESPACE,    3)                                   \
  TKSPEC(TK_LISTITEM,      4)                                   \
  TKSPEC(TK_ENDLIST,       5)                                   \
  TKSPEC(TK_COMMAND_AT,    6) /*! Command starting with `@` */  \
  TKSPEC(TK_HTMLTAG,       7)                                   \
  TKSPEC(TK_SYMBOL,        8)                                   \
  TKSPEC(TK_NEWPARA,       9)                                   \
  TKSPEC(TK_RCSTAG,       10)                                   \
  TKSPEC(TK_URL,          11)                                   \
  TKSPEC(TK_COMMAND_BS,   12) /*! Command starting with `\` */

Definition at line 29 of file doctokenizer.h.

#define TOKEN_SPECIFICATIONS \
  TKSPEC(TK_EOF,          -1)                                   \
  TKSPEC(TK_NONE,          0)                                   \
  TKSPEC(TK_WORD,          1)                                   \
  TKSPEC(TK_LNKWORD,       2)                                   \
  TKSPEC(TK_WHITESPACE,    3)                                   \
  TKSPEC(TK_LISTITEM,      4)                                   \
  TKSPEC(TK_ENDLIST,       5)                                   \
  TKSPEC(TK_COMMAND_AT,    6) /*! Command starting with `@` */  \
  TKSPEC(TK_HTMLTAG,       7)                                   \
  TKSPEC(TK_SYMBOL,        8)                                   \
  TKSPEC(TK_NEWPARA,       9)                                   \
  TKSPEC(TK_RCSTAG,       10)                                   \
  TKSPEC(TK_URL,          11)                                   \
  TKSPEC(TK_COMMAND_BS,   12) /*! Command starting with `\` */

Referenced by Token::to_string().

Enumeration Type Documentation

TokenRetval

enum class TokenRetval

strong

Enumerator
TKSPEC
RETVAL_SPECIFICATIONS

Definition at line 73 of file doctokenizer.h.

{
#define TKSPEC(x,y) x = y,
      TOKEN_SPECIFICATIONS
      RETVAL_SPECIFICATIONS
#undef TKSPEC
};