wallyqs-org-ruby 0.6.1 → 0.8.0

data/lib/org-ruby/parser.rb

@@ -1,4 +1,3 @@
-require 'rubygems'
 require 'rubypants'
 
 module Orgmode
@@ -100,74 +99,48 @@ module Orgmode
       mode = :normal
       previous_line = nil
       table_header_set = false
-      @lines.each do |line|
-        case mode
-        when :normal
+      @lines.each do |text|
+        line = Line.new text, self
+        mode = :normal if line.end_block? and mode == line.paragraph_type
+        mode = :normal if line.property_drawer_end_block? and mode == :property_drawer
 
-          if (Headline.headline? line) then
-            @current_headline = Headline.new line, self, offset
-            @headlines << @current_headline
-          else
-            line = Line.new line, self
-            # If there is a setting on this line, remember it.
-            line.in_buffer_setting? do |key, value|
-              store_in_buffer_setting key, value
-            end
-            if line.table_separator? then
-              if previous_line and previous_line.paragraph_type == :table_row and !table_header_set
-                previous_line.assigned_paragraph_type = :table_header
-                table_header_set = true
-              end
-            end
-            table_header_set = false if !line.table?
-            mode = :code if line.begin_block? and line.block_type == "EXAMPLE"
-            mode = :block_comment if line.begin_block? and line.block_type == "COMMENT"
-            mode = :property_drawer if line.property_drawer_begin_block?
-            if (@current_headline) then
-              @current_headline.body_lines << line
-            else
-              @header_lines << line
+        case mode
+        when :normal, :quote, :center
+          if Headline.headline? line.line
+            line = Headline.new line.line, self, offset
+          elsif line.table_separator?
+            if previous_line and previous_line.paragraph_type == :table_row and !table_header_set
+              previous_line.assigned_paragraph_type = :table_header
+              table_header_set = true
             end
           end
+          table_header_set = false if !line.table?
 
-        when :block_comment
-          line = Line.new line, self
-          if line.end_block? and line.block_type == "COMMENT"
-            mode = :normal
-          else
-            line.assigned_paragraph_type = :comment
-          end
-
-        when :code
-
-          # As long as we stay in code mode, force lines to be either blank or paragraphs.
+        when :example, :html, :src
+          # As long as we stay in code mode, force lines to be code.
           # Don't try to interpret structural items, like headings and tables.
-          line = Line.new line, self
-          if line.end_block? and line.block_type == "EXAMPLE"
-            mode = :normal
-          else
-            line.assigned_paragraph_type = :paragraph unless line.blank?
-          end
-          if (@current_headline) then
-            @current_headline.body_lines << line
-          else
-            @header_lines << line
+          line.assigned_paragraph_type = :code
+        end
+
+        if mode == :normal
+          @headlines << @current_headline = line if Headline.headline? line.line
+          # If there is a setting on this line, remember it.
+          line.in_buffer_setting? do |key, value|
+            store_in_buffer_setting key.upcase, value
           end
 
-        when :property_drawer
+          mode = line.paragraph_type if line.begin_block?
+          mode = :property_drawer if line.property_drawer_begin_block?
+        end
 
-          line = Line.new line, self
-          if line.property_drawer_end_block?
-            mode = :normal
-          else
-            line.assigned_paragraph_type = :property_drawer unless line.blank?
-          end
-          if (@current_headline) then
+        unless mode == :comment
+          if @current_headline
             @current_headline.body_lines << line
           else
             @header_lines << line
           end
-        end                     # case
+        end
+
         previous_line = line
       end                       # @lines.each
     end                         # initialize
@@ -181,9 +154,11 @@ module Orgmode
     # Saves the loaded orgmode file as a textile file.
     def to_textile
       output = ""
-      output << Line.to_textile(@header_lines)
+      output_buffer = TextileOutputBuffer.new(output)
+
+      translate(@header_lines, output_buffer)
       @headlines.each do |headline|
-        output << headline.to_textile
+        translate(headline.body_lines, output_buffer)
       end
       output
     end
@@ -192,7 +167,7 @@ module Orgmode
     def to_html
       mark_trees_for_export
       export_options = {
-        :decorate_title => true,
+        :decorate_title => @in_buffer_settings["TITLE"],
         :export_heading_number => export_heading_number?,
         :export_todo => export_todo?,
         :use_sub_superscripts =>  use_sub_superscripts?,
@@ -207,9 +182,9 @@ module Orgmode
         # If we're given a new title, then just create a new line
         # for that title.
         title = Line.new(@in_buffer_settings["TITLE"], self)
-        Parser.translate([title], output_buffer)
+        translate([title], output_buffer)
       end
-      Parser.translate(@header_lines, output_buffer) unless skip_header_lines?
+      translate(@header_lines, output_buffer) unless skip_header_lines?
 
       # If we've output anything at all, remove the :decorate_title option.
       export_options.delete(:decorate_title) if (output.length > 0)
@@ -219,11 +194,13 @@ module Orgmode
         when :exclude
           # NOTHING
         when :headline_only
-          Parser.translate(headline.body_lines[0, 1], output_buffer)
+          translate(headline.body_lines[0, 1], output_buffer)
         when :all
-          Parser.translate(headline.body_lines, output_buffer)
+          translate(headline.body_lines, output_buffer)
         end
       end
+      output << "\n"
+
       rp = RubyPants.new(output)
       rp.to_html
     end
@@ -233,54 +210,11 @@ module Orgmode
 
     # Converts an array of lines to the appropriate format.
     # Writes the output to +output_buffer+.
-    def self.translate(lines, output_buffer)
-      lines.each do |line|
-
-        # See if we're carrying paragraph payload, and output
-        # it if we're about to switch to some other output type.
-        output_buffer.prepare(line)
-        case line.paragraph_type
-        when :metadata, :table_separator, :blank, :comment, :property_drawer_item, :property_drawer_begin_block, :property_drawer_end_block
-
-          output_buffer << line.line if output_buffer.preserve_whitespace?
-
-        when :begin_block
-
-          output_buffer.push_mode(:blockquote) if line.block_type.casecmp("QUOTE") == 0
-          output_buffer.push_mode(:src) if line.block_type.casecmp("SRC") == 0
-          output_buffer.push_mode(:example) if line.block_type.casecmp("EXAMPLE") == 0
-          output_buffer.push_mode(:center) if line.block_type.casecmp("CENTER") == 0
-
-        when :end_block
-
-          output_buffer.pop_mode(:blockquote) if line.block_type.casecmp("QUOTE") == 0
-          output_buffer.pop_mode(:src) if line.block_type.casecmp("SRC") == 0
-          output_buffer.pop_mode(:example) if line.block_type.casecmp("EXAMPLE") == 0
-          output_buffer.pop_mode(:center) if line.block_type.casecmp("CENTER") == 0
-
-        when :table_row, :table_header
-
-          output_buffer << line.line.lstrip
-
-        when :unordered_list, :ordered_list, :definition_list
-
-          output_buffer << line.output_text << " "
-
-        when :inline_example
-
-          output_buffer << line.output_text
-
-        else
-
-          if output_buffer.preserve_whitespace? then
-            output_buffer << line.output_text
-          else
-            output_buffer << line.output_text.strip << " "
-          end
-        end
-      end
+    def translate(lines, output_buffer)
+      output_buffer.output_type = :start
+      lines.each { |line| output_buffer.insert(line) }
       output_buffer.flush!
-      output_buffer.pop_mode until output_buffer.current_mode == :normal
+      output_buffer.pop_mode while output_buffer.current_mode
       output_buffer.output_footnotes!
       output_buffer.output
     end

data/lib/org-ruby/regexp_helper.rb

@@ -3,7 +3,7 @@ require 'logger'
 module Orgmode
 
   # = Summary
-  # 
+  #
   # This class contains helper routines to deal with the Regexp "black
   # magic" you need to properly parse org-mode files.
   #
@@ -39,24 +39,20 @@ module Orgmode
     # body-regexp  A regexp like \".\" to match a body character.  Don't use
     #              non-shy groups here, and don't allow newline here.
     # newline      The maximum number of newlines allowed in an emphasis exp.
-    #
-    # I currently don't use +newline+ because I've thrown this information
-    # away by this point in the code. TODO -- revisit?
-    attr_reader   :pre_emphasis
-    attr_reader   :post_emphasis
-    attr_reader   :border_forbidden
-    attr_reader   :body_regexp
-    attr_reader   :markers
 
-    attr_reader   :org_emphasis_regexp
+    attr_reader :org_image_file_regexp
 
     def initialize
       # Set up the emphasis regular expression.
-      @pre_emphasis = " \t\\('\""
-      @post_emphasis = "- \t.,:!?;'\"\\)"
-      @border_forbidden = " \t\r\n,\"'"
-      @body_regexp = ".*?"
-      @markers = "*/_=~+"
+      @pre_emphasis = ' \t\(\'"\{'
+      @post_emphasis = '- \t\.,:!\?;\'"\)\}\\\\'
+      @border_forbidden = '\s,"\''
+      @body_regexp = '.*?'
+      @max_newlines = 1
+      @body_regexp = "#{@body_regexp}" +
+                     "(?:\\n#{@body_regexp}){0,#{@max_newlines}}" if @max_newlines > 0
+      @markers = '\*\/_=~\+'
+      @code_snippet_stack = []
       @logger = Logger.new(STDERR)
       @logger.level = Logger::WARN
       build_org_emphasis_regexp
@@ -94,23 +90,32 @@ module Orgmode
     # replace "*bold*", "/italic/", and "=code=",
     # respectively. (Clearly this sample string will use HTML-like
     # syntax, assuming +map+ is defined appropriately.)
-    def rewrite_emphasis(str)
-      str.gsub(@org_emphasis_regexp) do |match|
-        inner = yield $2, $3
-        "#{$1}#{inner}#{$4}"
+    def rewrite_emphasis str
+      # escape the percent signs for safe restoring code snippets
+      str.gsub!(/%/, "%%")
+      format_str = "%s"
+      str.gsub! @org_emphasis_regexp do |match|
+        # preserve the code snippet from further formatting
+        inner = if $2 == "=" or $2 == "~"
+                  @code_snippet_stack.push $3
+                  yield $2, format_str
+                else
+                  yield $2, $3
+                end
+        "#{$1}#{inner}"
       end
     end
 
     # rewrite subscript and superscript (_{foo} and ^{bar})
-    def rewrite_subp(str) # :yields: type ("_" for subscript and "^" for superscript), text
-      str.gsub(@org_subp_regexp) do |match|
+    def rewrite_subp str # :yields: type ("_" for subscript and "^" for superscript), text
+      str.gsub! @org_subp_regexp do |match|
         yield $1, $2
       end
     end
 
     # rewrite footnotes
-    def rewrite_footnote(str) # :yields: name, definition or nil
-      str.gsub(@org_footnote_regexp) do |match|
+    def rewrite_footnote str # :yields: name, definition or nil
+      str.gsub! @org_footnote_regexp do |match|
         yield $1, $3
       end
     end
@@ -121,7 +126,7 @@ module Orgmode
     # output format.
     #
     # = Usage
-    # 
+    #
     # Give this a block that expect the link and optional friendly
     # text. Return how that link should get formatted.
     #
@@ -140,53 +145,43 @@ module Orgmode
     # +http://www.hotmail.com+. In both cases, the block returns an
     # HTML-style link, and that is how things will get recorded in
     # +result+.
-    def rewrite_links(str) #  :yields: link, text
-      i = str.gsub(@org_link_regexp) do |match|
-        yield $1, nil
+    def rewrite_links str # :yields: link, text
+      str.gsub! @org_link_regexp do |match|
+        yield $1, $3
       end
-      if str =~ @org_angle_link_text_regexp
-        i.gsub(@org_angle_link_text_regexp) do |match|
-          yield "#{$2}:#{$3}", nil
-        end
-      else
-        i.gsub(@org_link_text_regexp) do |match|
-          yield $1, $2
-        end
+      str.gsub! @org_angle_link_text_regexp do |match|
+        yield $1, nil
       end
+
+      str # for testing
     end
 
-    # Rewrites all of the inline image tags.
-    def rewrite_images(str) #  :yields: image_link
-      str.gsub(@org_img_regexp) do |match|
-        yield $1
-      end
+    def restore_code_snippets str
+      str = str % @code_snippet_stack
+      @code_snippet_stack = []
+      str
     end
 
     private
 
     def build_org_emphasis_regexp
-      @org_emphasis_regexp = Regexp.new("([#{@pre_emphasis}]|^)\n" +
-                                        "(  [#{@markers}]  )\n" + 
-                                        "(  [^#{@border_forbidden}]  | " +
-                                        "  [^#{@border_forbidden}]#{@body_regexp}[^#{@border_forbidden}]  )\n" +
-                                        "\\2\n" +
-                                        "([#{@post_emphasis}]|$)\n", Regexp::EXTENDED)
+      @org_emphasis_regexp = Regexp.new("([#{@pre_emphasis}]|^)" +
+                                        "([#{@markers}])(?!\\2)" +
+                                        "([^#{@border_forbidden}]|" +
+                                        "[^#{@border_forbidden}]#{@body_regexp}" +
+                                        "[^#{@border_forbidden}])\\2" +
+                                        "(?=[#{@post_emphasis}]|$)")
       @logger.debug "Just created regexp: #{@org_emphasis_regexp}"
     end
 
     def build_org_link_regexp
       @org_link_regexp = /\[\[
-                             ([^\]]*) # This is the URL
-                          \]\]/x
-      @org_img_regexp = /\[\[
-          ([^\]]*\.(jpg|jpeg|gif|png)) # Like a normal URL, but must end with a specified extension
-        \]\]/xi
-      @org_link_text_regexp = /\[\[
-                                 ([^\]]*) # This is the URL
-                               \]\[
-                                 ([^\]]*) # This is the friendly text
-                               \]\]/x
-      @org_angle_link_text_regexp = /(<|&lt;)(\w+):([^\]\t\n\r<> ][^\]\t\n\r<> ]*)(>|&gt;)/x
+                             ([^\]\[]+) # This is the URL
+                          \](\[
+                             ([^\]\[]+) # This is the friendly text
+                          \])?\]/x
+      @org_angle_link_text_regexp = /<(\w+:[^\]\s<>]+)>/
+      @org_image_file_regexp = /\.(gif|jpe?g|p(?:bm|gm|n[gm]|pm)|svg|tiff?|x[bp]m)/i
     end
   end                           # class Emphasis
 end                             # module Orgmode

data/lib/org-ruby/textile_output_buffer.rb

@@ -6,21 +6,28 @@ module Orgmode
 
     def initialize(output)
       super(output)
-      @add_paragraph = false
+      @add_paragraph = true
       @support_definition_list = true # TODO this should be an option
-      @footnotes = {}
+      @footnotes = []
     end
 
-    def push_mode(mode)
+    def push_mode(mode, indent)
+      @list_indent_stack.push(indent)
       super(mode)
-      @output << "bc.. " if mode_is_code(mode)
-      @output << "\np=. " if mode == :center
+      @output << "bc. " if mode_is_code? mode
+      if mode == :center or mode == :quote
+        @add_paragraph = false
+        @output << "\n"
+      end
     end
 
     def pop_mode(mode = nil)
       m = super(mode)
-      @add_paragraph = (mode_is_code(m))
-      @output << "\n" if mode == :center
+      @list_indent_stack.pop
+      if m == :center or m == :quote
+        @add_paragraph = true
+        @output << "\n"
+      end
       m
     end
 
@@ -36,37 +43,68 @@ module Orgmode
 
     # Handles inline formatting for textile.
     def inline_formatting(input)
-      input = @re_help.rewrite_emphasis(input) do |marker, body|
+      @re_help.rewrite_emphasis input do |marker, body|
         m = TextileMap[marker]
         "#{m}#{body}#{m}"
       end
-      input = @re_help.rewrite_subp(input) do |type, text|
+      @re_help.rewrite_subp input do |type, text|
         if type == "_" then
           "~#{text}~"
         elsif type == "^" then
           "^#{text}^"
         end
       end
-      input = @re_help.rewrite_links(input) do |link, text|
-        text ||= link
-        link = link.gsub(/ /, "%20")
-        "\"#{text}\":#{link}"
+      @re_help.rewrite_links input do |link, defi|
+        [link, defi].compact.each do |text|
+          # We don't support search links right now. Get rid of it.
+          text.sub!(/\A(file:[^\s]+)::[^\s]*?\Z/, "\\1")
+          text.sub!(/\A(file:[^\s]+)\.org\Z/i, "\\1.textile")
+          text.sub!(/\Afile:(?=[^\s]+\Z)/, "")
+        end
+
+        # We don't add a description for images in links, because its
+        # empty value forces the image to be inlined.
+        defi ||= link unless link =~ @re_help.org_image_file_regexp
+        link = link.gsub(/ /, "%%20")
+
+        if defi =~ @re_help.org_image_file_regexp
+          defi = "!#{defi}(#{defi})!"
+        elsif defi
+          defi = "\"#{defi}\""
+        end
+
+        if defi
+          "#{defi}:#{link}"
+        else
+          "!#{link}(#{link})!"
+        end
       end
-      input = @re_help.rewrite_footnote(input) do |name, defi|
-        # textile only support numerical names! Use hash as a workarround
-        name = name.hash.to_s unless name.to_i.to_s == name # check if number
-        @footnotes[name] = defi if defi
-        "[#{name}]"
+      @re_help.rewrite_footnote input do |name, definition|
+        # textile only support numerical names, so we need to do some conversion
+        # Try to find the footnote and use its index
+        footnote = @footnotes.select {|f| f[:name] == name }.first
+        if footnote
+          # The latest definition overrides other ones
+          footnote[:definition] = definition if definition and not footnote[:definition]
+        else
+          # There is no footnote with the current name so we add it
+          footnote = { :name => name, :definition => definition }
+          @footnotes << footnote
+        end
+
+        "[#{@footnotes.index(footnote)}]"
       end
       Orgmode.special_symbols_to_textile(input)
+      input = @re_help.restore_code_snippets input
       input
     end
 
     def output_footnotes!
       return false if @footnotes.empty?
 
-      @footnotes.each do |name, defi|
-        @output << "\nfn#{name}. #{defi}\n"
+      @footnotes.each do |footnote|
+        index = @footnotes.index(footnote)
+        @output << "\nfn#{index}. #{footnote[:definition] || 'DEFINITION NOT FOUND' }\n"
       end
 
       return true
@@ -74,29 +112,44 @@ module Orgmode
 
     # Flushes the current buffer
     def flush!
+      return false if @buffer.empty? and @output_type != :blank
       @logger.debug "FLUSH ==========> #{@output_type}"
-      if (@output_type == :blank) then
+      @buffer.gsub!(/\A\n*/, "")
+
+      case
+      when preserve_whitespace?
+        @output << @buffer << "\n"
+
+      when @output_type == :blank
         @output << "\n"
-      elsif (@buffer.length > 0) then
-        if @add_paragraph then
-          @output << "p. " if @output_type == :paragraph
-          @add_paragraph = false
-        end
-        @output << "bq. " if current_mode == :blockquote
-        if @output_type == :definition_list and @support_definition_list then
-          @output << "-" * @list_indent_stack.length << " "
-          @buffer.sub!("::", ":=")
-        elsif @output_type == :ordered_list then
-          @output << "#" * @list_indent_stack.length << " "
-        elsif @output_type == :unordered_list or \
-            (@output_type == :definition_list and not @support_definition_list) then
-          @output << "*" * @list_indent_stack.length << " "
+
+      else
+        case current_mode
+        when :paragraph
+          @output << "p. " if @add_paragraph
+          @output << "p=. " if @mode_stack[0] == :center
+          @output << "bq. " if @mode_stack[0] == :quote
+
+        when :list_item
+          if @mode_stack[-2] == :ordered_list
+            @output << "#" * @mode_stack.count(:list_item) << " "
+          else # corresponds to unordered list
+            @output << "*" * @mode_stack.count(:list_item) << " "
+          end
+
+        when :definition_term
+          if @support_definition_list
+            @output << "-" * @mode_stack.count(:definition_term) << " "
+            @buffer.sub!("::", ":=")
+          end
         end
         @output << inline_formatting(@buffer) << "\n"
       end
-      clear_accumulation_buffer!
+      @buffer = ""
     end
 
-
+    def add_line_attributes headline
+      @output << "h#{headline.level}. "
+    end
   end                           # class TextileOutputBuffer
 end                             # module Orgmode