# token.h File Reference

`#include "text.h"`

Include dependency graph for token.h:

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

Go to the source code of this file.

## Data Structures

struct | FAXPP_Token
| A structure containing token information, returned by the tokenizer. More...

## Enumerations

enum

FAXPP_TokenType {
NO_TOKEN = 0, XML_DECL_VERSION_TOKEN, XML_DECL_ENCODING_TOKEN, XML_DECL_STANDALONE_TOKEN,
XML_DECL_END_TOKEN, START_ELEMENT_PREFIX_TOKEN, START_ELEMENT_NAME_TOKEN, START_ELEMENT_END_TOKEN,
SELF_CLOSING_ELEMENT_TOKEN, XMLNS_PREFIX_TOKEN, XMLNS_NAME_TOKEN, XML_PREFIX_TOKEN,
ATTRIBUTE_PREFIX_TOKEN, ATTRIBUTE_NAME_TOKEN, ATTRIBUTE_VALUE_TOKEN, END_ELEMENT_PREFIX_TOKEN,
END_ELEMENT_NAME_TOKEN, CHARACTERS_TOKEN, CDATA_TOKEN, IGNORABLE_WHITESPACE_TOKEN,
COMMENT_TOKEN, PI_NAME_TOKEN, PI_VALUE_TOKEN, AMP_ENTITY_REFERENCE_TOKEN,
APOS_ENTITY_REFERENCE_TOKEN, GT_ENTITY_REFERENCE_TOKEN, LT_ENTITY_REFERENCE_TOKEN, QUOT_ENTITY_REFERENCE_TOKEN,
ENTITY_REFERENCE_TOKEN, DEC_CHAR_REFERENCE_TOKEN, HEX_CHAR_REFERENCE_TOKEN, PE_REFERENCE_TOKEN,
PE_REFERENCE_IN_MARKUP_TOKEN, DOCTYPE_PREFIX_TOKEN, DOCTYPE_NAME_TOKEN, DOCTYPE_END_TOKEN,
SYSTEM_LITERAL_TOKEN, PUBID_LITERAL_TOKEN, NDATA_NAME_TOKEN, ELEMENTDECL_PREFIX_TOKEN,
ELEMENTDECL_NAME_TOKEN, ELEMENTDECL_EMPTY_TOKEN, ELEMENTDECL_ANY_TOKEN, ELEMENTDECL_PCDATA_TOKEN,
ELEMENTDECL_LPAR_TOKEN, ELEMENTDECL_RPAR_TOKEN, ELEMENTDECL_QUESTION_TOKEN, ELEMENTDECL_STAR_TOKEN,
ELEMENTDECL_PLUS_TOKEN, ELEMENTDECL_BAR_TOKEN, ELEMENTDECL_COMMA_TOKEN, ELEMENTDECL_END_TOKEN,
ATTLISTDECL_PREFIX_TOKEN, ATTLISTDECL_NAME_TOKEN, ATTLISTDECL_ATTDEF_PREFIX_TOKEN, ATTLISTDECL_ATTDEF_NAME_TOKEN,
ATTLISTDECL_ATTTYPE_ENTITY_TOKEN, ATTLISTDECL_ATTTYPE_ENTITIES_TOKEN, ATTLISTDECL_ATTTYPE_NMTOKEN_TOKEN, ATTLISTDECL_ATTTYPE_NMTOKENS_TOKEN,
ATTLISTDECL_ATTTYPE_ID_TOKEN, ATTLISTDECL_ATTTYPE_IDREF_TOKEN, ATTLISTDECL_ATTTYPE_IDREFS_TOKEN, ATTLISTDECL_ATTTYPE_CDATA_TOKEN,
ATTLISTDECL_NOTATION_NAME_TOKEN, ATTLISTDECL_ENUMERATION_NAME_TOKEN, ATTLISTDECL_DEFAULT_IMPLIED_TOKEN, ATTLISTDECL_DEFAULT_REQUIRED_TOKEN,
ATTLISTDECL_DEFAULT_FIXED_TOKEN, ATTLISTDECL_END_TOKEN, NOTATIONDECL_NAME_TOKEN, NOTATIONDECL_END_TOKEN,
ENTITYDECL_NAME_TOKEN, ENTITYDECL_VALUE_TOKEN, ENTITYDECL_END_TOKEN, PARAMENTITYDECL_NAME_TOKEN,
END_OF_BUFFER_TOKEN = 99
}

| An enumeration of the token types returned by the tokenizer. More...

## Functions

const char * | FAXPP_token_to_string (const FAXPP_TokenType type)
| Returns a string describing the given token type.

## Enumeration Type Documentation

enum FAXPP_TokenType

An enumeration of the token types returned by the tokenizer.

Enumerator:

  NO_TOKEN |
  XML_DECL_VERSION_TOKEN |
  XML_DECL_ENCODING_TOKEN |
  XML_DECL_STANDALONE_TOKEN |
  XML_DECL_END_TOKEN |
  START_ELEMENT_PREFIX_TOKEN |
  START_ELEMENT_NAME_TOKEN |
  START_ELEMENT_END_TOKEN |
  SELF_CLOSING_ELEMENT_TOKEN |
  XMLNS_PREFIX_TOKEN |
  XMLNS_NAME_TOKEN |
  XML_PREFIX_TOKEN |
  ATTRIBUTE_PREFIX_TOKEN |
  ATTRIBUTE_NAME_TOKEN |
  ATTRIBUTE_VALUE_TOKEN |
  END_ELEMENT_PREFIX_TOKEN |
  END_ELEMENT_NAME_TOKEN |
  CHARACTERS_TOKEN |
  CDATA_TOKEN |
  IGNORABLE_WHITESPACE_TOKEN |
  COMMENT_TOKEN |
  PI_NAME_TOKEN |
  PI_VALUE_TOKEN |
  AMP_ENTITY_REFERENCE_TOKEN |
  APOS_ENTITY_REFERENCE_TOKEN |
  GT_ENTITY_REFERENCE_TOKEN |
  LT_ENTITY_REFERENCE_TOKEN |
  QUOT_ENTITY_REFERENCE_TOKEN |
  ENTITY_REFERENCE_TOKEN |
  DEC_CHAR_REFERENCE_TOKEN |
  HEX_CHAR_REFERENCE_TOKEN |
  PE_REFERENCE_TOKEN |
  PE_REFERENCE_IN_MARKUP_TOKEN |
  DOCTYPE_PREFIX_TOKEN |
  DOCTYPE_NAME_TOKEN |
  DOCTYPE_END_TOKEN |
  SYSTEM_LITERAL_TOKEN |
  PUBID_LITERAL_TOKEN |
  NDATA_NAME_TOKEN |
  ELEMENTDECL_PREFIX_TOKEN |
  ELEMENTDECL_NAME_TOKEN |
  ELEMENTDECL_EMPTY_TOKEN |
  ELEMENTDECL_ANY_TOKEN |
  ELEMENTDECL_PCDATA_TOKEN |
  ELEMENTDECL_LPAR_TOKEN |
  ELEMENTDECL_RPAR_TOKEN |
  ELEMENTDECL_QUESTION_TOKEN |
  ELEMENTDECL_STAR_TOKEN |
  ELEMENTDECL_PLUS_TOKEN |
  ELEMENTDECL_BAR_TOKEN |
  ELEMENTDECL_COMMA_TOKEN |
  ELEMENTDECL_END_TOKEN |
  ATTLISTDECL_PREFIX_TOKEN |
  ATTLISTDECL_NAME_TOKEN |
  ATTLISTDECL_ATTDEF_PREFIX_TOKEN |
  ATTLISTDECL_ATTDEF_NAME_TOKEN |
  ATTLISTDECL_ATTTYPE_ENTITY_TOKEN |
  ATTLISTDECL_ATTTYPE_ENTITIES_TOKEN |
  ATTLISTDECL_ATTTYPE_NMTOKEN_TOKEN |
  ATTLISTDECL_ATTTYPE_NMTOKENS_TOKEN |
  ATTLISTDECL_ATTTYPE_ID_TOKEN |
  ATTLISTDECL_ATTTYPE_IDREF_TOKEN |
  ATTLISTDECL_ATTTYPE_IDREFS_TOKEN |
  ATTLISTDECL_ATTTYPE_CDATA_TOKEN |
  ATTLISTDECL_NOTATION_NAME_TOKEN |
  ATTLISTDECL_ENUMERATION_NAME_TOKEN |
  ATTLISTDECL_DEFAULT_IMPLIED_TOKEN |
  ATTLISTDECL_DEFAULT_REQUIRED_TOKEN |
  ATTLISTDECL_DEFAULT_FIXED_TOKEN |
  ATTLISTDECL_END_TOKEN |
  NOTATIONDECL_NAME_TOKEN |
  NOTATIONDECL_END_TOKEN |
  ENTITYDECL_NAME_TOKEN |
  ENTITYDECL_VALUE_TOKEN |
  ENTITYDECL_END_TOKEN |
  PARAMENTITYDECL_NAME_TOKEN |
  END_OF_BUFFER_TOKEN |

Definition at line 23 of file token.h.

## Function Documentation

const char * FAXPP_token_to_string | ( | const FAXPP_TokenType | type | ) |

Returns a string describing the given token type.

Parameters:

  | type | The token type

Returns:
  a string