Class: Prism::MatchRequiredNode

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain: self, `Node`
Instance Chain: self, `Node`
Inherits:	Prism::Node `::Object` Prism::Node Prism::MatchRequiredNode
Defined in:	lib/prism/node.rb, prism/api_node.c

Overview

Represents the use of the => operator.

foo => bar
^^^^^^^^^^

Class Method Summary

.new(source, node_id, location, flags, value, pattern, operator_loc) ⇒ MatchRequiredNode constructor

Initialize a new MatchRequiredNode node.
.type

Return a symbol representation of this node type.

`Node` - Inherited

.fields	Returns a list of the fields that exist for this node class.
.type	Similar to #type, this method returns a symbol that you can use for splitting on the type of the node without having to do a long === chain.

Instance Attribute Summary

#pattern readonly

Represents the right-hand side of the operator.
#value readonly

Represents the left-hand side of the operator.

`Node` - Inherited

#newline?	Returns true if the node has the newline flag set.
#node_id	A unique identifier for this node.
#static_literal?	Returns true if the node has the static literal flag set.
#flags	An bitset of flags for this node.
#source	A pointer to the source that this node was created from.
#newline_flag?

Instance Method Summary

#===(other)

Implements case-equality for the node.
#accept(visitor)

def accept: (Visitor visitor) -> void.
#child_nodes (also: #deconstruct)

def child_nodes: () -> Array.
#comment_targets

def comment_targets: () -> Array[Node | Location].
#compact_child_nodes

def compact_child_nodes: () -> Array.
#copy(node_id: self.node_id, location: self.location, flags: self.flags, value: self.value, pattern: self.pattern, operator_loc: self.operator_loc)

def copy: (?node_id: Integer, ?location: Location, ?flags: Integer, ?value: Prism.node, ?pattern: Prism.node, ?operator_loc: Location) -> MatchRequiredNode.
#deconstruct

Alias for #child_nodes.
#deconstruct_keys(keys)

def deconstruct_keys: (Array keys) -> { node_id: Integer, location: Location, value: Prism.node, pattern: Prism.node, operator_loc: Location }
#each_child_node {|value| ... }

def each_child_node: () { (Prism::node) -> void } -> void | () -> Enumerator.
#inspect

def inspect -> String.
#operator

def operator: () -> String.
#operator_loc

The location of the operator.
#save_operator_loc(repository)

Save the operator_loc location using the given saved source so that it can be retrieved later.
#type

Return a symbol representation of this node type.

`Node` - Inherited

#accept	Accepts a visitor and calls back into the specialized visit function.
#breadth_first_search	Returns the first node that matches the given block when visited in a depth-first search.
#cached_end_code_units_column	Delegates to the cached_end_code_units_column of the associated location object.
#cached_end_code_units_offset	Delegates to the cached_end_code_units_offset of the associated location object.
#cached_start_code_units_column	Delegates to the cached_start_code_units_column of the associated location object.
#cached_start_code_units_offset	Delegates to the cached_start_code_units_offset of the associated location object.
#child_nodes	Returns an array of child nodes, including `nil`s in the place of optional nodes that were not present.
#comment_targets	Returns an array of child nodes and locations that could potentially have comments attached to them.
#comments	Delegates to the comments of the associated location object.
#compact_child_nodes	Returns an array of child nodes, excluding any `nil`s in the place of optional nodes that were not present.
#deconstruct	Alias for Node#child_nodes.
#each_child_node	With a block given, yields each child node.
#end_character_column	Delegates to the end_character_column of the associated location object.
#end_character_offset	Delegates to the end_character_offset of the associated location object.
#end_column	Delegates to the end_column of the associated location object.
#end_line	Delegates to the end_line of the associated location object.
#end_offset	The end offset of the node in the source.
#inspect	Returns a string representation of the node.
#leading_comments	Delegates to the leading_comments of the associated location object.
#location	A Location instance that represents the location of this node in the source.
#pretty_print	Similar to inspect, but respects the current level of indentation given by the pretty print object.
#save	Save this node using a saved source so that it can be retrieved later.
#save_location	Save the location using a saved source so that it can be retrieved later.
#script_lines	Alias for Node#source_lines.
#slice	Slice the location of the node from the source.
#slice_lines	Slice the location of the node from the source, starting at the beginning of the line that the location starts on, ending at the end of the line that the location ends on.
#source_lines	Returns all of the lines of the source code associated with this node.
#start_character_column	Delegates to the start_character_column of the associated location object.
#start_character_offset	Delegates to the start_character_offset of the associated location object.
#start_column	Delegates to the start_column of the associated location object.
#start_line	Delegates to the start_line of the associated location object.
#start_offset	The start offset of the node in the source.
#to_dot	Convert this node into a graphviz dot graph string.
#trailing_comments	Delegates to the trailing_comments of the associated location object.
#tunnel	Returns a list of nodes that are descendants of this node that contain the given line and column.
#type	Sometimes you want to check an instance of a node against a list of classes to see what kind of behavior to perform.
#deprecated, #newline_flag!

Constructor Details

.new(source, node_id, location, flags, value, pattern, operator_loc) ⇒ `MatchRequiredNode`

Initialize a new MatchRequiredNode node.

[ GitHub ]

# File 'lib/prism/node.rb', line 13508


def initialize(source, node_id, location, flags, value, pattern, operator_loc)
  @source = source
  @node_id = node_id
  @location = location
  @flags = flags
  @value = value
  @pattern = pattern
  @operator_loc = operator_loc
end

Class Method Details

.type

Return a symbol representation of this node type. See Node::type.

[ GitHub ]

# File 'lib/prism/node.rb', line 13642


def self.type
  :match_required_node
end

Instance Attribute Details

#pattern (readonly)

Represents the right-hand side of the operator. The type of the node depends on the expression.

Anything that looks like a local variable name (including _) will result in a LocalVariableTargetNode.

foo => a # This is equivalent to writing `a = foo`
       ^

Using an explicit Array or combining expressions with , will result in a ArrayPatternNode. This can be preceded by a constant.

foo => [a]
       ^^^

foo => a, b
       ^^^^

foo => Bar[a, b]
       ^^^^^^^^^

If the array pattern contains at least two wildcard matches, a FindPatternNode is created instead.

foo => *, 1, *a
       ^^^^^

Using an explicit Hash or a constant with square brackets and hash keys in the square brackets will result in a HashPatternNode.

foo => { a: 1, b: }

foo => Bar[a: 1, b:]

foo => Bar[**]

To use any variable that needs run time evaluation, pinning is required. This results in a PinnedVariableNode

foo => ^a
       ^^

Similar, any expression can be used with pinning. This results in a PinnedExpressionNode.

foo => ^(a + 1)

Anything else will result in the regular node for that expression, for example a ConstantReadNode.

foo => CONST

[ GitHub ]

# File 'lib/prism/node.rb', line 13608


attr_reader :pattern

#value (readonly)

Represents the left-hand side of the operator.

foo => bar
^^^

[ GitHub ]

# File 'lib/prism/node.rb', line 13563


attr_reader :value

Instance Method Details

#===(other)

Implements case-equality for the node. This is effectively == but without comparing the value of locations. Locations are checked only for presence.

[ GitHub ]

# File 'lib/prism/node.rb', line 13648


def ===(other)
  other.is_a?(MatchRequiredNode) &&
    (value === other.value) &&
    (pattern === other.pattern) &&
    (operator_loc.nil? == other.operator_loc.nil?)
end

#accept(visitor)

def accept: (Visitor visitor) -> void

[ GitHub ]

# File 'lib/prism/node.rb', line 13519


def accept(visitor)
  visitor.visit_match_required_node(self)
end

#child_nodes Also known as: #deconstruct

def child_nodes: () -> Array

[ GitHub ]

# File 'lib/prism/node.rb', line 13524


def child_nodes
  [value, pattern]
end

#comment_targets

def comment_targets: () -> Array[Node | Location]

[ GitHub ]

# File 'lib/prism/node.rb', line 13542


def comment_targets
  [value, pattern, operator_loc] #: Array[Prism::node | Location]
end

#compact_child_nodes

def compact_child_nodes: () -> Array

[ GitHub ]

# File 'lib/prism/node.rb', line 13537


def compact_child_nodes
  [value, pattern]
end

#copy(node_id: self.node_id, location: self.location, flags: self.flags, value: self.value, pattern: self.pattern, operator_loc: self.operator_loc)

def copy: (?node_id: Integer, ?location: Location, ?flags: Integer, ?value: Prism.node, ?pattern: Prism.node, ?operator_loc: Location) -> MatchRequiredNode

[ GitHub ]

# File 'lib/prism/node.rb', line 13547


def copy(node_id: self.node_id, location: self.location, flags: self.flags, value: self.value, pattern: self.pattern, operator_loc: self.operator_loc)
  MatchRequiredNode.new(source, node_id, location, flags, value, pattern, operator_loc)
end

#deconstruct

Alias for #child_nodes.

[ GitHub ]

# File 'lib/prism/node.rb', line 13552


alias deconstruct child_nodes

#deconstruct_keys(keys)

def deconstruct_keys: (Array keys) -> { node_id: Integer, location: Location, value: Prism.node, pattern: Prism.node, operator_loc: Location }

[ GitHub ]

# File 'lib/prism/node.rb', line 13555


def deconstruct_keys(keys)
  { node_id: node_id, location: location, value: value, pattern: pattern, operator_loc: operator_loc }
end

#each_child_node {|value| ... }

def each_child_node: () { (Prism::node) -> void } -> void | () -> Enumerator

Yields:

(value)

[ GitHub ]

# File 'lib/prism/node.rb', line 13529


def each_child_node
  return to_enum(:each_child_node) unless block_given?

  yield value
  yield pattern
end

#inspect

def inspect -> String

[ GitHub ]

# File 'lib/prism/node.rb', line 13632


def inspect
  InspectVisitor.compose(self)
end

#operator

def operator: () -> String

[ GitHub ]

# File 'lib/prism/node.rb', line 13627


def operator
  operator_loc.slice
end

#operator_loc

The location of the operator.

foo => bar
    ^^

[ GitHub ]

# File 'lib/prism/node.rb', line 13614


def operator_loc
  location = @operator_loc
  return location if location.is_a?(Location)
  @operator_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
end

#save_operator_loc(repository)

Save the operator_loc location using the given saved source so that it can be retrieved later.

[ GitHub ]

# File 'lib/prism/node.rb', line 13622


def save_operator_loc(repository)
  repository.enter(node_id, :operator_loc)
end

#type

Return a symbol representation of this node type. See Node#type.

[ GitHub ]

# File 'lib/prism/node.rb', line 13637


def type
  :match_required_node
end

Class: Prism::MatchRequiredNode

Overview

Class Method Summary

Node - Inherited

Instance Attribute Summary

Node - Inherited

Instance Method Summary

Node - Inherited

Constructor Details

.new(source, node_id, location, flags, value, pattern, operator_loc) ⇒ MatchRequiredNode

Class Method Details

.type

Instance Attribute Details

#pattern (readonly)

#value (readonly)

Instance Method Details

#===(other)

#accept(visitor)

#child_nodes Also known as: #deconstruct

#comment_targets

#compact_child_nodes

#copy(node_id: self.node_id, location: self.location, flags: self.flags, value: self.value, pattern: self.pattern, operator_loc: self.operator_loc)

#deconstruct

#deconstruct_keys(keys)

#each_child_node {|value| ... }

#inspect

#operator

#operator_loc

#save_operator_loc(repository)

#type

`Node` - Inherited

`Node` - Inherited

`Node` - Inherited

.new(source, node_id, location, flags, value, pattern, operator_loc) ⇒ `MatchRequiredNode`