treeTableSchema.h

Go to the documentation of this file.

/*==================================================================*\
|                EXIP - Embeddable EXI Processor in C                |
|--------------------------------------------------------------------|
|          This work is licensed under BSD 3-Clause License          |
|  The full license terms and conditions are located in LICENSE.txt  |
\===================================================================*/

#ifndef TREETABLESCHEMA_H_
#define TREETABLESCHEMA_H_

#include "procTypes.h"
#include "dynamicArray.h"
#include "protoGrammars.h"
#include "hashtable.h"
#include "grammarGenerator.h"

enum ElemEnum
{
    ELEMENT_ELEMENT          =0,
    ELEMENT_ATTRIBUTE        =1,
    ELEMENT_CHOICE           =2,
    ELEMENT_COMPLEX_TYPE     =3,
    ELEMENT_COMPLEX_CONTENT  =4,
    ELEMENT_GROUP            =5,
    ELEMENT_IMPORT           =6,
    ELEMENT_SEQUENCE         =7,
    ELEMENT_ALL              =8,
    ELEMENT_EXTENSION        =9,
    ELEMENT_RESTRICTION     =10,
    ELEMENT_SIMPLE_CONTENT  =11,
    ELEMENT_ANY             =12,
    ELEMENT_SIMPLE_TYPE     =13,
    ELEMENT_MIN_INCLUSIVE   =14,
    ELEMENT_ANNOTATION      =15,
    ELEMENT_DOCUMENTATION   =16,
    ELEMENT_MAX_LENGTH      =17,
    ELEMENT_MAX_INCLUSIVE   =18,
    ELEMENT_LIST            =19,
    ELEMENT_UNION           =20,
    ELEMENT_ATTRIBUTE_GROUP =21,
    ELEMENT_ANY_ATTRIBUTE   =22,
    ELEMENT_ENUMERATION     =23,
    ELEMENT_KEY             =24,
    ELEMENT_SELECTOR        =25,
    ELEMENT_FIELD           =26,
    ELEMENT_NOTATION        =27,
    ELEMENT_INCLUDE         =28,
    ELEMENT_REDEFINE        =29,
    ELEMENT_MIN_EXCLUSIVE   =30,
    ELEMENT_MAX_EXCLUSIVE   =31,
    ELEMENT_TOTAL_DIGITS    =32,
    ELEMENT_FRACTION_DIGITS =33,
    ELEMENT_LENGTH          =34,
    ELEMENT_MIN_LENGTH      =35,
    ELEMENT_WHITE_SPACE     =36,
    ELEMENT_PATTERN         =37,
    ELEMENT_APPINFO         =38,
    ELEMENT_VOID            =39
};

typedef enum ElemEnum ElemEnum;

enum AttrEnum
{
    ATTRIBUTE_NAME               =0,
    ATTRIBUTE_TYPE               =1,
    ATTRIBUTE_REF                =2,
    ATTRIBUTE_MIN_OCCURS         =3,
    ATTRIBUTE_MAX_OCCURS         =4,
    ATTRIBUTE_FORM               =5,
    ATTRIBUTE_BASE               =6,
    ATTRIBUTE_USE                =7,
    ATTRIBUTE_NAMESPACE          =8,
    ATTRIBUTE_PROC_CONTENTS      =9,
    ATTRIBUTE_VALUE              =10,
    ATTRIBUTE_NILLABLE           =11,
    ATTRIBUTE_ITEM_TYPE          =12,
    ATTRIBUTE_MEMBER_TYPES       =13,
    ATTRIBUTE_MIXED              =14,
    ATTRIBUTE_SCHEMA_LOCATION    =15,
    ATTRIBUTE_SUBSTITUTION_GROUP =16,
    ATTRIBUTE_ABSTRACT           =17,
    ATTRIBUTE_CONTEXT_ARRAY_SIZE =18
};

typedef enum AttrEnum AttrEnum;

struct PfxNsEntry
{
    String pfx;
    String ns;
};

typedef struct PfxNsEntry PfxNsEntry;

struct PfxNsTable
{
    DynArray dynArray;
    PfxNsEntry *pfxNs;
    Index count;
};

typedef struct PfxNsTable PfxNsTable;

enum FormType
{
    QUALIFIED          =0,
    UNQUALIFIED        =1
};

typedef enum FormType FormType;

struct QNameIDGrIndx
{
    QNameID qnameId;
    Index grIndex;
};

typedef struct QNameIDGrIndx QNameIDGrIndx;

struct QualifiedTreeTableEntry
{
    struct TreeTable* treeT;
    struct TreeTableEntry* entry;
};

typedef struct QualifiedTreeTableEntry QualifiedTreeTableEntry;

struct TreeTableEntry
{
    QualifiedTreeTableEntry child;

    struct TreeTableEntry* next;

    QualifiedTreeTableEntry supertype;

    ElemEnum element;

    String attributePointers[ATTRIBUTE_CONTEXT_ARRAY_SIZE];

    Index loopDetection;
};

typedef struct TreeTableEntry TreeTableEntry;

struct TreeTable
{
    DynArray dynArray;
    TreeTableEntry* tree;
    Index count;

    struct
    {
        String targetNs;
        SmallIndex targetNsId; 
        FormType elemFormDefault;
        FormType attrFormDefault;
        PfxNsTable pfxNsTable;
    } globalDefs;

    AllocList memList; // Holding the memory allocations for the TreeTable

#if HASH_TABLE_USE

    struct hashtable* typeTbl;

    struct hashtable* elemTbl;

    struct hashtable* attrTbl;

    struct hashtable* groupTbl;

    struct hashtable* attrGroupTbl;
#endif
};

typedef struct TreeTable TreeTable;

struct NsTable
{
    DynArray dynArray;
    String *base;
    Index count;
};

typedef struct NsTable NsTable;

struct SubtGroupHead
{
    DynArray dynArray;
    QualifiedTreeTableEntry* substitutes;
    Index count;
    QNameID headId;
};

typedef struct SubtGroupHead SubtGroupHead;

struct SubstituteTable
{
    DynArray dynArray;
    SubtGroupHead* head;
    Index count;
};

typedef struct SubstituteTable SubstituteTable;

errorCode initTreeTable(TreeTable* treeT);

void destroyTreeTable(TreeTable* treeT);

errorCode generateTreeTable(BinaryBuffer buffer, SchemaFormat schemaFormat, EXIOptions* opt, TreeTable* treeT, EXIPSchema* schema);

errorCode resolveIncludeImportReferences(EXIPSchema* schema, TreeTable** treeT, unsigned int* count,
        errorCode (*loadSchemaHandler) (String* namespace, String* schemaLocation, BinaryBuffer** buffers, unsigned int* bufCount, SchemaFormat* schemaFormat, EXIOptions** opt));

errorCode resolveTypeHierarchy(EXIPSchema* schema, TreeTable* treeT, unsigned int count, SubstituteTable* subsTbl);

errorCode convertTreeTablesToExipSchema(TreeTable* treeT, unsigned int count, EXIPSchema* schema, SubstituteTable* subsTbl);

errorCode getTypeQName(EXIPSchema* schema, TreeTable* treeT, const String typeLiteral, QNameID* qname);

errorCode getNsList(TreeTable* treeT, String nsList, NsTable* nsTable);

#if DEBUG_GRAMMAR_GEN == ON

void printTreeTableEntry(TreeTableEntry* treeTableEntryIn, int indentIdx, char *prefix);
#endif

#endif /* TREETABLESCHEMA_H_ */