brew/Library/Homebrew/sorbet/rbi/gems/rbi@0.1.14.rbi

3328 lines
93 KiB
Plaintext
Raw Normal View History

# typed: true
2022-03-04 18:14:44 +00:00
# DO NOT EDIT MANUALLY
# This is an autogenerated file for types exported from the `rbi` gem.
# Please instead update this file by running `bin/tapioca gem rbi`.
# source://rbi//lib/rbi.rb#7
2022-03-04 18:14:44 +00:00
module RBI; end
# source://rbi//lib/rbi/model.rb#1043
2022-03-04 18:14:44 +00:00
class RBI::Arg < ::RBI::Node
# source://rbi//lib/rbi/model.rb#1055
2022-03-04 18:14:44 +00:00
sig { params(value: ::String, loc: T.nilable(::RBI::Loc)).void }
def initialize(value, loc: T.unsafe(nil)); end
# source://rbi//lib/rbi/model.rb#1061
2022-03-04 18:14:44 +00:00
sig { params(other: T.nilable(::Object)).returns(T::Boolean) }
def ==(other); end
# source://rbi//lib/rbi/model.rb#1066
2022-03-04 18:14:44 +00:00
sig { returns(::String) }
def to_s; end
# source://rbi//lib/rbi/model.rb#1047
2022-03-04 18:14:44 +00:00
sig { returns(::String) }
def value; end
end
2023-12-14 15:34:15 +00:00
# Attributes
#
# @abstract It cannot be directly instantiated. Subclasses must implement the `abstract` methods below.
#
# source://rbi//lib/rbi/model.rb#351
2022-03-04 18:14:44 +00:00
class RBI::Attr < ::RBI::NodeWithComments
include ::RBI::Indexable
abstract!
# source://rbi//lib/rbi/model.rb#376
2022-03-04 18:14:44 +00:00
sig do
params(
name: ::Symbol,
names: T::Array[::Symbol],
visibility: ::RBI::Visibility,
sigs: T::Array[::RBI::Sig],
loc: T.nilable(::RBI::Loc),
comments: T::Array[::RBI::Comment]
).void
end
def initialize(name, names, visibility: T.unsafe(nil), sigs: T.unsafe(nil), loc: T.unsafe(nil), comments: T.unsafe(nil)); end
# source://rbi//lib/rbi/rewriters/merge_trees.rb#414
2022-03-04 18:14:44 +00:00
sig { override.params(other: ::RBI::Node).returns(T::Boolean) }
def compatible_with?(other); end
2023-12-14 15:34:15 +00:00
# @abstract
#
# source://rbi//lib/rbi/rewriters/attr_to_methods.rb#61
sig { abstract.returns(T::Array[::RBI::Method]) }
def convert_to_methods; end
# @abstract
#
# source://rbi//lib/rbi/model.rb#384
2022-03-04 18:14:44 +00:00
sig { abstract.returns(T::Array[::String]) }
def fully_qualified_names; end
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/index.rb#113
2022-03-04 18:14:44 +00:00
sig { override.returns(T::Array[::String]) }
def index_ids; end
# source://rbi//lib/rbi/rewriters/merge_trees.rb#422
2022-03-04 18:14:44 +00:00
sig { override.params(other: ::RBI::Node).void }
def merge_with(other); end
# source://rbi//lib/rbi/model.rb#358
2022-03-04 18:14:44 +00:00
sig { returns(T::Array[::Symbol]) }
def names; end
# source://rbi//lib/rbi/model.rb#364
2022-03-04 18:14:44 +00:00
sig { returns(T::Array[::RBI::Sig]) }
def sigs; end
# source://rbi//lib/rbi/model.rb#361
2022-03-04 18:14:44 +00:00
sig { returns(::RBI::Visibility) }
def visibility; end
2023-12-14 15:34:15 +00:00
# @return [Visibility]
#
# source://rbi//lib/rbi/model.rb#361
2022-03-04 18:14:44 +00:00
def visibility=(_arg0); end
private
# source://rbi//lib/rbi/rewriters/attr_to_methods.rb#89
sig do
params(
name: ::String,
sig: T.nilable(::RBI::Sig),
visibility: ::RBI::Visibility,
loc: T.nilable(::RBI::Loc),
comments: T::Array[::RBI::Comment]
).returns(::RBI::Method)
end
def create_getter_method(name, sig, visibility, loc, comments); end
# source://rbi//lib/rbi/rewriters/attr_to_methods.rb#110
sig do
params(
name: ::String,
sig: T.nilable(::RBI::Sig),
attribute_type: T.nilable(::String),
visibility: ::RBI::Visibility,
loc: T.nilable(::RBI::Loc),
comments: T::Array[::RBI::Comment]
).returns(::RBI::Method)
end
def create_setter_method(name, sig, attribute_type, visibility, loc, comments); end
# @raise [UnexpectedMultipleSigsError]
#
# source://rbi//lib/rbi/rewriters/attr_to_methods.rb#66
sig(:final) { returns([T.nilable(::RBI::Sig), T.nilable(::String)]) }
def parse_sig; end
2022-03-04 18:14:44 +00:00
end
# source://rbi//lib/rbi/model.rb#387
2022-03-04 18:14:44 +00:00
class RBI::AttrAccessor < ::RBI::Attr
# source://rbi//lib/rbi/model.rb#401
2022-03-04 18:14:44 +00:00
sig do
params(
name: ::Symbol,
names: ::Symbol,
visibility: ::RBI::Visibility,
sigs: T::Array[::RBI::Sig],
loc: T.nilable(::RBI::Loc),
comments: T::Array[::RBI::Comment],
block: T.nilable(T.proc.params(node: ::RBI::AttrAccessor).void)
).void
end
def initialize(name, *names, visibility: T.unsafe(nil), sigs: T.unsafe(nil), loc: T.unsafe(nil), comments: T.unsafe(nil), &block); end
# source://rbi//lib/rbi/rewriters/merge_trees.rb#454
2022-03-04 18:14:44 +00:00
sig { override.params(other: ::RBI::Node).returns(T::Boolean) }
def compatible_with?(other); end
# source://rbi//lib/rbi/rewriters/attr_to_methods.rb#140
sig { override.returns(T::Array[::RBI::Method]) }
def convert_to_methods; end
# source://rbi//lib/rbi/model.rb#407
2022-03-04 18:14:44 +00:00
sig { override.returns(T::Array[::String]) }
def fully_qualified_names; end
# source://rbi//lib/rbi/model.rb#413
2022-03-04 18:14:44 +00:00
sig { override.returns(::String) }
def to_s; end
end
# source://rbi//lib/rbi/model.rb#419
2022-03-04 18:14:44 +00:00
class RBI::AttrReader < ::RBI::Attr
# source://rbi//lib/rbi/model.rb#433
2022-03-04 18:14:44 +00:00
sig do
params(
name: ::Symbol,
names: ::Symbol,
visibility: ::RBI::Visibility,
sigs: T::Array[::RBI::Sig],
loc: T.nilable(::RBI::Loc),
comments: T::Array[::RBI::Comment],
block: T.nilable(T.proc.params(node: ::RBI::AttrReader).void)
).void
end
def initialize(name, *names, visibility: T.unsafe(nil), sigs: T.unsafe(nil), loc: T.unsafe(nil), comments: T.unsafe(nil), &block); end
# source://rbi//lib/rbi/rewriters/merge_trees.rb#436
2022-03-04 18:14:44 +00:00
sig { override.params(other: ::RBI::Node).returns(T::Boolean) }
def compatible_with?(other); end
# source://rbi//lib/rbi/rewriters/attr_to_methods.rb#154
sig { override.returns(T::Array[::RBI::Method]) }
def convert_to_methods; end
# source://rbi//lib/rbi/model.rb#439
2022-03-04 18:14:44 +00:00
sig { override.returns(T::Array[::String]) }
def fully_qualified_names; end
# source://rbi//lib/rbi/model.rb#445
2022-03-04 18:14:44 +00:00
sig { override.returns(::String) }
def to_s; end
end
# source://rbi//lib/rbi/model.rb#451
2022-03-04 18:14:44 +00:00
class RBI::AttrWriter < ::RBI::Attr
# source://rbi//lib/rbi/model.rb#465
2022-03-04 18:14:44 +00:00
sig do
params(
name: ::Symbol,
names: ::Symbol,
visibility: ::RBI::Visibility,
sigs: T::Array[::RBI::Sig],
loc: T.nilable(::RBI::Loc),
comments: T::Array[::RBI::Comment],
block: T.nilable(T.proc.params(node: ::RBI::AttrWriter).void)
).void
end
def initialize(name, *names, visibility: T.unsafe(nil), sigs: T.unsafe(nil), loc: T.unsafe(nil), comments: T.unsafe(nil), &block); end
# source://rbi//lib/rbi/rewriters/merge_trees.rb#445
2022-03-04 18:14:44 +00:00
sig { override.params(other: ::RBI::Node).returns(T::Boolean) }
def compatible_with?(other); end
# source://rbi//lib/rbi/rewriters/attr_to_methods.rb#163
sig { override.returns(T::Array[::RBI::Method]) }
def convert_to_methods; end
# source://rbi//lib/rbi/model.rb#471
2022-03-04 18:14:44 +00:00
sig { override.returns(T::Array[::String]) }
def fully_qualified_names; end
# source://rbi//lib/rbi/model.rb#477
2022-03-04 18:14:44 +00:00
sig { override.returns(::String) }
def to_s; end
end
2023-12-14 15:34:15 +00:00
# An arbitrary blank line that can be added both in trees and comments
#
# source://rbi//lib/rbi/model.rb#76
2022-03-04 18:14:44 +00:00
class RBI::BlankLine < ::RBI::Comment
# source://rbi//lib/rbi/model.rb#80
2022-03-04 18:14:44 +00:00
sig { params(loc: T.nilable(::RBI::Loc)).void }
def initialize(loc: T.unsafe(nil)); end
end
# source://rbi//lib/rbi/model.rb#816
2022-03-04 18:14:44 +00:00
class RBI::BlockParam < ::RBI::Param
# source://rbi//lib/rbi/model.rb#827
2022-03-04 18:14:44 +00:00
sig do
params(
name: ::String,
loc: T.nilable(::RBI::Loc),
comments: T::Array[::RBI::Comment],
block: T.nilable(T.proc.params(node: ::RBI::BlockParam).void)
).void
end
def initialize(name, loc: T.unsafe(nil), comments: T.unsafe(nil), &block); end
# source://rbi//lib/rbi/model.rb#838
2022-03-04 18:14:44 +00:00
sig { params(other: T.nilable(::Object)).returns(T::Boolean) }
def ==(other); end
# source://rbi//lib/rbi/model.rb#833
2022-03-04 18:14:44 +00:00
sig { override.returns(::String) }
def to_s; end
end
# source://rbi//lib/rbi/model.rb#220
2022-03-04 18:14:44 +00:00
class RBI::Class < ::RBI::Scope
# source://rbi//lib/rbi/model.rb#238
2022-03-04 18:14:44 +00:00
sig do
params(
name: ::String,
superclass_name: T.nilable(::String),
loc: T.nilable(::RBI::Loc),
comments: T::Array[::RBI::Comment],
block: T.nilable(T.proc.params(node: ::RBI::Class).void)
).void
end
def initialize(name, superclass_name: T.unsafe(nil), loc: T.unsafe(nil), comments: T.unsafe(nil), &block); end
# source://rbi//lib/rbi/rewriters/merge_trees.rb#378
2022-03-04 18:14:44 +00:00
sig { override.params(other: ::RBI::Node).returns(T::Boolean) }
def compatible_with?(other); end
# source://rbi//lib/rbi/model.rb#246
2022-03-04 18:14:44 +00:00
sig { override.returns(::String) }
def fully_qualified_name; end
# source://rbi//lib/rbi/model.rb#224
2022-03-04 18:14:44 +00:00
sig { returns(::String) }
def name; end
2023-12-14 15:34:15 +00:00
# @return [String]
#
# source://rbi//lib/rbi/model.rb#224
2022-03-04 18:14:44 +00:00
def name=(_arg0); end
# source://rbi//lib/rbi/model.rb#227
2022-03-04 18:14:44 +00:00
sig { returns(T.nilable(::String)) }
def superclass_name; end
2023-12-14 15:34:15 +00:00
# @return [String, nil]
#
# source://rbi//lib/rbi/model.rb#227
2022-03-04 18:14:44 +00:00
def superclass_name=(_arg0); end
end
# source://rbi//lib/rbi/model.rb#55
2022-03-04 18:14:44 +00:00
class RBI::Comment < ::RBI::Node
# source://rbi//lib/rbi/model.rb#62
2022-03-04 18:14:44 +00:00
sig { params(text: ::String, loc: T.nilable(::RBI::Loc)).void }
def initialize(text, loc: T.unsafe(nil)); end
# source://rbi//lib/rbi/model.rb#68
2022-03-04 18:14:44 +00:00
sig { params(other: ::Object).returns(T::Boolean) }
def ==(other); end
# source://rbi//lib/rbi/model.rb#59
2022-03-04 18:14:44 +00:00
sig { returns(::String) }
def text; end
2023-12-14 15:34:15 +00:00
# @return [String]
#
# source://rbi//lib/rbi/model.rb#59
2022-03-04 18:14:44 +00:00
def text=(_arg0); end
end
2023-12-14 15:34:15 +00:00
# A tree showing incompatibles nodes
#
# Is rendered as a merge conflict between `left` and` right`:
# ~~~rb
# class Foo
# <<<<<<< left
# def m1; end
# def m2(a); end
# =======
# def m1(a); end
# def m2; end
# >>>>>>> right
# end
# ~~~
#
# source://rbi//lib/rbi/rewriters/merge_trees.rb#591
2022-03-04 18:14:44 +00:00
class RBI::ConflictTree < ::RBI::Tree
# source://rbi//lib/rbi/rewriters/merge_trees.rb#601
2022-03-04 18:14:44 +00:00
sig { params(left_name: ::String, right_name: ::String).void }
def initialize(left_name: T.unsafe(nil), right_name: T.unsafe(nil)); end
# source://rbi//lib/rbi/rewriters/merge_trees.rb#595
2022-03-04 18:14:44 +00:00
sig { returns(::RBI::Tree) }
def left; end
# source://rbi//lib/rbi/rewriters/merge_trees.rb#598
sig { returns(::String) }
def left_name; end
2023-12-14 15:34:15 +00:00
# @return [Tree]
#
# source://rbi//lib/rbi/rewriters/merge_trees.rb#595
2022-03-04 18:14:44 +00:00
def right; end
# @return [String]
#
# source://rbi//lib/rbi/rewriters/merge_trees.rb#598
def right_name; end
2022-03-04 18:14:44 +00:00
end
2023-12-14 15:34:15 +00:00
# Consts
#
# source://rbi//lib/rbi/model.rb#314
2022-03-04 18:14:44 +00:00
class RBI::Const < ::RBI::NodeWithComments
include ::RBI::Indexable
# source://rbi//lib/rbi/model.rb#329
2022-03-04 18:14:44 +00:00
sig do
params(
name: ::String,
value: ::String,
loc: T.nilable(::RBI::Loc),
comments: T::Array[::RBI::Comment],
block: T.nilable(T.proc.params(node: ::RBI::Const).void)
).void
end
def initialize(name, value, loc: T.unsafe(nil), comments: T.unsafe(nil), &block); end
# source://rbi//lib/rbi/rewriters/merge_trees.rb#405
2022-03-04 18:14:44 +00:00
sig { override.params(other: ::RBI::Node).returns(T::Boolean) }
def compatible_with?(other); end
# source://rbi//lib/rbi/model.rb#337
2022-03-04 18:14:44 +00:00
sig { returns(::String) }
def fully_qualified_name; end
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/index.rb#103
2022-03-04 18:14:44 +00:00
sig { override.returns(T::Array[::String]) }
def index_ids; end
# source://rbi//lib/rbi/model.rb#318
2022-03-04 18:14:44 +00:00
sig { returns(::String) }
def name; end
# source://rbi//lib/rbi/model.rb#344
2022-03-04 18:14:44 +00:00
sig { override.returns(::String) }
def to_s; end
2023-12-14 15:34:15 +00:00
# @return [String]
#
# source://rbi//lib/rbi/model.rb#318
2022-03-04 18:14:44 +00:00
def value; end
end
# source://rbi//lib/rbi/rewriters/merge_trees.rb#351
class RBI::DuplicateNodeError < ::RBI::Error; end
# source://rbi//lib/rbi.rb#8
class RBI::Error < ::StandardError; end
# source://rbi//lib/rbi/model.rb#891
2022-03-04 18:14:44 +00:00
class RBI::Extend < ::RBI::Mixin
include ::RBI::Indexable
# source://rbi//lib/rbi/model.rb#903
2022-03-04 18:14:44 +00:00
sig do
params(
name: ::String,
names: ::String,
loc: T.nilable(::RBI::Loc),
comments: T::Array[::RBI::Comment],
block: T.nilable(T.proc.params(node: ::RBI::Extend).void)
).void
end
def initialize(name, *names, loc: T.unsafe(nil), comments: T.unsafe(nil), &block); end
# source://rbi//lib/rbi/rewriters/merge_trees.rb#504
2022-03-04 18:14:44 +00:00
sig { override.params(other: ::RBI::Node).returns(T::Boolean) }
def compatible_with?(other); end
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/index.rb#143
2022-03-04 18:14:44 +00:00
sig { override.returns(T::Array[::String]) }
def index_ids; end
# source://rbi//lib/rbi/model.rb#909
2022-03-04 18:14:44 +00:00
sig { override.returns(::String) }
def to_s; end
end
# source://rbi//lib/rbi/model.rb#139
2022-03-04 18:14:44 +00:00
class RBI::File
# source://rbi//lib/rbi/model.rb#158
2022-03-04 18:14:44 +00:00
sig do
params(
strictness: T.nilable(::String),
comments: T::Array[::RBI::Comment],
block: T.nilable(T.proc.params(file: ::RBI::File).void)
).void
end
def initialize(strictness: T.unsafe(nil), comments: T.unsafe(nil), &block); end
# source://rbi//lib/rbi/model.rb#166
2022-03-04 18:14:44 +00:00
sig { params(node: ::RBI::Node).void }
def <<(node); end
# source://rbi//lib/rbi/model.rb#149
2022-03-04 18:14:44 +00:00
sig { returns(T::Array[::RBI::Comment]) }
def comments; end
2023-12-14 15:34:15 +00:00
# @return [Array<Comment>]
#
# source://rbi//lib/rbi/model.rb#149
2022-03-04 18:14:44 +00:00
def comments=(_arg0); end
# source://rbi//lib/rbi/model.rb#171
2022-03-04 18:14:44 +00:00
sig { returns(T::Boolean) }
def empty?; end
# source://rbi//lib/rbi/printer.rb#744
2022-03-04 18:14:44 +00:00
sig do
params(
out: T.any(::IO, ::StringIO),
indent: ::Integer,
print_locs: T::Boolean,
max_line_length: T.nilable(::Integer)
).void
end
def print(out: T.unsafe(nil), indent: T.unsafe(nil), print_locs: T.unsafe(nil), max_line_length: T.unsafe(nil)); end
# source://rbi//lib/rbi/model.rb#143
2022-03-04 18:14:44 +00:00
sig { returns(::RBI::Tree) }
def root; end
2023-12-14 15:34:15 +00:00
# @return [Tree]
#
# source://rbi//lib/rbi/model.rb#143
2022-03-04 18:14:44 +00:00
def root=(_arg0); end
# source://rbi//lib/rbi/model.rb#146
2022-03-04 18:14:44 +00:00
sig { returns(T.nilable(::String)) }
def strictness; end
2023-12-14 15:34:15 +00:00
# @return [String, nil]
#
# source://rbi//lib/rbi/model.rb#146
2022-03-04 18:14:44 +00:00
def strictness=(_arg0); end
# source://rbi//lib/rbi/printer.rb#750
2022-03-04 18:14:44 +00:00
sig { params(indent: ::Integer, print_locs: T::Boolean, max_line_length: T.nilable(::Integer)).returns(::String) }
def string(indent: T.unsafe(nil), print_locs: T.unsafe(nil), max_line_length: T.unsafe(nil)); end
end
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/formatter.rb#5
2022-03-04 18:14:44 +00:00
class RBI::Formatter
# source://rbi//lib/rbi/formatter.rb#24
2022-03-04 18:14:44 +00:00
sig do
params(
add_sig_templates: T::Boolean,
group_nodes: T::Boolean,
max_line_length: T.nilable(::Integer),
nest_singleton_methods: T::Boolean,
nest_non_public_methods: T::Boolean,
sort_nodes: T::Boolean
).void
end
def initialize(add_sig_templates: T.unsafe(nil), group_nodes: T.unsafe(nil), max_line_length: T.unsafe(nil), nest_singleton_methods: T.unsafe(nil), nest_non_public_methods: T.unsafe(nil), sort_nodes: T.unsafe(nil)); end
# source://rbi//lib/rbi/formatter.rb#47
2022-03-04 18:14:44 +00:00
sig { params(file: ::RBI::File).void }
def format_file(file); end
# source://rbi//lib/rbi/formatter.rb#52
2022-03-04 18:14:44 +00:00
sig { params(tree: ::RBI::Tree).void }
def format_tree(tree); end
# source://rbi//lib/rbi/formatter.rb#12
2022-03-04 18:14:44 +00:00
sig { returns(T.nilable(::Integer)) }
def max_line_length; end
2023-12-14 15:34:15 +00:00
# @return [Integer, nil]
#
# source://rbi//lib/rbi/formatter.rb#12
def max_line_length=(_arg0); end
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/formatter.rb#41
2022-03-04 18:14:44 +00:00
sig { params(file: ::RBI::File).returns(::String) }
def print_file(file); end
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/formatter.rb#9
sig { params(sort_nodes: T::Boolean).returns(T::Boolean) }
def sort_nodes=(sort_nodes); end
2022-03-04 18:14:44 +00:00
end
# source://rbi//lib/rbi/rewriters/group_nodes.rb#87
2022-03-04 18:14:44 +00:00
class RBI::Group < ::RBI::Tree
# source://rbi//lib/rbi/rewriters/group_nodes.rb#94
2022-03-04 18:14:44 +00:00
sig { params(kind: ::RBI::Group::Kind).void }
def initialize(kind); end
# source://rbi//lib/rbi/rewriters/group_nodes.rb#91
2022-03-04 18:14:44 +00:00
sig { returns(::RBI::Group::Kind) }
def kind; end
end
# source://rbi//lib/rbi/rewriters/group_nodes.rb#99
2022-03-04 18:14:44 +00:00
class RBI::Group::Kind < ::T::Enum
enums do
Mixins = new
RequiredAncestors = new
Helpers = new
TypeMembers = new
MixesInClassMethods = new
Sends = new
Attrs = new
TStructFields = new
TEnums = new
Inits = new
Methods = new
SingletonClasses = new
Consts = new
end
end
# source://rbi//lib/rbi/rewriters/group_nodes.rb#5
class RBI::GroupNodesError < ::RBI::Error; end
2023-12-14 15:34:15 +00:00
# Sorbet's misc.
#
# source://rbi//lib/rbi/model.rb#1374
2022-03-04 18:14:44 +00:00
class RBI::Helper < ::RBI::NodeWithComments
include ::RBI::Indexable
# source://rbi//lib/rbi/model.rb#1388
2022-03-04 18:14:44 +00:00
sig do
params(
name: ::String,
loc: T.nilable(::RBI::Loc),
comments: T::Array[::RBI::Comment],
block: T.nilable(T.proc.params(node: ::RBI::Helper).void)
).void
end
def initialize(name, loc: T.unsafe(nil), comments: T.unsafe(nil), &block); end
# source://rbi//lib/rbi/rewriters/merge_trees.rb#522
2022-03-04 18:14:44 +00:00
sig { override.params(other: ::RBI::Node).returns(T::Boolean) }
def compatible_with?(other); end
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/index.rb#173
2022-03-04 18:14:44 +00:00
sig { override.returns(T::Array[::String]) }
def index_ids; end
# source://rbi//lib/rbi/model.rb#1378
2022-03-04 18:14:44 +00:00
sig { returns(::String) }
def name; end
# source://rbi//lib/rbi/model.rb#1395
2022-03-04 18:14:44 +00:00
sig { override.returns(::String) }
def to_s; end
end
# source://rbi//lib/rbi/model.rb#868
2022-03-04 18:14:44 +00:00
class RBI::Include < ::RBI::Mixin
include ::RBI::Indexable
# source://rbi//lib/rbi/model.rb#880
2022-03-04 18:14:44 +00:00
sig do
params(
name: ::String,
names: ::String,
loc: T.nilable(::RBI::Loc),
comments: T::Array[::RBI::Comment],
block: T.nilable(T.proc.params(node: ::RBI::Include).void)
).void
end
def initialize(name, *names, loc: T.unsafe(nil), comments: T.unsafe(nil), &block); end
# source://rbi//lib/rbi/rewriters/merge_trees.rb#495
2022-03-04 18:14:44 +00:00
sig { override.params(other: ::RBI::Node).returns(T::Boolean) }
def compatible_with?(other); end
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/index.rb#133
2022-03-04 18:14:44 +00:00
sig { override.returns(T::Array[::String]) }
def index_ids; end
# source://rbi//lib/rbi/model.rb#886
2022-03-04 18:14:44 +00:00
sig { override.returns(::String) }
def to_s; end
end
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/index.rb#5
2022-03-04 18:14:44 +00:00
class RBI::Index < ::RBI::Visitor
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/index.rb#21
2022-03-04 18:14:44 +00:00
sig { void }
def initialize; end
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/index.rb#32
2022-03-04 18:14:44 +00:00
sig { params(id: ::String).returns(T::Array[::RBI::Node]) }
def [](id); end
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/index.rb#37
2022-03-04 18:14:44 +00:00
sig { params(nodes: ::RBI::Node).void }
def index(*nodes); end
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/index.rb#27
2022-03-04 18:14:44 +00:00
sig { returns(T::Array[::String]) }
def keys; end
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/index.rb#42
2022-03-04 18:14:44 +00:00
sig { override.params(node: T.nilable(::RBI::Node)).void }
def visit(node); end
private
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/index.rb#59
2022-03-04 18:14:44 +00:00
sig { params(node: T.all(::RBI::Indexable, ::RBI::Node)).void }
def index_node(node); end
class << self
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/index.rb#13
2022-03-04 18:14:44 +00:00
sig { params(node: ::RBI::Node).returns(::RBI::Index) }
def index(*node); end
end
end
# A Node that can be referred to by a unique ID inside an index
2023-12-14 15:34:15 +00:00
#
# @abstract Subclasses must implement the `abstract` methods below.
#
# source://rbi//lib/rbi/index.rb#74
2022-03-04 18:14:44 +00:00
module RBI::Indexable
interface!
2023-12-14 15:34:15 +00:00
# Unique IDs that refer to this node.
#
# Some nodes can have multiple ids, for example an attribute accessor matches the ID of the
# getter and the setter.
#
# @abstract
#
# source://rbi//lib/rbi/index.rb#85
2022-03-04 18:14:44 +00:00
sig { abstract.returns(T::Array[::String]) }
def index_ids; end
end
# source://rbi//lib/rbi/model.rb#1071
2022-03-04 18:14:44 +00:00
class RBI::KwArg < ::RBI::Arg
# source://rbi//lib/rbi/model.rb#1084
2022-03-04 18:14:44 +00:00
sig { params(keyword: ::String, value: ::String, loc: T.nilable(::RBI::Loc)).void }
def initialize(keyword, value, loc: T.unsafe(nil)); end
# source://rbi//lib/rbi/model.rb#1090
2022-03-04 18:14:44 +00:00
sig { params(other: T.nilable(::Object)).returns(T::Boolean) }
def ==(other); end
# source://rbi//lib/rbi/model.rb#1075
2022-03-04 18:14:44 +00:00
sig { returns(::String) }
def keyword; end
# source://rbi//lib/rbi/model.rb#1095
2022-03-04 18:14:44 +00:00
sig { returns(::String) }
def to_s; end
end
# source://rbi//lib/rbi/model.rb#757
2022-03-04 18:14:44 +00:00
class RBI::KwOptParam < ::RBI::Param
# source://rbi//lib/rbi/model.rb#772
2022-03-04 18:14:44 +00:00
sig do
params(
name: ::String,
value: ::String,
loc: T.nilable(::RBI::Loc),
comments: T::Array[::RBI::Comment],
block: T.nilable(T.proc.params(node: ::RBI::KwOptParam).void)
).void
end
def initialize(name, value, loc: T.unsafe(nil), comments: T.unsafe(nil), &block); end
# source://rbi//lib/rbi/model.rb#784
2022-03-04 18:14:44 +00:00
sig { params(other: T.nilable(::Object)).returns(T::Boolean) }
def ==(other); end
# source://rbi//lib/rbi/model.rb#779
2022-03-04 18:14:44 +00:00
sig { override.returns(::String) }
def to_s; end
# source://rbi//lib/rbi/model.rb#761
2022-03-04 18:14:44 +00:00
sig { returns(::String) }
def value; end
end
# source://rbi//lib/rbi/model.rb#730
2022-03-04 18:14:44 +00:00
class RBI::KwParam < ::RBI::Param
# source://rbi//lib/rbi/model.rb#741
2022-03-04 18:14:44 +00:00
sig do
params(
name: ::String,
loc: T.nilable(::RBI::Loc),
comments: T::Array[::RBI::Comment],
block: T.nilable(T.proc.params(node: ::RBI::KwParam).void)
).void
end
def initialize(name, loc: T.unsafe(nil), comments: T.unsafe(nil), &block); end
# source://rbi//lib/rbi/model.rb#752
2022-03-04 18:14:44 +00:00
sig { params(other: T.nilable(::Object)).returns(T::Boolean) }
def ==(other); end
# source://rbi//lib/rbi/model.rb#747
2022-03-04 18:14:44 +00:00
sig { override.returns(::String) }
def to_s; end
end
# source://rbi//lib/rbi/model.rb#789
2022-03-04 18:14:44 +00:00
class RBI::KwRestParam < ::RBI::Param
# source://rbi//lib/rbi/model.rb#800
2022-03-04 18:14:44 +00:00
sig do
params(
name: ::String,
loc: T.nilable(::RBI::Loc),
comments: T::Array[::RBI::Comment],
block: T.nilable(T.proc.params(node: ::RBI::KwRestParam).void)
).void
end
def initialize(name, loc: T.unsafe(nil), comments: T.unsafe(nil), &block); end
# source://rbi//lib/rbi/model.rb#811
2022-03-04 18:14:44 +00:00
sig { params(other: T.nilable(::Object)).returns(T::Boolean) }
def ==(other); end
# source://rbi//lib/rbi/model.rb#806
2022-03-04 18:14:44 +00:00
sig { override.returns(::String) }
def to_s; end
end
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/loc.rb#5
2022-03-04 18:14:44 +00:00
class RBI::Loc
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/loc.rb#38
2022-03-04 18:14:44 +00:00
sig do
params(
file: T.nilable(::String),
begin_line: T.nilable(::Integer),
end_line: T.nilable(::Integer),
begin_column: T.nilable(::Integer),
end_column: T.nilable(::Integer)
).void
end
def initialize(file: T.unsafe(nil), begin_line: T.unsafe(nil), end_line: T.unsafe(nil), begin_column: T.unsafe(nil), end_column: T.unsafe(nil)); end
2023-12-14 15:34:15 +00:00
# @return [Integer, nil]
#
# source://rbi//lib/rbi/loc.rb#27
2022-03-04 18:14:44 +00:00
def begin_column; end
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/loc.rb#27
2022-03-04 18:14:44 +00:00
sig { returns(T.nilable(::Integer)) }
def begin_line; end
2023-12-14 15:34:15 +00:00
# @return [Integer, nil]
#
# source://rbi//lib/rbi/loc.rb#27
2022-03-04 18:14:44 +00:00
def end_column; end
2023-12-14 15:34:15 +00:00
# @return [Integer, nil]
#
# source://rbi//lib/rbi/loc.rb#27
2022-03-04 18:14:44 +00:00
def end_line; end
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/loc.rb#24
2022-03-04 18:14:44 +00:00
sig { returns(T.nilable(::String)) }
def file; end
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/loc.rb#56
2022-03-15 18:11:17 +00:00
sig { returns(T.nilable(::String)) }
def source; end
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/loc.rb#47
2022-03-04 18:14:44 +00:00
sig { returns(::String) }
def to_s; end
class << self
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/loc.rb#12
sig { params(file: ::String, prism_location: ::Prism::Location).returns(::RBI::Loc) }
def from_prism(file, prism_location); end
2022-03-04 18:14:44 +00:00
end
end
2023-12-14 15:34:15 +00:00
# A tree that _might_ contain conflicts
#
# source://rbi//lib/rbi/rewriters/merge_trees.rb#330
2022-03-04 18:14:44 +00:00
class RBI::MergeTree < ::RBI::Tree
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/rewriters/merge_trees.rb#344
2022-03-04 18:14:44 +00:00
sig do
params(
loc: T.nilable(::RBI::Loc),
comments: T::Array[::RBI::Comment],
conflicts: T::Array[::RBI::Rewriters::Merge::Conflict],
block: T.nilable(T.proc.params(node: ::RBI::Tree).void)
).void
end
def initialize(loc: T.unsafe(nil), comments: T.unsafe(nil), conflicts: T.unsafe(nil), &block); end
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/rewriters/merge_trees.rb#334
2022-03-04 18:14:44 +00:00
sig { returns(T::Array[::RBI::Rewriters::Merge::Conflict]) }
def conflicts; end
end
2023-12-14 15:34:15 +00:00
# Methods and args
#
# source://rbi//lib/rbi/model.rb#485
2022-03-04 18:14:44 +00:00
class RBI::Method < ::RBI::NodeWithComments
include ::RBI::Indexable
# source://rbi//lib/rbi/model.rb#515
2022-03-04 18:14:44 +00:00
sig do
params(
name: ::String,
params: T::Array[::RBI::Param],
is_singleton: T::Boolean,
visibility: ::RBI::Visibility,
sigs: T::Array[::RBI::Sig],
loc: T.nilable(::RBI::Loc),
comments: T::Array[::RBI::Comment],
block: T.nilable(T.proc.params(node: ::RBI::Method).void)
).void
end
def initialize(name, params: T.unsafe(nil), is_singleton: T.unsafe(nil), visibility: T.unsafe(nil), sigs: T.unsafe(nil), loc: T.unsafe(nil), comments: T.unsafe(nil), &block); end
# source://rbi//lib/rbi/model.rb#535
2022-03-04 18:14:44 +00:00
sig { params(param: ::RBI::Param).void }
def <<(param); end
# source://rbi//lib/rbi/model.rb#570
sig { params(name: ::String).void }
def add_block_param(name); end
# source://rbi//lib/rbi/model.rb#560
sig { params(name: ::String, default_value: ::String).void }
def add_kw_opt_param(name, default_value); end
# source://rbi//lib/rbi/model.rb#555
sig { params(name: ::String).void }
def add_kw_param(name); end
# source://rbi//lib/rbi/model.rb#565
sig { params(name: ::String).void }
def add_kw_rest_param(name); end
# source://rbi//lib/rbi/model.rb#545
sig { params(name: ::String, default_value: ::String).void }
def add_opt_param(name, default_value); end
# source://rbi//lib/rbi/model.rb#540
sig { params(name: ::String).void }
def add_param(name); end
# source://rbi//lib/rbi/model.rb#550
sig { params(name: ::String).void }
def add_rest_param(name); end
# source://rbi//lib/rbi/model.rb#587
sig do
params(
params: T::Array[::RBI::SigParam],
return_type: T.nilable(::String),
is_abstract: T::Boolean,
is_override: T::Boolean,
is_overridable: T::Boolean,
is_final: T::Boolean,
type_params: T::Array[::String],
checked: T.nilable(::Symbol),
block: T.proc.params(node: ::RBI::Sig).void
).void
end
def add_sig(params: T.unsafe(nil), return_type: T.unsafe(nil), is_abstract: T.unsafe(nil), is_override: T.unsafe(nil), is_overridable: T.unsafe(nil), is_final: T.unsafe(nil), type_params: T.unsafe(nil), checked: T.unsafe(nil), &block); end
# source://rbi//lib/rbi/rewriters/merge_trees.rb#463
2022-03-04 18:14:44 +00:00
sig { override.params(other: ::RBI::Node).returns(T::Boolean) }
def compatible_with?(other); end
# source://rbi//lib/rbi/model.rb#613
2022-03-04 18:14:44 +00:00
sig { returns(::String) }
def fully_qualified_name; end
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/index.rb#123
2022-03-04 18:14:44 +00:00
sig { override.returns(T::Array[::String]) }
def index_ids; end
# source://rbi//lib/rbi/model.rb#495
2022-03-04 18:14:44 +00:00
sig { returns(T::Boolean) }
def is_singleton; end
2023-12-14 15:34:15 +00:00
# @return [Boolean]
#
# source://rbi//lib/rbi/model.rb#495
2022-03-04 18:14:44 +00:00
def is_singleton=(_arg0); end
# source://rbi//lib/rbi/rewriters/merge_trees.rb#472
2022-03-04 18:14:44 +00:00
sig { override.params(other: ::RBI::Node).void }
def merge_with(other); end
# source://rbi//lib/rbi/model.rb#489
2022-03-04 18:14:44 +00:00
sig { returns(::String) }
def name; end
2023-12-14 15:34:15 +00:00
# @return [String]
#
# source://rbi//lib/rbi/model.rb#489
2022-03-04 18:14:44 +00:00
def name=(_arg0); end
# source://rbi//lib/rbi/model.rb#492
2022-03-04 18:14:44 +00:00
sig { returns(T::Array[::RBI::Param]) }
def params; end
# source://rbi//lib/rbi/model.rb#501
2022-03-04 18:14:44 +00:00
sig { returns(T::Array[::RBI::Sig]) }
def sigs; end
2023-12-14 15:34:15 +00:00
# @return [Array<Sig>]
#
# source://rbi//lib/rbi/model.rb#501
2022-03-04 18:14:44 +00:00
def sigs=(_arg0); end
# source://rbi//lib/rbi/model.rb#622
2022-03-04 18:14:44 +00:00
sig { override.returns(::String) }
def to_s; end
# source://rbi//lib/rbi/model.rb#498
2022-03-04 18:14:44 +00:00
sig { returns(::RBI::Visibility) }
def visibility; end
2023-12-14 15:34:15 +00:00
# @return [Visibility]
#
# source://rbi//lib/rbi/model.rb#498
2022-03-04 18:14:44 +00:00
def visibility=(_arg0); end
end
# source://rbi//lib/rbi/model.rb#1435
2022-03-04 18:14:44 +00:00
class RBI::MixesInClassMethods < ::RBI::Mixin
include ::RBI::Indexable
# source://rbi//lib/rbi/model.rb#1447
2022-03-04 18:14:44 +00:00
sig do
params(
name: ::String,
names: ::String,
loc: T.nilable(::RBI::Loc),
comments: T::Array[::RBI::Comment],
block: T.nilable(T.proc.params(node: ::RBI::MixesInClassMethods).void)
).void
end
def initialize(name, *names, loc: T.unsafe(nil), comments: T.unsafe(nil), &block); end
# source://rbi//lib/rbi/rewriters/merge_trees.rb#513
2022-03-04 18:14:44 +00:00
sig { override.params(other: ::RBI::Node).returns(T::Boolean) }
def compatible_with?(other); end
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/index.rb#153
2022-03-04 18:14:44 +00:00
sig { override.returns(T::Array[::String]) }
def index_ids; end
# source://rbi//lib/rbi/model.rb#1453
2022-03-04 18:14:44 +00:00
sig { override.returns(::String) }
def to_s; end
end
2023-12-14 15:34:15 +00:00
# Mixins
#
# @abstract It cannot be directly instantiated. Subclasses must implement the `abstract` methods below.
#
# source://rbi//lib/rbi/model.rb#845
2022-03-04 18:14:44 +00:00
class RBI::Mixin < ::RBI::NodeWithComments
abstract!
# source://rbi//lib/rbi/model.rb#862
2022-03-04 18:14:44 +00:00
sig do
params(
name: ::String,
names: T::Array[::String],
loc: T.nilable(::RBI::Loc),
comments: T::Array[::RBI::Comment]
).void
end
def initialize(name, names, loc: T.unsafe(nil), comments: T.unsafe(nil)); end
# source://rbi//lib/rbi/rewriters/merge_trees.rb#486
2022-03-04 18:14:44 +00:00
sig { override.params(other: ::RBI::Node).returns(T::Boolean) }
def compatible_with?(other); end
# source://rbi//lib/rbi/model.rb#852
2022-03-04 18:14:44 +00:00
sig { returns(T::Array[::String]) }
def names; end
end
# source://rbi//lib/rbi/model.rb#192
2022-03-04 18:14:44 +00:00
class RBI::Module < ::RBI::Scope
# source://rbi//lib/rbi/model.rb#206
2022-03-04 18:14:44 +00:00
sig do
params(
name: ::String,
loc: T.nilable(::RBI::Loc),
comments: T::Array[::RBI::Comment],
block: T.nilable(T.proc.params(node: ::RBI::Module).void)
).void
end
def initialize(name, loc: T.unsafe(nil), comments: T.unsafe(nil), &block); end
# source://rbi//lib/rbi/rewriters/merge_trees.rb#387
2022-03-04 18:14:44 +00:00
sig { override.params(other: ::RBI::Node).returns(T::Boolean) }
def compatible_with?(other); end
# source://rbi//lib/rbi/model.rb#213
2022-03-04 18:14:44 +00:00
sig { override.returns(::String) }
def fully_qualified_name; end
# source://rbi//lib/rbi/model.rb#196
2022-03-04 18:14:44 +00:00
sig { returns(::String) }
def name; end
2023-12-14 15:34:15 +00:00
# @return [String]
#
# source://rbi//lib/rbi/model.rb#196
2022-03-04 18:14:44 +00:00
def name=(_arg0); end
end
2023-12-14 15:34:15 +00:00
# @abstract It cannot be directly instantiated. Subclasses must implement the `abstract` methods below.
#
# source://rbi//lib/rbi/model.rb#7
2022-03-04 18:14:44 +00:00
class RBI::Node
abstract!
# source://rbi//lib/rbi/model.rb#20
2022-03-04 18:14:44 +00:00
sig { params(loc: T.nilable(::RBI::Loc)).void }
def initialize(loc: T.unsafe(nil)); end
2023-12-14 15:34:15 +00:00
# Can `self` and `_other` be merged into a single definition?
#
# source://rbi//lib/rbi/rewriters/merge_trees.rb#287
2022-03-04 18:14:44 +00:00
sig { params(_other: ::RBI::Node).returns(T::Boolean) }
def compatible_with?(_other); end
# source://rbi//lib/rbi/model.rb#26
2022-03-04 18:14:44 +00:00
sig { void }
def detach; end
# source://rbi//lib/rbi/model.rb#17
2022-03-04 18:14:44 +00:00
sig { returns(T.nilable(::RBI::Loc)) }
def loc; end
2023-12-14 15:34:15 +00:00
# @return [Loc, nil]
#
# source://rbi//lib/rbi/model.rb#17
2022-03-04 18:14:44 +00:00
def loc=(_arg0); end
2023-12-14 15:34:15 +00:00
# Merge `self` and `other` into a single definition
#
# source://rbi//lib/rbi/rewriters/merge_trees.rb#293
2022-03-04 18:14:44 +00:00
sig { params(other: ::RBI::Node).void }
def merge_with(other); end
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/rewriters/merge_trees.rb#296
2022-03-04 18:14:44 +00:00
sig { returns(T.nilable(::RBI::ConflictTree)) }
def parent_conflict_tree; end
# source://rbi//lib/rbi/model.rb#48
2022-03-04 18:14:44 +00:00
sig { returns(T.nilable(::RBI::Scope)) }
def parent_scope; end
# source://rbi//lib/rbi/model.rb#14
2022-03-04 18:14:44 +00:00
sig { returns(T.nilable(::RBI::Tree)) }
def parent_tree; end
2023-12-14 15:34:15 +00:00
# @return [Tree, nil]
#
# source://rbi//lib/rbi/model.rb#14
2022-03-04 18:14:44 +00:00
def parent_tree=(_arg0); end
# source://rbi//lib/rbi/printer.rb#768
2022-03-04 18:14:44 +00:00
sig do
params(
out: T.any(::IO, ::StringIO),
indent: ::Integer,
print_locs: T::Boolean,
max_line_length: T.nilable(::Integer)
).void
end
def print(out: T.unsafe(nil), indent: T.unsafe(nil), print_locs: T.unsafe(nil), max_line_length: T.unsafe(nil)); end
# @raise [ReplaceNodeError]
#
# source://rbi//lib/rbi/model.rb#35
2022-03-04 18:14:44 +00:00
sig { params(node: ::RBI::Node).void }
def replace(node); end
# source://rbi//lib/rbi/rewriters/filter_versions.rb#94
sig { params(version: ::Gem::Version).returns(T::Boolean) }
def satisfies_version?(version); end
# source://rbi//lib/rbi/printer.rb#774
2022-03-04 18:14:44 +00:00
sig { params(indent: ::Integer, print_locs: T::Boolean, max_line_length: T.nilable(::Integer)).returns(::String) }
def string(indent: T.unsafe(nil), print_locs: T.unsafe(nil), max_line_length: T.unsafe(nil)); end
end
2023-12-14 15:34:15 +00:00
# @abstract It cannot be directly instantiated. Subclasses must implement the `abstract` methods below.
#
# source://rbi//lib/rbi/model.rb#85
2022-03-04 18:14:44 +00:00
class RBI::NodeWithComments < ::RBI::Node
abstract!
# source://rbi//lib/rbi/model.rb#95
2022-03-04 18:14:44 +00:00
sig { params(loc: T.nilable(::RBI::Loc), comments: T::Array[::RBI::Comment]).void }
def initialize(loc: T.unsafe(nil), comments: T.unsafe(nil)); end
# source://rbi//lib/rbi/model.rb#101
2022-03-04 18:14:44 +00:00
sig { returns(T::Array[::String]) }
def annotations; end
# source://rbi//lib/rbi/model.rb#92
2022-03-04 18:14:44 +00:00
sig { returns(T::Array[::RBI::Comment]) }
def comments; end
2023-12-14 15:34:15 +00:00
# @return [Array<Comment>]
#
# source://rbi//lib/rbi/model.rb#92
2022-03-04 18:14:44 +00:00
def comments=(_arg0); end
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/rewriters/merge_trees.rb#311
2022-03-04 18:14:44 +00:00
sig { override.params(other: ::RBI::Node).void }
def merge_with(other); end
# source://rbi//lib/rbi/rewriters/filter_versions.rb#104
sig { returns(T::Array[::Gem::Requirement]) }
def version_requirements; end
2022-03-04 18:14:44 +00:00
end
# source://rbi//lib/rbi/model.rb#676
2022-03-04 18:14:44 +00:00
class RBI::OptParam < ::RBI::Param
# source://rbi//lib/rbi/model.rb#691
2022-03-04 18:14:44 +00:00
sig do
params(
name: ::String,
value: ::String,
loc: T.nilable(::RBI::Loc),
comments: T::Array[::RBI::Comment],
block: T.nilable(T.proc.params(node: ::RBI::OptParam).void)
).void
end
def initialize(name, value, loc: T.unsafe(nil), comments: T.unsafe(nil), &block); end
# source://rbi//lib/rbi/model.rb#698
2022-03-04 18:14:44 +00:00
sig { params(other: T.nilable(::Object)).returns(T::Boolean) }
def ==(other); end
# source://rbi//lib/rbi/model.rb#680
2022-03-04 18:14:44 +00:00
sig { returns(::String) }
def value; end
end
2023-12-14 15:34:15 +00:00
# @abstract It cannot be directly instantiated. Subclasses must implement the `abstract` methods below.
#
# source://rbi//lib/rbi/model.rb#627
2022-03-04 18:14:44 +00:00
class RBI::Param < ::RBI::NodeWithComments
abstract!
# source://rbi//lib/rbi/model.rb#643
2022-03-04 18:14:44 +00:00
sig { params(name: ::String, loc: T.nilable(::RBI::Loc), comments: T::Array[::RBI::Comment]).void }
def initialize(name, loc: T.unsafe(nil), comments: T.unsafe(nil)); end
# source://rbi//lib/rbi/model.rb#634
2022-03-04 18:14:44 +00:00
sig { returns(::String) }
def name; end
# source://rbi//lib/rbi/model.rb#649
2022-03-04 18:14:44 +00:00
sig { override.returns(::String) }
def to_s; end
end
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/parser.rb#7
class RBI::ParseError < ::RBI::Error
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/parser.rb#14
2022-03-04 18:14:44 +00:00
sig { params(message: ::String, location: ::RBI::Loc).void }
def initialize(message, location); end
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/parser.rb#11
2022-03-04 18:14:44 +00:00
sig { returns(::RBI::Loc) }
def location; end
end
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/parser.rb#53
2022-03-04 18:14:44 +00:00
class RBI::Parser
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/parser.rb#88
2022-03-04 18:14:44 +00:00
sig { params(path: ::String).returns(::RBI::Tree) }
def parse_file(path); end
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/parser.rb#83
2022-03-04 18:14:44 +00:00
sig { params(string: ::String).returns(::RBI::Tree) }
def parse_string(string); end
private
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/parser.rb#95
sig { params(source: ::String, file: ::String).returns(::RBI::Tree) }
def parse(source, file:); end
2022-03-04 18:14:44 +00:00
class << self
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/parser.rb#65
2022-03-04 18:14:44 +00:00
sig { params(path: ::String).returns(::RBI::Tree) }
def parse_file(path); end
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/parser.rb#70
2022-03-04 18:14:44 +00:00
sig { params(paths: T::Array[::String]).returns(T::Array[::RBI::Tree]) }
def parse_files(paths); end
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/parser.rb#60
2022-03-04 18:14:44 +00:00
sig { params(string: ::String).returns(::RBI::Tree) }
def parse_string(string); end
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/parser.rb#76
2022-03-04 18:14:44 +00:00
sig { params(strings: T::Array[::String]).returns(T::Array[::RBI::Tree]) }
def parse_strings(strings); end
end
end
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/parser.rb#791
class RBI::Parser::SigBuilder < ::RBI::Parser::Visitor
# source://rbi//lib/rbi/parser.rb#798
sig { params(content: ::String, file: ::String).void }
def initialize(content, file:); end
# source://rbi//lib/rbi/parser.rb#795
sig { returns(::RBI::Sig) }
def current; end
# source://rbi//lib/rbi/parser.rb#850
sig { override.params(node: ::Prism::AssocNode).void }
def visit_assoc_node(node); end
# source://rbi//lib/rbi/parser.rb#805
sig { override.params(node: ::Prism::CallNode).void }
def visit_call_node(node); end
end
# source://rbi//lib/rbi/parser.rb#153
class RBI::Parser::TreeBuilder < ::RBI::Parser::Visitor
# source://rbi//lib/rbi/parser.rb#163
sig { params(source: ::String, comments: T::Array[::Prism::Comment], file: ::String).void }
def initialize(source, comments:, file:); end
# source://rbi//lib/rbi/parser.rb#160
sig { returns(T.nilable(::Prism::Node)) }
def last_node; end
# source://rbi//lib/rbi/parser.rb#157
sig { returns(::RBI::Tree) }
def tree; end
# source://rbi//lib/rbi/parser.rb#299
sig { params(node: ::Prism::CallNode).void }
def visit_call_node(node); end
# source://rbi//lib/rbi/parser.rb#176
sig { override.params(node: ::Prism::ClassNode).void }
def visit_class_node(node); end
# source://rbi//lib/rbi/parser.rb#208
sig { params(node: T.any(::Prism::ConstantPathWriteNode, ::Prism::ConstantWriteNode)).void }
def visit_constant_assign(node); end
# source://rbi//lib/rbi/parser.rb#201
sig { override.params(node: ::Prism::ConstantPathWriteNode).void }
def visit_constant_path_write_node(node); end
# source://rbi//lib/rbi/parser.rb#194
sig { override.params(node: ::Prism::ConstantWriteNode).void }
def visit_constant_write_node(node); end
# source://rbi//lib/rbi/parser.rb#241
sig { override.params(node: ::Prism::DefNode).void }
def visit_def_node(node); end
# source://rbi//lib/rbi/parser.rb#255
sig { override.params(node: ::Prism::ModuleNode).void }
def visit_module_node(node); end
# source://rbi//lib/rbi/parser.rb#272
sig { override.params(node: ::Prism::ProgramNode).void }
def visit_program_node(node); end
# source://rbi//lib/rbi/parser.rb#283
sig { override.params(node: ::Prism::SingletonClassNode).void }
def visit_singleton_class_node(node); end
private
# Collect all the remaining comments within a node
#
# source://rbi//lib/rbi/parser.rb#467
sig { params(node: ::Prism::Node).void }
def collect_dangling_comments(node); end
# Collect all the remaining comments after visiting the tree
#
# source://rbi//lib/rbi/parser.rb#485
sig { void }
def collect_orphan_comments; end
# source://rbi//lib/rbi/parser.rb#508
sig { returns(::RBI::Tree) }
def current_scope; end
# source://rbi//lib/rbi/parser.rb#513
sig { returns(T::Array[::RBI::Sig]) }
def current_sigs; end
# source://rbi//lib/rbi/parser.rb#520
sig { returns(T::Array[::RBI::Comment]) }
def current_sigs_comments; end
# source://rbi//lib/rbi/parser.rb#527
sig { params(node: ::Prism::Node).returns(T::Array[::RBI::Comment]) }
def node_comments(node); end
# source://rbi//lib/rbi/parser.rb#545
sig { params(node: ::Prism::Comment).returns(::RBI::Comment) }
def parse_comment(node); end
# source://rbi//lib/rbi/parser.rb#574
sig { params(node: T.nilable(::Prism::Node)).returns(T::Array[::RBI::Param]) }
def parse_params(node); end
# source://rbi//lib/rbi/parser.rb#550
sig { params(node: T.nilable(::Prism::Node)).returns(T::Array[::RBI::Arg]) }
def parse_send_args(node); end
# source://rbi//lib/rbi/parser.rb#648
sig { params(node: ::Prism::CallNode).returns(::RBI::Sig) }
def parse_sig(node); end
# source://rbi//lib/rbi/parser.rb#658
sig do
params(
node: T.any(::Prism::ConstantPathWriteNode, ::Prism::ConstantWriteNode)
).returns(T.nilable(::RBI::Struct))
end
def parse_struct(node); end
# source://rbi//lib/rbi/parser.rb#708
sig { params(send: ::Prism::CallNode).void }
def parse_tstruct_field(send); end
# source://rbi//lib/rbi/parser.rb#745
sig { params(name: ::String, node: ::Prism::Node).returns(::RBI::Visibility) }
def parse_visibility(name, node); end
# source://rbi//lib/rbi/parser.rb#759
sig { void }
def separate_header_comments; end
# source://rbi//lib/rbi/parser.rb#769
sig { void }
def set_root_tree_loc; end
# source://rbi//lib/rbi/parser.rb#783
sig { params(node: T.nilable(::Prism::Node)).returns(T::Boolean) }
def type_variable_definition?(node); end
end
# source://rbi//lib/rbi/parser.rb#122
class RBI::Parser::Visitor < ::Prism::Visitor
# source://rbi//lib/rbi/parser.rb#126
sig { params(source: ::String, file: ::String).void }
def initialize(source, file:); end
private
# source://rbi//lib/rbi/parser.rb#136
sig { params(node: ::Prism::Node).returns(::RBI::Loc) }
def node_loc(node); end
# source://rbi//lib/rbi/parser.rb#141
sig { params(node: T.nilable(::Prism::Node)).returns(T.nilable(::String)) }
def node_string(node); end
# source://rbi//lib/rbi/parser.rb#148
sig { params(node: ::Prism::Node).returns(::String) }
def node_string!(node); end
end
# source://rbi//lib/rbi/printer.rb#7
2022-03-04 18:14:44 +00:00
class RBI::Printer < ::RBI::Visitor
# source://rbi//lib/rbi/printer.rb#30
2022-03-04 18:14:44 +00:00
sig do
params(
out: T.any(::IO, ::StringIO),
indent: ::Integer,
print_locs: T::Boolean,
max_line_length: T.nilable(::Integer)
).void
end
def initialize(out: T.unsafe(nil), indent: T.unsafe(nil), print_locs: T.unsafe(nil), max_line_length: T.unsafe(nil)); end
# source://rbi//lib/rbi/printer.rb#17
2022-03-04 18:14:44 +00:00
sig { returns(::Integer) }
def current_indent; end
# source://rbi//lib/rbi/printer.rb#48
2022-03-04 18:14:44 +00:00
sig { void }
def dedent; end
2023-12-14 15:34:15 +00:00
# @return [Boolean]
#
# source://rbi//lib/rbi/printer.rb#11
2022-03-04 18:14:44 +00:00
def in_visibility_group; end
2023-12-14 15:34:15 +00:00
# @return [Boolean]
#
# source://rbi//lib/rbi/printer.rb#11
2022-03-04 18:14:44 +00:00
def in_visibility_group=(_arg0); end
2023-12-14 15:34:15 +00:00
# Printing
#
# source://rbi//lib/rbi/printer.rb#43
2022-03-04 18:14:44 +00:00
sig { void }
def indent; end
# source://rbi//lib/rbi/printer.rb#20
2022-03-04 18:14:44 +00:00
sig { returns(T.nilable(::Integer)) }
def max_line_length; end
# source://rbi//lib/rbi/printer.rb#14
2022-03-04 18:14:44 +00:00
sig { returns(T.nilable(::RBI::Node)) }
def previous_node; end
2023-12-14 15:34:15 +00:00
# Print a string without indentation nor `\n` at the end.
#
# source://rbi//lib/rbi/printer.rb#54
2022-03-04 18:14:44 +00:00
sig { params(string: ::String).void }
def print(string); end
# source://rbi//lib/rbi/printer.rb#11
2022-03-04 18:14:44 +00:00
sig { returns(T::Boolean) }
def print_locs; end
2023-12-14 15:34:15 +00:00
# @return [Boolean]
#
# source://rbi//lib/rbi/printer.rb#11
2022-03-04 18:14:44 +00:00
def print_locs=(_arg0); end
2023-12-14 15:34:15 +00:00
# Print a string with indentation and `\n` at the end.
#
# source://rbi//lib/rbi/printer.rb#74
2022-03-04 18:14:44 +00:00
sig { params(string: ::String).void }
def printl(string); end
2023-12-14 15:34:15 +00:00
# Print a string without indentation but with a `\n` at the end.
#
# source://rbi//lib/rbi/printer.rb#60
2022-03-04 18:14:44 +00:00
sig { params(string: T.nilable(::String)).void }
def printn(string = T.unsafe(nil)); end
2023-12-14 15:34:15 +00:00
# Print a string with indentation but without a `\n` at the end.
#
# source://rbi//lib/rbi/printer.rb#67
2022-03-04 18:14:44 +00:00
sig { params(string: T.nilable(::String)).void }
def printt(string = T.unsafe(nil)); end
# source://rbi//lib/rbi/printer.rb#80
2022-03-04 18:14:44 +00:00
sig { override.params(nodes: T::Array[::RBI::Node]).void }
def visit_all(nodes); end
# source://rbi//lib/rbi/printer.rb#91
sig { override.params(file: ::RBI::File).void }
2022-03-04 18:14:44 +00:00
def visit_file(file); end
private
# source://rbi//lib/rbi/printer.rb#619
sig { params(node: ::RBI::Node).returns(T::Boolean) }
def oneline?(node); end
# source://rbi//lib/rbi/printer.rb#577
sig { params(node: ::RBI::Node).void }
def print_blank_line_before(node); end
# source://rbi//lib/rbi/printer.rb#587
sig { params(node: ::RBI::Node).void }
def print_loc(node); end
# source://rbi//lib/rbi/printer.rb#593
sig { params(node: ::RBI::Param, last: T::Boolean).void }
def print_param_comment_leading_space(node, last:); end
# source://rbi//lib/rbi/printer.rb#666
sig { params(node: ::RBI::Sig).void }
def print_sig_as_block(node); end
# source://rbi//lib/rbi/printer.rb#641
sig { params(node: ::RBI::Sig).void }
def print_sig_as_line(node); end
# source://rbi//lib/rbi/printer.rb#611
sig { params(node: ::RBI::SigParam, last: T::Boolean).void }
def print_sig_param_comment_leading_space(node, last:); end
# source://rbi//lib/rbi/printer.rb#722
sig { params(node: ::RBI::Sig).returns(T::Array[::String]) }
def sig_modifiers(node); end
# source://rbi//lib/rbi/printer.rb#417
sig { override.params(node: ::RBI::Arg).void }
def visit_arg(node); end
# source://rbi//lib/rbi/printer.rb#237
sig { params(node: ::RBI::Attr).void }
def visit_attr(node); end
# source://rbi//lib/rbi/printer.rb#222
sig { override.params(node: ::RBI::AttrAccessor).void }
def visit_attr_accessor(node); end
# source://rbi//lib/rbi/printer.rb#227
sig { override.params(node: ::RBI::AttrReader).void }
def visit_attr_reader(node); end
# source://rbi//lib/rbi/printer.rb#232
sig { override.params(node: ::RBI::AttrWriter).void }
def visit_attr_writer(node); end
# source://rbi//lib/rbi/printer.rb#126
sig { override.params(node: ::RBI::BlankLine).void }
def visit_blank_line(node); end
# source://rbi//lib/rbi/printer.rb#344
sig { override.params(node: ::RBI::BlockParam).void }
def visit_block_param(node); end
# source://rbi//lib/rbi/printer.rb#143
sig { override.params(node: ::RBI::Class).void }
def visit_class(node); end
# source://rbi//lib/rbi/printer.rb#110
sig { override.params(node: ::RBI::Comment).void }
def visit_comment(node); end
# source://rbi//lib/rbi/printer.rb#554
sig { override.params(node: ::RBI::ConflictTree).void }
def visit_conflict_tree(node); end
# source://rbi//lib/rbi/printer.rb#213
sig { override.params(node: ::RBI::Const).void }
def visit_const(node); end
# source://rbi//lib/rbi/printer.rb#354
sig { override.params(node: ::RBI::Extend).void }
def visit_extend(node); end
# source://rbi//lib/rbi/printer.rb#526
sig { override.params(node: ::RBI::Group).void }
def visit_group(node); end
# source://rbi//lib/rbi/printer.rb#512
sig { override.params(node: ::RBI::Helper).void }
def visit_helper(node); end
# source://rbi//lib/rbi/printer.rb#349
sig { override.params(node: ::RBI::Include).void }
def visit_include(node); end
# source://rbi//lib/rbi/printer.rb#422
sig { override.params(node: ::RBI::KwArg).void }
def visit_kw_arg(node); end
# source://rbi//lib/rbi/printer.rb#334
sig { override.params(node: ::RBI::KwOptParam).void }
def visit_kw_opt_param(node); end
# source://rbi//lib/rbi/printer.rb#329
sig { override.params(node: ::RBI::KwParam).void }
def visit_kw_param(node); end
# source://rbi//lib/rbi/printer.rb#339
sig { override.params(node: ::RBI::KwRestParam).void }
def visit_kw_rest_param(node); end
# source://rbi//lib/rbi/printer.rb#265
sig { override.params(node: ::RBI::Method).void }
def visit_method(node); end
# source://rbi//lib/rbi/printer.rb#521
sig { override.params(node: ::RBI::MixesInClassMethods).void }
def visit_mixes_in_class_methods(node); end
# source://rbi//lib/rbi/printer.rb#359
sig { params(node: ::RBI::Mixin).void }
def visit_mixin(node); end
# source://rbi//lib/rbi/printer.rb#138
sig { override.params(node: ::RBI::Module).void }
def visit_module(node); end
# source://rbi//lib/rbi/printer.rb#319
sig { override.params(node: ::RBI::OptParam).void }
def visit_opt_param(node); end
# source://rbi//lib/rbi/printer.rb#386
sig { override.params(node: ::RBI::Private).void }
def visit_private(node); end
# source://rbi//lib/rbi/printer.rb#381
sig { override.params(node: ::RBI::Protected).void }
def visit_protected(node); end
# source://rbi//lib/rbi/printer.rb#376
sig { override.params(node: ::RBI::Public).void }
def visit_public(node); end
# source://rbi//lib/rbi/printer.rb#314
sig { override.params(node: ::RBI::ReqParam).void }
def visit_req_param(node); end
# source://rbi//lib/rbi/printer.rb#545
sig { override.params(node: ::RBI::RequiresAncestor).void }
def visit_requires_ancestor(node); end
# source://rbi//lib/rbi/printer.rb#324
sig { override.params(node: ::RBI::RestParam).void }
def visit_rest_param(node); end
# source://rbi//lib/rbi/printer.rb#158
sig { params(node: ::RBI::Scope).void }
def visit_scope(node); end
# source://rbi//lib/rbi/printer.rb#203
sig { params(node: ::RBI::Scope).void }
def visit_scope_body(node); end
# source://rbi//lib/rbi/printer.rb#563
sig { override.params(node: ::RBI::ScopeConflict).void }
def visit_scope_conflict(node); end
# source://rbi//lib/rbi/printer.rb#168
sig { params(node: ::RBI::Scope).void }
def visit_scope_header(node); end
# source://rbi//lib/rbi/printer.rb#400
sig { override.params(node: ::RBI::Send).void }
def visit_send(node); end
# source://rbi//lib/rbi/printer.rb#427
sig { override.params(node: ::RBI::Sig).void }
def visit_sig(node); end
# source://rbi//lib/rbi/printer.rb#446
sig { override.params(node: ::RBI::SigParam).void }
def visit_sig_param(node); end
# source://rbi//lib/rbi/printer.rb#153
sig { override.params(node: ::RBI::SingletonClass).void }
def visit_singleton_class(node); end
# source://rbi//lib/rbi/printer.rb#148
sig { override.params(node: ::RBI::Struct).void }
def visit_struct(node); end
# source://rbi//lib/rbi/printer.rb#466
sig { params(node: ::RBI::TStructField).void }
def visit_t_struct_field(node); end
# source://rbi//lib/rbi/printer.rb#484
sig { override.params(node: ::RBI::TEnum).void }
def visit_tenum(node); end
# source://rbi//lib/rbi/printer.rb#489
sig { override.params(node: ::RBI::TEnumBlock).void }
def visit_tenum_block(node); end
# source://rbi//lib/rbi/printer.rb#131
sig { override.params(node: ::RBI::Tree).void }
def visit_tree(node); end
# source://rbi//lib/rbi/printer.rb#451
sig { override.params(node: ::RBI::TStruct).void }
def visit_tstruct(node); end
# source://rbi//lib/rbi/printer.rb#456
sig { override.params(node: ::RBI::TStructConst).void }
def visit_tstruct_const(node); end
# source://rbi//lib/rbi/printer.rb#461
sig { override.params(node: ::RBI::TStructProp).void }
def visit_tstruct_prop(node); end
# source://rbi//lib/rbi/printer.rb#503
sig { override.params(node: ::RBI::TypeMember).void }
def visit_type_member(node); end
# source://rbi//lib/rbi/printer.rb#391
sig { params(node: ::RBI::Visibility).void }
def visit_visibility(node); end
# source://rbi//lib/rbi/printer.rb#532
sig { override.params(node: ::RBI::VisibilityGroup).void }
def visit_visibility_group(node); end
2022-03-04 18:14:44 +00:00
end
# source://rbi//lib/rbi/printer.rb#5
class RBI::PrinterError < ::RBI::Error; end
# source://rbi//lib/rbi/model.rb#984
2022-03-04 18:14:44 +00:00
class RBI::Private < ::RBI::Visibility
# source://rbi//lib/rbi/model.rb#994
2022-03-04 18:14:44 +00:00
sig do
params(
loc: T.nilable(::RBI::Loc),
comments: T::Array[::RBI::Comment],
block: T.nilable(T.proc.params(node: ::RBI::Private).void)
).void
end
def initialize(loc: T.unsafe(nil), comments: T.unsafe(nil), &block); end
end
# source://rbi//lib/rbi/model.rb#968
2022-03-04 18:14:44 +00:00
class RBI::Protected < ::RBI::Visibility
# source://rbi//lib/rbi/model.rb#978
2022-03-04 18:14:44 +00:00
sig do
params(
loc: T.nilable(::RBI::Loc),
comments: T::Array[::RBI::Comment],
block: T.nilable(T.proc.params(node: ::RBI::Protected).void)
).void
end
def initialize(loc: T.unsafe(nil), comments: T.unsafe(nil), &block); end
end
# source://rbi//lib/rbi/model.rb#952
2022-03-04 18:14:44 +00:00
class RBI::Public < ::RBI::Visibility
# source://rbi//lib/rbi/model.rb#962
2022-03-04 18:14:44 +00:00
sig do
params(
loc: T.nilable(::RBI::Loc),
comments: T::Array[::RBI::Comment],
block: T.nilable(T.proc.params(node: ::RBI::Public).void)
).void
end
def initialize(loc: T.unsafe(nil), comments: T.unsafe(nil), &block); end
end
# source://rbi//lib/rbi/model.rb#5
class RBI::ReplaceNodeError < ::RBI::Error; end
# source://rbi//lib/rbi/model.rb#654
2022-03-04 18:14:44 +00:00
class RBI::ReqParam < ::RBI::Param
# source://rbi//lib/rbi/model.rb#665
2022-03-04 18:14:44 +00:00
sig do
params(
name: ::String,
loc: T.nilable(::RBI::Loc),
comments: T::Array[::RBI::Comment],
block: T.nilable(T.proc.params(node: ::RBI::ReqParam).void)
).void
end
def initialize(name, loc: T.unsafe(nil), comments: T.unsafe(nil), &block); end
# source://rbi//lib/rbi/model.rb#671
2022-03-04 18:14:44 +00:00
sig { params(other: T.nilable(::Object)).returns(T::Boolean) }
def ==(other); end
end
# source://rbi//lib/rbi/model.rb#1458
2022-03-04 18:14:44 +00:00
class RBI::RequiresAncestor < ::RBI::NodeWithComments
include ::RBI::Indexable
# source://rbi//lib/rbi/model.rb#1471
2022-03-04 18:14:44 +00:00
sig { params(name: ::String, loc: T.nilable(::RBI::Loc), comments: T::Array[::RBI::Comment]).void }
def initialize(name, loc: T.unsafe(nil), comments: T.unsafe(nil)); end
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/index.rb#163
2022-03-04 18:14:44 +00:00
sig { override.returns(T::Array[::String]) }
def index_ids; end
# source://rbi//lib/rbi/model.rb#1462
2022-03-04 18:14:44 +00:00
sig { returns(::String) }
def name; end
# source://rbi//lib/rbi/model.rb#1477
2022-03-04 18:14:44 +00:00
sig { override.returns(::String) }
def to_s; end
end
# source://rbi//lib/rbi/model.rb#703
2022-03-04 18:14:44 +00:00
class RBI::RestParam < ::RBI::Param
# source://rbi//lib/rbi/model.rb#714
2022-03-04 18:14:44 +00:00
sig do
params(
name: ::String,
loc: T.nilable(::RBI::Loc),
comments: T::Array[::RBI::Comment],
block: T.nilable(T.proc.params(node: ::RBI::RestParam).void)
).void
end
def initialize(name, loc: T.unsafe(nil), comments: T.unsafe(nil), &block); end
# source://rbi//lib/rbi/model.rb#725
2022-03-04 18:14:44 +00:00
sig { params(other: T.nilable(::Object)).returns(T::Boolean) }
def ==(other); end
# source://rbi//lib/rbi/model.rb#720
2022-03-04 18:14:44 +00:00
sig { override.returns(::String) }
def to_s; end
end
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/rewriters/add_sig_templates.rb#5
2022-03-04 18:14:44 +00:00
module RBI::Rewriters; end
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/rewriters/add_sig_templates.rb#6
2022-03-04 18:14:44 +00:00
class RBI::Rewriters::AddSigTemplates < ::RBI::Visitor
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/rewriters/add_sig_templates.rb#10
2022-03-04 18:14:44 +00:00
sig { params(with_todo_comment: T::Boolean).void }
def initialize(with_todo_comment: T.unsafe(nil)); end
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/rewriters/add_sig_templates.rb#16
2022-03-04 18:14:44 +00:00
sig { override.params(node: T.nilable(::RBI::Node)).void }
def visit(node); end
private
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/rewriters/add_sig_templates.rb#30
2022-03-04 18:14:44 +00:00
sig { params(attr: ::RBI::Attr).void }
def add_attr_sig(attr); end
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/rewriters/add_sig_templates.rb#45
2022-03-04 18:14:44 +00:00
sig { params(method: ::RBI::Method).void }
def add_method_sig(method); end
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/rewriters/add_sig_templates.rb#56
2022-03-04 18:14:44 +00:00
sig { params(node: ::RBI::NodeWithComments).void }
def add_todo_comment(node); end
end
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/rewriters/annotate.rb#6
2022-03-04 18:14:44 +00:00
class RBI::Rewriters::Annotate < ::RBI::Visitor
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/rewriters/annotate.rb#10
2022-03-04 18:14:44 +00:00
sig { params(annotation: ::String, annotate_scopes: T::Boolean, annotate_properties: T::Boolean).void }
def initialize(annotation, annotate_scopes: T.unsafe(nil), annotate_properties: T.unsafe(nil)); end
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/rewriters/annotate.rb#18
2022-03-04 18:14:44 +00:00
sig { override.params(node: T.nilable(::RBI::Node)).void }
def visit(node); end
private
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/rewriters/annotate.rb#31
2022-03-04 18:14:44 +00:00
sig { params(node: ::RBI::NodeWithComments).void }
def annotate_node(node); end
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/rewriters/annotate.rb#38
2022-03-04 18:14:44 +00:00
sig { params(node: ::RBI::Node).returns(T::Boolean) }
def root?(node); end
end
# source://rbi//lib/rbi/rewriters/attr_to_methods.rb#22
class RBI::Rewriters::AttrToMethods < ::RBI::Visitor
# source://rbi//lib/rbi/rewriters/attr_to_methods.rb#26
sig { override.params(node: T.nilable(::RBI::Node)).void }
def visit(node); end
private
# @raise [ReplaceNodeError]
#
# source://rbi//lib/rbi/rewriters/attr_to_methods.rb#39
sig { params(node: ::RBI::Node, with: T::Array[::RBI::Node]).void }
def replace(node, with:); end
end
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/rewriters/deannotate.rb#6
2022-03-04 18:14:44 +00:00
class RBI::Rewriters::Deannotate < ::RBI::Visitor
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/rewriters/deannotate.rb#10
2022-03-04 18:14:44 +00:00
sig { params(annotation: ::String).void }
def initialize(annotation); end
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/rewriters/deannotate.rb#16
2022-03-04 18:14:44 +00:00
sig { override.params(node: T.nilable(::RBI::Node)).void }
def visit(node); end
private
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/rewriters/deannotate.rb#27
2022-03-04 18:14:44 +00:00
sig { params(node: ::RBI::NodeWithComments).void }
def deannotate_node(node); end
end
# Take a gem version and filter out all RBI that is not relevant to that version based on @version annotations
# in comments. As an example:
#
# ~~~rb
# tree = Parser.parse_string(<<~RBI)
# class Foo
# # @version > 0.3.0
# def bar
# end
#
# # @version <= 0.3.0
# def bar(arg1)
# end
# end
# RBI
#
# Rewriters::FilterVersions.filter(tree, Gem::Version.new("0.3.1"))
#
# assert_equal(<<~RBI, tree.string)
# class Foo
# # @version > 0.3.0
# def bar
# end
# end
# RBI
# ~~~
#
# Supported operators:
# - equals `=`
# - not equals `!=`
# - greater than `>`
# - greater than or equal to `>=`
# - less than `<`
# - less than or equal to `<=`
# - pessimistic or twiddle-wakka`~>`
#
# And/or logic:
# - "And" logic: put multiple versions on the same line
# - e.g. `@version > 0.3.0, <1.0.0` means version must be greater than 0.3.0 AND less than 1.0.0
# - "Or" logic: put multiple versions on subsequent lines
# - e.g. the following means version must be less than 0.3.0 OR greater than 1.0.0
# ```
# # @version < 0.3.0
# # @version > 1.0.0
# ```
# Prerelease versions:
# - Prerelease versions are considered less than their non-prerelease counterparts
# - e.g. `0.4.0-prerelease` is less than `0.4.0`
#
# RBI with no versions:
# - RBI with no version annotations are automatically counted towards ALL versions
#
# source://rbi//lib/rbi/rewriters/filter_versions.rb#57
class RBI::Rewriters::FilterVersions < ::RBI::Visitor
# source://rbi//lib/rbi/rewriters/filter_versions.rb#73
sig { params(version: ::Gem::Version).void }
def initialize(version); end
# source://rbi//lib/rbi/rewriters/filter_versions.rb#79
sig { override.params(node: T.nilable(::RBI::Node)).void }
def visit(node); end
class << self
# source://rbi//lib/rbi/rewriters/filter_versions.rb#66
sig { params(tree: ::RBI::Tree, version: ::Gem::Version).void }
def filter(tree, version); end
end
end
# source://rbi//lib/rbi/rewriters/filter_versions.rb#60
RBI::Rewriters::FilterVersions::VERSION_PREFIX = T.let(T.unsafe(nil), String)
# source://rbi//lib/rbi/rewriters/group_nodes.rb#8
2022-03-04 18:14:44 +00:00
class RBI::Rewriters::GroupNodes < ::RBI::Visitor
# source://rbi//lib/rbi/rewriters/group_nodes.rb#12
2022-03-04 18:14:44 +00:00
sig { override.params(node: T.nilable(::RBI::Node)).void }
def visit(node); end
private
# source://rbi//lib/rbi/rewriters/group_nodes.rb#36
sig { params(node: ::RBI::Node).returns(::RBI::Group::Kind) }
def group_kind(node); end
2022-03-04 18:14:44 +00:00
end
2023-12-14 15:34:15 +00:00
# Merge two RBI trees together
#
# Be this `Tree`:
# ~~~rb
# class Foo
# attr_accessor :a
# def m; end
# C = 10
# end
# ~~~
#
# Merged with this one:
# ~~~rb
# class Foo
# attr_reader :a
# def m(x); end
# C = 10
# end
# ~~~
#
# Compatible definitions are merged together while incompatible definitions are moved into a `ConflictTree`:
# ~~~rb
# class Foo
# <<<<<<< left
# attr_accessor :a
# def m; end
# =======
# attr_reader :a
# def m(x); end
# >>>>>>> right
# C = 10
# end
# ~~~
#
# source://rbi//lib/rbi/rewriters/merge_trees.rb#39
2022-03-04 18:14:44 +00:00
class RBI::Rewriters::Merge
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/rewriters/merge_trees.rb#70
2022-03-04 18:14:44 +00:00
sig { params(left_name: ::String, right_name: ::String, keep: ::RBI::Rewriters::Merge::Keep).void }
def initialize(left_name: T.unsafe(nil), right_name: T.unsafe(nil), keep: T.unsafe(nil)); end
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/rewriters/merge_trees.rb#79
2022-03-04 18:14:44 +00:00
sig { params(tree: ::RBI::Tree).void }
def merge(tree); end
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/rewriters/merge_trees.rb#67
2022-03-04 18:14:44 +00:00
sig { returns(::RBI::MergeTree) }
def tree; end
class << self
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/rewriters/merge_trees.rb#54
2022-03-04 18:14:44 +00:00
sig do
params(
left: ::RBI::Tree,
right: ::RBI::Tree,
left_name: ::String,
right_name: ::String,
keep: ::RBI::Rewriters::Merge::Keep
).returns(::RBI::MergeTree)
end
def merge_trees(left, right, left_name: T.unsafe(nil), right_name: T.unsafe(nil), keep: T.unsafe(nil)); end
end
end
2023-12-14 15:34:15 +00:00
# Used for logging / error displaying purpose
#
# source://rbi//lib/rbi/rewriters/merge_trees.rb#86
2022-03-04 18:14:44 +00:00
class RBI::Rewriters::Merge::Conflict < ::T::Struct
const :left, ::RBI::Node
const :right, ::RBI::Node
2023-12-14 15:34:15 +00:00
const :left_name, ::String
2022-03-04 18:14:44 +00:00
const :right_name, ::String
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/rewriters/merge_trees.rb#95
2022-03-04 18:14:44 +00:00
sig { returns(::String) }
def to_s; end
class << self
# source://sorbet-runtime/0.5.11481/lib/types/struct.rb#13
2022-03-04 18:14:44 +00:00
def inherited(s); end
end
end
2023-12-14 15:34:15 +00:00
# Merge adjacent conflict trees
#
# Transform this:
# ~~~rb
# class Foo
# <<<<<<< left
# def m1; end
# =======
# def m1(a); end
# >>>>>>> right
# <<<<<<< left
# def m2(a); end
# =======
# def m2; end
# >>>>>>> right
# end
# ~~~
#
# Into this:
# ~~~rb
# class Foo
# <<<<<<< left
# def m1; end
# def m2(a); end
# =======
# def m1(a); end
# def m2; end
# >>>>>>> right
# end
# ~~~
#
# source://rbi//lib/rbi/rewriters/merge_trees.rb#245
2022-03-04 18:14:44 +00:00
class RBI::Rewriters::Merge::ConflictTreeMerger < ::RBI::Visitor
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/rewriters/merge_trees.rb#247
2022-03-04 18:14:44 +00:00
sig { override.params(node: T.nilable(::RBI::Node)).void }
def visit(node); end
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/rewriters/merge_trees.rb#252
2022-03-04 18:14:44 +00:00
sig { override.params(nodes: T::Array[::RBI::Node]).void }
def visit_all(nodes); end
private
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/rewriters/merge_trees.rb#273
2022-03-04 18:14:44 +00:00
sig { params(left: ::RBI::Tree, right: ::RBI::Tree).void }
def merge_conflict_trees(left, right); end
end
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/rewriters/merge_trees.rb#42
2022-03-04 18:14:44 +00:00
class RBI::Rewriters::Merge::Keep < ::T::Enum
enums do
NONE = new
LEFT = new
RIGHT = new
end
end
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/rewriters/merge_trees.rb#100
2022-03-04 18:14:44 +00:00
class RBI::Rewriters::Merge::TreeMerger < ::RBI::Visitor
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/rewriters/merge_trees.rb#107
2022-03-04 18:14:44 +00:00
sig do
params(
output: ::RBI::Tree,
left_name: ::String,
right_name: ::String,
keep: ::RBI::Rewriters::Merge::Keep
).void
end
def initialize(output, left_name: T.unsafe(nil), right_name: T.unsafe(nil), keep: T.unsafe(nil)); end
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/rewriters/merge_trees.rb#104
2022-03-04 18:14:44 +00:00
sig { returns(T::Array[::RBI::Rewriters::Merge::Conflict]) }
def conflicts; end
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/rewriters/merge_trees.rb#119
2022-03-04 18:14:44 +00:00
sig { override.params(node: T.nilable(::RBI::Node)).void }
def visit(node); end
private
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/rewriters/merge_trees.rb#168
2022-03-04 18:14:44 +00:00
sig { returns(::RBI::Tree) }
def current_scope; end
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/rewriters/merge_trees.rb#185
2022-03-04 18:14:44 +00:00
sig { params(left: ::RBI::Scope, right: ::RBI::Scope).void }
def make_conflict_scope(left, right); end
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/rewriters/merge_trees.rb#192
2022-03-04 18:14:44 +00:00
sig { params(left: ::RBI::Node, right: ::RBI::Node).void }
def make_conflict_tree(left, right); end
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/rewriters/merge_trees.rb#173
2022-03-04 18:14:44 +00:00
sig { params(node: ::RBI::Node).returns(T.nilable(::RBI::Node)) }
def previous_definition(node); end
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/rewriters/merge_trees.rb#204
2022-03-04 18:14:44 +00:00
sig { params(left: ::RBI::Scope, right: ::RBI::Scope).returns(::RBI::Scope) }
def replace_scope_header(left, right); end
end
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/rewriters/nest_non_public_methods.rb#6
2022-03-04 18:14:44 +00:00
class RBI::Rewriters::NestNonPublicMethods < ::RBI::Visitor
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/rewriters/nest_non_public_methods.rb#10
2022-03-04 18:14:44 +00:00
sig { override.params(node: T.nilable(::RBI::Node)).void }
def visit(node); end
end
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/rewriters/nest_singleton_methods.rb#6
2022-03-04 18:14:44 +00:00
class RBI::Rewriters::NestSingletonMethods < ::RBI::Visitor
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/rewriters/nest_singleton_methods.rb#10
2022-03-04 18:14:44 +00:00
sig { override.params(node: T.nilable(::RBI::Node)).void }
def visit(node); end
end
2023-12-14 15:34:15 +00:00
# Remove all definitions existing in the index from the current tree
#
# Let's create an `Index` from two different `Tree`s:
# ~~~rb
# tree1 = Parse.parse_string(<<~RBI)
# class Foo
# def foo; end
# end
# RBI
#
# tree2 = Parse.parse_string(<<~RBI)
# FOO = 10
# RBI
#
# index = Index.index(tree1, tree2)
# ~~~
#
# We can use `RemoveKnownDefinitions` to remove the definitions found in the `index` from the `Tree` to clean:
# ~~~rb
# tree_to_clean = Parser.parse_string(<<~RBI)
# class Foo
# def foo; end
# def bar; end
# end
# FOO = 10
# BAR = 42
# RBI
#
# cleaned_tree, operations = RemoveKnownDefinitions.remove(tree_to_clean, index)
#
# assert_equal(<<~RBI, cleaned_tree)
# class Foo
# def bar; end
# end
# BAR = 42
# RBI
#
# assert_equal(<<~OPERATIONS, operations.join("\n"))
# Deleted ::Foo#foo at -:2:2-2-16 (duplicate from -:2:2-2:16)
# Deleted ::FOO at -:5:0-5:8 (duplicate from -:1:0-1:8)
# OPERATIONS
# ~~~
#
# source://rbi//lib/rbi/rewriters/remove_known_definitions.rb#48
2022-03-04 18:14:44 +00:00
class RBI::Rewriters::RemoveKnownDefinitions < ::RBI::Visitor
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/rewriters/remove_known_definitions.rb#55
2022-03-04 18:14:44 +00:00
sig { params(index: ::RBI::Index).void }
def initialize(index); end
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/rewriters/remove_known_definitions.rb#52
2022-03-04 18:14:44 +00:00
sig { returns(T::Array[::RBI::Rewriters::RemoveKnownDefinitions::Operation]) }
def operations; end
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/rewriters/remove_known_definitions.rb#83
2022-03-04 18:14:44 +00:00
sig { override.params(node: T.nilable(::RBI::Node)).void }
def visit(node); end
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/rewriters/remove_known_definitions.rb#78
2022-03-04 18:14:44 +00:00
sig { params(nodes: T::Array[::RBI::Node]).void }
def visit_all(nodes); end
private
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/rewriters/remove_known_definitions.rb#111
2022-03-04 18:14:44 +00:00
sig { params(node: ::RBI::Node, previous: ::RBI::Node).returns(T::Boolean) }
def can_delete_node?(node, previous); end
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/rewriters/remove_known_definitions.rb#129
2022-03-04 18:14:44 +00:00
sig { params(node: ::RBI::Node, previous: ::RBI::Node).void }
def delete_node(node, previous); end
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/rewriters/remove_known_definitions.rb#102
2022-03-04 18:14:44 +00:00
sig { params(node: ::RBI::Indexable).returns(T.nilable(::RBI::Node)) }
def previous_definition_for(node); end
class << self
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/rewriters/remove_known_definitions.rb#70
2022-03-04 18:14:44 +00:00
sig do
params(
tree: ::RBI::Tree,
index: ::RBI::Index
).returns([::RBI::Tree, T::Array[::RBI::Rewriters::RemoveKnownDefinitions::Operation]])
end
def remove(tree, index); end
end
end
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/rewriters/remove_known_definitions.rb#134
2022-03-04 18:14:44 +00:00
class RBI::Rewriters::RemoveKnownDefinitions::Operation < ::T::Struct
const :deleted_node, ::RBI::Node
const :duplicate_of, ::RBI::Node
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/rewriters/remove_known_definitions.rb#141
2022-03-04 18:14:44 +00:00
sig { returns(::String) }
def to_s; end
class << self
# source://sorbet-runtime/0.5.11481/lib/types/struct.rb#13
2022-03-04 18:14:44 +00:00
def inherited(s); end
end
end
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/rewriters/sort_nodes.rb#6
2022-03-04 18:14:44 +00:00
class RBI::Rewriters::SortNodes < ::RBI::Visitor
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/rewriters/sort_nodes.rb#10
2022-03-04 18:14:44 +00:00
sig { override.params(node: T.nilable(::RBI::Node)).void }
def visit(node); end
private
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/rewriters/sort_nodes.rb#73
2022-03-04 18:14:44 +00:00
sig { params(kind: ::RBI::Group::Kind).returns(::Integer) }
def group_rank(kind); end
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/rewriters/sort_nodes.rb#94
2022-03-04 18:14:44 +00:00
sig { params(node: ::RBI::Node).returns(T.nilable(::String)) }
def node_name(node); end
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/rewriters/sort_nodes.rb#45
2022-03-04 18:14:44 +00:00
sig { params(node: ::RBI::Node).returns(::Integer) }
def node_rank(node); end
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/rewriters/sort_nodes.rb#106
2022-03-04 18:14:44 +00:00
sig { params(node: ::RBI::Node).void }
def sort_node_names!(node); end
end
2023-12-14 15:34:15 +00:00
# Scopes
#
# @abstract It cannot be directly instantiated. Subclasses must implement the `abstract` methods below.
#
# source://rbi//lib/rbi/model.rb#178
2022-03-04 18:14:44 +00:00
class RBI::Scope < ::RBI::Tree
include ::RBI::Indexable
abstract!
2023-12-14 15:34:15 +00:00
# Duplicate `self` scope without its body
#
# source://rbi//lib/rbi/rewriters/merge_trees.rb#358
2022-03-04 18:14:44 +00:00
sig { returns(T.self_type) }
def dup_empty; end
2023-12-14 15:34:15 +00:00
# @abstract
#
# source://rbi//lib/rbi/model.rb#184
2022-03-04 18:14:44 +00:00
sig { abstract.returns(::String) }
def fully_qualified_name; end
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/index.rb#93
2022-03-04 18:14:44 +00:00
sig { override.returns(T::Array[::String]) }
def index_ids; end
# source://rbi//lib/rbi/model.rb#187
2022-03-04 18:14:44 +00:00
sig { override.returns(::String) }
def to_s; end
end
2023-12-14 15:34:15 +00:00
# A conflict between two scope headers
#
# Is rendered as a merge conflict between `left` and` right` for scope definitions:
# ~~~rb
# <<<<<<< left
# class Foo
# =======
# module Foo
# >>>>>>> right
# def m1; end
# end
# ~~~
#
# source://rbi//lib/rbi/rewriters/merge_trees.rb#624
2022-03-04 18:14:44 +00:00
class RBI::ScopeConflict < ::RBI::Tree
# source://rbi//lib/rbi/rewriters/merge_trees.rb#641
2022-03-04 18:14:44 +00:00
sig { params(left: ::RBI::Scope, right: ::RBI::Scope, left_name: ::String, right_name: ::String).void }
def initialize(left:, right:, left_name: T.unsafe(nil), right_name: T.unsafe(nil)); end
# source://rbi//lib/rbi/rewriters/merge_trees.rb#628
2022-03-04 18:14:44 +00:00
sig { returns(::RBI::Scope) }
def left; end
# source://rbi//lib/rbi/rewriters/merge_trees.rb#631
sig { returns(::String) }
def left_name; end
2022-03-04 18:14:44 +00:00
2023-12-14 15:34:15 +00:00
# @return [Scope]
#
# source://rbi//lib/rbi/rewriters/merge_trees.rb#628
2022-03-04 18:14:44 +00:00
def right; end
# @return [String]
#
# source://rbi//lib/rbi/rewriters/merge_trees.rb#631
def right_name; end
2022-03-04 18:14:44 +00:00
end
2023-12-14 15:34:15 +00:00
# Sends
#
# source://rbi//lib/rbi/model.rb#1002
2022-03-04 18:14:44 +00:00
class RBI::Send < ::RBI::NodeWithComments
include ::RBI::Indexable
# source://rbi//lib/rbi/model.rb#1020
2022-03-04 18:14:44 +00:00
sig do
params(
method: ::String,
args: T::Array[::RBI::Arg],
loc: T.nilable(::RBI::Loc),
comments: T::Array[::RBI::Comment],
block: T.nilable(T.proc.params(node: ::RBI::Send).void)
).void
end
def initialize(method, args = T.unsafe(nil), loc: T.unsafe(nil), comments: T.unsafe(nil), &block); end
# source://rbi//lib/rbi/model.rb#1028
2022-03-04 18:14:44 +00:00
sig { params(arg: ::RBI::Arg).void }
def <<(arg); end
# source://rbi//lib/rbi/model.rb#1033
2022-03-04 18:14:44 +00:00
sig { params(other: T.nilable(::Object)).returns(T::Boolean) }
def ==(other); end
# source://rbi//lib/rbi/model.rb#1009
2022-03-04 18:14:44 +00:00
sig { returns(T::Array[::RBI::Arg]) }
def args; end
# source://rbi//lib/rbi/rewriters/merge_trees.rb#531
2022-03-04 18:14:44 +00:00
sig { override.params(other: ::RBI::Node).returns(T::Boolean) }
def compatible_with?(other); end
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/index.rb#193
2022-03-04 18:14:44 +00:00
sig { override.returns(T::Array[::String]) }
def index_ids; end
# source://rbi//lib/rbi/model.rb#1006
2022-03-04 18:14:44 +00:00
sig { returns(::String) }
def method; end
# source://rbi//lib/rbi/model.rb#1038
2022-03-04 18:14:44 +00:00
sig { returns(::String) }
def to_s; end
end
2023-12-14 15:34:15 +00:00
# Sorbet's sigs
#
# source://rbi//lib/rbi/model.rb#1102
2022-03-04 18:14:44 +00:00
class RBI::Sig < ::RBI::Node
# source://rbi//lib/rbi/model.rb#1134
2022-03-04 18:14:44 +00:00
sig do
params(
params: T::Array[::RBI::SigParam],
return_type: T.nilable(::String),
is_abstract: T::Boolean,
is_override: T::Boolean,
is_overridable: T::Boolean,
is_final: T::Boolean,
type_params: T::Array[::String],
checked: T.nilable(::Symbol),
loc: T.nilable(::RBI::Loc),
block: T.nilable(T.proc.params(node: ::RBI::Sig).void)
).void
end
def initialize(params: T.unsafe(nil), return_type: T.unsafe(nil), is_abstract: T.unsafe(nil), is_override: T.unsafe(nil), is_overridable: T.unsafe(nil), is_final: T.unsafe(nil), type_params: T.unsafe(nil), checked: T.unsafe(nil), loc: T.unsafe(nil), &block); end
# source://rbi//lib/rbi/model.rb#1159
2022-03-04 18:14:44 +00:00
sig { params(param: ::RBI::SigParam).void }
def <<(param); end
# source://rbi//lib/rbi/model.rb#1169
2022-03-04 18:14:44 +00:00
sig { params(other: ::Object).returns(T::Boolean) }
def ==(other); end
# source://rbi//lib/rbi/model.rb#1164
sig { params(name: ::String, type: ::String).void }
def add_param(name, type); end
# source://rbi//lib/rbi/model.rb#1118
2022-03-04 18:14:44 +00:00
sig { returns(T.nilable(::Symbol)) }
def checked; end
2023-12-14 15:34:15 +00:00
# @return [Symbol, nil]
#
# source://rbi//lib/rbi/model.rb#1118
2022-03-04 18:14:44 +00:00
def checked=(_arg0); end
# source://rbi//lib/rbi/model.rb#1112
2022-03-04 18:14:44 +00:00
sig { returns(T::Boolean) }
def is_abstract; end
2023-12-14 15:34:15 +00:00
# @return [Boolean]
#
# source://rbi//lib/rbi/model.rb#1112
2022-03-04 18:14:44 +00:00
def is_abstract=(_arg0); end
2023-12-14 15:34:15 +00:00
# @return [Boolean]
#
# source://rbi//lib/rbi/model.rb#1112
2022-03-04 18:14:44 +00:00
def is_final; end
2023-12-14 15:34:15 +00:00
# @return [Boolean]
#
# source://rbi//lib/rbi/model.rb#1112
2022-03-04 18:14:44 +00:00
def is_final=(_arg0); end
2023-12-14 15:34:15 +00:00
# @return [Boolean]
#
# source://rbi//lib/rbi/model.rb#1112
2022-03-04 18:14:44 +00:00
def is_overridable; end
2023-12-14 15:34:15 +00:00
# @return [Boolean]
#
# source://rbi//lib/rbi/model.rb#1112
2022-03-04 18:14:44 +00:00
def is_overridable=(_arg0); end
2023-12-14 15:34:15 +00:00
# @return [Boolean]
#
# source://rbi//lib/rbi/model.rb#1112
2022-03-04 18:14:44 +00:00
def is_override; end
2023-12-14 15:34:15 +00:00
# @return [Boolean]
#
# source://rbi//lib/rbi/model.rb#1112
2022-03-04 18:14:44 +00:00
def is_override=(_arg0); end
# source://rbi//lib/rbi/model.rb#1106
2022-03-04 18:14:44 +00:00
sig { returns(T::Array[::RBI::SigParam]) }
def params; end
# source://rbi//lib/rbi/model.rb#1109
2022-03-04 18:14:44 +00:00
sig { returns(T.nilable(::String)) }
def return_type; end
2023-12-14 15:34:15 +00:00
# @return [String, nil]
#
# source://rbi//lib/rbi/model.rb#1109
2022-03-04 18:14:44 +00:00
def return_type=(_arg0); end
# source://rbi//lib/rbi/model.rb#1115
2022-03-04 18:14:44 +00:00
sig { returns(T::Array[::String]) }
def type_params; end
end
# source://rbi//lib/rbi/model.rb#1178
2022-03-04 18:14:44 +00:00
class RBI::SigParam < ::RBI::NodeWithComments
# source://rbi//lib/rbi/model.rb#1193
2022-03-04 18:14:44 +00:00
sig do
params(
name: ::String,
type: ::String,
loc: T.nilable(::RBI::Loc),
comments: T::Array[::RBI::Comment],
block: T.nilable(T.proc.params(node: ::RBI::SigParam).void)
).void
end
def initialize(name, type, loc: T.unsafe(nil), comments: T.unsafe(nil), &block); end
# source://rbi//lib/rbi/model.rb#1201
2022-03-04 18:14:44 +00:00
sig { params(other: ::Object).returns(T::Boolean) }
def ==(other); end
# source://rbi//lib/rbi/model.rb#1182
2022-03-04 18:14:44 +00:00
sig { returns(::String) }
def name; end
2023-12-14 15:34:15 +00:00
# @return [String]
#
# source://rbi//lib/rbi/model.rb#1182
2022-03-04 18:14:44 +00:00
def type; end
end
# source://rbi//lib/rbi/model.rb#253
2022-03-04 18:14:44 +00:00
class RBI::SingletonClass < ::RBI::Scope
# source://rbi//lib/rbi/model.rb#263
2022-03-04 18:14:44 +00:00
sig do
params(
loc: T.nilable(::RBI::Loc),
comments: T::Array[::RBI::Comment],
block: T.nilable(T.proc.params(node: ::RBI::SingletonClass).void)
).void
end
def initialize(loc: T.unsafe(nil), comments: T.unsafe(nil), &block); end
# source://rbi//lib/rbi/model.rb#269
2022-03-04 18:14:44 +00:00
sig { override.returns(::String) }
def fully_qualified_name; end
end
# source://rbi//lib/rbi/model.rb#274
2022-03-04 18:14:44 +00:00
class RBI::Struct < ::RBI::Scope
# source://rbi//lib/rbi/model.rb#296
2022-03-04 18:14:44 +00:00
sig do
params(
name: ::String,
members: T::Array[::Symbol],
keyword_init: T::Boolean,
loc: T.nilable(::RBI::Loc),
comments: T::Array[::RBI::Comment],
block: T.nilable(T.proc.params(struct: ::RBI::Struct).void)
).void
end
def initialize(name, members: T.unsafe(nil), keyword_init: T.unsafe(nil), loc: T.unsafe(nil), comments: T.unsafe(nil), &block); end
# source://rbi//lib/rbi/rewriters/merge_trees.rb#396
2022-03-04 18:14:44 +00:00
sig { override.params(other: ::RBI::Node).returns(T::Boolean) }
def compatible_with?(other); end
# source://rbi//lib/rbi/model.rb#305
2022-03-04 18:14:44 +00:00
sig { override.returns(::String) }
def fully_qualified_name; end
# source://rbi//lib/rbi/model.rb#284
2022-03-04 18:14:44 +00:00
sig { returns(T::Boolean) }
def keyword_init; end
2023-12-14 15:34:15 +00:00
# @return [Boolean]
#
# source://rbi//lib/rbi/model.rb#284
2022-03-04 18:14:44 +00:00
def keyword_init=(_arg0); end
# source://rbi//lib/rbi/model.rb#281
2022-03-04 18:14:44 +00:00
sig { returns(T::Array[::Symbol]) }
def members; end
2023-12-14 15:34:15 +00:00
# @return [Array<Symbol>]
#
# source://rbi//lib/rbi/model.rb#281
2022-03-04 18:14:44 +00:00
def members=(_arg0); end
# source://rbi//lib/rbi/model.rb#278
2022-03-04 18:14:44 +00:00
sig { returns(::String) }
def name; end
2023-12-14 15:34:15 +00:00
# @return [String]
#
# source://rbi//lib/rbi/model.rb#278
2022-03-04 18:14:44 +00:00
def name=(_arg0); end
end
2023-12-14 15:34:15 +00:00
# Sorbet's T::Enum
#
# source://rbi//lib/rbi/model.rb#1319
2022-03-04 18:14:44 +00:00
class RBI::TEnum < ::RBI::Class
# source://rbi//lib/rbi/model.rb#1330
2022-03-04 18:14:44 +00:00
sig do
params(
name: ::String,
loc: T.nilable(::RBI::Loc),
comments: T::Array[::RBI::Comment],
block: T.nilable(T.proc.params(klass: ::RBI::TEnum).void)
).void
end
def initialize(name, loc: T.unsafe(nil), comments: T.unsafe(nil), &block); end
end
# source://rbi//lib/rbi/model.rb#1336
2022-03-04 18:14:44 +00:00
class RBI::TEnumBlock < ::RBI::NodeWithComments
include ::RBI::Indexable
# source://rbi//lib/rbi/model.rb#1350
2022-03-04 18:14:44 +00:00
sig do
params(
names: T::Array[::String],
loc: T.nilable(::RBI::Loc),
comments: T::Array[::RBI::Comment],
block: T.nilable(T.proc.params(node: ::RBI::TEnumBlock).void)
).void
end
def initialize(names = T.unsafe(nil), loc: T.unsafe(nil), comments: T.unsafe(nil), &block); end
# source://rbi//lib/rbi/model.rb#1362
2022-03-04 18:14:44 +00:00
sig { params(name: ::String).void }
def <<(name); end
# source://rbi//lib/rbi/model.rb#1357
2022-03-04 18:14:44 +00:00
sig { returns(T::Boolean) }
def empty?; end
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/index.rb#223
2022-03-04 18:14:44 +00:00
sig { override.returns(T::Array[::String]) }
def index_ids; end
# source://rbi//lib/rbi/rewriters/merge_trees.rb#558
2022-03-04 18:14:44 +00:00
sig { override.params(other: ::RBI::Node).void }
def merge_with(other); end
# source://rbi//lib/rbi/model.rb#1340
2022-03-04 18:14:44 +00:00
sig { returns(T::Array[::String]) }
def names; end
# source://rbi//lib/rbi/model.rb#1367
2022-03-04 18:14:44 +00:00
sig { override.returns(::String) }
def to_s; end
end
2023-12-14 15:34:15 +00:00
# Sorbet's T::Struct
#
# source://rbi//lib/rbi/model.rb#1208
2022-03-04 18:14:44 +00:00
class RBI::TStruct < ::RBI::Class
# source://rbi//lib/rbi/model.rb#1219
2022-03-04 18:14:44 +00:00
sig do
params(
name: ::String,
loc: T.nilable(::RBI::Loc),
comments: T::Array[::RBI::Comment],
block: T.nilable(T.proc.params(klass: ::RBI::TStruct).void)
).void
end
def initialize(name, loc: T.unsafe(nil), comments: T.unsafe(nil), &block); end
end
# source://rbi//lib/rbi/model.rb#1257
2022-03-04 18:14:44 +00:00
class RBI::TStructConst < ::RBI::TStructField
include ::RBI::Indexable
# source://rbi//lib/rbi/model.rb#1270
2022-03-04 18:14:44 +00:00
sig do
params(
name: ::String,
type: ::String,
default: T.nilable(::String),
loc: T.nilable(::RBI::Loc),
comments: T::Array[::RBI::Comment],
block: T.nilable(T.proc.params(node: ::RBI::TStructConst).void)
).void
end
def initialize(name, type, default: T.unsafe(nil), loc: T.unsafe(nil), comments: T.unsafe(nil), &block); end
# source://rbi//lib/rbi/rewriters/merge_trees.rb#549
2022-03-04 18:14:44 +00:00
sig { override.params(other: ::RBI::Node).returns(T::Boolean) }
def compatible_with?(other); end
# source://rbi//lib/rbi/model.rb#1276
2022-03-04 18:14:44 +00:00
sig { override.returns(T::Array[::String]) }
def fully_qualified_names; end
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/index.rb#203
2022-03-04 18:14:44 +00:00
sig { override.returns(T::Array[::String]) }
def index_ids; end
# source://rbi//lib/rbi/model.rb#1282
2022-03-04 18:14:44 +00:00
sig { override.returns(::String) }
def to_s; end
end
2023-12-14 15:34:15 +00:00
# @abstract It cannot be directly instantiated. Subclasses must implement the `abstract` methods below.
#
# source://rbi//lib/rbi/model.rb#1225
2022-03-04 18:14:44 +00:00
class RBI::TStructField < ::RBI::NodeWithComments
abstract!
# source://rbi//lib/rbi/model.rb#1246
2022-03-04 18:14:44 +00:00
sig do
params(
name: ::String,
type: ::String,
default: T.nilable(::String),
loc: T.nilable(::RBI::Loc),
comments: T::Array[::RBI::Comment]
).void
end
def initialize(name, type, default: T.unsafe(nil), loc: T.unsafe(nil), comments: T.unsafe(nil)); end
# source://rbi//lib/rbi/rewriters/merge_trees.rb#540
2022-03-04 18:14:44 +00:00
sig { override.params(other: ::RBI::Node).returns(T::Boolean) }
def compatible_with?(other); end
# source://rbi//lib/rbi/model.rb#1235
2022-03-04 18:14:44 +00:00
sig { returns(T.nilable(::String)) }
def default; end
2023-12-14 15:34:15 +00:00
# @return [String, nil]
#
# source://rbi//lib/rbi/model.rb#1235
2022-03-04 18:14:44 +00:00
def default=(_arg0); end
2023-12-14 15:34:15 +00:00
# @abstract
#
# source://rbi//lib/rbi/model.rb#1254
2022-03-04 18:14:44 +00:00
sig { abstract.returns(T::Array[::String]) }
def fully_qualified_names; end
# source://rbi//lib/rbi/model.rb#1232
2022-03-04 18:14:44 +00:00
sig { returns(::String) }
def name; end
2023-12-14 15:34:15 +00:00
# @return [String]
#
# source://rbi//lib/rbi/model.rb#1232
2022-03-04 18:14:44 +00:00
def name=(_arg0); end
2023-12-14 15:34:15 +00:00
# @return [String]
#
# source://rbi//lib/rbi/model.rb#1232
2022-03-04 18:14:44 +00:00
def type; end
2023-12-14 15:34:15 +00:00
# @return [String]
#
# source://rbi//lib/rbi/model.rb#1232
2022-03-04 18:14:44 +00:00
def type=(_arg0); end
end
# source://rbi//lib/rbi/model.rb#1287
2022-03-04 18:14:44 +00:00
class RBI::TStructProp < ::RBI::TStructField
include ::RBI::Indexable
# source://rbi//lib/rbi/model.rb#1300
2022-03-04 18:14:44 +00:00
sig do
params(
name: ::String,
type: ::String,
default: T.nilable(::String),
loc: T.nilable(::RBI::Loc),
comments: T::Array[::RBI::Comment],
block: T.nilable(T.proc.params(node: ::RBI::TStructProp).void)
).void
end
def initialize(name, type, default: T.unsafe(nil), loc: T.unsafe(nil), comments: T.unsafe(nil), &block); end
# source://rbi//lib/rbi/rewriters/merge_trees.rb#572
2022-03-04 18:14:44 +00:00
sig { override.params(other: ::RBI::Node).returns(T::Boolean) }
def compatible_with?(other); end
# source://rbi//lib/rbi/model.rb#1306
2022-03-04 18:14:44 +00:00
sig { override.returns(T::Array[::String]) }
def fully_qualified_names; end
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/index.rb#213
2022-03-04 18:14:44 +00:00
sig { override.returns(T::Array[::String]) }
def index_ids; end
# source://rbi//lib/rbi/model.rb#1312
2022-03-04 18:14:44 +00:00
sig { override.returns(::String) }
def to_s; end
end
# source://rbi//lib/rbi/model.rb#108
2022-03-04 18:14:44 +00:00
class RBI::Tree < ::RBI::NodeWithComments
# source://rbi//lib/rbi/model.rb#121
2022-03-04 18:14:44 +00:00
sig do
params(
loc: T.nilable(::RBI::Loc),
comments: T::Array[::RBI::Comment],
block: T.nilable(T.proc.params(node: ::RBI::Tree).void)
).void
end
def initialize(loc: T.unsafe(nil), comments: T.unsafe(nil), &block); end
# source://rbi//lib/rbi/model.rb#128
2022-03-04 18:14:44 +00:00
sig { params(node: ::RBI::Node).void }
def <<(node); end
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/rewriters/add_sig_templates.rb#66
2022-03-04 18:14:44 +00:00
sig { params(with_todo_comment: T::Boolean).void }
def add_sig_templates!(with_todo_comment: T.unsafe(nil)); end
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/rewriters/annotate.rb#49
2022-03-04 18:14:44 +00:00
sig { params(annotation: ::String, annotate_scopes: T::Boolean, annotate_properties: T::Boolean).void }
def annotate!(annotation, annotate_scopes: T.unsafe(nil), annotate_properties: T.unsafe(nil)); end
# source://tapioca/0.15.1/lib/tapioca/rbi_ext/model.rb#38
2022-03-04 18:14:44 +00:00
sig do
params(
name: ::String,
superclass_name: T.nilable(::String),
block: T.nilable(T.proc.params(scope: ::RBI::Scope).void)
).returns(::RBI::Scope)
end
def create_class(name, superclass_name: T.unsafe(nil), &block); end
# source://tapioca/0.15.1/lib/tapioca/rbi_ext/model.rb#45
2022-03-04 18:14:44 +00:00
sig { params(name: ::String, value: ::String).void }
def create_constant(name, value:); end
# source://tapioca/0.15.1/lib/tapioca/rbi_ext/model.rb#55
2022-03-04 18:14:44 +00:00
sig { params(name: ::String).void }
def create_extend(name); end
# source://tapioca/0.15.1/lib/tapioca/rbi_ext/model.rb#50
2022-03-04 18:14:44 +00:00
sig { params(name: ::String).void }
def create_include(name); end
# source://tapioca/0.15.1/lib/tapioca/rbi_ext/model.rb#89
2022-03-04 18:14:44 +00:00
sig do
params(
name: ::String,
parameters: T::Array[::RBI::TypedParam],
return_type: ::String,
class_method: T::Boolean,
2023-12-14 15:34:15 +00:00
visibility: ::RBI::Visibility,
comments: T::Array[::RBI::Comment]
2022-03-04 18:14:44 +00:00
).void
end
2023-12-14 15:34:15 +00:00
def create_method(name, parameters: T.unsafe(nil), return_type: T.unsafe(nil), class_method: T.unsafe(nil), visibility: T.unsafe(nil), comments: T.unsafe(nil)); end
2022-03-04 18:14:44 +00:00
# source://tapioca/0.15.1/lib/tapioca/rbi_ext/model.rb#113
sig do
params(
name: ::String,
sigs: T::Array[::RBI::Sig],
parameters: T::Array[::RBI::Param],
class_method: T::Boolean,
visibility: ::RBI::Visibility,
comments: T::Array[::RBI::Comment]
).void
end
def create_method_with_sigs(name, sigs:, parameters: T.unsafe(nil), class_method: T.unsafe(nil), visibility: T.unsafe(nil), comments: T.unsafe(nil)); end
# source://tapioca/0.15.1/lib/tapioca/rbi_ext/model.rb#60
2022-03-04 18:14:44 +00:00
sig { params(name: ::String).void }
def create_mixes_in_class_methods(name); end
# source://tapioca/0.15.1/lib/tapioca/rbi_ext/model.rb#25
2022-03-04 18:14:44 +00:00
sig { params(name: ::String, block: T.nilable(T.proc.params(scope: ::RBI::Scope).void)).returns(::RBI::Scope) }
def create_module(name, &block); end
# source://tapioca/0.15.1/lib/tapioca/rbi_ext/model.rb#9
2023-12-14 15:34:15 +00:00
sig { params(constant: ::Module, block: T.nilable(T.proc.params(scope: ::RBI::Scope).void)).returns(::RBI::Scope) }
2022-03-04 18:14:44 +00:00
def create_path(constant, &block); end
# source://tapioca/0.15.1/lib/tapioca/rbi_ext/model.rb#135
sig do
params(
parameters: T::Hash[T.any(::String, ::Symbol), ::String],
type_parameters: T::Array[::String],
return_type: ::String
).returns(::RBI::Sig)
end
def create_sig(parameters:, type_parameters: T.unsafe(nil), return_type: T.unsafe(nil)); end
# source://tapioca/0.15.1/lib/tapioca/rbi_ext/model.rb#74
sig do
params(
name: ::String,
type: ::String,
variance: ::Symbol,
fixed: T.nilable(::String),
upper: T.nilable(::String),
lower: T.nilable(::String)
).void
end
def create_type_variable(name, type:, variance: T.unsafe(nil), fixed: T.unsafe(nil), upper: T.unsafe(nil), lower: T.unsafe(nil)); end
2022-03-04 18:14:44 +00:00
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/rewriters/deannotate.rb#41
2022-03-04 18:14:44 +00:00
sig { params(annotation: ::String).void }
def deannotate!(annotation); end
# source://rbi//lib/rbi/model.rb#134
2022-03-04 18:14:44 +00:00
sig { returns(T::Boolean) }
def empty?; end
# source://rbi//lib/rbi/rewriters/filter_versions.rb#118
sig { params(version: ::Gem::Version).void }
def filter_versions!(version); end
# source://rbi//lib/rbi/rewriters/group_nodes.rb#81
2022-03-04 18:14:44 +00:00
sig { void }
def group_nodes!; end
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/index.rb#68
2022-03-04 18:14:44 +00:00
sig { returns(::RBI::Index) }
def index; end
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/rewriters/merge_trees.rb#324
2022-03-04 18:14:44 +00:00
sig do
params(
other: ::RBI::Tree,
left_name: ::String,
right_name: ::String,
keep: ::RBI::Rewriters::Merge::Keep
).returns(::RBI::MergeTree)
end
def merge(other, left_name: T.unsafe(nil), right_name: T.unsafe(nil), keep: T.unsafe(nil)); end
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/rewriters/nest_non_public_methods.rb#46
2022-03-04 18:14:44 +00:00
sig { void }
def nest_non_public_methods!; end
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/rewriters/nest_singleton_methods.rb#36
2022-03-04 18:14:44 +00:00
sig { void }
def nest_singleton_methods!; end
# source://rbi//lib/rbi/model.rb#112
2022-03-04 18:14:44 +00:00
sig { returns(T::Array[::RBI::Node]) }
def nodes; end
# source://rbi//lib/rbi/rewriters/attr_to_methods.rb#53
sig { void }
def replace_attributes_with_methods!; end
2022-03-04 18:14:44 +00:00
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/rewriters/sort_nodes.rb#119
2022-03-04 18:14:44 +00:00
sig { void }
def sort_nodes!; end
private
# source://tapioca/0.15.1/lib/tapioca/rbi_ext/model.rb#150
2022-03-04 18:14:44 +00:00
sig { params(node: ::RBI::Node).returns(::RBI::Node) }
def create_node(node); end
# source://tapioca/0.15.1/lib/tapioca/rbi_ext/model.rb#145
2022-03-04 18:14:44 +00:00
sig { returns(T::Hash[::String, ::RBI::Node]) }
def nodes_cache; end
end
# source://rbi//lib/rbi/model.rb#1400
2022-03-04 18:14:44 +00:00
class RBI::TypeMember < ::RBI::NodeWithComments
2023-12-14 15:34:15 +00:00
include ::RBI::Indexable
# source://rbi//lib/rbi/model.rb#1415
2022-03-04 18:14:44 +00:00
sig do
params(
name: ::String,
value: ::String,
loc: T.nilable(::RBI::Loc),
comments: T::Array[::RBI::Comment],
block: T.nilable(T.proc.params(node: ::RBI::TypeMember).void)
).void
end
def initialize(name, value, loc: T.unsafe(nil), comments: T.unsafe(nil), &block); end
# source://rbi//lib/rbi/model.rb#1423
2022-03-04 18:14:44 +00:00
sig { returns(::String) }
def fully_qualified_name; end
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/index.rb#183
sig { override.returns(T::Array[::String]) }
def index_ids; end
# source://rbi//lib/rbi/model.rb#1404
2022-03-04 18:14:44 +00:00
sig { returns(::String) }
def name; end
# source://rbi//lib/rbi/model.rb#1430
2022-03-04 18:14:44 +00:00
sig { override.returns(::String) }
def to_s; end
2023-12-14 15:34:15 +00:00
# @return [String]
#
# source://rbi//lib/rbi/model.rb#1404
2022-03-04 18:14:44 +00:00
def value; end
end
# source://rbi//lib/rbi/rewriters/attr_to_methods.rb#5
class RBI::UnexpectedMultipleSigsError < ::RBI::Error
# source://rbi//lib/rbi/rewriters/attr_to_methods.rb#10
sig { params(node: ::RBI::Node).void }
def initialize(node); end
# source://rbi//lib/rbi/rewriters/attr_to_methods.rb#7
sig { returns(::RBI::Node) }
def node; end
end
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/parser.rb#20
class RBI::UnexpectedParserError < ::RBI::Error
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/parser.rb#27
2022-03-15 18:11:17 +00:00
sig { params(parent_exception: ::Exception, last_location: ::RBI::Loc).void }
def initialize(parent_exception, last_location); end
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/parser.rb#24
2022-03-15 18:11:17 +00:00
sig { returns(::RBI::Loc) }
def last_location; end
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/parser.rb#34
2022-03-15 18:11:17 +00:00
sig { params(io: T.any(::IO, ::StringIO)).void }
def print_debug(io: T.unsafe(nil)); end
end
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/version.rb#5
2022-03-04 18:14:44 +00:00
RBI::VERSION = T.let(T.unsafe(nil), String)
2023-12-14 15:34:15 +00:00
# Visibility
#
# @abstract It cannot be directly instantiated. Subclasses must implement the `abstract` methods below.
#
# source://rbi//lib/rbi/model.rb#916
2022-03-04 18:14:44 +00:00
class RBI::Visibility < ::RBI::NodeWithComments
abstract!
# source://rbi//lib/rbi/model.rb#926
2022-03-04 18:14:44 +00:00
sig { params(visibility: ::Symbol, loc: T.nilable(::RBI::Loc), comments: T::Array[::RBI::Comment]).void }
def initialize(visibility, loc: T.unsafe(nil), comments: T.unsafe(nil)); end
# source://rbi//lib/rbi/model.rb#932
2022-03-04 18:14:44 +00:00
sig { params(other: ::RBI::Visibility).returns(T::Boolean) }
def ==(other); end
# source://rbi//lib/rbi/model.rb#947
2022-03-04 18:14:44 +00:00
sig { returns(T::Boolean) }
def private?; end
# source://rbi//lib/rbi/model.rb#942
2022-03-04 18:14:44 +00:00
sig { returns(T::Boolean) }
def protected?; end
# source://rbi//lib/rbi/model.rb#937
2022-03-04 18:14:44 +00:00
sig { returns(T::Boolean) }
def public?; end
# source://rbi//lib/rbi/model.rb#923
2022-03-04 18:14:44 +00:00
sig { returns(::Symbol) }
def visibility; end
end
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/rewriters/nest_non_public_methods.rb#52
2022-03-04 18:14:44 +00:00
class RBI::VisibilityGroup < ::RBI::Tree
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/rewriters/nest_non_public_methods.rb#59
2022-03-04 18:14:44 +00:00
sig { params(visibility: ::RBI::Visibility).void }
def initialize(visibility); end
2023-12-14 15:34:15 +00:00
# source://rbi//lib/rbi/rewriters/nest_non_public_methods.rb#56
2022-03-04 18:14:44 +00:00
sig { returns(::RBI::Visibility) }
def visibility; end
end
2023-12-14 15:34:15 +00:00
# @abstract It cannot be directly instantiated. Subclasses must implement the `abstract` methods below.
#
# source://rbi//lib/rbi/visitor.rb#7
2022-03-04 18:14:44 +00:00
class RBI::Visitor
abstract!
# source://rbi//lib/rbi/visitor.rb#14
sig { params(node: T.nilable(::RBI::Node)).void }
2022-03-04 18:14:44 +00:00
def visit(node); end
# source://rbi//lib/rbi/visitor.rb#108
2022-03-04 18:14:44 +00:00
sig { params(nodes: T::Array[::RBI::Node]).void }
def visit_all(nodes); end
# source://rbi//lib/rbi/visitor.rb#113
sig { params(file: ::RBI::File).void }
def visit_file(file); end
private
# source://rbi//lib/rbi/visitor.rb#195
sig { params(node: ::RBI::Arg).void }
def visit_arg(node); end
# source://rbi//lib/rbi/visitor.rb#144
sig { params(node: ::RBI::AttrAccessor).void }
def visit_attr_accessor(node); end
# source://rbi//lib/rbi/visitor.rb#147
sig { params(node: ::RBI::AttrReader).void }
def visit_attr_reader(node); end
# source://rbi//lib/rbi/visitor.rb#150
sig { params(node: ::RBI::AttrWriter).void }
def visit_attr_writer(node); end
# source://rbi//lib/rbi/visitor.rb#123
sig { params(node: ::RBI::BlankLine).void }
def visit_blank_line(node); end
# source://rbi//lib/rbi/visitor.rb#174
sig { params(node: ::RBI::BlockParam).void }
def visit_block_param(node); end
# source://rbi//lib/rbi/visitor.rb#129
sig { params(node: ::RBI::Class).void }
def visit_class(node); end
# source://rbi//lib/rbi/visitor.rb#120
sig { params(node: ::RBI::Comment).void }
def visit_comment(node); end
# source://rbi//lib/rbi/visitor.rb#240
sig { params(node: ::RBI::ConflictTree).void }
def visit_conflict_tree(node); end
# source://rbi//lib/rbi/visitor.rb#141
sig { params(node: ::RBI::Const).void }
def visit_const(node); end
# source://rbi//lib/rbi/visitor.rb#180
sig { params(node: ::RBI::Extend).void }
def visit_extend(node); end
# source://rbi//lib/rbi/visitor.rb#234
sig { params(node: ::RBI::Group).void }
def visit_group(node); end
# source://rbi//lib/rbi/visitor.rb#222
sig { params(node: ::RBI::Helper).void }
def visit_helper(node); end
# source://rbi//lib/rbi/visitor.rb#177
sig { params(node: ::RBI::Include).void }
def visit_include(node); end
# source://rbi//lib/rbi/visitor.rb#198
sig { params(node: ::RBI::KwArg).void }
def visit_kw_arg(node); end
# source://rbi//lib/rbi/visitor.rb#168
sig { params(node: ::RBI::KwOptParam).void }
def visit_kw_opt_param(node); end
# source://rbi//lib/rbi/visitor.rb#165
sig { params(node: ::RBI::KwParam).void }
def visit_kw_param(node); end
# source://rbi//lib/rbi/visitor.rb#171
sig { params(node: ::RBI::KwRestParam).void }
def visit_kw_rest_param(node); end
# source://rbi//lib/rbi/visitor.rb#153
sig { params(node: ::RBI::Method).void }
def visit_method(node); end
# source://rbi//lib/rbi/visitor.rb#228
sig { params(node: ::RBI::MixesInClassMethods).void }
def visit_mixes_in_class_methods(node); end
# source://rbi//lib/rbi/visitor.rb#126
sig { params(node: ::RBI::Module).void }
def visit_module(node); end
# source://rbi//lib/rbi/visitor.rb#159
sig { params(node: ::RBI::OptParam).void }
def visit_opt_param(node); end
# source://rbi//lib/rbi/visitor.rb#189
sig { params(node: ::RBI::Private).void }
def visit_private(node); end
# source://rbi//lib/rbi/visitor.rb#186
sig { params(node: ::RBI::Protected).void }
def visit_protected(node); end
# source://rbi//lib/rbi/visitor.rb#183
sig { params(node: ::RBI::Public).void }
def visit_public(node); end
# source://rbi//lib/rbi/visitor.rb#156
sig { params(node: ::RBI::ReqParam).void }
def visit_req_param(node); end
# source://rbi//lib/rbi/visitor.rb#231
sig { params(node: ::RBI::RequiresAncestor).void }
def visit_requires_ancestor(node); end
# source://rbi//lib/rbi/visitor.rb#162
sig { params(node: ::RBI::RestParam).void }
def visit_rest_param(node); end
# source://rbi//lib/rbi/visitor.rb#243
sig { params(node: ::RBI::ScopeConflict).void }
def visit_scope_conflict(node); end
# source://rbi//lib/rbi/visitor.rb#192
sig { params(node: ::RBI::Send).void }
def visit_send(node); end
# source://rbi//lib/rbi/visitor.rb#201
sig { params(node: ::RBI::Sig).void }
def visit_sig(node); end
# source://rbi//lib/rbi/visitor.rb#204
sig { params(node: ::RBI::SigParam).void }
def visit_sig_param(node); end
# source://rbi//lib/rbi/visitor.rb#132
sig { params(node: ::RBI::SingletonClass).void }
def visit_singleton_class(node); end
# source://rbi//lib/rbi/visitor.rb#135
sig { params(node: ::RBI::Struct).void }
def visit_struct(node); end
# source://rbi//lib/rbi/visitor.rb#216
sig { params(node: ::RBI::TEnum).void }
def visit_tenum(node); end
# source://rbi//lib/rbi/visitor.rb#219
sig { params(node: ::RBI::TEnumBlock).void }
def visit_tenum_block(node); end
# source://rbi//lib/rbi/visitor.rb#138
sig { params(node: ::RBI::Tree).void }
def visit_tree(node); end
# source://rbi//lib/rbi/visitor.rb#207
sig { params(node: ::RBI::TStruct).void }
def visit_tstruct(node); end
# source://rbi//lib/rbi/visitor.rb#210
sig { params(node: ::RBI::TStructConst).void }
def visit_tstruct_const(node); end
# source://rbi//lib/rbi/visitor.rb#213
sig { params(node: ::RBI::TStructProp).void }
def visit_tstruct_prop(node); end
# source://rbi//lib/rbi/visitor.rb#225
sig { params(node: ::RBI::TypeMember).void }
def visit_type_member(node); end
# source://rbi//lib/rbi/visitor.rb#237
sig { params(node: ::RBI::VisibilityGroup).void }
def visit_visibility_group(node); end
2022-03-04 18:14:44 +00:00
end
# source://rbi//lib/rbi/visitor.rb#5
class RBI::VisitorError < ::RBI::Error; end