parser.h

Go to the documentation of this file.

/*  *************************************************************************************
    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 LIB_PARSER_H_
#define LIB_PARSER_H_
 
#define ID_ALT   1 
#define ID_CAT   2 
#define ID_REP   3 
#define ID_RNM   4 
#define ID_TRG   5 
#define ID_TBS   6 
#define ID_TLS   7 
 
#define ID_UDT   8 
#define ID_AND   9 
#define ID_NOT   10 
#define ID_BKR   11 
#define ID_BKA   12 
#define ID_BKN   13 
#define ID_ABG   14 
#define ID_AEN   15 
#define ID_GEN   19 
 
#define ID_ACTIVE               20 
#define ID_MATCH                21 
#define ID_NOMATCH              22 
#define ID_EMPTY                23 
 
#define ID_PPPT_NOMATCH         0 
#define ID_PPPT_MATCH           1 
#define ID_PPPT_EMPTY           2 
#define ID_PPPT_ACTIVE          3 
 
#define ID_AST_PRE              30 
#define ID_AST_POST             31 
#define ID_AST_OK               32 
#define ID_AST_SKIP             33 
 
#define ID_ATTR_N               40 
#define ID_ATTR_R               41 
#define ID_ATTR_MR              42 
 
#define ID_LOOKAROUND_NONE      50 
#define ID_LOOKAROUND_AHEAD     51 
#define ID_LOOKAROUND_BEHIND    52 
 
#define ID_BKR_MODE_U           60 
#define ID_BKR_MODE_P           61 
#define ID_BKR_CASE_S           62 
#define ID_BKR_CASE_I           63 
 
 
typedef struct {
    // only the 3 members below are to be changed by user
    void* vpUserData;
    aint uiCallbackState; 
    aint uiCallbackPhraseLength;
    // Parser will produce unpredictable results if user changes any of the values below.
    const achar* acpString; 
    aint uiStringLength; 
    aint uiParserState; 
    aint uiParserOffset; 
    aint uiParserPhraseLength; 
    aint uiRuleIndex; 
    aint uiUDTIndex; 
    exception* spException; 
    // For system use only.
    void* vpCtx; 
    void* vpMem; 
} callback_data;
 
typedef void (*parser_callback)(callback_data* spData);
 
typedef struct{
    aint uiSuccess; 
    aint uiState; 
    aint uiPhraseLength; 
    aint uiStringLength; 
    aint uiMaxTreeDepth; 
    aint uiHitCount; 
} parser_state;
 
typedef struct {
    const achar* acpInput; 
    aint uiInputLength; 
    aint uiStartRule; 
    abool bParseSubString; 
    aint uiSubStringBeg; 
    aint uiSubStringLength; 
    aint uiLookBehindLength; 
    void* vpUserData; 
} parser_config;
 
void* vpParserCtor(exception* spException, void* vpParserInit);
void vParserDtor(void* vpCtx);
abool bParserValidate(void* vpCtx);
void vParserParse(void* vpCtx, parser_config* spConfig, parser_state* spState);
aint uiParserRuleLookup(void* vpCtx, const char* cpRuleName);
aint uiParserUdtLookup(void* vpCtx, const char* cpUdtName);
const char* cpParserRuleName(void* vpCtx, aint uiRuleIndex);
const char* cpParserUdtName(void* vpCtx, aint uiUdtIndex);
void vParserSetRuleCallback(void* vpCtx, aint uiRuleId, parser_callback pfnCallback);
void vParserSetUdtCallback(void* vpCtx, aint uiUdtId, parser_callback pfnCallback);
 
#endif /* LIB_PARSER_H_ */