Class: Prism::CallAndWriteNode

Inherits:
PrismNode
  • Object
show all
Defined in:
lib/prism/node.rb,
ext/prism/api_node.c

Overview

Represents the use of the ‘&&=` operator on a call.

foo.bar &&= value
^^^^^^^^^^^^^^^^^

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(flags, receiver, call_operator_loc, message_loc, read_name, write_name, operator_loc, value, location) ⇒ CallAndWriteNode

def initialize: (flags: Integer, receiver: Node?, call_operator_loc: Location?, message_loc: Location?, read_name: Symbol, write_name: Symbol, operator_loc: Location, value: Node, location: Location) -> void



1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
 
# File 'lib/prism/node.rb', line 1996

def initialize(flags, receiver, call_operator_loc, message_loc, read_name, write_name, operator_loc, value, 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
  @location = location
end

Instance Attribute Details

#call_operator_loc ⇒ Object (readonly)

attr_reader call_operator_loc: Location?



1978
1979
1980
 
# File 'lib/prism/node.rb', line 1978

def call_operator_loc
  @call_operator_loc
end

#flags ⇒ Object (readonly)

Returns the value of attribute flags.



1972
1973
1974
 
# File 'lib/prism/node.rb', line 1972

def flags
  @flags
end

#message_loc ⇒ Object (readonly)

attr_reader message_loc: Location?



1981
1982
1983
 
# File 'lib/prism/node.rb', line 1981

def message_loc
  @message_loc
end

#operator_loc ⇒ Object (readonly)

attr_reader operator_loc: Location



1990
1991
1992
 
# File 'lib/prism/node.rb', line 1990

def operator_loc
  @operator_loc
end

#read_name ⇒ Object (readonly)

attr_reader read_name: Symbol



1984
1985
1986
 
# File 'lib/prism/node.rb', line 1984

def read_name
  @read_name
end

#receiver ⇒ Object (readonly)

attr_reader receiver: Node?



1975
1976
1977
 
# File 'lib/prism/node.rb', line 1975

def receiver
  @receiver
end

#value ⇒ Object (readonly)

attr_reader value: Node



1993
1994
1995
 
# File 'lib/prism/node.rb', line 1993

def value
  @value
end

#write_name ⇒ Object (readonly)

attr_reader write_name: Symbol



1987
1988
1989
 
# File 'lib/prism/node.rb', line 1987

def write_name
  @write_name
end

Class Method Details

.type ⇒ Object

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. Note that like #type, it will still be slower than using == for a single class, but should be faster in a case statement or an array comparison.

def self.type: () -> Symbol



2129
2130
2131
 
# File 'lib/prism/node.rb', line 2129

def self.type
  :call_and_write_node
end

Instance Method Details

#accept(visitor) ⇒ Object

def accept: (visitor: Visitor) -> void



2009
2010
2011
 
# File 'lib/prism/node.rb', line 2009

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

#attribute_write? ⇒ Boolean

def attribute_write?: () -> bool

Returns:

  • (Boolean) 


2065
2066
2067
 
# File 'lib/prism/node.rb', line 2065

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

#call_operator ⇒ Object

def call_operator: () -> String?



2070
2071
2072
 
# File 'lib/prism/node.rb', line 2070

def call_operator
  call_operator_loc&.slice
end

#child_nodes ⇒ Object Also known as: deconstruct

def child_nodes: () -> Array[nil | Node]



2014
2015
2016
 
# File 'lib/prism/node.rb', line 2014

def child_nodes
  [receiver, value]
end

#comment_targets ⇒ Object

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



2027
2028
2029
 
# File 'lib/prism/node.rb', line 2027

def comment_targets
  [*receiver, *call_operator_loc, *message_loc, operator_loc, value]
end

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



2019
2020
2021
2022
2023
2024
 
# File 'lib/prism/node.rb', line 2019

def compact_child_nodes
  compact = []
  compact << receiver if receiver
  compact << value
  compact
end

#copy(**params) ⇒ Object

def copy: (**params) -> CallAndWriteNode



2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
 
# File 'lib/prism/node.rb', line 2032

def copy(**params)
  CallAndWriteNode.new(
    params.fetch(:flags) { flags },
    params.fetch(:receiver) { receiver },
    params.fetch(:call_operator_loc) { call_operator_loc },
    params.fetch(:message_loc) { message_loc },
    params.fetch(:read_name) { read_name },
    params.fetch(:write_name) { write_name },
    params.fetch(:operator_loc) { operator_loc },
    params.fetch(:value) { value },
    params.fetch(:location) { location },
  )
end

#deconstruct_keys(keys) ⇒ Object

def deconstruct_keys: (keys: Array) -> Hash[Symbol, nil | Node | Array | String | Token | Array | Location]



2050
2051
2052
 
# File 'lib/prism/node.rb', line 2050

def deconstruct_keys(keys)
  { 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, location: location }
end

#inspect(inspector = NodeInspector.new) ⇒ Object

def inspect(inspector: NodeInspector) -> String



2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
 
# File 'lib/prism/node.rb', line 2085

def inspect(inspector = NodeInspector.new)
  inspector << inspector.header(self)
  flags = [("safe_navigation" if safe_navigation?), ("variable_call" if variable_call?), ("attribute_write" if attribute_write?)].compact
  inspector << "├── flags: #{flags.empty? ? "∅" : flags.join(", ")}\n"
  if (receiver = self.receiver).nil?
    inspector << "├── receiver: ∅\n"
  else
    inspector << "├── receiver:\n"
    inspector << receiver.inspect(inspector.child_inspector("│   ")).delete_prefix(inspector.prefix)
  end
  inspector << "├── call_operator_loc: #{inspector.location(call_operator_loc)}\n"
  inspector << "├── message_loc: #{inspector.location(message_loc)}\n"
  inspector << "├── read_name: #{read_name.inspect}\n"
  inspector << "├── write_name: #{write_name.inspect}\n"
  inspector << "├── operator_loc: #{inspector.location(operator_loc)}\n"
  inspector << "└── value:\n"
  inspector << inspector.child_node(value, "    ")
  inspector.to_str
end

#message ⇒ Object

def message: () -> String?



2075
2076
2077
 
# File 'lib/prism/node.rb', line 2075

def message
  message_loc&.slice
end

#operator ⇒ Object

def operator: () -> String



2080
2081
2082
 
# File 'lib/prism/node.rb', line 2080

def operator
  operator_loc.slice
end

#safe_navigation? ⇒ Boolean

def safe_navigation?: () -> bool

Returns:

  • (Boolean) 


2055
2056
2057
 
# File 'lib/prism/node.rb', line 2055

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

#type ⇒ Object

Sometimes you want to check an instance of a node against a list of classes to see what kind of behavior to perform. Usually this is done by calling ‘[cls1, cls2].include?(node.class)` or putting the node into a case statement and doing `case node; when cls1; when cls2; end`. Both of these approaches are relatively slow because of the constant lookups, method calls, and/or array allocations.

Instead, you can call #type, which will return to you a symbol that you can use for comparison. This is faster than the other approaches because it uses a single integer comparison, but also because if you’re on CRuby you can take advantage of the fact that case statements with all symbol keys will use a jump table.

def type: () -> Symbol



2119
2120
2121
 
# File 'lib/prism/node.rb', line 2119

def type
  :call_and_write_node
end

#variable_call? ⇒ Boolean

def variable_call?: () -> bool

Returns:

  • (Boolean) 


2060
2061
2062
 
# File 'lib/prism/node.rb', line 2060

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