Class: Puppet::Pops::Parser::Locator::AbstractLocator

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

Direct Known Subclasses

Locator19, LocatorForChars

Instance Attribute Summary collapse

Instance Method Summary collapse

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

#char_length, #char_offset, #extract_text, locator, #offset_on_line

Constructor Details

#initialize(string, file, index = nil) ⇒ AbstractLocator

Create a locator based on a content string, and a boolean indicating if ruby version support multi-byte strings or not.



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

def initialize(string, file, index = nil)
  @string = string.freeze
  @file = file.freeze
  @prev_offset = nil
  @prev_line = nil
  @line_index = index
  compute_line_index if index.nil?
end

Instance Attribute Details

#file ⇒ Object (readonly) 



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

def file
  @file
end

#line_index ⇒ Object 



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

def line_index
  @line_index
end

#prev_line ⇒ Object 



139
140
141
 
# File 'lib/puppet/pops/parser/locator.rb', line 139

def prev_line
  @prev_line
end

#prev_offset ⇒ Object 



138
139
140
 
# File 'lib/puppet/pops/parser/locator.rb', line 138

def prev_offset
  @prev_offset
end

#string ⇒ Object 



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

def string
  @string
end

Instance Method Details

#ary_bsearch_i(ary, value) ⇒ Object

Returns the index of the smallest item for which the item > the given value This is a min binary search. Although written in Ruby it is only slightly slower than the corresponding method in C in Ruby 2.0.0 - the main benefit to use this method over the Ruby C version is that it returns the index (not the value) which means there is not need to have an additional structure to get the index (or record the index in the structure). This saves both memory and CPU. It also does not require passing a block that is called since this method is specialized to search the line index.



176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/puppet/pops/parser/locator.rb', line 176

def ary_bsearch_i(ary, value)
  low = 0
  high = ary.length
  mid = nil
  smaller = false
  satisfied = false
  v = nil

  while low < high do
      mid = low + ((high - low) / 2)
      v = (ary[mid] > value)
      if v == true
        satisfied = true
        smaller = true
      elsif !v
        smaller = false
      else
        raise TypeError, "wrong argument, must be boolean or nil, got '#{v.class}'"
      end

      if smaller
        high = mid
      else
        low = mid + 1;
      end
  end

  return nil if low == ary.length
  return nil if !satisfied
  return low
end

#compute_line_index ⇒ Object

Common impl for 18 and 19 since scanner is byte based



218
219
220
221
222
223
224
225
 
# File 'lib/puppet/pops/parser/locator.rb', line 218

def compute_line_index
  scanner = StringScanner.new(string)
  result = [0] # first line starts at 0
  while scanner.scan_until(/\n/)
    result << scanner.pos
  end
  self.line_index = result.freeze
end

#eql?(o) ⇒ Boolean

Equal method needed by serializer to perform tabulation

Returns:

  • (Boolean) 


213
214
215
 
# File 'lib/puppet/pops/parser/locator.rb', line 213

def eql?(o)
  self.class == o.class && string == o.string && file == o.file && line_index == o.line_index
end

#hash ⇒ Object 



208
209
210
 
# File 'lib/puppet/pops/parser/locator.rb', line 208

def hash
  [string, file, line_index].hash
end

#line_for_offset(offset) ⇒ Object

Returns the line number (first line is 1) for the given offset



228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/puppet/pops/parser/locator.rb', line 228

def line_for_offset(offset)
  if prev_offset == offset
    # use cache
    return prev_line
  end
  if line_nbr = ary_bsearch_i(line_index, offset)
    # cache
    prev_offset = offset
    prev_line = line_nbr
    return line_nbr
  end
  # If not found it is after last
  # clear cache
  prev_offset = prev_line = nil
  return line_index.size
end

#pos_on_line(offset) ⇒ Object

Returns the position on line (first position on a line is 1)



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

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

#to_location_hash(reported_offset, end_offset) ⇒ Object 



160
161
162
163
164
165
166
 
# File 'lib/puppet/pops/parser/locator.rb', line 160

def to_location_hash(reported_offset, end_offset)
  pos        = pos_on_line(reported_offset)
  offset     = char_offset(reported_offset)
  length     = char_length(reported_offset, end_offset)
  start_line = line_for_offset(reported_offset)
  { :line => start_line, :pos => pos, :offset => offset, :length => length}
end