In Files

  • rdoc/tokenstream.rb

Files

Class/Module Index [+]

Quicksearch

RDoc::TokenStream

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.

Public Instance Methods

add_token(tk) click to toggle source
 
               # File rdoc/tokenstream.rb, line 20
def add_token(tk)
  @token_stream << tk
end
            
add_tokens(tks) click to toggle source
 
               # File rdoc/tokenstream.rb, line 24
def add_tokens(tks)
  tks.each  {|tk| add_token(tk)}
end
            
pop_token() click to toggle source
 
               # File rdoc/tokenstream.rb, line 28
def pop_token
  @token_stream.pop
end
            
start_collecting_tokens() click to toggle source
 
               # File rdoc/tokenstream.rb, line 16
def start_collecting_tokens
  @token_stream = []
end
            
token_stream() click to toggle source
 
               # File rdoc/tokenstream.rb, line 12
def token_stream
  @token_stream
end
            

Commenting is here to help enhance the documentation. For example, code samples, or clarification of the documentation.

If you have questions about Ruby or the documentation, please post to one of the Ruby mailing lists. You will get better, faster, help that way.

If you wish to post a correction of the docs, please do so, but also file bug report so that it can be corrected for the next release. Thank you.

If you want to help improve the Ruby documentation, please visit Documenting-ruby.org.

blog comments powered by Disqus