apgex.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 APGEX_H_
#define APGEX_H_
 
#include "../api/api.h"
 
typedef struct{
    apg_phrase sPhrase; 
    aint uiPhraseOffset; 
} apgex_phrase;
 
typedef struct{
    const char* cpRuleName; 
    apgex_phrase* spPhrases; 
    aint uiPhraseCount; 
    aint uiIndex; 
} apgex_rule;
 
typedef struct{
    apgex_phrase* spResult; 
    apgex_phrase* spLeftContext; 
    apgex_phrase* spRightContext; 
    apgex_rule* spRules; 
    aint uiLastIndex; 
    aint uiRuleCount; 
    aint uiNodeHits; 
    aint uiTreeDepth; 
} apgex_result;
 
typedef struct{
    void* vpParser; 
    void* vpAst; 
    void* vpTrace; 
    const char* cpFlags; 
    const char* cpPattern; 
    apg_phrase sOriginalSource; 
    apg_phrase sLastSource; 
    apgex_phrase sLastMatch; 
    apgex_phrase sLeftContext; 
    apgex_phrase sRightContext; 
    aint uiLastIndex; 
    abool bDefaultMode; 
    abool bGlobalMode; 
    abool bPpptMode; 
    abool bStickyMode; 
    abool bTraceMode; 
    abool bTraceHtmlMode; 
} apgex_properties;
 
typedef apg_phrase (*pfn_replace)(apgex_result* spResult, apgex_properties* spProperties, void* vpUser);
 
void* vpApgexCtor(exception* spEx);
void vApgexDtor(void* vpCtx);
 
void vApgexPattern(void* vpCtx, const char* cpPattern, const char* cpFlags);
void vApgexPatternFile(void* vpCtx, const char* cpFileName, const char* cpFlags);
void vApgexPatternParser(void* vpCtx, void* vpParser, const char* cpFlags);
 
void vApgexEnableRules(void* vpCtx, const char* cpNames, abool bEnable);
void vApgexDefineUDT(void* vpCtx, const char* cpName, parser_callback pfnUdt);
void vApgexSetLastIndex(void* vpCtx, aint uiLastIndex);
 
apgex_result sApgexExec(void* vpCtx, apg_phrase* spSource);
apg_phrase sApgexReplace(void* vpCtx, apg_phrase* spSource, apg_phrase* spReplacement);
apg_phrase sApgexReplaceFunc(void* vpCtx, apg_phrase* spSource, pfn_replace pfnFunc, void* vpUser);
apg_phrase* spApgexSplit(void* vpCtx, apg_phrase* spSource, aint uiLimit, aint* uipCount);
abool bApgexTest(void* vpCtx, apg_phrase* spSource);
apgex_properties sApgexProperties(void* vpCtx);
void* vpApgexGetAst(void* vpCtx);
void* vpApgexGetTrace(void* vpCtx);
void* vpApgexGetParser(void* vpCtx);
 
void vApgexDisplayResult(void* vpCtx, apgex_result* spResult, const char* cpFileName);
void vApgexDisplayPhrase(void* vpCtx, apgex_phrase* spPhrase, const char* cpFileName);
void vApgexDisplayProperties(void* vpCtx, apgex_properties* spProperties, const char* cpFileName);
void vApgexDisplayPatternErrors(void* vpCtx, const char* cpFileName);
 
void vApgexBkrCheck(exception* spEx);
#endif /* APGEX_H_ */