Module: RDoc::Parser::RubyTools

### Home Classes Methods

### In Files

- lib/rdoc/parser/ruby_tools.rb

### Methods

- #add_token_listener
- #get_tk
- #get_tk_until
- #get_tkread
- #peek_read
- #peek_tk
- #remove_token_listener
- #reset
- #skip_tkspace
- #token_listener
- #unget_tk

### Included Modules

- RDoc::RubyToken

### Files

- CONTRIBUTING.rdoc
- CVE-2013-0256.rdoc
- ExampleRDoc.rdoc
- LICENSE.rdoc
- Manifest.txt
- README.rdoc
- RI.rdoc
- Rakefile
- TODO.rdoc

### Class/Module Index

Quicksearch

- RDoc
- RDoc::Alias
- RDoc::AnonClass
- RDoc::AnyMethod
- RDoc::Attr
- RDoc::ClassModule
- RDoc::CodeObject
- RDoc::Comment
- RDoc::Constant
- RDoc::Context
- RDoc::Context::Section
- RDoc::CrossReference
- RDoc::ERBIO
- RDoc::ERBPartial
- RDoc::Encoding
- RDoc::Error
- RDoc::Extend
- RDoc::Gauntlet
- RDoc::Generator
- RDoc::Generator::Darkfish
- RDoc::Generator::JsonIndex
- RDoc::Generator::Markup
- RDoc::Generator::POT
- RDoc::Generator::RI
- RDoc::GhostMethod
- RDoc::Include
- RDoc::Markdown
- RDoc::Markdown::Literals
- RDoc::Markup
- RDoc::Markup::AttrChanger
- RDoc::Markup::AttrSpan
- RDoc::Markup::AttributeManager
- RDoc::Markup::Attributes
- RDoc::Markup::BlankLine
- RDoc::Markup::BlockQuote
- RDoc::Markup::Document
- RDoc::Markup::Formatter
- RDoc::Markup::FormatterTestCase
- RDoc::Markup::HardBreak
- RDoc::Markup::Include
- RDoc::Markup::IndentedParagraph
- RDoc::Markup::List
- RDoc::Markup::ListItem
- RDoc::Markup::Paragraph
- RDoc::Markup::Parser
- RDoc::Markup::Parser::Error
- RDoc::Markup::Parser::ParseError
- RDoc::Markup::PreProcess
- RDoc::Markup::Raw
- RDoc::Markup::Rule
- RDoc::Markup::Special
- RDoc::Markup::TextFormatterTestCase
- RDoc::Markup::ToAnsi
- RDoc::Markup::ToBs
- RDoc::Markup::ToHtml
- RDoc::Markup::ToHtmlCrossref
- RDoc::Markup::ToHtmlSnippet
- RDoc::Markup::ToJoinedParagraph
- RDoc::Markup::ToLabel
- RDoc::Markup::ToMarkdown
- RDoc::Markup::ToRdoc
- RDoc::Markup::ToTableOfContents
- RDoc::Markup::ToTest
- RDoc::Markup::ToTtOnly
- RDoc::Markup::Verbatim
- RDoc::MetaMethod
- RDoc::MethodAttr
- RDoc::Mixin
- RDoc::NormalClass
- RDoc::NormalModule
- RDoc::Options
- RDoc::Parser
- RDoc::Parser::C
- RDoc::Parser::ChangeLog
- RDoc::Parser::Markdown
- RDoc::Parser::RD
- RDoc::Parser::Ruby
- RDoc::Parser::RubyTools
- RDoc::Parser::Simple
- RDoc::Parser::Text
- RDoc::RD
- RDoc::RD::BlockParser
- RDoc::RD::Inline
- RDoc::RD::InlineParser
- RDoc::RDoc
- RDoc::RI
- RDoc::RI::Driver
- RDoc::RI::Driver::Error
- RDoc::RI::Driver::NotFoundError
- RDoc::RI::Error
- RDoc::RI::Paths
- RDoc::Require
- RDoc::RubyLex
- RDoc::RubyLex::Error
- RDoc::RubyToken
- RDoc::RubygemsHook
- RDoc::Servlet
- RDoc::SingleClass
- RDoc::Stats
- RDoc::Stats::Normal
- RDoc::Stats::Quiet
- RDoc::Stats::Verbose
- RDoc::Store
- RDoc::Store::Error
- RDoc::Store::MissingFileError
- RDoc::Task
- RDoc::Task
- RDoc::TestCase
- RDoc::TokenStream
- RDoc::TomDoc
- RDoc::TopLevel
- Object

No matching classes.

# RDoc::Parser::RubyTools

Collection of methods for writing parsers against RDoc::RubyLex and RDoc::RubyToken

### Public Instance Methods

add_token_listener(obj) click to toggle source

Adds a token listener `obj`, but you should probably use token_listener

    # File lib/rdoc/parser/ruby_tools.rb, line 12
    def add_token_listener(obj)
      @token_listeners ||= []
      @token_listeners << obj
    end

get_tk() click to toggle source

Fetches the next token from the scanner

    # File lib/rdoc/parser/ruby_tools.rb, line 20
    def get_tk
      tk = nil

      if @tokens.empty? then
        tk = @scanner.token
        @read.push @scanner.get_readed
        puts "get_tk1 => #{tk.inspect}" if $TOKEN_DEBUG
      else
        @read.push @unget_read.shift
        tk = @tokens.shift
        puts "get_tk2 => #{tk.inspect}" if $TOKEN_DEBUG
      end

      tk = nil if TkEND_OF_SCRIPT === tk

      if TkSYMBEG === tk then
        set_token_position tk.line_no, tk.char_no

        case tk1 = get_tk
        when TkId, TkOp, TkSTRING, TkDSTRING, TkSTAR, TkAMPER then
          if tk1.respond_to?(:name) then
            tk = Token(TkSYMBOL).set_text(":" + tk1.name)
          else
            tk = Token(TkSYMBOL).set_text(":" + tk1.text)
          end

          # remove the identifier we just read to replace it with a symbol
          @token_listeners.each do |obj|
            obj.pop_token
          end if @token_listeners
        else
          tk = tk1
        end
      end

      # inform any listeners of our shiny new token
      @token_listeners.each do |obj|
        obj.add_token(tk)
      end if @token_listeners

      tk
    end

get_tk_until(*tokens) click to toggle source

Reads and returns all tokens up to one of `tokens`. Leaves the matched token in the token list.

    # File lib/rdoc/parser/ruby_tools.rb, line 67
    def get_tk_until(*tokens)
      read = []

      loop do
        tk = get_tk

        case tk
        when *tokens then
          unget_tk tk
          break
        end

        read << tk
      end

      read
    end

get_tkread() click to toggle source

Retrieves a String representation of the read tokens

    # File lib/rdoc/parser/ruby_tools.rb, line 88
    def get_tkread
      read = @read.join("")
      @read = []
      read
    end

peek_read() click to toggle source

Peek equivalent for get_tkread

    # File lib/rdoc/parser/ruby_tools.rb, line 97
    def peek_read
      @read.join('')
    end

peek_tk() click to toggle source

Peek at the next token, but don't remove it from the stream

    # File lib/rdoc/parser/ruby_tools.rb, line 104
    def peek_tk
      unget_tk(tk = get_tk)
      tk
    end

remove_token_listener(obj) click to toggle source

Removes the token listener `obj`

    # File lib/rdoc/parser/ruby_tools.rb, line 112
    def remove_token_listener(obj)
      @token_listeners.delete(obj)
    end

reset() click to toggle source

Resets the tools

    # File lib/rdoc/parser/ruby_tools.rb, line 119
    def reset
      @read       = []
      @tokens     = []
      @unget_read = []
      @nest = 0
    end

skip_tkspace(skip_nl = true) click to toggle source

Skips whitespace tokens including newlines if `skip_nl` is true

    # File lib/rdoc/parser/ruby_tools.rb, line 129
    def skip_tkspace(skip_nl = true) # HACK dup
      tokens = []

      while TkSPACE === (tk = get_tk) or (skip_nl and TkNL === tk) do
        tokens.push tk
      end

      unget_tk tk
      tokens
    end

token_listener(obj) click to toggle source

Has `obj` listen to tokens

    # File lib/rdoc/parser/ruby_tools.rb, line 143
    def token_listener(obj)
      add_token_listener obj
      yield
    ensure
      remove_token_listener obj
    end

unget_tk(tk) click to toggle source

Returns `tk` to the scanner

    # File lib/rdoc/parser/ruby_tools.rb, line 153
    def unget_tk(tk)
      @tokens.unshift tk
      @unget_read.unshift @read.pop

      # Remove this token from any listeners
      @token_listeners.each do |obj|
        obj.pop_token
      end if @token_listeners

      nil
    end

[Validate]

Generated with the Darkfish Rdoc Generator 2.