Class: RDoc::Markup::ToRdoc

Inherits:
Formatter show all
Defined in:
lib/rdoc/markup/to_rdoc.rb

Overview

Outputs RDoc markup as RDoc markup! (mostly)

Direct Known Subclasses

ToAnsi, ToBs, ToMarkdown

Constant Summary collapse

DEFAULT_HEADINGS = 
{
    1 => ['= ',      ''],
    2 => ['== ',     ''],
    3 => ['=== ',    ''],
    4 => ['==== ',   ''],
    5 => ['===== ',  ''],
    6 => ['====== ', '']
}

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Formatter

#accept_document, #add_regexp_handling_RDOCLINK, #annotate, #apply_regexp_handling, #convert, #convert_string, gen_relative_url, #handle_TEXT, #ignore, #parse_url, #traverse_inline_nodes, #tt?

Constructor Details

#initialize(markup = nil) ⇒ ToRdoc

Creates a new formatter that will output (mostly) RDoc markup



55
56
57
58
59
60
61
62
63
 
# File 'lib/rdoc/markup/to_rdoc.rb', line 55

def initialize(markup = nil)
  super nil, markup

  @markup.add_regexp_handling(/\\\S/, :SUPPRESSED_CROSSREF)
  @width = 78

  @headings = DEFAULT_HEADINGS.dup
  @hard_break = "\n"
end

Instance Attribute Details

#indent ⇒ Object

Current indent amount for output in characters



20
21
22
 
# File 'lib/rdoc/markup/to_rdoc.rb', line 20

def indent
  @indent
end

#list_index ⇒ Object (readonly)

Stack of current list indexes for alphabetic and numeric lists



30
31
32
 
# File 'lib/rdoc/markup/to_rdoc.rb', line 30

def list_index
  @list_index
end

#list_type ⇒ Object (readonly)

Stack of list types



35
36
37
 
# File 'lib/rdoc/markup/to_rdoc.rb', line 35

def list_type
  @list_type
end

#list_width ⇒ Object (readonly)

Stack of list widths for indentation



40
41
42
 
# File 'lib/rdoc/markup/to_rdoc.rb', line 40

def list_width
  @list_width
end

#prefix ⇒ Object (readonly)

Prefix for the next list item. See #use_prefix



45
46
47
 
# File 'lib/rdoc/markup/to_rdoc.rb', line 45

def prefix
  @prefix
end

#res ⇒ Object (readonly)

Output accumulator



50
51
52
 
# File 'lib/rdoc/markup/to_rdoc.rb', line 50

def res
  @res
end

#width ⇒ Object

Output width in characters



25
26
27
 
# File 'lib/rdoc/markup/to_rdoc.rb', line 25

def width
  @width
end

Instance Method Details

#accept_blank_line(blank_line) ⇒ Object

Adds blank_line to the output



68
69
70
 
# File 'lib/rdoc/markup/to_rdoc.rb', line 68

def accept_blank_line(blank_line)
  @res << "\n"
end

#accept_block_quote(block_quote) ⇒ Object

Adds paragraph to the output



75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/rdoc/markup/to_rdoc.rb', line 75

def accept_block_quote(block_quote)
  @indent += 2

  block_quote.parts.each do |part|
    @prefix = '> '

    part.accept self
  end

  @indent -= 2
end

#accept_heading(heading) ⇒ Object

Adds heading to the output



90
91
92
93
94
95
96
 
# File 'lib/rdoc/markup/to_rdoc.rb', line 90

def accept_heading(heading)
  use_prefix or @res << ' ' * @indent
  @res << @headings[heading.level][0]
  @res << attributes(heading.text)
  @res << @headings[heading.level][1]
  @res << "\n"
end

#accept_indented_paragraph(paragraph) ⇒ Object

Adds paragraph to the output



202
203
204
205
206
207
 
# File 'lib/rdoc/markup/to_rdoc.rb', line 202

def accept_indented_paragraph(paragraph)
  @indent += paragraph.indent
  text = paragraph.text @hard_break
  wrap attributes text
  @indent -= paragraph.indent
end

#accept_list_end(list) ⇒ Object

Finishes consumption of list



101
102
103
104
105
 
# File 'lib/rdoc/markup/to_rdoc.rb', line 101

def accept_list_end(list)
  @list_index.pop
  @list_type.pop
  @list_width.pop
end

#accept_list_item_end(list_item) ⇒ Object

Finishes consumption of list_item



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/rdoc/markup/to_rdoc.rb', line 110

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"
            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) ⇒ Object

Prepares the visitor for consuming list_item



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/rdoc/markup/to_rdoc.rb', line 134

def accept_list_item_start(list_item)
  type = @list_type.last

  case type
  when :NOTE, :LABEL then
    stripped_labels = Array(list_item.label).map do |label|
      attributes(label).strip
    end

    bullets = case type
    when :NOTE
      stripped_labels.map { |b| "#{b}::" }
    when :LABEL
      stripped_labels.map { |b| "[#{b}]" }
    end

    bullets = bullets.join("\n")
    bullets << "\n" unless stripped_labels.empty?

    @prefix = ' ' * @indent
    @indent += 2
    @prefix << bullets + (' ' * @indent)
  else
    bullet = type == :BULLET ? '*' :  @list_index.last.to_s + '.'
    @prefix = (' ' * @indent) + bullet.ljust(bullet.length + 1)
    width = bullet.length + 1
    @indent += width
  end
end

#accept_list_start(list) ⇒ Object

Prepares the visitor for consuming list



167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/rdoc/markup/to_rdoc.rb', line 167

def accept_list_start(list)
  case list.type
  when :BULLET then
    @list_index << nil
    @list_width << 1
  when :LABEL, :NOTE then
    @list_index << nil
    @list_width << 2
  when :LALPHA then
    @list_index << 'a'
    @list_width << list.items.length.to_s.length
  when :NUMBER then
    @list_index << 1
    @list_width << list.items.length.to_s.length
  when :UALPHA then
    @list_index << 'A'
    @list_width << list.items.length.to_s.length
  else
    raise RDoc::Error, "invalid list type #{list.type}"
  end

  @list_type << list.type
end

#accept_paragraph(paragraph) ⇒ Object

Adds paragraph to the output



194
195
196
197
 
# File 'lib/rdoc/markup/to_rdoc.rb', line 194

def accept_paragraph(paragraph)
  text = paragraph.text @hard_break
  wrap attributes text
end

#accept_raw(raw) ⇒ Object

Adds raw to the output



212
213
214
 
# File 'lib/rdoc/markup/to_rdoc.rb', line 212

def accept_raw(raw)
  @res << raw.parts.join("\n")
end

#accept_rule(rule) ⇒ Object

Adds rule to the output



219
220
221
222
223
 
# File 'lib/rdoc/markup/to_rdoc.rb', line 219

def accept_rule(rule)
  use_prefix or @res << ' ' * @indent
  @res << '-' * (@width - @indent)
  @res << "\n"
end

#accept_table(header, body, aligns) ⇒ Object

Adds table to the output



242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'lib/rdoc/markup/to_rdoc.rb', line 242

def accept_table(header, body, aligns)
  header = header.map { |h| attributes h }
  body = body.map { |row| row.map { |t| attributes t } }
  widths = header.zip(*body).map do |cols|
    cols.compact.map { |col| calculate_text_width(col) }.max
  end
  aligns = aligns.map do |a|
    case a
    when nil, :center
      :center
    when :left
      :ljust
    when :right
      :rjust
    end
  end
  @res << header.zip(widths, aligns).map do |h, w, a|
    extra_width = h.size - calculate_text_width(h)
    h.__send__(a, w + extra_width)
  end.join("|").rstrip << "\n"
  @res << widths.map {|w| "-" * w }.join("|") << "\n"
  body.each do |row|
    @res << widths.zip(aligns).each_with_index.map do |(w, a), i|
      t = row[i] || ""
      extra_width = t.size - calculate_text_width(t)
      t.__send__(a, w + extra_width)
    end.join("|").rstrip << "\n"
  end
end

#accept_verbatim(verbatim) ⇒ Object

Outputs verbatim indented 2 columns



228
229
230
231
232
233
234
235
236
237
 
# File 'lib/rdoc/markup/to_rdoc.rb', line 228

def accept_verbatim(verbatim)
  indent = ' ' * (@indent + 2)

  verbatim.parts.each do |part|
    @res << indent unless part == "\n"
    @res << part
  end

  @res << "\n"
end

#add_text(text) ⇒ Object 



347
348
349
 
# File 'lib/rdoc/markup/to_rdoc.rb', line 347

def add_text(text)
  emit_inline(text)
end

#attributes(text) ⇒ Object

Applies attribute-specific markup to text using RDoc::Markup::InlineParser



358
359
360
 
# File 'lib/rdoc/markup/to_rdoc.rb', line 358

def attributes(text)
  handle_inline(text)
end

#calculate_text_width(text) ⇒ Object 



272
273
274
 
# File 'lib/rdoc/markup/to_rdoc.rb', line 272

def calculate_text_width(text)
  text.size
end

#emit_inline(text) ⇒ Object 



351
352
353
 
# File 'lib/rdoc/markup/to_rdoc.rb', line 351

def emit_inline(text)
  @inline_output << text
end

#end_accepting ⇒ Object

Returns the generated output



365
366
367
 
# File 'lib/rdoc/markup/to_rdoc.rb', line 365

def end_accepting
  @res.join
end

#handle_BOLD(target) ⇒ Object 



284
285
286
287
288
 
# File 'lib/rdoc/markup/to_rdoc.rb', line 284

def handle_BOLD(target)
  on(:BOLD)
  super
  off(:BOLD)
end

#handle_BOLD_WORD(word) ⇒ Object 



296
297
298
299
300
 
# File 'lib/rdoc/markup/to_rdoc.rb', line 296

def handle_BOLD_WORD(word)
  on(:BOLD)
  super
  off(:BOLD)
end

#handle_EM(target) ⇒ Object 



290
291
292
293
294
 
# File 'lib/rdoc/markup/to_rdoc.rb', line 290

def handle_EM(target)
  on(:EM)
  super
  off(:EM)
end

#handle_EM_WORD(word) ⇒ Object 



302
303
304
305
306
 
# File 'lib/rdoc/markup/to_rdoc.rb', line 302

def handle_EM_WORD(word)
  on(:EM)
  super
  off(:EM)
end

#handle_HARD_BREAK ⇒ Object 



320
321
322
 
# File 'lib/rdoc/markup/to_rdoc.rb', line 320

def handle_HARD_BREAK
  add_text("\n")
end

#handle_inline(text, initial_attributes = []) ⇒ Object 



329
330
331
332
333
334
335
336
 
# File 'lib/rdoc/markup/to_rdoc.rb', line 329

def handle_inline(text, initial_attributes = [])
  @attributes = Hash.new(0)
  initial_attributes.each { |attr| on(attr) }
  out = @inline_output = +''
  super(text)
  @inline_output = nil
  out
end

#handle_PLAIN_TEXT(text) ⇒ Object 



276
277
278
 
# File 'lib/rdoc/markup/to_rdoc.rb', line 276

def handle_PLAIN_TEXT(text)
  add_text(text)
end

#handle_REGEXP_HANDLING_TEXT(text) ⇒ Object 



280
281
282
 
# File 'lib/rdoc/markup/to_rdoc.rb', line 280

def handle_REGEXP_HANDLING_TEXT(text)
  add_text(text)
end

#handle_regexp_SUPPRESSED_CROSSREF(text) ⇒ Object

Removes preceding \ from the suppressed crossref target



372
373
374
 
# File 'lib/rdoc/markup/to_rdoc.rb', line 372

def handle_regexp_SUPPRESSED_CROSSREF(text)
  text.sub('\\', '')
end

#handle_STRIKE(target) ⇒ Object 



314
315
316
317
318
 
# File 'lib/rdoc/markup/to_rdoc.rb', line 314

def handle_STRIKE(target)
  on(:STRIKE)
  super
  off(:STRIKE)
end

#handle_TIDYLINK(label_part, url) ⇒ Object 



324
325
326
327
 
# File 'lib/rdoc/markup/to_rdoc.rb', line 324

def handle_TIDYLINK(label_part, url)
  super
  add_text("( #{url} )")
end

#handle_TT(code) ⇒ Object 



308
309
310
311
312
 
# File 'lib/rdoc/markup/to_rdoc.rb', line 308

def handle_TT(code)
  on(:TT)
  super
  off(:TT)
end

#off(attr) ⇒ Object 



342
343
344
345
 
# File 'lib/rdoc/markup/to_rdoc.rb', line 342

def off(attr)
  @attributes[attr] -= 1
  @attributes.delete(attr) if @attributes[attr] == 0
end

#on(attr) ⇒ Object 



338
339
340
 
# File 'lib/rdoc/markup/to_rdoc.rb', line 338

def on(attr)
  @attributes[attr] += 1
end

#start_accepting ⇒ Object

Prepares the visitor for text generation



379
380
381
382
383
384
385
386
387
 
# File 'lib/rdoc/markup/to_rdoc.rb', line 379

def start_accepting
  @res = [""]
  @indent = 0
  @prefix = nil

  @list_index = []
  @list_type  = []
  @list_width = []
end

#use_prefix ⇒ Object

Adds the stored #prefix to the output and clears it. Lists generate a prefix for later consumption.



393
394
395
396
397
398
 
# File 'lib/rdoc/markup/to_rdoc.rb', line 393

def use_prefix
  prefix, @prefix = @prefix, nil
  @res << prefix if prefix

  prefix
end

#wrap(text) ⇒ Object

Wraps text to #width



403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
 
# File 'lib/rdoc/markup/to_rdoc.rb', line 403

def wrap(text)
  return unless text && !text.empty?

  text_len = @width - @indent

  text_len = 20 if text_len < 20

  next_prefix = ' ' * @indent

  prefix = @prefix || next_prefix
  @prefix = nil

  text.scan(/\G(?:([^ \n]{#{text_len}})(?=[^ \n])|(.{1,#{text_len}})(?:[ \n]|\z))/) do
    @res << prefix << ($1 || $2) << "\n"
    prefix = next_prefix
  end
end