org-ruby 0.5.1 → 0.5.2

data/lib/org-ruby/headline.rb

@@ -1,120 +1,102 @@
-require OrgRuby.libpath(*%w[org-ruby line])
-
-module Orgmode
-
-  # Represents a headline in an orgmode file.
-  class Headline < Line
-
-    # This is the "level" of the headline
-    attr_reader :level
-
-    # This is the headline text -- the part of the headline minus the leading
-    # asterisks, the keywords, and the tags.
-    attr_reader :headline_text
-
-    # This contains the lines that "belong" to the headline.
-    attr_reader :body_lines
-
-    # These are the headline tags
-    attr_reader :tags
-
-    # Optional keyword found at the beginning of the headline.
-    attr_reader :keyword
-
-    # Valid states for partial export.
-    # exclude::       The entire subtree from this heading should be excluded.
-    # headline_only:: The headline should be exported, but not the body.
-    # all::           Everything should be exported, headline/body/children.
-    ValidExportStates = [:exclude, :headline_only, :all]
-
-    # The export state of this headline. See +ValidExportStates+.
-    attr_accessor :export_state
-
-    # This is the regex that matches a line
-    LineRegexp = /^\*+\s+/
-
-    # This matches the tags on a headline
-    TagsRegexp = /\s*:[\w:]*:\s*$/
-
-    # Special keywords allowed at the start of a line.
-    Keywords = %w[TODO DONE]
-
-    KeywordsRegexp = Regexp.new("^(#{Keywords.join('|')})\$")
-
-    def initialize(line, parser = nil)
-      super(line, parser)
-      @body_lines = []
-      @tags = []
-      @export_state = :exclude
-      if (@line =~ LineRegexp) then
-        @level = $&.strip.length
-        @headline_text = $'.strip
-        if (@headline_text =~ TagsRegexp) then
-          @tags = $&.split(/:/)              # split tag text on semicolon
-          @tags.delete_at(0)                 # the first item will be empty; discard
-          @headline_text.gsub!(TagsRegexp, "") # Removes the tags from the headline
-        end
-        @keyword = nil
-        parse_keywords
-      else
-        raise "'#{line}' is not a valid headline"
-      end
-    end
-
-    # Determines if a line is an orgmode "headline":
-    # A headline begins with one or more asterisks.
-    def self.headline?(line)
-      line =~ LineRegexp
-    end
-
-    # Converts this headline and its body to textile.
-    def to_textile
-      output = "h#{@level}. #{@headline_text}\n"
-      output << Line.to_textile(@body_lines)
-      output
-    end
-
-    def to_html(opts = {})
-      return "" if @export_state == :exclude
-      if opts[:decorate_title]
-        decoration = " class=\"title\""
-        opts.delete(:decorate_title)
-      else
-        decoration = ""
-      end
-      output = "<h#{@level}#{decoration}>"
-      if @parser and @parser.export_heading_number? then
-        heading_number = @parser.get_next_headline_number(@level)
-        output << "<span class=\"heading-number heading-number-#{@level}\">#{heading_number} </span>"
-      end
-      if @parser and @parser.export_todo? and @keyword then
-        output << "<span class=\"todo-keyword #{@keyword}\">#{@keyword} </span>"
-      end
-      output << "#{escape(@headline_text)}</h#{@level}>\n"
-      return output if @export_state == :headline_only
-      output << Line.to_html(@body_lines, opts)
-      output
-    end
-
-    ######################################################################
-    private
-
-    # TODO 2009-12-29 This duplicates escape_buffer! in html_output_buffer. DRY.
-    def escape(str)
-      str = str.gsub(/&/, "&amp;")
-      str = str.gsub(/</, "&lt;")
-      str = str.gsub(/>/, "&gt;")
-      str
-    end
-
-    def parse_keywords
-      re = @parser.custom_keyword_regexp if @parser
-      re ||= KeywordsRegexp
-      words = @headline_text.split
-      if words.length > 0 && words[0] =~ re then
-        @keyword = words[0]
-        @headline_text.sub!(Regexp.new("^#{@keyword}\s*"), "")
-      end
-    end
-  end                           # class Headline
-end                             # class Orgmode
+require OrgRuby.libpath(*%w[org-ruby line])
+
+module Orgmode
+
+  # Represents a headline in an orgmode file.
+  class Headline < Line
+
+    # This is the "level" of the headline
+    attr_reader :level
+
+    # This is the headline text -- the part of the headline minus the leading
+    # asterisks, the keywords, and the tags.
+    attr_reader :headline_text
+
+    # This contains the lines that "belong" to the headline.
+    attr_reader :body_lines
+
+    # These are the headline tags
+    attr_reader :tags
+
+    # Optional keyword found at the beginning of the headline.
+    attr_reader :keyword
+
+    # Valid states for partial export.
+    # exclude::       The entire subtree from this heading should be excluded.
+    # headline_only:: The headline should be exported, but not the body.
+    # all::           Everything should be exported, headline/body/children.
+    ValidExportStates = [:exclude, :headline_only, :all]
+
+    # The export state of this headline. See +ValidExportStates+.
+    attr_accessor :export_state
+
+    # This is the regex that matches a line
+    LineRegexp = /^\*+\s+/
+
+    # This matches the tags on a headline
+    TagsRegexp = /\s*:[\w:]*:\s*$/
+
+    # Special keywords allowed at the start of a line.
+    Keywords = %w[TODO DONE]
+
+    KeywordsRegexp = Regexp.new("^(#{Keywords.join('|')})\$")
+
+    def initialize(line, parser = nil)
+      super(line, parser)
+      @body_lines = []
+      @body_lines << self       # Make @body_lines contain the headline?
+      @tags = []
+      @export_state = :exclude
+      if (@line =~ LineRegexp) then
+        @level = $&.strip.length
+        @headline_text = $'.strip
+        if (@headline_text =~ TagsRegexp) then
+          @tags = $&.split(/:/)              # split tag text on semicolon
+          @tags.delete_at(0)                 # the first item will be empty; discard
+          @headline_text.gsub!(TagsRegexp, "") # Removes the tags from the headline
+        end
+        @keyword = nil
+        parse_keywords
+      else
+        raise "'#{line}' is not a valid headline"
+      end
+    end
+
+    # Override Line.output_text. For a heading, @headline_text
+    # is what we should output.
+    def output_text
+      return @headline_text
+    end
+
+    # Determines if a line is an orgmode "headline":
+    # A headline begins with one or more asterisks.
+    def self.headline?(line)
+      line =~ LineRegexp
+    end
+
+    # Overrides Line.paragraph_type.
+    def paragraph_type
+      :"heading#{@level}"
+    end
+
+    # Converts this headline and its body to textile.
+    def to_textile
+      output = "h#{@level}. #{@headline_text}\n"
+      output << Line.to_textile(@body_lines[1..-1])
+      output
+    end
+
+    ######################################################################
+    private
+
+    def parse_keywords
+      re = @parser.custom_keyword_regexp if @parser
+      re ||= KeywordsRegexp
+      words = @headline_text.split
+      if words.length > 0 && words[0] =~ re then
+        @keyword = words[0]
+        @headline_text.sub!(Regexp.new("^#{@keyword}\s*"), "")
+      end
+    end
+  end                           # class Headline
+end                             # class Orgmode

data/lib/org-ruby/html_output_buffer.rb

@@ -1,156 +1,174 @@
-require OrgRuby.libpath(*%w[org-ruby output_buffer])
-
-module Orgmode
-
-  class HtmlOutputBuffer < OutputBuffer
-
-    HtmlBlockTag = {
-      :paragraph => "p",
-      :ordered_list => "li",
-      :unordered_list => "li",
-      :table_row => "tr",
-      :table_header => "tr"
-    }
-
-    ModeTag = {
-      :unordered_list => "ul",
-      :ordered_list => "ol",
-      :table => "table",
-      :blockquote => "blockquote",
-      :example => "pre",
-      :src => "pre",
-      :inline_example => "pre"
-    }
-
-    attr_reader :options
-
-    def initialize(output, opts = {})
-      super(output)
-      if opts[:decorate_title] then
-        @title_decoration = " class=\"title\""
-      else
-        @title_decoration = ""
-      end
-      @options = opts
-      @logger.debug "HTML export options: #{@options.inspect}"
-    end
-
-    # Output buffer is entering a new mode. Use this opportunity to
-    # write out one of the block tags in the ModeTag constant to put
-    # this information in the HTML stream.
-    def push_mode(mode)
-      if ModeTag[mode] then
-        output_indentation
-        css_class = ""
-        css_class = " class=\"src\"" if mode == :src
-        css_class = " class=\"example\"" if (mode == :example || mode == :inline_example)
-        @logger.debug "#{mode}: <#{ModeTag[mode]}#{css_class}>\n" 
-        @output << "<#{ModeTag[mode]}#{css_class}>\n" unless mode == :table and skip_tables?
-        # Entering a new mode obliterates the title decoration
-        @title_decoration = ""
-      end
-      super(mode)
-    end
-
-    # We are leaving a mode. Close any tags that were opened when
-    # entering this mode.
-    def pop_mode(mode = nil)
-      m = super(mode)
-      if ModeTag[m] then
-        output_indentation
-        @logger.debug "</#{ModeTag[m]}>\n"
-        @output << "</#{ModeTag[m]}>\n" unless mode == :table and skip_tables?
-      end
-    end
-
-    def flush!
-      escape_buffer!
-      if mode_is_code(@buffer_mode) then
-        # Whitespace is significant in :code mode. Always output the buffer
-        # and do not do any additional translation.
-        @logger.debug "FLUSH CODE ==========> #{@buffer.inspect}"
-        @output << @buffer << "\n"
-      else
-        if (@buffer.length > 0) then
-          unless buffer_mode_is_table? and skip_tables?
-            @logger.debug "FLUSH      ==========> #{@buffer_mode}"
-            output_indentation
-            @output << "<#{HtmlBlockTag[@output_type]}#{@title_decoration}>" \
-            << inline_formatting(@buffer) \
-            << "</#{HtmlBlockTag[@output_type]}>\n"
-            @title_decoration = ""
-          else
-            @logger.debug "SKIP       ==========> #{@buffer_mode}"
-          end
-        end
-      end
-      @buffer = ""
-      @buffer_mode = nil
-    end
-
-    ######################################################################
-    private
-
-    def skip_tables?
-      @options[:skip_tables]
-    end
-
-    def buffer_mode_is_table?
-      @buffer_mode == :table
-    end
-
-    # Escapes any HTML content in the output accumulation buffer @buffer.
-    def escape_buffer!
-      @buffer.gsub!(/&/, "&amp;")
-      @buffer.gsub!(/</, "&lt;")
-      @buffer.gsub!(/>/, "&gt;")
-    end
-
-    def output_indentation
-      indent = "  " * (@mode_stack.length - 1)
-      @output << indent
-    end
-
-    Tags = {
-      "*" => { :open => "<b>", :close => "</b>" },
-      "/" => { :open => "<i>", :close => "</i>" },
-      "_" => { :open => "<span style=\"text-decoration:underline;\">",
-        :close => "</span>" },
-      "=" => { :open => "<code>", :close => "</code>" },
-      "~" => { :open => "<code>", :close => "</code>" },
-      "+" => { :open => "<del>", :close => "</del>" }
-    }
-
-    # Applies inline formatting rules to a string.
-    def inline_formatting(str)
-      str.rstrip!
-      str = @re_help.rewrite_emphasis(str) do |marker, s|
-        "#{Tags[marker][:open]}#{s}#{Tags[marker][:close]}"
-      end
-      str = @re_help.rewrite_links(str) do |link, text|
-        text ||= link
-        link = link.sub(/^file:(.*)::(.*?)$/) do
-
-          # We don't support search links right now. Get rid of it.
-
-          "file:#{$1}"
-        end
-        link = link.sub(/^file:/i, "") # will default to HTTP
-        link = link.sub(/\.org$/i, ".html")
-        "<a href=\"#{link}\">#{text}</a>"
-      end
-      if (@output_type == :table_row) then
-        str.gsub!(/^\|\s*/, "<td>")
-        str.gsub!(/\s*\|$/, "</td>")
-        str.gsub!(/\s*\|\s*/, "</td><td>")
-      end
-      if (@output_type == :table_header) then
-        str.gsub!(/^\|\s*/, "<th>")
-        str.gsub!(/\s*\|$/, "</th>")
-        str.gsub!(/\s*\|\s*/, "</th><th>")
-      end
-      str
-    end
-
-  end                           # class HtmlOutputBuffer
-end                             # module Orgmode
+require OrgRuby.libpath(*%w[org-ruby output_buffer])
+
+module Orgmode
+
+  class HtmlOutputBuffer < OutputBuffer
+
+    HtmlBlockTag = {
+      :paragraph => "p",
+      :ordered_list => "li",
+      :unordered_list => "li",
+      :table_row => "tr",
+      :table_header => "tr",
+      :heading1 => "h1",
+      :heading2 => "h2",
+      :heading3 => "h3",
+      :heading4 => "h4",
+      :heading5 => "h5",
+      :heading6 => "h6"
+    }
+
+    ModeTag = {
+      :unordered_list => "ul",
+      :ordered_list => "ol",
+      :table => "table",
+      :blockquote => "blockquote",
+      :example => "pre",
+      :src => "pre",
+      :inline_example => "pre"
+    }
+
+    attr_reader :options
+
+    def initialize(output, opts = {})
+      super(output)
+      if opts[:decorate_title] then
+        @title_decoration = " class=\"title\""
+      else
+        @title_decoration = ""
+      end
+      @options = opts
+      @logger.debug "HTML export options: #{@options.inspect}"
+    end
+
+    # Output buffer is entering a new mode. Use this opportunity to
+    # write out one of the block tags in the ModeTag constant to put
+    # this information in the HTML stream.
+    def push_mode(mode)
+      if ModeTag[mode] then
+        output_indentation
+        css_class = ""
+        css_class = " class=\"src\"" if mode == :src
+        css_class = " class=\"example\"" if (mode == :example || mode == :inline_example)
+        @logger.debug "#{mode}: <#{ModeTag[mode]}#{css_class}>\n" 
+        @output << "<#{ModeTag[mode]}#{css_class}>\n" unless mode == :table and skip_tables?
+        # Entering a new mode obliterates the title decoration
+        @title_decoration = ""
+      end
+      super(mode)
+    end
+
+    # We are leaving a mode. Close any tags that were opened when
+    # entering this mode.
+    def pop_mode(mode = nil)
+      m = super(mode)
+      if ModeTag[m] then
+        output_indentation
+        @logger.debug "</#{ModeTag[m]}>\n"
+        @output << "</#{ModeTag[m]}>\n" unless mode == :table and skip_tables?
+      end
+    end
+
+    def flush!
+      escape_buffer!
+      if mode_is_code(@buffer_mode) then
+        # Whitespace is significant in :code mode. Always output the buffer
+        # and do not do any additional translation.
+        @logger.debug "FLUSH CODE ==========> #{@buffer.inspect}"
+        @output << @buffer << "\n"
+      else
+        if (@buffer.length > 0) then
+          unless buffer_mode_is_table? and skip_tables?
+            @logger.debug "FLUSH      ==========> #{@buffer_mode}"
+            output_indentation
+            @output << "<#{HtmlBlockTag[@output_type]}#{@title_decoration}>" 
+            if (@buffered_lines[0].kind_of?(Headline)) then
+              headline = @buffered_lines[0]
+              raise "Cannot be more than one headline!" if @buffered_lines.length > 1
+              if @options[:export_heading_number] then
+                level = headline.level
+                heading_number = get_next_headline_number(level)
+                output << "<span class=\"heading-number heading-number-#{level}\">#{heading_number} </span>"
+              end
+              if @options[:export_todo] and headline.keyword then
+                keyword = headline.keyword
+                output << "<span class=\"todo-keyword #{keyword}\">#{keyword} </span>"
+              end
+            end
+            @output << inline_formatting(@buffer) 
+            @output << "</#{HtmlBlockTag[@output_type]}>\n"
+            @title_decoration = ""
+          else
+            @logger.debug "SKIP       ==========> #{@buffer_mode}"
+          end
+        end
+      end
+      clear_accumulation_buffer!
+    end
+
+    ######################################################################
+    private
+
+    def skip_tables?
+      @options[:skip_tables]
+    end
+
+    def buffer_mode_is_table?
+      @buffer_mode == :table
+    end
+
+    # Escapes any HTML content in the output accumulation buffer @buffer.
+    def escape_buffer!
+      @buffer.gsub!(/&/, "&amp;")
+      @buffer.gsub!(/</, "&lt;")
+      @buffer.gsub!(/>/, "&gt;")
+    end
+
+    def output_indentation
+      indent = "  " * (@mode_stack.length - 1)
+      @output << indent
+    end
+
+    Tags = {
+      "*" => { :open => "<b>", :close => "</b>" },
+      "/" => { :open => "<i>", :close => "</i>" },
+      "_" => { :open => "<span style=\"text-decoration:underline;\">",
+        :close => "</span>" },
+      "=" => { :open => "<code>", :close => "</code>" },
+      "~" => { :open => "<code>", :close => "</code>" },
+      "+" => { :open => "<del>", :close => "</del>" }
+    }
+
+    # Applies inline formatting rules to a string.
+    def inline_formatting(str)
+      str.rstrip!
+      str = @re_help.rewrite_emphasis(str) do |marker, s|
+        "#{Tags[marker][:open]}#{s}#{Tags[marker][:close]}"
+      end
+      str = @re_help.rewrite_links(str) do |link, text|
+        text ||= link
+        link = link.sub(/^file:(.*)::(.*?)$/) do
+
+          # We don't support search links right now. Get rid of it.
+
+          "file:#{$1}"
+        end
+        link = link.sub(/^file:/i, "") # will default to HTTP
+        link = link.sub(/\.org$/i, ".html")
+        "<a href=\"#{link}\">#{text}</a>"
+      end
+      if (@output_type == :table_row) then
+        str.gsub!(/^\|\s*/, "<td>")
+        str.gsub!(/\s*\|$/, "</td>")
+        str.gsub!(/\s*\|\s*/, "</td><td>")
+      end
+      if (@output_type == :table_header) then
+        str.gsub!(/^\|\s*/, "<th>")
+        str.gsub!(/\s*\|$/, "</th>")
+        str.gsub!(/\s*\|\s*/, "</th><th>")
+      end
+      str
+    end
+
+  end                           # class HtmlOutputBuffer
+end                             # module Orgmode