Class: Prism::CallOperatorWriteNode

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

Overview

Represents the use of an assignment operator on a call.

foo.bar += baz
^^^^^^^^^^^^^^

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, binary_operator, binary_operator_loc, value) ⇒ CallOperatorWriteNode

Initialize a new CallOperatorWriteNode node.



2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
 
# File 'lib/prism/node.rb', line 2845

def initialize(source, node_id, location, flags, receiver, call_operator_loc, message_loc, read_name, write_name, binary_operator, binary_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
  @binary_operator = binary_operator
  @binary_operator_loc = binary_operator_loc
  @value = value
end

Instance Attribute Details

#binary_operator ⇒ Object (readonly)

Represents the binary operator being used.

foo.bar += value # binary_operator `:+`
        ^



2982
2983
2984
 
# File 'lib/prism/node.rb', line 2982

def binary_operator
  @binary_operator
end

#read_name ⇒ Object (readonly)

Represents the name of the method being called.

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



2970
2971
2972
 
# File 'lib/prism/node.rb', line 2970

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
^^^



2920
2921
2922
 
# File 'lib/prism/node.rb', line 2920

def receiver
  @receiver
end

#value ⇒ Object (readonly)

Represents the value being assigned.

foo.bar += value
           ^^^^^



3004
3005
3006
 
# File 'lib/prism/node.rb', line 3004

def value
  @value
end

#write_name ⇒ Object (readonly)

Represents the name of the method being written to.

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



2976
2977
2978
 
# File 'lib/prism/node.rb', line 2976

def write_name
  @write_name
end

Class Method Details

.type ⇒ Object

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



3027
3028
3029
 
# File 'lib/prism/node.rb', line 3027

def self.type
  :call_operator_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.



3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
 
# File 'lib/prism/node.rb', line 3033

def ===(other)
  other.is_a?(CallOperatorWriteNode) &&
    (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) &&
    (binary_operator === other.binary_operator) &&
    (binary_operator_loc.nil? == other.binary_operator_loc.nil?) &&
    (value === other.value)
end

#accept(visitor) ⇒ Object

def accept: (Visitor visitor) -> void



2861
2862
2863
 
# File 'lib/prism/node.rb', line 2861

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

#attribute_write? ⇒ Boolean

def attribute_write?: () -> bool

Returns:

  • (Boolean) 


2907
2908
2909
 
# File 'lib/prism/node.rb', line 2907

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

#binary_operator_loc ⇒ Object

Represents the location of the binary operator.

foo.bar += value
        ^^



2988
2989
2990
2991
2992
 
# File 'lib/prism/node.rb', line 2988

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

#call_operator ⇒ Object

def call_operator: () -> String?



3007
3008
3009
 
# File 'lib/prism/node.rb', line 3007

def call_operator
  call_operator_loc&.slice
end

#call_operator_loc ⇒ Object

Represents the location of the call operator.

foo.bar += value
   ^



2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
 
# File 'lib/prism/node.rb', line 2926

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[nil | Node]



2866
2867
2868
 
# File 'lib/prism/node.rb', line 2866

def child_nodes
  [receiver, value]
end

#comment_targets ⇒ Object

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



2879
2880
2881
 
# File 'lib/prism/node.rb', line 2879

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

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



2871
2872
2873
2874
2875
2876
 
# File 'lib/prism/node.rb', line 2871

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, binary_operator: self.binary_operator, binary_operator_loc: self.binary_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, ?binary_operator: Symbol, ?binary_operator_loc: Location, ?value: Prism::node) -> CallOperatorWriteNode



2884
2885
2886
 
# File 'lib/prism/node.rb', line 2884

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, binary_operator: self.binary_operator, binary_operator_loc: self.binary_operator_loc, value: self.value)
  CallOperatorWriteNode.new(source, node_id, location, flags, receiver, call_operator_loc, message_loc, read_name, write_name, binary_operator, binary_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, binary_operator: Symbol, binary_operator_loc: Location, value: Prism::node }



2892
2893
2894
 
# File 'lib/prism/node.rb', line 2892

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, binary_operator: binary_operator, binary_operator_loc: binary_operator_loc, value: value }
end

#ignore_visibility? ⇒ Boolean

def ignore_visibility?: () -> bool

Returns:

  • (Boolean) 


2912
2913
2914
 
# File 'lib/prism/node.rb', line 2912

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

#inspect ⇒ Object

def inspect -> String



3017
3018
3019
 
# File 'lib/prism/node.rb', line 3017

def inspect
  InspectVisitor.compose(self)
end

#message ⇒ Object

def message: () -> String?



3012
3013
3014
 
# File 'lib/prism/node.rb', line 3012

def message
  message_loc&.slice
end

#message_loc ⇒ Object

Represents the location of the message.

foo.bar += value
    ^^^



2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
 
# File 'lib/prism/node.rb', line 2948

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

Returns the binary operator used to modify the receiver. This method is deprecated in favor of #binary_operator.



339
340
341
342
 
# File 'lib/prism/node_ext.rb', line 339

def operator
  deprecated("binary_operator")
  binary_operator
end

#operator_loc ⇒ Object

Returns the location of the binary operator used to modify the receiver. This method is deprecated in favor of #binary_operator_loc.



346
347
348
349
 
# File 'lib/prism/node_ext.rb', line 346

def operator_loc
  deprecated("binary_operator_loc")
  binary_operator_loc
end

#safe_navigation? ⇒ Boolean

def safe_navigation?: () -> bool

Returns:

  • (Boolean) 


2897
2898
2899
 
# File 'lib/prism/node.rb', line 2897

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

#save_binary_operator_loc(repository) ⇒ Object

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



2996
2997
2998
 
# File 'lib/prism/node.rb', line 2996

def save_binary_operator_loc(repository)
  repository.enter(node_id, :binary_operator_loc)
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.



2940
2941
2942
 
# File 'lib/prism/node.rb', line 2940

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.



2962
2963
2964
 
# File 'lib/prism/node.rb', line 2962

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

#type ⇒ Object

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



3022
3023
3024
 
# File 'lib/prism/node.rb', line 3022

def type
  :call_operator_write_node
end

#variable_call? ⇒ Boolean

def variable_call?: () -> bool

Returns:

  • (Boolean) 


2902
2903
2904
 
# File 'lib/prism/node.rb', line 2902

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