Sha256: 1a2b8ec623e0762dd8fdb85f6554c6b84e5818398e28152818482d326587d642

Contents?: true

Size: 1015 Bytes

Versions: 20

Compression:

Stored size: 1015 Bytes

Contents

##
# A TokenStream is a list of tokens, gathered during the parse of some entity
# (say a method). Entities populate these streams by being registered with the
# lexer. Any class can collect tokens by including TokenStream. From the
# outside, you use such an object by calling the start_collecting_tokens
# method, followed by calls to add_token and pop_token.

module RDoc::TokenStream

  ##
  # Adds +tokens+ to the collected tokens

  def add_tokens(*tokens)
    tokens.flatten.each { |token| @token_stream << token }
  end

  alias add_token add_tokens

  ##
  # Starts collecting tokens

  def collect_tokens
    @token_stream = []
  end

  alias start_collecting_tokens collect_tokens

  ##
  # Remove the last token from the collected tokens

  def pop_token
    @token_stream.pop
  end

  ##
  # Current token stream

  def token_stream
    @token_stream
  end

  ##
  # Returns a string representation of the token stream

  def tokens_to_s
    token_stream.map { |token| token.text }.join ''
  end

end

Version data entries

20 entries across 20 versions & 1 rubygems

Version Path
rdoc-3.9.5 lib/rdoc/token_stream.rb
rdoc-3.9.4 lib/rdoc/token_stream.rb
rdoc-3.9.3 lib/rdoc/token_stream.rb
rdoc-3.9.2 lib/rdoc/token_stream.rb
rdoc-3.9.1 lib/rdoc/token_stream.rb
rdoc-3.9 lib/rdoc/token_stream.rb
rdoc-3.8 lib/rdoc/token_stream.rb
rdoc-3.7 lib/rdoc/token_stream.rb
rdoc-3.6.1 lib/rdoc/token_stream.rb
rdoc-3.6 lib/rdoc/token_stream.rb
rdoc-3.5.3 lib/rdoc/token_stream.rb
rdoc-3.5.2 lib/rdoc/token_stream.rb
rdoc-3.5.1 lib/rdoc/token_stream.rb
rdoc-3.5 lib/rdoc/token_stream.rb
rdoc-3.4 lib/rdoc/token_stream.rb
rdoc-3.3 lib/rdoc/token_stream.rb
rdoc-3.2 lib/rdoc/token_stream.rb
rdoc-3.1 lib/rdoc/token_stream.rb
rdoc-3.0.1 lib/rdoc/token_stream.rb
rdoc-3.0 lib/rdoc/token_stream.rb