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, SubLocator

Instance Attribute Summary collapse

Instance Method Summary collapse

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

#char_length, #char_offset, compute_line_index, #extract_text, #extract_tree_text, locator, #offset_on_line, #to_s, #to_uri

Constructor Details

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

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



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

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

Instance Attribute Details

#file ⇒ Object (readonly) 



100
101
102
 
# File 'lib/puppet/pops/parser/locator.rb', line 100

def file
  @file
end

#line_index ⇒ Object 



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

def line_index
  @line_index
end

#string ⇒ Object (readonly) 



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

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.



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/puppet/pops/parser/locator.rb', line 134

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

#eql?(o) ⇒ Boolean

Equal method needed by serializer to perform tabulation

Returns:

  • (Boolean) 


171
172
173
 
# File 'lib/puppet/pops/parser/locator.rb', line 171

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

#hash ⇒ Object 



166
167
168
 
# File 'lib/puppet/pops/parser/locator.rb', line 166

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



176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/puppet/pops/parser/locator.rb', line 176

def line_for_offset(offset)
  if @prev_offset == offset
    # use cache
    return @prev_line
  end
  line_nbr = ary_bsearch_i(line_index, offset)
  if line_nbr
    # 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)



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

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

#to_location_hash(reported_offset, end_offset) ⇒ Object 



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

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