options.h

Go to the documentation of this file.

#ifndef PRISM_OPTIONS_H
#define PRISM_OPTIONS_H
 
#include "prism/defines.h"
#include "prism/util/pm_char.h"
#include "prism/util/pm_string.h"
 
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>

#define PM_OPTIONS_FROZEN_STRING_LITERAL_DISABLED   ((int8_t) -1)

#define PM_OPTIONS_FROZEN_STRING_LITERAL_UNSET      ((int8_t)  0)

#define PM_OPTIONS_FROZEN_STRING_LITERAL_ENABLED    ((int8_t)  1)

typedef struct pm_options_scope {
    size_t locals_count;

    pm_string_t *locals;

    uint8_t forwarding;
} pm_options_scope_t;

static const uint8_t PM_OPTIONS_SCOPE_FORWARDING_NONE = 0x0;

static const uint8_t PM_OPTIONS_SCOPE_FORWARDING_POSITIONALS = 0x1;

static const uint8_t PM_OPTIONS_SCOPE_FORWARDING_KEYWORDS = 0x2;

static const uint8_t PM_OPTIONS_SCOPE_FORWARDING_BLOCK = 0x4;

static const uint8_t PM_OPTIONS_SCOPE_FORWARDING_ALL = 0x8;
 
// Forward declaration needed by the callback typedef.
struct pm_options;

typedef void (*pm_options_shebang_callback_t)(struct pm_options *options, const uint8_t *source, size_t length, void *shebang_callback_data);

typedef enum {
    PM_OPTIONS_VERSION_UNSET = 0,

    PM_OPTIONS_VERSION_CRUBY_3_3 = 1,

    PM_OPTIONS_VERSION_CRUBY_3_4 = 2,

    PM_OPTIONS_VERSION_CRUBY_3_5 = 3,

    PM_OPTIONS_VERSION_LATEST = PM_OPTIONS_VERSION_CRUBY_3_5
} pm_options_version_t;

typedef struct pm_options {
    pm_options_shebang_callback_t shebang_callback;

    void *shebang_callback_data;

    pm_string_t filepath;

    int32_t line;

    pm_string_t encoding;

    size_t scopes_count;

    pm_options_scope_t *scopes;

    pm_options_version_t version;

    uint8_t command_line;

    int8_t frozen_string_literal;

    bool encoding_locked;

    bool main_script;

    bool partial_script;

    bool freeze;
} pm_options_t;

static const uint8_t PM_OPTIONS_COMMAND_LINE_A = 0x1;

static const uint8_t PM_OPTIONS_COMMAND_LINE_E = 0x2;

static const uint8_t PM_OPTIONS_COMMAND_LINE_L = 0x4;

static const uint8_t PM_OPTIONS_COMMAND_LINE_N = 0x8;

static const uint8_t PM_OPTIONS_COMMAND_LINE_P = 0x10;

static const uint8_t PM_OPTIONS_COMMAND_LINE_X = 0x20;

PRISM_EXPORTED_FUNCTION void pm_options_shebang_callback_set(pm_options_t *options, pm_options_shebang_callback_t shebang_callback, void *shebang_callback_data);

PRISM_EXPORTED_FUNCTION void pm_options_filepath_set(pm_options_t *options, const char *filepath);

PRISM_EXPORTED_FUNCTION void pm_options_line_set(pm_options_t *options, int32_t line);

PRISM_EXPORTED_FUNCTION void pm_options_encoding_set(pm_options_t *options, const char *encoding);

PRISM_EXPORTED_FUNCTION void pm_options_encoding_locked_set(pm_options_t *options, bool encoding_locked);

PRISM_EXPORTED_FUNCTION void pm_options_frozen_string_literal_set(pm_options_t *options, bool frozen_string_literal);

PRISM_EXPORTED_FUNCTION void pm_options_command_line_set(pm_options_t *options, uint8_t command_line);

PRISM_EXPORTED_FUNCTION bool pm_options_version_set(pm_options_t *options, const char *version, size_t length);

PRISM_EXPORTED_FUNCTION void pm_options_main_script_set(pm_options_t *options, bool main_script);

PRISM_EXPORTED_FUNCTION void pm_options_partial_script_set(pm_options_t *options, bool partial_script);

PRISM_EXPORTED_FUNCTION void pm_options_freeze_set(pm_options_t *options, bool freeze);

PRISM_EXPORTED_FUNCTION bool pm_options_scopes_init(pm_options_t *options, size_t scopes_count);

PRISM_EXPORTED_FUNCTION const pm_options_scope_t * pm_options_scope_get(const pm_options_t *options, size_t index);

PRISM_EXPORTED_FUNCTION bool pm_options_scope_init(pm_options_scope_t *scope, size_t locals_count);

PRISM_EXPORTED_FUNCTION const pm_string_t * pm_options_scope_local_get(const pm_options_scope_t *scope, size_t index);

PRISM_EXPORTED_FUNCTION void pm_options_scope_forwarding_set(pm_options_scope_t *scope, uint8_t forwarding);

PRISM_EXPORTED_FUNCTION void pm_options_free(pm_options_t *options);

void pm_options_read(pm_options_t *options, const char *data);
 
#endif