api.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 API_H_
#define API_H_
 
#include <limits.h>
 
#include "../utilities/utilities.h"
 
typedef struct {
    abool bLeft; 
    abool bNested; 
    abool bRight; 
    abool bCyclic; 
    abool bFinite; 
    abool bEmpty; 
    const char *cpRuleName; 
    aint uiRuleIndex; 
    aint uiRecursiveType; 
    aint uiMRGroup; 
} api_attr;
 
typedef struct{
    luint luiAcharMin; 
    luint luiAcharMax; 
    luint luiMapSize; 
    luint luiMaps; 
    luint luiTableSize; 
} pppt_size;
 
// the API constructor and destructor
void* vpApiCtor(exception* spEx);
void vApiDtor(void *vpCtx);
abool bApiValidate(void *vpCtx);
void* vpApiGetErrorLog(void *vpCtx);
 
// the input API - get, validate and manipulate the SABNF grammar characters
void vApiInClear(void *vpCtx);
const char* cpApiInFile(void *vpCtx, const char *cpFileName);
const char* cpApiInString(void *vpCtx, const char *cpString);
void vApiInValidate(void *vpCtx, abool bStrict);
void vApiInToAscii(void *vpCtx, const char *cpFileName);
void vApiInToHtml(void *vpCtx, const char *cpFileName, const char *cpTitle);
 
// the syntax API - parsing the SABNF grammar
void vApiSyntax(void *vpCtx, abool bStrict);
 
// the semantics API - translating the SABNF grammar AST to APG opcodes
void vApiOpcodes(void *vpCtx);
void vApiOpcodesToAscii(void *vpCtx, const char *cpFileName);
void vApiRulesToAscii(void *vpCtx, const char *cpMode, const char *cpFileName);
void vApiRulesToHtml(void *vpCtx, const char *cpFileName);
 
// the attributes API - analyzing the SABNF grammar's opcodes
abool bApiAttrs(void *vpCtx);
//const api_attr* spApiAttrsErrors(void *vpCtx, aint* uipCount);
void vApiAttrsToAscii(void *vpCtx, const char *cpMode, const char *cpFileName);
void vApiAttrsErrorsToAscii(void *vpCtx, const char *cpMode, const char *cpFileName);
 
// the Partially-Predictive Parsing Tables (PPPT)
void vApiPppt(void *vpCtx, char **cppProtectedRules, aint uiProtectedRules);
void vApiPpptSize(void *vpCtx, pppt_size* spSize);
 
// full parser generation tools
void vApiFile(void *vpCtx, const char *cpFileName, abool bStrict, abool bPppt);
void vApiString(void *vpCtx, const char *cpString, abool bStrict, abool bPppt);
 
// the generator API - generate a parser from the SABNF grammar
void vApiOutput(void *vpCtx, const char *cpOutput);
void* vpApiOutputParser(void* vpCtx);
 
#endif /* API_H_ */