Class: Prism::ArrayNode
- Inherits:
-
PrismNode
- Object
- PrismNode
- Prism::ArrayNode
- Defined in:
- lib/prism/node.rb,
ext/prism/api_node.c
Overview
Represents an array literal. This can be a regular array using brackets or a special array using % like %w or %i.
[1, 2, 3]
^^^^^^^^^
Instance Attribute Summary collapse
-
#elements ⇒ Object
readonly
Represent the list of zero or more [non-void expressions](github.com/ruby/prism/blob/main/docs/parsing_rules.md#non-void-expression) within the array.
Class Method Summary collapse
-
.type ⇒ Object
Return a symbol representation of this node type.
Instance Method Summary collapse
-
#===(other) ⇒ Object
Implements case-equality for the node.
-
#accept(visitor) ⇒ Object
def accept: (Visitor visitor) -> void.
-
#child_nodes ⇒ Object
(also: #deconstruct)
def child_nodes: () -> Array.
-
#closing ⇒ Object
def closing: () -> String?.
-
#closing_loc ⇒ Object
Represents the optional source location for the closing token.
-
#comment_targets ⇒ Object
def comment_targets: () -> Array[Node | Location].
-
#compact_child_nodes ⇒ Object
def compact_child_nodes: () -> Array.
-
#contains_splat? ⇒ Boolean
def contains_splat?: () -> bool.
-
#copy(node_id: self.node_id, location: self.location, flags: self.flags, elements: self.elements, opening_loc: self.opening_loc, closing_loc: self.closing_loc) ⇒ Object
def copy: (?node_id: Integer, ?location: Location, ?flags: Integer, ?elements: Array, ?opening_loc: Location?, ?closing_loc: Location?) -> ArrayNode.
- #deconstruct_keys(keys) ⇒ Object
-
#initialize(source, node_id, location, flags, elements, opening_loc, closing_loc) ⇒ ArrayNode
constructor
Initialize a new ArrayNode node.
-
#inspect ⇒ Object
def inspect -> String.
-
#opening ⇒ Object
def opening: () -> String?.
-
#opening_loc ⇒ Object
Represents the optional source location for the opening token.
-
#save_closing_loc(repository) ⇒ Object
Save the closing_loc location using the given saved source so that it can be retrieved later.
-
#save_opening_loc(repository) ⇒ Object
Save the opening_loc location using the given saved source so that it can be retrieved later.
-
#type ⇒ Object
Return a symbol representation of this node type.
Constructor Details
#initialize(source, node_id, location, flags, elements, opening_loc, closing_loc) ⇒ ArrayNode
Initialize a new ArrayNode node.
870 871 872 873 874 875 876 877 878 |
# File 'lib/prism/node.rb', line 870 def initialize(source, node_id, location, flags, elements, opening_loc, closing_loc) @source = source @node_id = node_id @location = location @flags = flags @elements = elements @opening_loc = opening_loc @closing_loc = closing_loc end |
Instance Attribute Details
#elements ⇒ Object (readonly)
Represent the list of zero or more [non-void expressions](github.com/ruby/prism/blob/main/docs/parsing_rules.md#non-void-expression) within the array.
919 920 921 |
# File 'lib/prism/node.rb', line 919 def elements @elements end |
Class Method Details
.type ⇒ Object
Return a symbol representation of this node type. See ‘Node::type`.
990 991 992 |
# File 'lib/prism/node.rb', line 990 def self.type :array_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.
996 997 998 999 1000 1001 1002 1003 |
# File 'lib/prism/node.rb', line 996 def ===(other) other.is_a?(ArrayNode) && (flags === other.flags) && (elements.length == other.elements.length) && elements.zip(other.elements).all? { |left, right| left === right } && (opening_loc.nil? == other.opening_loc.nil?) && (closing_loc.nil? == other.closing_loc.nil?) end |
#accept(visitor) ⇒ Object
def accept: (Visitor visitor) -> void
881 882 883 |
# File 'lib/prism/node.rb', line 881 def accept(visitor) visitor.visit_array_node(self) end |
#child_nodes ⇒ Object Also known as: deconstruct
def child_nodes: () -> Array
886 887 888 |
# File 'lib/prism/node.rb', line 886 def child_nodes [*elements] end |
#closing ⇒ Object
def closing: () -> String?
975 976 977 |
# File 'lib/prism/node.rb', line 975 def closing closing_loc&.slice end |
#closing_loc ⇒ Object
Represents the optional source location for the closing token.
[1,2,3] # "]"
%w[foo bar baz] # "]"
%I(apple orange banana) # ")"
foo = 1, 2, 3 # nil
951 952 953 954 955 956 957 958 959 960 961 |
# File 'lib/prism/node.rb', line 951 def closing_loc location = @closing_loc case location when nil nil when Location location else @closing_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF) end end |
#comment_targets ⇒ Object
def comment_targets: () -> Array[Node | Location]
896 897 898 |
# File 'lib/prism/node.rb', line 896 def comment_targets [*elements, *opening_loc, *closing_loc] #: Array[Prism::node | Location] end |
#compact_child_nodes ⇒ Object
def compact_child_nodes: () -> Array
891 892 893 |
# File 'lib/prism/node.rb', line 891 def compact_child_nodes [*elements] end |
#contains_splat? ⇒ Boolean
def contains_splat?: () -> bool
914 915 916 |
# File 'lib/prism/node.rb', line 914 def contains_splat? flags.anybits?(ArrayNodeFlags::CONTAINS_SPLAT) end |
#copy(node_id: self.node_id, location: self.location, flags: self.flags, elements: self.elements, opening_loc: self.opening_loc, closing_loc: self.closing_loc) ⇒ Object
def copy: (?node_id: Integer, ?location: Location, ?flags: Integer, ?elements: Array, ?opening_loc: Location?, ?closing_loc: Location?) -> ArrayNode
901 902 903 |
# File 'lib/prism/node.rb', line 901 def copy(node_id: self.node_id, location: self.location, flags: self.flags, elements: self.elements, opening_loc: self.opening_loc, closing_loc: self.closing_loc) ArrayNode.new(source, node_id, location, flags, elements, opening_loc, closing_loc) end |
#deconstruct_keys(keys) ⇒ Object
909 910 911 |
# File 'lib/prism/node.rb', line 909 def deconstruct_keys(keys) { node_id: node_id, location: location, elements: elements, opening_loc: opening_loc, closing_loc: closing_loc } end |
#inspect ⇒ Object
def inspect -> String
980 981 982 |
# File 'lib/prism/node.rb', line 980 def inspect InspectVisitor.compose(self) end |
#opening ⇒ Object
def opening: () -> String?
970 971 972 |
# File 'lib/prism/node.rb', line 970 def opening opening_loc&.slice end |
#opening_loc ⇒ Object
Represents the optional source location for the opening token.
[1,2,3] # "["
%w[foo bar baz] # "%w["
%I(apple orange banana) # "%I("
foo = 1, 2, 3 # nil
927 928 929 930 931 932 933 934 935 936 937 |
# File 'lib/prism/node.rb', line 927 def opening_loc location = @opening_loc case location when nil nil when Location location else @opening_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF) end end |
#save_closing_loc(repository) ⇒ Object
Save the closing_loc location using the given saved source so that it can be retrieved later.
965 966 967 |
# File 'lib/prism/node.rb', line 965 def save_closing_loc(repository) repository.enter(node_id, :closing_loc) unless @closing_loc.nil? end |
#save_opening_loc(repository) ⇒ Object
Save the opening_loc location using the given saved source so that it can be retrieved later.
941 942 943 |
# File 'lib/prism/node.rb', line 941 def save_opening_loc(repository) repository.enter(node_id, :opening_loc) unless @opening_loc.nil? end |
#type ⇒ Object
Return a symbol representation of this node type. See ‘Node#type`.
985 986 987 |
# File 'lib/prism/node.rb', line 985 def type :array_node end |