Move list out of utils

Author: kddnewton

include/prism/internal/diagnostic.h

@@ -8,7 +8,6 @@
 
 #include "prism/diagnostic.h"
 #include "prism/arena.h"
-#include "prism/util/pm_list.h"
 
 /**
  * Append a diagnostic to the given list of diagnostics that is using shared

include/prism/util/pm_list.h include/prism/list.hinclude/prism/util/pm_list.h renamed to include/prism/list.h

@@ -1,17 +1,12 @@
 /**
- * @file pm_list.h
+ * @file list.h
  *
  * An abstract linked list.
  */
 #ifndef PRISM_LIST_H
 #define PRISM_LIST_H
 
-#include "prism/defines.h"
-
-#include <stdbool.h>
 #include <stddef.h>
-#include <stdint.h>
-#include <stdlib.h>
 
 /**
  * This struct represents an abstract linked list that provides common
@@ -63,25 +58,13 @@ typedef struct {
     pm_list_node_t *tail;
 } pm_list_t;
 
-/**
- * Returns true if the given list is empty.
- *
- * @param list The list to check.
- * @return True if the given list is empty, otherwise false.
- *
- * \public \memberof pm_list_t
- */
-PRISM_EXPORTED_FUNCTION bool pm_list_empty_p(pm_list_t *list);
-
 /**
  * Returns the size of the list.
  *
  * @param list The list to check.
  * @return The size of the list.
- *
- * \public \memberof pm_list_t
  */
-PRISM_EXPORTED_FUNCTION size_t pm_list_size(pm_list_t *list);
+size_t pm_list_size(pm_list_t *list);
 
 /**
  * Append a node to the given list.
@@ -91,13 +74,4 @@ PRISM_EXPORTED_FUNCTION size_t pm_list_size(pm_list_t *list);
  */
 void pm_list_append(pm_list_t *list, pm_list_node_t *node);
 
-/**
- * Deallocate the internal state of the given list.
- *
- * @param list The list to free.
- *
- * \public \memberof pm_list_t
- */
-PRISM_EXPORTED_FUNCTION void pm_list_free(pm_list_t *list);
-
 #endif

include/prism/parser.h

@@ -12,10 +12,10 @@
 #include "prism/constant_pool.h"
 #include "prism/encoding.h"
 #include "prism/line_offset_list.h"
+#include "prism/list.h"
 #include "prism/options.h"
 #include "prism/static_literals.h"
 #include "prism/strings.h"
-#include "prism/util/pm_list.h"
 
 #include <stdbool.h>
 

prism.gemspec

@@ -64,6 +64,7 @@ Gem::Specification.new do |spec|
     "include/prism/files.h",
     "include/prism/integer.h",
     "include/prism/line_offset_list.h",
+    "include/prism/list.h",
     "include/prism/node.h",
     "include/prism/node_new.h",
     "include/prism/options.h",
@@ -85,7 +86,6 @@ Gem::Specification.new do |spec|
     "include/prism/internal/strncasecmp.h",
     "include/prism/internal/strings.h",
     "include/prism/internal/strpbrk.h",
-    "include/prism/util/pm_list.h",
     "include/prism/version.h",
     "lib/prism.rb",
     "lib/prism/compiler.rb",
@@ -183,6 +183,7 @@ Gem::Specification.new do |spec|
     "src/encoding.c",
     "src/integer.c",
     "src/line_offset_list.c",
+    "src/list.c",
     "src/memchr.c",
     "src/node.c",
     "src/options.c",
@@ -194,8 +195,7 @@ Gem::Specification.new do |spec|
     "src/strings.c",
     "src/strncasecmp.c",
     "src/strpbrk.c",
-    "src/token_type.c",
-    "src/util/pm_list.c"
+    "src/token_type.c"
   ]
 
   spec.extensions = ["ext/prism/extconf.rb"]

rust/ruby-prism-sys/build/main.rs

@@ -149,8 +149,6 @@ fn generate_bindings(ruby_include_path: &Path) -> bindgen::Bindings {
         // Functions
         .allowlist_function("pm_arena_free")
         .allowlist_function("pm_line_offset_list_line_column")
-        .allowlist_function("pm_list_empty_p")
-        .allowlist_function("pm_list_free")
         .allowlist_function("pm_options_command_line_set")
         .allowlist_function("pm_options_encoding_locked_set")
         .allowlist_function("pm_options_encoding_set")

rust/ruby-prism-sys/tests/utils_tests.rs

@@ -1,7 +1,4 @@
-use std::{
-    ffi::{CStr, CString},
-    mem::MaybeUninit,
-};
+use std::ffi::{CStr, CString};
 
 #[test]
 fn version_test() {
@@ -15,21 +12,6 @@ fn version_test() {
     assert_eq!(&cstring.to_string_lossy(), "1.9.0");
 }
 
-#[test]
-fn list_test() {
-    use ruby_prism_sys::{pm_list_empty_p, pm_list_free, pm_list_t};
-
-    let mut list = MaybeUninit::<pm_list_t>::zeroed();
-
-    unsafe {
-        let list = list.assume_init_mut();
-
-        assert!(pm_list_empty_p(list));
-
-        pm_list_free(list);
-    }
-}
-
 mod string {
     use ruby_prism_sys::{
         pm_string_free, pm_string_length, pm_string_source, pm_string_t, pm_string_t__bindgen_ty_1, PM_STRING_CONSTANT,

src/list.c

@@ -0,0 +1,24 @@
+#include "prism/list.h"
+
+/**
+ * Returns the size of the list.
+ */
+size_t
+pm_list_size(pm_list_t *list) {
+    return list->size;
+}
+
+/**
+ * Append a node to the given list.
+ */
+void
+pm_list_append(pm_list_t *list, pm_list_node_t *node) {
+    if (list->head == NULL) {
+        list->head = node;
+    } else {
+        list->tail->next = node;
+    }
+
+    list->tail = node;
+    list->size++;
+}

src/util/pm_list.c

@@ -6,8 +6,9 @@
 #ifndef PRISM_DIAGNOSTIC_H
 #define PRISM_DIAGNOSTIC_H
 
+#include "prism/attribute/exported.h"
 #include "prism/ast.h"
-#include "prism/util/pm_list.h"
+#include "prism/list.h"
 
 /**
  * The diagnostic IDs of all of the diagnostics, used to communicate the types
@@ -75,4 +76,12 @@ typedef enum {
     PM_WARNING_LEVEL_VERBOSE = 1
 } pm_warning_level_t;
 
+/**
+ * Get the human-readable name of the given diagnostic ID.
+ *
+ * @param diag_id The diagnostic ID to get the name of.
+ * @returns The human-readable name of the given diagnostic ID.
+ */
+PRISM_EXPORTED_FUNCTION const char * pm_diagnostic_id_human(pm_diagnostic_id_t diag_id);
+
 #endif

templates/include/prism/diagnostic.h.erb

@@ -4,6 +4,8 @@
 #include "prism/internal/constant_pool.h"
 #include "prism/internal/integer.h"
 
+#include <stdlib.h>
+
 /**
  * Attempts to grow the node list to the next size. If there is already
  * capacity in the list, this function does nothing. Otherwise it allocates a