class Prism::ClassNode
Represents a class declaration involving the ‘class` keyword.
class Foo end ^^^^^^^^^^^^^
Attributes
attr_reader body: Prism::node?
attr_reader constant_path
: Prism::node
attr_reader locals: Array
attr_reader name: Symbol
attr_reader superclass: Prism::node?
Public Class Methods
def initialize: (Array locals, Location
class_keyword_loc
, Prism::node constant_path
, Location
? inheritance_operator_loc
, Prism::node? superclass, Prism::node? body, Location
end_keyword_loc
, Symbol
name, Location
location) -> void
# File lib/prism/node.rb, line 3564 def initialize(source, locals, class_keyword_loc, constant_path, inheritance_operator_loc, superclass, body, end_keyword_loc, name, location) @source = source @newline = false @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
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
# File lib/prism/node.rb, line 3722 def self.type :class_node end
Public Instance Methods
def accept: (Visitor
visitor) -> void
# File lib/prism/node.rb, line 3579 def accept(visitor) visitor.visit_class_node(self) end
def child_nodes
: () -> Array[nil | Node]
# File lib/prism/node.rb, line 3584 def child_nodes [constant_path, superclass, body] end
def class_keyword
: () -> String
# File lib/prism/node.rb, line 3659 def class_keyword class_keyword_loc.slice end
attr_reader class_keyword_loc
: Location
# File lib/prism/node.rb, line 3619 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
def comment_targets
: () -> Array[Node | Location]
# File lib/prism/node.rb, line 3598 def comment_targets [class_keyword_loc, constant_path, *inheritance_operator_loc, *superclass, *body, end_keyword_loc] #: Array[Prism::node | Location] end
def compact_child_nodes
: () -> Array
# File lib/prism/node.rb, line 3589 def compact_child_nodes compact = [] #: Array[Prism::node] compact << constant_path compact << superclass if superclass compact << body if body compact end
def copy: (?locals: Array, ?class_keyword_loc: Location
, ?constant_path: Prism::node, ?inheritance_operator_loc: Location
?, ?superclass: Prism::node?, ?body: Prism::node?, ?end_keyword_loc: Location
, ?name: Symbol
, ?location: Location
) -> ClassNode
# File lib/prism/node.rb, line 3603 def copy(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, location: self.location) ClassNode.new(source, locals, class_keyword_loc, constant_path, inheritance_operator_loc, superclass, body, end_keyword_loc, name, location) end
def deconstruct_keys
: (Array keys) -> { locals: Array, class_keyword_loc
: Location
, constant_path
: Prism::node, inheritance_operator_loc
: Location
?, superclass: Prism::node?, body: Prism::node?, end_keyword_loc
: Location
, name: Symbol
, location: Location
}
# File lib/prism/node.rb, line 3611 def deconstruct_keys(keys) { 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, location: location } end
def end_keyword
: () -> String
# File lib/prism/node.rb, line 3669 def end_keyword end_keyword_loc.slice end
attr_reader end_keyword_loc
: Location
# File lib/prism/node.rb, line 3648 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
def inheritance_operator
: () -> String
?
# File lib/prism/node.rb, line 3664 def inheritance_operator inheritance_operator_loc&.slice end
attr_reader inheritance_operator_loc
: Location
?
# File lib/prism/node.rb, line 3629 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
def inspect(NodeInspector inspector) -> String
# File lib/prism/node.rb, line 3674 def inspect(inspector = NodeInspector.new) inspector << inspector.header(self) inspector << "├── locals: #{locals.inspect}\n" inspector << "├── class_keyword_loc: #{inspector.location(class_keyword_loc)}\n" inspector << "├── constant_path:\n" inspector << inspector.child_node(constant_path, "│ ") inspector << "├── inheritance_operator_loc: #{inspector.location(inheritance_operator_loc)}\n" if (superclass = self.superclass).nil? inspector << "├── superclass: ∅\n" else inspector << "├── superclass:\n" inspector << superclass.inspect(inspector.child_inspector("│ ")).delete_prefix(inspector.prefix) end if (body = self.body).nil? inspector << "├── body: ∅\n" else inspector << "├── body:\n" inspector << body.inspect(inspector.child_inspector("│ ")).delete_prefix(inspector.prefix) end inspector << "├── end_keyword_loc: #{inspector.location(end_keyword_loc)}\n" inspector << "└── name: #{name.inspect}\n" inspector.to_str end
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
# File lib/prism/node.rb, line 3712 def type :class_node end