./Source/headertypes.c

HeaderTypes/header_type_lookup_table [ Variables ]

FUNCTION

A lookup table for all the header types that ROBODoc recognizes. At the moment is has about 127 entries. About as many as there are characters in the standard ASCII set. The first 32 entries can be used for special purposes.

Two of them are use:

     HT_MASTERINDEXTYPE

and

     HT_SOURCEHEADERTYPE

HT_MASTERINDEXTYPE is a wildcard type. All headertypes match this type. This is used to collect all the headers for the masterindex.

HT_SOURCEHEADERTYPE is used to pretend that the name of a sourcefile is a kind of header. This makes it possible to include the names of the source files in the master index.

SOURCE

struct RB_HeaderType header_type_lookup_table[MAX_HEADER_TYPE + 1] = {
    {'\0', NULL, NULL, 0},
    {HT_SOURCEHEADERTYPE, "Sourcefiles", "robo_sourcefiles", 0},
    {HT_MASTERINDEXTYPE, "Index", "masterindex", 0},    /* no robo_ prefix for backwards compatibility */
    {'\0', NULL, NULL, 0},
    {'\0', NULL, NULL, 0},
    {'\0', NULL, NULL, 0},
    {'\0', NULL, NULL, 0},
    {'\0', NULL, NULL, 0},
    {'\0', NULL, NULL, 0},
    {'\0', NULL, NULL, 0},
    {'\0', NULL, NULL, 0},
    {'\0', NULL, NULL, 0},
    {'\0', NULL, NULL, 0},
    {'\0', NULL, NULL, 0},
    {'\0', NULL, NULL, 0},
    {'\0', NULL, NULL, 0},
    {'\0', NULL, NULL, 0},
    {'\0', NULL, NULL, 0},
    {'\0', NULL, NULL, 0},
    {'\0', NULL, NULL, 0},
    {'\0', NULL, NULL, 0},
    {'\0', NULL, NULL, 0},
    {'\0', NULL, NULL, 0},
    {'\0', NULL, NULL, 0},
    {'\0', NULL, NULL, 0},
    {'\0', NULL, NULL, 0},
    {'\0', NULL, NULL, 0},
    {'\0', NULL, NULL, 0},
    {'\0', NULL, NULL, 0},
    {'\0', NULL, NULL, 0},
    {'\0', NULL, NULL, 0},
    {'\0', NULL, NULL, 0},
    {' ', NULL, NULL, 0},
    {'!', NULL, NULL, 0},
    {'"', NULL, NULL, 0},
    {'#', NULL, NULL, 0},
    {'$', NULL, NULL, 0},
    {'%', NULL, NULL, 0},
    {'&', NULL, NULL, 0},
    {'\0', NULL, NULL, 0},
    {'(', NULL, NULL, 0},
    {')', NULL, NULL, 0},
    {'*', "Generics", "robo_generics", 0},
    {'+', NULL, NULL, 0},
    {',', NULL, NULL, 0},
    {'-', NULL, NULL, 0},
    {'.', NULL, NULL, 0},
    {'/', NULL, NULL, 0},
    {'0', NULL, NULL, 0},
    {'1', NULL, NULL, 0},
    {'2', NULL, NULL, 0},
    {'3', NULL, NULL, 0},
    {'4', NULL, NULL, 0},
    {'5', NULL, NULL, 0},
    {'6', NULL, NULL, 0},
    {'7', NULL, NULL, 0},
    {'8', NULL, NULL, 0},
    {'9', NULL, NULL, 0},
    {':', NULL, NULL, 0},
    {';', NULL, NULL, 0},
    {'<', NULL, NULL, 0},
    {'=', NULL, NULL, 0},
    {'>', NULL, NULL, 0},
    {'?', NULL, NULL, 0},
    {'@', NULL, NULL, 0},
    {'A', NULL, NULL, 0},
    {'B', "Businessrules", "robo_businessrules", 0},
    {'C', "Contracts", "robo_contracts", 0},
    {'D', "Datasources", "robo_datasources", 0},
    {'E', "Ensure contracts", "robo_ensure_contracts", 0},
    {'F', NULL, NULL, 0},
    {'G', NULL, NULL, 0},
    {'H', NULL, NULL, 0},
    {'I', "Invariants", "robo_invariants", 0},
    {'J', NULL, NULL, 0},
    {'K', NULL, NULL, 0},
    {'L', NULL, NULL, 0},
    {'M', "Metadata", "robo_metadata", 0},
    {'N', NULL, NULL, 0},
    {'O', NULL, NULL, 0},
    {'P', "Process", "robo_processes", 0},
    {'Q', NULL, NULL, 0},
    {'R', "Require contracts", "robo_require_contracts", 0},
    {'S', "Subjects", "robo_subjects", 0},
    {'T', NULL, NULL, 0},
    {'U', NULL, NULL, 0},
    {'V', NULL, NULL, 0},
    {'W', NULL, NULL, 0},
    {'X', NULL, NULL, 0},
    {'Y', NULL, NULL, 0},
    {'Z', NULL, NULL, 0},
    {'[', NULL, NULL, 0},
    {'\0', NULL, NULL, 0},      /* Separator /  */
    {']', NULL, NULL, 0},
    {'^', NULL, NULL, 0},
    {'_', NULL, NULL, 0},
    {'`', NULL, NULL, 0},
    {'a', NULL, NULL, 0},
    {'b', NULL, NULL, 0},
    {'c', "Classes", "robo_classes", 0},
    {'d', "Definitions", "robo_definitions", 0},
    {'e', "Exceptions", "robo_exceptions", 0},
    {'f', "Functions", "robo_functions", 0},
    {'g', NULL, NULL, 0},
    {'h', "Modules", "robo_modules", 1},
    {'\0', NULL, NULL, 0},      /* Internal header flag */
    {'j', NULL, NULL, 0},
    {'k', NULL, NULL, 0},
    {'l', NULL, NULL, 0},
    {'m', "Methods", "robo_methods", 0},
    {'n', NULL, NULL, 0},
    {'o', NULL, NULL, 0},
    {'p', "Procedures", "robo_procedures", 0},
    {'q', NULL, NULL, 0},
    {'r', NULL, NULL, 0},
    {'s', "Structures", "robo_strutures", 0},
    {'t', "Types", "robo_types", 0},
    {'u', "Unittest", "robo_unittests", 0},
    {'v', "Variables", "robo_variables", 0},
    {'w', "Warehouses", "robo_warehouses", 0},
    {'x', NULL, NULL, 0},
    {'y', NULL, NULL, 0},
    {'z', NULL, NULL, 0},
    {'{', NULL, NULL, 0},
    {'|', NULL, NULL, 0},
    {'}', NULL, NULL, 0},
    {'~', NULL, NULL, 0},
    {'\0', NULL, NULL, 0}
};