prism 1.9.0 → 2.0.0.rc2

data/include/prism/options.h

@@ -6,16 +6,27 @@
 #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 "prism/compiler/exported.h"
+#include "prism/compiler/nodiscard.h"
+#include "prism/compiler/nonnull.h"
+
+#include "prism/stringy.h"
 
 #include <stdbool.h>
 #include <stddef.h>
-#include <stdint.h>
 
 /**
- * String literals should be made frozen.
+ * A scope of locals surrounding the code that is being parsed.
+ */
+typedef struct pm_options_scope_t pm_options_scope_t;
+
+/**
+ * The options that can be passed to the parser.
+ */
+typedef struct pm_options_t pm_options_t;
+
+/**
+ * String literals should not be frozen.
  */
 #define PM_OPTIONS_FROZEN_STRING_LITERAL_DISABLED   ((int8_t) -1)
 
@@ -26,42 +37,25 @@
 #define PM_OPTIONS_FROZEN_STRING_LITERAL_UNSET      ((int8_t)  0)
 
 /**
- * String literals should be made mutable.
+ * String literals should be made frozen.
  */
 #define PM_OPTIONS_FROZEN_STRING_LITERAL_ENABLED    ((int8_t)  1)
 
-/**
- * A scope of locals surrounding the code that is being parsed.
- */
-typedef struct pm_options_scope {
-    /** The number of locals in the scope. */
-    size_t locals_count;
-
-    /** The names of the locals in the scope. */
-    pm_string_t *locals;
-
-    /** Flags for the set of forwarding parameters in this scope. */
-    uint8_t forwarding;
-} pm_options_scope_t;
-
 /** The default value for parameters. */
 static const uint8_t PM_OPTIONS_SCOPE_FORWARDING_NONE = 0x0;
 
-/** When the scope is fowarding with the * parameter. */
+/** When the scope is forwarding with the * parameter. */
 static const uint8_t PM_OPTIONS_SCOPE_FORWARDING_POSITIONALS = 0x1;
 
-/** When the scope is fowarding with the ** parameter. */
+/** When the scope is forwarding with the ** parameter. */
 static const uint8_t PM_OPTIONS_SCOPE_FORWARDING_KEYWORDS = 0x2;
 
-/** When the scope is fowarding with the & parameter. */
+/** When the scope is forwarding with the & parameter. */
 static const uint8_t PM_OPTIONS_SCOPE_FORWARDING_BLOCK = 0x4;
 
-/** When the scope is fowarding with the ... parameter. */
+/** When the scope is forwarding with the ... parameter. */
 static const uint8_t PM_OPTIONS_SCOPE_FORWARDING_ALL = 0x8;
 
-// Forward declaration needed by the callback typedef.
-struct pm_options;
-
 /**
  * The callback called when additional switches are found in a shebang comment
  * that need to be processed by the runtime.
@@ -74,130 +68,7 @@ struct pm_options;
  * @param shebang_callback_data Any additional data that should be passed along
  *   to the callback.
  */
-typedef void (*pm_options_shebang_callback_t)(struct pm_options *options, const uint8_t *source, size_t length, void *shebang_callback_data);
-
-/**
- * The version of Ruby syntax that we should be parsing with. This is used to
- * allow consumers to specify which behavior they want in case they need to
- * parse in the same way as a specific version of CRuby would have.
- */
-typedef enum {
-    /** If an explicit version is not provided, the current version of prism will be used. */
-    PM_OPTIONS_VERSION_UNSET = 0,
-
-    /** The vendored version of prism in CRuby 3.3.x. */
-    PM_OPTIONS_VERSION_CRUBY_3_3 = 1,
-
-    /** The vendored version of prism in CRuby 3.4.x. */
-    PM_OPTIONS_VERSION_CRUBY_3_4 = 2,
-
-    /** The vendored version of prism in CRuby 4.0.x. */
-    PM_OPTIONS_VERSION_CRUBY_3_5 = 3,
-
-    /** The vendored version of prism in CRuby 4.0.x. */
-    PM_OPTIONS_VERSION_CRUBY_4_0 = 3,
-
-    /** The vendored version of prism in CRuby 4.1.x. */
-    PM_OPTIONS_VERSION_CRUBY_4_1 = 4,
-
-    /** The current version of prism. */
-    PM_OPTIONS_VERSION_LATEST = PM_OPTIONS_VERSION_CRUBY_4_1
-} pm_options_version_t;
-
-/**
- * The options that can be passed to the parser.
- */
-typedef struct pm_options {
-    /**
-     * The callback to call when additional switches are found in a shebang
-     * comment.
-     */
-    pm_options_shebang_callback_t shebang_callback;
-
-    /**
-     * Any additional data that should be passed along to the shebang callback
-     * if one was set.
-     */
-    void *shebang_callback_data;
-
-    /** The name of the file that is currently being parsed. */
-    pm_string_t filepath;
-
-    /**
-     * The line within the file that the parse starts on. This value is
-     * 1-indexed.
-     */
-    int32_t line;
-
-    /**
-     * The name of the encoding that the source file is in. Note that this must
-     * correspond to a name that can be found with Encoding.find in Ruby.
-     */
-    pm_string_t encoding;
-
-    /**
-     * The number of scopes surrounding the code that is being parsed.
-     */
-    size_t scopes_count;
-
-    /**
-     * The scopes surrounding the code that is being parsed. For most parses
-     * this will be NULL, but for evals it will be the locals that are in scope
-     * surrounding the eval. Scopes are ordered from the outermost scope to the
-     * innermost one.
-     */
-    pm_options_scope_t *scopes;
-
-    /**
-     * The version of prism that we should be parsing with. This is used to
-     * allow consumers to specify which behavior they want in case they need to
-     * parse exactly as a specific version of CRuby.
-     */
-    pm_options_version_t version;
-
-    /** A bitset of the various options that were set on the command line. */
-    uint8_t command_line;
-
-    /**
-    * Whether or not the frozen string literal option has been set.
-    * May be:
-    *  - PM_OPTIONS_FROZEN_STRING_LITERAL_DISABLED
-    *  - PM_OPTIONS_FROZEN_STRING_LITERAL_ENABLED
-    *  - PM_OPTIONS_FROZEN_STRING_LITERAL_UNSET
-    */
-    int8_t frozen_string_literal;
-
-    /**
-     * Whether or not the encoding magic comments should be respected. This is a
-     * niche use-case where you want to parse a file with a specific encoding
-     * but ignore any encoding magic comments at the top of the file.
-     */
-    bool encoding_locked;
-
-    /**
-     * When the file being parsed is the main script, the shebang will be
-     * considered for command-line flags (or for implicit -x). The caller needs
-     * to pass this information to the parser so that it can behave correctly.
-     */
-    bool main_script;
-
-    /**
-     * When the file being parsed is considered a "partial" script, jumps will
-     * not be marked as errors if they are not contained within loops/blocks.
-     * This is used in the case that you're parsing a script that you know will
-     * be embedded inside another script later, but you do not have that context
-     * yet. For example, when parsing an ERB template that will be evaluated
-     * inside another script.
-     */
-    bool partial_script;
-
-    /**
-     * Whether or not the parser should freeze the nodes that it creates. This
-     * makes it possible to have a deeply frozen AST that is safe to share
-     * between concurrency primitives.
-     */
-    bool freeze;
-} pm_options_t;
+typedef void (*pm_options_shebang_callback_t)(pm_options_t *options, const uint8_t *source, size_t length, void *shebang_callback_data);
 
 /**
  * A bit representing whether or not the command line -a option was set. -a
@@ -232,10 +103,26 @@ static const uint8_t PM_OPTIONS_COMMAND_LINE_P = 0x10;
 
 /**
  * A bit representing whether or not the command line -x option was set. -x
- * searches the input file for a shebang that matches the current Ruby engine.
+ * searches the input file for a shebang that includes "ruby".
  */
 static const uint8_t PM_OPTIONS_COMMAND_LINE_X = 0x20;
 
+/**
+ * Allocate a new options struct. If the options struct cannot be allocated,
+ * this function aborts the process.
+ *
+ * @returns A new options struct with default values. It is the responsibility
+ *     of the caller to free this struct using pm_options_free().
+ */
+PRISM_NODISCARD PRISM_EXPORTED_FUNCTION pm_options_t * pm_options_new(void);
+
+/**
+ * Free both the held memory of the given options struct and the struct itself.
+ *
+ * @param options The options struct to free.
+ */
+PRISM_EXPORTED_FUNCTION void pm_options_free(pm_options_t *options) PRISM_NONNULL(1);
+
 /**
  * Set the shebang callback option on the given options struct.
  *
@@ -243,70 +130,64 @@ static const uint8_t PM_OPTIONS_COMMAND_LINE_X = 0x20;
  * @param shebang_callback The shebang callback to set.
  * @param shebang_callback_data Any additional data that should be passed along
  *   to the callback.
+ */
+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_NONNULL(1);
+
+/**
+ * Get the filepath option on the given options struct.
  *
- * \public \memberof pm_options
+ * @param options The options struct to get the filepath from.
+ * @returns The filepath.
  */
-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 const pm_string_t * pm_options_filepath(const pm_options_t *options) PRISM_NONNULL(1);
 
 /**
  * Set the filepath option on the given options struct.
  *
  * @param options The options struct to set the filepath on.
  * @param filepath The filepath to set.
- *
- * \public \memberof pm_options
  */
-PRISM_EXPORTED_FUNCTION void pm_options_filepath_set(pm_options_t *options, const char *filepath);
+PRISM_EXPORTED_FUNCTION void pm_options_filepath_set(pm_options_t *options, const char *filepath) PRISM_NONNULL(1);
 
 /**
  * Set the line option on the given options struct.
  *
  * @param options The options struct to set the line on.
  * @param line The line to set.
- *
- * \public \memberof pm_options
  */
-PRISM_EXPORTED_FUNCTION void pm_options_line_set(pm_options_t *options, int32_t line);
+PRISM_EXPORTED_FUNCTION void pm_options_line_set(pm_options_t *options, int32_t line) PRISM_NONNULL(1);
 
 /**
  * Set the encoding option on the given options struct.
  *
  * @param options The options struct to set the encoding on.
  * @param encoding The encoding to set.
- *
- * \public \memberof pm_options
  */
-PRISM_EXPORTED_FUNCTION void pm_options_encoding_set(pm_options_t *options, const char *encoding);
+PRISM_EXPORTED_FUNCTION void pm_options_encoding_set(pm_options_t *options, const char *encoding) PRISM_NONNULL(1);
 
 /**
  * Set the encoding_locked option on the given options struct.
  *
  * @param options The options struct to set the encoding_locked value on.
  * @param encoding_locked The encoding_locked value to set.
- *
- * \public \memberof pm_options
  */
-PRISM_EXPORTED_FUNCTION void pm_options_encoding_locked_set(pm_options_t *options, bool encoding_locked);
+PRISM_EXPORTED_FUNCTION void pm_options_encoding_locked_set(pm_options_t *options, bool encoding_locked) PRISM_NONNULL(1);
 
 /**
  * Set the frozen string literal option on the given options struct.
  *
  * @param options The options struct to set the frozen string literal value on.
  * @param frozen_string_literal The frozen string literal value to set.
- *
- * \public \memberof pm_options
  */
-PRISM_EXPORTED_FUNCTION void pm_options_frozen_string_literal_set(pm_options_t *options, bool frozen_string_literal);
+PRISM_EXPORTED_FUNCTION void pm_options_frozen_string_literal_set(pm_options_t *options, bool frozen_string_literal) PRISM_NONNULL(1);
 
 /**
  * Sets the command line option on the given options struct.
  *
  * @param options The options struct to set the command line option on.
  * @param command_line The command_line value to set.
- *
- * \public \memberof pm_options
  */
-PRISM_EXPORTED_FUNCTION void pm_options_command_line_set(pm_options_t *options, uint8_t command_line);
+PRISM_EXPORTED_FUNCTION void pm_options_command_line_set(pm_options_t *options, uint8_t command_line) PRISM_NONNULL(1);
 
 /**
  * Set the version option on the given options struct by parsing the given
@@ -316,173 +197,158 @@ PRISM_EXPORTED_FUNCTION void pm_options_command_line_set(pm_options_t *options,
  * @param options The options struct to set the version on.
  * @param version The version to set.
  * @param length The length of the version string.
- * @return Whether or not the version was parsed successfully.
+ * @returns Whether or not the version was parsed successfully.
+ */
+PRISM_EXPORTED_FUNCTION bool pm_options_version_set(pm_options_t *options, const char *version, size_t length) PRISM_NONNULL(1);
+
+/**
+ * Set the version option on the given options struct to the lowest version of
+ * Ruby that prism supports.
+ *
+ * @param options The options struct to set the version on.
+ */
+PRISM_EXPORTED_FUNCTION void pm_options_version_set_lowest(pm_options_t *options) PRISM_NONNULL(1);
+
+/**
+ * Set the version option on the given options struct to the highest version of
+ * Ruby that prism supports.
  *
- * \public \memberof pm_options
+ * @param options The options struct to set the version on.
  */
-PRISM_EXPORTED_FUNCTION bool pm_options_version_set(pm_options_t *options, const char *version, size_t length);
+PRISM_EXPORTED_FUNCTION void pm_options_version_set_highest(pm_options_t *options) PRISM_NONNULL(1);
 
 /**
  * Set the main script option on the given options struct.
  *
  * @param options The options struct to set the main script value on.
  * @param main_script The main script value to set.
- *
- * \public \memberof pm_options
  */
-PRISM_EXPORTED_FUNCTION void pm_options_main_script_set(pm_options_t *options, bool main_script);
+PRISM_EXPORTED_FUNCTION void pm_options_main_script_set(pm_options_t *options, bool main_script) PRISM_NONNULL(1);
 
 /**
  * Set the partial script option on the given options struct.
  *
  * @param options The options struct to set the partial script value on.
  * @param partial_script The partial script value to set.
+ */
+PRISM_EXPORTED_FUNCTION void pm_options_partial_script_set(pm_options_t *options, bool partial_script) PRISM_NONNULL(1);
+
+/**
+ * Get the freeze option on the given options struct.
  *
- * \public \memberof pm_options
+ * @param options The options struct to get the freeze value from.
+ * @returns The freeze value.
  */
-PRISM_EXPORTED_FUNCTION void pm_options_partial_script_set(pm_options_t *options, bool partial_script);
+PRISM_EXPORTED_FUNCTION bool pm_options_freeze(const pm_options_t *options) PRISM_NONNULL(1);
 
 /**
  * Set the freeze option on the given options struct.
  *
  * @param options The options struct to set the freeze value on.
  * @param freeze The freeze value to set.
+ */
+PRISM_EXPORTED_FUNCTION void pm_options_freeze_set(pm_options_t *options, bool freeze) PRISM_NONNULL(1);
+
+/**
+ * Get the attach_comments option on the given options struct.
+ *
+ * @param options The options struct to get the attach_comments value from.
+ * @returns The attach_comments value.
+ */
+PRISM_EXPORTED_FUNCTION bool pm_options_attach_comments(const pm_options_t *options) PRISM_NONNULL(1);
+
+/**
+ * Set the attach_comments option on the given options struct. When this is
+ * set, the parser's comment list is sorted by start offset after parsing and
+ * every comment is assigned an owning node. Without it, comments are left in
+ * the order they were lexed and no nodes own any comments.
  *
- * \public \memberof pm_options
+ * @param options The options struct to set the attach_comments value on.
+ * @param attach_comments The attach_comments value to set.
  */
-PRISM_EXPORTED_FUNCTION void pm_options_freeze_set(pm_options_t *options, bool freeze);
+PRISM_EXPORTED_FUNCTION void pm_options_attach_comments_set(pm_options_t *options, bool attach_comments) PRISM_NONNULL(1);
+
+/**
+ * Get the raise_error option on the given options struct.
+ *
+ * @param options The options struct to get the raise_error value from.
+ * @returns The raise_error value.
+ */
+PRISM_EXPORTED_FUNCTION uint8_t pm_options_raise_error(const pm_options_t *options) PRISM_NONNULL(1);
+
+/**
+ * Set the raise_error option on the given options struct.
+ *
+ * @param options The options struct to set the raise_error value on.
+ * @param raise_error The raise_error value to set.
+ */
+PRISM_EXPORTED_FUNCTION void pm_options_raise_error_set(pm_options_t *options, uint8_t raise_error) PRISM_NONNULL(1);
 
 /**
  * Allocate and zero out the scopes array on the given options struct.
  *
  * @param options The options struct to initialize the scopes array on.
  * @param scopes_count The number of scopes to allocate.
- * @return Whether or not the scopes array was initialized successfully.
- *
- * \public \memberof pm_options
+ * @returns Whether or not the scopes array was initialized successfully.
  */
-PRISM_EXPORTED_FUNCTION bool pm_options_scopes_init(pm_options_t *options, size_t scopes_count);
+PRISM_EXPORTED_FUNCTION bool pm_options_scopes_init(pm_options_t *options, size_t scopes_count) PRISM_NONNULL(1);
 
 /**
- * Return a pointer to the scope at the given index within the given options.
+ * Return a constant pointer to the scope at the given index within the given
+ * options.
  *
  * @param options The options struct to get the scope from.
  * @param index The index of the scope to get.
- * @return A pointer to the scope at the given index.
+ * @returns A constant pointer to the scope at the given index.
+ */
+PRISM_EXPORTED_FUNCTION const pm_options_scope_t * pm_options_scope(const pm_options_t *options, size_t index) PRISM_NONNULL(1);
+
+/**
+ * Return a mutable pointer to the scope at the given index within the given
+ * options.
  *
- * \public \memberof pm_options
+ * @param options The options struct to get the scope from.
+ * @param index The index of the scope to get.
+ * @returns A mutable pointer to the scope at the given index.
  */
-PRISM_EXPORTED_FUNCTION const pm_options_scope_t * pm_options_scope_get(const pm_options_t *options, size_t index);
+PRISM_EXPORTED_FUNCTION pm_options_scope_t * pm_options_scope_mut(pm_options_t *options, size_t index) PRISM_NONNULL(1);
 
 /**
  * Create a new options scope struct. This will hold a set of locals that are in
- * scope surrounding the code that is being parsed.
+ * scope surrounding the code that is being parsed. If the scope was unable to
+ * allocate its locals, this function will abort the process.
  *
  * @param scope The scope struct to initialize.
  * @param locals_count The number of locals to allocate.
- * @return Whether or not the scope was initialized successfully.
- *
- * \public \memberof pm_options
  */
-PRISM_EXPORTED_FUNCTION bool pm_options_scope_init(pm_options_scope_t *scope, size_t locals_count);
+PRISM_EXPORTED_FUNCTION void pm_options_scope_init(pm_options_scope_t *scope, size_t locals_count) PRISM_NONNULL(1);
 
 /**
- * Return a pointer to the local at the given index within the given scope.
+ * Return a constant pointer to the local at the given index within the given
+ * scope.
  *
  * @param scope The scope struct to get the local from.
  * @param index The index of the local to get.
- * @return A pointer to the local at the given index.
- *
- * \public \memberof pm_options
- */
-PRISM_EXPORTED_FUNCTION const pm_string_t * pm_options_scope_local_get(const pm_options_scope_t *scope, size_t index);
-
-/**
- * Set the forwarding option on the given scope struct.
- *
- * @param scope The scope struct to set the forwarding on.
- * @param forwarding The forwarding value to set.
- *
- * \public \memberof pm_options
+ * @returns A constant pointer to the local at the given index.
  */
-PRISM_EXPORTED_FUNCTION void pm_options_scope_forwarding_set(pm_options_scope_t *scope, uint8_t forwarding);
+PRISM_EXPORTED_FUNCTION const pm_string_t * pm_options_scope_local(const pm_options_scope_t *scope, size_t index) PRISM_NONNULL(1);
 
 /**
- * Free the internal memory associated with the options.
+ * Return a mutable pointer to the local at the given index within the given
+ * scope.
  *
- * @param options The options struct whose internal memory should be freed.
- *
- * \public \memberof pm_options
+ * @param scope The scope struct to get the local from.
+ * @param index The index of the local to get.
+ * @returns A mutable pointer to the local at the given index.
  */
-PRISM_EXPORTED_FUNCTION void pm_options_free(pm_options_t *options);
+PRISM_EXPORTED_FUNCTION pm_string_t * pm_options_scope_local_mut(pm_options_scope_t *scope, size_t index) PRISM_NONNULL(1);
 
 /**
- * Deserialize an options struct from the given binary string. This is used to
- * pass options to the parser from an FFI call so that consumers of the library
- * from an FFI perspective don't have to worry about the structure of our
- * options structs. Since the source of these calls will be from Ruby
- * implementation internals we assume it is from a trusted source.
- *
- * `data` is assumed to be a valid pointer pointing to well-formed data. The
- * layout of this data should be the same every time, and is described below:
- *
- * | # bytes | field                      |
- * | ------- | -------------------------- |
- * | `4`     | the length of the filepath |
- * | ...     | the filepath bytes         |
- * | `4`     | the line number            |
- * | `4`     | the length the encoding    |
- * | ...     | the encoding bytes         |
- * | `1`     | frozen string literal      |
- * | `1`     | -p command line option     |
- * | `1`     | -n command line option     |
- * | `1`     | -l command line option     |
- * | `1`     | -a command line option     |
- * | `1`     | the version                |
- * | `1`     | encoding locked            |
- * | `1`     | main script                |
- * | `1`     | partial script             |
- * | `1`     | freeze                     |
- * | `4`     | the number of scopes       |
- * | ...     | the scopes                 |
- *
- * The version field is an enum, so it should be one of the following values:
- *
- * | value | version                   |
- * | ----- | ------------------------- |
- * | `0`   | use the latest version of prism |
- * | `1`   | use the version of prism that is vendored in CRuby 3.3.0 |
- *
- * Each scope is laid out as follows:
- *
- * | # bytes | field                      |
- * | ------- | -------------------------- |
- * | `4`     | the number of locals       |
- * | `1`     | the forwarding flags       |
- * | ...     | the locals                 |
- *
- * Each local is laid out as follows:
- *
- * | # bytes | field                      |
- * | ------- | -------------------------- |
- * | `4`     | the length of the local    |
- * | ...     | the local bytes            |
- *
- * Some additional things to note about this layout:
- *
- * * The filepath can have a length of 0, in which case we'll consider it an
- *   empty string.
- * * The line number should be 0-indexed.
- * * The encoding can have a length of 0, in which case we'll use the default
- *   encoding (UTF-8). If it's not 0, it should correspond to a name of an
- *   encoding that can be passed to `Encoding.find` in Ruby.
- * * The frozen string literal, encoding locked, main script, and partial script
- *   fields are booleans, so their values should be either 0 or 1.
- * * The number of scopes can be 0.
+ * Set the forwarding option on the given scope struct.
  *
- * @param options The options struct to deserialize into.
- * @param data The binary string to deserialize from.
+ * @param scope The scope struct to set the forwarding on.
+ * @param forwarding The forwarding value to set.
  */
-void pm_options_read(pm_options_t *options, const char *data);
+PRISM_EXPORTED_FUNCTION void pm_options_scope_forwarding_set(pm_options_scope_t *scope, uint8_t forwarding) PRISM_NONNULL(1);
 
 #endif