my_wiki_generator 0.0.1

data/my_wiki/templates/lib/markup/simple_markup/lines.rb

@@ -0,0 +1,151 @@
+##########################################################################
+#
+# We store the lines we're working on as objects of class Line.
+# These contain the text of the line, along with a flag indicating the
+# line type, and an indentation level
+
+module SM
+
+  class Line
+    INFINITY = 9999
+
+    BLANK     = :BLANK
+    HEADING   = :HEADING
+    LIST      = :LIST
+    RULE      = :RULE
+    PARAGRAPH = :PARAGRAPH
+    VERBATIM  = :VERBATIM
+    
+    # line type
+    attr_accessor :type
+
+    # The indentation nesting level
+    attr_accessor :level
+
+    # The contents
+    attr_accessor :text
+
+    # A prefix or parameter. For LIST lines, this is
+    # the text that introduced the list item (the label)
+    attr_accessor  :param
+
+    # A flag. For list lines, this is the type of the list
+    attr_accessor :flag
+
+    # the number of leading spaces
+    attr_accessor :leading_spaces
+
+    # true if this line has been deleted from the list of lines
+    attr_accessor :deleted
+    
+
+    def initialize(text)
+      @text    = text.dup
+      @deleted = false
+
+      # expand tabs
+      1 while @text.gsub!(/\t+/) { ' ' * (8*$&.length - $`.length % 8)}  && $~ #`
+
+      # Strip trailing whitespace
+      @text.sub!(/\s+$/, '')
+
+      # and look for leading whitespace
+      if @text.length > 0
+        @text =~ /^(\s*)/
+        @leading_spaces = $1.length
+      else
+        @leading_spaces = INFINITY
+      end
+    end
+
+    # Return true if this line is blank
+    def isBlank?
+      @text.length.zero?
+    end
+
+    # stamp a line with a type, a level, a prefix, and a flag
+    def stamp(type, level, param="", flag=nil)
+      @type, @level, @param, @flag = type, level, param, flag
+    end
+
+    ##
+    # Strip off the leading margin
+    #
+
+    def strip_leading(size)
+      if @text.size > size
+        @text[0,size] = ""
+      else
+        @text = ""
+      end
+    end
+
+    def to_s
+      "#@type#@level: #@text"
+    end
+  end
+
+  ###############################################################################
+  #
+  # A container for all the lines
+  #
+
+  class Lines
+    include Enumerable
+
+    attr_reader :lines   # for debugging
+
+    def initialize(lines)
+      @lines = lines
+      rewind
+    end
+
+    def empty?
+      @lines.size.zero?
+    end
+
+    def each
+      @lines.each do |line|
+        yield line unless line.deleted
+      end
+    end
+
+#    def [](index)
+#      @lines[index]
+#    end
+
+    def rewind
+      @nextline = 0
+    end
+
+    def next
+      begin
+        res = @lines[@nextline]
+        @nextline += 1 if @nextline < @lines.size
+      end while res and res.deleted and @nextline < @lines.size
+      res
+    end
+
+    def unget
+      @nextline -= 1
+    end
+
+    def delete(a_line)
+      a_line.deleted = true
+    end
+
+    def normalize
+      margin = @lines.collect{|l| l.leading_spaces}.min
+      margin = 0 if margin == Line::INFINITY
+      @lines.each {|line| line.strip_leading(margin) } if margin > 0
+    end
+
+    def as_text
+      @lines.map {|l| l.text}.join("\n")
+    end
+
+    def line_types
+      @lines.map {|l| l.type }
+    end
+  end
+end

data/my_wiki/templates/lib/markup/simple_markup/preprocess.rb

@@ -0,0 +1,68 @@
+module SM
+
+  ## 
+  # Handle common directives that can occur in a block of text:
+  #
+  # : include : filename
+  #
+
+  class PreProcess
+
+    def initialize(input_file_name, include_path)
+      @input_file_name = input_file_name
+      @include_path = include_path
+    end
+
+    # Look for common options in a chunk of text. Options that
+    # we don't handle are passed back to our caller
+    # as |directive, param| 
+
+    def handle(text)
+      text.gsub!(/^([ \t#]*):(\w+):\s*(.+)?\n/) do 
+        prefix    = $1
+        directive = $2.downcase
+        param     = $3
+
+        case directive
+        when "include"
+          filename = param.split[0]
+          include_file(filename, prefix)
+
+        else
+          yield(directive, param)
+        end
+      end
+    end
+
+    #######
+    private
+    #######
+
+    # Include a file, indenting it correctly
+
+    def include_file(name, indent)
+      if (full_name = find_include_file(name))
+        content = File.open(full_name) {|f| f.read}
+        res = content.gsub(/^#?/, indent)
+      else
+        $stderr.puts "Couldn't find file to include: '#{name}'"
+        ''
+      end
+    end
+
+    # Look for the given file in the directory containing the current
+    # file, and then in each of the directories specified in the
+    # RDOC_INCLUDE path
+
+    def find_include_file(name)
+      to_search = [ File.dirname(@input_file_name) ].concat @include_path
+      to_search.each do |dir|
+        full_name = File.join(dir, name)
+        stat = File.stat(full_name) rescue next
+        return full_name if stat.readable?
+      end
+      nil
+    end
+
+  end
+end

data/my_wiki/templates/lib/markup/simple_markup/to_flow.rb

@@ -0,0 +1,188 @@
+require 'markup/simple_markup/fragments'
+require 'markup/simple_markup/inline'
+require 'cgi'
+
+module SM
+
+  module Flow
+    P = Struct.new(:body)
+    VERB = Struct.new(:body)
+    RULE = Struct.new(:width)
+    class LIST
+      attr_reader :type, :contents
+      def initialize(type)
+        @type = type
+        @contents = []
+      end
+      def <<(stuff)
+        @contents << stuff
+      end
+    end
+    LI = Struct.new(:label, :body)
+    H = Struct.new(:level, :text)
+  end
+
+  class ToFlow
+    LIST_TYPE_TO_HTML = {
+      SM::ListBase::BULLET     =>  [ "<ul>", "</ul>" ],
+      SM::ListBase::NUMBER     =>  [ "<ol>", "</ol>" ],
+      SM::ListBase::UPPERALPHA =>  [ "<ol>", "</ol>" ],
+      SM::ListBase::LOWERALPHA =>  [ "<ol>", "</ol>" ],
+      SM::ListBase::LABELED    =>  [ "<dl>", "</dl>" ],
+      SM::ListBase::NOTE       =>  [ "<table>", "</table>" ],
+    }
+
+    InlineTag = Struct.new(:bit, :on, :off)
+
+    def initialize
+      init_tags
+    end
+
+    ##
+    # Set up the standard mapping of attributes to HTML tags
+    #
+    def init_tags
+      @attr_tags = [
+        InlineTag.new(SM::Attribute.bitmap_for(:BOLD), "<b>", "</b>"),
+        InlineTag.new(SM::Attribute.bitmap_for(:TT),   "<tt>", "</tt>"),
+        InlineTag.new(SM::Attribute.bitmap_for(:EM),   "<em>", "</em>"),
+      ]
+    end
+
+    ##
+    # Add a new set of HTML tags for an attribute. We allow
+    # separate start and end tags for flexibility
+    #
+    def add_tag(name, start, stop)
+      @attr_tags << InlineTag.new(SM::Attribute.bitmap_for(name), start, stop)
+    end
+
+    ##
+    # Given an HTML tag, decorate it with class information
+    # and the like if required. This is a no-op in the base
+    # class, but is overridden in HTML output classes that
+    # implement style sheets
+
+    def annotate(tag)
+      tag
+    end
+
+    ## 
+    # Here's the client side of the visitor pattern
+
+    def start_accepting
+      @res = []
+      @list_stack = []
+    end
+
+    def end_accepting
+      @res
+    end
+
+    def accept_paragraph(am, fragment)
+      @res << Flow::P.new((convert_flow(am.flow(fragment.txt))))
+    end
+
+    def accept_verbatim(am, fragment)
+      @res << Flow::VERB.new((convert_flow(am.flow(fragment.txt))))
+    end
+
+    def accept_rule(am, fragment)
+      size = fragment.param
+      size = 10 if size > 10
+      @res << Flow::RULE.new(size)
+    end
+
+    def accept_list_start(am, fragment)
+      @list_stack.push(@res)
+      list = Flow::LIST.new(fragment.type)
+      @res << list
+      @res = list
+    end
+
+    def accept_list_end(am, fragment)
+      @res = @list_stack.pop
+    end
+
+    def accept_list_item(am, fragment)
+      @res << Flow::LI.new(fragment.param, convert_flow(am.flow(fragment.txt)))
+    end
+
+    def accept_blank_line(am, fragment)
+      # @res << annotate("<p />") << "\n"
+    end
+
+    def accept_heading(am, fragment)
+      @res << Flow::H.new(fragment.head_level, convert_flow(am.flow(fragment.txt)))
+    end
+
+
+    #######################################################################
+
+    private
+
+    #######################################################################
+
+    def on_tags(res, item)
+      attr_mask = item.turn_on
+      return if attr_mask.zero?
+
+      @attr_tags.each do |tag|
+        if attr_mask & tag.bit != 0
+          res << annotate(tag.on)
+        end
+      end
+    end
+
+    def off_tags(res, item)
+      attr_mask = item.turn_off
+      return if attr_mask.zero?
+
+      @attr_tags.reverse_each do |tag|
+        if attr_mask & tag.bit != 0
+          res << annotate(tag.off)
+        end
+      end
+    end
+
+    def convert_flow(flow)
+      res = ""
+      flow.each do |item|
+        case item
+        when String
+          res << convert_string(item)
+        when AttrChanger
+          off_tags(res, item)
+          on_tags(res,  item)
+        when Special
+          res << convert_special(item)
+        else
+          raise "Unknown flow element: #{item.inspect}"
+        end
+      end
+      res
+    end
+
+    # some of these patterns are taken from SmartyPants...
+
+    def convert_string(item)
+      CGI.escapeHTML(item)
+    end
+
+    def convert_special(special)
+      handled = false
+      Attribute.each_name_of(special.type) do |name|
+        method_name = "handle_special_#{name}"
+        if self.respond_to? method_name
+          special.text = send(method_name, special)
+          handled = true
+        end
+      end
+      raise "Unhandled special: #{special}" unless handled
+      special.text
+    end
+
+
+  end
+
+end

data/my_wiki/templates/lib/markup/simple_markup/to_html.rb

@@ -0,0 +1,302 @@
+require 'markup/simple_markup/fragments'
+require 'markup/simple_markup/inline'
+
+require 'cgi'
+
+module SM
+
+  class ToHtml
+
+    LIST_TYPE_TO_HTML = {
+      ListBase::BULLET =>  [ "<ul>", "</ul>" ],
+      ListBase::NUMBER =>  [ "<ol>", "</ol>" ],
+      ListBase::UPPERALPHA =>  [ "<ol>", "</ol>" ],
+      ListBase::LOWERALPHA =>  [ "<ol>", "</ol>" ],
+      ListBase::LABELED => [ "<dl>", "</dl>" ],
+      ListBase::NOTE    => [ "<table>", "</table>" ],
+      ListBase::TABLE   => [ '<table class="table" cellspacing="1" border="0">', "</table>" ], # added by ando
+    }
+
+    InlineTag = Struct.new(:bit, :on, :off)
+
+    def initialize
+      init_tags
+    end
+
+    ##
+    # Set up the standard mapping of attributes to HTML tags
+    #
+    def init_tags
+      @attr_tags = [
+        InlineTag.new(SM::Attribute.bitmap_for(:BOLD), "<b>", "</b>"),
+        InlineTag.new(SM::Attribute.bitmap_for(:TT),   "<tt>", "</tt>"),
+        InlineTag.new(SM::Attribute.bitmap_for(:EM),   "<em>", "</em>"),
+      ]
+    end
+
+    ##
+    # Add a new set of HTML tags for an attribute. We allow
+    # separate start and end tags for flexibility
+    #
+    def add_tag(name, start, stop)
+      @attr_tags << InlineTag.new(SM::Attribute.bitmap_for(name), start, stop)
+    end
+
+    ##
+    # Given an HTML tag, decorate it with class information
+    # and the like if required. This is a no-op in the base
+    # class, but is overridden in HTML output classes that
+    # implement style sheets
+
+    def annotate(tag)
+      tag
+    end
+
+    ## 
+    # Here's the client side of the visitor pattern
+
+    def start_accepting
+      @res = ""
+      @in_list_entry = []
+    end
+
+    def end_accepting
+      @res
+    end
+
+    def accept_paragraph(am, fragment)
+      @res << annotate("<p>") + "\n"
+      @res << wrap(convert_flow(am.flow(fragment.txt)))
+      @res << annotate("</p>") + "\n"
+    end
+
+    def accept_verbatim(am, fragment)
+      @res << annotate("<pre>") + "\n"
+      @res << CGI.escapeHTML(fragment.txt)
+      @res << annotate("</pre>") << "\n"
+    end
+
+    def accept_rule(am, fragment)
+      size = fragment.param
+      size = 10 if size > 10
+      @res << "<hr size=\"#{size}\"></hr>"
+    end
+
+    def accept_list_start(am, fragment)
+      @res << html_list_name(fragment.type, true) <<"\n"
+      @in_list_entry.push false
+    end
+
+    def accept_list_end(am, fragment)
+      if tag = @in_list_entry.pop
+        @res << annotate(tag) << "\n"
+      end
+      @res << html_list_name(fragment.type, false) <<"\n"
+    end
+
+    def accept_list_item(am, fragment)
+      if tag = @in_list_entry.last
+        @res << annotate(tag) << "\n"
+      end
+      @res << list_item_start(am, fragment)
+      @res << wrap(convert_flow(am.flow(fragment.txt))) << "\n"
+      @in_list_entry[-1] = list_end_for(fragment.type)
+    end
+
+    def accept_blank_line(am, fragment)
+      # @res << annotate("<p />") << "\n"
+    end
+
+    def accept_heading(am, fragment)
+      @res << convert_heading(fragment.head_level, am.flow(fragment.txt))
+    end
+
+    # This is a higher speed (if messier) version of wrap
+
+    def wrap(txt, line_len = 76)
+      res = ""
+      sp = 0
+      ep = txt.length
+      while sp < ep
+        # scan back for a space
+        p = sp + line_len - 1
+        if p >= ep
+          p = ep
+        else
+          while p > sp and txt[p] != ?\s
+            p -= 1
+          end
+          if p <= sp
+            p = sp + line_len
+            while p < ep and txt[p] != ?\s
+              p += 1
+            end
+          end
+        end
+        res << txt[sp...p] << "\n"
+        sp = p
+        sp += 1 while sp < ep and txt[sp] == ?\s
+      end
+      res
+    end
+
+    #######################################################################
+
+    private
+
+    #######################################################################
+
+    def on_tags(res, item)
+      attr_mask = item.turn_on
+      return if attr_mask.zero?
+
+      @attr_tags.each do |tag|
+        if attr_mask & tag.bit != 0
+          res << annotate(tag.on)
+        end
+      end
+    end
+
+    def off_tags(res, item)
+      attr_mask = item.turn_off
+      return if attr_mask.zero?
+
+      @attr_tags.reverse_each do |tag|
+        if attr_mask & tag.bit != 0
+          res << annotate(tag.off)
+        end
+      end
+    end
+
+    def convert_flow(flow)
+      res = ""
+      flow.each do |item|
+        case item
+        when String
+          res << convert_string(item)
+        when AttrChanger
+          off_tags(res, item)
+          on_tags(res,  item)
+        when Special
+          res << convert_special(item)
+        else
+          raise "Unknown flow element: #{item.inspect}"
+        end
+      end
+      res
+    end
+
+    # some of these patterns are taken from SmartyPants...
+
+    def convert_string(item)
+      item = CGI.escapeHTML(item).
+
+      # convert -- to em-dash, (-- to en-dash)
+        gsub(/---?/, '&#8212;'). #gsub(/--/, '&#8211;').
+
+      # convert ... to elipsis (and make sure .... becomes .<elipsis>)
+        gsub(/\.\.\.\./, '.&#8230;').gsub(/\.\.\./, '&#8230;').
+
+      # convert single closing quote
+        gsub(%r{([^ \t\r\n\[\{\(])\'}) { "#$1&#8217;" }.
+        gsub(%r{\'(?=\W|s\b)}) { "&#8217;" }.
+
+      # convert single opening quote
+        gsub(/'/, '&#8216;').
+
+      # convert double closing quote
+        gsub(%r{([^ \t\r\n\[\{\(])\'(?=\W)}) { "#$1&#8221;" }.
+
+      # convert double opening quote
+        gsub(/'/, '&#8220;').
+
+      # convert copyright
+        gsub(/\(c\)/, '&#169;').
+
+      # convert and registered trademark
+        gsub(/\(r\)/, '&#174;')
+
+      # convert column separator (by ando)
+      if item =~ /^\|\|(.*)/
+        #item = item.sub(/^\|\|/, '').gsub('||', '</td><td>')
+        item = $1.gsub('||', '</td><td>')
+      end
+
+      item
+    end
+
+    def convert_special(special)
+      handled = false
+      Attribute.each_name_of(special.type) do |name|
+        method_name = "handle_special_#{name}"
+        if self.respond_to? method_name
+          special.text = send(method_name, special)
+          handled = true
+        end
+      end
+      raise "Unhandled special: #{special}" unless handled
+      special.text
+    end
+
+    def convert_heading(level, flow)
+      res =
+        annotate("<h#{level}>") + 
+        convert_flow(flow) + 
+        annotate("</h#{level}>\n")
+    end
+
+    def html_list_name(list_type, is_open_tag)
+      tags = LIST_TYPE_TO_HTML[list_type] || raise("Invalid list type: #{list_type.inspect}")
+      annotate(tags[ is_open_tag ? 0 : 1])
+    end
+
+    def list_item_start(am, fragment)
+      case fragment.type
+      when ListBase::BULLET, ListBase::NUMBER
+        annotate("<li>")
+
+      when ListBase::UPPERALPHA
+        annotate("<li type=\"A\">")
+
+      when ListBase::LOWERALPHA
+        annotate("<li type=\"a\">")
+
+      when ListBase::LABELED
+        annotate("<dt>") +
+          convert_flow(am.flow(fragment.param)) + 
+          annotate("</dt>") +
+          annotate("<dd>")
+
+      when ListBase::NOTE
+        annotate("<tr>") +
+          annotate("<td valign=\"top\">") +
+          convert_flow(am.flow(fragment.param)) + 
+          annotate("</td>") +
+          annotate("<td>")
+       
+      when ListBase::TABLE # added by ando
+        annotate("<tr><td>")
+      
+      else
+        raise "Invalid list type"
+      end
+    end
+
+    def list_end_for(fragment_type)
+      case fragment_type
+      when ListBase::BULLET, ListBase::NUMBER, ListBase::UPPERALPHA, ListBase::LOWERALPHA
+        "</li>"
+      when ListBase::LABELED
+        "</dd>"
+      when ListBase::NOTE
+        "</td></tr>"
+      when ListBase::TABLE # added by ando
+        "</td></tr>"
+      else
+        raise "Invalid list type"
+      end
+    end
+
+  end
+
+end