apfl/src/bytecode.h

#ifndef APFL_BYTECODE_H
#define APFL_BYTECODE_H

#ifdef __cplusplus
extern "C" {
#endif

#include "apfl.h"

#include "gc.h"

enum matcher_instruction {
    MATCHER_IGNORE,
    MATCHER_CAPTURE,     // with index as capture index
    MATCHER_CHECK_CONST, // with index as values index
    MATCHER_CHECK_PRED,  // with index as values index
    MATCHER_ENTER_LIST,
    MATCHER_LEAVE_LIST,
    MATCHER_CONTINUE_FROM_END,
    MATCHER_REMAINDING,
};

union matcher_instruction_or_arg {
    enum matcher_instruction instruction;
    size_t index;
};

struct matcher_instruction_list {
    union matcher_instruction_or_arg *instructions;
    size_t len;
    size_t cap;
    size_t capture_count;
    size_t value_count;
};

enum instruction {
    INSN_NIL,                        // ( -- nil)
    INSN_TRUE,                       // ( -- true)
    INSN_FALSE,                      // ( -- false)
    INSN_NUMBER,                     // ( -- number), arg: number
    INSN_STRING,                     // ( -- string), arg: string
    INSN_LIST,                       // ( -- list), arg: count (preallocation hint)
    INSN_LIST_APPEND,                // ( list val -- list' )
    INSN_LIST_EXPAND_INTO,           // ( list list -- list' )
    INSN_DICT,                       // ( -- dict )
    INSN_DICT_APPEND_KVPAIR,         // ( dict key value -- dict' )
    INSN_GET_MEMBER,                 // ( list/dict key -- value )
    INSN_GET_BY_INDEX_KEEP,          // ( list/dict -- list/dict value ), arg: index
    INSN_VAR_GET,                    // ( -- value ), arg: string
    INSN_VAR_SET,                    // ( value -- value ), arg: string
    INSN_VAR_SET_LOCAL,              // ( value -- value ), arg: string
    INSN_VAR_NEW,                    // ( -- ), arg: string
    INSN_VAR_NEW_LOCAL,              // ( -- ), arg: string
    INSN_MOVE_TO_LOCAL_VAR,          // ( value -- ), arg: string
    INSN_NEXT_LINE,                  // ( -- )
    INSN_SET_LINE,                   // ( -- ), arg: count (new line number)
    INSN_DROP,                       // ( value -- )
    INSN_CALL,                       // ( func list -- value )
    INSN_FUNC,                       // ( -- func ), arg: body
    INSN_MATCHER_LOAD,               // ( -- ), arg: matcher
    INSN_MATCHER_SET_VAL,            // ( val -- ), arg: index
    INSN_MATCHER_MUST_MATCH,         // ( val -- )
    INSN_MATCHER_DROP,               // ( -- )
    INSN_VAR_SET_FROM_MATCHER,       // ( -- ), args: string, index
    INSN_VAR_SET_LOCAL_FROM_MATCHER, // ( -- ), args: string, index
};

union instruction_or_arg {
    enum instruction instruction;
    struct apfl_string *string;
    apfl_number number;
    size_t count;
    size_t index;
    struct instruction_list *body;
    struct matcher_instruction_list *matcher;
};

struct instruction_list {
    union instruction_or_arg *instructions;
    size_t len;
    size_t cap;

    int line;
};

const char *apfl_instruction_to_string(enum instruction);
const char *apfl_matcher_instruction_to_string(enum matcher_instruction);

struct instruction_list *apfl_instructions_new(struct gc *, int line);
void apfl_instructions_deinit(struct apfl_allocator, struct instruction_list *);

void apfl_gc_instructions_traverse(struct instruction_list *, gc_visitor, void *);

struct matcher_instruction_list *apfl_matcher_instructions_new(struct gc *);
void apfl_matcher_instructions_deinit(struct apfl_allocator, struct matcher_instruction_list *);

bool apfl_bytecode_dump(struct apfl_format_writer, struct instruction_list *);

#ifdef __cplusplus
}
#endif

#endif