SWAMPy

✎ CARVE FLESH

EDITING: location.rbs

module RBS
  # Location is the range on buffer, `start_pos..end_pos`.
  # The index is based on characters.
  #
  # A location can have _child_ locations.
  #
  class Location[in RequiredChildKeys, in OptionalChildKeys]
    # The buffer this location points on.
    attr_reader buffer (): Buffer

# The index of character the range starts from.
    attr_reader start_pos (): Integer

# The index of character the range ends at.
    attr_reader end_pos (): Integer

def initialize: (Buffer, Integer start_pos, Integer end_pos) -> void

def self.new: (Buffer, Integer start_pos, Integer end_pos) -> instance
                | (buffer: Buffer, start_pos: Integer, end_pos: Integer) -> instance

def inspect: () -> String

# Returns the name of the buffer.
    def name: () -> untyped

# Line of the `start_pos` (1 origin)
    attr_reader start_line (): Integer

# Column of the `start_pos` (0 origin)
    attr_reader start_column (): Integer

# Line of the `end_pos` (1 origin)
    attr_reader end_line (): Integer

# Column of the `end_pos` (0 origin)
    attr_reader end_column (): Integer

attr_reader start_loc (): Buffer::loc

@start_loc: Buffer::loc?

attr_reader end_loc (): Buffer::loc

@end_loc: Buffer::loc?

attr_reader range (): Range[Integer]

@range: Range[Integer]?

# A substring of buffer associated to the location.
    def source: () -> String

@source: String?

def to_s: () -> String

# Returns a string representation suitable for terminal output.
    #
    #     Location.to_string(loc)  # => a.rb:1:0...3:4
    #     Location.to_string(nil)  # => *:*:*..*:*
    #
    def self.to_string: (Location[untyped, untyped]? location, ?default: ::String default) -> String

def ==: (untyped other) -> bool

include _ToJson

def add_optional_child: (OptionalChildKeys name, Range[Integer]? range) -> void

def add_required_child: (RequiredChildKeys name, Range[Integer] range) -> void

# Returns `Location` instance for given _child_ name.
    #
    #     # @type var loc: Location::WithChildren[:name, :args]
    #     loc[:name]      # => Location
    #     loc[:args]      # => may be nil
    #
    # Note that passing unknown symbol raises an error even if the child is _optional_.
    # You need explicitly set `nil` for absent optional children.
    #
    def []: (RequiredChildKeys) -> Location[bot, bot]
          | (OptionalChildKeys) -> Location[bot, bot]?
          | (Symbol) -> Location[bot, bot]?

alias aref []

def each_optional_key: () { (Symbol) -> void } -> void
                         | () -> Enumerator[Symbol, void]

def each_required_key: () { (Symbol) -> void } -> void
                         | () -> Enumerator[Symbol, void]

def optional_key?: (Symbol) -> bool

def required_key?: (Symbol) -> bool

def key?: (Symbol) -> bool

private

def _start_loc: () -> Buffer::loc?
    def _end_loc: () -> Buffer::loc?

def _add_required_child: (RequiredChildKeys name, Integer start_pos, Integer end_pos) -> void
    def _add_optional_child: (OptionalChildKeys name, Integer start_pos, Integer end_pos) -> void
    def _add_optional_no_child: (OptionalChildKeys name) -> void
    def _optional_keys: () -> Array[Symbol]
    def _required_keys: () -> Array[Symbol]

WithChildren: singleton(Location)
  end
end

CANCEL

Name	Type	Size	Modified	Actions
↩ ..	DIR	—	—
📁 annotate/	DIR	—	2026-01-17 03:50
📁 collection/	DIR	—	2026-01-17 03:50
📁 prototype/	DIR	—	2026-01-17 03:50
📁 rdoc/	DIR	—	2026-01-17 03:50
📁 resolver/	DIR	—	2026-01-17 03:50
📁 shims/	DIR	—	2026-01-17 03:50
📄 ancestor_builder.rbs	RBS	7.4 KB	2025-03-26 04:20	EDIT
📄 ancestor_graph.rbs	RBS	1.3 KB	2025-03-26 04:20	EDIT
📄 annotation.rbs	RBS	556 B	2025-03-26 04:20	EDIT
📄 buffer.rbs	RBS	718 B	2025-03-26 04:20	EDIT
📄 builtin_names.rbs	RBS	847 B	2025-03-26 04:20	EDIT
📄 cli.rbs	RBS	2.2 KB	2025-03-26 04:20	EDIT
📄 collection.rbs	RBS	41 B	2025-03-26 04:20	EDIT
📄 comment.rbs	RBS	495 B	2025-03-26 04:20	EDIT
📄 constant.rbs	RBS	502 B	2025-03-26 04:20	EDIT
📄 constant_table.rbs	RBS	1.1 KB	2025-03-26 04:20	EDIT
📄 declarations.rbs	RBS	6.8 KB	2025-03-26 04:20	EDIT
📄 definition.rbs	RBS	5.1 KB	2025-03-26 04:20	EDIT
📄 definition_builder.rbs	RBS	5.5 KB	2025-03-26 04:20	EDIT
📄 environment.rbs	RBS	4.3 KB	2025-03-26 04:20	EDIT
📄 environment_loader.rbs	RBS	3.8 KB	2025-03-26 04:20	EDIT
📄 environment_walker.rbs	RBS	1.8 KB	2025-03-26 04:20	EDIT
📄 errors.rbs	RBS	7.9 KB	2025-03-26 04:20	EDIT
📄 factory.rbs	RBS	77 B	2025-03-26 04:20	EDIT
📄 location.rbs	RBS	3.3 KB	2025-03-26 04:20	EDIT
📄 locator.rbs	RBS	1.6 KB	2025-03-26 04:20	EDIT
📄 manifest.yaml	YAML	148 B	2025-03-26 04:20	EDIT
📄 members.rbs	RBS	7.1 KB	2025-03-26 04:20	EDIT
📄 method_builder.rbs	RBS	3.2 KB	2025-03-26 04:20	EDIT
📄 method_types.rbs	RBS	1.5 KB	2025-03-26 04:20	EDIT
📄 namespace.rbs	RBS	3.5 KB	2025-03-26 04:20	EDIT
📄 parser.rbs	RBS	892 B	2025-03-26 04:20	EDIT
📄 rbs.rbs	RBS	384 B	2025-03-26 04:20	EDIT
📄 repository.rbs	RBS	2.4 KB	2025-03-26 04:20	EDIT
📄 shims.rbs	RBS	1.3 KB	2025-03-26 04:20	EDIT
📄 sorter.rbs	RBS	499 B	2025-03-26 04:20	EDIT
📄 substitution.rbs	RBS	1.4 KB	2025-03-26 04:20	EDIT
📄 type_alias_dependency.rbs	RBS	585 B	2025-03-26 04:20	EDIT
📄 type_alias_regularity.rbs	RBS	2.9 KB	2025-03-26 04:20	EDIT
📄 type_name_resolver.rbs	RBS	618 B	2025-03-26 04:20	EDIT
📄 type_param.rbs	RBS	2.2 KB	2025-03-26 04:20	EDIT
📄 typename.rbs	RBS	2.1 KB	2025-03-26 04:20	EDIT
📄 types.rbs	RBS	11.6 KB	2025-03-26 04:20	EDIT
📄 util.rbs	RBS	128 B	2025-03-26 04:20	EDIT
📄 validator.rbs	RBS	1.9 KB	2025-03-26 04:20	EDIT
📄 variance_calculator.rbs	RBS	2.6 KB	2025-03-26 04:20	EDIT
📄 vendorer.rbs	RBS	1.4 KB	2025-03-26 04:20	EDIT
📄 version.rbs	RBS	33 B	2025-03-26 04:20	EDIT
📄 writer.rbs	RBS	2.9 KB	2025-03-26 04:20	EDIT