ctioga2 0.6.1 → 0.7

data/lib/ctioga2/graphics/styles/plot-types.rb

@@ -0,0 +1,123 @@
+# contour.rb: the style of a contour plot
+# copyright (c) 2009 by Vincent Fourmond
+  
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+  
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details (in the COPYING file).
+
+require 'ctioga2/utils'
+require 'ctioga2/log'
+
+
+# This module contains all the classes used by ctioga
+module CTioga2
+
+  Version::register_svn_info('$Revision$', '$Date$')
+
+  module Graphics
+
+    module Styles
+
+      StyleAspectRE = {
+        /^marker[_-]color$/i => :marker_color,
+        /^marker[_-](size|scale)$/i => :marker_scale,
+      }
+
+      StyleAspect = 
+        CmdType.new('style-aspect',  {:type => :re_list,
+                      :list => StyleAspectRE}, <<EOD)
+
+This type designs which aspect of the style of a 
+{command: xy-parametric} plot is controlled by a certain Z value.
+It can take the following values:
+ * @marker_color@: the color for the markers
+ * @marker_size@/@marker_scale@: the size of the markers
+EOD
+
+      # This class defines how the Z values are converted into
+      # stylistic information
+      class ParametricPlotStyle < BasicStyle
+        
+        # What is the z1 axis
+        typed_attribute :z1, 'style-aspect'
+
+        # What is the z2 axis
+        typed_attribute :z2, 'style-aspect'
+
+        def initialize
+          @z1 = :marker_color
+        end
+
+        def prepare
+          @reversed = {}
+          
+          2.times do |i|
+            val = self.send("z#{i+1}")
+            if val
+              @reversed[val] = i
+            end
+          end
+        end
+
+        # Returns the marker style for the given Z values.
+        #
+        # This will only work if #prepare has been called first !
+        def marker_style(curve_style, zvalue, zmin, zmax)
+
+          style = curve_style.marker.dup
+
+          if @reversed[:marker_scale]
+            idx = @reversed[:marker_scale]
+            if idx < zvalue.size
+              max_scale = curve_style.marker.scale || 1.0
+
+              ## @todo Later on, when a min_marker_scale is provided,
+              ## then the scale will be constrained between the min
+              ## and max. For now, it is simply proportionnal to the
+              ## absolute value of the largest.
+              min_scale = curve_style.marker_min_scale
+
+              zm = zmin[idx]
+              zM = zmax[idx] 
+              
+              mm = zM.abs
+              m2 = zm.abs
+              mm = m2 if m2 > mm
+
+              z = zvalue[idx]
+
+              style.scale = if min_scale
+                              min_scale + (max_scale - min_scale) * 
+                                (z - zm)/(zM - zm)
+                            else
+                              zvalue[idx].abs/mm * max_scale
+                            end
+            end
+
+          end
+
+          if @reversed[:marker_color]
+            idx = @reversed[:marker_color]
+            if idx < zvalue.size
+              style.color = curve_style.marker_color_map.z_color(zvalue[idx], 
+                                                                 zmin[idx], 
+                                                                 zmax[idx])
+            end
+          end
+
+          return style
+
+        end
+
+      end
+    end
+
+  end
+end
+

data/lib/ctioga2/graphics/styles/plot.rb

@@ -19,7 +19,7 @@ require 'ctioga2/graphics/coordinates'
 # This module contains all the classes used by ctioga
 module CTioga2
 
-  Version::register_svn_info('$Revision: 488 $', '$Date: 2013-09-03 00:31:36 +0200 (Tue, 03 Sep 2013) $')
+  Version::register_svn_info('$Revision: 521 $', '$Date: 2013-09-21 18:55:05 +0200 (Sat, 21 Sep 2013) $')
 
   module Graphics
 
@@ -355,13 +355,27 @@ EOH
 
       end
 
+      asco = AxisStyleOptions.dup
+      asco['also-axes'] = CmdArg.new('axis')
+
       AxisStyleCommand = 
           Cmd.new("axis-style",nil,"--axis-style", 
                   [
                    CmdArg.new('axis'),
-                  ], AxisStyleOptions) do |plotmaker, which, opts|
-        style = AxisStyle.current_axis_style(plotmaker, which)
-        style.set_from_hash(opts)
+                  ], asco) do |plotmaker, which, opts|
+        axes = [which]
+        if opts['also-axes']
+          axes += opts['also-axes'].split(/\s*,\s*/)
+        end
+
+        for w in axes
+          begin
+            style = AxisStyle.current_axis_style(plotmaker, w)
+            style.set_from_hash(opts)
+          rescue Exception => e
+            error {"Error while setting style of axis: #{w} -- #{e}"}
+          end
+        end
       end
       AxisStyleCommand.
         describe("Sets the style of the given axis", 
@@ -370,6 +384,10 @@ This command can be used to set various aspects of the style of the
 given axis, through its various options, which are documented in more details 
 in the {command: define-axis-style} command -- excepted for the @ticks@ bit
 which are documented in the {command: ticks} command.
+
+If the option @also-axes@ is specified, the style is also applied to
+the comma-separated list of axes it contains.
+
 EOH
 
       ClearAxesCommand = 

data/lib/ctioga2/graphics/types.rb

@@ -26,7 +26,7 @@ require 'ctioga2/graphics/types/grid'
 # This module contains all the classes used by ctioga
 module CTioga2
 
-  Version::register_svn_info('$Revision: 466 $', '$Date: 2013-08-31 13:10:38 +0200 (Sat, 31 Aug 2013) $')
+  Version::register_svn_info('$Revision: 523 $', '$Date: 2013-09-22 15:31:16 +0200 (Sun, 22 Sep 2013) $')
 
   module Graphics
 
@@ -49,6 +49,7 @@ module CTioga2
 
     ColorType = CmdType.new('color', {
                               :type => :tioga_color,
+                              :namespace => Tioga::ColorConstants,
                             }, <<EOD)
 A color. It can take three forms:
  * a named color, see 
@@ -61,9 +62,10 @@ EOD
     ColorOrFalseType = 
       CmdType.new('color-or-false', {
                     :type => :tioga_color,
+                    :namespace => Tioga::ColorConstants,
                     :shortcuts => {'none' => false }
                   }, <<EOD)
-A {type: color}, or false to say that nothing should be drawn.
+A {type: color}, or none to say that nothing should be drawn.
 EOD
 
 

data/lib/ctioga2/log.rb

@@ -16,7 +16,7 @@ require 'logger'
 
 module CTioga2
 
-  Version::register_svn_info('$Revision: 497 $', '$Date: 2013-09-04 22:07:55 +0200 (Wed, 04 Sep 2013) $')
+  Version::register_svn_info('$Revision: 522 $', '$Date: 2013-09-22 12:02:48 +0200 (Sun, 22 Sep 2013) $')
 
   # This module should be included (or extended) by every class that
   # need logging/debugging facilities.
@@ -101,7 +101,10 @@ module CTioga2
 
     # A logged replacement for system
     def spawn(cmd, priority = :info)
-      retval = system(cmd)
+      if cmd.is_a? String
+        cmd = [cmd]
+      end
+      retval = system(*cmd)
       self.send(priority) { "Spawned #{cmd} -> " + 
         if retval
           "success"

data/lib/ctioga2/metabuilder/type.rb

@@ -20,7 +20,7 @@ require 'ctioga2/utils'
 
 module CTioga2
 
-  Version::register_svn_info('$Revision: 151 $', '$Date: 2010-06-19 23:45:20 +0200 (Sat, 19 Jun 2010) $')
+  Version::register_svn_info('$Revision: 523 $', '$Date: 2013-09-22 15:31:16 +0200 (Sun, 22 Sep 2013) $')
   
 
   # The MetaBuilder module contains a framework to perform
@@ -104,6 +104,13 @@ module CTioga2
       # passed through without further modification.
       attr_accessor :passthrough
 
+      # An array of module whose constants can be used "as such"
+      attr_accessor :namespace
+
+      # When a :namespace option is provided, this hash provides a
+      # lookup 'lowercase name' => constant value.
+      attr_accessor :namespace_lookup
+
       # A default constructor. It should be safe to use it directly for
       # children, unless something more specific is needed. Any descendent
       # should *always* register _type_ as @type - or, even better, call
@@ -128,6 +135,7 @@ module CTioga2
 
       end
 
+
       # This class function actually registers the current type
       # to the Type ancestor. _name_ should be a symbol.
       # Moreover, if the second argument is provided, it automatically
@@ -200,11 +208,12 @@ module CTioga2
             end
           end
         end
+
         # Then, constants lookup.
         if @type.key?(:namespace)
           begin
             return stt_run_hook(lookup_const(string))
-          rescue Exception
+          rescue IncorrectInput
           end
         end
         return stt_run_hook(string_to_type_internal(string))
@@ -276,17 +285,32 @@ module CTioga2
       
       protected
 
+      def build_namespace_lookup
+        if @type[:namespace]
+          @namespace = [@type[:namespace]].flatten
+
+          @namespace_lookup = {}
+          for m in @namespace
+            for c in m.constants
+              @namespace_lookup[c.to_s.downcase] = m.const_get(c)
+            end
+          end
+        end
+
+      end
+
       # Looks for the value as a constant specified in the :namespace
       # modules. Raises IncorrectInput if not found.
       def lookup_const(str)
-        for mod in [@type[:namespace]].flatten
-          begin
-            return mod.const_get(str)
-          rescue
-            # Nothing, we still look up
-          end
+        str = str.downcase
+        if @type[:namespace] && (! @namespace_lookup)
+          build_namespace_lookup
+        end
+        if @namespace_lookup.key? str
+          return @namespace_lookup[str]
+        else
+          raise IncorrectInput, "Constant #{str} not found"
         end
-        raise IncorrectInput, "Constant #{str} not found"
       end
       
       # The internal function for converting type to a string. Used by

data/lib/ctioga2/plotmaker.rb

@@ -158,7 +158,7 @@ require 'ctioga2/postprocess'
 # displays of rate constants vs potentials)
 module CTioga2
 
-  Version::register_svn_info('$Revision: 508 $', '$Date: 2013-09-09 22:13:14 +0200 (Mon, 09 Sep 2013) $')
+  Version::register_svn_info('$Revision: 522 $', '$Date: 2013-09-22 12:02:48 +0200 (Sun, 22 Sep 2013) $')
 
   # This class is the core of ctioga. It parses the command-line arguments,
   # reads all necessary files and plots graphs. Most of its functionality
@@ -700,12 +700,18 @@ EOH
     
     XpdfViewerCommand = 
       Cmd.new("xpdf",'-X',"--xpdf", [ ]) do |plotmaker|
-      plotmaker.postprocess.viewer = "xpdf -z page"
+      plotmaker.postprocess.viewer = :auto
     end
 
     XpdfViewerCommand.describe('Uses xpdf to view the produced PDF files', 
                               <<EOH, OutputSetupGroup)
 Uses xpdf to view the PDF files produced by ctioga2.
+
+If xpdf is not found, then it tries to guess which viewers are available:
+ * on windows, it uses the system file associations to open the PDF file
+ * on mac, it uses the open command
+ * on linux, it tries, mime-open, and if that is missing, falls back to
+   commonly available PDF viewers.
 EOH
 
     OpenViewerCommand = 

data/lib/ctioga2/postprocess.rb

@@ -17,7 +17,7 @@ require 'ctioga2/log'
 
 module CTioga2
 
-  Version::register_svn_info('$Revision: 155 $', '$Date: 2010-06-21 21:41:32 +0200 (Mon, 21 Jun 2010) $')
+  Version::register_svn_info('$Revision: 522 $', '$Date: 2013-09-22 12:02:48 +0200 (Sun, 22 Sep 2013) $')
 
   # What happens to generated PDF files ?
   #
@@ -69,6 +69,33 @@ module CTioga2
     end
 
 
+    # Try to open the file with xpdf, or fallback to system defaults
+    def view_pdf(pdf)
+      if Utils.which("xpdf")
+        spawn(["xpdf", "-z", "page", pdf])
+      else
+        case Utils.os
+        when :windows
+          # Use start
+          spawn(["start", "/B", pdf])
+        when :macosx
+          spawn(["open", pdf])
+        else
+          for w in %w{evince gv mimeopen}
+            if Utils.which(w)
+              if w == "mimeopen"
+                spawn(["mimeopen", "-n", pdf])
+              else
+                spawn([w, pdf])
+              end
+              break
+            end
+          end
+        end
+      end
+    end
+
+
     # Process the given _file_. If _last_ is true, things that should
     # only happen last happen.
     def process_file(file, last = false)
@@ -96,15 +123,19 @@ module CTioga2
 
       # View produced PDF or PNG files...
       if (last || @view_all) && @viewer
-        if @png_res
-          cmd = "display #{target}"
-        elsif @viewer =~ /%s/
-          cmd = @viewer % file
+        if @viewer == :auto
+          view_pdf(file)
         else
-          cmd = "#{@viewer} #{file}"
+          if @png_res
+            cmd = "display #{target}"
+          elsif @viewer =~ /%s/
+            cmd = @viewer % file
+          else
+            cmd = "#{@viewer} #{file}"
+          end
+          info { "Spawning the viewer as requested for #{file}" }
+          spawn(cmd)
         end
-        info { "Spawning the viewer as requested for #{file}" }
-        spawn(cmd)
       end
     end
 

data/lib/ctioga2/utils.rb

@@ -11,6 +11,9 @@
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 # GNU General Public License for more details (in the COPYING file).
 
+# For platform detection
+require 'rbconfig'
+
 module CTioga2
 
   # An exception to raise upon to-be-implemented-one-day features
@@ -35,7 +38,7 @@ module CTioga2
     # arguments and have the Date and Revision svn:keyword:. Use this
     # way:
     #
-    #  Version::register_svn_info('$Revision: 508 $', '$Date: 2013-09-09 22:13:14 +0200 (Mon, 09 Sep 2013) $')
+    #  Version::register_svn_info('$Revision: 532 $', '$Date: 2013-09-29 12:13:33 +0200 (Sun, 29 Sep 2013) $')
     #
     # To set the correct properties, the following command-line can be
     # used:
@@ -75,7 +78,7 @@ module CTioga2
     }
 
     # The position of the URL, used for getting the version
-    SVN_URL = '$HeadURL: svn+ssh://rubyforge.org/var/svn/ctioga2/releases/ctioga2-0.6.1/lib/ctioga2/utils.rb $'
+    SVN_URL = '$HeadURL: svn+ssh://rubyforge.org/var/svn/ctioga2/releases/ctioga2-0.7/lib/ctioga2/utils.rb $'
     
     # The version of ctioga2
     CTIOGA_VERSION = if SVN_URL =~ /releases\/ctioga2-([^\/]+)/
@@ -84,7 +87,7 @@ module CTioga2
                        "SVN version"
                      end
 
-    register_svn_info('$Revision: 508 $', '$Date: 2013-09-09 22:13:14 +0200 (Mon, 09 Sep 2013) $')
+    register_svn_info('$Revision: 532 $', '$Date: 2013-09-29 12:13:33 +0200 (Sun, 29 Sep 2013) $')
 
   end
 
@@ -254,6 +257,93 @@ module CTioga2
       end
       return file               # But that will fail later on.
     end
+
+
+
+    # Cross-platform way of finding an executable in the $PATH.
+    #
+    # This is adapted from
+    # http://stackoverflow.com/questions/2108727/which-in-ruby-checking-if-program-exists-in-path-from-ruby
+    def self.which(cmd)
+      return nil unless cmd
+      exts = ['']
+      if ENV['PATHEXT']
+        exts += ENV['PATHEXT'].split(';')
+      end
+
+      ENV['PATH'].split(File::PATH_SEPARATOR).each do |path|
+        exts.each { |ext|
+          exe = File.join(path, "#{cmd}#{ext}")
+          return exe if File.executable? exe
+        }
+      end
+      return nil
+    end
+
+
+    # Reliable OS detection, coming from:
+    #
+    # http://stackoverflow.com/questions/11784109/detecting-operating-systems-in-ruby
+    def self.os
+      host_os = RbConfig::CONFIG['host_os']
+      case host_os
+      when /mswin|msys|mingw|cygwin|bccwin|wince|emc/
+        :windows
+      when /darwin|mac os/
+        :macosx
+      when /linux/
+        :linux
+      when /solaris|bsd/
+        :unix
+      else
+        warn {"Unknown os: #{host_os.inspect}"}
+        :unknown
+      end
+    end
+
+
+    # Cluster a series of objects by the values returned by the given
+    # funcall. It returns an array of arrays where the elements are in
+    # the same order, and in each sub-array, the functions all return
+    # the same value
+    #
+    # @todo with block too ?
+    def self.cluster_by_value(list, funcall)
+      if list.size == 0
+        return []
+      end
+      ret = [ [list[0]] ]
+      cur = ret[0]
+      last = cur.first.send(funcall)
+
+      for o in list[1..-1]
+        val = o.send(funcall)
+        if last == val
+          cur << o
+        else
+          cur = [o]
+          ret << cur
+          last = val
+        end
+      end
+
+      return ret
+     end
+
+
+    # Returns a hash value -> [elements] in which the elements are in
+    # the same order
+    def self.sort_by_value(list, funcall)
+      ret = {}
+      
+      for el in list
+        val = el.send(funcall)
+        ret[val] ||= []
+
+        ret[val] << el
+      end
+      return ret
+    end
   end