docs/doc7.0/tracep_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 LIB_TRACEP_H_

#define LIB_TRACEP_H_


#ifdef APG_TRACE


#include <stdio.h>


// apgex handles display of header and footer explicitly


#define TRACE_HEADER_APGEX         2


#define TRACE_HEADER_TRACE         3


typedef struct {

    aint uiTreeDepth;

    int iTraceDepth;

    aint uiThisRecord;

    aint uiOffset;

    aint uiPhraseLength;

    aint uiState;

    const opcode* spOpcode;

} trace_record;


typedef struct{

    abool* bpRules;

    abool* bpUdts;

    abool* bpOps;

    aint uiOutputType;

    aint uiHeaderType;

    aint uiFirstRecord;

    aint uiMaxRecords;

    abool bAllRules;

    abool bAllOps;

    abool bCountOnly;

    abool bPppt;

} trace_config;


typedef struct{

    void* vpMem;

    exception* spException;

    void* vpLog;

    parser* spParserCtx;

    char* cpFileName;

    void* vpVecFileName;

    FILE* spOut;

    FILE* spOpenFile;

    void* vpLookaroundStack;

    aint uiThisRecord;

    aint uiTreeDepth;

    aint uiTreeDepthMax;

    int iTraceDepth;

    int iTraceDepthMax;

    int iTraceDepthMin;

    char* cpBuf;

    aint uiBufSize;

    trace_config sConfig;

} trace;


void vTraceApgexSeparator(void* vpCtx, aint uiLastIndex);

void vTraceApgexType(void* vpCtx, aint uiType);

void vTraceApgexHeader(void* vpCtx);

void vTraceApgexFooter(void* vpCtx);


void vTraceBegin(void* vpCtx);

void vTraceEnd(void* vpCtx);

void vTraceDown(void* vpCtx, const opcode* spOp, aint uiOffset);

void vTraceUp(void* vpCtx, const opcode* spOp, aint uiState, aint uiOffset, aint uiPhraseLength);

void vDisplayRecord(trace* spCtx, trace_record* spRec, abool bIsMatchedPppt);

void vDisplayHeader(trace* spCtx);

void vDisplaySeparator(trace* spCtx, aint uiLastIndex);

void vDisplayFooter(trace* spCtx);

void vSetDefaultConfig(trace* spTrace);


#endif /* APG_TRACE */


#endif /* LIB_TRACEP_H_ */