Class: Rouge::CLI::Highlight

Inherits:
Rouge::CLI show all
Defined in:
lib/rouge/cli.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Rouge::CLI

class_from_arg, error!, #error!, normalize_syntax

Constructor Details

#initialize(opts = {}) ⇒ Highlight

Returns a new instance of Highlight.


249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
# File 'lib/rouge/cli.rb', line 249

def initialize(opts={})
  Rouge::Lexer.enable_debug!

  opts[:requires].each do |r|
    require r
  end

  @input_file = opts[:input_file]

  if opts[:lexer]
    @lexer_class = Lexer.find(opts[:lexer]) \
      or error! "unknown lexer #{opts[:lexer].inspect}"
  else
    @lexer_name = opts[:lexer]
    @mimetype = opts[:mimetype]
  end

  @lexer_opts = opts[:lexer_opts]

  theme = Theme.find(opts[:theme]).new or error! "unknown theme #{opts[:theme]}"

  @formatter = case opts[:formatter]
  when 'terminal256' then Formatters::Terminal256.new(theme)
  when 'html' then Formatters::HTML.new
  when 'html-pygments' then Formatters::HTMLPygments.new(Formatters::HTML.new, opts[:css_class])
  when 'html-inline' then Formatters::HTMLInline.new(theme)
  when 'html-table' then Formatters::HTMLTable.new(Formatters::HTML.new)
  when 'null', 'raw', 'tokens' then Formatters::Null.new
  else
    error! "unknown formatter preset #{opts[:formatter]}"
  end
end

Instance Attribute Details

#formatterObject (readonly)

Returns the value of attribute formatter


247
248
249
# File 'lib/rouge/cli.rb', line 247

def formatter
  @formatter
end

#input_fileObject (readonly)

Returns the value of attribute input_file


247
248
249
# File 'lib/rouge/cli.rb', line 247

def input_file
  @input_file
end

#lexer_nameObject (readonly)

Returns the value of attribute lexer_name


247
248
249
# File 'lib/rouge/cli.rb', line 247

def lexer_name
  @lexer_name
end

#mimetypeObject (readonly)

Returns the value of attribute mimetype


247
248
249
# File 'lib/rouge/cli.rb', line 247

def mimetype
  @mimetype
end

Class Method Details

.descObject


151
152
153
# File 'lib/rouge/cli.rb', line 151

def self.desc
  "highlight code"
end

.doc {|%[usage: rougify highlight <filename> [options...]]| ... } ⇒ Object

Yields:

  • (%[usage: rougify highlight <filename> [options...]])

155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
# File 'lib/rouge/cli.rb', line 155

def self.doc
  return enum_for(:doc) unless block_given?

  yield %[usage: rougify highlight <filename> [options...]]
  yield %[       rougify highlight [options...]]
  yield %[]
  yield %[--input-file|-i <filename>  specify a file to read, or - to use stdin]
  yield %[]
  yield %[--lexer|-l <lexer>          specify the lexer to use.]
  yield %[                            If not provided, rougify will try to guess]
  yield %[                            based on --mimetype, the filename, and the]
  yield %[                            file contents.]
  yield %[]
  yield %[--formatter|-f <opts>       specify the output formatter to use.]
  yield %[                            If not provided, rougify will default to]
  yield %[                            terminal256.]
  yield %[]
  yield %[--theme|-t <theme>          specify the theme to use for highlighting]
  yield %[                            the file. (only applies to some formatters)]
  yield %[]
  yield %[--mimetype|-m <mimetype>    specify a mimetype for lexer guessing]
  yield %[]
  yield %[--lexer-opts|-L <opts>      specify lexer options in CGI format]
  yield %[                            (opt1=val1&opt2=val2)]
  yield %[]
  yield %[--formatter-opts|-F <opts>  specify formatter options in CGI format]
  yield %[                            (opt1=val1&opt2=val2)]
  yield %[]
  yield %[--require|-r <filename>     require a filename or library before]
  yield %[                            highlighting]
end

.parse(argv) ⇒ Object


187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
# File 'lib/rouge/cli.rb', line 187

def self.parse(argv)
  opts = {
    :formatter => 'terminal256',
    :theme => 'thankful_eyes',
    :css_class => 'codehilite',
    :input_file => '-',
    :lexer_opts => {},
    :formatter_opts => {},
    :requires => [],
  }

  until argv.empty?
    arg = argv.shift
    case arg
    when '-r', '--require'
      opts[:requires] << argv.shift
    when '--input-file', '-i'
      opts[:input_file] = argv.shift
    when '--mimetype', '-m'
      opts[:mimetype] = argv.shift
    when '--lexer', '-l'
      opts[:lexer] = argv.shift
    when '--formatter-preset', '-f'
      opts[:formatter] = argv.shift
    when '--theme', '-t'
      opts[:theme] = argv.shift
    when '--css-class', '-c'
      opts[:css_class] = argv.shift
    when '--lexer-opts', '-L'
      opts[:lexer_opts] = parse_cgi(argv.shift)
    when /^--/
      error! "unknown option #{arg.inspect}"
    else
      opts[:input_file] = arg
    end
  end

  new(opts)
end

.parse_cgi(str) ⇒ Object


287
288
289
290
# File 'lib/rouge/cli.rb', line 287

def self.parse_cgi(str)
  pairs = CGI.parse(str).map { |k, v| [k.to_sym, v.first] }
  Hash[pairs]
end

Instance Method Details

#inputObject


231
232
233
# File 'lib/rouge/cli.rb', line 231

def input
  @input ||= input_stream.read
end

#input_streamObject


227
228
229
# File 'lib/rouge/cli.rb', line 227

def input_stream
  @input_stream ||= FileReader.new(@input_file)
end

#lexerObject


243
244
245
# File 'lib/rouge/cli.rb', line 243

def lexer
  @lexer ||= lexer_class.new(@lexer_opts)
end

#lexer_classObject


235
236
237
238
239
240
241
# File 'lib/rouge/cli.rb', line 235

def lexer_class
  @lexer_class ||= Lexer.guess(
    :filename => @input_file,
    :mimetype => @mimetype,
    :source => input_stream,
  )
end

#runObject


282
283
284
# File 'lib/rouge/cli.rb', line 282

def run
  formatter.format(lexer.lex(input), &method(:print))
end