deplate 0.7.3 → 0.8

data/lib/deplate/input.rb

@@ -3,31 +3,28 @@
 # @Website:     http://deplate.sf.net/
 # @License:     GPL (see http://www.gnu.org/licenses/gpl.txt)
 # @Created:     10-M�r-2005.
-# @Last Change: 01-Nov-2005.
-# @Revision:    0.294
+# @Last Change: 07-Jun-2006.
+# @Revision:    0.467
 #
 # = Description
 # = Usage
 # = TODO
 # = CHANGES
 
+require "deplate/common"
+
 # Input: 
-class Deplate::Input
+class Deplate::Input < Deplate::CommonObject
     class << self
-        attr_reader :myname
-
-        def myname=(value)
-            @myname = value
-            klass   = self
-            Deplate::Core.class_eval do
-                declare_input_format(klass)
-            end
+        def hook_post_myname=(name)
+            klass = self
+            Deplate::Core.class_eval {declare_input_format(klass)}
         end
     end
-    
-    self.myname = 'deplate'
 
-    attr_reader :elements, :commands, :regions, :macros
+    class_attribute :myname, 'deplate'
+
+    attr_reader :elements, :commands, :regions, :macros, :skeleton_expander
     attr_reader :paragraph_class, :comment_class, :command_class
     attr_reader :particles, :rx_particles, :particles_ext, :rx_particles_ext
 
@@ -37,14 +34,20 @@ class Deplate::Input
         @deplate  = deplate
         @options  = deplate.options
         @args     = args
-        @elements = (args[:elements] || Deplate::Element.elements)
-        @commands = (args[:commands] || Deplate::Command.commands)
-        @regions  = (args[:regions ] || Deplate::Region.regions)
-        @macros   = (args[:macros]   || Deplate::Macro.macros)
+        @elements = args[:elements] || Deplate::Element.elements
+        @commands = args[:commands] || Deplate::Command.commands
+        @regions  = args[:regions ] || Deplate::Region.regions
+        @macros   = args[:macros]   || Deplate::Macro.macros
         @paragraph_class = args[:paragraph_class] || Deplate::Element::Paragraph
         @comment_class   = args[:comment_class]   || Deplate::Element::Comment
         @command_class   = args[:command_class]   || Deplate::Element::Command
         @allow_onthefly_particles = args[:onthefly_particles] || true
+        if @options.skeletons.empty?
+            @skeleton_expander = nil
+        else
+            expander = args[:expander_class] || Deplate::SkeletonExpander
+            @skeleton_expander = expander.new(deplate)
+        end
         initialize_particles
     end
     
@@ -90,6 +93,35 @@ class Deplate::Input
             @rx_particles = get_rx_particles(@particles)
         end
     end
+ 
+    def register_element(instance, args={})
+        # <+TBD+> duplicates will be ignored
+        @elements << instance
+    end
+
+    def register_macro(instance, args={})
+        name = Deplate::CommonGround.get_explicit_id(args)
+        if @macros[name]
+            @deplate.log(['Macro already defined', name])
+        end
+        @macros[name] = instance
+    end
+    
+    def register_region(instance, args={})
+        name = Deplate::CommonGround.get_explicit_id(args)
+        if @regions[name]
+            @deplate.log(['Region already defined', name])
+        end
+        @regions[name] = instance
+    end
+    
+    def register_command(instance, args={})
+        name = Deplate::CommonGround.get_explicit_id(args)
+        if @commands[name]
+            @deplate.log(['Command already defined', name])
+        end
+        @commands[name] = instance
+    end
     
     def register_particle(particle, args={})
         arr = args[:extended] ? @particles_ext : @particles
@@ -110,7 +142,9 @@ class Deplate::Input
     end
     
     def get_rx_particles(particles)
-        return Regexp.new(particles.collect {|e| e.rx.source[1..-1]}.join("|"))
+        return Regexp.new(particles.collect do |e|
+            e.rx.source[1..-1]
+        end.join("|"))
     end
 
     def get_particles(what, alt=true)
@@ -138,23 +172,26 @@ class Deplate::Input
     # This is the general function for including text from whatever source 
     # that follows the enumeration interface. In general, the more 
     # specialized methods from Deplate::Core should be used to call this.
-    def include_enum(enum, acc_array, linenumber)
-        accum = []
-        for line in enum
+    def include_string(string, acc_array, linenumber)
+        accum  = []
+        string = @skeleton_expander.expand(string) if @skeleton_expander
+        for line in string
             linenumber += 1
             line.chomp!
             unless accum.empty?
-                line.gsub!(/^\s+/, "")
+                line.gsub!(/^\s+/, '')
             end
-            use_line_continuation = acc_array.last ? acc_array.last.line_cont : true
-            if comment_class.match(line)
+            if !unfinished_region?(acc_array.last) and comment_class.match(line)
                 next
-            elsif use_line_continuation and line =~ /(^|[^\\])\\$/
-                accum << line[0..-2]
             else
-                accum << line
-                handle_line(acc_array, accum.join, linenumber)
-                accum = []
+                use_line_continuation = acc_array.last ? acc_array.last.line_cont : true
+                if use_line_continuation and line =~ /(^|[^\\])\\$/
+                    accum << line[0..-2]
+                else
+                    accum << line
+                    handle_line(acc_array, accum.join, linenumber)
+                    accum = []
+                end
             end
         end
         handle_line(acc_array, nil, linenumber)
@@ -172,31 +209,33 @@ class Deplate::Input
                 ec = @deplate.variables['embeddedVerbatim'] || 'Verbatim'
                 rx = /^#{tic}/
                 if line =~ rx
+                    # p "DBG tic", line
                     if $1
                         line = $1
                     else
                         line.sub!(rx, '')
                     end
-                    if last.kind_of?(Deplate::Element::Region) and last.name == ec and !last.finished?
+                    if last and last.kind_of?(Deplate::Element::Region) and last.name == ec and !last.finished?
                         last = finish_last(array, last, lineNumber)
                     end
                 else
-                    if !@deplate.switches.last
+                    # p "DBG notic", line
+                    if !@deplate.switches.last and !ec.empty?
                         if last.kind_of?(Deplate::Element::Region) and last.name == ec
                             last << line
                         elsif line =~ /\S/
-                            unless last.finished?
+                            if last and !last.finished?
                                 last = finish_last(array, last, lineNumber)
                             end
                             m = Deplate::Element::Region.pseudo_match(:args => '')
                             Deplate::Element::Region.do_accumulate(src, array, @deplate, '', m, ec)
-                            array.last << line
+                            array.last << line if array.last
                         end
                     end
                     return
                 end
             end
-            if last and !last.finished? and last.endRx
+            if unfinished_region?(last)
                 # last is a region
                 if line =~ last.endRx
                     last = finish_last(array, last, lineNumber)
@@ -213,20 +252,25 @@ class Deplate::Input
                     elsif last.finished?
                         # last is finished, so we start a new element
                         c = e || paragraph_class
-                    elsif e
-                        unless e.is_volatile?(m)
-                            last = finish_last(array, last, lineNumber - 1)
-                        end
-                        c = e
-                    elsif last.to_be_continued?(line)
+                    elsif last.to_be_continued?(line, e, m)
                         # this line is something else, so we ask last if it wants 
                         # to be continued
-                        if @options.keep_whitespace or last.keep_whitespace
-                            last << line
-                        else
-                            last << line.strip
+                        case last.multiliner
+                        when :match
+                            last.push_match(m)
+                        when true
+                            if @options.keep_whitespace or last.keep_whitespace
+                                last << line
+                            else
+                                last << line.strip
+                            end
                         end
                         c = nil
+                    elsif e
+                        unless e.is_volatile?(m, self)
+                            last = finish_last(array, last, lineNumber - 1)
+                        end
+                        c = e
                     else
                         # last doesn't want this line, so we start a new element
                         last = finish_last(array, last, lineNumber - 1)
@@ -247,10 +291,14 @@ class Deplate::Input
     end
     private :handle_line
 
+    def unfinished_region?(last)
+        return last && !last.finished? && last.endRx
+    end
+                   
     def finish_last(array, last, lineNumber=-1)
-        last.source.end  = lineNumber if lineNumber > 0
-        finished_element = last.finish
-        array.pop
+        last.source.end   = lineNumber if lineNumber > 0
+        # finished_element  = last.finish
+        finished_element = array.pop.finish
         if finished_element.kind_of?(Array)
             for e in finished_element
                 handle_finished_element(array, e)
@@ -333,45 +381,62 @@ class Deplate::Input
                     particles.each do |e|
                         m = e.match(mx[0])
                         if m
-                            pre = mx.pre_match
-                            unless pre.empty?
-                                rt << Deplate::Particle::Text.new(@deplate, container, rt, mx.pre_match, alt, last)
+                            pc = e.pre_condition
+                            unless pc && !pc.call(mx)
+                                pre = mx.pre_match
+                                unless pre.empty?
+                                    rt << as_text(container, rt, mx.pre_match, alt, last)
+                                end
+                                txt = last + mx.pre_match
+                                begin
+                                    rt << e.new(@deplate, container, rt, m, alt, txt, rest)
+                                rescue Exception => exc
+                                    puts exc
+                                    # puts "#{exc}\nInternal error when initializing %s: %s" % [e.name, txt]
+                                    # raise exc
+                                end
+                                throw :ok
                             end
-                            txt = last + mx.pre_match
-                            # begin
-                                rt << e.new(@deplate, container, rt, m, alt, txt, rest)
-                                # rescue Exception => exc
-                                # puts "Internal error when initializing %s: %s" % [e.name, txt]
-                                # raise exc
-                            # end
-                            throw :ok
                         end
                     end
                     txt = mx.pre_match + mx[0]
-                    rt << Deplate::Particle::Text.new(@deplate, container, rt, txt, alt, last, rest)
+                    rt << as_text(container, rt, txt, alt, last, rest)
                 end
                 last = mx[0]
             else
-                rt << Deplate::Particle::Text.new(@deplate, container, rt, rest, alt, last, "")
+                rt << as_text(container, rt, rest, alt, last, "")
                 break
             end
         end
         return rt
     end
 
+    def as_text(container, context, match, alt, last="", rest="")
+        case match
+        when String
+            match = Deplate::Particle::Text.pseudo_match(match)
+        end
+        Deplate::Particle::Text.new(@deplate, container, context, match, alt, last, rest)
+    end
+    
     def parse_with_particles(container, text, particles, alt=true)
         parse_using(container, text, get_particles(:rx, alt), particles, alt)
     end
 
-    def parse_with_source(source, text, alt=true)
+    def parse_with_source(source, text, alt=true, excluded=[])
         container = Deplate::PseudoContainer.new(@deplate, :source => source)
-        parse(container, text, alt)
+        parse(container, text, alt, excluded)
     end
 
     def parse(container, text, alt=true, excluded=[])
         rx, particles = get_particles(:both, alt)
         for p in excluded
-            particles.delete(p)
+            case p
+            when Proc
+                particles.delete_if &p
+            else
+                particles.delete(p)
+            end
         end
         parse_using(container, text, rx, particles, alt)
     end
@@ -387,99 +452,94 @@ class Deplate::Input
     @@rxsrc_key    = %{[@\\w]+(\\[\\S*?\\])?}
     @@rxsrc_args1  = %{(#{@@rxsrc_key})(!|=(#{@@rxsrc_argval}))\\s*} % "^=!:"
     @@rxsrc_args2  = %{(#{@@rxsrc_key})(!|=(#{@@rxsrc_argval}))\\s*} % "^=!"
-    @@rx_args      = /^\s*(#{@@rxsrc_args2})(\s*$|(?=\s+#{@@rxsrc_key}(!|=)))/
+    @@rx_args      = /^\s*(#{@@rxsrc_args2})(?=(\s*$|\s+#{@@rxsrc_key}(!|=)))/
     @@rx_argstext  = /^\s*((#{@@rxsrc_args1})*?)(:\s*(.+))?$/
 
     def parse_args(argText, container=nil, firstPass=true, parseText=false)
-        if argText
-            if firstPass
-                m  = @@rx_argstext.match(argText)
-            else
-                m = [nil, argText]
-            end
-            accum = {}
-            if m
-                args = m[1]
-                text = m[10]
-                while !args.empty?
-                    m = @@rx_args.match(args)
-                    if m
-                        key = m[2]
-                        if key =~ /^no[A-Z]/
-                            key_alt = key[2..2].downcase + key[3..-1]
-                            accum[key_alt] = false
-                            val = true
-                        end
-                        if m[4] == "!"
-                            val = true
-                        elsif m[5] == 'true'
-                            val = true
-                        elsif m[5] == 'false'
-                            val = false
-                        else
-                            valm = /^"(.*?)"$/.match(m[5])
-                            if valm
-                                val = valm[1]
-                            else
-                                val = m[5].strip
-                            end
-                            val = Deplate::Core.remove_backslashes(val)
-                        end
-                        accum[key] = val
-                        args = m.post_match
-                        if args.empty?
-                            break
-                        end
-                    else
-                        log_error(@container, ["Argument parse error", args, argText])
+        unless argText
+            return nil
+        end
+        argText.strip!
+        if argText.empty?
+            return [{}, '']
+        end
+        if firstPass
+            m  = @@rx_argstext.match(argText)
+        else
+            m = [nil, argText]
+        end
+        accum = {}
+        if m
+            args = m[1]
+            text = m[10]
+            while !args.empty?
+                m = @@rx_args.match(args)
+                if m
+                    key = m[2]
+                    val = m[5]
+                    Deplate::Core.canonic_args(accum, key, val)
+                    args = m.post_match
+                    if args.empty?
                         break
                     end
+                else
+                    log_error(@container, ['Argument parse error', args, argText])
+                    break
                 end
-                if parseText
-                    if text
-                        parsed = parse(container, text)
-                    else
-                        parsed = []
-                    end
-                end
-            else
-                text   = nil
-                parsed = nil
-            end
-            id = accum['id']
-            if id
-                accum['@id'] = id
-                accum['id']  = @deplate.formatter.encode_id(id)
             end
-            fmt   = accum["fmt"]
-            accum.delete("fmt") if fmt
-            ifOpt = accum["if"]
-            if ifOpt
-                accum.delete("if")
-                ifOpt = Deplate::Element::Command.check_switch(@deplate, ifOpt)
-            else
-                ifOpt = true
-            end
-            nofmt = accum["nofmt"]
-            accum.delete("nofmt") if nofmt
-            nofmt ||= accum["noFmt"]
-            accum.delete("noFmt") if nofmt
-            if (!firstPass or (ifOpt and
-                              (!fmt || @deplate.formatter.matches?(fmt)) and 
-                              (!nofmt || !(@deplate.formatter.matches?(nofmt)))))
-                if parseText
-                    return [accum, text, parsed]
+            if parseText
+                if text
+                    parsed = parse(container, text)
                 else
-                    return [accum, text || ""]
+                    parsed = []
                 end
+            end
+        else
+            text   = nil
+            parsed = nil
+        end
+        id = accum['id']
+        if id
+            accum['@id'] = id
+            accum['id']  = @deplate.formatter.encode_id(id)
+        end
+        fmt   = accum['fmt']
+        accum.delete('fmt') if fmt
+        ifOpt0 = ifOpt = accum['if']
+        if ifOpt
+            accum.delete('if')
+            ifOpt = Deplate::Element::Command.check_switch(@deplate, ifOpt)
+        else
+            ifOpt = true
+        end
+        if ifOpt0 and !ifOpt and accum['else']
+            text = accum['else']
+            accum.delete('else')
+            parsed = parse(container, text)
+            ifOpt = true
+        end
+        nofmt = accum['nofmt']
+        accum.delete('nofmt') if nofmt
+        nofmt ||= accum['noFmt']
+        accum.delete('noFmt') if nofmt
+        if (!firstPass or
+            (ifOpt and
+             (!fmt || @deplate.formatter.matches?(fmt)) and 
+             (!nofmt || !(@deplate.formatter.matches?(nofmt)))))
+            if parseText
+                return [accum, text, parsed]
             else
-                raise Deplate::DontFormatException
+                return [accum, text || '']
             end
         else
-            return nil
+            raise Deplate::DontFormatException
         end
     end
 
+    def allow_set_variable(var)
+        true
+    end
+    
     private
     def log_error(container, text)
         (container || @deplate).log(text, :error)