deplate 0.7.3 → 0.8

data/lib/deplate/particles.rb

@@ -3,8 +3,8 @@
 # @Website:     http://deplate.sf.net/
 # @License:     GPL (see http://www.gnu.org/licenses/gpl.txt)
 # @Created:     24-M�r-2004.
-# @Last Change: 02-Nov-2005.
-# @Revision:    0.1655
+# @Last Change: 05-Jun-2006.
+# @Revision:    0.1847
 
 require "uri"
 require "deplate/common"
@@ -12,8 +12,6 @@ require "deplate/common"
 
 # Sub-line level text bits.
 class Deplate::Particle < Deplate::BaseParticle
-    # An array of auto-indexed words/strings.
-    @@autoindexed  = []
     # An array of the default particle classes.
     @@particles    = []
     # The regular expression for the default particle classes.
@@ -25,8 +23,6 @@ class Deplate::Particle < Deplate::BaseParticle
     @@rx_extended        = nil
 
     class << self
-        attr :rx
-
         def particles
             @@particles
         end
@@ -44,16 +40,20 @@ class Deplate::Particle < Deplate::BaseParticle
         end
         
         def match(text)
-            return @rx.match(text)
+            return self.rx.match(text)
         end
 
         def register_particle(c=self)
             @@particles << c
         end
+
+        def disable_particle(*particles)
+            particles.each {|p| @@particles.delete(p)}
+        end
         
         # Create an auto-indexed word. Arguments:
         # deplate:: An instance of Deplate::Core.
-        # idx:: An instance of the Deplate::Core::IndexEntry structure.
+        # idx:: An instance of the Deplate::IndexEntry structure.
         def auto_indexing(deplate, idx)
             if idx
                 i = idx.name
@@ -61,14 +61,15 @@ class Deplate::Particle < Deplate::BaseParticle
                 name = i.gsub(/\W\|s/) do |x|
                     x.unpack('H2' * x.size)
                 end
-                if !w.any? {|x| @@autoindexed.include?(x)}
-                    @@autoindexed += w
+                autoindexed = deplate.options.autoindexed
+                if !w.any? {|x| autoindexed.include?(x)}
+                    autoindexed.concat(w)
                     aname = %{AutoIndex#{name}}
                     if self == Deplate::HyperLink
                         rx = Regexp.escape(i).gsub(/\\/, "\\\\")
                         rx.gsub!(/"/, %{\\\\"})
                         body = <<-EOR
-                            @rx = %r{^\\b#{rx}\\b}
+                            set_rx(%r{^\\b#{rx}\\b})
                             def setup
                                 super
                                 name = match[0]
@@ -86,7 +87,7 @@ class Deplate::Particle < Deplate::BaseParticle
                         rx      = w.collect {|i| Regexp.escape(i)}.join("\\b|\\b")
                         rx.gsub!(/"/, %{\\\\"})
                         body = <<-EOR
-                            @rx = %r{^\\b#{rx}\\b}
+                            set_rx(%r{^\\b#{rx}\\b})
                             def setup
                                 @idx = @deplate.add_index(self, %{#{idxName}}) if @container
                             end
@@ -95,12 +96,13 @@ class Deplate::Particle < Deplate::BaseParticle
                                     @elt = plain_text(Deplate::Core.remove_backslashes(@match[0])) + 
                                         format_particle(:format_index, self, @idx)
                                 else
-                                    @elt = ""
+                                    @elt = ''
                                 end
                             end
                         EOR
                     end
                     cls = Deplate::Cache.particle(deplate, body, 
+                                                  :super    => Deplate::Autoindex,
                                                   :register => true,
                                                   :extended => true)
                 end
@@ -114,9 +116,9 @@ class Deplate::Particle < Deplate::BaseParticle
     
     end
 
-    def initialize(deplate, container, context, match, alt, last="", rest="")
+    def initialize(deplate, container, context, match, alt, last='', rest='')
         super(deplate, :container => container)
-        @level_as_string  = container.level_as_string if container
+        self.level_as_string = container.level_as_string if container
         @context   = context
         @match     = match
         @last      = last
@@ -133,23 +135,47 @@ class Deplate::Particle < Deplate::BaseParticle
 end
 
 
+class Deplate::Autoindex < Deplate::Particle
+end
+
+
 # A wrapper class for simple particles that require only minimal 
 # processing.
 class Deplate::SimpleParticle < Deplate::Particle
     def setup
         @elt = @deplate.parse(@container, get_text, @alt)
     end
+    
     def get_text
         @match[1]
     end
+    
+    def process
+        @elt = @deplate.format_particles(@elt)
+        fmt  = self.class.formatter
+        if fmt
+            @elt = format_particle(fmt, self, @elt)
+        # else
+        #     raise 'Internal error: No formatter'
+        end
+    end
 end
 
 
 # A pseudo-particle class. Note the following difference: @match holds 
 # the plain text as String and not as MatchData.
 class Deplate::Particle::Text < Deplate::Particle
+    # set_formatter :plain_text
+    class << self
+        def pseudo_match(text)
+            [text]
+        end
+    end
     def process
-        @elt = plain_text(@match)
+        @elt = plain_text(get_text)
+    end
+    def get_text
+        @match[0]
     end
 end
 
@@ -157,7 +183,7 @@ end
 # Match characters escaped with a backslash.
 class Deplate::Particle::Escaped < Deplate::Particle
     register_particle
-    set_rx /^\\(.)/
+    set_rx(/^\\(.)/)
     def process
         @elt = plain_text(@match[1], true)
     end
@@ -166,12 +192,24 @@ end
 
 # Match emphasized text marked as <tt>__text__</tt>.
 class Deplate::Particle::Emphasize < Deplate::SimpleParticle
-    register_particle
-    set_rx /^__((\\_|.)+?)__/
-    def process
-        @elt = @deplate.format_particles(@elt)
-        @elt = format_particle(:format_emphasize, self, @elt)
+    class << self
+        def markup(text)
+            if text
+                [
+                    '__', 
+                    Deplate::Core.escape_characters(text, :escape => '_\\'), 
+                    '__'
+                ].join
+            end
+        end
     end
+    register_particle
+    set_rx(/^__((\\_|.)+?)__/)
+    set_formatter :format_emphasize
+    # def process
+    #     @elt = @deplate.format_particles(@elt)
+    #     @elt = format_particle(:format_emphasize, self, @elt)
+    # end
 end
 
 
@@ -179,23 +217,29 @@ end
 class Deplate::Particle::Code < Deplate::Particle
     register_particle
     set_rx(/^''((\\\\|\\'|.)+?)''/)
+    def_get :text, 1
 
     class << self
         # Programmatically markup text as code. Used e.g. for some 
         # R-generated tables.
         def markup(text)
-            [%{''}, text.gsub("'", "\\\\'"), %{''}].join
+            [
+                %{''}, 
+                # text.gsub("'", "\\\\'"), 
+                Deplate::Core.escape_characters(text, :escape => "'\\"),
+                %{''}
+            ].join
         end
     end
     
+    def hook_pre_process
+        @elt = Deplate::Core.remove_backslashes(@elt)
+    end
+    
     def process
         text = Deplate::Core.remove_backslashes(get_text)
         @elt = format_particle(:format_code, self, text)
     end
-
-    def get_text
-        @match[1]
-    end
 end
 
 
@@ -204,28 +248,8 @@ end
 class Deplate::Particle::Symbol < Deplate::Particle
     register_particle
     
-    # A hash of symbols and method names for formatting this symbol.
-    @@symbols_table = {}
-    # An array of symbols in order as they were defined -- as ruby 
-    # eagerly sorts the keys in the @@symbols_table hash. This is used 
-    # for building the rx.
-    @@symbols_keys  = []
-
-    class << self
-        # Add a symbol. If val is nil, a general formatter dependent 
-        # routine will be used.
-        def add_symbol(key, val=nil)
-            @@symbols_keys << Regexp.escape(key)
-            @@symbols_table[key] = val
-        end
-
-        # Build the rx based on @@symbols_keys.
-        def setup_rx
-            @rx = Regexp.new(%{^(%s)} % @@symbols_keys.join("|"))
-        end
-    end
-
-    for i in [
+    # An association array of symbols and method names for formatting this symbol.
+    @@symbols_table = [
         ["<->"],
         ["<-" ],
         ["->" ],
@@ -251,14 +275,44 @@ class Deplate::Particle::Symbol < Deplate::Particle
         ["``",  :singlequote_open],
         ["`'",  :singlequote_close],
     ]
-        add_symbol(*i)
+    # An array of symbols in order as they were defined -- as ruby 
+    # eagerly sorts the keys in the @@symbols_table hash. This is used 
+    # for building the rx.
+    @@symbols_keys  = []
+
+    class << self
+        # Add a symbol. If val is nil, a general formatter dependent 
+        # routine will be used.
+        def add_symbol(key, val=nil)
+            @@symbols_keys << Regexp.escape(key)
+            # @@symbols_table[key] = val
+        end
+
+        # Build the rx based on @@symbols_keys.
+        def setup_rx
+            set_rx(Regexp.new(%{^(%s)} % @@symbols_keys.join("|")))
+        end
+
+        def reset_symbols
+            @@symbols_keys = []
+            for i in @@symbols_table
+                add_symbol(*i)
+            end
+            setup_rx
+        end
     end
-    setup_rx
 
+    reset_symbols
+    
     def process
-        sym = @@symbols_table[@match[1]]
-        if sym
+        sym = @@symbols_table.assoc(@match[1])[1]
+        case sym
+        when ::Proc
+            @elt = instance_eval &sym
+        when ::Symbol
             @elt = @deplate.formatter.send(sym, self)
+        when ::String
+            @elt = format_particle(:format_symbol, self, sym)
         else
             @elt = format_particle(:format_symbol, self, @match[1])
         end
@@ -270,7 +324,7 @@ class Deplate::Particle::DoubleQuote < Deplate::Particle
     register_particle
     set_rx(/^"/)
     def process
-        if @last =~ /(^|[\s({\[])$/
+        if @last =~ /(^|[\s({\[])$/ or (@rest =~ /^\w/ and @last =~ /\W$/)
             @elt = format_particle(:doublequote_open, self)
         else
             @elt = format_particle(:doublequote_close, self)
@@ -283,7 +337,7 @@ class Deplate::Particle::SingleQuote < Deplate::Particle
     register_particle
     set_rx(/^'/)
     def process
-        if @last =~ /(^|[\s({\[])$/
+        if @last =~ /(^|[\s({\[])$/ or (@rest =~ /^\w/ and @last =~ /\W$/)
             @elt = format_particle(:singlequote_open, self)
         else
             @elt = format_particle(:singlequote_close, self)
@@ -340,17 +394,29 @@ class Deplate::HyperLink < Deplate::Particle
         def url_anchor(url, anchor)
             dest = [url]
             if anchor and !anchor.empty?
-                dest << "#" << anchor
+                dest << '#' << anchor
             end
             dest.join
         end
+
+        def upper_case_chars
+            @@uc
+        end
+
+        def lower_case_chars
+            @@lc
+        end
+        
+        def chars
+            @@uc + @@lc
+        end
     end
     
     include Deplate::InterWiki
 
     def get_InterWiki(id)
         d = @@interwikis[id]
-        Deplate::Core.log(["Unknown InterWiki name", id], :error, @container.source) unless d
+        Deplate::Core.log(['Unknown InterWiki name', id], :error, @container.source) unless d
         return d
     end
    
@@ -367,15 +433,15 @@ class Deplate::HyperLink < Deplate::Particle
     # 
     # +++ the heuristic is fragile and sometimes gives wrong results
     def complete_wiki_ref(inter, name, dest, anchor)
-        sfx = @deplate.variables["suffix"]
-        sfx = ".%s" % sfx if sfx
+        sfx = @deplate.variables['suffix']
+        sfx = '.%s' % sfx if sfx
         if dest.empty?
             label = guess_label(dest, anchor)
             if label
                 dest = @container.output_file_name(:relative => self)
                 return :wiki, name, dest, label
             else
-                log(["Wiki reference to unknown anchor", "#{dest}##{anchor}"], :error)
+                log(['Wiki reference to unknown anchor', "#{dest}##{anchor}"], :error)
                 return nil
             end
         elsif @literal
@@ -396,23 +462,23 @@ class Deplate::HyperLink < Deplate::Particle
                 return :url, name, d.url + @deplate.file_with_suffix(dest, d.sfx), anchor
             end
         # we then check if the file was included
-        elsif @deplate.file_included?(dest, File.dirname(@container.source.file || ""), sfx)
+        elsif @deplate.file_included?(dest, File.dirname(@container.source.file || ''), sfx)
             label = guess_label(@deplate.file_with_suffix(dest, sfx), anchor)
             if label
                 dest = @container.output_file_name(:label => label)
             else
-                dest = ""
+                dest = ''
             end
             return :wiki, name, dest, label
         end
         # Fallback heuristic
-        src      = @container.source.file || ""
+        src      = @container.source.file || ''
         dest_sfx = File.extname(dest)
         dest_abs = File.expand_path(dest, File.basename(src))
         dest_is_dir = (File.exist?(dest_abs) and File.stat(dest_abs).directory?)
-        if !dest_is_dir and (dest_sfx == "" or dest_sfx == sfx or dest_sfx == File.extname(src))
+        if !dest_is_dir and (dest_sfx == '' or dest_sfx == sfx or dest_sfx == File.extname(src))
             dest1 = @deplate.file_with_suffix(dest, @deplate.options.suffix)
-            name  = dest1 if !dest_sfx.empty? and (name == dest or name == "")
+            name  = dest1 if !dest_sfx.empty? and (name == dest or name == '')
             return :url, name, dest1, anchor
         else
             return :url, name, dest, anchor
@@ -421,8 +487,8 @@ class Deplate::HyperLink < Deplate::Particle
 
     def indexing(idx)
         idx = idx.compact
-        unless @deplate.variables["indexwiki"] == "no" or idx.empty?
-            auto = @deplate.variables["autoindex"]
+        unless @deplate.variables['indexwiki'] == 'no' or idx.empty?
+            auto = @deplate.variables['autoindex']
             for i in idx
                 Deplate::Particle.auto_indexing(@deplate, i) if auto
             end
@@ -435,14 +501,14 @@ class Deplate::HyperLink < Deplate::Particle
     def process
         type, name, dest, anchor = complete_wiki_ref(@inter, *@elt)
         if type
-            dest.gsub!(/\\/, "/")
+            dest.gsub!(/\\/, '/')
             dest   = encode_dest(dest)
             anchor = encode_anchor(anchor)
             if dest =~ Deplate::HyperLink::Url.rx
                 if dest =~ /^mailto:/
-                    @styles << "mailto"
+                    @styles << 'mailto'
                 else
-                    @styles << "remote"
+                    @styles << 'remote'
                 end
             end
             case type
@@ -471,7 +537,7 @@ class Deplate::HyperLink < Deplate::Particle
 
     def encode_dest(dest)
         if dest =~ /^~/
-            return "file://%s" % File.join(ENV["HOME"], encode_path(dest[1..-1]))
+            return 'file://%s' % File.join(ENV['HOME'], encode_path(dest[1..-1]))
         elsif dest =~ Deplate::HyperLink::Url.rx
         # elsif dest =~ URI::REGEXP::ABS_URI
             # if it looks like an url, we assume that it's already properly encoded
@@ -502,17 +568,24 @@ class Deplate::HyperLink::Extended < Deplate::HyperLink
     class << self
         def setup
             # @rx  = /^\[\[([^\]#]*)(#(#{@@bc}))?\](\[(.+?)\])?([-!~*]*)\]/
-            @rx  = /^\[\[([^\]#]*)(#([^\]]*))?\](\[(.+?)\])?([-!~*]*)\]/
+            # @rx  = /^\[\[([^\]#]*)(#([^\]]*))?\](\[(.+?)\])?([-!~*]*)\]/
+            set_rx(/^\[\[(([#{@@uc}]+?)::)?([^\]#]*)(#([^\]]*))?\](\[(.+?)\])?([-!~*]*)\]/)
         end
     end
     
+    def_get :interwiki, 2
+    def_get :destination, 3
+    def_get :anchor, 5
+    def_get :name, 7
+    def_get :modifier, 8
+
     def setup
-        @inter    = nil
-        @dest     = get_destination || ""
+        @inter    = get_interwiki
+        @dest     = get_destination || ''
         @anchor   = get_anchor
         @name     = get_name
-        @modifier = get_modifier || ""
-        unless @modifier.include?("-")
+        @modifier = get_modifier || ''
+        unless @modifier.include?('-')
             if @name
                 id = @name
             else
@@ -529,7 +602,7 @@ class Deplate::HyperLink::Extended < Deplate::HyperLink
             idx = []
         end
         @idx     = indexing(idx)
-        @literal = @modifier.include?("!")  # || @dest =~ Deplate::HyperLink::Url.rx
+        @literal = @modifier.include?('!')  # || @dest =~ Deplate::HyperLink::Url.rx
         if @modifier.include?('~') and @dest =~ /^\~/
             @dest = File.expand_path(@dest)
         end
@@ -537,22 +610,6 @@ class Deplate::HyperLink::Extended < Deplate::HyperLink
             @args['target'] = '_blank'
         end
     end
-   
-    def get_destination
-        @match[1]
-    end
-
-    def get_anchor
-        @match[3]
-    end
-
-    def get_name
-        @match[5]
-    end
-
-    def get_modifier
-        @match[6]
-    end
     
     def process
         @name = @deplate.parse_and_format(self, @name, false, [
@@ -589,11 +646,21 @@ end
 #   OTHERDEPLATE::[-some name-]#there
 class Deplate::HyperLink::Simple < Deplate::HyperLink
     register_particle
+    self.pre_condition = lambda do |match|
+        pre = match.pre_match
+        cond = pre.empty? || pre !~ /[#{@@uc}#{@@lc}[:alnum:]]$/
+        if cond
+            post = match.post_match
+            cond &&= (post.empty? || post !~ /^[#{@@uc}#{@@lc}[:alnum:]]/)
+        end
+        cond
+    end
 
     class << self
         def setup
             # @rx = /^((\b[#{@@uc}]+)::)?(\[-(.*?)-\]|\b[#{@@uc}][#{@@lc}]+([#{@@uc}][#{@@lc}0-9]+)+\b)(#(#{@@ac})\b)?/
-            @rx = /^(([#{@@uc}]+)::)?(\[-(.*?)-\]|\b[#{@@uc}][#{@@lc}]+([#{@@uc}][#{@@lc}0-9]+)+\b)(#(#{@@ac}))?/
+            # set_rx(/^(([#{@@uc}]+)::)?(\[-(.*?)-\]|\b[#{@@uc}][#{@@lc}]+([#{@@uc}][#{@@lc}0-9]+)+\b)(#(#{@@ac}))?/)
+            set_rx(/^(([#{@@uc}]+)::)?(\[-(.*?)-\]|[#{@@uc}][#{@@lc}]+([#{@@uc}][#{@@lc}0-9]+)+)(#(#{@@ac}))?/)
             # @rx = /^(([#{@@uc}]+)::)?(\[-(.*?)-\]|\b[A-Z][#{@@lc}]+([#{@@uc}][#{@@lc}0-9]+)+)(#(#{@@ac}))?(?!#{@@ac})/
             # @rx = /^(([#{@@uc}]+)::)?(\[-(.*?)-\]|\b[#{@@uc}][#{@@lc}]+([#{@@uc}][#{@@lc}0-9]+)+)(#(#{@@ac}))?(?!(#{@@ac}|$))/
         end
@@ -687,29 +754,16 @@ class Deplate::Particle::Macro < Deplate::Particle
     # The macro name.
     attr_reader :macro
    
-    class << self
-        # This function builds the rx for the macro reader. The optional 
-        # argument defines the depth of nested macros for which the 
-        # regular expression is being built. The default is 5 which should 
-        # be sufficient due to the primitivity of the macro language.
-        def build_rx(depth=5)
-            @rx  = "\\{(?>\\\\\\{|\\\\\\}|\\\\\\\\|[^{}]+?|#)*\\}"
-            @rxr = @rx.gsub("\\", "\\\\\\\\")
-            for i in 1..depth
-                @rx.gsub!(/#/, @rxr)
-            end
-            @rx.gsub!(/#/, "[^{}]+?")
-            @rx = Regexp.new("^" + @rx)
-        end
-    end
-
-    build_rx
+    set_rx Deplate::Rx.builder('\\{(?>\\\\\\{|\\\\\\}|\\\\\\\\|[^{}]+?|{#})*\\}')
 
     def setup
         begin
             macro = get_text
-            unless macro.empty?
+            if macro.empty?
+                @elt = plain_text(@match[0], false)
+            else
                 @macro, args, text = split_name_args(macro)
+                # args[:macro] = macro
                 if @macro
                     @elt = Deplate::Macro.exec(@deplate, @container, @context, @macro, args, @alt, text)
                     if @elt
@@ -733,7 +787,8 @@ class Deplate::Particle::Macro < Deplate::Particle
     end
 
     def split_name_args(macro)
-        m = /^([^a-zA-Z]|[[:alnum:]_]+)(.*)$/.match(macro)
+        # m = /^([^a-zA-Z]|[[:alnum:]_]+)(.*)$/.match(macro)
+        m = /^([^a-zA-Z]|[^:[:space:]]+)(.*)$/.match(macro)
         if m
             macro = m[1]
             if macro =~ /^[^a-zA-Z]/
@@ -750,7 +805,14 @@ class Deplate::Particle::Macro < Deplate::Particle
     end
                         
     def process
-        @elt = if @elt then @elt.process else "" end
+        @elt = case @elt
+               when String
+                   @elt
+               when nil
+                   ''
+               else
+                   @elt.process
+               end
     end
 end
 
@@ -758,7 +820,7 @@ end
 # Give warnings about misplaced, unbalanced, or not-escaped curly braces.
 class Deplate::Particle::CurlyBrace < Deplate::Particle
     register_particle
-    set_rx /^([{}])/
+    set_rx(/^([{}])/)
 
     def process
         sample_pre  = @last[-10..-1]
@@ -772,7 +834,7 @@ end
 # Match against whitespace. This class is currently only used for 
 # template input filter.
 class Deplate::Particle::Whitespace < Deplate::Particle
-    set_rx /^\s+/
+    set_rx(/^\s+/)
 
     def process
         @elt = @match[0]