Class: YARD::Parser::Ruby::Legacy::RubyLex::BufferedReader

Inherits:
Object
  • Object
show all
Defined in:
lib/yard/parser/ruby/legacy/ruby_lex.rb

Overview

Read an input stream character by character. We allow for unlimited ungetting of characters just read.

We simplify the implementation greatly by reading the entire input into a buffer initially, and then simply traversing it using pointers.

We also have to allow for the here document diversion. This little gem comes about when the lexer encounters a here document. At this point we effectively need to split the input stream into two parts: one to read the body of the here document, the other to read the rest of the input line where the here document was initially encountered. For example, we might have

do_something(<<-A, <<-B)
  stuff
  for
B

When the lexer encounters the <<A, it reads until the end of the line, and keeps it around for later. It then reads the body of the here document. Once complete, it needs to read the rest of the original line, but then skip the here document body.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(content) ⇒ BufferedReader

Returns a new instance of BufferedReader.



346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'lib/yard/parser/ruby/legacy/ruby_lex.rb', line 346

def initialize(content)
  if /\t/ =~ content
    tab_width = 2
    content = content.split(/\n/).map do |line|
      1 while line.gsub!(/\t+/) { ' ' * (tab_width * $&.length - $`.length % tab_width) } && $~ #`
      line
    end .join("\n")
  end
  @content = String.new(content)
  @content << "\n" unless @content[-1, 1] == "\n"
  @size      = @content.size
  @offset    = 0
  @hwm       = 0
  @line_num  = 1
  @read_back_offset = 0
  @last_newline = 0
  @newline_pending = false
end

Instance Attribute Details

#line_num ⇒ Object (readonly)

Returns the value of attribute line_num.



344
345
346
 
# File 'lib/yard/parser/ruby/legacy/ruby_lex.rb', line 344

def line_num
  @line_num
end

Instance Method Details

#column ⇒ Object 



365
366
367
 
# File 'lib/yard/parser/ruby/legacy/ruby_lex.rb', line 365

def column
  @offset - @last_newline
end

#divert_read_from(reserve) ⇒ Object 



419
420
421
422
 
# File 'lib/yard/parser/ruby/legacy/ruby_lex.rb', line 419

def divert_read_from(reserve)
  @content[@offset, 0] = reserve
  @size = @content.size
end

#get_read ⇒ Object 



400
401
402
403
404
 
# File 'lib/yard/parser/ruby/legacy/ruby_lex.rb', line 400

def get_read
  res = @content[@read_back_offset...@offset]
  @read_back_offset = @offset
  res
end

#getc ⇒ Object 



369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
 
# File 'lib/yard/parser/ruby/legacy/ruby_lex.rb', line 369

def getc
  return nil if @offset >= @size
  ch = @content[@offset, 1]

  @offset += 1
  @hwm = @offset if @hwm < @offset

  if @newline_pending
    @line_num += 1
    @last_newline = @offset - 1
    @newline_pending = false
  end

  if ch == "\n"
    @newline_pending = true
  end
  ch
end

#getc_already_read ⇒ Object 



388
389
390
 
# File 'lib/yard/parser/ruby/legacy/ruby_lex.rb', line 388

def getc_already_read
  getc
end

#peek(at) ⇒ Object 



406
407
408
409
410
411
412
413
 
# File 'lib/yard/parser/ruby/legacy/ruby_lex.rb', line 406

def peek(at)
  pos = @offset + at
  if pos >= @size
    nil
  else
    @content[pos, 1]
  end
end

#peek_equal(str) ⇒ Object 



415
416
417
 
# File 'lib/yard/parser/ruby/legacy/ruby_lex.rb', line 415

def peek_equal(str)
  @content[@offset, str.length] == str
end

#ungetc(_ch) ⇒ Object 



392
393
394
395
396
397
398
 
# File 'lib/yard/parser/ruby/legacy/ruby_lex.rb', line 392

def ungetc(_ch)
  raise "unget past beginning of file" if @offset <= 0
  @offset -= 1
  if @content[@offset] == ?\n
    @newline_pending = false
  end
end