BxBinxSchema.h

/********************************************************************
 * Binx
 * $Id: BxBinxSchema_8h-source.html,v 1.1.1.1 2006/04/19 14:19:02 edikt2 Exp $
 *
 * BinX schema definitions
 *
 *
 * edikt::BinX
 * www.edikt.org
 * support@edikt.org
 *
 * Copyright (c) 2005 The University of Edinburgh.
 *
 ********************************************************************/

#ifndef BXBINXSCHEMA_H
#define BXBINXSCHEMA_H

#include "BxObject.h"

// set compiler to use integers for enum.
// will be used as indexes of an array.
enum BxBinxTagNumber
{
    BX_TAG_NULL = 0,     //added to start from 0
    BX_TAG_ROOT,
    BX_TAG_PARAMETERS,
    BX_TAG_DEFINITIONS,
    BX_TAG_DATASET,
    BX_TAG_DEFINETYPE,
    BX_TAG_USETYPE,
    BX_TAG_STRUCT,
    BX_TAG_UNION,
    BX_TAG_ARRAY,
    BX_TAG_ARRAYFIXED,
    BX_TAG_ARRAYVARIABLE,
    BX_TAG_ARRAYSTREAMED,
    BX_TAG_ARRAYDATA,   //for implicit array data
    BX_TAG_DIMENSION,
    BX_TAG_DIMVARIABLE,    //obsolete
    BX_TAG_DIMSTREAMED,    //obsolete
    BX_TAG_VARRAYSIZE,          //for arrayVariable only
    BX_TAG_DATATYPE,    //STARTS A DATATYPE SECTION
    BX_TAG_BIT1,           //not currently supported
    BX_TAG_BYTE8,
    BX_TAG_CHARACTER8,
    BX_TAG_UNICODE16,
    BX_TAG_UNICODE32,
    BX_TAG_ENUM32,         //not used by new schema
    BX_TAG_SHORT16,
    BX_TAG_INTEGER32,
    BX_TAG_LONG64,
    BX_TAG_UNSIGNEDBYTE8,   //added in new schema
    BX_TAG_UNSIGNEDSHORT16,
    BX_TAG_UNSIGNEDINTEGER32,
    BX_TAG_UNSIGNEDLONG64,
    BX_TAG_FLOAT32,
    BX_TAG_DOUBLE64,
    BX_TAG_EXTENDED80,
    BX_TAG_EXTENDED96,
    BX_TAG_QUADRUPLE128,
    BX_TAG_VOID0,
    BX_TAG_DISCRIMINANT,
    BX_TAG_VAL, //<enum-32,...<val...
    BX_TAG_CASE,    //<union,...<case...
    BX_TAG_DEFINETYPE_SYN,  //synonyms, kept here to enlarge the array
    BX_TAG_USETYPE_SYN,     //so that BX_TAG_END reflect the last element in array
    BX_TAG_DATASET_FILE, //both <dataset> and <file> ok for this version
    BX_TAG_SYN1,    //synonym space reservation
    BX_TAG_SYN2,
    BX_TAG_SYN3,
    BX_TAG_SYN4,
    BX_TAG_SYN5,
    BX_TAG_SYN6,
    BX_TAG_SYN7,
    BX_TAG_SYN8,
    BX_TAG_SYN9,
    BX_TAG_DATABINX,
    BX_TAG_STRING,  //added for databinx
    BX_TAG_END  //not used, mark the end of the list
};

struct BxBinxTagTable
{
    BxBinxTagNumber number_;
    char* name_;
};

class BxBinxSchema : public BxObject
{
public:
        // The default constructor
    BxBinxSchema();

        // The destructor
    virtual ~BxBinxSchema() {}

    static BxBinxTagNumber search(const char* const tag);
    static const char* searchTagByDataClass(int dataclass);

    static const BxBinxTagTable tags[];     //element tags

    static const char* xmlHeader;  //<?xml version=...
    static const char* binxNameSpace;      //namespace for binx
    static const char* databinxNameSpace;  //namespace for databinx

    static const char* attrTypeName;     //attribute typeName="..."
    static const char* attrVarName;      //varName="..."
    static const char* attrTestValue;    //testValue="..."
    static const char* attrIndexFrom;    //<dim indexFrom="..."
    static const char* attrIndexTo;      //<dim indexTo="..."
    static const char* attrCount;        //<dim count="..."
    static const char* attrIndex;        //<dim index="0"  for implicit XML
    static const char* attrName;         //<val name="...", <dim name="d1">
    static const char* attrValue;        //<val value="0"
    static const char* attrSrc;          //<file src="..."
    static const char* attrByteOrder;    //byteOrder="bigEndian | littleEndian"
    static const char* attrBitOrder;     //bitOrder
    static const char* attrBlockSize;    //blockSize
    static const char* attrDim;          //dim="..."
    static const char* attrIgnore;       //ignore="true"
    static const char* attrKey;          //key="primaryKey"
    static const char* attrInfo;         //info
    static const char* attrOffset;       //offset="1002"
    static const char* attrDiscriminantValue; //<case discriminantValue="1"
    static const char* attrXref;           //<dim href="binx_file"
    static const char* attrType;           //<array type="Variable"
    static const char* attrSize;       //<string size="10"
    static const char* attrDelim;      //<string delim="\n"
    static const char* attrSizeType;   //<string sizeType="byte-8"
    
    static const char* valBigEndian;       //value of attribute byteOrder="bigEndian"
    static const char* valLittleEndian;    //byteOrder="littleEndian"
    static const char* valFixed;           //type="Fixed", "fixed", "FIXED"
    static const char* valVariable;        //type="Variable"
    static const char* valStreamed;        //type="Streamed"
};

#endif

---