Class: Prism::ParseResult::Newlines

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain: self, `::Prism::Visitor`, `::Prism::BasicVisitor`
Instance Chain: self, `::Prism::Visitor`, `::Prism::BasicVisitor`
Inherits:	Prism::Visitor `::Object` Prism::BasicVisitor Prism::Visitor Prism::ParseResult::Newlines
Defined in:	lib/prism/parse_result/newlines.rb

Overview

The :line tracepoint event gets fired whenever the Ruby VM encounters an expression on a new line. The types of expressions that can trigger this event are:

if statements
unless statements
nodes that are children of statements lists

In order to keep track of the newlines, we have a list of offsets that come back from the parser. We assign these offsets to the first nodes that we find in the tree that are on those lines.

Note that the logic in this file should be kept in sync with the Java MarkNewlinesVisitor, since that visitor is responsible for marking the newlines for JRuby/TruffleRuby.

This file is autoloaded only when #mark_newlines! is called, so the re-opening of the various nodes in this file will only be performed in that case. We do that to avoid storing the extra @newline instance variable on every node if we don’t need it.

Class Method Summary

.new(lines) ⇒ Newlines constructor

Create a new Newlines visitor with the given newline offsets.

Instance Method Summary

#visit_block_node(node) (also: #visit_lambda_node)

Permit block/lambda nodes to mark newlines within themselves.
#visit_if_node(node) (also: #visit_unless_node)

Mark if/unless nodes as newlines.
#visit_lambda_node(node)

Alias for #visit_block_node.
#visit_statements_node(node)

Permit statements lists to mark newlines within themselves.
#visit_unless_node(node)

Alias for #visit_if_node.

`::Prism::Visitor` - Inherited

#visit_alias_global_variable_node	Visit a `::Prism::AliasGlobalVariableNode` node.
#visit_alias_method_node	Visit a `::Prism::AliasMethodNode` node.
#visit_alternation_pattern_node	Visit a `::Prism::AlternationPatternNode` node.
#visit_and_node	Visit a `::Prism::AndNode` node.
#visit_arguments_node	Visit a `::Prism::ArgumentsNode` node.
#visit_array_node	Visit a `::Prism::ArrayNode` node.
#visit_array_pattern_node	Visit a `::Prism::ArrayPatternNode` node.
#visit_assoc_node	Visit a `::Prism::AssocNode` node.
#visit_assoc_splat_node	Visit a `::Prism::AssocSplatNode` node.
#visit_back_reference_read_node	Visit a `::Prism::BackReferenceReadNode` node.
#visit_begin_node	Visit a `::Prism::BeginNode` node.
#visit_block_argument_node	Visit a `::Prism::BlockArgumentNode` node.
#visit_block_local_variable_node	Visit a `::Prism::BlockLocalVariableNode` node.
#visit_block_node	Visit a `::Prism::BlockNode` node.
#visit_block_parameter_node	Visit a `::Prism::BlockParameterNode` node.
#visit_block_parameters_node	Visit a `::Prism::BlockParametersNode` node.
#visit_break_node	Visit a `::Prism::BreakNode` node.
#visit_call_and_write_node	Visit a `::Prism::CallAndWriteNode` node.
#visit_call_node	Visit a `::Prism::CallNode` node.
#visit_call_operator_write_node	Visit a `::Prism::CallOperatorWriteNode` node.
#visit_call_or_write_node	Visit a `::Prism::CallOrWriteNode` node.
#visit_call_target_node	Visit a `::Prism::CallTargetNode` node.
#visit_capture_pattern_node	Visit a `::Prism::CapturePatternNode` node.
#visit_case_match_node	Visit a `::Prism::CaseMatchNode` node.
#visit_case_node	Visit a `::Prism::CaseNode` node.
#visit_class_node	Visit a `::Prism::ClassNode` node.
#visit_class_variable_and_write_node	Visit a `::Prism::ClassVariableAndWriteNode` node.
#visit_class_variable_operator_write_node	Visit a `::Prism::ClassVariableOperatorWriteNode` node.
#visit_class_variable_or_write_node	Visit a `::Prism::ClassVariableOrWriteNode` node.
#visit_class_variable_read_node	Visit a `::Prism::ClassVariableReadNode` node.
#visit_class_variable_target_node	Visit a `::Prism::ClassVariableTargetNode` node.
#visit_class_variable_write_node	Visit a `::Prism::ClassVariableWriteNode` node.
#visit_constant_and_write_node	Visit a `::Prism::ConstantAndWriteNode` node.
#visit_constant_operator_write_node	Visit a `::Prism::ConstantOperatorWriteNode` node.
#visit_constant_or_write_node	Visit a `::Prism::ConstantOrWriteNode` node.
#visit_constant_path_and_write_node	Visit a `::Prism::ConstantPathAndWriteNode` node.
#visit_constant_path_node	Visit a `::Prism::ConstantPathNode` node.
#visit_constant_path_operator_write_node	Visit a `::Prism::ConstantPathOperatorWriteNode` node.
#visit_constant_path_or_write_node	Visit a `::Prism::ConstantPathOrWriteNode` node.
#visit_constant_path_target_node	Visit a `::Prism::ConstantPathTargetNode` node.
#visit_constant_path_write_node	Visit a `::Prism::ConstantPathWriteNode` node.
#visit_constant_read_node	Visit a `::Prism::ConstantReadNode` node.
#visit_constant_target_node	Visit a `::Prism::ConstantTargetNode` node.
#visit_constant_write_node	Visit a `::Prism::ConstantWriteNode` node.
#visit_def_node	Visit a `::Prism::DefNode` node.
#visit_defined_node	Visit a `::Prism::DefinedNode` node.
#visit_else_node	Visit a `::Prism::ElseNode` node.
#visit_embedded_statements_node	Visit a `::Prism::EmbeddedStatementsNode` node.
#visit_embedded_variable_node	Visit a `::Prism::EmbeddedVariableNode` node.
#visit_ensure_node	Visit a `::Prism::EnsureNode` node.
#visit_false_node	Visit a `::Prism::FalseNode` node.
#visit_find_pattern_node	Visit a `::Prism::FindPatternNode` node.
#visit_flip_flop_node	Visit a `::Prism::FlipFlopNode` node.
#visit_float_node	Visit a `::Prism::FloatNode` node.
#visit_for_node	Visit a `::Prism::ForNode` node.
#visit_forwarding_arguments_node	Visit a `::Prism::ForwardingArgumentsNode` node.
#visit_forwarding_parameter_node	Visit a `::Prism::ForwardingParameterNode` node.
#visit_forwarding_super_node	Visit a `::Prism::ForwardingSuperNode` node.
#visit_global_variable_and_write_node	Visit a `::Prism::GlobalVariableAndWriteNode` node.
#visit_global_variable_operator_write_node	Visit a `::Prism::GlobalVariableOperatorWriteNode` node.
#visit_global_variable_or_write_node	Visit a `::Prism::GlobalVariableOrWriteNode` node.
#visit_global_variable_read_node	Visit a `::Prism::GlobalVariableReadNode` node.
#visit_global_variable_target_node	Visit a `::Prism::GlobalVariableTargetNode` node.
#visit_global_variable_write_node	Visit a `::Prism::GlobalVariableWriteNode` node.
#visit_hash_node	Visit a `::Prism::HashNode` node.
#visit_hash_pattern_node	Visit a `::Prism::HashPatternNode` node.
#visit_if_node	Visit a `::Prism::IfNode` node.
#visit_imaginary_node	Visit a `::Prism::ImaginaryNode` node.
#visit_implicit_node	Visit a `::Prism::ImplicitNode` node.
#visit_implicit_rest_node	Visit a `::Prism::ImplicitRestNode` node.
#visit_in_node	Visit a `::Prism::InNode` node.
#visit_index_and_write_node	Visit a `::Prism::IndexAndWriteNode` node.
#visit_index_operator_write_node	Visit a `::Prism::IndexOperatorWriteNode` node.
#visit_index_or_write_node	Visit a `::Prism::IndexOrWriteNode` node.
#visit_index_target_node	Visit a `::Prism::IndexTargetNode` node.
#visit_instance_variable_and_write_node	Visit a `::Prism::InstanceVariableAndWriteNode` node.
#visit_instance_variable_operator_write_node	Visit a `::Prism::InstanceVariableOperatorWriteNode` node.
#visit_instance_variable_or_write_node	Visit a `::Prism::InstanceVariableOrWriteNode` node.
#visit_instance_variable_read_node	Visit a `::Prism::InstanceVariableReadNode` node.
#visit_instance_variable_target_node	Visit a `::Prism::InstanceVariableTargetNode` node.
#visit_instance_variable_write_node	Visit a `::Prism::InstanceVariableWriteNode` node.
#visit_integer_node	Visit a `::Prism::IntegerNode` node.
#visit_interpolated_match_last_line_node	Visit a `::Prism::InterpolatedMatchLastLineNode` node.
#visit_interpolated_regular_expression_node	Visit a `::Prism::InterpolatedRegularExpressionNode` node.
#visit_interpolated_string_node	Visit a `::Prism::InterpolatedStringNode` node.
#visit_interpolated_symbol_node	Visit a `::Prism::InterpolatedSymbolNode` node.
#visit_interpolated_x_string_node	Visit a `::Prism::InterpolatedXStringNode` node.
#visit_it_local_variable_read_node	Visit a `::Prism::ItLocalVariableReadNode` node.
#visit_it_parameters_node	Visit a `::Prism::ItParametersNode` node.
#visit_keyword_hash_node	Visit a `::Prism::KeywordHashNode` node.
#visit_keyword_rest_parameter_node	Visit a `::Prism::KeywordRestParameterNode` node.
#visit_lambda_node	Visit a `::Prism::LambdaNode` node.
#visit_local_variable_and_write_node	Visit a `::Prism::LocalVariableAndWriteNode` node.
#visit_local_variable_operator_write_node	Visit a `::Prism::LocalVariableOperatorWriteNode` node.
#visit_local_variable_or_write_node	Visit a `::Prism::LocalVariableOrWriteNode` node.
#visit_local_variable_read_node	Visit a `::Prism::LocalVariableReadNode` node.
#visit_local_variable_target_node	Visit a `::Prism::LocalVariableTargetNode` node.
#visit_local_variable_write_node	Visit a `::Prism::LocalVariableWriteNode` node.
#visit_match_last_line_node	Visit a `::Prism::MatchLastLineNode` node.
#visit_match_predicate_node	Visit a `::Prism::MatchPredicateNode` node.
#visit_match_required_node	Visit a `::Prism::MatchRequiredNode` node.
#visit_match_write_node	Visit a `::Prism::MatchWriteNode` node.
#visit_missing_node	Visit a `::Prism::MissingNode` node.
#visit_module_node	Visit a `::Prism::ModuleNode` node.
#visit_multi_target_node	Visit a `::Prism::MultiTargetNode` node.
#visit_multi_write_node	Visit a `::Prism::MultiWriteNode` node.
#visit_next_node	Visit a `::Prism::NextNode` node.
#visit_nil_node	Visit a `::Prism::NilNode` node.
#visit_no_keywords_parameter_node	Visit a `::Prism::NoKeywordsParameterNode` node.
#visit_numbered_parameters_node	Visit a `::Prism::NumberedParametersNode` node.
#visit_numbered_reference_read_node	Visit a `::Prism::NumberedReferenceReadNode` node.
#visit_optional_keyword_parameter_node	Visit a `::Prism::OptionalKeywordParameterNode` node.
#visit_optional_parameter_node	Visit a `::Prism::OptionalParameterNode` node.
#visit_or_node	Visit a `::Prism::OrNode` node.
#visit_parameters_node	Visit a `::Prism::ParametersNode` node.
#visit_parentheses_node	Visit a `::Prism::ParenthesesNode` node.
#visit_pinned_expression_node	Visit a `::Prism::PinnedExpressionNode` node.
#visit_pinned_variable_node	Visit a `::Prism::PinnedVariableNode` node.
#visit_post_execution_node	Visit a `::Prism::PostExecutionNode` node.
#visit_pre_execution_node	Visit a `::Prism::PreExecutionNode` node.
#visit_program_node	Visit a `::Prism::ProgramNode` node.
#visit_range_node	Visit a `::Prism::RangeNode` node.
#visit_rational_node	Visit a `::Prism::RationalNode` node.
#visit_redo_node	Visit a `::Prism::RedoNode` node.
#visit_regular_expression_node	Visit a `::Prism::RegularExpressionNode` node.
#visit_required_keyword_parameter_node	Visit a `::Prism::RequiredKeywordParameterNode` node.
#visit_required_parameter_node	Visit a `::Prism::RequiredParameterNode` node.
#visit_rescue_modifier_node	Visit a `::Prism::RescueModifierNode` node.
#visit_rescue_node	Visit a `::Prism::RescueNode` node.
#visit_rest_parameter_node	Visit a `::Prism::RestParameterNode` node.
#visit_retry_node	Visit a `::Prism::RetryNode` node.
#visit_return_node	Visit a `::Prism::ReturnNode` node.
#visit_self_node	Visit a `::Prism::SelfNode` node.
#visit_shareable_constant_node	Visit a `::Prism::ShareableConstantNode` node.
#visit_singleton_class_node	Visit a `::Prism::SingletonClassNode` node.
#visit_source_encoding_node	Visit a `::Prism::SourceEncodingNode` node.
#visit_source_file_node	Visit a `::Prism::SourceFileNode` node.
#visit_source_line_node	Visit a `::Prism::SourceLineNode` node.
#visit_splat_node	Visit a `::Prism::SplatNode` node.
#visit_statements_node	Visit a `::Prism::StatementsNode` node.
#visit_string_node	Visit a `::Prism::StringNode` node.
#visit_super_node	Visit a `::Prism::SuperNode` node.
#visit_symbol_node	Visit a `::Prism::SymbolNode` node.
#visit_true_node	Visit a `::Prism::TrueNode` node.
#visit_undef_node	Visit a `::Prism::UndefNode` node.
#visit_unless_node	Visit a `::Prism::UnlessNode` node.
#visit_until_node	Visit a `::Prism::UntilNode` node.
#visit_when_node	Visit a `::Prism::WhenNode` node.
#visit_while_node	Visit a `::Prism::WhileNode` node.
#visit_x_string_node	Visit a `::Prism::XStringNode` node.
#visit_yield_node	Visit a `::Prism::YieldNode` node.

`::Prism::BasicVisitor` - Inherited

#visit	Calls `accept` on the given node if it is not `nil`, which in turn should call back into this visitor by calling the appropriate `visit_*` method.
#visit_all	Visits each node in `nodes` by calling `accept` on each one.
#visit_child_nodes	Visits the child nodes of `node` by calling `accept` on each one.

Constructor Details

.new(lines) ⇒ `Newlines`

Create a new Newlines visitor with the given newline offsets.

[ GitHub ]

# File 'lib/prism/parse_result/newlines.rb', line 28


def initialize(lines)
  # @type var lines: Integer
  @lines = Array.new(1 + lines, false)
end

Instance Method Details

#visit_block_node(node) Also known as: #visit_lambda_node

Permit block/lambda nodes to mark newlines within themselves.

[ GitHub ]

# File 'lib/prism/parse_result/newlines.rb', line 34


def visit_block_node(node)
  old_lines = @lines
  @lines = Array.new(old_lines.size, false)

  begin
    super(node)
  ensure
    @lines = old_lines
  end
end

#visit_if_node(node) Also known as: #visit_unless_node

Mark if/unless nodes as newlines.

[ GitHub ]

# File 'lib/prism/parse_result/newlines.rb', line 48


def visit_if_node(node)
  node.newline_flag!(@lines)
  super(node)
end

#visit_lambda_node(node)

Alias for #visit_block_node.

[ GitHub ]

# File 'lib/prism/parse_result/newlines.rb', line 45


alias_method :visit_lambda_node, :visit_block_node

#visit_statements_node(node)

Permit statements lists to mark newlines within themselves.

[ GitHub ]

# File 'lib/prism/parse_result/newlines.rb', line 56


def visit_statements_node(node)
  node.body.each do |child|
    child.newline_flag!(@lines)
  end
  super(node)
end

#visit_unless_node(node)

Alias for #visit_if_node.

[ GitHub ]

# File 'lib/prism/parse_result/newlines.rb', line 53


alias_method :visit_unless_node, :visit_if_node

Class: Prism::ParseResult::Newlines

Overview

Class Method Summary

Instance Method Summary

::Prism::Visitor - Inherited

::Prism::BasicVisitor - Inherited

Constructor Details

.new(lines) ⇒ Newlines

Instance Method Details

#visit_block_node(node) Also known as: #visit_lambda_node

#visit_if_node(node) Also known as: #visit_unless_node

#visit_lambda_node(node)

#visit_statements_node(node)

#visit_unless_node(node)

`::Prism::Visitor` - Inherited

`::Prism::BasicVisitor` - Inherited

.new(lines) ⇒ `Newlines`