123456789_123456789_123456789_123456789_123456789_

Class: Prism::ClassNode

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, Node
Instance Chain:
self, Node
Inherits: Prism::Node
Defined in: lib/prism/node.rb,
prism/api_node.c

Overview

Represents a class declaration involving the class keyword.

class Foo end
^^^^^^^^^^^^^

Class Method Summary

Node - Inherited

.fields

Returns a list of the fields that exist for this node class.
.type

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.

Instance Attribute Summary

Node - Inherited

#newline?

Returns true if the node has the newline flag set.
#node_id

A unique identifier for this node.
#static_literal?

Returns true if the node has the static literal flag set.
#flags

An bitset of flags for this node.
#source

A pointer to the source that this node was created from.
#newline_flag?

Instance Method Summary

Node - Inherited

#accept

Accepts a visitor and calls back into the specialized visit function.
#breadth_first_search

Returns the first node that matches the given block when visited in a depth-first search.
#cached_end_code_units_column

Delegates to the cached_end_code_units_column of the associated location object.
#cached_end_code_units_offset

Delegates to the cached_end_code_units_offset of the associated location object.
#cached_start_code_units_column

Delegates to the cached_start_code_units_column of the associated location object.
#cached_start_code_units_offset

Delegates to the cached_start_code_units_offset of the associated location object.
#child_nodes

Returns an array of child nodes, including nils in the place of optional nodes that were not present.
#comment_targets

Returns an array of child nodes and locations that could potentially have comments attached to them.
#comments

Delegates to the comments of the associated location object.
#compact_child_nodes

Returns an array of child nodes, excluding any nils in the place of optional nodes that were not present.
#deconstruct

Alias for Node#child_nodes.
#each_child_node

With a block given, yields each child node.
#end_character_column

Delegates to the end_character_column of the associated location object.
#end_character_offset

Delegates to the end_character_offset of the associated location object.
#end_column

Delegates to the end_column of the associated location object.
#end_line

Delegates to the end_line of the associated location object.
#end_offset

The end offset of the node in the source.
#inspect

Returns a string representation of the node.
#leading_comments

Delegates to the leading_comments of the associated location object.
#location

A Location instance that represents the location of this node in the source.
#pretty_print

Similar to inspect, but respects the current level of indentation given by the pretty print object.
#save

Save this node using a saved source so that it can be retrieved later.
#save_location

Save the location using a saved source so that it can be retrieved later.
#script_lines

Alias for Node#source_lines.
#slice

Slice the location of the node from the source.
#slice_lines

Slice the location of the node from the source, starting at the beginning of the line that the location starts on, ending at the end of the line that the location ends on.
#source_lines

Returns all of the lines of the source code associated with this node.
#start_character_column

Delegates to the start_character_column of the associated location object.
#start_character_offset

Delegates to the start_character_offset of the associated location object.
#start_column

Delegates to the start_column of the associated location object.
#start_line

Delegates to the start_line of the associated location object.
#start_offset

The start offset of the node in the source.
#to_dot

Convert this node into a graphviz dot graph string.
#trailing_comments

Delegates to the trailing_comments of the associated location object.
#tunnel

Returns a list of nodes that are descendants of this node that contain the given line and column.
#type

Sometimes you want to check an instance of a node against a list of classes to see what kind of behavior to perform.
#deprecated, #newline_flag!

Constructor Details

.new(source, node_id, location, flags, locals, class_keyword_loc, constant_path, inheritance_operator_loc, superclass, body, end_keyword_loc, name) ⇒ ClassNode

Initialize a new ClassNode node.

[ GitHub ] 

  


# File 'lib/prism/node.rb', line 4049



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


  







Class Method Details



  

    .type  
  



  

    

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


  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 4214



def self.type
  :class_node
end


  







Instance Attribute Details



  

    #body   (readonly)
  



  

    

Represents the body of the class.



class Foo
  foo
  ^^^


  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 4165



attr_reader :body


  








  

    #constant_path   (readonly)
  



  

    

attr_reader constant_path: ConstantReadNode | ConstantPathNode | CallNode


  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 4130



attr_reader :constant_path


  








  

    #locals   (readonly)
  



  

    

attr_reader locals: Array


  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 4111



attr_reader :locals


  








  

    #name   (readonly)
  



  

    

The name of the class.



class Foo end # name `:Foo`


  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 4186



attr_reader :name


  








  

    #superclass   (readonly)
  



  

    

Represents the superclass of the class.



class Foo < Bar
            ^^^


  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 4158



attr_reader :superclass


  







Instance Method Details



  

    #===(other)  
  



  

    

Implements case-equality for the node. This is effectively == but without comparing the value of locations. Locations are checked only for presence.


  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 4220



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


  








  

    #accept(visitor)  
  



  

    

def accept: (Visitor visitor) -> void


  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 4065



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


  








  

    #child_nodes  
    Also known as: #deconstruct
  



  

    

def child_nodes: () -> Array


  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 4070



def child_nodes
  [constant_path, superclass, body]
end


  








  

    #class_keyword  
  



  

    

def class_keyword: () -> String


  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 4189



def class_keyword
  class_keyword_loc.slice
end


  








  

    #class_keyword_loc  
  



  

    

Represents the location of the class keyword.



class Foo end
^^^^^


  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 4117



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


  








  

    #comment_targets  
  



  

    

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


  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 4093



def comment_targets
  [class_keyword_loc, constant_path, *inheritance_operator_loc, *superclass, *body, end_keyword_loc] #: Array[Prism::node | Location]
end


  








  

    #compact_child_nodes  
  



  

    

def compact_child_nodes: () -> Array


  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 4084



def compact_child_nodes
  compact = [] #: Array[Prism::node]
  compact << constant_path
  compact << superclass if superclass
  compact << body if body
  compact
end


  








  

    #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)  
  



  

    

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


  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 4098



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


  








  

    #deconstruct  
  



  

    

Alias for #child_nodes.


  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 4103



alias deconstruct child_nodes


  








  

    #deconstruct_keys(keys)  
  



  

    

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 }


  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 4106



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


  








  

    #each_child_node {|constant_path| ... } 
  



  

    

def each_child_node: () { (Prism::node) -> void } -> void | () -> Enumerator


  





  
Yields:





  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 4075



def each_child_node
  return to_enum(:each_child_node) unless block_given?

  yield constant_path
  yield superclass if superclass
  yield body if body
end


  








  

    #end_keyword  
  



  

    

def end_keyword: () -> String


  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 4199



def end_keyword
  end_keyword_loc.slice
end


  








  

    #end_keyword_loc  
  



  

    

Represents the location of the end keyword.



class Foo end
          ^^^


  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 4171



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


  








  

    #inheritance_operator  
  



  

    

def inheritance_operator: () -> String?


  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 4194



def inheritance_operator
  inheritance_operator_loc&.slice
end


  








  

    #inheritance_operator_loc  
  



  

    

Represents the location of the < operator.



class Foo < Bar
          ^


  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 4136



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


  








  

    #inspect  
  



  

    

def inspect -> String


  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 4204



def inspect
  InspectVisitor.compose(self)
end


  








  

    #save_class_keyword_loc(repository)  
  



  

    

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


  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 4125



def save_class_keyword_loc(repository)
  repository.enter(node_id, :class_keyword_loc)
end


  








  

    #save_end_keyword_loc(repository)  
  



  

    

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


  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 4179



def save_end_keyword_loc(repository)
  repository.enter(node_id, :end_keyword_loc)
end


  








  

    #save_inheritance_operator_loc(repository)  
  



  

    

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


  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 4150



def save_inheritance_operator_loc(repository)
  repository.enter(node_id, :inheritance_operator_loc) unless @inheritance_operator_loc.nil?
end


  








  

    #type  
  



  

    

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


  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 4209



def type
  :class_node
end