bin/headers/EXISerializer.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 EXISERIALIZER_H_
#define EXISERIALIZER_H_

#include "procTypes.h"

struct EXISerializer
{
    // For handling the meta-data (document structure)
    errorCode (*startDocument)(EXIStream* strm);
    errorCode (*endDocument)(EXIStream* strm);
    errorCode (*startElement)(EXIStream* strm, QName qname, EXITypeClass* valueType);
    errorCode (*endElement)(EXIStream* strm);
    errorCode (*attribute)(EXIStream* strm, QName qname, boolean isSchemaType, EXITypeClass* valueType);

    // For handling the data
    errorCode (*intData)(EXIStream* strm, Integer int_val);
    errorCode (*booleanData)(EXIStream* strm, boolean bool_val);
    errorCode (*stringData)(EXIStream* strm, const String str_val);
    errorCode (*floatData)(EXIStream* strm, Float float_val);
    errorCode (*binaryData)(EXIStream* strm, const char* binary_val, Index nbytes);
    errorCode (*dateTimeData)(EXIStream* strm, EXIPDateTime dt_val);
    errorCode (*decimalData)(EXIStream* strm, Decimal dec_val);
    errorCode (*listData)(EXIStream* strm, unsigned int itemCount);
    errorCode (*qnameData)(EXIStream* strm, QName qname); // xsi:type value only

    // Miscellaneous
    errorCode (*processingInstruction)(EXIStream* strm); // TODO: define the parameters!
    errorCode (*namespaceDeclaration)(EXIStream* strm, const String ns, const String prefix, boolean isLocalElementNS);

    // EXI specific
    errorCode (*exiHeader)(EXIStream* strm);
    errorCode (*selfContained)(EXIStream* strm);  // Used for indexing independent elements for random access

    // EXIP specific
    void (*initHeader)(EXIStream* strm);
    errorCode (*initStream)(EXIStream* strm, BinaryBuffer buffer, EXIPSchema* schema);
    errorCode (*closeEXIStream)(EXIStream* strm);
    errorCode (*flushEXIData)(EXIStream* strm, char* outBuf, unsigned int bufSize, unsigned int* bytesFlush);
};

typedef struct EXISerializer EXISerializer;

extern const EXISerializer serialize;

/**** START: Serializer API declarations  ****/

// For handling the meta-data (document structure)

errorCode startDocument(EXIStream* strm);

errorCode endDocument(EXIStream* strm);

errorCode startElement(EXIStream* strm, QName qname, EXITypeClass* valueType);

errorCode endElement(EXIStream* strm);



errorCode attribute(EXIStream* strm, QName qname, boolean isSchemaType, EXITypeClass* valueType);

// For handling the data

errorCode intData(EXIStream* strm, Integer int_val);

errorCode booleanData(EXIStream* strm, boolean bool_val);

errorCode stringData(EXIStream* strm, const String str_val);

errorCode floatData(EXIStream* strm, Float float_val);

errorCode binaryData(EXIStream* strm, const char* binary_val, Index nbytes);

errorCode dateTimeData(EXIStream* strm, EXIPDateTime dt_val);

errorCode decimalData(EXIStream* strm, Decimal dec_val);

errorCode listData(EXIStream* strm, unsigned int itemCount);

errorCode qnameData(EXIStream* strm, QName qname);

// Miscellaneous

errorCode processingInstruction(EXIStream* strm);

errorCode namespaceDeclaration(EXIStream* strm, const String ns, const String prefix, boolean isLocalElementNS);

// EXI specific

errorCode selfContained(EXIStream* strm);

// EXIP specific

void initHeader(EXIStream* strm);

errorCode initStream(EXIStream* strm, BinaryBuffer buffer, EXIPSchema *schema);

errorCode closeEXIStream(EXIStream* strm);

errorCode flushEXIData(EXIStream* strm, char* outBuf, unsigned int bufSize, unsigned int* bytesFlush);

/****  END: Serializer API implementation  ****/


/**** START: Fast, low level API for schema encoding only ****/

errorCode serializeEvent(EXIStream* strm, EventCode ec, QName* qname);

/****  END: Fast, low level API for schema encoding only ****/

#endif /* EXISERIALIZER_H_ */