redcloth-rename.patch

rename of the included modified redcloth library - Gerrit Kaiser, 2008-08-26 03:01

Download (75.7 KB)

View differences:

lib/redcloth.rb
1
#                                vim:ts=4:sw=4:
2
# = RedCloth - Textile and Markdown Hybrid for Ruby
3
#
4
# Homepage::  http://whytheluckystiff.net/ruby/redcloth/
5
# Author::    why the lucky stiff (http://whytheluckystiff.net/)
6
# Copyright:: (cc) 2004 why the lucky stiff (and his puppet organizations.)
7
# License::   BSD
8
#
9
# (see http://hobix.com/textile/ for a Textile Reference.)
10
#
11
# Based on (and also inspired by) both:
12
#
13
# PyTextile: http://diveintomark.org/projects/textile/textile.py.txt
14
# Textism for PHP: http://www.textism.com/tools/textile/
15
#
16
#
17

  
18
# = RedCloth
19
#
20
# RedCloth is a Ruby library for converting Textile and/or Markdown
21
# into HTML.  You can use either format, intermingled or separately.
22
# You can also extend RedCloth to honor your own custom text stylings.
23
#
24
# RedCloth users are encouraged to use Textile if they are generating
25
# HTML and to use Markdown if others will be viewing the plain text.
26
#
27
# == What is Textile?
28
#
29
# Textile is a simple formatting style for text
30
# documents, loosely based on some HTML conventions.
31
#
32
# == Sample Textile Text
33
#
34
#  h2. This is a title
35
#
36
#  h3. This is a subhead
37
#
38
#  This is a bit of paragraph.
39
#
40
#  bq. This is a blockquote.
41
#
42
# = Writing Textile
43
#
44
# A Textile document consists of paragraphs.  Paragraphs
45
# can be specially formatted by adding a small instruction
46
# to the beginning of the paragraph.
47
#
48
#  h[n].   Header of size [n].
49
#  bq.     Blockquote.
50
#  #       Numeric list.
51
#  *       Bulleted list.
52
#
53
# == Quick Phrase Modifiers
54
#
55
# Quick phrase modifiers are also included, to allow formatting
56
# of small portions of text within a paragraph.
57
#
58
#  \_emphasis\_
59
#  \_\_italicized\_\_
60
#  \*strong\*
61
#  \*\*bold\*\*
62
#  ??citation??
63
#  -deleted text-
64
#  +inserted text+
65
#  ^superscript^
66
#  ~subscript~
67
#  @code@
68
#  %(classname)span%
69
#
70
#  ==notextile== (leave text alone)
71
#
72
# == Links
73
#
74
# To make a hypertext link, put the link text in "quotation 
75
# marks" followed immediately by a colon and the URL of the link.
76
# 
77
# Optional: text in (parentheses) following the link text, 
78
# but before the closing quotation mark, will become a Title 
79
# attribute for the link, visible as a tool tip when a cursor is above it.
80
# 
81
# Example:
82
#
83
#  "This is a link (This is a title) ":http://www.textism.com
84
# 
85
# Will become:
86
# 
87
#  <a href="http://www.textism.com" title="This is a title">This is a link</a>
88
#
89
# == Images
90
#
91
# To insert an image, put the URL for the image inside exclamation marks.
92
#
93
# Optional: text that immediately follows the URL in (parentheses) will 
94
# be used as the Alt text for the image. Images on the web should always 
95
# have descriptive Alt text for the benefit of readers using non-graphical 
96
# browsers.
97
#
98
# Optional: place a colon followed by a URL immediately after the 
99
# closing ! to make the image into a link.
100
# 
101
# Example:
102
#
103
#  !http://www.textism.com/common/textist.gif(Textist)!
104
#
105
# Will become:
106
#
107
#  <img src="http://www.textism.com/common/textist.gif" alt="Textist" />
108
#
109
# With a link:
110
#
111
#  !/common/textist.gif(Textist)!:http://textism.com
112
#
113
# Will become:
114
#
115
#  <a href="http://textism.com"><img src="/common/textist.gif" alt="Textist" /></a>
116
#
117
# == Defining Acronyms
118
#
119
# HTML allows authors to define acronyms via the tag. The definition appears as a 
120
# tool tip when a cursor hovers over the acronym. A crucial aid to clear writing, 
121
# this should be used at least once for each acronym in documents where they appear.
122
#
123
# To quickly define an acronym in Textile, place the full text in (parentheses) 
124
# immediately following the acronym.
125
# 
126
# Example:
127
#
128
#  ACLU(American Civil Liberties Union)
129
#
130
# Will become:
131
#
132
#  <acronym title="American Civil Liberties Union">ACLU</acronym>
133
#
134
# == Adding Tables
135
#
136
# In Textile, simple tables can be added by seperating each column by
137
# a pipe.
138
#
139
#     |a|simple|table|row|
140
#     |And|Another|table|row|
141
#
142
# Attributes are defined by style definitions in parentheses.
143
#
144
#     table(border:1px solid black).
145
#     (background:#ddd;color:red). |{}| | | |
146
#
147
# == Using RedCloth
148
# 
149
# RedCloth is simply an extension of the String class, which can handle
150
# Textile formatting.  Use it like a String and output HTML with its
151
# RedCloth#to_html method.
152
#
153
#  doc = RedCloth.new "
154
#
155
#  h2. Test document
156
#
157
#  Just a simple test."
158
#
159
#  puts doc.to_html
160
#
161
# By default, RedCloth uses both Textile and Markdown formatting, with
162
# Textile formatting taking precedence.  If you want to turn off Markdown
163
# formatting, to boost speed and limit the processor:
164
#
165
#  class RedCloth::Textile.new( str )
166

  
167
class RedCloth < String
168

  
169
    VERSION = '3.0.4'
170
    DEFAULT_RULES = [:textile, :markdown]
171

  
172
    #
173
    # Two accessor for setting security restrictions.
174
    #
175
    # This is a nice thing if you're using RedCloth for
176
    # formatting in public places (e.g. Wikis) where you
177
    # don't want users to abuse HTML for bad things.
178
    #
179
    # If +:filter_html+ is set, HTML which wasn't
180
    # created by the Textile processor will be escaped.
181
    #
182
    # If +:filter_styles+ is set, it will also disable
183
    # the style markup specifier. ('{color: red}')
184
    #
185
    attr_accessor :filter_html, :filter_styles
186

  
187
    #
188
    # Accessor for toggling hard breaks.
189
    #
190
    # If +:hard_breaks+ is set, single newlines will
191
    # be converted to HTML break tags.  This is the
192
    # default behavior for traditional RedCloth.
193
    #
194
    attr_accessor :hard_breaks
195

  
196
    # Accessor for toggling lite mode.
197
    #
198
    # In lite mode, block-level rules are ignored.  This means
199
    # that tables, paragraphs, lists, and such aren't available.
200
    # Only the inline markup for bold, italics, entities and so on.
201
    #
202
    #   r = RedCloth.new( "And then? She *fell*!", [:lite_mode] )
203
    #   r.to_html
204
    #   #=> "And then? She <strong>fell</strong>!"
205
    #
206
    attr_accessor :lite_mode
207

  
208
    #
209
    # Accessor for toggling span caps.
210
    #
211
    # Textile places `span' tags around capitalized
212
    # words by default, but this wreaks havoc on Wikis.
213
    # If +:no_span_caps+ is set, this will be
214
    # suppressed.
215
    #
216
    attr_accessor :no_span_caps
217

  
218
    #
219
    # Establishes the markup predence.  Available rules include:
220
    #
221
    # == Textile Rules
222
    #
223
    # The following textile rules can be set individually.  Or add the complete
224
    # set of rules with the single :textile rule, which supplies the rule set in
225
    # the following precedence:
226
    #
227
    # refs_textile::          Textile references (i.e. [hobix]http://hobix.com/)
228
    # block_textile_table::   Textile table block structures
229
    # block_textile_lists::   Textile list structures
230
    # block_textile_prefix::  Textile blocks with prefixes (i.e. bq., h2., etc.)
231
    # inline_textile_image::  Textile inline images
232
    # inline_textile_link::   Textile inline links
233
    # inline_textile_span::   Textile inline spans
234
    # glyphs_textile:: Textile entities (such as em-dashes and smart quotes)
235
    #
236
    # == Markdown
237
    #
238
    # refs_markdown::         Markdown references (for example: [hobix]: http://hobix.com/)
239
    # block_markdown_setext:: Markdown setext headers
240
    # block_markdown_atx::    Markdown atx headers
241
    # block_markdown_rule::   Markdown horizontal rules
242
    # block_markdown_bq::     Markdown blockquotes
243
    # block_markdown_lists::  Markdown lists
244
    # inline_markdown_link::  Markdown links
245
    attr_accessor :rules
246

  
247
    # Returns a new RedCloth object, based on _string_ and
248
    # enforcing all the included _restrictions_.
249
    #
250
    #   r = RedCloth.new( "h1. A <b>bold</b> man", [:filter_html] )
251
    #   r.to_html
252
    #     #=>"<h1>A &lt;b&gt;bold&lt;/b&gt; man</h1>"
253
    #
254
    def initialize( string, restrictions = [] )
255
        restrictions.each { |r| method( "#{ r }=" ).call( true ) }
256
        super( string )
257
    end
258

  
259
    #
260
    # Generates HTML from the Textile contents.
261
    #
262
    #   r = RedCloth.new( "And then? She *fell*!" )
263
    #   r.to_html( true )
264
    #     #=>"And then? She <strong>fell</strong>!"
265
    #
266
    def to_html( *rules )
267
        rules = DEFAULT_RULES if rules.empty?
268
        # make our working copy
269
        text = self.dup
270
        
271
        @urlrefs = {}
272
        @shelf = []
273
        textile_rules = [:refs_textile, :block_textile_table, :block_textile_lists,
274
                         :block_textile_prefix, :inline_textile_image, :inline_textile_link,
275
                         :inline_textile_code, :inline_textile_span]
276
        markdown_rules = [:refs_markdown, :block_markdown_setext, :block_markdown_atx, :block_markdown_rule,
277
                          :block_markdown_bq, :block_markdown_lists, 
278
                          :inline_markdown_reflink, :inline_markdown_link]
279
        @rules = rules.collect do |rule|
280
            case rule
281
            when :markdown
282
                markdown_rules
283
            when :textile
284
                textile_rules
285
            else
286
                rule
287
            end
288
        end.flatten
289

  
290
        # standard clean up
291
        incoming_entities text 
292
        clean_white_space text 
293

  
294
        # start processor
295
        @pre_list = []
296
        rip_offtags text
297
        no_textile text
298
        escape_html_tags text
299
        hard_break text 
300
        unless @lite_mode
301
            refs text
302
            # need to do this before text is split by #blocks
303
            block_textile_quotes text
304
            blocks text
305
        end
306
        inline text
307
        smooth_offtags text
308

  
309
        retrieve text
310

  
311
        text.gsub!( /<\/?notextile>/, '' )
312
        text.gsub!( /x%x%/, '&#38;' )
313
        clean_html text if filter_html
314
        text.strip!
315
        text
316

  
317
    end
318

  
319
    #######
320
    private
321
    #######
322
    #
323
    # Mapping of 8-bit ASCII codes to HTML numerical entity equivalents.
324
    # (from PyTextile)
325
    #
326
    TEXTILE_TAGS =
327

  
328
        [[128, 8364], [129, 0], [130, 8218], [131, 402], [132, 8222], [133, 8230], 
329
         [134, 8224], [135, 8225], [136, 710], [137, 8240], [138, 352], [139, 8249], 
330
         [140, 338], [141, 0], [142, 0], [143, 0], [144, 0], [145, 8216], [146, 8217], 
331
         [147, 8220], [148, 8221], [149, 8226], [150, 8211], [151, 8212], [152, 732], 
332
         [153, 8482], [154, 353], [155, 8250], [156, 339], [157, 0], [158, 0], [159, 376]].
333

  
334
        collect! do |a, b|
335
            [a.chr, ( b.zero? and "" or "&#{ b };" )]
336
        end
337

  
338
    #
339
    # Regular expressions to convert to HTML.
340
    #
341
    A_HLGN = /(?:(?:<>|<|>|\=|[()]+)+)/
342
    A_VLGN = /[\-^~]/
343
    C_CLAS = '(?:\([^)]+\))'
344
    C_LNGE = '(?:\[[^\]]+\])'
345
    C_STYL = '(?:\{[^}]+\})'
346
    S_CSPN = '(?:\\\\\d+)'
347
    S_RSPN = '(?:/\d+)'
348
    A = "(?:#{A_HLGN}?#{A_VLGN}?|#{A_VLGN}?#{A_HLGN}?)"
349
    S = "(?:#{S_CSPN}?#{S_RSPN}|#{S_RSPN}?#{S_CSPN}?)"
350
    C = "(?:#{C_CLAS}?#{C_STYL}?#{C_LNGE}?|#{C_STYL}?#{C_LNGE}?#{C_CLAS}?|#{C_LNGE}?#{C_STYL}?#{C_CLAS}?)"
351
    # PUNCT = Regexp::quote( '!"#$%&\'()*+,-./:;<=>?@[\\]^_`{|}~' )
352
    PUNCT = Regexp::quote( '!"#$%&\'*+,-./:;=?@\\^_`|~' )
353
    PUNCT_NOQ = Regexp::quote( '!"#$&\',./:;=?@\\`|' )
354
    PUNCT_Q = Regexp::quote( '*-_+^~%' )
355
    HYPERLINK = '(\S+?)([^\w\s/;=\?]*?)(?=\s|<|$)'
356

  
357
    # Text markup tags, don't conflict with block tags
358
    SIMPLE_HTML_TAGS = [
359
        'tt', 'b', 'i', 'big', 'small', 'em', 'strong', 'dfn', 'code', 
360
        'samp', 'kbd', 'var', 'cite', 'abbr', 'acronym', 'a', 'img', 'br',
361
        'br', 'map', 'q', 'sub', 'sup', 'span', 'bdo'
362
    ]
363

  
364
    QTAGS = [
365
        ['**', 'b', :limit],
366
        ['*', 'strong', :limit],
367
        ['??', 'cite', :limit],
368
        ['-', 'del', :limit],
369
        ['__', 'i', :limit],
370
        ['_', 'em', :limit],
371
        ['%', 'span', :limit],
372
        ['+', 'ins', :limit],
373
        ['^', 'sup', :limit],
374
        ['~', 'sub', :limit]
375
    ] 
376
    QTAGS.collect! do |rc, ht, rtype|
377
        rcq = Regexp::quote rc
378
        re =
379
            case rtype
380
            when :limit
381
                /(^|[>\s\(])
382
                (#{rcq})
383
                (#{C})
384
                (?::(\S+?))?
385
                ([^\s\-].*?[^\s\-]|\w)
386
                #{rcq}
387
                (?=[[:punct:]]|\s|\)|$)/x
388
            else
389
                /(#{rcq})
390
                (#{C})
391
                (?::(\S+))?
392
                ([^\s\-].*?[^\s\-]|\w)
393
                #{rcq}/xm 
394
            end
395
        [rc, ht, re, rtype]
396
    end
397

  
398
    # Elements to handle
399
    GLYPHS = [
400
    #   [ /([^\s\[{(>])?\'([dmst]\b|ll\b|ve\b|\s|:|$)/, '\1&#8217;\2' ], # single closing
401
    #   [ /([^\s\[{(>#{PUNCT_Q}][#{PUNCT_Q}]*)\'/, '\1&#8217;' ], # single closing
402
    #   [ /\'(?=[#{PUNCT_Q}]*(s\b|[\s#{PUNCT_NOQ}]))/, '&#8217;' ], # single closing
403
    #   [ /\'/, '&#8216;' ], # single opening
404
        [ /</, '&lt;' ], # less-than
405
        [ />/, '&gt;' ], # greater-than
406
    #   [ /([^\s\[{(])?"(\s|:|$)/, '\1&#8221;\2' ], # double closing
407
    #   [ /([^\s\[{(>#{PUNCT_Q}][#{PUNCT_Q}]*)"/, '\1&#8221;' ], # double closing
408
    #   [ /"(?=[#{PUNCT_Q}]*[\s#{PUNCT_NOQ}])/, '&#8221;' ], # double closing
409
    #   [ /"/, '&#8220;' ], # double opening
410
        [ /\b( )?\.{3}/, '\1&#8230;' ], # ellipsis
411
        [ /\b([A-Z][A-Z0-9]{2,})\b(?:[(]([^)]*)[)])/, '<acronym title="\2">\1</acronym>' ], # 3+ uppercase acronym
412
        [ /(^|[^"][>\s])([A-Z][A-Z0-9 ]+[A-Z0-9])([^<A-Za-z0-9]|$)/, '\1<span class="caps">\2</span>\3', :no_span_caps ], # 3+ uppercase caps
413
        [ /(\.\s)?\s?--\s?/, '\1&#8212;' ], # em dash
414
        [ /\s->\s/, ' &rarr; ' ], # right arrow
415
        [ /\s-\s/, ' &#8211; ' ], # en dash
416
        [ /(\d+) ?x ?(\d+)/, '\1&#215;\2' ], # dimension sign
417
        [ /\b ?[(\[]TM[\])]/i, '&#8482;' ], # trademark
418
        [ /\b ?[(\[]R[\])]/i, '&#174;' ], # registered
419
        [ /\b ?[(\[]C[\])]/i, '&#169;' ] # copyright
420
    ]
421

  
422
    H_ALGN_VALS = {
423
        '<' => 'left',
424
        '=' => 'center',
425
        '>' => 'right',
426
        '<>' => 'justify'
427
    }
428

  
429
    V_ALGN_VALS = {
430
        '^' => 'top',
431
        '-' => 'middle',
432
        '~' => 'bottom'
433
    }
434

  
435
    #
436
    # Flexible HTML escaping
437
    #
438
    def htmlesc( str, mode )
439
        str.gsub!( '&', '&amp;' )
440
        str.gsub!( '"', '&quot;' ) if mode != :NoQuotes
441
        str.gsub!( "'", '&#039;' ) if mode == :Quotes
442
        str.gsub!( '<', '&lt;')
443
        str.gsub!( '>', '&gt;')
444
    end
445

  
446
    # Search and replace for Textile glyphs (quotes, dashes, other symbols)
447
    def pgl( text )
448
        GLYPHS.each do |re, resub, tog|
449
            next if tog and method( tog ).call
450
            text.gsub! re, resub
451
        end
452
    end
453

  
454
    # Parses Textile attribute lists and builds an HTML attribute string
455
    def pba( text_in, element = "" )
456
        
457
        return '' unless text_in
458

  
459
        style = []
460
        text = text_in.dup
461
        if element == 'td'
462
            colspan = $1 if text =~ /\\(\d+)/
463
            rowspan = $1 if text =~ /\/(\d+)/
464
            style << "vertical-align:#{ v_align( $& ) };" if text =~ A_VLGN
465
        end
466

  
467
        style << "#{ $1 };" if not filter_styles and
468
            text.sub!( /\{([^}]*)\}/, '' )
469

  
470
        lang = $1 if
471
            text.sub!( /\[([^)]+?)\]/, '' )
472

  
473
        cls = $1 if
474
            text.sub!( /\(([^()]+?)\)/, '' )
475
                        
476
        style << "padding-left:#{ $1.length }em;" if
477
            text.sub!( /([(]+)/, '' )
478

  
479
        style << "padding-right:#{ $1.length }em;" if text.sub!( /([)]+)/, '' )
480

  
481
        style << "text-align:#{ h_align( $& ) };" if text =~ A_HLGN
482

  
483
        cls, id = $1, $2 if cls =~ /^(.*?)#(.*)$/
484
        
485
        atts = ''
486
        atts << " style=\"#{ style.join }\"" unless style.empty?
487
        atts << " class=\"#{ cls }\"" unless cls.to_s.empty?
488
        atts << " lang=\"#{ lang }\"" if lang
489
        atts << " id=\"#{ id }\"" if id
490
        atts << " colspan=\"#{ colspan }\"" if colspan
491
        atts << " rowspan=\"#{ rowspan }\"" if rowspan
492
        
493
        atts
494
    end
495

  
496
    TABLE_RE = /^(?:table(_?#{S}#{A}#{C})\. ?\n)?^(#{A}#{C}\.? ?\|.*?\|)(\n\n|\Z)/m
497
    
498
    # Parses a Textile table block, building HTML from the result.
499
    def block_textile_table( text ) 
500
        text.gsub!( TABLE_RE ) do |matches|
501

  
502
            tatts, fullrow = $~[1..2]
503
            tatts = pba( tatts, 'table' )
504
            tatts = shelve( tatts ) if tatts
505
            rows = []
506

  
507
            fullrow.each_line do |row|
508
                ratts, row = pba( $1, 'tr' ), $2 if row =~ /^(#{A}#{C}\. )(.*)/m
509
                cells = []
510
                row.split( /(\|)(?![^\[\|]*\]\])/ )[1..-2].each do |cell|
511
                    next if cell == '|'
512
                    ctyp = 'd'
513
                    ctyp = 'h' if cell =~ /^_/
514

  
515
                    catts = ''
516
                    catts, cell = pba( $1, 'td' ), $2 if cell =~ /^(_?#{S}#{A}#{C}\. ?)(.*)/
517

  
518
                    catts = shelve( catts ) if catts
519
                    cells << "\t\t\t<t#{ ctyp }#{ catts }>#{ cell }</t#{ ctyp }>" 
520
                end
521
                ratts = shelve( ratts ) if ratts
522
                rows << "\t\t<tr#{ ratts }>\n#{ cells.join( "\n" ) }\n\t\t</tr>"
523
            end
524
            "\t<table#{ tatts }>\n#{ rows.join( "\n" ) }\n\t</table>\n\n"
525
        end
526
    end
527

  
528
    LISTS_RE = /^([#*]+?#{C} .*?)$(?![^#*])/m
529
    LISTS_CONTENT_RE = /^([#*]+)(#{A}#{C}) (.*)$/m
530

  
531
    # Parses Textile lists and generates HTML
532
    def block_textile_lists( text ) 
533
        text.gsub!( LISTS_RE ) do |match|
534
            lines = match.split( /\n/ )
535
            last_line = -1
536
            depth = []
537
            lines.each_with_index do |line, line_id|
538
                if line =~ LISTS_CONTENT_RE 
539
                    tl,atts,content = $~[1..3]
540
                    if depth.last
541
                        if depth.last.length > tl.length
542
                            (depth.length - 1).downto(0) do |i|
543
                                break if depth[i].length == tl.length
544
                                lines[line_id - 1] << "</li>\n\t</#{ lT( depth[i] ) }l>\n\t"
545
                                depth.pop
546
                            end
547
                        end
548
                        if depth.last and depth.last.length == tl.length
549
                            lines[line_id - 1] << '</li>'
550
                        end
551
                    end
552
                    unless depth.last == tl
553
                        depth << tl
554
                        atts = pba( atts )
555
                        atts = shelve( atts ) if atts
556
                        lines[line_id] = "\t<#{ lT(tl) }l#{ atts }>\n\t<li>#{ content }"
557
                    else
558
                        lines[line_id] = "\t\t<li>#{ content }"
559
                    end
560
                    last_line = line_id
561

  
562
                else
563
                    last_line = line_id
564
                end
565
                if line_id - last_line > 1 or line_id == lines.length - 1
566
                    depth.delete_if do |v|
567
                        lines[last_line] << "</li>\n\t</#{ lT( v ) }l>"
568
                    end
569
                end
570
            end
571
            lines.join( "\n" )
572
        end
573
    end
574
    
575
    QUOTES_RE = /(^>+([^\n]*?)\n?)+/m
576
    QUOTES_CONTENT_RE = /^([> ]+)(.*)$/m
577
    
578
    def block_textile_quotes( text )
579
      text.gsub!( QUOTES_RE ) do |match|
580
        lines = match.split( /\n/ )
581
        quotes = ''
582
        indent = 0
583
        lines.each do |line|
584
          line =~ QUOTES_CONTENT_RE 
585
          bq,content = $1, $2
586
          l = bq.count('>')
587
          if l != indent
588
            quotes << ("\n\n" + (l>indent ? '<blockquote>' * (l-indent) : '</blockquote>' * (indent-l)) + "\n\n")
589
            indent = l
590
          end
591
          quotes << (content + "\n")
592
        end
593
        quotes << ("\n" + '</blockquote>' * indent + "\n\n")
594
        quotes
595
      end
596
    end
597

  
598
    CODE_RE = /(\W)
599
        @
600
        (?:\|(\w+?)\|)?
601
        (.+?)
602
        @
603
        (?=\W)/x
604

  
605
    def inline_textile_code( text ) 
606
        text.gsub!( CODE_RE ) do |m|
607
            before,lang,code,after = $~[1..4]
608
            lang = " lang=\"#{ lang }\"" if lang
609
            rip_offtags( "#{ before }<code#{ lang }>#{ code }</code>#{ after }" )
610
        end
611
    end
612

  
613
    def lT( text ) 
614
        text =~ /\#$/ ? 'o' : 'u'
615
    end
616

  
617
    def hard_break( text )
618
        text.gsub!( /(.)\n(?!\Z| *([#*=]+(\s|$)|[{|]))/, "\\1<br />" ) if hard_breaks
619
    end
620

  
621
    BLOCKS_GROUP_RE = /\n{2,}(?! )/m
622

  
623
    def blocks( text, deep_code = false )
624
        text.replace( text.split( BLOCKS_GROUP_RE ).collect do |blk|
625
            plain = blk !~ /\A[#*> ]/
626

  
627
            # skip blocks that are complex HTML
628
            if blk =~ /^<\/?(\w+).*>/ and not SIMPLE_HTML_TAGS.include? $1
629
                blk
630
            else
631
                # search for indentation levels
632
                blk.strip!
633
                if blk.empty?
634
                    blk
635
                else
636
                    code_blk = nil
637
                    blk.gsub!( /((?:\n(?:\n^ +[^\n]*)+)+)/m ) do |iblk|
638
                        flush_left iblk
639
                        blocks iblk, plain
640
                        iblk.gsub( /^(\S)/, "\t\\1" )
641
                        if plain
642
                            code_blk = iblk; ""
643
                        else
644
                            iblk
645
                        end
646
                    end
647

  
648
                    block_applied = 0 
649
                    @rules.each do |rule_name|
650
                        block_applied += 1 if ( rule_name.to_s.match /^block_/ and method( rule_name ).call( blk ) )
651
                    end
652
                    if block_applied.zero?
653
                        if deep_code
654
                            blk = "\t<pre><code>#{ blk }</code></pre>"
655
                        else
656
                            blk = "\t<p>#{ blk }</p>"
657
                        end
658
                    end
659
                    # hard_break blk
660
                    blk + "\n#{ code_blk }"
661
                end
662
            end
663

  
664
        end.join( "\n\n" ) )
665
    end
666

  
667
    def textile_bq( tag, atts, cite, content )
668
        cite, cite_title = check_refs( cite )
669
        cite = " cite=\"#{ cite }\"" if cite
670
        atts = shelve( atts ) if atts
671
        "\t<blockquote#{ cite }>\n\t\t<p#{ atts }>#{ content }</p>\n\t</blockquote>"
672
    end
673

  
674
    def textile_p( tag, atts, cite, content )
675
        atts = shelve( atts ) if atts
676
        "\t<#{ tag }#{ atts }>#{ content }</#{ tag }>"
677
    end
678

  
679
    alias textile_h1 textile_p
680
    alias textile_h2 textile_p
681
    alias textile_h3 textile_p
682
    alias textile_h4 textile_p
683
    alias textile_h5 textile_p
684
    alias textile_h6 textile_p
685

  
686
    def textile_fn_( tag, num, atts, cite, content )
687
        atts << " id=\"fn#{ num }\""
688
        content = "<sup>#{ num }</sup> #{ content }"
689
        atts = shelve( atts ) if atts
690
        "\t<p#{ atts }>#{ content }</p>"
691
    end
692

  
693
    BLOCK_RE = /^(([a-z]+)(\d*))(#{A}#{C})\.(?::(\S+))? (.*)$/m
694

  
695
    def block_textile_prefix( text ) 
696
        if text =~ BLOCK_RE
697
            tag,tagpre,num,atts,cite,content = $~[1..6]
698
            atts = pba( atts )
699

  
700
            # pass to prefix handler
701
            if respond_to? "textile_#{ tag }", true
702
                text.gsub!( $&, method( "textile_#{ tag }" ).call( tag, atts, cite, content ) )
703
            elsif respond_to? "textile_#{ tagpre }_", true
704
                text.gsub!( $&, method( "textile_#{ tagpre }_" ).call( tagpre, num, atts, cite, content ) )
705
            end
706
        end
707
    end
708
    
709
    SETEXT_RE = /\A(.+?)\n([=-])[=-]* *$/m
710
    def block_markdown_setext( text )
711
        if text =~ SETEXT_RE
712
            tag = if $2 == "="; "h1"; else; "h2"; end
713
            blk, cont = "<#{ tag }>#{ $1 }</#{ tag }>", $'
714
            blocks cont
715
            text.replace( blk + cont )
716
        end
717
    end
718

  
719
    ATX_RE = /\A(\#{1,6})  # $1 = string of #'s
720
              [ ]*
721
              (.+?)       # $2 = Header text
722
              [ ]*
723
              \#*         # optional closing #'s (not counted)
724
              $/x
725
    def block_markdown_atx( text )
726
        if text =~ ATX_RE
727
            tag = "h#{ $1.length }"
728
            blk, cont = "<#{ tag }>#{ $2 }</#{ tag }>\n\n", $'
729
            blocks cont
730
            text.replace( blk + cont )
731
        end
732
    end
733

  
734
    MARKDOWN_BQ_RE = /\A(^ *> ?.+$(.+\n)*\n*)+/m
735

  
736
    def block_markdown_bq( text )
737
        text.gsub!( MARKDOWN_BQ_RE ) do |blk|
738
            blk.gsub!( /^ *> ?/, '' )
739
            flush_left blk
740
            blocks blk
741
            blk.gsub!( /^(\S)/, "\t\\1" )
742
            "<blockquote>\n#{ blk }\n</blockquote>\n\n"
743
        end
744
    end
745

  
746
    MARKDOWN_RULE_RE = /^(#{
747
        ['*', '-', '_'].collect { |ch| ' ?(' + Regexp::quote( ch ) + ' ?){3,}' }.join( '|' )
748
    })$/
749

  
750
    def block_markdown_rule( text )
751
        text.gsub!( MARKDOWN_RULE_RE ) do |blk|
752
            "<hr />"
753
        end
754
    end
755

  
756
    # XXX TODO XXX
757
    def block_markdown_lists( text )
758
    end
759

  
760
    def inline_textile_span( text ) 
761
        QTAGS.each do |qtag_rc, ht, qtag_re, rtype|
762
            text.gsub!( qtag_re ) do |m|
763
             
764
                case rtype
765
                when :limit
766
                    sta,qtag,atts,cite,content = $~[1..5]
767
                else
768
                    qtag,atts,cite,content = $~[1..4]
769
                    sta = ''
770
                end
771
                atts = pba( atts )
772
                atts << " cite=\"#{ cite }\"" if cite
773
                atts = shelve( atts ) if atts
774

  
775
                "#{ sta }<#{ ht }#{ atts }>#{ content }</#{ ht }>"
776

  
777
            end
778
        end
779
    end
780

  
781
    LINK_RE = /
782
            ([\s\[{(]|[#{PUNCT}])?     # $pre
783
            "                          # start
784
            (#{C})                     # $atts
785
            ([^"\n]+?)                 # $text
786
            \s?
787
            (?:\(([^)]+?)\)(?="))?     # $title
788
            ":
789
            ([\w\/]\S+?)               # $url
790
            (\/)?                      # $slash
791
            ([^\w\/;]*?)               # $post
792
            (?=<|\s|$)
793
        /x 
794

  
795
    def inline_textile_link( text ) 
796
        text.gsub!( LINK_RE ) do |m|
797
            pre,atts,text,title,url,slash,post = $~[1..7]
798

  
799
            url, url_title = check_refs( url )
800
            title ||= url_title
801
            
802
            atts = pba( atts )
803
            atts = " href=\"#{ url }#{ slash }\"#{ atts }"
804
            atts << " title=\"#{ title }\"" if title
805
            atts = shelve( atts ) if atts
806
            
807
            external = (url =~ /^https?:\/\//) ? ' class="external"' : ''
808
            
809
            "#{ pre }<a#{ atts }#{ external }>#{ text }</a>#{ post }"
810
        end
811
    end
812

  
813
    MARKDOWN_REFLINK_RE = /
814
            \[([^\[\]]+)\]      # $text
815
            [ ]?                # opt. space
816
            (?:\n[ ]*)?         # one optional newline followed by spaces
817
            \[(.*?)\]           # $id
818
        /x 
819

  
820
    def inline_markdown_reflink( text ) 
821
        text.gsub!( MARKDOWN_REFLINK_RE ) do |m|
822
            text, id = $~[1..2]
823

  
824
            if id.empty?
825
                url, title = check_refs( text )
826
            else
827
                url, title = check_refs( id )
828
            end
829
            
830
            atts = " href=\"#{ url }\""
831
            atts << " title=\"#{ title }\"" if title
832
            atts = shelve( atts )
833
            
834
            "<a#{ atts }>#{ text }</a>"
835
        end
836
    end
837

  
838
    MARKDOWN_LINK_RE = /
839
            \[([^\[\]]+)\]      # $text
840
            \(                  # open paren
841
            [ \t]*              # opt space
842
            <?(.+?)>?           # $href
843
            [ \t]*              # opt space
844
            (?:                 # whole title
845
            (['"])              # $quote
846
            (.*?)               # $title
847
            \3                  # matching quote
848
            )?                  # title is optional
849
            \)
850
        /x 
851

  
852
    def inline_markdown_link( text ) 
853
        text.gsub!( MARKDOWN_LINK_RE ) do |m|
854
            text, url, quote, title = $~[1..4]
855

  
856
            atts = " href=\"#{ url }\""
857
            atts << " title=\"#{ title }\"" if title
858
            atts = shelve( atts )
859
            
860
            "<a#{ atts }>#{ text }</a>"
861
        end
862
    end
863

  
864
    TEXTILE_REFS_RE =  /(^ *)\[([^\[\n]+?)\](#{HYPERLINK})(?=\s|$)/
865
    MARKDOWN_REFS_RE = /(^ *)\[([^\n]+?)\]:\s+<?(#{HYPERLINK})>?(?:\s+"((?:[^"]|\\")+)")?(?=\s|$)/m
866

  
867
    def refs( text )
868
        @rules.each do |rule_name|
869
            method( rule_name ).call( text ) if rule_name.to_s.match /^refs_/
870
        end
871
    end
872

  
873
    def refs_textile( text ) 
874
        text.gsub!( TEXTILE_REFS_RE ) do |m|
875
            flag, url = $~[2..3]
876
            @urlrefs[flag.downcase] = [url, nil]
877
            nil
878
        end
879
    end
880
    
881
    def refs_markdown( text )
882
        text.gsub!( MARKDOWN_REFS_RE ) do |m|
883
            flag, url = $~[2..3]
884
            title = $~[6]
885
            @urlrefs[flag.downcase] = [url, title]
886
            nil
887
        end
888
    end
889

  
890
    def check_refs( text ) 
891
        ret = @urlrefs[text.downcase] if text
892
        ret || [text, nil]
893
    end
894

  
895
    IMAGE_RE = /
896
            (<p>|.|^)            # start of line?
897
            \!                   # opening
898
            (\<|\=|\>)?          # optional alignment atts
899
            (#{C})               # optional style,class atts
900
            (?:\. )?             # optional dot-space
901
            ([^\s(!]+?)          # presume this is the src
902
            \s?                  # optional space
903
            (?:\(((?:[^\(\)]|\([^\)]+\))+?)\))?   # optional title
904
            \!                   # closing
905
            (?::#{ HYPERLINK })? # optional href
906
        /x 
907

  
908
    def inline_textile_image( text ) 
909
        text.gsub!( IMAGE_RE )  do |m|
910
            stln,algn,atts,url,title,href,href_a1,href_a2 = $~[1..8]
911
            atts = pba( atts )
912
            atts = " src=\"#{ url }\"#{ atts }"
913
            atts << " title=\"#{ title }\"" if title
914
            atts << " alt=\"#{ title }\"" 
915
            # size = @getimagesize($url);
916
            # if($size) $atts.= " $size[3]";
917

  
918
            href, alt_title = check_refs( href ) if href
919
            url, url_title = check_refs( url )
920

  
921
            out = ''
922
            out << "<a#{ shelve( " href=\"#{ href }\"" ) }>" if href
923
            out << "<img#{ shelve( atts ) } />"
924
            out << "</a>#{ href_a1 }#{ href_a2 }" if href
925
            
926
            if algn 
927
                algn = h_align( algn )
928
                if stln == "<p>"
929
                    out = "<p style=\"float:#{ algn }\">#{ out }"
930
                else
931
                    out = "#{ stln }<div style=\"float:#{ algn }\">#{ out }</div>"
932
                end
933
            else
934
                out = stln + out
935
            end
936

  
937
            out
938
        end
939
    end
940

  
941
    def shelve( val ) 
942
        @shelf << val
943
        " :redsh##{ @shelf.length }:"
944
    end
945
    
946
    def retrieve( text ) 
947
        @shelf.each_with_index do |r, i|
948
            text.gsub!( " :redsh##{ i + 1 }:", r )
949
        end
950
    end
951

  
952
    def incoming_entities( text ) 
953
        ## turn any incoming ampersands into a dummy character for now.
954
        ## This uses a negative lookahead for alphanumerics followed by a semicolon,
955
        ## implying an incoming html entity, to be skipped
956

  
957
        text.gsub!( /&(?![#a-z0-9]+;)/i, "x%x%" )
958
    end
959

  
960
    def no_textile( text ) 
961
        text.gsub!( /(^|\s)==([^=]+.*?)==(\s|$)?/,
962
            '\1<notextile>\2</notextile>\3' )
963
        text.gsub!( /^ *==([^=]+.*?)==/m,
964
            '\1<notextile>\2</notextile>\3' )
965
    end
966

  
967
    def clean_white_space( text ) 
968
        # normalize line breaks
969
        text.gsub!( /\r\n/, "\n" )
970
        text.gsub!( /\r/, "\n" )
971
        text.gsub!( /\t/, '    ' )
972
        text.gsub!( /^ +$/, '' )
973
        text.gsub!( /\n{3,}/, "\n\n" )
974
        text.gsub!( /"$/, "\" " )
975

  
976
        # if entire document is indented, flush
977
        # to the left side
978
        flush_left text
979
    end
980

  
981
    def flush_left( text )
982
        indt = 0
983
        if text =~ /^ /
984
            while text !~ /^ {#{indt}}\S/
985
                indt += 1
986
            end unless text.empty?
987
            if indt.nonzero?
988
                text.gsub!( /^ {#{indt}}/, '' )
989
            end
990
        end
991
    end
992

  
993
    def footnote_ref( text ) 
994
        text.gsub!( /\b\[([0-9]+?)\](\s)?/,
995
            '<sup><a href="#fn\1">\1</a></sup>\2' )
996
    end
997
    
998
    OFFTAGS = /(code|pre|kbd|notextile)/
999
    OFFTAG_MATCH = /(?:(<\/#{ OFFTAGS }>)|(<#{ OFFTAGS }[^>]*>))(.*?)(?=<\/?#{ OFFTAGS }|\Z)/mi
1000
    OFFTAG_OPEN = /<#{ OFFTAGS }/
1001
    OFFTAG_CLOSE = /<\/?#{ OFFTAGS }/
1002
    HASTAG_MATCH = /(<\/?\w[^\n]*?>)/m
1003
    ALLTAG_MATCH = /(<\/?\w[^\n]*?>)|.*?(?=<\/?\w[^\n]*?>|$)/m
1004

  
1005
    def glyphs_textile( text, level = 0 )
1006
        if text !~ HASTAG_MATCH
1007
            pgl text
1008
            footnote_ref text
1009
        else
1010
            codepre = 0
1011
            text.gsub!( ALLTAG_MATCH ) do |line|
1012
                ## matches are off if we're between <code>, <pre> etc.
1013
                if $1
1014
                    if line =~ OFFTAG_OPEN
1015
                        codepre += 1
1016
                    elsif line =~ OFFTAG_CLOSE
1017
                        codepre -= 1
1018
                        codepre = 0 if codepre < 0
1019
                    end 
1020
                elsif codepre.zero?
1021
                    glyphs_textile( line, level + 1 )
1022
                else
1023
                    htmlesc( line, :NoQuotes )
1024
                end
1025
                # p [level, codepre, line]
1026

  
1027
                line
1028
            end
1029
        end
1030
    end
1031

  
1032
    def rip_offtags( text )
1033
        if text =~ /<.*>/
1034
            ## strip and encode <pre> content
1035
            codepre, used_offtags = 0, {}
1036
            text.gsub!( OFFTAG_MATCH ) do |line|
1037
                if $3
1038
                    offtag, aftertag = $4, $5
1039
                    codepre += 1
1040
                    used_offtags[offtag] = true
1041
                    if codepre - used_offtags.length > 0
1042
                        htmlesc( line, :NoQuotes ) unless used_offtags['notextile']
1043
                        @pre_list.last << line
1044
                        line = ""
1045
                    else
1046
                        htmlesc( aftertag, :NoQuotes ) if aftertag and not used_offtags['notextile']
1047
                        line = "<redpre##{ @pre_list.length }>"
1048
                        @pre_list << "#{ $3 }#{ aftertag }"
1049
                    end
1050
                elsif $1 and codepre > 0
1051
                    if codepre - used_offtags.length > 0
1052
                        htmlesc( line, :NoQuotes ) unless used_offtags['notextile']
1053
                        @pre_list.last << line
1054
                        line = ""
1055
                    end
1056
                    codepre -= 1 unless codepre.zero?
1057
                    used_offtags = {} if codepre.zero?
1058
                end 
1059
                line
1060
            end
1061
        end
1062
        text
1063
    end
1064

  
1065
    def smooth_offtags( text )
1066
        unless @pre_list.empty?
1067
            ## replace <pre> content
1068
            text.gsub!( /<redpre#(\d+)>/ ) { @pre_list[$1.to_i] }
1069
        end
1070
    end
1071

  
1072
    def inline( text ) 
1073
        [/^inline_/, /^glyphs_/].each do |meth_re|
1074
            @rules.each do |rule_name|
1075
                method( rule_name ).call( text ) if rule_name.to_s.match( meth_re )
1076
            end
1077
        end
1078
    end
1079

  
1080
    def h_align( text ) 
1081
        H_ALGN_VALS[text]
1082
    end
1083

  
1084
    def v_align( text ) 
1085
        V_ALGN_VALS[text]
1086
    end
1087

  
1088
    def textile_popup_help( name, windowW, windowH )
1089
        ' <a target="_blank" href="http://hobix.com/textile/#' + helpvar + '" onclick="window.open(this.href, \'popupwindow\', \'width=' + windowW + ',height=' + windowH + ',scrollbars,resizable\'); return false;">' + name + '</a><br />'
1090
    end
1091

  
1092
    # HTML cleansing stuff
1093
    BASIC_TAGS = {
1094
        'a' => ['href', 'title'],
1095
        'img' => ['src', 'alt', 'title'],
1096
        'br' => [],
1097
        'i' => nil,
1098
        'u' => nil, 
1099
        'b' => nil,
1100
        'pre' => nil,
1101
        'kbd' => nil,
1102
        'code' => ['lang'],
1103
        'cite' => nil,
1104
        'strong' => nil,
1105
        'em' => nil,
1106
        'ins' => nil,
1107
        'sup' => nil,
1108
        'sub' => nil,
1109
        'del' => nil,
1110
        'table' => nil,
1111
        'tr' => nil,
1112
        'td' => ['colspan', 'rowspan'],
1113
        'th' => nil,
1114
        'ol' => nil,
1115
        'ul' => nil,
1116
        'li' => nil,
1117
        'p' => nil,
1118
        'h1' => nil,
1119
        'h2' => nil,
1120
        'h3' => nil,
1121
        'h4' => nil,
1122
        'h5' => nil,
1123
        'h6' => nil, 
1124
        'blockquote' => ['cite']
1125
    }
1126

  
1127
    def clean_html( text, tags = BASIC_TAGS )
1128
        text.gsub!( /<!\[CDATA\[/, '' )
1129
        text.gsub!( /<(\/*)(\w+)([^>]*)>/ ) do
1130
            raw = $~
1131
            tag = raw[2].downcase
1132
            if tags.has_key? tag
1133
                pcs = [tag]
1134
                tags[tag].each do |prop|
1135
                    ['"', "'", ''].each do |q|
1136
                        q2 = ( q != '' ? q : '\s' )
1137
                        if raw[3] =~ /#{prop}\s*=\s*#{q}([^#{q2}]+)#{q}/i
1138
                            attrv = $1
1139
                            next if prop == 'src' and attrv =~ %r{^(?!http)\w+:}
1140
                            pcs << "#{prop}=\"#{$1.gsub('"', '\\"')}\""
1141
                            break
1142
                        end
1143
                    end
1144
                end if tags[tag]
1145
                "<#{raw[1]}#{pcs.join " "}>"
1146
            else
1147
                " "
1148
            end
1149
        end
1150
    end
1151
    
1152
    ALLOWED_TAGS = %w(redpre pre code notextile)
1153
    
1154
    def escape_html_tags(text)
1155
      text.gsub!(%r{<(\/?([!\w]+)[^<>\n]*)(>?)}) {|m| ALLOWED_TAGS.include?($2) ? "<#{$1}#{$3}" : "&lt;#{$1}#{'&gt;' unless $3.blank?}" }
1156
    end
1157
end
1158

  
lib/redcloth3.rb
1
#                                vim:ts=4:sw=4:
2
# = RedCloth - Textile and Markdown Hybrid for Ruby
3
#
4
# Homepage::  http://whytheluckystiff.net/ruby/redcloth/
5
# Author::    why the lucky stiff (http://whytheluckystiff.net/)
6
# Copyright:: (cc) 2004 why the lucky stiff (and his puppet organizations.)
7
# License::   BSD
8
#
9
# (see http://hobix.com/textile/ for a Textile Reference.)
10
#
11
# Based on (and also inspired by) both:
12
#
13
# PyTextile: http://diveintomark.org/projects/textile/textile.py.txt
14
# Textism for PHP: http://www.textism.com/tools/textile/
15
#
16
#
17

  
18
# = RedCloth
19
#
20
# RedCloth is a Ruby library for converting Textile and/or Markdown
21
# into HTML.  You can use either format, intermingled or separately.
22
# You can also extend RedCloth to honor your own custom text stylings.
23
#
24
# RedCloth users are encouraged to use Textile if they are generating
25
# HTML and to use Markdown if others will be viewing the plain text.
26
#
27
# == What is Textile?
28
#
29
# Textile is a simple formatting style for text
30
# documents, loosely based on some HTML conventions.
31
#
32
# == Sample Textile Text
33
#
34
#  h2. This is a title
35
#
36
#  h3. This is a subhead
37
#
38
#  This is a bit of paragraph.
39
#
40
#  bq. This is a blockquote.
41
#
42
# = Writing Textile
43
#
44
# A Textile document consists of paragraphs.  Paragraphs
45
# can be specially formatted by adding a small instruction
46
# to the beginning of the paragraph.
47
#
48
#  h[n].   Header of size [n].
49
#  bq.     Blockquote.
50
#  #       Numeric list.
51
#  *       Bulleted list.
52
#
53
# == Quick Phrase Modifiers
54
#
55
# Quick phrase modifiers are also included, to allow formatting
56
# of small portions of text within a paragraph.
57
#
58
#  \_emphasis\_
59
#  \_\_italicized\_\_
60
#  \*strong\*
61
#  \*\*bold\*\*
62
#  ??citation??
63
#  -deleted text-
64
#  +inserted text+
65
#  ^superscript^
66
#  ~subscript~
67
#  @code@
68
#  %(classname)span%
69
#
70
#  ==notextile== (leave text alone)
71
#
72
# == Links
73
#
74
# To make a hypertext link, put the link text in "quotation 
75
# marks" followed immediately by a colon and the URL of the link.
76
# 
77
# Optional: text in (parentheses) following the link text, 
78
# but before the closing quotation mark, will become a Title 
79
# attribute for the link, visible as a tool tip when a cursor is above it.
80
# 
81
# Example:
82
#
83
#  "This is a link (This is a title) ":http://www.textism.com
84
# 
85
# Will become:
86
# 
87
#  <a href="http://www.textism.com" title="This is a title">This is a link</a>
88
#
89
# == Images
90
#
91
# To insert an image, put the URL for the image inside exclamation marks.
92
#
93
# Optional: text that immediately follows the URL in (parentheses) will 
94
# be used as the Alt text for the image. Images on the web should always 
95
# have descriptive Alt text for the benefit of readers using non-graphical 
96
# browsers.
97
#
98
# Optional: place a colon followed by a URL immediately after the 
99
# closing ! to make the image into a link.
100
# 
101
# Example:
102
#
103
#  !http://www.textism.com/common/textist.gif(Textist)!
104
#
105
# Will become:
106
#
107
#  <img src="http://www.textism.com/common/textist.gif" alt="Textist" />
108
#
109
# With a link:
110
#
111
#  !/common/textist.gif(Textist)!:http://textism.com
112
#
113
# Will become:
114
#
115
#  <a href="http://textism.com"><img src="/common/textist.gif" alt="Textist" /></a>
116
#
117
# == Defining Acronyms
118
#
119
# HTML allows authors to define acronyms via the tag. The definition appears as a 
120
# tool tip when a cursor hovers over the acronym. A crucial aid to clear writing, 
121
# this should be used at least once for each acronym in documents where they appear.
122
#
123
# To quickly define an acronym in Textile, place the full text in (parentheses) 
124
# immediately following the acronym.
125
# 
126
# Example:
127
#
128
#  ACLU(American Civil Liberties Union)
129
#
130
# Will become:
131
#
132
#  <acronym title="American Civil Liberties Union">ACLU</acronym>
133
#
134
# == Adding Tables
135
#
136
# In Textile, simple tables can be added by seperating each column by
137
# a pipe.
138
#
139
#     |a|simple|table|row|
140
#     |And|Another|table|row|
141
#
142
# Attributes are defined by style definitions in parentheses.
143
#
144
#     table(border:1px solid black).
145
#     (background:#ddd;color:red). |{}| | | |
146
#
147
# == Using RedCloth
148
# 
149
# RedCloth is simply an extension of the String class, which can handle
150
# Textile formatting.  Use it like a String and output HTML with its
151
# RedCloth#to_html method.
152
#
153
#  doc = RedCloth.new "
154
#
155
#  h2. Test document
156
#
157
#  Just a simple test."
158
#
159
#  puts doc.to_html
160
#
161
# By default, RedCloth uses both Textile and Markdown formatting, with
162
# Textile formatting taking precedence.  If you want to turn off Markdown
163
# formatting, to boost speed and limit the processor:
164
#
165
#  class RedCloth::Textile.new( str )
166

  
167
class RedCloth3 < String
168

  
169
    VERSION = '3.0.4'
170
    DEFAULT_RULES = [:textile, :markdown]
171

  
172
    #
173
    # Two accessor for setting security restrictions.
174
    #
175
    # This is a nice thing if you're using RedCloth for
176
    # formatting in public places (e.g. Wikis) where you
177
    # don't want users to abuse HTML for bad things.
178
    #
179
    # If +:filter_html+ is set, HTML which wasn't
180
    # created by the Textile processor will be escaped.
181
    #
182
    # If +:filter_styles+ is set, it will also disable
183
    # the style markup specifier. ('{color: red}')
184
    #
185
    attr_accessor :filter_html, :filter_styles
186

  
187
    #
188
    # Accessor for toggling hard breaks.
189
    #
190
    # If +:hard_breaks+ is set, single newlines will
191
    # be converted to HTML break tags.  This is the
192
    # default behavior for traditional RedCloth.
193
    #
194
    attr_accessor :hard_breaks
195

  
196
    # Accessor for toggling lite mode.
197
    #
198
    # In lite mode, block-level rules are ignored.  This means
199
    # that tables, paragraphs, lists, and such aren't available.
200
    # Only the inline markup for bold, italics, entities and so on.
201
    #
202
    #   r = RedCloth.new( "And then? She *fell*!", [:lite_mode] )
203
    #   r.to_html
204
    #   #=> "And then? She <strong>fell</strong>!"
205
    #
206
    attr_accessor :lite_mode
207

  
208
    #
209
    # Accessor for toggling span caps.
210
    #
211
    # Textile places `span' tags around capitalized
212
    # words by default, but this wreaks havoc on Wikis.
213
    # If +:no_span_caps+ is set, this will be
214
    # suppressed.
215
    #
216
    attr_accessor :no_span_caps
217

  
218
    #
219
    # Establishes the markup predence.  Available rules include:
220
    #
221
    # == Textile Rules
222
    #
223
    # The following textile rules can be set individually.  Or add the complete
224
    # set of rules with the single :textile rule, which supplies the rule set in
225
    # the following precedence:
226
    #
227
    # refs_textile::          Textile references (i.e. [hobix]http://hobix.com/)
228
    # block_textile_table::   Textile table block structures
229
    # block_textile_lists::   Textile list structures
230
    # block_textile_prefix::  Textile blocks with prefixes (i.e. bq., h2., etc.)
231
    # inline_textile_image::  Textile inline images
232
    # inline_textile_link::   Textile inline links
233
    # inline_textile_span::   Textile inline spans
234
    # glyphs_textile:: Textile entities (such as em-dashes and smart quotes)
235
    #
236
    # == Markdown
237
    #
238
    # refs_markdown::         Markdown references (for example: [hobix]: http://hobix.com/)
239
    # block_markdown_setext:: Markdown setext headers
240
    # block_markdown_atx::    Markdown atx headers
241
    # block_markdown_rule::   Markdown horizontal rules
242
    # block_markdown_bq::     Markdown blockquotes
243
    # block_markdown_lists::  Markdown lists
244
    # inline_markdown_link::  Markdown links
245
    attr_accessor :rules
246

  
247
    # Returns a new RedCloth object, based on _string_ and
248
    # enforcing all the included _restrictions_.
249
    #
250
    #   r = RedCloth.new( "h1. A <b>bold</b> man", [:filter_html] )
251
    #   r.to_html
252
    #     #=>"<h1>A &lt;b&gt;bold&lt;/b&gt; man</h1>"
253
    #
254
    def initialize( string, restrictions = [] )
255
        restrictions.each { |r| method( "#{ r }=" ).call( true ) }
256
        super( string )
257
    end
258

  
259
    #
260
    # Generates HTML from the Textile contents.
261
    #
262
    #   r = RedCloth.new( "And then? She *fell*!" )
263
    #   r.to_html( true )
264
    #     #=>"And then? She <strong>fell</strong>!"
265
    #
266
    def to_html( *rules )
267
        rules = DEFAULT_RULES if rules.empty?
268
        # make our working copy
269
        text = self.dup
270
        
271
        @urlrefs = {}
272
        @shelf = []
273
        textile_rules = [:refs_textile, :block_textile_table, :block_textile_lists,
274
                         :block_textile_prefix, :inline_textile_image, :inline_textile_link,
275
                         :inline_textile_code, :inline_textile_span]
276
        markdown_rules = [:refs_markdown, :block_markdown_setext, :block_markdown_atx, :block_markdown_rule,
277
                          :block_markdown_bq, :block_markdown_lists, 
278
                          :inline_markdown_reflink, :inline_markdown_link]
279
        @rules = rules.collect do |rule|
280
            case rule
281
            when :markdown
282
                markdown_rules
283
            when :textile
284
                textile_rules
285
            else
286
                rule
287
            end
288
        end.flatten
289

  
290
        # standard clean up
291
        incoming_entities text 
292
        clean_white_space text 
293

  
294
        # start processor
295
        @pre_list = []
296
        rip_offtags text
297
        no_textile text
298
        escape_html_tags text
299
        hard_break text 
300
        unless @lite_mode
301
            refs text
302
            # need to do this before text is split by #blocks
303
            block_textile_quotes text
304
            blocks text
305
        end
306
        inline text
307
        smooth_offtags text
308

  
309
        retrieve text
310

  
311
        text.gsub!( /<\/?notextile>/, '' )
312
        text.gsub!( /x%x%/, '&#38;' )
313
        clean_html text if filter_html
314
        text.strip!
315
        text
316

  
317
    end
318

  
319
    #######
320
    private
321
    #######
322
    #
323
    # Mapping of 8-bit ASCII codes to HTML numerical entity equivalents.
324
    # (from PyTextile)
325
    #
... This diff was truncated because it exceeds the maximum size that can be displayed.