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, #extract_tree_text, #line_index, locator, #to_s, #to_uri

Constructor Details

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

Returns a new instance of SubLocator.



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

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) 



109
110
111
 
# File 'lib/puppet/pops/parser/locator.rb', line 109

def leading_line_count
  @leading_line_count
end

#leading_line_offset ⇒ Object (readonly) 



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

def leading_line_offset
  @leading_line_offset
end

#leading_offset ⇒ Object (readonly) 



110
111
112
 
# File 'lib/puppet/pops/parser/locator.rb', line 110

def leading_offset
  @leading_offset
end

#locator ⇒ Object (readonly) 



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

def locator
  @locator
end

Class Method Details

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



113
114
115
116
117
118
 
# File 'lib/puppet/pops/parser/locator.rb', line 113

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



152
153
154
155
 
# File 'lib/puppet/pops/parser/locator.rb', line 152

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



146
147
148
149
 
# File 'lib/puppet/pops/parser/locator.rb', line 146

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 



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

def file
  @locator.file
end

#line_for_offset(offset) ⇒ Object

Given offset is offset in the subspace



136
137
138
 
# File 'lib/puppet/pops/parser/locator.rb', line 136

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



141
142
143
 
# File 'lib/puppet/pops/parser/locator.rb', line 141

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

#pos_on_line(offset) ⇒ Object 



157
158
159
 
# File 'lib/puppet/pops/parser/locator.rb', line 157

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

#string ⇒ Object 



131
132
133
 
# File 'lib/puppet/pops/parser/locator.rb', line 131

def string
  @locator.string
end