ctioga2 0.3 → 0.4

data/lib/ctioga2/graphics/elements/region.rb

@@ -17,7 +17,7 @@ require 'ctioga2/log'
 
 module CTioga2
 
-  Version::register_svn_info('$Revision$', '$Date$')
+  Version::register_svn_info('$Revision: 288 $', '$Date: 2011-02-22 21:12:58 +0100 (Tue, 22 Feb 2011) $')
 
   module Graphics
 

data/lib/ctioga2/graphics/elements/subplot.rb

@@ -16,7 +16,7 @@ require 'ctioga2/log'
 
 module CTioga2
 
-  Version::register_svn_info('$Revision$', '$Date$')
+  Version::register_svn_info('$Revision: 329 $', '$Date: 2012-12-11 00:13:17 +0100 (Tue, 11 Dec 2012) $')
 
   module Graphics
 
@@ -103,8 +103,14 @@ module CTioga2
         # Makes up a Boundaries object from two axes keys
         def get_given_boundaries(horiz, vert)
           if @computed_boundaries
-            return Types::Boundaries.from_ranges(@computed_boundaries[horiz],
-                                                 @computed_boundaries[vert])
+            if @computed_boundaries.key?(horiz) and 
+                @computed_boundaries.key?(vert)
+              return Types::Boundaries.from_ranges(@computed_boundaries[horiz],
+                                                   @computed_boundaries[vert])
+            else
+              error { "A subplot element doesn't have inner bounds -- which probably means that no curves were defined" }
+              return Types::Boundaries.new(0.0,1.0,0.0,1.0)
+            end
           else
             return nil
           end

data/lib/ctioga2/graphics/elements/tangent.rb

@@ -17,7 +17,7 @@ require 'ctioga2/graphics/elements/primitive'
 # This module contains all the classes used by ctioga
 module CTioga2
 
-  Version::register_svn_info('$Revision$', '$Date$')
+  Version::register_svn_info('$Revision: 171 $', '$Date: 2010-10-22 17:07:52 +0200 (Fri, 22 Oct 2010) $')
 
   module Graphics
 

data/lib/ctioga2/graphics/elements/xyz-map.rb

@@ -19,7 +19,7 @@ require 'Dobjects/Function'
 
 module CTioga2
 
-  Version::register_svn_info('$Revision$', '$Date$')
+  Version::register_svn_info('$Revision: 198 $', '$Date: 2010-11-30 00:48:23 +0100 (Tue, 30 Nov 2010) $')
 
   module Graphics
 

data/lib/ctioga2/graphics/generator.rb

@@ -18,7 +18,7 @@ require 'ctioga2/graphics/coordinates'
 
 module CTioga2
 
-  Version::register_svn_info('$Revision$', '$Date$')
+  Version::register_svn_info('$Revision: 311 $', '$Date: 2012-04-16 22:51:59 +0200 (Mon, 16 Apr 2012) $')
 
   module Graphics
 

data/lib/ctioga2/graphics/legends.rb

@@ -19,7 +19,7 @@ require 'ctioga2/graphics/legends/provider'
 
 module CTioga2
 
-  Version::register_svn_info('$Revision$', '$Date$')
+  Version::register_svn_info('$Revision: 357 $', '$Date: 2012-12-26 00:49:11 +0100 (Wed, 26 Dec 2012) $')
 
   module Graphics
 
@@ -54,6 +54,9 @@ EOH
 Adds a line of text unrelated to any curve to the legend.
 EOH
 
+    
+    Commands::make_alias_for_option 'legend-line', 'alignment', 'align', true
+    
     AutoLegendCommand = 
       Cmd.new("auto-legend",nil,"--auto-legend", 
               [ CmdArg.new('boolean') ]) do |plotmaker, value|
@@ -66,12 +69,7 @@ When this option is in effect (off by default), all datasets get a legend,
 their 'dataset name', unless another legend is manually specified.
 EOH
 
-    LegendStyleOptions = {
-      'dy' => CmdArg.new('dimension'),
-      'scale' => CmdArg.new('float'),
-      'text_scale' => CmdArg.new('float'),
-    }
-      
+    LegendStyleOptions = Styles::LegendStorageStyle.options_hash()
 
     LegendStyleCommand = 
       Cmd.new("legend-style",nil,"--legend-style", 

data/lib/ctioga2/graphics/legends/area.rb

@@ -16,7 +16,7 @@ require 'ctioga2/log'
 
 module CTioga2
 
-  Version::register_svn_info('$Revision$', '$Date$')
+  Version::register_svn_info('$Revision: 359 $', '$Date: 2012-12-26 10:45:35 +0100 (Wed, 26 Dec 2012) $')
 
   module Graphics
 
@@ -27,13 +27,6 @@ module CTioga2
       #
       # \todo
       # 
-      # * a legend can be plotted either inside a plot or outside the
-      #   root object
-      #   
-      # * in case it is plotted outside the root object, the user should
-      #   be able to choose whether it should be counted in the
-      #   real-size or not.
-      #
       # * legends should provide all the kind of things that were in the
       #   first ctioga, such as background, frames, and so on...
       #
@@ -88,6 +81,13 @@ module CTioga2
             t.set_bounds([0, 1, 1, 0])
             ## \todo customize this !
             x, y = initial_xy(t, container)
+
+            w,h = *size(t, container)
+            h /= @legend_style.scale * @legend_style.text_scale
+            @legend_style.frame.
+              draw_box_around(t, x, y,
+                              x + w, y - h, @legend_style.frame_padding)
+            
             for item in items
               ## \todo transform the 0.0 for x into a negative
               # user-specifiable stuff.

data/lib/ctioga2/graphics/legends/items.rb

@@ -18,7 +18,7 @@ require 'ctioga2/graphics/styles'
 
 module CTioga2
 
-  Version::register_svn_info('$Revision$', '$Date$')
+  Version::register_svn_info('$Revision: 345 $', '$Date: 2012-12-24 10:43:37 +0100 (Mon, 24 Dec 2012) $')
 
   module Graphics
 
@@ -146,7 +146,7 @@ module CTioga2
             t.subfigure(margin_specs) do
               # We make the markers slightly smaller than the text
               # around.
-              t.rescale_text(0.8)
+              t.rescale_text(0.8 * legend_style.symbol_scale)
               @curve_style.draw_legend_pictogram(t)
             end
           end

data/lib/ctioga2/graphics/legends/provider.rb

@@ -16,7 +16,7 @@ require 'ctioga2/log'
 
 module CTioga2
 
-  Version::register_svn_info('$Revision$', '$Date$')
+  Version::register_svn_info('$Revision: 2 $', '$Date: 2009-04-25 14:03:30 +0200 (Sat, 25 Apr 2009) $')
 
   module Graphics
 

data/lib/ctioga2/graphics/legends/storage.rb

@@ -16,7 +16,7 @@ require 'ctioga2/log'
 
 module CTioga2
 
-  Version::register_svn_info('$Revision$', '$Date$')
+  Version::register_svn_info('$Revision: 139 $', '$Date: 2010-01-22 00:12:17 +0100 (Fri, 22 Jan 2010) $')
 
   module Graphics
 

data/lib/ctioga2/graphics/root.rb

@@ -21,7 +21,7 @@ require 'ctioga2/graphics/subplot-commands'
 
 module CTioga2
 
-  Version::register_svn_info('$Revision$', '$Date$')
+  Version::register_svn_info('$Revision: 155 $', '$Date: 2010-06-21 21:41:32 +0200 (Mon, 21 Jun 2010) $')
 
   # This module contains all graphical elements of CTioga2
   module Graphics

data/lib/ctioga2/graphics/styles.rb

@@ -14,6 +14,8 @@
 require 'ctioga2/graphics/styles/base'
 
 require 'ctioga2/graphics/styles/drawable'
+require 'ctioga2/graphics/styles/arrows'
+require 'ctioga2/graphics/styles/box'
 require 'ctioga2/graphics/styles/location'
 require 'ctioga2/graphics/styles/texts'
 require 'ctioga2/graphics/styles/carrays'
@@ -36,3 +38,6 @@ require 'ctioga2/graphics/styles/legend'
 
 
 require 'ctioga2/graphics/styles/factory'
+
+# Style sheets
+require 'ctioga2/graphics/styles/sheet'

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

@@ -0,0 +1,53 @@
+# arrows.rb: style objects for lines and arrows
+# copyright (c) 2012 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
+
+    # All the styles
+    module Styles
+
+      # This class represents an arrow
+
+      class ArrowStyle < StrokeStyle
+
+        # This probably should end up being a marker_style sub_style
+
+        for e in [:head, :tail]
+          typed_attribute "#{e}_marker".to_sym, 'marker'
+          typed_attribute "#{e}_scale".to_sym, 'float'
+          typed_attribute "#{e}_angle".to_sym, 'float'
+          typed_attribute "#{e}_color".to_sym, 'color'
+        end
+
+        def draw_arrow(t, x1, y1, x2, y2)
+          dict = self.to_hash
+          dict.rename_key('width', 'line_width')
+          dict.rename_key('style', 'line_style')
+          dict['head'] = [x2,y2]
+          dict['tail'] = [x1,y1]
+          t.show_arrow(dict)
+        end
+
+      end
+    end
+  end
+end
+

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

@@ -17,7 +17,7 @@ require 'ctioga2/log'
 # This module contains all the classes used by ctioga
 module CTioga2
 
-  Version::register_svn_info('$Revision$', '$Date$')
+  Version::register_svn_info('$Revision: 357 $', '$Date: 2012-12-26 00:49:11 +0100 (Wed, 26 Dec 2012) $')
 
   module Graphics
 
@@ -33,36 +33,44 @@ module CTioga2
         # AXIS_WITH_TICKS_ONLY,
         # AXIS_WITH_MAJOR_TICKS_AND_NUMERIC_LABELS, and
         # AXIS_WITH_TICKS_AND_NUMERIC_LABELS.
-        attr_accessor :decoration
+        typed_attribute :decoration, 'axis-decoration'
         
         # The position of the axis. Can be one of :left, :right, :top,
         # :bottom, :at_y_origin or :at_x_origin.
-        attr_accessor :location
+        typed_attribute :location, 'location'
 
         # Offset of the axis with respect to its normal position. It
         # is counted *away* from the graph. It is either a
         # Types::Dimension object or _nil_.
-        attr_accessor :offset
+        typed_attribute :offset, 'dimension'
 
         # The background lines for the given axis. _nil_ for nothing,
         # or a StrokeStyle object if we want to draw something.
-        attr_accessor :background_lines
+        #
+        # @todo Use a sub-style for that when that is implemented.
+        sub_style :background_lines, StrokeStyle
 
         # The style of the tick labels
-        attr_accessor :tick_label_style
+        sub_style :tick_label_style, FullTextStyle, "tick_label_%s"
 
         # The label of the axis, if there is one
-        attr_accessor :axis_label
+        sub_style :axis_label, TextLabel
 
         # Whether the axis should be log scale or not
-        attr_accessor :log
+        typed_attribute :log, 'boolean'
 
         # Transform: a Types::Bijection object specifying a coordinate
         # transformation for the axis.
-        attr_accessor :transform
+        typed_attribute :transform, 'bijection'
 
         # The color of the stroke for the lines of the axis
-        attr_accessor :stroke_color
+        typed_attribute :stroke_color, 'color'
+
+        typed_attribute :major_tick_length, 'float'
+        typed_attribute :major_tick_width, 'float'
+
+        typed_attribute :minor_tick_length, 'float'
+        typed_attribute :minor_tick_width, 'float'
 
 
         # Creates a new AxisStyle object at the given location with
@@ -89,8 +97,14 @@ module CTioga2
           spec = get_axis_specification(t)
           # Add tick label style:
           spec.merge!(@tick_label_style.to_hash)
-          if @stroke_color
-            spec['stroke_color'] = @stroke_color
+
+          # Direct copy of attributes 
+          for key in %w(stroke_color major_tick_length major_tick_width
+minor_tick_length minor_tick_width)
+            val = self.send(key.to_sym)
+            if val
+              spec[key] = val
+            end
           end
           t.show_axis(spec)
           @axis_label.loc = @location
@@ -258,17 +272,9 @@ module CTioga2
        
       end
 
-      PartialAxisStyle = {
-        'transform' => CmdArg.new('bijection'),
-        'location' => CmdArg.new('location'),
-        'log' => CmdArg.new('boolean'),
-        'stroke_color' => CmdArg.new('color')
-      }
-
-      FullAxisStyle = PartialAxisStyle.dup
-      FullAxisStyle['decoration'] = CmdArg.new('axis-decoration')
-                       
-
+      AxisStyleOptions = AxisStyle.options_hash()
+      PartialAxisStyle = AxisStyleOptions.without('decoration')
+      
     end
   end
 end

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

@@ -16,7 +16,7 @@ require 'ctioga2/log'
 
 module CTioga2
 
-  Version::register_svn_info('$Revision$', '$Date$')
+  Version::register_svn_info('$Revision: 342 $', '$Date: 2012-12-23 21:34:48 +0100 (Sun, 23 Dec 2012) $')
 
   module Graphics
 
@@ -28,16 +28,18 @@ module CTioga2
       # * pictures (in a distant future ?)
       class BackgroundStyle < BasicStyle
 
-        # The background color for a uniform fill. 
-        attr_accessor :background_color
+        # The background color for a uniform fill.
+        #
+        # @todo This should be turned into a full-scale fill style
+        typed_attribute :background_color, 'color-or-false'
 
         # The text of the watermark, or _nil_ if there should be no
         # watermark.
-        attr_accessor :watermark_text
+        typed_attribute :watermark, 'text'
 
         # A MarkerStringStyle object representing the style of the
         # watermark.
-        attr_accessor :watermark_style
+        sub_style :watermark_style, MarkerStringStyle, "watermark_%s" 
         
         # Creates a new AxisStyle object at the given location with
         # the given style.
@@ -62,7 +64,7 @@ module CTioga2
         end
 
         def draw_watermark(t)
-          if @watermark_text
+          if @watermark
             x = t.convert_frame_to_figure_x(0.5)
             y = t.convert_frame_to_figure_y(0.5)
             
@@ -70,7 +72,7 @@ module CTioga2
               real_vertical_scale
             
             # We split lines on \\, just like in standard LaTeX
-            lines = @watermark_text.split(/\s*\\\\\s*/)
+            lines = @watermark.split(/\s*\\\\\s*/)
             i = + (lines.size-1)/2.0
             for text in lines 
               @watermark_style.
@@ -106,16 +108,16 @@ EOH
       WatermarkCmd = 
         Cmd.new('watermark', nil, '--watermark', 
                 [ CmdArg.new('text') ], 
-                StringMarkerOptions) do |plotmaker, text, opts|
+                MarkerStringStyle.options_hash) do |plotmaker, text, opts|
         bg = PlotStyle.current_plot_style(plotmaker).
           background
-        bg.watermark_text = text
+        bg.watermark = text
         bg.watermark_style.set_from_hash(opts)
       end
 
       WatermarkCmd.describe("Sets a watermark for the current plot", 
                             <<"EOH", BackgroundGroup)
-Watermark...
+Sets a watermark for the background of the current plot.
 EOH
     end
   end

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

@@ -1,5 +1,5 @@
 # base.rb: the base of style objects
-# copyright (c) 2009 by Vincent Fourmond
+# copyright (c) 2009, 2012 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
@@ -16,7 +16,7 @@ require 'ctioga2/log'
 # This module contains all the classes used by ctioga
 module CTioga2
 
-  Version::register_svn_info('$Revision$', '$Date$')
+  Version::register_svn_info('$Revision: 370 $', '$Date: 2012-12-28 17:40:18 +0100 (Fri, 28 Dec 2012) $')
 
   module Graphics
 
@@ -26,9 +26,6 @@ module CTioga2
       # This style is the base class of a series of style objects that
       # share one common feature: all their attributes can be set
       # using the set_from_hash function.
-      #
-      # \todo maybe a basic MetaBuilder::Type should be associated to
-      # each attribute ??? 
       class BasicStyle
 
         OldAttrAccessor = method(:attr_accessor)
@@ -40,6 +37,10 @@ module CTioga2
           @attributes ||= []
           @attributes << symbol
           OldAttrAccessor.call(symbol)
+          # cl = caller()
+          # if not cl[0] =~ /typed_attribute/
+          #   puts "old-style attribute: #{cl[0]}"
+          # end
         end
 
         # Returns the list of attributes.
@@ -52,6 +53,73 @@ module CTioga2
             end
         end
 
+        # This function should be the main way now of declaring
+        # attributes, as it allows one to automatically generate an
+        # options hash for Command
+        #
+        # @todo There may be a reason to make some of the attributes
+        # private to some extent ?
+        #
+        # @todo Provide a function to make attributes "aliases" of
+        # others (but just on the hash side of the things), in order
+        # for instance to have halign and valign as aliases for the
+        # less intuitive alignment and justification.
+        def self.typed_attribute(symbol, type)
+          sym = symbol.to_sym
+          self.attr_accessor(sym)
+          type = CmdArg.new(type) unless type.respond_to? :string_to_type
+          @attribute_types ||= {}
+          @attribute_types[sym] = type
+        end
+
+        # Defines an accessor for an attribute which is a BasicStyle
+        # subclass in itself.
+        #
+        # _format_ is the thing fed to the subclass for the
+        # _from_hash_ function.
+        def self.sub_style(symbol, cls, fmt = nil)
+          @sub_styles ||= []    # A list of [symbol, cls, fmt]
+          
+          if ! fmt
+            fmt = "#{symbol.to_s}_%s"
+          end
+          
+          @sub_styles << [symbol, cls, fmt]
+          # Define the accessor
+          OldAttrAccessor.call(symbol)
+        end
+
+        # Returns a hash suitable for using as an options hash.
+        #
+        # _key_ provides tuning of the key names.
+        def self.options_hash(key = "%s")
+          ret = if superclass.respond_to?(:options_hash)
+                  superclass.options_hash(key)
+                else
+                  {}
+                end
+
+          if @attribute_types   # Not always present
+            for k, v in @attribute_types
+              ret[key % k] = v
+            end
+          end
+            
+          if @sub_styles        # Not always present too
+            for sub in @sub_styles
+              sym, cls, fmt = *sub
+              fmt = key % fmt
+              ret.merge!(cls.options_hash(fmt))
+            end
+          end
+
+          return ret
+        end
+
+        def self.sub_styles
+          return @sub_styles
+        end
+
         # Sets the values of the attributes from the given
         # _hash_. Keys are looked under the form of
         # 
@@ -61,13 +129,39 @@ module CTioga2
         #
         # Unspecified attributes are not removed from the
         # object. Extra keys are silently ignored.
+        #
+        # @todo Maybe there should be a way to detect extra attributes ?
+        #
+        # This function returns the number of properties that were
+        # effectively set (including those set in sub-styles)
         def set_from_hash(hash, name = "%s")
+          nb_set = 0
           for key_name in self.class.attributes
             hash_key = name % key_name
             if hash.key? hash_key 
               self.send("#{key_name}=", hash[hash_key])
+              nb_set += 1
+            end
+          end
+
+          if self.class.sub_styles
+            for sub in self.class.sub_styles
+              sym, cls, fmt = *sub
+              cur_var = self.send(sym)
+              if ! cur_var        # Create if not present
+                cur_var = cls.new
+                set_after = true
+              end
+              fmt = name % fmt
+              nb = cur_var.set_from_hash(hash, fmt)
+              if nb > 0 and set_after
+                self.send("#{sym}=", cur_var)
+              end
+              nb_set += nb
             end
           end
+          return nb_set
+            
         end
 
         # Creates a new object from a hash specification, just as in