Class: Prism::IntegerNode

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

Overview

Represents an integer number literal.

1
^

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(flags, location) ⇒ IntegerNode

def initialize: (flags: Integer, location: Location) -> void



9610
9611
9612
9613
 
# File 'lib/prism/node.rb', line 9610

def initialize(flags, location)
  @flags = flags
  @location = location
end

Instance Attribute Details

#flags ⇒ Object (readonly)

Returns the value of attribute flags.



9607
9608
9609
 
# File 'lib/prism/node.rb', line 9607

def flags
  @flags
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



9703
9704
9705
 
# File 'lib/prism/node.rb', line 9703

def self.type
  :integer_node
end

Instance Method Details

#accept(visitor) ⇒ Object

def accept: (visitor: Visitor) -> void



9616
9617
9618
 
# File 'lib/prism/node.rb', line 9616

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

#binary? ⇒ Boolean

def binary?: () -> bool

Returns:

  • (Boolean) 


9652
9653
9654
 
# File 'lib/prism/node.rb', line 9652

def binary?
  flags.anybits?(IntegerBaseFlags::BINARY)
end

#child_nodes ⇒ Object Also known as: deconstruct

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



9621
9622
9623
 
# File 'lib/prism/node.rb', line 9621

def child_nodes
  []
end

#comment_targets ⇒ Object

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



9631
9632
9633
 
# File 'lib/prism/node.rb', line 9631

def comment_targets
  []
end

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



9626
9627
9628
 
# File 'lib/prism/node.rb', line 9626

def compact_child_nodes
  []
end

#copy(**params) ⇒ Object

def copy: (**params) -> IntegerNode



9636
9637
9638
9639
9640
9641
 
# File 'lib/prism/node.rb', line 9636

def copy(**params)
  IntegerNode.new(
    params.fetch(:flags) { flags },
    params.fetch(:location) { location },
  )
end

#decimal? ⇒ Boolean

def decimal?: () -> bool

Returns:

  • (Boolean) 


9657
9658
9659
 
# File 'lib/prism/node.rb', line 9657

def decimal?
  flags.anybits?(IntegerBaseFlags::DECIMAL)
end

#deconstruct_keys(keys) ⇒ Object

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



9647
9648
9649
 
# File 'lib/prism/node.rb', line 9647

def deconstruct_keys(keys)
  { flags: flags, location: location }
end

#hexadecimal? ⇒ Boolean

def hexadecimal?: () -> bool

Returns:

  • (Boolean) 


9667
9668
9669
 
# File 'lib/prism/node.rb', line 9667

def hexadecimal?
  flags.anybits?(IntegerBaseFlags::HEXADECIMAL)
end

#inspect(inspector = NodeInspector.new) ⇒ Object

def inspect(inspector: NodeInspector) -> String



9672
9673
9674
9675
9676
9677
 
# File 'lib/prism/node.rb', line 9672

def inspect(inspector = NodeInspector.new)
  inspector << inspector.header(self)
  flags = [("binary" if binary?), ("decimal" if decimal?), ("octal" if octal?), ("hexadecimal" if hexadecimal?)].compact
  inspector << "└── flags: #{flags.empty? ? "∅" : flags.join(", ")}\n"
  inspector.to_str
end

#octal? ⇒ Boolean

def octal?: () -> bool

Returns:

  • (Boolean) 


9662
9663
9664
 
# File 'lib/prism/node.rb', line 9662

def octal?
  flags.anybits?(IntegerBaseFlags::OCTAL)
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



9693
9694
9695
 
# File 'lib/prism/node.rb', line 9693

def type
  :integer_node
end

#value ⇒ Object

Returns the value of the node as a Ruby Integer.



76
77
78
 
# File 'lib/prism/node_ext.rb', line 76

def value
  Integer(slice)
end