grammar_context.h

Go to the documentation of this file.

 
#ifndef GRAMMAR_CONTEXT_H
#define GRAMMAR_CONTEXT_H
 
#include <stdbool.h>
#include <stdint.h>
 
/* ------------------------------------------------------------------ */
/*  Forward declarations                                               */
/* ------------------------------------------------------------------ */
 
typedef struct ParserSnapshot ParserSnapshot;
 
/* ------------------------------------------------------------------ */
/* ------------------------------------------------------------------ */
 
typedef enum GrammarMode {
    MODE_SQL = 0,             
    MODE_XQUERY,              
    MODE_XPATH,               
    MODE_EDN,                 
    MODE_JSON,                
    MODE_CUSTOM,              
    MODE_COUNT_               
} GrammarMode;
 
 
/* ------------------------------------------------------------------ */
/* ------------------------------------------------------------------ */
 
typedef struct GrammarContextEntry {
    GrammarMode mode;                 
    const char *mode_name;            
    ParserSnapshot *snapshot;         
    int depth;                        
    uint32_t start_offset;            
} GrammarContextEntry;
 
 
/* ------------------------------------------------------------------ */
/* ------------------------------------------------------------------ */
 
typedef struct GrammarModeInfo {
    GrammarMode mode;                 
    const char *name;                 
    ParserSnapshot *snapshot;         
    int trigger_token;
 
    const char *trigger_lexeme;
 
    int exit_token;
} GrammarModeInfo;
 
 
/* ------------------------------------------------------------------ */
/* ------------------------------------------------------------------ */
 
typedef struct GrammarContextStack GrammarContextStack;
 
 
/* ------------------------------------------------------------------ */
/* ------------------------------------------------------------------ */
 
typedef bool (*ContextSwitchCallback)(GrammarMode prev_mode,
                                      GrammarMode new_mode,
                                      void *user_data);
 
 
/* ------------------------------------------------------------------ */
/* ------------------------------------------------------------------ */
 
GrammarContextStack *grammar_context_create(ParserSnapshot *root_snapshot);
 
void grammar_context_destroy(GrammarContextStack *stack);
 
bool grammar_context_register_mode(GrammarContextStack *stack,
                                   const GrammarModeInfo *info);
 
bool grammar_context_detect_switch(GrammarContextStack *stack,
                                   int token_code,
                                   const char *lexeme,
                                   uint32_t offset);
 
bool grammar_context_detect_exit(GrammarContextStack *stack,
                                 int token_code);
 
bool grammar_context_push(GrammarContextStack *stack,
                          GrammarMode mode,
                          uint32_t offset);
 
bool grammar_context_pop(GrammarContextStack *stack);
 
ParserSnapshot *grammar_context_current_snapshot(
    const GrammarContextStack *stack);
 
GrammarMode grammar_context_current_mode(
    const GrammarContextStack *stack);
 
uint32_t grammar_context_depth(const GrammarContextStack *stack);
 
void grammar_context_set_switch_callback(GrammarContextStack *stack,
                                         ContextSwitchCallback cb,
                                         void *user_data);
 
void grammar_context_open_bracket(GrammarContextStack *stack);
 
bool grammar_context_close_bracket(GrammarContextStack *stack);
 
bool grammar_context_is_root_only(const GrammarContextStack *stack);
 
 
#endif /* GRAMMAR_CONTEXT_H */