xml.h

Go to the documentation of this file.

#ifndef CTL_XML_H
#define CTL_XML_H

#include <stdio.h>
#include <ctl/serial.h>

#define XML_TAB_DEPTH   4

#define CTL_LABEL_TYPE      szconst(char,"type")
#define CTL_LABEL_MBRTYPE   szconst(char,"mbrtype")
#define CTL_LABEL_COUNT     szconst(char,"count")


typedef struct ctl_xmlwrite
{
    ctl_gstring(char)* buff;
    FILE*           fp;     
    int             indent; 
    bool            pretty; 
} ctl_xmlwrite;
bool ctl_xmlwrite_begin( ctl_xmlwrite* self, ctl_gstring(char)* string );
bool ctl_xmlwrite_create( ctl_xmlwrite* self, const char* szPath );
void ctl_xmlwrite_close( ctl_xmlwrite* self );
void ctl_xmlwrite_addheader( ctl_xmlwrite* self );
void ctl_xmlwrite_newline( ctl_xmlwrite* self );
void ctl_xmlwrite_indent( ctl_xmlwrite* self );
void ctl_xmlwrite_outdent( ctl_xmlwrite* self );
void ctl_xmlwrite_generaltag( ctl_xmlwrite* self, const char* type, const char* label );
void ctl_xmlwrite_containertag( ctl_xmlwrite* self, const char* type, size_t count, const char* label );
void ctl_xmlwrite_endtag( ctl_xmlwrite* self, const char* type, const char* label );
void ctl_xmlwrite_string_char( ctl_xmlwrite* self, const char* begin, const char* end );
void ctl_xmlwrite_string_wchar_t( ctl_xmlwrite* self, const wchar_t* begin, const wchar_t* end );


struct ctl_xmlread;
typedef void (*ctl_xmlread_exception)( const struct ctl_xmlread* xml, const char* reason, const char* szP0, const char* szP1 );
typedef struct ctl_xmlread
{
    ctl_xmlread_exception   except;     
    void*           exceptParam;
    const char*     szBegin;    
    const char*     szEnd;      
    const char*     szpCurr;    
    const char*     szpEnd;     
    const char*     szcCurr;    
    const char*     szcEnd;     
    bool            bRecursible;
} ctl_xmlread;
bool ctl_xmlread_init( ctl_xmlread* self, const char* begin, const char* end, ctl_xmlread_exception except, void* exceptParam );
/* Navigate data */
void ctl_xmlread_rewind( ctl_xmlread* self );
bool ctl_xmlread_next( ctl_xmlread* self );
bool ctl_xmlread_find( ctl_xmlread* self, const char* type );
bool ctl_xmlread_findnext( ctl_xmlread* self, const char* type );
bool ctl_xmlread_canrecurse( ctl_xmlread* self );
bool ctl_xmlread_recurse( ctl_xmlread* newself, const ctl_xmlread* self );
/* Get or compare tag's name */
bool ctl_xmlread_getname( const ctl_xmlread* self, ctl_gstring(char)* str );
bool ctl_xmlread_is( const ctl_xmlread* self, const char* str );
/* Get translated contents of tag data */
bool ctl_xmlread_getattribute( ctl_xmlread* self, ctl_gstring(char)* str, const char* label );
bool ctl_xmlread_getattribute_int( ctl_xmlread* self, const char* label, int32* value );
bool ctl_xmlread_getcontent( const ctl_xmlread* self, ctl_gstring(char)* str, bool eatWhite );
bool ctl_xmlread_gettextbefore( const ctl_xmlread* self, ctl_gstring(char)* str, bool eatWhite );
bool ctl_xmlread_gettextafter( const ctl_xmlread* self, ctl_gstring(char)* str, bool eatWhite );
/* Get untranslated contents of tag data - much faster than above, for fields we don't expect to find filled with text stuff */
bool ctl_xmlread_rawname( const ctl_xmlread* self, ctl_sconst(char)* str );
bool ctl_xmlread_rawattribute( ctl_xmlread* self, ctl_sconst(char)* str, const char* label );
bool ctl_xmlread_rawcontent( const ctl_xmlread* self, ctl_sconst(char)* str, bool eatWhite );
bool ctl_xmlread_rawtextbefore( const ctl_xmlread* self, ctl_sconst(char)* str, bool eatWhite );
bool ctl_xmlread_rawtextafter( const ctl_xmlread* self, ctl_sconst(char)* str, bool eatWhite );
/* Some template generated stuff */
bool ctl_xmlread_rawtextbefore( const ctl_xmlread* self, ctl_sconst(char)* str, bool eatWhite );
bool ctl_xmlread_rawtextafter( const ctl_xmlread* self, ctl_sconst(char)* str, bool eatWhite );
/* Translate a string of text in-place in its own buffer */
const char* ctl_xmlread_translate_char( const ctl_xmlread* self, char* begin, const char* end, bool bEatWhite );
const wchar_t* ctl_xmlread_translate_wchar_t( const ctl_xmlread* self, wchar_t* begin, const wchar_t* end, bool bEatWhite );

void char_xml_write_string( const char* buff, size_t size, ctl_xmlwrite* xml, const char* label );
void wchar_t_xml_write_string( const wchar_t* buff, size_t size, ctl_xmlwrite* xml, const char* label );

void char_xml_write_gstring( ctl_gstring(char)* str, ctl_xmlwrite* xml, const char* label );
void wchar_t_xml_write_gstring( ctl_gstring(wchar_t)* str, ctl_xmlwrite* xml, const char* label );

bool char_xml_read_string( char* buff, size_t size, ctl_xmlread* self, const char* label );
bool wchar_t_xml_read_string( wchar_t* buff, size_t size, ctl_xmlread* self, const char* label );

bool char_xml_read_gstring( ctl_gstring(char)* str, ctl_xmlread* self, const char* label );
bool wchar_t_xml_read_gstring( ctl_gstring(wchar_t)* str, ctl_xmlread* self, const char* label );

/* XML Write a scalar/array of whatever type */
#define DECL_scalar_write(type,char)            void ppConcat(type,_xml_write)( const type* p, ctl_xmlwrite* self, const char* label );
#define DECL_scalar_write_array(type,char)      void ppConcat(type,_xml_write_array)( const type* p, size_t count, ctl_xmlwrite* self, const char* label );
DEF_ENUMTYPES(DECL_scalar_write,char)
DEF_ENUMTYPES(DECL_scalar_write_array,char)

/* XML Read a scalar of whatever type */
#define DECL_scalar_read(type,unused)           bool ppConcat(type,_xml_read)( type* p, ctl_xmlread* self, const char* label );
#define DECL_scalar_read_array(type,unused)     bool ppConcat(type,_xml_read_array)( type* p, size_t count, ctl_xmlread* self, const char* label );
DEF_ENUMTYPES(DECL_scalar_read,unused)
DEF_ENUMTYPES(DECL_scalar_read_array,unused)
#undef DECL_scalar_read
#undef DECL_scalar_read_array

/* XML save/restore raw data */
void raw_xml_writebytes( const ctl_serial* serial, ctl_xmlwrite* xml, const char* label );
bool raw_xml_readbytes( ctl_serial* serial, ctl_xmlread* self, const char* label );


#endif /* CTL_XML_H */