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)

Permit block nodes to mark newlines within themselves.
#visit_class_node(node)

Permit class nodes to mark newlines within themselves.
#visit_def_node(node)

Permit def nodes to mark newlines within themselves.
#visit_embedded_statements_node(node)

Statements inside string interpolation do not emit newline events, so mark every line as already seen while visiting them.
#visit_if_node(node)

Mark if nodes as newlines.
#visit_lambda_node(node)

Permit lambda nodes to mark newlines within themselves.
#visit_module_node(node)

Permit module nodes to mark newlines within themselves.
#visit_singleton_class_node(node)

Permit singleton class nodes to mark newlines within themselves.
#visit_statements_node(node)

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

Mark unless nodes as newlines.
#visit_until_node(node)

The predicate of an until loop is compiled at the end of the loop, after the body, so any statements it contains (from parentheses) emit their line events again even if the lines were already seen.
#visit_while_node(node)

The predicate of a while loop is compiled at the end of the loop, after the body, so any statements it contains (from parentheses) emit their line events again even if the lines were already seen.

`::Prism::Visitor` - Inherited

#visit_alias_global_variable_node	Alias for BasicVisitor#visit_child_nodes.
#visit_alias_method_node	Alias for BasicVisitor#visit_child_nodes.
#visit_alternation_pattern_node	Alias for BasicVisitor#visit_child_nodes.
#visit_and_node	Alias for BasicVisitor#visit_child_nodes.
#visit_arguments_node	Alias for BasicVisitor#visit_child_nodes.
#visit_array_node	Alias for BasicVisitor#visit_child_nodes.
#visit_array_pattern_node	Alias for BasicVisitor#visit_child_nodes.
#visit_assoc_node	Alias for BasicVisitor#visit_child_nodes.
#visit_assoc_splat_node	Alias for BasicVisitor#visit_child_nodes.
#visit_back_reference_read_node	Alias for BasicVisitor#visit_child_nodes.
#visit_begin_node	Alias for BasicVisitor#visit_child_nodes.
#visit_block_argument_node	Alias for BasicVisitor#visit_child_nodes.
#visit_block_local_variable_node	Alias for BasicVisitor#visit_child_nodes.
#visit_block_node	Alias for BasicVisitor#visit_child_nodes.
#visit_block_parameter_node	Alias for BasicVisitor#visit_child_nodes.
#visit_block_parameters_node	Alias for BasicVisitor#visit_child_nodes.
#visit_break_node	Alias for BasicVisitor#visit_child_nodes.
#visit_call_and_write_node	Alias for BasicVisitor#visit_child_nodes.
#visit_call_node	Alias for BasicVisitor#visit_child_nodes.
#visit_call_operator_write_node	Alias for BasicVisitor#visit_child_nodes.
#visit_call_or_write_node	Alias for BasicVisitor#visit_child_nodes.
#visit_call_target_node	Alias for BasicVisitor#visit_child_nodes.
#visit_capture_pattern_node	Alias for BasicVisitor#visit_child_nodes.
#visit_case_match_node	Alias for BasicVisitor#visit_child_nodes.
#visit_case_node	Alias for BasicVisitor#visit_child_nodes.
#visit_class_node	Alias for BasicVisitor#visit_child_nodes.
#visit_class_variable_and_write_node	Alias for BasicVisitor#visit_child_nodes.
#visit_class_variable_operator_write_node	Alias for BasicVisitor#visit_child_nodes.
#visit_class_variable_or_write_node	Alias for BasicVisitor#visit_child_nodes.
#visit_class_variable_read_node	Alias for BasicVisitor#visit_child_nodes.
#visit_class_variable_target_node	Alias for BasicVisitor#visit_child_nodes.
#visit_class_variable_write_node	Alias for BasicVisitor#visit_child_nodes.
#visit_constant_and_write_node	Alias for BasicVisitor#visit_child_nodes.
#visit_constant_operator_write_node	Alias for BasicVisitor#visit_child_nodes.
#visit_constant_or_write_node	Alias for BasicVisitor#visit_child_nodes.
#visit_constant_path_and_write_node	Alias for BasicVisitor#visit_child_nodes.
#visit_constant_path_node	Alias for BasicVisitor#visit_child_nodes.
#visit_constant_path_operator_write_node	Alias for BasicVisitor#visit_child_nodes.
#visit_constant_path_or_write_node	Alias for BasicVisitor#visit_child_nodes.
#visit_constant_path_target_node	Alias for BasicVisitor#visit_child_nodes.
#visit_constant_path_write_node	Alias for BasicVisitor#visit_child_nodes.
#visit_constant_read_node	Alias for BasicVisitor#visit_child_nodes.
#visit_constant_target_node	Alias for BasicVisitor#visit_child_nodes.
#visit_constant_write_node	Alias for BasicVisitor#visit_child_nodes.
#visit_def_node	Alias for BasicVisitor#visit_child_nodes.
#visit_defined_node	Alias for BasicVisitor#visit_child_nodes.
#visit_else_node	Alias for BasicVisitor#visit_child_nodes.
#visit_embedded_statements_node	Alias for BasicVisitor#visit_child_nodes.
#visit_embedded_variable_node	Alias for BasicVisitor#visit_child_nodes.
#visit_ensure_node	Alias for BasicVisitor#visit_child_nodes.
#visit_false_node	Alias for BasicVisitor#visit_child_nodes.
#visit_find_pattern_node	Alias for BasicVisitor#visit_child_nodes.
#visit_flip_flop_node	Alias for BasicVisitor#visit_child_nodes.
#visit_float_node	Alias for BasicVisitor#visit_child_nodes.
#visit_for_node	Alias for BasicVisitor#visit_child_nodes.
#visit_forwarding_arguments_node	Alias for BasicVisitor#visit_child_nodes.
#visit_forwarding_parameter_node	Alias for BasicVisitor#visit_child_nodes.
#visit_forwarding_super_node	Alias for BasicVisitor#visit_child_nodes.
#visit_global_variable_and_write_node	Alias for BasicVisitor#visit_child_nodes.
#visit_global_variable_operator_write_node	Alias for BasicVisitor#visit_child_nodes.
#visit_global_variable_or_write_node	Alias for BasicVisitor#visit_child_nodes.
#visit_global_variable_read_node	Alias for BasicVisitor#visit_child_nodes.
#visit_global_variable_target_node	Alias for BasicVisitor#visit_child_nodes.
#visit_global_variable_write_node	Alias for BasicVisitor#visit_child_nodes.
#visit_hash_node	Alias for BasicVisitor#visit_child_nodes.
#visit_hash_pattern_node	Alias for BasicVisitor#visit_child_nodes.
#visit_if_node	Alias for BasicVisitor#visit_child_nodes.
#visit_imaginary_node	Alias for BasicVisitor#visit_child_nodes.
#visit_implicit_node	Alias for BasicVisitor#visit_child_nodes.
#visit_implicit_rest_node	Alias for BasicVisitor#visit_child_nodes.
#visit_in_node	Alias for BasicVisitor#visit_child_nodes.
#visit_index_and_write_node	Alias for BasicVisitor#visit_child_nodes.
#visit_index_operator_write_node	Alias for BasicVisitor#visit_child_nodes.
#visit_index_or_write_node	Alias for BasicVisitor#visit_child_nodes.
#visit_index_target_node	Alias for BasicVisitor#visit_child_nodes.
#visit_instance_variable_and_write_node	Alias for BasicVisitor#visit_child_nodes.
#visit_instance_variable_operator_write_node	Alias for BasicVisitor#visit_child_nodes.
#visit_instance_variable_or_write_node	Alias for BasicVisitor#visit_child_nodes.
#visit_instance_variable_read_node	Alias for BasicVisitor#visit_child_nodes.
#visit_instance_variable_target_node	Alias for BasicVisitor#visit_child_nodes.
#visit_instance_variable_write_node	Alias for BasicVisitor#visit_child_nodes.
#visit_integer_node	Alias for BasicVisitor#visit_child_nodes.
#visit_interpolated_match_last_line_node	Alias for BasicVisitor#visit_child_nodes.
#visit_interpolated_regular_expression_node	Alias for BasicVisitor#visit_child_nodes.
#visit_interpolated_string_node	Alias for BasicVisitor#visit_child_nodes.
#visit_interpolated_symbol_node	Alias for BasicVisitor#visit_child_nodes.
#visit_interpolated_x_string_node	Alias for BasicVisitor#visit_child_nodes.
#visit_it_local_variable_read_node	Alias for BasicVisitor#visit_child_nodes.
#visit_it_parameters_node	Alias for BasicVisitor#visit_child_nodes.
#visit_keyword_hash_node	Alias for BasicVisitor#visit_child_nodes.
#visit_keyword_rest_parameter_node	Alias for BasicVisitor#visit_child_nodes.
#visit_lambda_node	Alias for BasicVisitor#visit_child_nodes.
#visit_local_variable_and_write_node	Alias for BasicVisitor#visit_child_nodes.
#visit_local_variable_operator_write_node	Alias for BasicVisitor#visit_child_nodes.
#visit_local_variable_or_write_node	Alias for BasicVisitor#visit_child_nodes.
#visit_local_variable_read_node	Alias for BasicVisitor#visit_child_nodes.
#visit_local_variable_target_node	Alias for BasicVisitor#visit_child_nodes.
#visit_local_variable_write_node	Alias for BasicVisitor#visit_child_nodes.
#visit_match_last_line_node	Alias for BasicVisitor#visit_child_nodes.
#visit_match_predicate_node	Alias for BasicVisitor#visit_child_nodes.
#visit_match_required_node	Alias for BasicVisitor#visit_child_nodes.
#visit_match_write_node	Alias for BasicVisitor#visit_child_nodes.
#visit_missing_node	Alias for BasicVisitor#visit_child_nodes.
#visit_module_node	Alias for BasicVisitor#visit_child_nodes.
#visit_multi_target_node	Alias for BasicVisitor#visit_child_nodes.
#visit_multi_write_node	Alias for BasicVisitor#visit_child_nodes.
#visit_next_node	Alias for BasicVisitor#visit_child_nodes.
#visit_nil_node	Alias for BasicVisitor#visit_child_nodes.
#visit_no_keywords_parameter_node	Alias for BasicVisitor#visit_child_nodes.
#visit_numbered_parameters_node	Alias for BasicVisitor#visit_child_nodes.
#visit_numbered_reference_read_node	Alias for BasicVisitor#visit_child_nodes.
#visit_optional_keyword_parameter_node	Alias for BasicVisitor#visit_child_nodes.
#visit_optional_parameter_node	Alias for BasicVisitor#visit_child_nodes.
#visit_or_node	Alias for BasicVisitor#visit_child_nodes.
#visit_parameters_node	Alias for BasicVisitor#visit_child_nodes.
#visit_parentheses_node	Alias for BasicVisitor#visit_child_nodes.
#visit_pinned_expression_node	Alias for BasicVisitor#visit_child_nodes.
#visit_pinned_variable_node	Alias for BasicVisitor#visit_child_nodes.
#visit_post_execution_node	Alias for BasicVisitor#visit_child_nodes.
#visit_pre_execution_node	Alias for BasicVisitor#visit_child_nodes.
#visit_program_node	Alias for BasicVisitor#visit_child_nodes.
#visit_range_node	Alias for BasicVisitor#visit_child_nodes.
#visit_rational_node	Alias for BasicVisitor#visit_child_nodes.
#visit_redo_node	Alias for BasicVisitor#visit_child_nodes.
#visit_regular_expression_node	Alias for BasicVisitor#visit_child_nodes.
#visit_required_keyword_parameter_node	Alias for BasicVisitor#visit_child_nodes.
#visit_required_parameter_node	Alias for BasicVisitor#visit_child_nodes.
#visit_rescue_modifier_node	Alias for BasicVisitor#visit_child_nodes.
#visit_rescue_node	Alias for BasicVisitor#visit_child_nodes.
#visit_rest_parameter_node	Alias for BasicVisitor#visit_child_nodes.
#visit_retry_node	Alias for BasicVisitor#visit_child_nodes.
#visit_return_node	Alias for BasicVisitor#visit_child_nodes.
#visit_self_node	Alias for BasicVisitor#visit_child_nodes.
#visit_shareable_constant_node	Alias for BasicVisitor#visit_child_nodes.
#visit_singleton_class_node	Alias for BasicVisitor#visit_child_nodes.
#visit_source_encoding_node	Alias for BasicVisitor#visit_child_nodes.
#visit_source_file_node	Alias for BasicVisitor#visit_child_nodes.
#visit_source_line_node	Alias for BasicVisitor#visit_child_nodes.
#visit_splat_node	Alias for BasicVisitor#visit_child_nodes.
#visit_statements_node	Alias for BasicVisitor#visit_child_nodes.
#visit_string_node	Alias for BasicVisitor#visit_child_nodes.
#visit_super_node	Alias for BasicVisitor#visit_child_nodes.
#visit_symbol_node	Alias for BasicVisitor#visit_child_nodes.
#visit_true_node	Alias for BasicVisitor#visit_child_nodes.
#visit_undef_node	Alias for BasicVisitor#visit_child_nodes.
#visit_unless_node	Alias for BasicVisitor#visit_child_nodes.
#visit_until_node	Alias for BasicVisitor#visit_child_nodes.
#visit_when_node	Alias for BasicVisitor#visit_child_nodes.
#visit_while_node	Alias for BasicVisitor#visit_child_nodes.
#visit_x_string_node	Alias for BasicVisitor#visit_child_nodes.
#visit_yield_node	Alias for BasicVisitor#visit_child_nodes.

`::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.

: (Integer lines) -> void

[ GitHub ]

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


def initialize(lines)
  @lines = Array.new(1 + lines, false)
end

Instance Method Details

#visit_block_node(node)

Permit block nodes to mark newlines within themselves.

: (BlockNode node) -> void

[ GitHub ]

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


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_class_node(node)

Permit class nodes to mark newlines within themselves.

: (ClassNode node) -> void

[ GitHub ]

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


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

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

#visit_def_node(node)

Permit def nodes to mark newlines within themselves. The body of an endless method definition never emits newline events, so in that case mark every line as already seen while visiting it instead. Nested scopes (blocks, lambdas, etc.) reset the lines and emit events again.

: (DefNode node) -> void

[ GitHub ]

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


def visit_def_node(node)
  old_lines = @lines
  @lines = Array.new(old_lines.size, !node.equal_loc.nil?)

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

#visit_embedded_statements_node(node)

Statements inside string interpolation do not emit newline events, so mark every line as already seen while visiting them. Nested scopes (blocks, lambdas, defs, etc.) reset the lines and emit events again.

: (EmbeddedStatementsNode node) -> void

[ GitHub ]

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


def visit_embedded_statements_node(node)
  old_lines = @lines
  @lines = Array.new(old_lines.size, true)

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

#visit_if_node(node)

Mark if nodes as newlines.

: (IfNode node) -> void

[ GitHub ]

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


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

#visit_lambda_node(node)

Permit lambda nodes to mark newlines within themselves.

: (LambdaNode node) -> void

[ GitHub ]

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


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

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

#visit_module_node(node)

Permit module nodes to mark newlines within themselves.

: (ModuleNode node) -> void

[ GitHub ]

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


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

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

#visit_singleton_class_node(node)

Permit singleton class nodes to mark newlines within themselves.

: (SingletonClassNode node) -> void

[ GitHub ]

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


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

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

#visit_statements_node(node)

Permit statements lists to mark newlines within themselves.

: (StatementsNode node) -> void

[ GitHub ]

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


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

#visit_unless_node(node)

Mark unless nodes as newlines.

: (UnlessNode node) -> void

[ GitHub ]

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


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

#visit_until_node(node)

The predicate of an until loop is compiled at the end of the loop, after the body, so any statements it contains (from parentheses) emit their line events again even if the lines were already seen.

: (UntilNode node) -> void

[ GitHub ]

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


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

  begin
    visit(node.predicate)
  ensure
    @lines = old_lines
  end

  visit(node.statements)
end

#visit_while_node(node)

The predicate of a while loop is compiled at the end of the loop, after the body, so any statements it contains (from parentheses) emit their line events again even if the lines were already seen.

: (WhileNode node) -> void

[ GitHub ]

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


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

  begin
    visit(node.predicate)
  ensure
    @lines = old_lines
  end

  visit(node.statements)
end

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)

#visit_class_node(node)

#visit_def_node(node)

#visit_embedded_statements_node(node)

#visit_if_node(node)

#visit_lambda_node(node)

#visit_module_node(node)

#visit_singleton_class_node(node)

#visit_statements_node(node)

#visit_unless_node(node)

#visit_until_node(node)

#visit_while_node(node)

`::Prism::Visitor` - Inherited

`::Prism::BasicVisitor` - Inherited

.new(lines) ⇒ `Newlines`