lime/grammar__context_8h_source.html

#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;


 /* end grammar_modes */

/* ------------------------------------------------------------------ */

/* ------------------------------------------------------------------ */


typedef struct GrammarContextEntry {

    GrammarMode mode;

    const char *mode_name;

    ParserSnapshot *snapshot;

    int depth;

    uint32_t start_offset;

} GrammarContextEntry;


 /* end ctx_entry */

/* ------------------------------------------------------------------ */

/* ------------------------------------------------------------------ */


typedef struct GrammarModeInfo {

    GrammarMode mode;

    const char *name;

    ParserSnapshot *snapshot;

    int trigger_token;


    const char *trigger_lexeme;


    int exit_token;

} GrammarModeInfo;


 /* end mode_info */

/* ------------------------------------------------------------------ */

/* ------------------------------------------------------------------ */


typedef struct GrammarContextStack GrammarContextStack;


 /* end ctx_stack */

/* ------------------------------------------------------------------ */

/* ------------------------------------------------------------------ */


typedef bool (*ContextSwitchCallback)(GrammarMode prev_mode, GrammarMode new_mode, void *user_data);


 /* end ctx_switch_cb */

/* ------------------------------------------------------------------ */

/* ------------------------------------------------------------------ */


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);


 /* end grammar_ctx_api */

/* ------------------------------------------------------------------ */

/* ------------------------------------------------------------------ */


#define MODE_NONE ((GrammarMode)MODE_SQL)


bool context_switch_register_trigger(GrammarContextStack *stack,

                                     const char *trigger_lexeme,

                                     ParserSnapshot *embedded_snap,

                                     const char *mode_name);


GrammarMode context_switch_classify_lexeme(const GrammarContextStack *stack, const char *lexeme);


bool context_switch_needed(const GrammarContextStack *stack, int token_code, const char *lexeme);


bool context_switch_detect_exit(GrammarContextStack *stack, int token_code, const char *lexeme);


 /* end ctx_switch */

/* ------------------------------------------------------------------ */

/* ------------------------------------------------------------------ */


uint32_t grammar_context_mode_count(const GrammarContextStack *stack);


const GrammarModeInfo *grammar_context_mode_at(const GrammarContextStack *stack, uint32_t i);


 /* end grammar_ctx_introspect */

#endif /* GRAMMAR_CONTEXT_H */

GrammarContextStack
struct GrammarContextStack GrammarContextStack
Opaque grammar context stack handle.
Definition grammar_context.h:149

ContextSwitchCallback
bool(* ContextSwitchCallback)(GrammarMode prev_mode, GrammarMode new_mode, void *user_data)
Called when a context switch occurs.
Definition grammar_context.h:172

context_switch_classify_lexeme
GrammarMode context_switch_classify_lexeme(const GrammarContextStack *stack, const char *lexeme)
Classify a lexeme against the registered triggers.

context_switch_register_trigger
bool context_switch_register_trigger(GrammarContextStack *stack, const char *trigger_lexeme, ParserSnapshot *embedded_snap, const char *mode_name)
Register a runtime trigger that switches into an embedded grammar.

context_switch_detect_exit
bool context_switch_detect_exit(GrammarContextStack *stack, int token_code, const char *lexeme)
Detect whether the current embedded context should exit.

context_switch_needed
bool context_switch_needed(const GrammarContextStack *stack, int token_code, const char *lexeme)
Fast-path predicate: could the current token trigger a switch?

grammar_context_pop
bool grammar_context_pop(GrammarContextStack *stack)
Pop the current grammar context.

grammar_context_create
GrammarContextStack * grammar_context_create(ParserSnapshot *root_snapshot)
Create a context stack with the given root grammar snapshot.

grammar_context_current_mode
GrammarMode grammar_context_current_mode(const GrammarContextStack *stack)
Return the current grammar mode.

grammar_context_destroy
void grammar_context_destroy(GrammarContextStack *stack)
Destroy the context stack and release all snapshot references.

grammar_context_detect_exit
bool grammar_context_detect_exit(GrammarContextStack *stack, int token_code)
Detect whether the current embedded context should end.

grammar_context_current_snapshot
ParserSnapshot * grammar_context_current_snapshot(const GrammarContextStack *stack)
Return the snapshot for the current (topmost) grammar context.

grammar_context_is_root_only
bool grammar_context_is_root_only(const GrammarContextStack *stack)
Check if only the root grammar is active.

grammar_context_register_mode
bool grammar_context_register_mode(GrammarContextStack *stack, const GrammarModeInfo *info)
Register a grammar mode.

grammar_context_set_switch_callback
void grammar_context_set_switch_callback(GrammarContextStack *stack, ContextSwitchCallback cb, void *user_data)
Register a callback to be invoked on context switches.

grammar_context_push
bool grammar_context_push(GrammarContextStack *stack, GrammarMode mode, uint32_t offset)
Explicitly push a grammar mode onto the context stack.

grammar_context_depth
uint32_t grammar_context_depth(const GrammarContextStack *stack)
Return the current nesting depth (0 = root).

grammar_context_close_bracket
bool grammar_context_close_bracket(GrammarContextStack *stack)
Notify the context stack that a bracket/parenthesis was closed.

grammar_context_open_bracket
void grammar_context_open_bracket(GrammarContextStack *stack)
Notify the context stack that a bracket/parenthesis was opened.

grammar_context_detect_switch
bool grammar_context_detect_switch(GrammarContextStack *stack, int token_code, const char *lexeme, uint32_t offset)
Detect whether a context switch should occur.

grammar_context_mode_at
const GrammarModeInfo * grammar_context_mode_at(const GrammarContextStack *stack, uint32_t i)
Read one entry from the registered-mode table.

grammar_context_mode_count
uint32_t grammar_context_mode_count(const GrammarContextStack *stack)
Number of registered modes.

GrammarMode
GrammarMode
Grammar mode identifiers.
Definition grammar_context.h:68

MODE_CUSTOM
@ MODE_CUSTOM
User-defined / extension grammar.
Definition grammar_context.h:74

MODE_JSON
@ MODE_JSON
JSON embedded literal.
Definition grammar_context.h:73

MODE_SQL
@ MODE_SQL
Standard SQL (root grammar)
Definition grammar_context.h:69

MODE_COUNT_
@ MODE_COUNT_
Sentinel (number of built-in modes)
Definition grammar_context.h:75

MODE_XPATH
@ MODE_XPATH
XPath embedded expression.
Definition grammar_context.h:71

MODE_XQUERY
@ MODE_XQUERY
XQuery embedded expression.
Definition grammar_context.h:70

MODE_EDN
@ MODE_EDN
EDN (Extensible Data Notation)
Definition grammar_context.h:72

GrammarContextEntry
One level of the grammar context stack.
Definition grammar_context.h:90

GrammarContextEntry::depth
int depth
Nesting depth (for bracket matching)
Definition grammar_context.h:94

GrammarContextEntry::snapshot
ParserSnapshot * snapshot
Snapshot for this grammar.
Definition grammar_context.h:93

GrammarContextEntry::mode_name
const char * mode_name
Human-readable name (borrowed)
Definition grammar_context.h:92

GrammarContextEntry::mode
GrammarMode mode
Active grammar mode.
Definition grammar_context.h:91

GrammarContextEntry::start_offset
uint32_t start_offset
Input offset where mode began.
Definition grammar_context.h:95

GrammarModeInfo
Describes a grammar mode that can be entered during parsing.
Definition grammar_context.h:112

GrammarModeInfo::name
const char * name
Human-readable name.
Definition grammar_context.h:114

GrammarModeInfo::mode
GrammarMode mode
Which mode this describes.
Definition grammar_context.h:113

GrammarModeInfo::trigger_lexeme
const char * trigger_lexeme
Entry trigger: lexeme prefix that initiates this mode.
Definition grammar_context.h:129

GrammarModeInfo::trigger_token
int trigger_token
Entry trigger: token code that initiates this mode.
Definition grammar_context.h:122

GrammarModeInfo::exit_token
int exit_token
Exit trigger: token code that terminates this mode.
Definition grammar_context.h:136

GrammarModeInfo::snapshot
ParserSnapshot * snapshot
Snapshot to use (reference acquired)
Definition grammar_context.h:115

ParserSnapshot
Opaque snapshot handle.
Definition snapshot.h:177