docs/doc7.0/xml_8h_source.html

/*  *************************************************************************************

    Copyright (c) 2021, Lowell D. Thomas

    All rights reserved.


    This file is part of APG Version 7.0.

    APG Version 7.0 may be used under the terms of the BSD 2-Clause License.


    Redistribution and use in source and binary forms, with or without

    modification, are permitted provided that the following conditions are met:


    1. Redistributions of source code must retain the above copyright notice, this

       list of conditions and the following disclaimer.


    2. Redistributions in binary form must reproduce the above copyright notice,

       this list of conditions and the following disclaimer in the documentation

       and/or other materials provided with the distribution.


    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"

    AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE

    IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE

    DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE

    FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL

    DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR

    SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER

    CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,

    OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE

    OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.


*   *************************************************************************************/

#ifndef APG_XML_H_

#define APG_XML_H_


#include <limits.h>

#include "../utilities/utilities.h"


#define DEFAULT_CALLBACK (void*)1


typedef struct{

    const char* cpExists;

    const char* cpVersion;

    const char* cpEncoding;

    const char* cpStandalone;

} xmldecl_info;


typedef struct{

    abool bExists;

    abool bStandalone;

    abool bExtSubset;

    aint uiExternalIds;

    aint uiPEDecls;

    aint uiPERefs;

    aint uiGEDeclsDeclared;

    aint uiGEDeclsUnique;

    aint uiGEDeclsNotProcessed;

    aint uiAttListsDeclared;

    aint uiAttListsUnique;

    aint uiAttListsNotProcessed;

    u32_phrase* spName;

    u32_phrase* spGENames;

    u32_phrase* spGEValues;

    u32_phrase* spAttElementNames;

    u32_phrase* spAttNames;

    u32_phrase* spAttTypes;

    u32_phrase* spAttValues;

    u32_phrase* spNotationNames;

    u32_phrase* spNotationValues;

    aint uiNotationDecls;

    aint uiElementDecls;

} dtd_info;


typedef void (*pfnXmlDeclCallback)(xmldecl_info* spInfo, void* vpUserData);


typedef void (*pfnDTDCallback)(dtd_info* spInfo, void* vpUserData);


typedef void (*pfnStartTagCallback)(u32_phrase* spName, u32_phrase* spAttNames,

        u32_phrase* spAttValues, uint32_t uiAttCount, void* vpUserData);


typedef void (*pfnEmptyTagCallback)(u32_phrase* spName, u32_phrase* spAttrNames,

        u32_phrase* spAttrValues, uint32_t uiAttrCount, void* vpUserData);


typedef void (*pfnEndTagCallback)(u32_phrase* spName, u32_phrase* spContent, void* vpUserData);


typedef void (*pfnPICallback)(u32_phrase* spTarget, u32_phrase* spInfo, void* vpUserData);


typedef void (*pfnCommentCallback)(u32_phrase* spComment, void* vpUserData);


// constructor/destructor

void* vpXmlCtor(exception* spEx);

void vXmlDtor(void* vpCtx);

abool bXmlValidate(void* vpCtx);


// the XML input

void vXmlGetFile(void* vpCtx, const char* cpFileName);

void vXmlGetArray(void* vpCtx, uint8_t* ucpData, aint uiDataLen);


// parsing

void vXmlParse(void* vpCtx);

void vXmlSetXmlDeclCallback(void* vpCtx, pfnXmlDeclCallback pfnCallback, void* vpUserData);

void vXmlSetDTDCallback(void* vpCtx, pfnDTDCallback pfnCallback, void* vpUserData);

void vXmlSetEmptyTagCallback(void* vpCtx, pfnEmptyTagCallback pfnCallback, void* vpUserData);

void vXmlSetStartTagCallback(void* vpCtx, pfnStartTagCallback pfnCallback, void* vpUserData);

void vXmlSetEndTagCallback(void* vpCtx, pfnEndTagCallback pfnCallback, void* vpUserData);

void vXmlSetPICallback(void* vpCtx, pfnPICallback pfnCallback, void* vpUserData);

void vXmlSetCommentCallback(void* vpCtx, pfnCommentCallback pfnCallback, void* vpUserData);


// display

void vXmlDisplayInput(void* vpCtx, abool bShowLines);

void vXmlDisplayMsgs(void* vpCtx);

void* vpXmlGetMsgs(void* vpCtx);


#endif /* APG_XML_H_ */