class Orgmode::OutputBuffer
The OutputBuffer
is used to accumulate multiple lines of orgmode text, and then emit them to the output all in one go. The class will do the final textile substitution for inline formatting and add a newline character prior emitting the output.
Attributes
This is the overall output buffer
This is the current type of output being accumulated.
Public Class Methods
Creates a new OutputBuffer
object that is bound to an output object. The output will get flushed to =output=.
# File lib/org-ruby/output_buffer.rb, line 19 def initialize(output) # This is the accumulation buffer. It's a holding pen so # consecutive lines of the right type can get stuck together # without intervening newlines. @buffer = "" # This stack is used to do proper outline numbering of # headlines. @headline_number_stack = [] @output = output @output_type = :start @list_indent_stack = [] @mode_stack = [] @code_block_indent = nil @logger = Logger.new(STDERR) if ENV['DEBUG'] or $DEBUG @logger.level = Logger::DEBUG else @logger.level = Logger::WARN end @re_help = RegexpHelper.new end
Public Instance Methods
# File lib/org-ruby/output_buffer.rb, line 45 def current_mode @mode_stack.last end
# File lib/org-ruby/output_buffer.rb, line 138 def do_custom_markup if File.exists? @options[:markup_file] load_custom_markup if @custom_blocktags.empty? no_valid_markup_found else set_custom_markup end else no_custom_markup_file_exists end end
Gets the next headline number for a given level. The intent is this function is called sequentially for each headline that needs to get numbered. It does standard outline numbering.
# File lib/org-ruby/output_buffer.rb, line 115 def get_next_headline_number(level) raise "Headline level not valid: #{level}" if level <= 0 while level > @headline_number_stack.length do @headline_number_stack.push 0 end while level < @headline_number_stack.length do @headline_number_stack.pop end raise "Oops, shouldn't happen" unless level == @headline_number_stack.length @headline_number_stack[@headline_number_stack.length - 1] += 1 @headline_number_stack.join(".") end
# File lib/org-ruby/output_buffer.rb, line 60 def insert(line) # Prepares the output buffer to receive content from a line. # As a side effect, this may flush the current accumulated text. @logger.debug "Looking at #{line.paragraph_type}|#{line.assigned_paragraph_type}(#{current_mode}) : #{line.to_s}" # We try to get the lang from #+BEGIN_SRC blocks @block_lang = line.block_lang if line.begin_block? unless should_accumulate_output?(line) flush! maintain_mode_stack(line) end # Adds the current line to the output buffer case when line.assigned_paragraph_type == :comment # Don't add to buffer when line.title? @buffer << line.output_text when line.raw_text? @buffer << "\n" << line.output_text if line.raw_text_tag == @buffer_tag when preserve_whitespace? @buffer << "\n" << line.output_text unless line.block_type when line.assigned_paragraph_type == :code # If the line is contained within a code block but we should # not preserve whitespaces, then we do nothing. when (line.kind_of? Headline) add_line_attributes line @buffer << "\n" << line.output_text.strip when ([:definition_term, :list_item, :table_row, :table_header, :horizontal_rule].include? line.paragraph_type) @buffer << "\n" << line.output_text.strip when line.paragraph_type == :paragraph @buffer << "\n" buffer_indentation @buffer << line.output_text.strip end if mode_is_code? current_mode and not line.block_type # Determines the amount of whitespaces to be stripped at the # beginning of each line in code block. if line.paragraph_type != :blank if @code_block_indent @code_block_indent = [@code_block_indent, line.indent].min else @code_block_indent = line.indent end end end @output_type = line.assigned_paragraph_type || line.paragraph_type end
Gets the current list indent level.
# File lib/org-ruby/output_buffer.rb, line 129 def list_indent_level @list_indent_stack.length end
# File lib/org-ruby/output_buffer.rb, line 151 def load_custom_markup require 'yaml' self.class.to_s == 'Orgmode::MarkdownOutputBuffer' ? filter = '^MarkdownMap$' : filter = '^HtmlBlockTag$|^Tags$' @custom_blocktags = YAML.load_file(@options[:markup_file]).select {|k| k.to_s.match(filter) } end
# File lib/org-ruby/output_buffer.rb, line 169 def no_custom_markup_file_exists @logger.debug "Setting Custom Markup failed. No such file exists: #{@options[:markup_file]}." @logger.debug "Continuing export with default tags." end
# File lib/org-ruby/output_buffer.rb, line 163 def no_valid_markup_found self.class.to_s == 'Orgmode::MarkdownOutputBuffer' ? tags = 'MarkdownMap' : tags = 'HtmlBlockTag or Tags' @logger.debug "Setting Custom Markup failed. No #{tags} key where found in: #{@options[:markup_file]}." @logger.debug "Continuing export with default markup." end
# File lib/org-ruby/output_buffer.rb, line 54 def pop_mode(mode = nil) m = @mode_stack.pop @logger.warn "Modes don't match. Expected to pop #{mode}, but popped #{m}" if mode && mode != m m end
Test if we're in an output mode in which whitespace is significant.
# File lib/org-ruby/output_buffer.rb, line 134 def preserve_whitespace? [:example, :inline_example, :raw_text, :src].include? current_mode end
# File lib/org-ruby/output_buffer.rb, line 49 def push_mode(mode, indent) @mode_stack.push(mode) @list_indent_stack.push(indent) end
# File lib/org-ruby/output_buffer.rb, line 157 def set_custom_markup @custom_blocktags.keys.each do |k| @custom_blocktags[k].each {|key,v| self.class.const_get(k.to_s)[key] = v if self.class.const_get(k.to_s).key? key} end end
Private Instance Methods
# File lib/org-ruby/output_buffer.rb, line 245 def add_line_attributes headline # Implemented by specific output buffers end
# File lib/org-ruby/output_buffer.rb, line 190 def boundary_of_block?(line) # Boundary of inline example return true if ((line.paragraph_type == :inline_example) ^ (@output_type == :inline_example)) # Boundary of begin...end block return true if mode_is_block? @output_type end
# File lib/org-ruby/output_buffer.rb, line 289 def buffer_indentation; false; end
# File lib/org-ruby/output_buffer.rb, line 290 def flush!; false; end
# File lib/org-ruby/output_buffer.rb, line 198 def maintain_mode_stack(line) # Always close the following lines pop_mode if (mode_is_heading? current_mode or current_mode == :paragraph or current_mode == :horizontal_rule or current_mode == :inline_example or current_mode == :raw_text) # End-block line closes every mode within block if line.end_block? and @mode_stack.include? line.paragraph_type pop_mode until current_mode == line.paragraph_type end if ((not line.paragraph_type == :blank) or @output_type == :blank) # Close previous tags on demand. Two blank lines close all tags. while ((not @list_indent_stack.empty?) and @list_indent_stack.last >= line.indent and # Don't allow an arbitrary line to close block (not mode_is_block? current_mode)) # Item can't close its major mode if (@list_indent_stack.last == line.indent and line.major_mode == current_mode) break else pop_mode end end end # Special case: Only end-block line closes block pop_mode if line.end_block? and line.paragraph_type == current_mode unless line.paragraph_type == :blank or line.assigned_paragraph_type == :comment if (@list_indent_stack.empty? or @list_indent_stack.last <= line.indent or mode_is_block? current_mode) # Opens the major mode of line if it exists if @list_indent_stack.last != line.indent or mode_is_block? current_mode push_mode(line.major_mode, line.indent) if line.major_mode end # Opens tag that precedes text immediately push_mode(line.paragraph_type, line.indent) unless line.end_block? end end end
# File lib/org-ruby/output_buffer.rb, line 182 def mode_is_block?(mode) [:quote, :center, :example, :src].include? mode end
# File lib/org-ruby/output_buffer.rb, line 186 def mode_is_code?(mode) [:example, :src].include? mode end
# File lib/org-ruby/output_buffer.rb, line 177 def mode_is_heading?(mode) [:heading1, :heading2, :heading3, :heading4, :heading5, :heading6].include? mode end
# File lib/org-ruby/output_buffer.rb, line 249 def output_footnotes! return false end
Tests if the current line should be accumulated in the current output buffer.
# File lib/org-ruby/output_buffer.rb, line 255 def should_accumulate_output? line # Special case: Assign mode if not yet done. return false unless current_mode # Special case: Handles accumulating block content and example lines if mode_is_code? current_mode return true unless (line.end_block? and line.paragraph_type == current_mode) end return false if boundary_of_block? line return true if current_mode == :inline_example # Special case: Don't accumulate the following lines. return false if (mode_is_heading? @output_type or @output_type == :comment or @output_type == :horizontal_rule or @output_type == :raw_text) # Special case: Blank line at least splits paragraphs return false if @output_type == :blank if line.paragraph_type == :paragraph # Paragraph gets accumulated only if its indent level is # greater than the indent level of the previous mode. if @mode_stack[-2] and not mode_is_block? @mode_stack[-2] return false if line.indent <= @list_indent_stack[-2] end # Special case: Multiple "paragraphs" get accumulated. return true end false end