snapshot_build.h

Go to the documentation of this file.

 
#ifndef SNAPSHOT_BUILD_H
#define SNAPSHOT_BUILD_H
 
#include "snapshot.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef struct LimeParserTables {
    /* Action tables */
    const uint16_t *yy_action;
    uint32_t yy_action_count;
    const uint16_t *yy_lookahead;
    uint32_t yy_lookahead_count;
    const int32_t *yy_shift_ofst;
    const int32_t *yy_reduce_ofst;
    const uint16_t *yy_default;
    uint32_t nstate;
 
    /* Rule metadata */
    const int16_t *yy_rule_info_lhs;
    const int8_t *yy_rule_info_nrhs;
    uint32_t nrule;
 
    /* Counts */
    uint32_t nsymbol;
    uint32_t nterminal;
 
    /* Optional symbol-name table (the generated yyTokenName[]), indexed
    ** by internal symbol index: [0]="$", [1..nterminal-1]=terminals,
    ** [nterminal..nsymbol-1]=nonterminals.  When supplied,
    ** snapshot_build_from_tables deep-copies it so the snapshot can map
    ** a token NAME -> external code (lime_snapshot_token_code), which a
    ** scanner needs to emit the right code for an extension keyword in
    ** a recompiled/composed snapshot.  NULL when the generator did not
    ** emit names (recognition-only / pre-name-table lime); the lookup
    ** then returns -1. */
    const char *const *token_names;
    uint32_t token_names_count; /* = nsymbol when token_names != NULL */
    uint16_t ntoken; /* YYNTOKEN = highest terminal + 1 */
    /* YYFIRSTTOKEN: the %first_token directive value (0 when not
    ** declared).  Subtracted from external token codes by parse_token
    ** to compute the internal action-table index.  Paired with
    ** ntoken: the valid external code range is
    ** [first_token, first_token + ntoken). */
    uint16_t first_token;
 
    /* Action-range constants */
    uint16_t yy_max_shift;
    uint16_t yy_min_shiftreduce;
    uint16_t yy_max_shiftreduce;
    uint16_t yy_error_action;
    uint16_t yy_accept_action;
    uint16_t yy_no_action;
    uint16_t yy_min_reduce;
 
    /* Optional fallback (NULL when grammar has no %fallback) */
    const uint16_t *yy_fallback;
    uint32_t nfallback;
 
    /* Optional original grammar source text.  Embedded by `lime -n`
    ** so the runtime extension framework can rebuild the LALR(1)
    ** automaton from a base snapshot plus a list of modifications:
    ** publish_modified_snapshot() concatenates this text with
    ** lime_modifications_to_grammar_text(mods) and reruns the
    ** subprocess pipeline (lime + cc) on the merged grammar.
    **
    ** NULL when the snapshot was built by a path that did not have
    ** access to the original .y text (e.g. a hand-built snapshot
    ** for testing).  Callers that want runtime grammar mutation
    ** must supply this, or a base snapshot whose generated builder
    ** populated it.  Length is the byte count NOT including a
    ** trailing NUL (the array always has one for C-string-friendly
    ** consumption). */
    const char *grammar_source;
    uint32_t grammar_source_len;
 
    /* Magic + ABI version pair.  Set unconditionally by the
    ** generator.  snapshot_build_from_tables checks both and
    ** rejects mismatched bundles with a clear error rather than
    ** silently producing a wrong snapshot.  v0.6.3 generated
    ** *_snapshot.c files leave these zero (partial initialiser);
    ** v0.7.0+ runtime detects that and reports "snapshot was
    ** built against pre-v0.7.0 lime; rebuild required". */
    uint32_t magic;       /* LIME_TABLES_MAGIC */
    uint16_t abi_version; /* LIME_TABLES_ABI_VERSION */
 
    /* Optional host-reduce hook (Letter 30).  `lime -n` sets this to
    ** the generated, exported <Name>HostReduce wrapper so the push
    ** parser can run BASE-grammar reduce actions over the snapshot.
    ** NULL for recognition-only snapshots (and for tables emitted by
    ** pre-host-reduce lime), in which case parse_token accepts/rejects
    ** without running actions.  Copied verbatim into the snapshot. */
    LimeHostReduceFn host_reduce;
    void *host_reduce_user;
} LimeParserTables;
 
#define LIME_TABLES_MAGIC       0x4C494D45U   /* 'L','I','M','E' */
#define LIME_TABLES_ABI_VERSION 1
 
ParserSnapshot *snapshot_build_from_tables(const LimeParserTables *tables);
 
#ifdef __cplusplus
}
#endif
 
#endif /* SNAPSHOT_BUILD_H */