rbs 2.8.4 → 3.8.1

data/stdlib/zlib/0/zlib.rbs

@@ -57,8 +57,6 @@
 #     *   Zlib::VersionError
 #     *   Zlib::InProgressError
 #
-#
-#
 # (if you have GZIP_SUPPORT)
 # *   Zlib::GzipReader
 # *   Zlib::GzipWriter
@@ -95,7 +93,7 @@ module Zlib
   #   rdoc-file=ext/zlib/zlib.c
   #   - Zlib.adler32_combine(adler1, adler2, len2)
   # -->
-  # Combine two Adler-32 check values in to one.  `alder1` is the first Adler-32
+  # Combine two Adler-32 check values in to one.  `adler1` is the first Adler-32
   # value, `adler2` is the second Adler-32 value.  `len2` is the length of the
   # string used to generate `adler2`.
   #

data/stdlib/zlib/0/zstream.rbs

@@ -0,0 +1,200 @@
+%a{annotate:rdoc:skip}
+module Zlib
+  # <!-- rdoc-file=ext/zlib/zlib.c -->
+  # Zlib::ZStream is the abstract class for the stream which handles the
+  # compressed data. The operations are defined in the subclasses: Zlib::Deflate
+  # for compression, and Zlib::Inflate for decompression.
+  #
+  # An instance of Zlib::ZStream has one stream (struct zstream in the source) and
+  # two variable-length buffers which associated to the input (next_in) of the
+  # stream and the output (next_out) of the stream. In this document, "input
+  # buffer" means the buffer for input, and "output buffer" means the buffer for
+  # output.
+  #
+  # Data input into an instance of Zlib::ZStream are temporally stored into the
+  # end of input buffer, and then data in input buffer are processed from the
+  # beginning of the buffer until no more output from the stream is produced (i.e.
+  # until avail_out > 0 after processing).  During processing, output buffer is
+  # allocated and expanded automatically to hold all output data.
+  #
+  # Some particular instance methods consume the data in output buffer and return
+  # them as a String.
+  #
+  # Here is an ascii art for describing above:
+  #
+  #     +================ an instance of Zlib::ZStream ================+
+  #     ||                                                            ||
+  #     ||     +--------+          +-------+          +--------+      ||
+  #     ||  +--| output |<---------|zstream|<---------| input  |<--+  ||
+  #     ||  |  | buffer |  next_out+-------+next_in   | buffer |   |  ||
+  #     ||  |  +--------+                             +--------+   |  ||
+  #     ||  |                                                      |  ||
+  #     +===|======================================================|===+
+  #         |                                                      |
+  #         v                                                      |
+  #     "output data"                                         "input data"
+  #
+  # If an error occurs during processing input buffer, an exception which is a
+  # subclass of Zlib::Error is raised.  At that time, both input and output buffer
+  # keep their conditions at the time when the error occurs.
+  #
+  # ## Method Catalogue
+  #
+  # Many of the methods in this class are fairly low-level and unlikely to be of
+  # interest to users.  In fact, users are unlikely to use this class directly;
+  # rather they will be interested in Zlib::Inflate and Zlib::Deflate.
+  #
+  # The higher level methods are listed below.
+  #
+  # *   #total_in
+  # *   #total_out
+  # *   #data_type
+  # *   #adler
+  # *   #reset
+  # *   #finish
+  # *   #finished?
+  # *   #close
+  # *   #closed?
+  #
+  class ZStream
+    # <!--
+    #   rdoc-file=ext/zlib/zlib.c
+    #   - adler()
+    # -->
+    # Returns the adler-32 checksum.
+    #
+    def adler: () -> Integer
+
+    # <!--
+    #   rdoc-file=ext/zlib/zlib.c
+    #   - avail_in()
+    # -->
+    # Returns bytes of data in the input buffer. Normally, returns 0.
+    #
+    def avail_in: () -> Integer
+
+    # <!--
+    #   rdoc-file=ext/zlib/zlib.c
+    #   - avail_out()
+    # -->
+    # Returns number of bytes of free spaces in output buffer.  Because the free
+    # space is allocated automatically, this method returns 0 normally.
+    #
+    def avail_out: () -> Integer
+
+    # <!--
+    #   rdoc-file=ext/zlib/zlib.c
+    #   - avail_out=(p1)
+    # -->
+    # Allocates `size` bytes of free space in the output buffer. If there are more
+    # than `size` bytes already in the buffer, the buffer is truncated. Because free
+    # space is allocated automatically, you usually don't need to use this method.
+    #
+    def avail_out=: (Integer p1) -> void
+
+    # <!--
+    #   rdoc-file=ext/zlib/zlib.c
+    #   - close()
+    # -->
+    # Closes the stream. All operations on the closed stream will raise an
+    # exception.
+    #
+    def close: () -> void
+
+    # <!--
+    #   rdoc-file=ext/zlib/zlib.c
+    #   - closed?()
+    # -->
+    # Returns true if the stream is closed.
+    #
+    def closed?: () -> bool
+
+    # <!--
+    #   rdoc-file=ext/zlib/zlib.c
+    #   - data_type()
+    # -->
+    # Guesses the type of the data which have been inputted into the stream. The
+    # returned value is either `BINARY`, `ASCII`, or `UNKNOWN`.
+    #
+    def data_type: () -> String
+
+    # <!-- rdoc-file=ext/zlib/zlib.c -->
+    # Closes the stream. All operations on the closed stream will raise an
+    # exception.
+    #
+    def end: () -> void
+
+    # <!-- rdoc-file=ext/zlib/zlib.c -->
+    # Returns true if the stream is closed.
+    #
+    def ended?: () -> bool
+
+    # <!--
+    #   rdoc-file=ext/zlib/zlib.c
+    #   - finish                 -> String
+    #   - finish { |chunk| ... } -> nil
+    # -->
+    # Finishes the stream and flushes output buffer.  If a block is given each chunk
+    # is yielded to the block until the input buffer has been flushed to the output
+    # buffer.
+    #
+    def finish: () -> String
+              | () { (String chunk) -> void } -> void
+
+    # <!--
+    #   rdoc-file=ext/zlib/zlib.c
+    #   - finished?()
+    # -->
+    # Returns true if the stream is finished.
+    #
+    def finished?: () -> bool
+
+    # <!--
+    #   rdoc-file=ext/zlib/zlib.c
+    #   - flush_next_in -> input
+    # -->
+    #
+    def flush_next_in: () -> String
+
+    # <!--
+    #   rdoc-file=ext/zlib/zlib.c
+    #   - flush_next_out                 -> String
+    #   - flush_next_out { |chunk| ... } -> nil
+    # -->
+    # Flushes output buffer and returns all data in that buffer.  If a block is
+    # given each chunk is yielded to the block until the current output buffer has
+    # been flushed.
+    #
+    def flush_next_out: () -> String?
+
+    # <!--
+    #   rdoc-file=ext/zlib/zlib.c
+    #   - reset()
+    # -->
+    # Resets and initializes the stream. All data in both input and output buffer
+    # are discarded.
+    #
+    def reset: () -> void
+
+    # <!-- rdoc-file=ext/zlib/zlib.c -->
+    # Returns true if the stream is finished.
+    #
+    def stream_end?: () -> bool
+
+    # <!--
+    #   rdoc-file=ext/zlib/zlib.c
+    #   - total_in()
+    # -->
+    # Returns the total bytes of the input data to the stream.  FIXME
+    #
+    def total_in: () -> Integer
+
+    # <!--
+    #   rdoc-file=ext/zlib/zlib.c
+    #   - total_out()
+    # -->
+    # Returns the total bytes of the output data from the stream.  FIXME
+    #
+    def total_out: () -> Integer
+  end
+end

data/templates/include/rbs/constants.h.erb

@@ -0,0 +1,20 @@
+#ifndef RBS__CONSTANTS_H
+#define RBS__CONSTANTS_H
+
+extern VALUE RBS;
+
+extern VALUE RBS_AST;
+extern VALUE RBS_AST_Declarations;
+extern VALUE RBS_AST_Directives;
+extern VALUE RBS_AST_Members;
+extern VALUE RBS_Types;
+extern VALUE RBS_Types_Bases;
+extern VALUE RBS_ParsingError;
+
+<%- nodes.each do |node| -%>
+extern VALUE <%= node.c_constant_name %>;
+<%- end -%>
+
+void rbs__init_constants();
+
+#endif

data/templates/include/rbs/ruby_objs.h.erb

@@ -0,0 +1,10 @@
+#ifndef RBS__RUBY_OBJS_H
+#define RBS__RUBY_OBJS_H
+
+#include "ruby.h"
+
+<%- nodes.each do |node| -%>
+VALUE <%= node.c_function_name %>(<%= node.fields.map { |field| "#{field.c_type} #{field.name}" }.join(", ") %>);
+<%- end -%>
+
+#endif

data/templates/src/constants.c.erb

@@ -0,0 +1,36 @@
+#include "rbs_extension.h"
+
+VALUE RBS_Parser;
+
+VALUE RBS;
+VALUE RBS_AST;
+VALUE RBS_AST_Declarations;
+VALUE RBS_AST_Directives;
+VALUE RBS_AST_Members;
+VALUE RBS_Parser;
+VALUE RBS_Types;
+VALUE RBS_Types_Bases;
+
+<%- nodes.each do |node| -%>
+VALUE <%= node.c_constant_name %>;
+<%- end -%>
+
+VALUE RBS_ParsingError;
+
+#define IMPORT_CONSTANT(var, parent, name) { var = rb_const_get(parent, rb_intern(name)); rb_gc_register_mark_object(var); }
+
+void rbs__init_constants(void) {
+  IMPORT_CONSTANT(RBS, rb_cObject, "RBS");
+  IMPORT_CONSTANT(RBS_ParsingError, RBS, "ParsingError");
+
+  IMPORT_CONSTANT(RBS_AST, RBS, "AST");
+  IMPORT_CONSTANT(RBS_AST_Declarations, RBS_AST, "Declarations");
+  IMPORT_CONSTANT(RBS_AST_Directives, RBS_AST, "Directives");
+  IMPORT_CONSTANT(RBS_AST_Members, RBS_AST, "Members");
+  IMPORT_CONSTANT(RBS_Types, RBS, "Types");
+  IMPORT_CONSTANT(RBS_Types_Bases, RBS_Types, "Bases");
+
+  <%- nodes.each do |node| -%>
+  IMPORT_CONSTANT(<%= node.c_constant_name %>, <%= node.c_parent_constant_name %>, "<%= node.ruby_class_name %>");
+  <%- end -%>
+}

data/templates/src/ruby_objs.c.erb

@@ -0,0 +1,27 @@
+#include "rbs_extension.h"
+
+#ifdef RB_PASS_KEYWORDS
+  // Ruby 2.7 or later
+  #define CLASS_NEW_INSTANCE(klass, argc, argv)\
+          rb_class_new_instance_kw(argc, argv, klass, RB_PASS_KEYWORDS)
+#else
+  // Ruby 2.6
+  #define CLASS_NEW_INSTANCE(receiver, argc, argv)\
+          rb_class_new_instance(argc, argv, receiver)
+#endif
+
+<%- nodes.each do |node| -%>
+VALUE <%= node.c_function_name %>(<%= node.fields.map { |field| "#{field.c_type} #{field.name}" }.join(", ") %>) {
+  VALUE _init_kwargs = rb_hash_new();
+  <%- node.fields.each do |field| -%>
+  rb_hash_aset(_init_kwargs, ID2SYM(rb_intern("<%= field.name %>")), <%= field.name %>);
+  <%- end -%>
+
+  return CLASS_NEW_INSTANCE(
+    <%= node.c_constant_name %>,
+    1,
+    &_init_kwargs
+  );
+}
+
+<%- end -%>

data/templates/template.rb

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+require "erb"
+require "fileutils"
+require "yaml"
+
+module RBS
+  class Template
+    class Field
+      attr_reader :name
+      attr_reader :c_type
+
+      def initialize(yaml)
+        @name = yaml["name"]
+        @c_type = "VALUE"
+      end
+    end
+
+    class Type
+      # The fully-qualified name of the auto-generated Ruby class for this type,
+      # e.g. `RBS::AST::Declarations::TypeAlias`
+      attr_reader :ruby_full_name #: String
+
+      # The name of the name of the auto-generated Ruby class for this type,
+      # e.g. `TypeAlias`
+      attr_reader :ruby_class_name #: String
+
+      # The name of the auto-generated C struct for this type,
+      # e.g. `rbs_ast_declarations_typealias_t`
+      attr_reader :c_type_name #: String
+
+      # The name of the pre-existing C function which constructs new Ruby objects of this type.
+      # e.g. `rbs_ast_declarations_typealias_new`
+      attr_reader :c_function_name #: String
+
+      # The name of the C constant which stores the Ruby VALUE pointing to the generated class.
+      # e.g. `RBS_AST_Declarations_TypeAlias`
+      attr_reader :c_constant_name #: String
+
+      # The name of the C constant in which the `c_constant_name` is nested.
+      # e.g. `RBS_AST_Declarations`
+      attr_reader :c_parent_constant_name #: String
+
+      attr_reader :fields #: Array[RBS::Template::Field]
+
+      def initialize(yaml)
+        @ruby_full_name = yaml["name"]
+        @ruby_class_name = @ruby_full_name[/[^:]+\z/] # demodulize-like
+        name = @ruby_full_name.gsub("::", "_")
+        @c_function_name = name.gsub(/(^)?(_)?([A-Z](?:[A-Z]*(?=[A-Z_])|[a-z0-9]*))/) { ($1 || $2 || "_") + $3.downcase } # underscore-like
+        @c_function_name.gsub!(/^rbs_types_/, 'rbs_')
+        @c_function_name.gsub!(/^rbs_ast_declarations_/, 'rbs_ast_decl_')
+        @c_constant_name = @ruby_full_name.gsub("::", "_")
+        @c_parent_constant_name = @ruby_full_name.split("::")[0..-2].join("::").gsub("::", "_")
+
+        @fields = yaml.fetch("fields", []).map { |field| Field.new(field) }.freeze
+      end
+    end
+
+    class << self
+      def render(out_file)
+        filepath = "templates/#{out_file}.erb"
+        template = File.expand_path("../#{filepath}", __dir__)
+
+        erb = read_template(template)
+        extension = File.extname(filepath.gsub(".erb", ""))
+
+        heading = <<~HEADING
+          /*----------------------------------------------------------------------------*/
+          /* This file is generated by the templates/template.rb script and should not  */
+          /* be modified manually.                                                      */
+          /* To change the template see                                                 */
+          /* #{filepath + " " * (74 - filepath.size) } */
+          /*----------------------------------------------------------------------------*/
+        HEADING
+
+        write_to = File.expand_path("../#{out_file}", __dir__)
+        contents = heading + "\n" + erb.result_with_hash(locals)
+
+        if (extension == ".c" || extension == ".h") && !contents.ascii_only?
+          # Enforce that we only have ASCII characters here. This is necessary
+          # for non-UTF-8 locales that only allow ASCII characters in C source
+          # files.
+          contents.each_line.with_index(1) do |line, line_number|
+            raise "Non-ASCII character on line #{line_number} of #{write_to}" unless line.ascii_only?
+          end
+        end
+
+        FileUtils.mkdir_p(File.dirname(write_to))
+        File.write(write_to, contents)
+      end
+
+      private
+
+      def read_template(filepath)
+        template = File.read(filepath, encoding: Encoding::UTF_8)
+        erb = erb(template)
+        erb.filename = filepath
+        erb
+      end
+
+      def erb(template)
+        ERB.new(template, trim_mode: "-")
+      end
+
+      def locals
+        config = YAML.load_file(File.expand_path("../config.yml", __dir__))
+        {
+          nodes: config.fetch("nodes").map { |node| Type.new(node) }.sort_by(&:ruby_full_name),
+        }
+      end
+    end
+  end
+end
+
+unless ARGV.size == 1
+  $stderr.puts "Usage: ruby template.rb <out_file>"
+  exit 1
+end
+
+out_file = ARGV.first
+RBS::Template.render(out_file)