class Prism::Node

要約

構文解析の結果得られる構文木の各ノードを表す抽象基底クラスです。 Prism.#parse などが返す構文木は、このクラスのサブクラス (150 種類以上)のインスタンスで構成されます。Prism::Node 自身のインスタンスが生成されることはありません。

個々のノードクラス(Prism::ProgramNode・Prism::CallNode など)に固有のフィールド(子ノードや値を取得するアクセサ)は、このページ末尾の ノードクラスの一覧 に名前だけを載せ、個別のエントリは作りません。このページで扱うのは、すべてのノードクラスに共通する API です。個々のノードクラスの詳細は公式ドキュメントを参照してください。

• プロジェクトページ: https://github.com/ruby/prism
• リファレンス(YARD): https://www.rubydoc.info/gems/prism
• ドキュメントサイト: https://ruby.github.io/prism/

require "prism"

node = Prism.parse("1 + 2").value
p node.type           # => :program_node
p node.class          # => Prism::ProgramNode
p node.location.slice # => "1 + 2"

call = node.statements.body[0]
p call.type                    # => :call_node
p call.child_nodes.size        # => 3
p call.compact_child_nodes.size # => 2

[SEE_ALSO] Prism::ParseResult, Prism::Location

目次

インスタンスメソッド

• copy
• deconstruct_keys
• inspect
• location
• newline?
• pretty_print
• set_newline_flag
• slice
• to_dot

インスタンスメソッド

copy(**params) -> Prism::NodeRuby 3.3 から[permalink][rdoc][edit]

自身と同じクラスの新しいノードを、指定したフィールドだけを差し替えて複製します。渡せるキーワードはノードクラスごとのフィールド名で、指定しなかったフィールドは自身の値を引き継ぎます。

例

require "prism"

call = Prism.parse("1 + 2").value.statements.body[0]
copied = call.copy
p copied.class        # => Prism::CallNode
p copied.equal?(call) # => false

deconstruct_keys(keys) -> HashRuby 3.3 から[permalink][rdoc][edit]

パターンマッチのハッシュパターン(case node; in {value:})で使われます。ノードの各フィールドをキーに持つハッシュを返します。

[PARAM] keys:

取り出したいキーの配列。すべて取り出す場合は nil を指定します。

inspect(inspector = NodeInspector.new) -> StringRuby 3.3 から[permalink][rdoc][edit]

構文木をツリー形式で表した、人間が読みやすい文字列を返します。

inspector は内部実装用の引数なので、通常は省略してください。

例

require "prism"

puts Prism.parse("1 + 2").value.inspect

location -> Prism::LocationRuby 3.3 から[permalink][rdoc][edit]

ノードのソースコード上の位置を表す Prism::Location を返します。

newline? -> boolRuby 3.3 から[permalink][rdoc][edit]

このノードが、TracePoint の :line イベントを発生させる行の位置としてマークされているかどうかを返します。

ノードクラスの一覧

prism の各ノードクラス(Prism::Node のサブクラス)と、そのフィールド(子ノードや値を取得するアクセサ)の名前の一覧です。 prism の config.yml(3.3= prism 0.19.0・3.4= 1.2.0・4.0= 1.7.0・4.1= 1.9.0)から機械的に生成しています。フィールドの構成が版によって異なるノードは、版ごとに行を分けています。各フィールドの意味は公式ドキュメントを参照してください。

ノードクラス	フィールド
AliasGlobalVariableNode	new_name, old_name, keyword_loc
AliasMethodNode	new_name, old_name, keyword_loc
AlternationPatternNode	left, right, operator_loc
AndNode	left, right, operator_loc
ArgumentsNode	flags, arguments
ArrayNode	flags, elements, opening_loc, closing_loc
ArrayPatternNode	constant, requireds, rest, posts, opening_loc, closing_loc
AssocNode	key, value, operator_loc
AssocSplatNode	value, operator_loc
BackReferenceReadNode	name
BeginNode	begin_keyword_loc, statements, rescue_clause, else_clause, ensure_clause, end_keyword_loc
BlockArgumentNode	expression, operator_loc
BlockLocalVariableNode	name
BlockNode	locals, locals_body_index, parameters, body, opening_loc, closing_loc
BlockParameterNode	name, name_loc, operator_loc
BlockParametersNode	parameters, locals, opening_loc, closing_loc
BreakNode	arguments, keyword_loc
CallAndWriteNode	flags, receiver, call_operator_loc, message_loc, read_name, write_name, operator_loc, value
CallNode	flags, receiver, call_operator_loc, name, message_loc, opening_loc, arguments, closing_loc, block
CallOperatorWriteNode	flags, receiver, call_operator_loc, message_loc, read_name, write_name, operator, operator_loc, value
CallOrWriteNode	flags, receiver, call_operator_loc, message_loc, read_name, write_name, operator_loc, value
CallTargetNode	flags, receiver, call_operator_loc, name, message_loc
CapturePatternNode	value, target, operator_loc
CaseMatchNode	predicate, conditions, consequent, case_keyword_loc, end_keyword_loc
CaseNode	predicate, conditions, consequent, case_keyword_loc, end_keyword_loc
ClassNode	locals, class_keyword_loc, constant_path, inheritance_operator_loc, superclass, body, end_keyword_loc, name
ClassVariableAndWriteNode	name, name_loc, operator_loc, value
ClassVariableOperatorWriteNode	name, name_loc, operator_loc, value, operator
ClassVariableOrWriteNode	name, name_loc, operator_loc, value
ClassVariableReadNode	name
ClassVariableTargetNode	name
ClassVariableWriteNode	name, name_loc, value, operator_loc
ConstantAndWriteNode	name, name_loc, operator_loc, value
ConstantOperatorWriteNode	name, name_loc, operator_loc, value, operator
ConstantOrWriteNode	name, name_loc, operator_loc, value
ConstantPathAndWriteNode	target, operator_loc, value
ConstantPathNode	parent, child, delimiter_loc
ConstantPathOperatorWriteNode	target, operator_loc, value, operator
ConstantPathOrWriteNode	target, operator_loc, value
ConstantPathTargetNode	parent, child, delimiter_loc
ConstantPathWriteNode	target, operator_loc, value
ConstantReadNode	name
ConstantTargetNode	name
ConstantWriteNode	name, name_loc, value, operator_loc
DefNode	name, name_loc, receiver, parameters, body, locals, locals_body_index, def_keyword_loc, operator_loc, lparen_loc, rparen_loc, equal_loc, end_keyword_loc
DefinedNode	lparen_loc, value, rparen_loc, keyword_loc
ElseNode	else_keyword_loc, statements, end_keyword_loc
EmbeddedStatementsNode	opening_loc, statements, closing_loc
EmbeddedVariableNode	operator_loc, variable
EnsureNode	ensure_keyword_loc, statements, end_keyword_loc
FalseNode	(なし)
FindPatternNode	constant, left, requireds, right, opening_loc, closing_loc
FlipFlopNode	flags, left, right, operator_loc
FloatNode	(なし)
ForNode	index, collection, statements, for_keyword_loc, in_keyword_loc, do_keyword_loc, end_keyword_loc
ForwardingArgumentsNode	(なし)
ForwardingParameterNode	(なし)
ForwardingSuperNode	block
GlobalVariableAndWriteNode	name, name_loc, operator_loc, value
GlobalVariableOperatorWriteNode	name, name_loc, operator_loc, value, operator
GlobalVariableOrWriteNode	name, name_loc, operator_loc, value
GlobalVariableReadNode	name
GlobalVariableTargetNode	name
GlobalVariableWriteNode	name, name_loc, value, operator_loc
HashNode	opening_loc, elements, closing_loc
HashPatternNode	constant, elements, rest, opening_loc, closing_loc
IfNode	if_keyword_loc, predicate, then_keyword_loc, statements, consequent, end_keyword_loc
ImaginaryNode	numeric
ImplicitNode	value
ImplicitRestNode	(なし)
InNode	pattern, statements, in_loc, then_loc
IndexAndWriteNode	flags, receiver, call_operator_loc, opening_loc, arguments, closing_loc, block, operator_loc, value
IndexOperatorWriteNode	flags, receiver, call_operator_loc, opening_loc, arguments, closing_loc, block, operator, operator_loc, value
IndexOrWriteNode	flags, receiver, call_operator_loc, opening_loc, arguments, closing_loc, block, operator_loc, value
IndexTargetNode	flags, receiver, opening_loc, arguments, closing_loc, block
InstanceVariableAndWriteNode	name, name_loc, operator_loc, value
InstanceVariableOperatorWriteNode	name, name_loc, operator_loc, value, operator
InstanceVariableOrWriteNode	name, name_loc, operator_loc, value
InstanceVariableReadNode	name
InstanceVariableTargetNode	name
InstanceVariableWriteNode	name, name_loc, value, operator_loc
IntegerNode	flags
InterpolatedMatchLastLineNode	flags, opening_loc, parts, closing_loc
InterpolatedRegularExpressionNode	flags, opening_loc, parts, closing_loc
InterpolatedStringNode	opening_loc, parts, closing_loc
InterpolatedSymbolNode	opening_loc, parts, closing_loc
InterpolatedXStringNode	opening_loc, parts, closing_loc
KeywordHashNode	flags, elements
KeywordRestParameterNode	name, name_loc, operator_loc
LambdaNode	locals, locals_body_index, operator_loc, opening_loc, closing_loc, parameters, body
LocalVariableAndWriteNode	name_loc, operator_loc, value, name, depth
LocalVariableOperatorWriteNode	name_loc, operator_loc, value, name, operator, depth
LocalVariableOrWriteNode	name_loc, operator_loc, value, name, depth
LocalVariableReadNode	name, depth
LocalVariableTargetNode	name, depth
LocalVariableWriteNode	name, depth, name_loc, value, operator_loc
MatchLastLineNode	flags, opening_loc, content_loc, closing_loc, unescaped
MatchPredicateNode	value, pattern, operator_loc
MatchRequiredNode	value, pattern, operator_loc
MatchWriteNode	call, targets
MissingNode	(なし)
ModuleNode	locals, module_keyword_loc, constant_path, body, end_keyword_loc, name
MultiTargetNode	lefts, rest, rights, lparen_loc, rparen_loc
MultiWriteNode	lefts, rest, rights, lparen_loc, rparen_loc, operator_loc, value
NextNode	arguments, keyword_loc
NilNode	(なし)
NoKeywordsParameterNode	operator_loc, keyword_loc
NumberedParametersNode	maximum
NumberedReferenceReadNode	number
OptionalKeywordParameterNode	name, name_loc, value
OptionalParameterNode	name, name_loc, operator_loc, value
OrNode	left, right, operator_loc
ParametersNode	requireds, optionals, rest, posts, keywords, keyword_rest, block
ParenthesesNode	body, opening_loc, closing_loc
PinnedExpressionNode	expression, operator_loc, lparen_loc, rparen_loc
PinnedVariableNode	variable, operator_loc
PostExecutionNode	statements, keyword_loc, opening_loc, closing_loc
PreExecutionNode	statements, keyword_loc, opening_loc, closing_loc
ProgramNode	locals, statements
RangeNode	flags, left, right, operator_loc
RationalNode	numeric
RedoNode	(なし)
RegularExpressionNode	flags, opening_loc, content_loc, closing_loc, unescaped
RequiredKeywordParameterNode	name, name_loc
RequiredParameterNode	name
RescueModifierNode	expression, keyword_loc, rescue_expression
RescueNode	keyword_loc, exceptions, operator_loc, reference, statements, consequent
RestParameterNode	name, name_loc, operator_loc
RetryNode	(なし)
ReturnNode	keyword_loc, arguments
SelfNode	(なし)
SingletonClassNode	locals, class_keyword_loc, operator_loc, expression, body, end_keyword_loc
SourceEncodingNode	(なし)
SourceFileNode	filepath
SourceLineNode	(なし)
SplatNode	operator_loc, expression
StatementsNode	body
StringNode	flags, opening_loc, content_loc, closing_loc, unescaped
SuperNode	keyword_loc, lparen_loc, arguments, rparen_loc, block
SymbolNode	flags, opening_loc, value_loc, closing_loc, unescaped
TrueNode	(なし)
UndefNode	names, keyword_loc
UnlessNode	keyword_loc, predicate, then_keyword_loc, statements, consequent, end_keyword_loc
UntilNode	flags, keyword_loc, closing_loc, predicate, statements
WhenNode	keyword_loc, conditions, statements
WhileNode	flags, keyword_loc, closing_loc, predicate, statements
XStringNode	flags, opening_loc, content_loc, closing_loc, unescaped
YieldNode	keyword_loc, lparen_loc, arguments, rparen_loc

pretty_print(q) -> ()Ruby 3.3 から[permalink][rdoc][edit]

pp ライブラリからの呼び出しに対応します。Prism::Node#inspect の出力を、現在のインデントレベルを保ったまま表示します。

set_newline_flag(newline_marked) -> ()Ruby 3.3 から Ruby 3.4 で削除[permalink][rdoc][edit]

このノードの開始行にまだ印が付けられていなければ、Prism::Node#newline? が true を返すように印を付けます。

newline_marked は行番号をインデックスとする真偽値の配列です。Prism::ParseResult#mark_newlines! が構文木を巡回する際に、行ごとに最初に見つかったノードだけに印を付けるために内部で使用します。

[PARAM] newline_marked:

行番号をインデックスとする真偽値の配列を指定します。すでに印が付いている行には true が入っています。

[SEE_ALSO] Prism::Node#newline?

slice -> StringRuby 3.3 から[permalink][rdoc][edit]

ノードの位置に対応するソースコードの文字列を返します。 location.slice と同じです。

to_dot -> StringRuby 3.3 から[permalink][rdoc][edit]

構文木を Graphviz の DOT 言語形式の文字列に変換します。

例

require "prism"

dot = Prism.parse("1 + 2").value.to_dot
p dot.start_with?("digraph") # => true