deplate 0.8 → 0.8.1

data/lib/deplate/regions.rb

@@ -1,10 +1,10 @@
 # regions.rb
-# @Author:      Thomas Link (samul AT web.de)
+# @Author:      Thomas Link (micathom AT gmail com)
 # @Website:     http://deplate.sf.net/
 # @License:     GPL (see http://www.gnu.org/licenses/gpl.txt)
 # @Created:     08-Mai-2004.
-# @Last Change: 05-Jun-2006.
-# @Revision:    0.1662
+# @Last Change: 2007-09-30.
+# @Revision:    0.1752
 
 # Description:
 # 
@@ -32,11 +32,59 @@ class Deplate::Region < Deplate::Element
         def set_line_cont(val=true)
             self.line_cont=val
         end
+
+        def check_file(container, out, file, source)
+            if Dir[out].empty?
+                container.log(['Output not found', out, Dir.pwd])
+                return false
+            elsif file and source
+                if File.exist?(file)
+                    accum = File.open(file) {|io| io.read}.split(/[\n\r]+/)
+                    clean_strings(accum)
+                    clean_strings(source)
+                    if accum === source
+                        container.log(['Output exists and source matches', file])
+                        return true
+                    else
+                        container.log(['Source has changed', file, accum.size, source.size])
+                        # p "DBG", accum, source
+                        # puts caller[0..10].join("\n")
+                        for i in 0..[accum.size, source.size].max
+                            unless accum[i] === source[i]
+                                container.log('%S != %S', [accum[i], source[i]])
+                            end
+                        end
+                    end
+                else
+                    container.log(['Source not found; assume that output is okay', file])
+                    return true
+                end
+            end
+            container.log(['Output needs updating', file])
+            return false
+        end
+        
+        def clean_strings(strings)
+            strings.delete('')
+            strings.each {|l| l.chomp!}
+        end
+
+        def deprecated_regnote(invoker, args, regNote, arg='@note')
+            # if !@args.has_key?(arg) or (!@args[arg] and @regNote)
+            if !args.has_key?(arg)
+                if regNote and !regNote.empty?
+                    invoker.log(['Deprecated region syntax: Use argument instead', arg, regNote]
+                                # , :anyway
+                               )
+                    # puts caller[0..10].join("\n")
+                end
+                args[arg] = regNote
+            end
+            args[arg]
+        end
+
     end
     
-    attr_reader :regNote
-    attr_accessor :indent
-
     def setup(region=nil)
         if region
             @region = region
@@ -48,10 +96,10 @@ class Deplate::Region < Deplate::Element
     def finish_accum
         if @region
             unify_now(@region)
-            @regNote = @region.regNote ? @region.regNote.strip : ""
+            @regNote = @region.regNote ? @region.regNote.strip : ''
             @accum   = @region.accum
         else
-            @regNote = ""
+            @regNote = ''
         end
         if defined?(@indent)
             rx = /^#{@indent}/
@@ -84,40 +132,8 @@ class Deplate::Region < Deplate::Element
         end
     end
 
-    class << self
-        def check_file(container, out, file, source)
-            if Dir[out].empty?
-                container.log(["Output not found", out, Dir.pwd])
-                return false
-            elsif file and source
-                if File.exist?(file)
-                    accum = File.open(file) {|io| io.read}.split(/[\n\r]+/)
-                    clean_strings(accum)
-                    clean_strings(source)
-                    if accum === source
-                        container.log(["Output exists and source matches", file])
-                        return true
-                    else
-                        container.log(["Source has changed", file, accum.size, source.size])
-                        for i in 0..[accum.size, source.size].max
-                            unless accum[i] === source[i]
-                                container.log("%S != %S", [accum[i], source[i]])
-                            end
-                        end
-                    end
-                else
-                    container.log(["Source not found; assume that output is okay", file])
-                    return true
-                end
-            end
-            container.log(["Output needs updating", file])
-            return false
-        end
-        
-        def clean_strings(strings)
-            strings.delete("")
-            strings.each {|l| l.chomp!}
-        end
+    def deprecated_regnote(arg='@note')
+        Deplate::Region.deprecated_regnote(self, @args, @regNote, arg)
     end
 end
 
@@ -171,14 +187,14 @@ class Deplate::Regions::UNKNOWN < Deplate::Region
 end
 
 
-class Deplate::Regions::Doc < Deplate::Region
+class Deplate::Regions::Var < Deplate::Region
     register_as 'Doc'
     register_as 'Var'
     set_line_cont false
 
     def finish
         finish_accum
-        id = @args['id'] || @regNote
+        id = deprecated_regnote('id')
         Deplate::Command::VAR.set_variable(@deplate, id, @accum, @args, @source)
         return nil
     end
@@ -194,17 +210,26 @@ class Deplate::Regions::Native < Deplate::Region
     def finish
         finish_accum
         @elt = @accum
+        if @args['template']
+            @elt = filter_template(@elt)
+        end
         return self
     end
 
     def process
         process_etc
-        @elt = @elt.join("\n")
         return self
     end
 
     def format_special
-        @elt
+        case @elt
+        when Array
+            @elt.join("\n")
+        else
+            puts "TBD DBG This shouldn't be @elt.class=#{@elt.class}. Please report."
+            puts @elt
+            @elt
+        end
     end
 end
 
@@ -214,30 +239,39 @@ class Deplate::Regions::Write < Deplate::Regions::Native
     self.label_mode = :none
     
     def finish
-        @vars = @deplate.variables.dup
+        unless @args['noTemplate']
+            @args['template'] = true
+        end
+        # @vars = @deplate.variables.dup
         super
     end
     
     def format_special
-        @elt = Deplate::Template.new(:template  => @elt,
-                                     :source    => @source,
-                                     :container => self)
-        Deplate::Define.let_variables(@deplate, @vars) do
-            @elt = @elt.fill_in(@deplate, :source => @source)
-        end
-        @elt = @elt.join("\n")
+        # @elt = Deplate::Template.new(:template  => @elt,
+        #                              :source    => @source,
+        #                              :container => self)
+        # Deplate::Define.let_variables(@deplate, @vars) do
+        #     @elt = @elt.fill_in(@deplate, :source => @source)
+        # end
+        # @elt = @elt.join("\n")
+        # @elt = filter_template(@elt, @vars, :container => self).join("\n")
         fname = @args['file'] || @args['id']
-        if @deplate.is_allowed?(['w', 'W'], :logger => self)
+        if fname == '-' or @deplate.is_allowed?(['w', 'W'], :logger => self)
             if fname
-                unless @deplate.is_allowed?('W')
-                    fname = File.basename(fname)
-                end
-                fname = Deplate::Core.get_out_fullname(fname, nil, @deplate.options)
-                sfx   = @args['suffix'] || @args['sfx']
-                fname = [fname, sfx.gsub(/[^[:alnum:].]/, '_')].join('.') if sfx
-                mode  = @args['append'] ? 'a' : 'w'
-                @deplate.write_file(fname, mode) do |io|
-                    io.puts(@elt)
+                if fname == '-'
+                    # fname = 2
+                    puts @elt
+                else
+                    unless @deplate.is_allowed?('W')
+                        fname = File.basename(fname)
+                    end
+                    fname = Deplate::Core.get_out_fullname(fname, nil, @deplate.options)
+                    sfx   = @args['suffix'] || @args['sfx']
+                    fname = [fname, sfx.gsub(/[^[:alnum:].]/, '_')].join('.') if sfx
+                    mode  = @args['append'] ? 'a' : 'w'
+                    @deplate.write_file(fname, mode) do |io|
+                        io.puts(@elt)
+                    end
                 end
             else
                 log(['No filename'], :error)
@@ -271,41 +305,41 @@ class Deplate::Regions::Code < Deplate::Regions::Native
 
     def setup(region)
         super
-        @syntax = @deplate.variables["codeSyntax"]
-        @style  = @deplate.variables["codeStyle"]
+        @syntax = @deplate.variables['codeSyntax']
+        @style  = @deplate.variables['codeStyle']
     end
 
     def process
         process_etc
         text = @elt.join("\n")
-        if (s = @args["syntax"])
+        if (s = @args['syntax'])
             @syntax = s
         end
-        if (s = @args["style"])
+        if (s = @args['style'])
             @style = s
         end
         if @style
-            @style = Deplate::Core.clean_file_name(@style)
+            @style = Deplate::Core.clean_name(@style)
             @deplate.call_methods_matching(@deplate.formatter, /^hook_code_process_/, @style)
         end
         if @syntax
             e = nil
             @deplate.in_working_dir do
                 fmt_name = @deplate.formatter.formatter_name
-                id       = @args["id"]
+                id       = @args['id']
                 if id
-                    id.gsub!(/\W/, "00")
+                    id.gsub!(/\W/, '00')
                     fcode    = @deplate.auxiliary_filename("code_#{id}")
                     fout     = @deplate.auxiliary_filename("code_#{id}.#{fmt_name}")
                 else
-                    log("No ID given", :anyway)
+                    log('No ID given', :anyway)
                     @@code_idx += 1
                     fcode = @deplate.auxiliary_filename(@deplate.auxiliary_auto_filename('code', @@code_idx, @elt, @syntax))
                     fout  = @deplate.auxiliary_filename(@deplate.auxiliary_auto_filename('code', @@code_idx, @elt, fmt_name))
                 end
                 if Deplate::Region.check_file(self, fout, fcode, @elt)
                     log(["Files exist! Using", fout], :anyway)
-                    File.open(fout) {|io| @elt = io.read}
+                    File.open(fout) {|io| @elt = io.readlines.collect {|l| l.chomp}}
                     return self
                 else
                     begin
@@ -314,6 +348,7 @@ class Deplate::Regions::Code < Deplate::Regions::Native
                             specialized_highlighter.each do |fmt, agent|
                                 if @deplate.formatter.matches?(fmt)
                                     e = send(agent, @syntax, @style, text)
+                                    # p "DBG Code 1 #{e.class}"
                                     break if e
                                 end
                             end
@@ -321,6 +356,7 @@ class Deplate::Regions::Code < Deplate::Regions::Native
                         unless e
                             agent = self.class.general_highlighter[fmt_name]
                             e     = send(agent, @syntax, @style, text) if agent
+                            # p "DBG Code 2 #{e.class}"
                         end
                     rescue StandardError => e
                         log("#Code: #{e}", :error)
@@ -332,13 +368,21 @@ class Deplate::Regions::Code < Deplate::Regions::Native
                 end
             end
             if e
-                @elt = e
+                case e
+                when Array
+                    @elt = e
+                when String
+                    p "DBG e should be an Array. Please report."
+                    @elt = e.split("\n")
+                else
+                    raise "DBG Unknown class for e: #{e.class}. Please report."
+                end
                 return self
             end
         else
             log("Code: No syntax defined!", :error)
         end
-        return Deplate::Regions::Verbatim.new(@deplate, @source, text, @match, self).finish.process
+        return Deplate::Regions::Verbatim.new(@deplate, @source, @elt, @match, self).finish.process
     end
 end
 
@@ -371,7 +415,7 @@ class Deplate::Regions::Inlatex < Deplate::Region
 
     def register_caption
         if @args["inline"]
-            log("Can't attach caption to a LaTeX fragment marked as inline", :error)
+            log("Cannot attach caption to a LaTeX fragment marked as inline", :error)
         elsif @content_type == "table"
             register_table
         else
@@ -530,6 +574,7 @@ module Deplate::Regions::Img_R
             raise
         end
         post << "dev.off()"
+        post << "q(runLast=FALSE)"
         return (pre + accum + post).flatten
     end
 
@@ -564,7 +609,7 @@ class Deplate::Regions::Footnote < Deplate::Region::SecondOrder
     def finish
         rv = super
         @prototype = Deplate::Element
-        id = (@args['id'] ||= @regNote)
+        id = deprecated_regnote('id')
         if id
             @deplate.footnotes[id] = rv
             # @deplate.register_metadata(src, 
@@ -582,22 +627,27 @@ end
 
 class Deplate::Regions::Foreach < Deplate::Region
     register_as 'Foreach'
+    register_as 'For'
     self.label_mode = :once
 
     def finish
         finish_accum
-        @id = @args['@id'].split(/[\s,]+/)
+        @id = Deplate::Core.split_list(@args['@id'], ',', '; ', @source)
         unless @id
             log('No ID given', :error)
             return nil
         end
-        doc = @args['doc']
+        doc = @args['var'] || @args['doc']
         if doc
             @list = @deplate.variables[doc]
         else
-            @list = @regNote
+            @list = deprecated_regnote('each')
         end
-        if @list.kind_of?(Array)
+        case @list
+        when nil
+            log('Missing arguments', :error)
+            return nil
+        when Array
             @list = @list.flatten
         else
             rx = @args['rx']
@@ -613,6 +663,13 @@ class Deplate::Regions::Foreach < Deplate::Region
                 end
             end
         end
+        use_template = !(@args['noTemplate'] || deplate.variables['legacyFor1'])
+        if use_template
+            tmpl = Deplate::Template.new(:master    => @deplate,
+                                         :template  => @accum,
+                                         :source    => @source,
+                                         :container => self)
+        end
         @foreach = []
         while !@list.empty?
             ids = {}
@@ -620,7 +677,12 @@ class Deplate::Regions::Foreach < Deplate::Region
                 ids[i] = @list.shift
             end
             Deplate::Define.let_variables(@deplate, ids) do
-                acc = @deplate.parsed_array_from_strings(@accum, 1 + @source.begin, @source.file)
+                if use_template
+                    body = tmpl.fill_in(deplate, :source => @source)
+                else
+                    body = @accum
+                end
+                acc  = @deplate.parsed_array_from_strings(body, 1 + @source.begin, @source.file)
                 @prototype ||= acc[0]
                 @foreach << [ids, acc]
             end
@@ -739,6 +801,13 @@ class Deplate::Regions::Quote < Deplate::Region::SecondOrder
 end
 
 
+class Deplate::Regions::Region < Deplate::Region::SecondOrder
+    register_as 'Region'
+    register_as 'Block'
+    set_formatter :format_region, true
+end
+
+
 class Deplate::Regions::R < Deplate::Region
     register_as 'R'
 
@@ -958,6 +1027,7 @@ class Deplate::Regions::R < Deplate::Region
             log(["Running R", d, r, out])
             begin
                 @accum.unshift(%{deplate.fmt <- "#{@deplate.formatter.formatter_name}"})
+                @accum << %{q(runLast=FALSE)}
                 if Deplate::Region.check_file(self, out, r, @accum)
                     log(["Files exist! Using", out], :anyway)
                 else
@@ -974,7 +1044,7 @@ class Deplate::Regions::R < Deplate::Region
                 @accum = File.open(out) {|io| io.read}.split(/[\n\r]+/)
                 skip = @args["skip"]
                 if skip
-                    head, tail = skip.split(/,/).collect {|n| n.to_i}
+                    head, tail = Deplate::Core.split_list(skip, nil, nil, @source).collect {|n| n.to_i}
                     @accum = @accum[(head || 0) .. (@accum.size - tail - 1 || -1)] || []
                 end
                 rv = true
@@ -1003,12 +1073,12 @@ class Deplate::Regions::Ruby < Deplate::Region
     def finish
         finish_accum
         @accum = [@deplate.eval_ruby(self, @args, @accum.join("\n")).to_s]
-        if @args["verb"]
+        if @args['verb']
             return Deplate::Regions::Verbatim.new(@deplate, @source, @accum, @match, self).finish
-        elsif @args["img"] or @args["image"]
-            file = @args["img"] || @args["image"]
-            return Deplate::Command::IMG.new(@deplate, @source, file, nil, {}, "IMG").finish
-        elsif @args["native"]
+        elsif @args['img'] or @args['image']
+            file = @args['img'] || @args['image']
+            return Deplate::Command::IMG.new(@deplate, @source, file, nil, {}, 'IMG').finish
+        elsif @args['native']
             return Deplate::Regions::Native.new(@deplate, @source, @accum, @match, self).finish
         else
             acc = []
@@ -1036,7 +1106,7 @@ class Deplate::Regions::Clip < Deplate::Region::SecondOrder
 
     def finish
         finish_accum
-        id           = @args["id"] || @regNote
+        id           = deprecated_regnote('id')
         @doc_type    = :array
         @processed   = false
         @elt         = @deplate.parsed_array_from_strings(@accum, @source.begin, @source.file)
@@ -1060,7 +1130,7 @@ class Deplate::Regions::Clip < Deplate::Region::SecondOrder
     end
 
     def log(*args)
-        if @invoker
+        if defined?(@invoker) and @invoker
             @invoker.log(*args)
         else
             super