prism 2.0.0.rc1-x86_64-linux-gnu

data/rbi/generated/prism/node_ext.rbi

@@ -0,0 +1,259 @@
+# typed: true
+
+module Prism
+  class Node
+    abstract!
+
+    sig { params(replacements: String).void }
+    def deprecated(*replacements); end
+  end
+
+  module RegularExpressionOptions
+    # Returns a numeric value that represents the flags that were used to create
+    # the regular expression.
+    sig { params(flags: Integer).returns(Integer) }
+    def self.options(flags); end
+  end
+
+  class InterpolatedMatchLastLineNode < Node
+    # Returns a numeric value that represents the flags that were used to create
+    # the regular expression.
+    sig { returns(Integer) }
+    def options; end
+  end
+
+  class InterpolatedRegularExpressionNode < Node
+    # Returns a numeric value that represents the flags that were used to create
+    # the regular expression.
+    sig { returns(Integer) }
+    def options; end
+  end
+
+  class MatchLastLineNode < Node
+    # Returns a numeric value that represents the flags that were used to create
+    # the regular expression.
+    sig { returns(Integer) }
+    def options; end
+  end
+
+  class RegularExpressionNode < Node
+    # Returns a numeric value that represents the flags that were used to create
+    # the regular expression.
+    sig { returns(Integer) }
+    def options; end
+  end
+
+  module HeredocQuery
+    # Returns true if this node was represented as a heredoc in the source code.
+    sig { params(opening: ::T.nilable(String)).returns(::T.nilable(T::Boolean)) }
+    def self.heredoc?(opening); end
+  end
+
+  class InterpolatedStringNode < Node
+    # Returns true if this node was represented as a heredoc in the source code.
+    sig { returns(::T.nilable(T::Boolean)) }
+    def heredoc?; end
+  end
+
+  class InterpolatedXStringNode < Node
+    # Returns true if this node was represented as a heredoc in the source code.
+    sig { returns(::T.nilable(T::Boolean)) }
+    def heredoc?; end
+  end
+
+  class StringNode < Node
+    # Returns true if this node was represented as a heredoc in the source code.
+    sig { returns(::T.nilable(T::Boolean)) }
+    def heredoc?; end
+
+    # Occasionally it's helpful to treat a string as if it were interpolated so
+    # that there's a consistent interface for working with strings.
+    sig { returns(InterpolatedStringNode) }
+    def to_interpolated; end
+  end
+
+  class XStringNode < Node
+    # Returns true if this node was represented as a heredoc in the source code.
+    sig { returns(::T.nilable(T::Boolean)) }
+    def heredoc?; end
+
+    # Occasionally it's helpful to treat a string as if it were interpolated so
+    # that there's a consistent interface for working with strings.
+    sig { returns(InterpolatedXStringNode) }
+    def to_interpolated; end
+  end
+
+  class ImaginaryNode < Node
+    # Returns the value of the node as a Ruby Complex.
+    sig { returns(Complex) }
+    def value; end
+  end
+
+  class RationalNode < Node
+    # Returns the value of the node as a Ruby Rational.
+    sig { returns(Rational) }
+    def value; end
+  end
+
+  class ConstantReadNode < Node
+    # Returns the list of parts for the full name of this constant.
+    # For example: [:Foo]
+    sig { returns(T::Array[Symbol]) }
+    def full_name_parts; end
+
+    # Returns the full name of this constant. For example: "Foo"
+    sig { returns(String) }
+    def full_name; end
+  end
+
+  class ConstantWriteNode < Node
+    # Returns the list of parts for the full name of this constant.
+    # For example: [:Foo]
+    sig { returns(T::Array[Symbol]) }
+    def full_name_parts; end
+
+    # Returns the full name of this constant. For example: "Foo"
+    sig { returns(String) }
+    def full_name; end
+  end
+
+  class ConstantPathNode < Node
+    # An error class raised when dynamic parts are found while computing a
+    # constant path's full name. For example:
+    # Foo::Bar::Baz -> does not raise because all parts of the constant path are
+    # simple constants
+    # var::Bar::Baz -> raises because the first part of the constant path is a
+    # local variable
+    class DynamicPartsInConstantPathError < StandardError; end
+
+    # An error class raised when error recovery nodes are found while computing a
+    # constant path's full name. For example:
+    # Foo:: -> raises because the constant path is missing the last part
+    class ErrorRecoveryNodesInConstantPathError < StandardError; end
+
+    # Returns the list of parts for the full name of this constant path.
+    # For example: [:Foo, :Bar]
+    sig { returns(T::Array[Symbol]) }
+    def full_name_parts; end
+
+    # Returns the full name of this constant path. For example: "Foo::Bar"
+    sig { returns(String) }
+    def full_name; end
+  end
+
+  class ConstantPathTargetNode < Node
+    # Returns the list of parts for the full name of this constant path.
+    # For example: [:Foo, :Bar]
+    sig { returns(T::Array[Symbol]) }
+    def full_name_parts; end
+
+    # Returns the full name of this constant path. For example: "Foo::Bar"
+    sig { returns(String) }
+    def full_name; end
+  end
+
+  class ConstantTargetNode < Node
+    # Returns the list of parts for the full name of this constant.
+    # For example: [:Foo]
+    sig { returns(T::Array[Symbol]) }
+    def full_name_parts; end
+
+    # Returns the full name of this constant. For example: "Foo"
+    sig { returns(String) }
+    def full_name; end
+  end
+
+  class ParametersNode < Node
+    # Mirrors the Method#parameters method.
+    sig { returns(T::Array[::T.any([Symbol, Symbol], [Symbol])]) }
+    def signature; end
+  end
+
+  class CallNode < Node
+    # When a call node has the attribute_write flag set, it means that the call
+    # is using the attribute write syntax. This is either a method call to []=
+    # or a method call to a method that ends with =. Either way, the = sign is
+    # present in the source.
+    #
+    # Prism returns the message_loc _without_ the = sign attached, because there
+    # can be any amount of space between the message and the = sign. However,
+    # sometimes you want the location of the full message including the inner
+    # space and the = sign. This method provides that.
+    sig { returns(::T.nilable(Location)) }
+    def full_message_loc; end
+  end
+
+  class InNode < Node
+    sig { returns(String) }
+    def in; end
+
+    sig { returns(Location) }
+    def in_loc; end
+
+    sig { returns(::T.nilable(String)) }
+    def then; end
+
+    sig { returns(::T.nilable(Location)) }
+    def then_loc; end
+  end
+
+  class MatchPredicateNode < Node
+    sig { returns(String) }
+    def operator; end
+
+    sig { returns(Location) }
+    def operator_loc; end
+  end
+
+  class UnlessNode < Node
+    sig { returns(String) }
+    def keyword; end
+
+    sig { returns(Location) }
+    def keyword_loc; end
+  end
+
+  class UntilNode < Node
+    sig { returns(String) }
+    def keyword; end
+
+    sig { returns(Location) }
+    def keyword_loc; end
+
+    sig { returns(::T.nilable(String)) }
+    def closing; end
+
+    sig { returns(::T.nilable(Location)) }
+    def closing_loc; end
+  end
+
+  class WhenNode < Node
+    sig { returns(String) }
+    def keyword; end
+
+    sig { returns(Location) }
+    def keyword_loc; end
+  end
+
+  class WhileNode < Node
+    sig { returns(String) }
+    def keyword; end
+
+    sig { returns(Location) }
+    def keyword_loc; end
+
+    sig { returns(::T.nilable(String)) }
+    def closing; end
+
+    sig { returns(::T.nilable(Location)) }
+    def closing_loc; end
+  end
+
+  class SymbolNode < Node
+    sig { returns(String) }
+    def value; end
+
+    sig { returns(Location) }
+    def value_loc; end
+  end
+end

data/rbi/generated/prism/node_find.rbi

@@ -0,0 +1,79 @@
+# typed: true
+
+module Prism
+  # Finds the Prism AST node corresponding to a given Method, UnboundMethod,
+  # Proc, or Thread::Backtrace::Location. On CRuby, uses node_id from the
+  # instruction sequence for an exact match. On other implementations, falls
+  # back to best-effort matching by source location line number.
+  #
+  # This module is autoloaded so that programs that don't use Prism.find don't
+  # pay for its definition.
+  module NodeFind
+    # Find the node for the given callable or backtrace location.
+    sig { params(callable: ::T.any(Method, UnboundMethod, Proc, Thread::Backtrace::Location)).returns(::T.nilable(Node)) }
+    def self.find(callable); end
+
+    # Base class that handles parsing a file.
+    class Find
+      # Parse the given file path, returning a ParseResult or nil.
+      sig { params(file: ::T.nilable(String)).returns(::T.nilable(ParseResult)) }
+      private def parse_file(file); end
+    end
+
+    # Finds the AST node for a Method, UnboundMethod, Proc or Thread::Backtrace::Location
+    # using the #source_range
+    class SourceRangeFind < Find
+      # Find the node for the given callable using the #source_range.
+      sig { params(callable: ::T.any(Method, UnboundMethod, Proc, Thread::Backtrace::Location)).returns(::T.nilable(Node)) }
+      def find(callable); end
+    end
+
+    # Finds the AST node for a Method, UnboundMethod, or Proc using the node_id
+    # from the instruction sequence.
+    class RubyVMCallableFind < Find
+      # Find the node for the given callable using the ISeq node_id.
+      sig { params(callable: ::T.any(Method, UnboundMethod, Proc)).returns(::T.nilable(Node)) }
+      def find(callable); end
+    end
+
+    # Finds the AST node for a Thread::Backtrace::Location using the node_id
+    # from the backtrace location.
+    class RubyVMBacktraceLocationFind < Find
+      # Find the node for the given backtrace location using node_id.
+      sig { params(location: Thread::Backtrace::Location).returns(::T.nilable(Node)) }
+      def find(location); end
+    end
+
+    # Finds the AST node for a Method or UnboundMethod using best-effort line
+    # matching. Used on non-CRuby implementations.
+    class LineMethodFind < Find
+      # Find the node for the given method by matching on name and line.
+      sig { params(callable: ::T.any(Method, UnboundMethod)).returns(::T.nilable(Node)) }
+      def find(callable); end
+    end
+
+    # Finds the AST node for a lambda using best-effort line matching. Used
+    # on non-CRuby implementations.
+    class LineLambdaFind < Find
+      # Find the node for the given lambda by matching on line.
+      sig { params(callable: Proc).returns(::T.nilable(Node)) }
+      def find(callable); end
+    end
+
+    # Finds the AST node for a non-lambda Proc using best-effort line
+    # matching. Used on non-CRuby implementations.
+    class LineProcFind < Find
+      # Find the node for the given proc by matching on line.
+      sig { params(callable: Proc).returns(::T.nilable(Node)) }
+      def find(callable); end
+    end
+
+    # Finds the AST node for a Thread::Backtrace::Location using best-effort
+    # line matching. Used on non-CRuby implementations.
+    class LineBacktraceLocationFind < Find
+      # Find the node for the given backtrace location by matching on line.
+      sig { params(location: Thread::Backtrace::Location).returns(::T.nilable(Node)) }
+      def find(location); end
+    end
+  end
+end

data/rbi/generated/prism/parse_result/errors.rbi

@@ -0,0 +1,21 @@
+# typed: true
+
+module Prism
+  class ParseResult < Result
+    # An object to represent the set of errors on a parse result. This object
+    # can be used to format the errors in a human-readable way.
+    class Errors
+      # The parse result that contains the errors.
+      sig { returns(ParseResult) }
+      attr_reader :parse_result
+
+      # Initialize a new set of errors from the given parse result.
+      sig { params(parse_result: ParseResult).void }
+      def initialize(parse_result); end
+
+      # Formats the errors in a human-readable way and return them as a string.
+      sig { returns(String) }
+      def format; end
+    end
+  end
+end

data/rbi/generated/prism/parse_result/newlines.rbi

@@ -0,0 +1,208 @@
+# typed: true
+
+module Prism
+  class ParseResult < Result
+    # The :line tracepoint event gets fired whenever the Ruby VM encounters an
+    # expression on a new line. The types of expressions that can trigger this
+    # event are:
+    #
+    # * if statements
+    # * unless statements
+    # * nodes that are children of statements lists
+    #
+    # In order to keep track of the newlines, we have a list of offsets that
+    # come back from the parser. We assign these offsets to the first nodes that
+    # we find in the tree that are on those lines.
+    #
+    # Note that the logic in this file should be kept in sync with the Java
+    # MarkNewlinesVisitor, since that visitor is responsible for marking the
+    # newlines for JRuby/TruffleRuby.
+    #
+    # This file is autoloaded only when `mark_newlines!` is called, so the
+    # re-opening of the various nodes in this file will only be performed in
+    # that case. We do that to avoid storing the extra `@newline` instance
+    # variable on every node if we don't need it.
+    class Newlines < Visitor
+      # Create a new Newlines visitor with the given newline offsets.
+      sig { params(lines: Integer).void }
+      def initialize(lines); end
+
+      # Permit block nodes to mark newlines within themselves.
+      sig { params(node: BlockNode).void }
+      def visit_block_node(node); end
+
+      # Permit lambda nodes to mark newlines within themselves.
+      sig { params(node: LambdaNode).void }
+      def visit_lambda_node(node); end
+
+      # Permit def nodes to mark newlines within themselves. The body of an
+      # endless method definition never emits newline events, so in that case
+      # mark every line as already seen while visiting it instead. Nested
+      # scopes (blocks, lambdas, etc.) reset the lines and emit events again.
+      sig { params(node: DefNode).void }
+      def visit_def_node(node); end
+
+      # Permit class nodes to mark newlines within themselves.
+      sig { params(node: ClassNode).void }
+      def visit_class_node(node); end
+
+      # Permit module nodes to mark newlines within themselves.
+      sig { params(node: ModuleNode).void }
+      def visit_module_node(node); end
+
+      # Permit singleton class nodes to mark newlines within themselves.
+      sig { params(node: SingletonClassNode).void }
+      def visit_singleton_class_node(node); end
+
+      # Statements inside string interpolation do not emit newline events, so
+      # mark every line as already seen while visiting them. Nested scopes
+      # (blocks, lambdas, defs, etc.) reset the lines and emit events again.
+      sig { params(node: EmbeddedStatementsNode).void }
+      def visit_embedded_statements_node(node); end
+
+      # The predicate of a while loop is compiled at the end of the loop,
+      # after the body, so any statements it contains (from parentheses)
+      # emit their line events again even if the lines were already seen.
+      sig { params(node: WhileNode).void }
+      def visit_while_node(node); end
+
+      # The predicate of an until loop is compiled at the end of the loop,
+      # after the body, so any statements it contains (from parentheses)
+      # emit their line events again even if the lines were already seen.
+      sig { params(node: UntilNode).void }
+      def visit_until_node(node); end
+
+      # Mark if nodes as newlines.
+      sig { params(node: IfNode).void }
+      def visit_if_node(node); end
+
+      # Mark unless nodes as newlines.
+      sig { params(node: UnlessNode).void }
+      def visit_unless_node(node); end
+
+      # Permit statements lists to mark newlines within themselves.
+      sig { params(node: StatementsNode).void }
+      def visit_statements_node(node); end
+    end
+  end
+
+  class Node
+    abstract!
+
+    sig { returns(T::Boolean) }
+    def newline_flag?; end
+
+    sig { params(lines: T::Array[T::Boolean]).void }
+    def newline_flag!(lines); end
+  end
+
+  class BeginNode < Node
+    sig { params(lines: T::Array[T::Boolean]).void }
+    def newline_flag!(lines); end
+  end
+
+  class ParenthesesNode < Node
+    sig { params(lines: T::Array[T::Boolean]).void }
+    def newline_flag!(lines); end
+  end
+
+  class IfNode < Node
+    sig { params(lines: T::Array[T::Boolean]).void }
+    def newline_flag!(lines); end
+  end
+
+  class UnlessNode < Node
+    sig { params(lines: T::Array[T::Boolean]).void }
+    def newline_flag!(lines); end
+  end
+
+  class UntilNode < Node
+    sig { params(lines: T::Array[T::Boolean]).void }
+    def newline_flag!(lines); end
+  end
+
+  class WhileNode < Node
+    sig { params(lines: T::Array[T::Boolean]).void }
+    def newline_flag!(lines); end
+  end
+
+  class RescueModifierNode < Node
+    sig { params(lines: T::Array[T::Boolean]).void }
+    def newline_flag!(lines); end
+  end
+
+  class LocalVariableWriteNode < Node
+    sig { params(lines: T::Array[T::Boolean]).void }
+    def newline_flag!(lines); end
+  end
+
+  class InstanceVariableWriteNode < Node
+    sig { params(lines: T::Array[T::Boolean]).void }
+    def newline_flag!(lines); end
+  end
+
+  class ClassVariableWriteNode < Node
+    sig { params(lines: T::Array[T::Boolean]).void }
+    def newline_flag!(lines); end
+  end
+
+  class GlobalVariableWriteNode < Node
+    sig { params(lines: T::Array[T::Boolean]).void }
+    def newline_flag!(lines); end
+  end
+
+  class ConstantWriteNode < Node
+    sig { params(lines: T::Array[T::Boolean]).void }
+    def newline_flag!(lines); end
+  end
+
+  class ConstantPathWriteNode < Node
+    sig { params(lines: T::Array[T::Boolean]).void }
+    def newline_flag!(lines); end
+  end
+
+  class MultiWriteNode < Node
+    sig { params(lines: T::Array[T::Boolean]).void }
+    def newline_flag!(lines); end
+  end
+
+  class CallNode < Node
+    sig { params(lines: T::Array[T::Boolean]).void }
+    def newline_flag!(lines); end
+  end
+
+  class ArrayNode < Node
+    sig { params(lines: T::Array[T::Boolean]).void }
+    def newline_flag!(lines); end
+  end
+
+  class HashNode < Node
+    sig { params(lines: T::Array[T::Boolean]).void }
+    def newline_flag!(lines); end
+  end
+
+  class InterpolatedMatchLastLineNode < Node
+    sig { params(lines: T::Array[T::Boolean]).void }
+    def newline_flag!(lines); end
+  end
+
+  class InterpolatedRegularExpressionNode < Node
+    sig { params(lines: T::Array[T::Boolean]).void }
+    def newline_flag!(lines); end
+  end
+
+  class InterpolatedStringNode < Node
+    sig { params(lines: T::Array[T::Boolean]).void }
+    def newline_flag!(lines); end
+  end
+
+  class InterpolatedSymbolNode < Node
+    sig { params(lines: T::Array[T::Boolean]).void }
+    def newline_flag!(lines); end
+  end
+
+  class InterpolatedXStringNode < Node
+    sig { params(lines: T::Array[T::Boolean]).void }
+    def newline_flag!(lines); end
+  end
+end