Object
A Duo is a convenient way to use CodeRay. You just create a Duo, giving it a lang (language of the input code) and a format (desired output format), and call Duo#highlight with the code.
Duo makes it easy to re-use both scanner and encoder for a repetitive task. It also provides a very easy interface syntax:
require 'coderay' CodeRay::Duo[:python, :div].highlight 'import this'
Until you want to do uncommon things with CodeRay, I recommend to use this method, since it takes care of everything.
Create a new Duo, holding a lang and a format to highlight code.
simple:
CodeRay::Duo[:ruby, :page].highlight 'bla 42'
streaming:
CodeRay::Duo[:ruby, :page].highlight 'bar 23', :stream => true
with options:
CodeRay::Duo[:ruby, :html, :hint => :debug].highlight '????::??'
alternative syntax without options:
CodeRay::Duo[:ruby => :statistic].encode 'class << self; end'
alternative syntax with options:
CodeRay::Duo[{ :ruby => :statistic }, :do => :something].encode 'abc'
The options are forwarded to scanner and encoder (see CodeRay.get_scanner_options).
# File lib/coderay/duo.rb, line 40 40: def initialize lang = nil, format = nil, options = {} 41: if format == nil and lang.is_a? Hash and lang.size == 1 42: @lang = lang.keys.first 43: @format = lang[@lang] 44: else 45: @lang = lang 46: @format = format 47: end 48: @options = options 49: end
Tokenize and highlight the code using scanner and encoder.
If the :stream option is set, the Duo will go into streaming mode, saving memory for the cost of time.
# File lib/coderay/duo.rb, line 70 70: def encode code, options = { :stream => false } 71: stream = options.delete :stream 72: options = @options.merge options 73: if stream 74: encoder.encode_stream(code, @lang, options) 75: else 76: scanner.code = code 77: encoder.encode_tokens(scanner.tokenize, options) 78: end 79: end
Disabled; run with --debug to generate this.
Generated with the Darkfish Rdoc Generator 1.1.6.