Class: Prism::CallOrWriteNode

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

Overview

Represents the use of the {||=} operator on a call.

foo.bar ||= value
^^^^^^^^^^^^^^^^^

Class Method Summary

.new(source, node_id, location, flags, receiver, call_operator_loc, message_loc, read_name, write_name, operator_loc, value) ⇒ CallOrWriteNode constructor

Initialize a new CallOrWriteNode 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

#attribute_write? ⇒ Boolean readonly

def attribute_write?: () -> bool.
#ignore_visibility? ⇒ Boolean readonly

def ignore_visibility?: () -> bool.
#read_name readonly

Represents the name of the method being called.
#receiver readonly

The object that the method is being called on.
#safe_navigation? ⇒ Boolean readonly

def safe_navigation?: () -> bool.
#value readonly

Represents the value being assigned.
#variable_call? ⇒ Boolean readonly

def variable_call?: () -> bool.
#write_name readonly

Represents the name of the method being written to.

`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.
#call_operator

def call_operator: () -> String?
#call_operator_loc

Represents the location of the call operator.
#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, receiver: self.receiver, call_operator_loc: self.call_operator_loc, message_loc: self.message_loc, read_name: self.read_name, write_name: self.write_name, operator_loc: self.operator_loc, value: self.value)

def copy: (?node_id: Integer, ?location: Location, ?flags: Integer, ?receiver: Prism.node?, ?call_operator_loc: Location?, ?message_loc: Location?, ?read_name: Symbol, ?write_name: Symbol, ?operator_loc: Location, ?value: Prism.node) -> CallOrWriteNode.
#deconstruct

Alias for #child_nodes.
#deconstruct_keys(keys)

def deconstruct_keys: (Array keys) -> { node_id: Integer, location: Location, receiver: Prism.node?, call_operator_loc: Location?, message_loc: Location?, read_name: Symbol, write_name: Symbol, operator_loc: Location, value: Prism.node }
#each_child_node {|receiver| ... }

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

def inspect -> String.
#message

def message: () -> String?
#message_loc

Represents the location of the message.
#operator

def operator: () -> String.
#operator_loc

Represents the location of the operator.
#save_call_operator_loc(repository)

Save the call_operator_loc location using the given saved source so that it can be retrieved later.
#save_message_loc(repository)

Save the message_loc location using the given saved source so that it can be retrieved later.
#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, receiver, call_operator_loc, message_loc, read_name, write_name, operator_loc, value) ⇒ `CallOrWriteNode`

Initialize a new CallOrWriteNode node.

[ GitHub ]

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


def initialize(source, node_id, location, flags, receiver, call_operator_loc, message_loc, read_name, write_name, operator_loc, value)
  @source = source
  @node_id = node_id
  @location = location
  @flags = flags
  @receiver = receiver
  @call_operator_loc = call_operator_loc
  @message_loc = message_loc
  @read_name = read_name
  @write_name = write_name
  @operator_loc = operator_loc
  @value = value
end

Class Method Details

.type

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

[ GitHub ]

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


def self.type
  :call_or_write_node
end

Instance Attribute Details

#attribute_write? ⇒ `Boolean` (readonly)

def attribute_write?: () -> bool

[ GitHub ]

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


def attribute_write?
  flags.anybits?(CallNodeFlags::ATTRIBUTE_WRITE)
end

#ignore_visibility? ⇒ `Boolean` (readonly)

def ignore_visibility?: () -> bool

[ GitHub ]

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


def ignore_visibility?
  flags.anybits?(CallNodeFlags::IGNORE_VISIBILITY)
end

#read_name (readonly)

Represents the name of the method being called.

foo.bar ||= value # read_name {:bar}
    ^^^

[ GitHub ]

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


attr_reader :read_name

#receiver (readonly)

The object that the method is being called on. This can be either nil or any non-void expressions.

foo.bar ||= value
^^^

[ GitHub ]

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


attr_reader :receiver

#safe_navigation? ⇒ `Boolean` (readonly)

def safe_navigation?: () -> bool

[ GitHub ]

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


def safe_navigation?
  flags.anybits?(CallNodeFlags::SAFE_NAVIGATION)
end

#value (readonly)

Represents the value being assigned.

foo.bar ||= value
            ^^^^^

[ GitHub ]

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


attr_reader :value

#variable_call? ⇒ `Boolean` (readonly)

def variable_call?: () -> bool

[ GitHub ]

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


def variable_call?
  flags.anybits?(CallNodeFlags::VARIABLE_CALL)
end

#write_name (readonly)

Represents the name of the method being written to.

foo.bar ||= value # write_name {:bar=}
    ^^^

[ GitHub ]

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


attr_reader :write_name

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 3441


def ===(other)
  other.is_a?(CallOrWriteNode) &&
    (flags === other.flags) &&
    (receiver === other.receiver) &&
    (call_operator_loc.nil? == other.call_operator_loc.nil?) &&
    (message_loc.nil? == other.message_loc.nil?) &&
    (read_name === other.read_name) &&
    (write_name === other.write_name) &&
    (operator_loc.nil? == other.operator_loc.nil?) &&
    (value === other.value)
end

#accept(visitor)

def accept: (Visitor visitor) -> void

[ GitHub ]

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


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

#call_operator

def call_operator: () -> String?

[ GitHub ]

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


def call_operator
  call_operator_loc&.slice
end

#call_operator_loc

Represents the location of the call operator.

foo.bar ||= value
   ^

[ GitHub ]

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


def call_operator_loc
  location = @call_operator_loc
  case location
  when nil
    nil
  when Location
    location
  else
    @call_operator_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
  end
end

#child_nodes Also known as: #deconstruct

def child_nodes: () -> Array

[ GitHub ]

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


def child_nodes
  [receiver, value]
end

#comment_targets

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

[ GitHub ]

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


def comment_targets
  [*receiver, *call_operator_loc, *message_loc, operator_loc, value] #: Array[Prism::node | Location]
end

#compact_child_nodes

def compact_child_nodes: () -> Array

[ GitHub ]

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


def compact_child_nodes
  compact = [] #: Array[Prism::node]
  compact << receiver if receiver
  compact << value
  compact
end

#copy(node_id: self.node_id, location: self.location, flags: self.flags, receiver: self.receiver, call_operator_loc: self.call_operator_loc, message_loc: self.message_loc, read_name: self.read_name, write_name: self.write_name, operator_loc: self.operator_loc, value: self.value)

def copy: (?node_id: Integer, ?location: Location, ?flags: Integer, ?receiver: Prism.node?, ?call_operator_loc: Location?, ?message_loc: Location?, ?read_name: Symbol, ?write_name: Symbol, ?operator_loc: Location, ?value: Prism.node) -> CallOrWriteNode

[ GitHub ]

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


def copy(node_id: self.node_id, location: self.location, flags: self.flags, receiver: self.receiver, call_operator_loc: self.call_operator_loc, message_loc: self.message_loc, read_name: self.read_name, write_name: self.write_name, operator_loc: self.operator_loc, value: self.value)
  CallOrWriteNode.new(source, node_id, location, flags, receiver, call_operator_loc, message_loc, read_name, write_name, operator_loc, value)
end

#deconstruct

Alias for #child_nodes.

[ GitHub ]

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


alias deconstruct child_nodes

#deconstruct_keys(keys)

def deconstruct_keys: (Array keys) -> { node_id: Integer, location: Location, receiver: Prism.node?, call_operator_loc: Location?, message_loc: Location?, read_name: Symbol, write_name: Symbol, operator_loc: Location, value: Prism.node }

[ GitHub ]

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


def deconstruct_keys(keys)
  { node_id: node_id, location: location, receiver: receiver, call_operator_loc: call_operator_loc, message_loc: message_loc, read_name: read_name, write_name: write_name, operator_loc: operator_loc, value: value }
end

#each_child_node {|receiver| ... }

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

Yields:

(receiver)

[ GitHub ]

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


def each_child_node
  return to_enum(:each_child_node) unless block_given?

  yield receiver if receiver
  yield value
end

#inspect

def inspect -> String

[ GitHub ]

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


def inspect
  InspectVisitor.compose(self)
end

#message

def message: () -> String?

[ GitHub ]

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


def message
  message_loc&.slice
end

#message_loc

Represents the location of the message.

foo.bar ||= value
    ^^^

[ GitHub ]

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


def message_loc
  location = @message_loc
  case location
  when nil
    nil
  when Location
    location
  else
    @message_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
  end
end

#operator

def operator: () -> String

[ GitHub ]

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


def operator
  operator_loc.slice
end

#operator_loc

Represents the location of the operator.

foo.bar ||= value
        ^^^

[ GitHub ]

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


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

#save_call_operator_loc(repository)

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

[ GitHub ]

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


def save_call_operator_loc(repository)
  repository.enter(node_id, :call_operator_loc) unless @call_operator_loc.nil?
end

#save_message_loc(repository)

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

[ GitHub ]

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


def save_message_loc(repository)
  repository.enter(node_id, :message_loc) unless @message_loc.nil?
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 3399


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 3430


def type
  :call_or_write_node
end

Class: Prism::CallOrWriteNode

Overview

Class Method Summary

Node - Inherited

Instance Attribute Summary

Node - Inherited

Instance Method Summary

Node - Inherited

Constructor Details

.new(source, node_id, location, flags, receiver, call_operator_loc, message_loc, read_name, write_name, operator_loc, value) ⇒ CallOrWriteNode

Class Method Details

.type

Instance Attribute Details

#attribute_write? ⇒ Boolean (readonly)

#ignore_visibility? ⇒ Boolean (readonly)

#read_name (readonly)

#receiver (readonly)

#safe_navigation? ⇒ Boolean (readonly)

#value (readonly)

#variable_call? ⇒ Boolean (readonly)

#write_name (readonly)

Instance Method Details

#===(other)

#accept(visitor)

#call_operator

#call_operator_loc

#child_nodes Also known as: #deconstruct

#comment_targets

#compact_child_nodes

#copy(node_id: self.node_id, location: self.location, flags: self.flags, receiver: self.receiver, call_operator_loc: self.call_operator_loc, message_loc: self.message_loc, read_name: self.read_name, write_name: self.write_name, operator_loc: self.operator_loc, value: self.value)

#deconstruct

#deconstruct_keys(keys)

#each_child_node {|receiver| ... }

#inspect

#message

#message_loc

#operator

#operator_loc

#save_call_operator_loc(repository)

#save_message_loc(repository)

#save_operator_loc(repository)

#type

`Node` - Inherited

`Node` - Inherited

`Node` - Inherited

.new(source, node_id, location, flags, receiver, call_operator_loc, message_loc, read_name, write_name, operator_loc, value) ⇒ `CallOrWriteNode`

#attribute_write? ⇒ `Boolean` (readonly)

#ignore_visibility? ⇒ `Boolean` (readonly)

#safe_navigation? ⇒ `Boolean` (readonly)

#variable_call? ⇒ `Boolean` (readonly)