docs/doc7.0/apip_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 APIP_H_

#define APIP_H_


typedef struct {

    aint uiGroupOpen;

    aint uiGroupError;

    aint uiOptionOpen;

    aint uiOptionError;

    aint uiTlsOpen;

    aint uiClsOpen;

    aint uiProseValOpen;

    aint uiStringTab;

    aint uiBasicError;

} alt_data;


typedef struct {

    char *cpName;

    aint uiIndex;

    aint uiOpOffset;

    aint uiOpCount;

    abool bIsOpen;

    abool bIsComplete;

    aint uiPpptIndex;

    abool bProtected;

} api_rule;


typedef struct {

    char *cpName;

    aint uiIndex;

    aint uiEmpty;

} api_udt;


typedef struct {

    aint uiId;

    aint uiIndex;

    aint uiEmpty;

    aint *uipChildIndex;

    aint uiChildCount;

    luint luiMin;

    luint luiMax;

    luint *luipAchar;

    aint uiAcharLength;

    aint uiCase;

    aint uiMode;

    aint uiBkrIndex;

    aint uiPpptIndex;

} api_op;


typedef struct {

    abool bLeft;

    abool bNested;

    abool bRight;

    abool bCyclic;

    abool bFinite;

    abool bEmpty;

    abool bLeaf;

    char *cpRuleName;

    aint uiRuleIndex;

    aint uiRecursiveType;

    aint uiMRGroup;

    abool *bpRefersToUdt;

    abool *bpRefersTo;

    abool *bpIsReferencedBy;

    // admin during discovery

    abool bIsOpen;

    abool bIsComplete;

} api_attr_w;


typedef struct {

    const void *vpValidate;

    exception* spException;

    void *vpMem;

    void *vpParser;

    void *vpAltStack;

    void *vpAst;

    void *vpAttrsCtx;

    void* vpOutputAcharTable;

    void* vpOutputParserInit;

    luint* luipInit;

    char* cpLineBuffer;


    // input

    void *vpVecInput;

    void* vpVecGrammar;

    char *cpInput;

    aint uiInputLength;

    void* vpLines;

    void* vpVecTempChars;


    // rules & opcodes

    api_rule *spRules;

    aint uiRuleCount;

    api_udt *spUdts;

    aint uiUdtCount;

    char *cpStringTable;

    aint uiStringTableLength;

    aint uiVersionOffset;

    aint uiVersionLength;

    aint uiLicenseOffset;

    aint uiLicenseLength;

    aint uiCopyrightOffset;

    aint uiCopyrightLength;

    luint *luipAcharTable;

    aint uiAcharTableLength;

    aint *uipChildIndexTable;

    aint uiChildIndexTableLength;

    api_op *spOpcodes;

    aint uiOpcodeCount;

//    char *cpInitName; ///< \brief


    // PPPT table

    abool bUsePppt;

    uint8_t *ucpPpptUndecidedMap;

    uint8_t *ucpPpptEmptyMap;

    uint8_t *ucpPpptTable;

    luint luiPpptTableLength;

    luint luiPpptMapCount;

    luint luiPpptMapSize;

    luint luiAcharMin;

    luint luiAcharMax;

    luint luiAcharEos;


    // the error hierarchy

    void *vpLog;


    // the grammar stage indicators.

    abool bInputValid;

    abool bSyntaxValid;

    abool bSemanticsValid;

    abool bAttributesValid;

    abool bAttributesComputed;

} api;


void vLineError(api *spCtx, aint uiCharIndex, const char *cpSrc, const char *cpMsg);

void vHtmlHeader(FILE *spFile, const char *cpTitle);

void vHtmlFooter(FILE *spFile);


#endif /* APIP_H_ */