rdoc 6.3.4.1 → 8.0.0

data/lib/rdoc/markdown.kpeg

@@ -9,7 +9,7 @@
 # RDoc::Markdown as described by the [markdown syntax][syntax].
 #
 # To choose Markdown as your only default format see
-# RDoc::Options@Saved+Options for instructions on setting up a `.doc_options`
+# RDoc::Options@Saved+Options for instructions on setting up a `.rdoc_options`
 # file to store your project default.
 #
 # ## Usage
@@ -178,7 +178,7 @@
 # [dingus]: http://daringfireball.net/projects/markdown/dingus
 # [GFM]: https://github.github.com/gfm/
 # [pegmarkdown]: https://github.com/jgm/peg-markdown
-# [PHPE]: http://michelf.com/projects/php-markdown/extra/#def-list
+# [PHPE]: https://michelf.ca/projects/php-markdown/extra/#def-list
 # [syntax]: http://daringfireball.net/projects/markdown/syntax
 #--
 # Last updated to jgm/peg-markdown commit 8f8fc22ef0
@@ -187,11 +187,11 @@
 
 %% {
 
-  require 'rdoc'
-  require 'rdoc/markup/to_joined_paragraph'
-  require 'rdoc/markdown/entities'
+  require_relative '../rdoc'
+  require_relative 'markup/to_joined_paragraph'
+  require_relative 'markdown/entities'
 
-  require 'rdoc/markdown/literals'
+  require_relative 'markdown/literals'
 
   ##
   # Supported extensions
@@ -303,6 +303,20 @@
     end
   end
 
+  # Escape character that has special meaning in RDoc format.
+  # To allow rdoc-styled link used in markdown format for now, bracket and brace are not escaped.
+
+  def rdoc_escape(text)
+    text.gsub(/[*+<\\_]/) {|s| "\\#{s}" }
+  end
+
+  # Escape link url that contains brackets.
+  # Brackets needs escape because link url will be surrounded by `[]` in RDoc format.
+
+  def rdoc_link_url_escape(text)
+    text.gsub(/[\[\]\\]/) {|s| "\\#{s}" }
+  end
+
   ##
   # :category: Extensions
   #
@@ -389,6 +403,8 @@
   # the note order list for proper display at the end of the document.
 
   def note_for ref
+    return unless @note_order
+
     @note_order << ref
 
     label = @note_order.length
@@ -449,7 +465,7 @@
 
       @note_order.each_with_index do |ref, index|
         label = index + 1
-        note = @footnotes[ref]
+        note = @footnotes[ref] or raise ParseError, "footnote [^#{ref}] not found"
 
         link = "{^#{label}}[rdoc-label:footmark-#{label}:foottext-#{label}] "
         note.parts.unshift link
@@ -490,10 +506,57 @@
   # Wraps `text` in strike markup for rdoc inline formatting
 
   def strike text
-    if text =~ /\A[a-z\d.\/-]+\z/i then
-      "~#{text}~"
+    "<del>#{text}</del>"
+  end
+
+  ##
+  # Wraps `text` in code markup for rdoc inline formatting
+
+  def code text
+    # trim even spaces
+    text = $2 while /\A( +|\t+)(.*)\1\z/ =~ text
+    # escape unescaped backslash at the end
+    backslash_at_end = "\\" if /(?<!\\)(?:\\\\)*\\\z/.match?(text)
+    "<code>#{text}#{backslash_at_end}</code>"
+  end
+
+  ##
+  # Parses inline markdown in table cells
+
+  def parse_table_cells(table)
+    # Parse header cells
+    table.header = table.header.map { |cell| parse_cell_inline(cell) }
+
+    # Parse body cells
+    table.body = table.body.map do |row|
+      row.map { |cell| parse_cell_inline(cell) }
+    end
+
+    table
+  end
+
+  ##
+  # Parses inline markdown in a single table cell
+
+  def parse_cell_inline(text)
+    return text if text.nil? || text.empty?
+
+    # Create a new parser instance for the cell
+    cell_parser = RDoc::Markdown.new(@extensions, @debug)
+
+    # Parse the cell content
+    doc = cell_parser.parse(text)
+
+    # Extract the parsed content
+    if doc && doc.parts && !doc.parts.empty?
+      para = doc.parts.first
+      if para.is_a?(RDoc::Markup::Paragraph)
+        para.parts.join
+      else
+        text
+      end
     else
-      "<s>#{text}</s>"
+      text
     end
   end
 }
@@ -530,7 +593,7 @@ AtxInline = !@Newline !(@Sp /#*/ @Sp @Newline) Inline
 AtxStart =  < /\#{1,6}/ >
             { text.length }
 
-AtxHeading = AtxStart:s @Sp AtxInline+:a (@Sp /#*/ @Sp)?  @Newline
+AtxHeading = AtxStart:s @Spacechar+ AtxInline+:a (@Sp /#*/ @Sp)?  @Newline
             { RDoc::Markup::Heading.new(s, a.join) }
 
 SetextHeading = SetextHeading1 | SetextHeading2
@@ -556,8 +619,8 @@ BlockQuote = BlockQuoteRaw:a
 
 BlockQuoteRaw =  @StartList:a
                  (( ">" " "? Line:l { a << l } )
-                  ( !">" !@BlankLine Line:c { a << c } )*
-                  ( @BlankLine:n { a << n } )*
+                  ( !">" !@BlankLine !(AtxStart @Spacechar) !Bullet !Enumerator !( &{ github? } Ticks3 ) Line:c { a << c } )*
+                  ( ">" @BlankLine:n { a << n } )*
                  )+
                  { inner_parse a.join }
 
@@ -914,6 +977,7 @@ Inline  = Str
         | InlineNote
         | Code
         | RawHtml
+        | StrippedComment
         | Entity
         | EscapedChar
         | Symbol
@@ -922,11 +986,11 @@ Space = @Spacechar+ { " " }
 
 Str = @StartList:a
       < @NormalChar+ > { a = text }
-      ( StrChunk:c { a << c } )* { a }
+      ( StrChunk:c { a << c } )* { rdoc_escape(a) }
 
 StrChunk = < (@NormalChar | /_+/ &Alphanumeric)+ > { text }
 
-EscapedChar =   "\\" !@Newline < /[:\\`|*_{}\[\]()#+.!><-]/ > { text }
+EscapedChar =   "\\" !@Newline < /[:\\`|*_{}\[\]()#+.!><-]/ > { rdoc_escape(text) }
 
 Entity =    ( HexEntity | DecEntity | CharEntity ):a { a }
 
@@ -941,7 +1005,7 @@ TerminalEndline = @Sp @Newline @Eof
 LineBreak = "  " @NormalEndline { RDoc::Markup::HardBreak.new }
 
 Symbol = < @SpecialChar >
-         { text }
+         { rdoc_escape(text) }
 
 # This keeps the parser from getting bogged down on long strings of '*' or '_',
 # or strings of '*' or '_' with space on each side:
@@ -992,9 +1056,8 @@ Strike = &{ strike? }
          "~~"
          { strike a.join }
 
-# TODO alt text support
-Image = "!" ( ExplicitLink | ReferenceLink ):a
-        { "rdoc-image:#{a[/\[(.*)\]/, 1]}" }
+Image = "!" ExplicitLinkWithLabel:a
+        { "rdoc-image:#{a[:link]}:#{a[:label]}" }
 
 Link =  ExplicitLink | ReferenceLink | AutoLink
 
@@ -1006,8 +1069,11 @@ ReferenceLinkDouble = Label:content < Spnl > !"[]" Label:label
 ReferenceLinkSingle = Label:content < (Spnl "[]")? >
                       { link_to content, content, text }
 
-ExplicitLink =  Label:l "(" @Sp Source:s Spnl Title @Sp ")"
-                { "{#{l}}[#{s}]" }
+ExplicitLink = ExplicitLinkWithLabel:a
+               { "{#{a[:label]}}[#{rdoc_link_url_escape(a[:link])}]" }
+
+ExplicitLinkWithLabel = Label:label "(" @Sp Source:link Spnl Title @Sp ")"
+                        { { label: label, link: link } }
 
 Source  = ( "<" < SourceContents > ">" | < SourceContents > )
           { text }
@@ -1062,35 +1128,35 @@ Ticks3 = "```" !"`"
 Ticks4 = "````" !"`"
 Ticks5 = "`````" !"`"
 
-Code = ( Ticks1 @Sp < (
+Code = ( Ticks1 < (
            ( !"`" Nonspacechar )+ | !Ticks1 /`+/ |
-           !( @Sp Ticks1 ) ( @Spacechar | @Newline !@BlankLine )
-         )+ > @Sp Ticks1 |
-         Ticks2 @Sp < (
+           !Ticks1 ( @Spacechar | @Newline !@BlankLine )
+         )+ > Ticks1 |
+         Ticks2 < (
            ( !"`" Nonspacechar )+ |
            !Ticks2 /`+/ |
-           !( @Sp Ticks2 ) ( @Spacechar | @Newline !@BlankLine )
-         )+ > @Sp Ticks2 |
-         Ticks3 @Sp < (
+           !Ticks2 ( @Spacechar | @Newline !@BlankLine )
+         )+ > Ticks2 |
+         Ticks3 < (
            ( !"`" Nonspacechar )+ |
            !Ticks3 /`+/ |
-           !( @Sp Ticks3 ) ( @Spacechar | @Newline !@BlankLine )
-         )+ > @Sp Ticks3 |
-         Ticks4 @Sp < (
+           !Ticks3 ( @Spacechar | @Newline !@BlankLine )
+         )+ > Ticks3 |
+         Ticks4 < (
            ( !"`" Nonspacechar )+ |
            !Ticks4 /`+/ |
-           !( @Sp Ticks4 ) ( @Spacechar | @Newline !@BlankLine )
-         )+ > @Sp Ticks4 |
-         Ticks5 @Sp < (
+           !Ticks4 ( @Spacechar | @Newline !@BlankLine )
+         )+ > Ticks4 |
+         Ticks5 < (
            ( !"`" Nonspacechar )+ |
            !Ticks5 /`+/ |
-           !( @Sp Ticks5 ) ( @Spacechar | @Newline !@BlankLine )
-         )+ > @Sp Ticks5
+           !Ticks5 ( @Spacechar | @Newline !@BlankLine )
+         )+ > Ticks5
        )
-       { "<code>#{text}</code>" }
+       { code text }
 
-RawHtml = < (HtmlComment | HtmlBlockScript | HtmlTag) >
-          { if html? then text else '' end }
+RawHtml = < HtmlBlockScript | HtmlTag > { html? ? text : '' }
+StrippedComment = HtmlComment { '' }
 
 BlankLine =     @Sp @Newline { "\n" }
 
@@ -1114,12 +1180,12 @@ Newline           = %literals.Newline
 Spacechar         = %literals.Spacechar
 
 HexEntity  = /&#x/i < /[0-9a-fA-F]+/ > ";"
-             { [text.to_i(16)].pack 'U' }
+             { rdoc_escape([text.to_i(16)].pack('U')) }
 DecEntity  = "&#"   < /[0-9]+/       > ";"
-             { [text.to_i].pack 'U' }
+             { rdoc_escape([text.to_i].pack('U')) }
 CharEntity = "&"    </[A-Za-z0-9]+/  > ";"
              { if entity = HTML_ENTITIES[text] then
-                 entity.pack 'U*'
+                 rdoc_escape(entity.pack('U*'))
                else
                  "&#{text};"
                end
@@ -1135,7 +1201,7 @@ StartList = &.
             { [] }
 
 Line =  @RawLine:a { a }
-RawLine = ( < (!"\r" !"\n" .)* @Newline >
+RawLine = ( < /[^\r\n]*/ @Newline >
         | < .+ > @Eof ) { text }
 
 SkipBlock = HtmlBlock
@@ -1170,23 +1236,25 @@ InlineNote = &{ notes? }
              @StartList:a
              ( !"]" Inline:l { a << l } )+
              "]"
-             { ref = [:inline, @note_order.length]
-               @footnotes[ref] = paragraph a
+             { if @note_order
+                 ref = [:inline, @note_order.length]
+                 @footnotes[ref] = paragraph a
 
-               note_for ref
+                 note_for ref
+               end
              }
 
 Notes = ( Note | SkipBlock )*
 
 RawNoteBlock = @StartList:a
-               ( !@BlankLine OptionallyIndentedLine:l { a << l } )+
+               ( !@BlankLine !RawNoteReference OptionallyIndentedLine:l { a << l } )+
                ( < @BlankLine* > { a << text } )
                { a }
 
 # Markdown extensions added by RDoc follow
 
 CodeFence = &{ github? }
-            Ticks3 (@Sp StrChunk:format)? Spnl < (
+            Ticks3 (@Sp StrChunk:format)? @Sp @Newline? < (
               ( !"`" Nonspacechar )+ |
               !Ticks3 /`+/ |
               Spacechar |
@@ -1198,19 +1266,29 @@ CodeFence = &{ github? }
             }
 
 Table = &{ github? }
-        TableRow:header TableLine:line TableRow+:body
-        { table = RDoc::Markup::Table.new(header, line, body) }
-
-TableRow = TableItem+:row "|" @Newline
-           { row }
-TableItem = "|" < (!"|" !@Newline .)+ >
-            { text.strip }
-
-TableLine = TableColumn+:line "|" @Newline
-            { line }
-TableColumn = "|" < ( "-"+ ":"? | ":" "-"* ) >
-              { text.start_with?(":") ? :left :
-                text.end_with?(":") ? :right : nil
+        TableHead:header TableLine:line TableRow+:body
+        {
+          table = RDoc::Markup::Table.new(header, line, body)
+          parse_table_cells(table)
+        }
+
+TableHead = TableItem2+:items "|"? @Newline
+            { items }
+
+TableRow = ( ( TableItem:item1 TableItem2+:items { [item1, *items] } ):row | TableItem2+:row ) "|"? @Newline
+	   { row }
+TableItem2 = "|" TableItem
+TableItem = < /(?:\\.|[^|\n])+/ >
+	    { text.strip.gsub(/\\([|])/, '\1')  }
+
+TableLine = ( ( TableAlign:align1 TableAlign2+:aligns {[align1, *aligns] } ):line | TableAlign2+:line ) "|"? @Newline
+	    { line }
+TableAlign2 = "|" @Sp TableAlign
+TableAlign = < /:?-+:?/ > @Sp
+              {
+                text.start_with?(":") ?
+                (text.end_with?(":") ? :center : :left) :
+                (text.end_with?(":") ? :right : nil)
               }
 
 DefinitionList = &{ definition_lists? }
@@ -1230,7 +1308,7 @@ DefinitionListItem = ( DefinitionListLabel+ ):label
                        list_items
                      }
 
-DefinitionListLabel = StrChunk:label @Sp @Newline
+DefinitionListLabel = Inline:label @Sp @Newline
                       { label }
 
 DefinitionListDefinition = @NonindentSpace ":" @Space Inlines:a @BlankLine+