Class: Prism::CallOrWriteNode

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(source, node_id, location, flags, receiver, call_operator_loc, message_loc, read_name, write_name, operator_loc, value) ⇒ CallOrWriteNode

Initialize a new CallOrWriteNode node.



3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
 
# File 'lib/prism/node.rb', line 3097

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

Instance Attribute Details

#read_name ⇒ Object (readonly)

Represents the name of the method being called.

foo.bar ||= value # read_name `:bar`
    ^^^



3221
3222
3223
 
# File 'lib/prism/node.rb', line 3221

def read_name
  @read_name
end

#receiver ⇒ Object (readonly)

The object that the method is being called on. This can be either ‘nil` or any [non-void expressions](github.com/ruby/prism/blob/main/docs/parsing_rules.md#non-void-expression).

foo.bar ||= value
^^^



3171
3172
3173
 
# File 'lib/prism/node.rb', line 3171

def receiver
  @receiver
end

#value ⇒ Object (readonly)

Represents the value being assigned.

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



3249
3250
3251
 
# File 'lib/prism/node.rb', line 3249

def value
  @value
end

#write_name ⇒ Object (readonly)

Represents the name of the method being written to.

foo.bar ||= value # write_name `:bar=`
    ^^^



3227
3228
3229
 
# File 'lib/prism/node.rb', line 3227

def write_name
  @write_name
end

Class Method Details

.type ⇒ Object

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



3277
3278
3279
 
# File 'lib/prism/node.rb', line 3277

def self.type
  :call_or_write_node
end

Instance Method Details

#===(other) ⇒ Object

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



3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
 
# File 'lib/prism/node.rb', line 3283

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) ⇒ Object

def accept: (Visitor visitor) -> void



3112
3113
3114
 
# File 'lib/prism/node.rb', line 3112

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

#attribute_write? ⇒ Boolean

def attribute_write?: () -> bool

Returns:

  • (Boolean) 


3158
3159
3160
 
# File 'lib/prism/node.rb', line 3158

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

#call_operator ⇒ Object

def call_operator: () -> String?



3252
3253
3254
 
# File 'lib/prism/node.rb', line 3252

def call_operator
  call_operator_loc&.slice
end

#call_operator_loc ⇒ Object

Represents the location of the call operator.

foo.bar ||= value
   ^



3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
 
# File 'lib/prism/node.rb', line 3177

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 ⇒ Object Also known as: deconstruct

def child_nodes: () -> Array



3117
3118
3119
 
# File 'lib/prism/node.rb', line 3117

def child_nodes
  [receiver, value]
end

#comment_targets ⇒ Object

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



3130
3131
3132
 
# File 'lib/prism/node.rb', line 3130

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

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



3122
3123
3124
3125
3126
3127
 
# File 'lib/prism/node.rb', line 3122

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) ⇒ Object

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



3135
3136
3137
 
# File 'lib/prism/node.rb', line 3135

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_keys(keys) ⇒ Object

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 }



3143
3144
3145
 
# File 'lib/prism/node.rb', line 3143

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

#ignore_visibility? ⇒ Boolean

def ignore_visibility?: () -> bool

Returns:

  • (Boolean) 


3163
3164
3165
 
# File 'lib/prism/node.rb', line 3163

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

#inspect ⇒ Object

def inspect -> String



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

def inspect
  InspectVisitor.compose(self)
end

#message ⇒ Object

def message: () -> String?



3257
3258
3259
 
# File 'lib/prism/node.rb', line 3257

def message
  message_loc&.slice
end

#message_loc ⇒ Object

Represents the location of the message.

foo.bar ||= value
    ^^^



3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
 
# File 'lib/prism/node.rb', line 3199

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 ⇒ Object

def operator: () -> String



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

def operator
  operator_loc.slice
end

#operator_loc ⇒ Object

Represents the location of the operator.

foo.bar ||= value
        ^^^



3233
3234
3235
3236
3237
 
# File 'lib/prism/node.rb', line 3233

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

#safe_navigation? ⇒ Boolean

def safe_navigation?: () -> bool

Returns:

  • (Boolean) 


3148
3149
3150
 
# File 'lib/prism/node.rb', line 3148

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

#save_call_operator_loc(repository) ⇒ Object

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



3191
3192
3193
 
# File 'lib/prism/node.rb', line 3191

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

#save_message_loc(repository) ⇒ Object

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



3213
3214
3215
 
# File 'lib/prism/node.rb', line 3213

def save_message_loc(repository)
  repository.enter(node_id, :message_loc) unless @message_loc.nil?
end

#save_operator_loc(repository) ⇒ Object

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



3241
3242
3243
 
# File 'lib/prism/node.rb', line 3241

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

#type ⇒ Object

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



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

def type
  :call_or_write_node
end

#variable_call? ⇒ Boolean

def variable_call?: () -> bool

Returns:

  • (Boolean) 


3153
3154
3155
 
# File 'lib/prism/node.rb', line 3153

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