Class: Rouge::Formatters::Terminal256

Inherits:
Rouge::Formatter show all
Defined in:
lib/rouge/formatters/terminal256.rb

Overview

A formatter for 256-color terminals

Defined Under Namespace

Classes: EscapeSequence

Constant Summary

Constants inherited from Rouge::Formatter

Rouge::Formatter::REGISTRY

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Rouge::Formatter

find, format, #format, #render, tag

Constructor Details

#initialize(theme = Themes::ThankfulEyes.new) ⇒ Terminal256

Returns a new instance of Terminal256.

Parameters:

  • theme (Hash, Rouge::Theme) (defaults to: Themes::ThankfulEyes.new)

    the theme to render with.



14
15
16
17
18
19
20
21
22
# File 'lib/rouge/formatters/terminal256.rb', line 14

def initialize(theme = Themes::ThankfulEyes.new)
  if theme.is_a?(Rouge::Theme)
    @theme = theme
  elsif theme.is_a?(Hash)
    @theme = theme[:theme] || Themes::ThankfulEyes.new
  else
    raise ArgumentError, "invalid theme: #{theme.inspect}"
  end
end

Instance Attribute Details

#themeObject (readonly)



10
11
12
# File 'lib/rouge/formatters/terminal256.rb', line 10

def theme
  @theme
end

Instance Method Details

#escape_sequence(token) ⇒ Object

private



160
161
162
163
164
# File 'lib/rouge/formatters/terminal256.rb', line 160

def escape_sequence(token)
  @escape_sequences ||= {}
  @escape_sequences[token.qualname] ||=
    EscapeSequence.new(get_style(token))
end

#get_style(token) ⇒ Object



166
167
168
169
170
# File 'lib/rouge/formatters/terminal256.rb', line 166

def get_style(token)
  return text_style if token.ancestors.include? Token::Tokens::Text

  theme.get_own_style(token) || text_style
end

#stream(tokens, &b) ⇒ Object



24
25
26
27
28
29
30
31
# File 'lib/rouge/formatters/terminal256.rb', line 24

def stream(tokens, &b)
  tokens.each do |tok, val|
    escape = escape_sequence(tok)
    yield escape.style_string
    yield val.gsub("\n", "#{escape.reset_string}\n#{escape.style_string}")
    yield escape.reset_string
  end
end

#text_styleObject



172
173
174
175
176
177
# File 'lib/rouge/formatters/terminal256.rb', line 172

def text_style
  style = theme.get_style(Token['Text'])
  # don't highlight text backgrounds
  style.delete :bg
  style
end