module 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 Class Methods

to_html (token_stream)

Source

# File lib/rdoc/token_stream.rb, line 17
def self.to_html(token_stream)
  token_stream.map do |t|
    next unless t

    style = case t[:kind]
            when :operator   then 'ruby-operator'
            when :keyword    then 'ruby-keyword'
            when :constant   then 'ruby-constant'
            when :ivar       then 'ruby-ivar'
            when :comment    then 'ruby-comment'
            when :value      then 'ruby-value'
            when :string     then 'ruby-string'
            when :symbol     then 'ruby-value'
            when :x_string   then 'ruby-string'
            when :regexp     then 'ruby-regexp'
            when :identifier then 'ruby-identifier'
            end

    text = t[:text]

    text = CGI.escapeHTML text

    if style then
      end_with_newline = text.end_with?("\n")
      text = text.chomp if end_with_newline
      "<span class=\"#{style}\">#{text}</span>#{"\n" if end_with_newline}"
    else
      text
    end
  end.join
end

Converts token_stream to HTML wrapping various tokens with <span> elements. Some tokens types are wrapped in spans with the given class names. Other token types are not wrapped in spans.

Public Instance Methods

add_token (token)

Source

# File lib/rdoc/token_stream.rb, line 59
def add_token(token)
  @token_stream.push(token)
end

Adds one token to the collected tokens

add_tokens (tokens)

Source

# File lib/rdoc/token_stream.rb, line 52
def add_tokens(tokens)
  @token_stream.concat(tokens)
end

Adds tokens to the collected tokens

collect_tokens (language)

Source

# File lib/rdoc/token_stream.rb, line 67
def collect_tokens(language)
  @token_stream = []
  @token_stream_language = language
end

Starts collecting tokens

Also aliased as: start_collecting_tokens

pop_token ()

Source

# File lib/rdoc/token_stream.rb, line 77
def pop_token
  @token_stream.pop
end

Remove the last token from the collected tokens

source_language ()

Source

# File lib/rdoc/token_stream.rb, line 100
def source_language
  @token_stream_language == :c ? 'c' : 'ruby'
end

Returns the source language of the token stream as a string

Returns ‘c’ or ‘ruby’

start_collecting_tokens (language)

Alias for: collect_tokens

token_stream ()

Source

# File lib/rdoc/token_stream.rb, line 84
def token_stream
  @token_stream
end

Current token stream

tokens_to_s ()

Source

# File lib/rdoc/token_stream.rb, line 91
def tokens_to_s
  (token_stream or return '').compact.map { |token| token[:text] }.join ''
end

Returns a string representation of the token stream