rdesc.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2025-2026 Metehan Selvi <me@metehanselvi.com>
//
// SPDX-License-Identifier: LGPL-2.1-or-later
 
#ifndef RDESC_H
#define RDESC_H
 
#include "detail.h"
 
#include <stdbool.h>
#include <stdint.h>
#include <stddef.h>
 
#define RDESC_VERSION_MAJOR 0
#define RDESC_VERSION_MINOR 2
#define RDESC_VERSION_PATCH 0
#define RDESC_VERSION_PRE_RELEASE "rc.2"
 
 
enum rdesc_result {
        RDESC_ENOMEM = -1,
        RDESC_READY = 0,
        RDESC_CONTINUE = 1,
        RDESC_NOMATCH = 2,
};
 
struct rdesc {
        /* Grammar production rules. */
        const struct rdesc_grammar *grammar;
 
        /* Size in bytes allocated for each token's semantic information. */
        size_t seminfo_size;
 
        /* - Error Recovery -
         *
         * Extra space for holding a token in case of memory allocation error.
         * Token will be copied to those fields for retry in next pump call.
         */
        bool has_saved_tk;
        uint16_t saved_tk;
        void *saved_seminfo;
 
        /* - Navigation - */
        size_t cur  /* (current) Nonterminal being expanded; may not be
                     * the top element. */;
        uint16_t top_unwind  /* Stack's top node's unwind distance. */;
 
        /* Destructor method for tokens the parser owns. */
        void (*token_destroyer)(uint16_t, void *);
 
        /* Token stack used to store tokens temporarily during nonterminal
         * backtracking. */
        struct rdesc_stack *token_stack;
 
        /* Underlying concrete syntax tree. */
        struct rdesc_stack *cst_stack;
 
};
 
struct rdesc_node;
 
 
#ifdef __cplusplus
extern "C" {
#endif
 
const char *rdesc_version(void);
 
int rdesc_init(struct rdesc *parser,
               const struct rdesc_grammar *grammar,
               size_t seminfo_size,
               void (*token_destroyer)(uint16_t id, void *seminfo)) _rdesc_wur;
 
void rdesc_destroy(struct rdesc *parser);
 
int rdesc_start(struct rdesc *parser, uint16_t start_symbol) _rdesc_wur;
 
void rdesc_reset(struct rdesc *parser);
 
enum rdesc_result rdesc_pump(struct rdesc *parser,
                             uint16_t id,
                             void *seminfo) _rdesc_wur;
 
 enum rdesc_result rdesc_resume(struct rdesc *parser) _rdesc_wur;
 
struct rdesc_node *rdesc_root(struct rdesc *parser);
 
#ifdef __cplusplus
}
#endif
 
 
#endif