Represents a class declaration involving the class keyword.
class Foo end ^^^^^^^^^^^^^
Represents the body of the class.
class Foo foo ^^^
attr_reader constant_path: ConstantReadNode | ConstantPathNode | CallNode
The name of the class.
class Foo end # name `:Foo`
Represents the superclass of the class.
class Foo < Bar
^^^
# File tmp/rubies/ruby-4.0.0/lib/prism/node.rb, line 3858
def initialize(source, node_id, location, flags, locals, class_keyword_loc, constant_path, inheritance_operator_loc, superclass, body, end_keyword_loc, name)
@source = source
@node_id = node_id
@location = location
@flags = flags
@locals = locals
@class_keyword_loc = class_keyword_loc
@constant_path = constant_path
@inheritance_operator_loc = inheritance_operator_loc
@superclass = superclass
@body = body
@end_keyword_loc = end_keyword_loc
@name = name
end
Initialize a new ClassNode node.
# File tmp/rubies/ruby-4.0.0/lib/prism/node.rb, line 4014
def self.type
:class_node
end
Return a symbol representation of this node type. See Node::type.
# File tmp/rubies/ruby-4.0.0/lib/prism/node.rb, line 4020
def ===(other)
other.is_a?(ClassNode) &&
(locals.length == other.locals.length) &&
locals.zip(other.locals).all? { |left, right| left === right } &&
(class_keyword_loc.nil? == other.class_keyword_loc.nil?) &&
(constant_path === other.constant_path) &&
(inheritance_operator_loc.nil? == other.inheritance_operator_loc.nil?) &&
(superclass === other.superclass) &&
(body === other.body) &&
(end_keyword_loc.nil? == other.end_keyword_loc.nil?) &&
(name === other.name)
end
Implements case-equality for the node. This is effectively == but without comparing the value of locations. Locations are checked only for presence.
# File tmp/rubies/ruby-4.0.0/lib/prism/node.rb, line 3874
def accept(visitor)
visitor.visit_class_node(self)
end
def accept: (Visitor visitor) -> void
# File tmp/rubies/ruby-4.0.0/lib/prism/node.rb, line 3879
def child_nodes
[constant_path, superclass, body]
end
def child_nodes: () -> Array
# File tmp/rubies/ruby-4.0.0/lib/prism/node.rb, line 3989
def class_keyword
class_keyword_loc.slice
end
def class_keyword: () -> String
# File tmp/rubies/ruby-4.0.0/lib/prism/node.rb, line 3917
def class_keyword_loc
location = @class_keyword_loc
return location if location.is_a?(Location)
@class_keyword_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
end
Represents the location of the class keyword.
class Foo end ^^^^^
# File tmp/rubies/ruby-4.0.0/lib/prism/node.rb, line 3893
def comment_targets
[class_keyword_loc, constant_path, *inheritance_operator_loc, *superclass, *body, end_keyword_loc] #: Array[Prism::node | Location]
end
def comment_targets: () -> Array[Node | Location]
# File tmp/rubies/ruby-4.0.0/lib/prism/node.rb, line 3884
def compact_child_nodes
compact = [] #: Array[Prism::node]
compact << constant_path
compact << superclass if superclass
compact << body if body
compact
end
def compact_child_nodes: () -> Array
# File tmp/rubies/ruby-4.0.0/lib/prism/node.rb, line 3898
def copy(node_id: self.node_id, location: self.location, flags: self.flags, locals: self.locals, class_keyword_loc: self.class_keyword_loc, constant_path: self.constant_path, inheritance_operator_loc: self.inheritance_operator_loc, superclass: self.superclass, body: self.body, end_keyword_loc: self.end_keyword_loc, name: self.name)
ClassNode.new(source, node_id, location, flags, locals, class_keyword_loc, constant_path, inheritance_operator_loc, superclass, body, end_keyword_loc, name)
end
def copy: (?node_id: Integer, ?location: Location, ?flags: Integer, ?locals: Array, ?class_keyword_loc: Location, ?constant_path: ConstantReadNode | ConstantPathNode | CallNode, ?inheritance_operator_loc: Location?, ?superclass: Prism::node?, ?body: StatementsNode | BeginNode | nil, ?end_keyword_loc: Location, ?name: Symbol) -> ClassNode
# File tmp/rubies/ruby-4.0.0/lib/prism/node.rb, line 3906
def deconstruct_keys(keys)
{ node_id: node_id, location: location, locals: locals, class_keyword_loc: class_keyword_loc, constant_path: constant_path, inheritance_operator_loc: inheritance_operator_loc, superclass: superclass, body: body, end_keyword_loc: end_keyword_loc, name: name }
end
def deconstruct_keys: (Array keys) -> { node_id: Integer, location: Location, locals: Array, class_keyword_loc: Location, constant_path: ConstantReadNode | ConstantPathNode | CallNode, inheritance_operator_loc: Location?, superclass: Prism::node?, body: StatementsNode | BeginNode | nil, end_keyword_loc: Location, name: Symbol }
# File tmp/rubies/ruby-4.0.0/lib/prism/node.rb, line 3999
def end_keyword
end_keyword_loc.slice
end
def end_keyword: () -> String
# File tmp/rubies/ruby-4.0.0/lib/prism/node.rb, line 3971
def end_keyword_loc
location = @end_keyword_loc
return location if location.is_a?(Location)
@end_keyword_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
end
Represents the location of the end keyword.
class Foo end
^^^
# File tmp/rubies/ruby-4.0.0/lib/prism/node.rb, line 3994
def inheritance_operator
inheritance_operator_loc&.slice
end
def inheritance_operator: () -> String?
# File tmp/rubies/ruby-4.0.0/lib/prism/node.rb, line 3936
def inheritance_operator_loc
location = @inheritance_operator_loc
case location
when nil
nil
when Location
location
else
@inheritance_operator_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
end
end
Represents the location of the < operator.
class Foo < Bar
^
# File tmp/rubies/ruby-4.0.0/lib/prism/node.rb, line 4004
def inspect
InspectVisitor.compose(self)
end
def inspect -> String
# File tmp/rubies/ruby-4.0.0/lib/prism/node.rb, line 3925
def save_class_keyword_loc(repository)
repository.enter(node_id, :class_keyword_loc)
end
Save the class_keyword_loc location using the given saved source so that it can be retrieved later.
# File tmp/rubies/ruby-4.0.0/lib/prism/node.rb, line 3979
def save_end_keyword_loc(repository)
repository.enter(node_id, :end_keyword_loc)
end
Save the end_keyword_loc location using the given saved source so that it can be retrieved later.
# File tmp/rubies/ruby-4.0.0/lib/prism/node.rb, line 3950
def save_inheritance_operator_loc(repository)
repository.enter(node_id, :inheritance_operator_loc) unless @inheritance_operator_loc.nil?
end
Save the inheritance_operator_loc location using the given saved source so that it can be retrieved later.
# File tmp/rubies/ruby-4.0.0/lib/prism/node.rb, line 4009
def type
:class_node
end
Return a symbol representation of this node type. See Node#type.