Class: Puppet::Pops::Parser::Locator::SubLocator

Inherits:
Puppet::Pops::Parser::Locator show all
Defined in:
lib/puppet/pops/parser/locator.rb

Overview

A Sublocator locates a concrete locator (subspace) in a virtual space. The ‘leading_line_count` is the (virtual) number of lines preceding the first line in the concrete locator. The `leading_offset` is the (virtual) byte offset of the first byte in the concrete locator. The `leading_line_offset` is the (virtual) offset / margin in characters for each line.

This illustrates characters in the sublocator (‘.`) inside the subspace (`X`):

1:XXXXXXXX
2:XXXX.... .. ... ..
3:XXXX. . .... ..
4:XXXX............

This sublocator would be configured with leading_line_count = 1, leading_offset=8, and leading_line_offset=4

Note that leading_offset must be the same for all lines and measured in characters.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Puppet::Pops::Parser::Locator

#extract_text, #line_index, locator

Constructor Details

#initialize(locator, leading_line_count, leading_offset, leading_line_offset) ⇒ SubLocator

Returns a new instance of SubLocator.



91
92
93
94
95
96
 
# File 'lib/puppet/pops/parser/locator.rb', line 91

def initialize(locator, leading_line_count, leading_offset, leading_line_offset)
  @locator = locator
  @leading_line_count = leading_line_count
  @leading_offset = leading_offset
  @leading_line_offset = leading_line_offset
end

Instance Attribute Details

#leading_line_count ⇒ Object (readonly) 



80
81
82
 
# File 'lib/puppet/pops/parser/locator.rb', line 80

def leading_line_count
  @leading_line_count
end

#leading_line_offset ⇒ Object (readonly) 



82
83
84
 
# File 'lib/puppet/pops/parser/locator.rb', line 82

def leading_line_offset
  @leading_line_offset
end

#leading_offset ⇒ Object (readonly) 



81
82
83
 
# File 'lib/puppet/pops/parser/locator.rb', line 81

def leading_offset
  @leading_offset
end

#locator ⇒ Object (readonly) 



79
80
81
 
# File 'lib/puppet/pops/parser/locator.rb', line 79

def locator
  @locator
end

Class Method Details

.sub_locator(string, file, leading_line_count, leading_offset, leading_line_offset) ⇒ Object 



84
85
86
87
88
89
 
# File 'lib/puppet/pops/parser/locator.rb', line 84

def self.sub_locator(string, file, leading_line_count, leading_offset, leading_line_offset)
  self.new(Locator.locator(string, file),
    leading_line_count,
    leading_offset,
    leading_line_offset)
end

Instance Method Details

#char_length(offset, end_offset) ⇒ Object

Given offsets are offsets in the subspace



123
124
125
126
 
# File 'lib/puppet/pops/parser/locator.rb', line 123

def char_length(offset, end_offset)
  effective_line = @locator.line_for_offset(end_offset) - @locator.line_for_offset(offset)
  locator.char_length(offset, end_offset) + (effective_line * @leading_line_offset)
end

#char_offset(offset) ⇒ Object

Given offset is offset in the subspace



117
118
119
120
 
# File 'lib/puppet/pops/parser/locator.rb', line 117

def char_offset(offset)
  effective_line = @locator.line_for_offset(offset)
  locator.char_offset(offset) + (effective_line * @leading_line_offset) + @leading_offset
end

#file ⇒ Object 



98
99
100
 
# File 'lib/puppet/pops/parser/locator.rb', line 98

def file
  @locator.file
end

#line_for_offset(offset) ⇒ Object

Given offset is offset in the subspace



107
108
109
 
# File 'lib/puppet/pops/parser/locator.rb', line 107

def line_for_offset(offset)
  @locator.line_for_offset(offset) + @leading_line_count
end

#offset_on_line(offset) ⇒ Object

Given offset is offset in the subspace



112
113
114
 
# File 'lib/puppet/pops/parser/locator.rb', line 112

def offset_on_line(offset)
  @locator.offset_on_line(offset) + @leading_line_offset
end

#pos_on_line(offset) ⇒ Object 



128
129
130
 
# File 'lib/puppet/pops/parser/locator.rb', line 128

def pos_on_line(offset)
  offset_on_line(offset) +1
end

#string ⇒ Object 



102
103
104
 
# File 'lib/puppet/pops/parser/locator.rb', line 102

def string
  @locator.string
end