класс Prism::DefNode

Родитель:: Prism::Node

Представляет определение метода.

def method
end
^^^^^^^^^^

Атрибуты

body[R]

attr_reader body: Node?

def_keyword_loc[R]

attr_reader def_keyword_loc: Location

end_keyword_loc[R]

attr_reader end_keyword_loc: Location?

equal_loc[R]

attr_reader equal_loc: Location?

locals[R]

attr_reader locals: Массив

locals_body_index[R]

attr_reader locals_body_index: Integer

lparen_loc[R]

attr_reader lparen_loc: Location?

name[R]

attr_reader name: Symbol

name_loc[R]

attr_reader name_loc: Location

operator_loc[R]

attr_reader operator_loc: Location?

parameters[R]

attr_reader parameters: ParametersNode?

receiver[R]

attr_reader receiver: Node?

rparen_loc[R]

attr_reader rparen_loc: Location?

Публичные методы класса

new(name, name_loc, receiver, parameters, body, locals, locals_body_index, def_keyword_loc, operator_loc, lparen_loc, rparen_loc, equal_loc, end_keyword_loc, location) Показать исходный код

# File lib/prism/node.rb, line 5278
def initialize(name, name_loc, receiver, parameters, body, locals, locals_body_index, def_keyword_loc, operator_loc, lparen_loc, rparen_loc, equal_loc, end_keyword_loc, location)
  @name = name
  @name_loc = name_loc
  @receiver = receiver
  @parameters = parameters
  @body = body
  @locals = locals
  @locals_body_index = locals_body_index
  @def_keyword_loc = def_keyword_loc
  @operator_loc = operator_loc
  @lparen_loc = lparen_loc
  @rparen_loc = rparen_loc
  @equal_loc = equal_loc
  @end_keyword_loc = end_keyword_loc
  @location = location
end

def initialize: (name: Symbol, name_loc: Location, receiver: Node?, parameters: ParametersNode?, body: Node?, locals: Массив, locals_body_index: Integer, def_keyword_loc: Location, operator_loc: Location?, lparen_loc: Location?, rparen_loc: Location?, equal_loc: Location?, end_keyword_loc: Location?, location: Location) -> void

type() Показать исходный код

# File lib/prism/node.rb, line 5435
def self.type
  :def_node
end

Аналогично type, этот метод возвращает символ, который можно использовать для разделения по типу узла, без необходимости выполнять длинную цепочку ===. Обратите внимание, что, как и type, он по-прежнему будет медленнее, чем использование == для одного класса, но должен быть быстрее в операторе case или сравнении массивов.

def self.type: () -> Symbol

END_OF_DOCUMENT_MARKER

Методы публичного экземпляра

accept(visitor) Показать исходный код

# File lib/prism/node.rb, line 5296
def accept(visitor)
  visitor.visit_def_node(self)
end

def accept: (visitor: Visitor) -> void

child_nodes() Показать исходный код

# File lib/prism/node.rb, line 5301
def child_nodes
  [receiver, parameters, body]
end

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

Также псевдоним: deconstruct

comment_targets() Показать исходный код

# File lib/prism/node.rb, line 5315
def comment_targets
  [name_loc, *receiver, *parameters, *body, def_keyword_loc, *operator_loc, *lparen_loc, *rparen_loc, *equal_loc, *end_keyword_loc]
end

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

compact_child_nodes() Показать исходный код

# File lib/prism/node.rb, line 5306
def compact_child_nodes
  compact = []
  compact << receiver if receiver
  compact << parameters if parameters
  compact << body if body
  compact
end

def compact_child_nodes: () -> Array

copy(**params) Показать исходный код

# File lib/prism/node.rb, line 5320
def copy(**params)
  DefNode.new(
    params.fetch(:name) { name },
    params.fetch(:name_loc) { name_loc },
    params.fetch(:receiver) { receiver },
    params.fetch(:parameters) { parameters },
    params.fetch(:body) { body },
    params.fetch(:locals) { locals },
    params.fetch(:locals_body_index) { locals_body_index },
    params.fetch(:def_keyword_loc) { def_keyword_loc },
    params.fetch(:operator_loc) { operator_loc },
    params.fetch(:lparen_loc) { lparen_loc },
    params.fetch(:rparen_loc) { rparen_loc },
    params.fetch(:equal_loc) { equal_loc },
    params.fetch(:end_keyword_loc) { end_keyword_loc },
    params.fetch(:location) { location },
  )
end

def copy: (**params) -> DefNode

deconstruct()

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

Псевдоним для: child_nodes

deconstruct_keys(keys) Показать исходный код

# File lib/prism/node.rb, line 5343
def deconstruct_keys(keys)
  { name: name, name_loc: name_loc, receiver: receiver, parameters: parameters, body: body, locals: locals, locals_body_index: locals_body_index, def_keyword_loc: def_keyword_loc, operator_loc: operator_loc, lparen_loc: lparen_loc, rparen_loc: rparen_loc, equal_loc: equal_loc, end_keyword_loc: end_keyword_loc, location: location }
end

def_keyword() Показать исходный код

# File lib/prism/node.rb, line 5348
def def_keyword
  def_keyword_loc.slice
end

def def_keyword: () -> String

end_keyword() Показать исходный код

# File lib/prism/node.rb, line 5373
def end_keyword
  end_keyword_loc&.slice
end

def end_keyword: () -> String?

equal() Показать исходный код

# File lib/prism/node.rb, line 5368
def equal
  equal_loc&.slice
end

def equal: () -> String?

inspect(inspector = NodeInspector.new) Показать исходный код

# File lib/prism/node.rb, line 5378
def inspect(inspector = NodeInspector.new)
  inspector << inspector.header(self)
  inspector << "├── name: #{name.inspect}\n"
  inspector << "├── name_loc: #{inspector.location(name_loc)}\n"
  if (receiver = self.receiver).nil?
    inspector << "├── receiver: ∅\n"
  else
    inspector << "├── receiver:\n"
    inspector << receiver.inspect(inspector.child_inspector("│   ")).delete_prefix(inspector.prefix)
  end
  if (parameters = self.parameters).nil?
    inspector << "├── parameters: ∅\n"
  else
    inspector << "├── parameters:\n"
    inspector << parameters.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 << "├── locals: #{locals.inspect}\n"
  inspector << "├── locals_body_index: #{locals_body_index.inspect}\n"
  inspector << "├── def_keyword_loc: #{inspector.location(def_keyword_loc)}\n"
  inspector << "├── operator_loc: #{inspector.location(operator_loc)}\n"
  inspector << "├── lparen_loc: #{inspector.location(lparen_loc)}\n"
  inspector << "├── rparen_loc: #{inspector.location(rparen_loc)}\n"
  inspector << "├── equal_loc: #{inspector.location(equal_loc)}\n"
  inspector << "└── end_keyword_loc: #{inspector.location(end_keyword_loc)}\n"
  inspector.to_str
end

def inspect(inspector: NodeInspector) -> String

lparen() Показать исходный код

# File lib/prism/node.rb, line 5358
def lparen
  lparen_loc&.slice
end

def lparen: () -> String?

operator() Показать исходный код

# File lib/prism/node.rb, line 5353
def operator
  operator_loc&.slice
end

def operator: () -> String?

rparen() Показать исходный код

# File lib/prism/node.rb, line 5363
def rparen
  rparen_loc&.slice
end

def rparen: () -> String?

type() Показать исходный код

# File lib/prism/node.rb, line 5425
def type
  :def_node
end

Иногда нужно проверить экземпляр узла на соответствие списку классов, чтобы определить, какое поведение выполнить. Обычно это делается с помощью `[cls1, cls2].include?(node.class)` или размещения узла в операторе case и выполнения `case node; when cls1; when cls2; end`. Оба этих подхода относительно медленные из-за постоянных поисков, вызовов методов и/или выделения массивов.

Вместо этого вы можете вызвать type, который вернёт символ, который вы можете использовать для сравнения. Это быстрее, чем другие подходы, потому что использует одно целочисленное сравнение, а также потому, что если вы работаете с CRuby, вы можете воспользоваться тем, что операторы case со всеми символами-ключами используют таблицу переходов.

def type: () -> Symbol

Ruby Core © 1993–2022 Yukihiro Matsumoto
Licensed under the Ruby License.
Ruby Standard Library © contributors
Licensed under their own licenses.