prism 2.0.0.rc1-x86_64-linux-gnu → 2.0.0-x86_64-linux-gnu

data/include/prism/stringy.h

@@ -1,7 +1,7 @@
 /**
  * @file stringy.h
  *
- * A generic string type that can have various ownership semantics.
+ * A view of a sequence of bytes owned by someone else.
  */
 #ifndef PRISM_STRINGY_H
 #define PRISM_STRINGY_H
@@ -12,8 +12,13 @@
 #include <stddef.h>
 #include <stdint.h>
 
+#ifdef __cplusplus
+extern "C" {
+#endif
+
 /**
- * A generic string type that can have various ownership semantics.
+ * A view of a sequence of bytes. The string does not own the bytes, so they
+ * must remain valid for as long as the string is in use.
  */
 typedef struct {
     /** A pointer to the start of the string. */
@@ -21,37 +26,17 @@ typedef struct {
 
     /** The length of the string in bytes of memory. */
     size_t length;
-
-    /** The type of the string. This field determines how the string should be freed. */
-    enum {
-        /** This string is a constant string, and should not be freed. */
-        PM_STRING_CONSTANT,
-
-        /** This is a slice of another string, and should not be freed. */
-        PM_STRING_SHARED,
-
-        /** This string owns its memory, and should be freed internally. */
-        PM_STRING_OWNED
-    } type;
 } pm_string_t;
 
 /**
- * Initialize a constant string that doesn't own its memory source.
- *
- * @param string The string to initialize.
- * @param source The source of the string.
- * @param length The length of the string.
- */
-PRISM_EXPORTED_FUNCTION void pm_string_constant_init(pm_string_t *string, const char *source, size_t length) PRISM_NONNULL(1);
-
-/**
- * Initialize an owned string that is responsible for freeing allocated memory.
+ * Initialize a string that views the given bytes. The bytes are not copied, so
+ * they must remain valid for as long as the string is in use.
  *
  * @param string The string to initialize.
- * @param source The source of the string.
- * @param length The length of the string.
+ * @param source The start of the bytes.
+ * @param length The number of bytes.
  */
-PRISM_EXPORTED_FUNCTION void pm_string_owned_init(pm_string_t *string, uint8_t *source, size_t length) PRISM_NONNULL(1, 2);
+PRISM_EXPORTED_FUNCTION void pm_string_init(pm_string_t *string, const uint8_t *source, size_t length) PRISM_NONNULL(1);
 
 /**
  * Returns the length associated with the string.
@@ -69,4 +54,8 @@ PRISM_EXPORTED_FUNCTION size_t pm_string_length(const pm_string_t *string) PRISM
  */
 PRISM_EXPORTED_FUNCTION const uint8_t * pm_string_source(const pm_string_t *string) PRISM_NONNULL(1);
 
+#ifdef __cplusplus
+}
+#endif
+
 #endif

data/include/prism/stringy.hpp

@@ -0,0 +1,31 @@
+/**
+ * @file stringy.hpp
+ *
+ * Access to the contents of strings from C++.
+ */
+#ifndef PRISM_STRINGY_HPP
+#define PRISM_STRINGY_HPP
+
+#include "prism/compiler/cplusplus.hpp"
+#include "prism/compiler/lifetimebound.hpp"
+
+#include "prism/stringy.h"
+
+#include <string_view>
+
+namespace prism {
+
+/**
+ * The bytes of the given string.
+ *
+ * @param string The string to view.
+ * @return A view of the bytes of the string.
+ */
+[[nodiscard]] inline std::string_view
+view(const pm_string_t &string PRISM_LIFETIMEBOUND) noexcept {
+    return std::string_view(reinterpret_cast<const char *>(pm_string_source(&string)), pm_string_length(&string));
+}
+
+}
+
+#endif

data/include/prism/version.h

@@ -8,6 +8,10 @@
 
 #include "prism/compiler/exported.h"
 
+#ifdef __cplusplus
+extern "C" {
+#endif
+
 /**
  * The major version of the Prism library as an int.
  */
@@ -26,7 +30,7 @@
 /**
  * The version of the Prism library as a constant string.
  */
-#define PRISM_VERSION "2.0.0.rc1"
+#define PRISM_VERSION "2.0.0"
 
 /**
  * The prism version and the serialization format.
@@ -35,4 +39,8 @@
  */
 PRISM_EXPORTED_FUNCTION const char * pm_version(void);
 
+#ifdef __cplusplus
+}
+#endif
+
 #endif

data/include/prism.h

@@ -6,10 +6,6 @@
 #ifndef PRISM_H
 #define PRISM_H
 
-#ifdef __cplusplus
-extern "C" {
-#endif
-
 #include "prism/arena.h"
 #include "prism/ast.h"
 #include "prism/buffer.h"
@@ -124,8 +120,4 @@ extern "C" {
  * ```
  */
 
-#ifdef __cplusplus
-}
-#endif
-
 #endif

data/include/prism.hpp

@@ -0,0 +1,24 @@
+/**
+ * @file prism.hpp
+ *
+ * The main header file for the C++ interface to the prism parser. It adds
+ * ownership, checked casts between node types, and callable-based iteration on
+ * top of the C API. It never wraps the C structs: every function in it takes
+ * and returns the same pm_*_t types that prism.h declares, so the two can be
+ * mixed freely. It requires C++17 or later.
+ */
+#ifndef PRISM_HPP
+#define PRISM_HPP
+
+#include "prism.h"
+
+#include "prism/arena.hpp"
+#include "prism/ast.hpp"
+#include "prism/buffer.hpp"
+#include "prism/node.hpp"
+#include "prism/node_type.hpp"
+#include "prism/options.hpp"
+#include "prism/parser.hpp"
+#include "prism/stringy.hpp"
+
+#endif

data/lib/prism/ffi.rb

@@ -124,6 +124,7 @@ module Prism # :nodoc:
       "pm_string_query_local",
       "pm_string_query_constant",
       "pm_string_query_method_name",
+      "pm_string_query_keyword",
       []
     )
 
@@ -722,6 +723,11 @@ module Prism # :nodoc:
         query(LibRubyParser.pm_string_query_method_name(string, string.bytesize, string.encoding.name))
       end
 
+      # Mirrors the C extension's StringQuery::keyword? method.
+      def keyword?(string)
+        query(LibRubyParser.pm_string_query_keyword(string, string.bytesize, string.encoding.name))
+      end
+
       private
 
       # Parse the enum result and return an appropriate boolean.