Class: RDoc::Markup::ToAnsi (Ruby 2.3.7)
Description: Class : RDoc::Markup::ToAnsi - Ruby 2.3.7

- Home
- Core 2.3.7
- Std-lib 2.3.7
- Downloads

Support for the Ruby 2.3 series has ended. See here for reference.

### Home Classes Methods

### In Files

- rdoc/markup/to_ansi.rb

### Parent

RDoc::Markup::ToRdoc

### Methods

- ::new
- #accept_list_item_end
- #accept_list_item_start
- #init_tags
- #start_accepting

### 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::Generator
- RDoc::Generator::Darkfish
- RDoc::Generator::JsonIndex
- RDoc::Generator::Markup
- RDoc::Generator::POT
- RDoc::Generator::POT::MessageExtractor
- RDoc::Generator::POT::PO
- RDoc::Generator::POT::POEntry
- RDoc::Generator::RI
- RDoc::GhostMethod
- RDoc::I18n
- RDoc::I18n::Locale
- RDoc::I18n::Text
- 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::RI::Task
- 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::TestCase
- RDoc::Text
- RDoc::TokenStream
- RDoc::TomDoc
- RDoc::TopLevel
- RDocTask
- Test

No matching classes.

# RDoc::Markup::ToAnsi

Outputs RDoc markup with vibrant ANSI color!

### Public Class Methods

new(markup = nil) click to toggle source

Creates a new ToAnsi visitor that is ready to output vibrant ANSI color!

                   # File rdoc/markup/to_ansi.rb, line 9
    def initialize markup = nil
      super

      @headings.clear
      @headings[1] = ["\e[1;32m", "\e[m"] # bold
      @headings[2] = ["\e[4;32m", "\e[m"] # underline
      @headings[3] = ["\e[32m",   "\e[m"] # just green
    end

### Public Instance Methods

accept_list_item_end(list_item) click to toggle source

Overrides indent width to ensure output lines up correctly.

                   # File rdoc/markup/to_ansi.rb, line 30
    def accept_list_item_end list_item
      width = case @list_type.last
              when :BULLET then
                2
              when :NOTE, :LABEL then
                if @prefix then
                  @res << @prefix.strip
                  @prefix = nil
                end

                @res << "\n" unless res.length == 1
                2
              else
                bullet = @list_index.last.to_s
                @list_index[-1] = @list_index.last.succ
                bullet.length + 2
              end

      @indent -= width
    end

accept_list_item_start(list_item) click to toggle source

Adds coloring to note and label list items

                   # File rdoc/markup/to_ansi.rb, line 54
    def accept_list_item_start list_item
      bullet = case @list_type.last
               when :BULLET then
                 '*'
               when :NOTE, :LABEL then
                 labels = Array(list_item.label).map do |label|
                   attributes(label).strip
                 end.join "\n"

                 labels << ":\n" unless labels.empty?

                 labels
               else
                 @list_index.last.to_s + '.'
               end

      case @list_type.last
      when :NOTE, :LABEL then
        @indent += 2
        @prefix = bullet + (' ' * @indent)
      else
        @prefix = (' ' * @indent) + bullet.ljust(bullet.length + 1)

        width = bullet.gsub(/\e\[[\d;]*m/, '').length + 1

        @indent += width
      end
    end

init_tags() click to toggle source

Maps attributes to ANSI sequences

                   # File rdoc/markup/to_ansi.rb, line 21
    def init_tags
      add_tag :BOLD, "\e[1m", "\e[m"
      add_tag :TT,   "\e[7m", "\e[m"
      add_tag :EM,   "\e[4m", "\e[m"
    end

start_accepting() click to toggle source

Starts accepting with a reset screen

                   # File rdoc/markup/to_ansi.rb, line 86
    def start_accepting
      super

      @res = ["\e[0m"]
    end