Class: Rouge::RegexLexer Abstract

Inherits:
Lexer
  • Object
show all
Defined in:
lib/rouge/regex_lexer.rb

Overview

This class is abstract.

A stateful lexer that uses sets of regular expressions to tokenize a string. Most lexers are instances of RegexLexer.

Defined Under Namespace

Classes: Rule, State, StateDSL

Constant Summary collapse

MAX_NULL_SCANS =

The number of successive scans permitted without consuming the input stream. If this is exceeded, the match fails.

5

Constants included from Token::Tokens

Token::Tokens::Num, Token::Tokens::Str

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Lexer

aliases, all, analyze_text, assert_utf8!, #debug, default_options, demo, demo_file, desc, filenames, find, find_fancy, guess, guess_by_filename, guess_by_mimetype, guess_by_source, guesses, #initialize, lex, #lex, mimetypes, #option, #options, #tag, tag

Methods included from Token::Tokens

token

Constructor Details

This class inherits a constructor from Rouge::Lexer

Class Method Details

.append(state, &b) ⇒ Object 



186
187
188
189
190
 
# File 'lib/rouge/regex_lexer.rb', line 186

def self.append(state, &b)
  name = name.to_s
  dsl = state_definitions[name] or raise "no such state #{name.inspect}"
  replace_state(name, dsl.appended(&b))
end

.get_state(name) ⇒ Object 



193
194
195
196
197
198
199
200
 
# File 'lib/rouge/regex_lexer.rb', line 193

def self.get_state(name)
  return name if name.is_a? State

  states[name.to_sym] ||= begin
    defn = state_definitions[name.to_s] or raise "unknown state: #{name.inspect}"
    defn.to_state(self)
  end
end

.prepend(name, &b) ⇒ Object 



180
181
182
183
184
 
# File 'lib/rouge/regex_lexer.rb', line 180

def self.prepend(name, &b)
  name = name.to_s
  dsl = state_definitions[name] or raise "no such state #{name.inspect}"
  replace_state(name, dsl.prepended(&b))
end

.replace_state(name, new_defn) ⇒ Object 



153
154
155
156
 
# File 'lib/rouge/regex_lexer.rb', line 153

def self.replace_state(name, new_defn)
  states[name] = nil
  state_definitions[name] = new_defn
end

.start(&b) ⇒ Object

Specify an action to be run every fresh lex.

Examples:

start { puts "I'm lexing a new string!" }


169
170
171
 
# File 'lib/rouge/regex_lexer.rb', line 169

def self.start(&b)
  start_procs << b
end

.start_procs ⇒ Object

The routines to run at the beginning of a fresh lex.

See Also:



160
161
162
 
# File 'lib/rouge/regex_lexer.rb', line 160

def self.start_procs
  @start_procs ||= InheritableList.new(superclass.start_procs)
end

.state(name, &b) ⇒ Object

Define a new state for this lexer with the given name. The block will be evaluated in the context of a StateDSL.



175
176
177
178
 
# File 'lib/rouge/regex_lexer.rb', line 175

def self.state(name, &b)
  name = name.to_s
  state_definitions[name] = StateDSL.new(name, &b)
end

.state_definitions ⇒ Object 



148
149
150
 
# File 'lib/rouge/regex_lexer.rb', line 148

def self.state_definitions
  @state_definitions ||= InheritableHash.new(superclass.state_definitions)
end

.states ⇒ Object

The states hash for this lexer.

See Also:



144
145
146
 
# File 'lib/rouge/regex_lexer.rb', line 144

def self.states
  @states ||= {}
end

Instance Method Details

#delegate(lexer, text = nil) ⇒ Object

Delegate the lex to another lexer. The #lex method will be called with ‘:continue` set to true, so that #reset! will not be called. In this way, a single lexer can be repeatedly delegated to while maintaining its own internal state stack.

Parameters:

  • lexer (#lex) —

    The lexer or lexer class to delegate to

  • text (String) (defaults to: nil) —

    The text to delegate. This defaults to the last matched string.



353
354
355
356
357
358
359
360
361
 
# File 'lib/rouge/regex_lexer.rb', line 353

def delegate(lexer, text=nil)
  puts "    delegating to #{lexer.inspect}" if @debug
  text ||= @current_stream[0]

  lexer.lex(text, :continue => true) do |tok, val|
    puts "    delegated token: #{tok.inspect}, #{val.inspect}" if @debug
    yield_token(tok, val)
  end
end

#get_state(state_name) ⇒ Object 



203
204
205
 
# File 'lib/rouge/regex_lexer.rb', line 203

def get_state(state_name)
  self.class.get_state(state_name)
end

#goto(state_name) ⇒ Object

replace the head of the stack with the given state



397
398
399
400
401
402
 
# File 'lib/rouge/regex_lexer.rb', line 397

def goto(state_name)
  raise 'empty stack!' if stack.empty?

  puts "    going to state #{state_name} " if @debug
  stack[-1] = get_state(state_name)
end

#group(tok) ⇒ Object

Deprecated.

Yield a token with the next matched group. Subsequent calls to this method will yield subsequent groups.



332
333
334
 
# File 'lib/rouge/regex_lexer.rb', line 332

def group(tok)
  raise "RegexLexer#group is deprecated: use #groups instead"
end

#groups(*tokens) ⇒ Object

Yield tokens corresponding to the matched groups of the current match.



338
339
340
341
342
 
# File 'lib/rouge/regex_lexer.rb', line 338

def groups(*tokens)
  tokens.each_with_index do |tok, i|
    yield_token(tok, @current_stream[i+1])
  end
end

#in_state?(state_name) ⇒ Boolean

Check if ‘state_name` is in the state stack.

Returns:

  • (Boolean) 


412
413
414
415
416
417
 
# File 'lib/rouge/regex_lexer.rb', line 412

def in_state?(state_name)
  state_name = state_name.to_s
  stack.any? do |state|
    state.name == state_name.to_s
  end
end

#pop!(times = 1) ⇒ Object

Pop the state stack. If a number is passed in, it will be popped that number of times.



386
387
388
389
390
391
392
393
394
 
# File 'lib/rouge/regex_lexer.rb', line 386

def pop!(times=1)
  raise 'empty stack!' if stack.empty?

  puts "    popping stack: #{times}" if @debug

  stack.pop(times)

  nil
end

#push(state_name = nil, &b) ⇒ Object

Push a state onto the stack. If no state name is given and you’ve passed a block, a state will be dynamically created using the StateDSL.



370
371
372
373
374
375
376
377
378
379
380
381
382
 
# File 'lib/rouge/regex_lexer.rb', line 370

def push(state_name=nil, &b)
  push_state = if state_name
    get_state(state_name)
  elsif block_given?
    StateDSL.new(b.inspect, &b).to_state(self.class)
  else
    # use the top of the stack by default
    self.state
  end

  puts "    pushing #{push_state.name}" if @debug
  stack.push(push_state)
end

#recurse(text = nil) ⇒ Object 



363
364
365
 
# File 'lib/rouge/regex_lexer.rb', line 363

def recurse(text=nil)
  delegate(self.class, text)
end

#reset! ⇒ Object

reset this lexer to its initial state. This runs all of the start_procs.



224
225
226
227
228
229
230
231
 
# File 'lib/rouge/regex_lexer.rb', line 224

def reset!
  @stack = nil
  @current_stream = nil

  self.class.start_procs.each do |pr|
    instance_eval(&pr)
  end
end

#reset_stack ⇒ Object

reset the stack back to ‘[:root]`.



405
406
407
408
409
 
# File 'lib/rouge/regex_lexer.rb', line 405

def reset_stack
  puts '    resetting stack' if @debug
  stack.clear
  stack.push get_state(:root)
end

#stack ⇒ Object

The state stack. This is initially the single state ‘[:root]`. It is an error for this stack to be empty.

See Also:



210
211
212
 
# File 'lib/rouge/regex_lexer.rb', line 210

def stack
  @stack ||= [get_state(:root)]
end

#state ⇒ Object

The current state - i.e. one on top of the state stack.

NB: if the state stack is empty, this will throw an error rather than returning nil.



218
219
220
 
# File 'lib/rouge/regex_lexer.rb', line 218

def state
  stack.last or raise 'empty stack!'
end

#state?(state_name) ⇒ Boolean

Check if ‘state_name` is the state on top of the state stack.

Returns:

  • (Boolean) 


420
421
422
 
# File 'lib/rouge/regex_lexer.rb', line 420

def state?(state_name)
  state_name.to_s == state.name
end

#step(state, stream) ⇒ Object

Runs one step of the lex. Rules in the current state are tried until one matches, at which point its callback is called.

Returns:

  • true if a rule was tried successfully

  • false otherwise.



278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
 
# File 'lib/rouge/regex_lexer.rb', line 278

def step(state, stream)
  state.rules.each do |rule|
    if rule.is_a?(State)
      puts "  entering mixin #{rule.name}" if @debug
      return true if step(rule, stream)
      puts "  exiting  mixin #{rule.name}" if @debug
    else
      puts "  trying #{rule.inspect}" if @debug

      # XXX HACK XXX
      # StringScanner's implementation of ^ is b0rken.
      # see http://bugs.ruby-lang.org/issues/7092
      # TODO: this doesn't cover cases like /(a|^b)/, but it's
      # the most common, for now...
      next if rule.beginning_of_line && !stream.beginning_of_line?

      if size = stream.skip(rule.re)
        puts "    got #{stream[0].inspect}" if @debug

        instance_exec(stream, &rule.callback)

        if size.zero?
          @null_steps += 1
          if @null_steps > MAX_NULL_SCANS
            puts "    too many scans without consuming the string!" if @debug
            return false
          end
        else
          @null_steps = 0
        end

        return true
      end
    end
  end

  false
end

#stream_tokens(str, &b) ⇒ Object

This implements the lexer protocol, by yielding [token, value] pairs.

The process for lexing works as follows, until the stream is empty:

  1. We look at the state on top of the stack (which by default is ‘[:root]`).

  2. Each rule in that state is tried until one is successful. If one is found, that rule’s callback is evaluated - which may yield tokens and manipulate the state stack. Otherwise, one character is consumed with an ‘’Error’‘ token, and we continue at (1.)

See Also:



245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/rouge/regex_lexer.rb', line 245

def stream_tokens(str, &b)
  stream = StringScanner.new(str)

  @current_stream = stream
  @output_stream  = b
  @states         = self.class.states
  @null_steps     = 0

  until stream.eos?
    if @debug
      puts "lexer: #{self.class.tag}"
      puts "stack: #{stack.map(&:name).inspect}"
      puts "stream: #{stream.peek(20).inspect}"
    end

    success = step(state, stream)

    if !success
      puts "    no match, yielding Error" if @debug
      b.call(Token::Tokens::Error, stream.getch)
    end
  end
end

#token(tok, val = ) ⇒ Object

Yield a token.

Parameters:

  • tok —

    the token type

  • val (defaults to: ) —

    (optional) the string value to yield. If absent, this defaults to the entire last match.



324
325
326
 
# File 'lib/rouge/regex_lexer.rb', line 324

def token(tok, val=@current_stream[0])
  yield_token(tok, val)
end