ctioga2 0.0 → 0.1

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

@@ -17,7 +17,7 @@ require 'ctioga2/log'
 # This module contains all the classes used by ctioga
 module CTioga2
 
-  Version::register_svn_info('$Revision: 2 $', '$Date: 2009-04-25 14:03:30 +0200 (Sat, 25 Apr 2009) $')
+  Version::register_svn_info('$Revision: 161 $', '$Date: 2010-08-03 12:07:49 +0200 (Tue, 03 Aug 2010) $')
 
   module Graphics
 
@@ -35,6 +35,11 @@ module CTioga2
           [MediumSeaGreen, RoyalBlue, Pumpkin, DarkChocolate, Lilac, Crimson],
           "colorblind" => 
           [BrightBlue, Goldenrod, Coral, Lilac, FireBrick, RoyalPurple],
+          "gradient1" => 
+          [DarkMagenta, DarkGreen, OrangeRed, DarkRed, DarkBlue ],
+          "gradient2" => 
+          [LightPlum, PaleGreen, Gold, RedBrown, SkyBlue ],
+
         }
 
         MarkerSets = { 
@@ -48,6 +53,14 @@ module CTioga2
           'default' => [1.0]
         }
 
+        XAxisSets = {
+          'default' => ['x']
+        }
+
+        YAxisSets = {
+          'default' => ['y']
+        }
+
         LineStyleSets = {
           'default' => [ LineStyles::Solid,
                          LineStyles::Dots,

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

@@ -17,34 +17,12 @@ require 'ctioga2/log'
 # This module contains all the classes used by ctioga
 module CTioga2
 
-  Version::register_svn_info('$Revision: 94 $', '$Date: 2009-06-25 23:37:13 +0200 (Thu, 25 Jun 2009) $')
+  Version::register_svn_info('$Revision: 197 $', '$Date: 2010-11-29 14:26:12 +0100 (Mon, 29 Nov 2010) $')
 
   module Graphics
 
     module Styles
 
-      # Conversion between the #location attribute and the real
-      # constant used for Tioga
-      LocationToTiogaLocation = {
-        :left => Tioga::FigureConstants::LEFT,
-        :right => Tioga::FigureConstants::RIGHT,
-        :bottom => Tioga::FigureConstants::BOTTOM,
-        :top => Tioga::FigureConstants::TOP,
-        :at_x_origin => Tioga::FigureConstants::AT_X_ORIGIN,
-        :at_y_origin => Tioga::FigureConstants::AT_Y_ORIGIN
-      }
-
-      # Horizontal or vertical
-      LocationVertical = {
-        :left => true,
-        :right => true,
-        :bottom => false,
-        :top => false,
-        :at_x_origin => true,
-        :at_y_origin => false
-      }
-
-
       # The style of a text object. This class is suitable for
       # inclusion as a Hash to FigureMaker#show_axis, for the tick
       # labels.
@@ -85,8 +63,11 @@ module CTioga2
             dict['at'] = [x_or_loc, y]
           else
             # Perform automatic conversion on the location
-            if x_or_loc.is_a? Symbol
-              x_or_loc = LocationToTiogaLocation[x_or_loc]
+            case x_or_loc
+            when Symbol, Types::PlotLocation
+              ## @todo It won't be easy to implement shifts for this,
+              ## though it may be useful eventually.
+              x_or_loc = Types::PlotLocation.new(x_or_loc).tioga_location
             end
             dict['loc'] = x_or_loc
           end
@@ -127,6 +108,9 @@ module CTioga2
         attr_accessor :text
         
         # The location of the label.
+        #
+        # @todo This will have to eventually use PlotLocation, as it
+        # makes much more sense.
         attr_accessor :loc
 
         def initialize(text = nil)
@@ -146,16 +130,12 @@ module CTioga2
         # Gets the extension of the label, in units of text height.
         # Default values for the various parameters are taken from the
         # _default_ parameter if they are not specified.
-        def label_extension(t, default = nil, side = nil)
+        def label_extension(t, default = nil, location = nil)
           if @text
-            dict = prepare_label_dict(t, default, nil) 
-            case side
-            when :bottom, :right
-              extra = 0.5       # To account for baseline ?
-            when :top, :left
-              extra = 1
-            else                # We take the safe side !
-              extra = 1
+            dict = prepare_label_dict(t, default, nil)
+            extra = 0
+            if location
+              extra = location.label_extra_space(t)
             end
             return (dict['shift'] + extra) * dict['scale']
           else
@@ -270,6 +250,36 @@ module CTioga2
         'font' => CmdArg.new('pdf-font')
       }
 
+      # A LaTeX font. It should be applied to text using the function
+      # #fontify.
+      #
+      # \todo add real font attributes (family, and so on...)
+      class LaTeXFont
+        # The font command (bf, sf...). Naive but effective !
+        attr_accessor :font_command
+
+        def initialize
+          # Nothing to be done
+        end
+
+        def self.from_text(txt)
+          # For now, only the naive way of things:
+          font = self.new
+          font.font_command = txt
+          return font
+        end
+
+        # Returns text wrapping _txt_ with the appropriate functions
+        # to get the appropriate font in LaTeX.
+        def fontify(txt)
+          if @font_command
+            return "{\\#{@font_command} #{txt}}"
+          end
+          return txt
+        end
+        
+      end
+      
 
     end
   end

data/lib/ctioga2/graphics/subplot-commands.rb

@@ -16,7 +16,7 @@ require 'ctioga2/log'
 
 module CTioga2
 
-  Version::register_svn_info('$Revision: 97 $', '$Date: 2009-06-27 21:33:45 +0200 (Sat, 27 Jun 2009) $')
+  Version::register_svn_info('$Revision: 214 $', '$Date: 2010-12-31 02:50:03 +0100 (Fri, 31 Dec 2010) $')
 
   module Graphics
 
@@ -65,17 +65,17 @@ EOH
               [
                CmdArg.new('box'),
               ]) do |plotmaker, box|
+      Log::debug { "Starting a subplot with specs #{box.inspect}" }
       subplot = plotmaker.root_object.subplot
       subplot.subframe = box
     end
     
     InsetCommand.describe('Begins a new inset',
                           <<EOD, SubplotsGroup)
-Starts a new inset at the specified box. If no graphical commands have
-been issued before this one, it starts a top-level box in a blank 
-background. 
+Starts a new inset within the given box.
 
-TODO: this surely could be clarified a little tiny bit.
+If no graph has been started yet, it just creates a new graph using
+the given box. In short, it does what it seems it should.
 EOD
 
     NextInsetCommand =         
@@ -91,6 +91,9 @@ EOD
     NextInsetCommand.describe('Ends the previous inset and begins a new one',
                               <<EOD, SubplotsGroup)
 Has the same effet as {command: end} followed by {command: inset}.
+
+Particularly useful for chaining subgraphs. In that case, you might be 
+interested in the grid box specification and {command: setup-grid}.
 EOD
 
     EndCommand =         
@@ -102,8 +105,46 @@ EOD
     EndCommand.describe('Leaves the current subobject',
                         <<EOD, SubplotsGroup)
 Leaves the current subobject.
+EOD
+    RegionOptions = {
+      'color' => CmdArg.new('color'),
+      'transparency' => CmdArg.new('float'),
+      'reversed_color' => CmdArg.new('color'),
+      'reversed_transparency' => CmdArg.new('float'),
+    }
+
+    RegionCommand =         
+      Cmd.new("region",nil,"--region", 
+              [ ], RegionOptions) do |plotmaker, options|
+      r = plotmaker.root_object.enter_region
+      r.set_from_hash(options)
+    end
+    
+    RegionCommand.describe('Starts a region with filling between curves',
+                           <<EOD, SubplotsGroup)
+The curves up to the corresponding {command: end} will be considered for
+delimiting a colored region between them. The actual position of the
+curves with respect to the region can be fine-tuned using the 
+{command: region-side} command (or the corresponding option to {command: plot}).
 EOD
 
+    GradientCommand =         
+      Cmd.new("gradient",nil,"--gradient", 
+              [CmdArg.new('color'), CmdArg.new('color') ], {}) do |plotmaker, s, e, options|
+      r = plotmaker.root_object.enter_gradient
+      r.start_color = s
+      r.end_color = e
+      r.set_from_hash(options)
+    end
+    
+    GradientCommand.describe('Use a color gradient for all curves until --end',
+                             <<EOD, SubplotsGroup)
+All the curves between this command and the corresponding {command: end}
+will have their {command: color} set to a weighted average of the
+colors given as argument. This gives a neat gradient effect.
+EOD
+
+
     RescaleCommand =         
       Cmd.new("plot-scale",nil,"--plot-scale", 
               [CmdArg.new('float')], 
@@ -118,7 +159,7 @@ EOD
         Styles::PlotStyle.current_plot_style(plotmaker).text_scale = scale
         Styles::PlotStyle.current_plot_style(plotmaker).lines_scale = scale
       else
-        CTioga2::Log::error "Unkown 'what' option for plot-scale: #{what}"
+        CTioga2::Log::error { "Unkown 'what' option for plot-scale: #{what}" }
       end
     end
     
@@ -133,6 +174,53 @@ Scaling also applies to all elements of the plot that were added
 before the call to plot-scale.
 EOD
 
+    # Options for the SetupGrid command:
+    SetupGridOptions = {}
+    for n in %w(left right top bottom dx dy)
+      SetupGridOptions[n] = CmdArg.new('dimension')
+    end
+
+    SetupGridCommand = 
+      Cmd.new('setup-grid', nil, '--setup-grid', 
+              [ CmdArg.new('text') ], SetupGridOptions
+              ) do |plotmaker, nup, options|
+      grd = Types::GridLayout.new(nup)
+      for f in %w(left right top bottom)
+        if options.key? f
+          grd.outer_margins[f] = options[f]
+        end
+      end
+      grd.delta_x = options['dx'] if options['dx']
+      grd.delta_y = options['dy'] if options['dy']
+      Types::GridLayout.current_grid = grd
+    end
+    
+    SetupGridCommand.describe("Setup grid for insets", 
+                              <<"EOH", SubplotsGroup)
+Sets up a grid of the given layout (such as 2x1). After this command,
+arguments such as grid:0,1 can be used as the {type: box} argument of
+{command: inset} and {command: next-inset} commands.
+
+Alternatively, the layout can be specified as 1,2,1x1,4, in which case
+there are three columns and two rows; the second column is 2 times
+larger than the other ones, while the second row is four times larger
+than the first.
+EOH
+
+    ZoomCommand =         
+      Cmd.new("zoom-inset",nil,"--zoom-inset", 
+              [
+               CmdArg.new('box'),
+              ]) do |plotmaker, box|
+      subplot = plotmaker.root_object.subplot
+      subplot.subframe = box
+      raise YetUnimplemented.new("zooms are not yet implemented !")
+    end
+    
+    ZoomCommand.describe('Starts an inset ',
+                          <<EOD, SubplotsGroup)
+Zooms are currently not implemented yet.
+EOD
 
 
   end

data/lib/ctioga2/graphics/types.rb

@@ -16,12 +16,16 @@ require 'ctioga2/graphics/types/point'
 require 'ctioga2/graphics/types/boundaries'
 require 'ctioga2/graphics/types/boxes'
 require 'ctioga2/graphics/types/bijection'
+require 'ctioga2/graphics/types/location'
+
+
+require 'ctioga2/graphics/types/grid'
 
 # In addition to the former, here are some useful constants
 # This module contains all the classes used by ctioga
 module CTioga2
 
-  Version::register_svn_info('$Revision: 96 $', '$Date: 2009-06-27 20:56:17 +0200 (Sat, 27 Jun 2009) $')
+  Version::register_svn_info('$Revision: 249 $', '$Date: 2011-01-29 14:05:04 +0100 (Sat, 29 Jan 2011) $')
 
   module Graphics
 
@@ -47,11 +51,11 @@ module CTioga2
                               :namespace => Tioga::ColorConstants
                             }, <<EOD)
 A color. It can take three forms:
- * the name of a named color; see 
-http://tioga.rubyforge.org/doc/classes/Tioga/ColorConstants.html
-for the list of colors.
- * an HTML color: for instance, #f00 or #ff0000 is red;
- * a list of three numbers between 0 and 1: 1,0,0 is red too.
+ * a named color, see 
+{url: http://tioga.rubyforge.org/doc/classes/Tioga/ColorConstants.html}
+for the list of color names.
+ * an HTML color: for instance, @#f00@ or @#ff0000@ is red;
+ * a list of three numbers between 0 and 1: @1,0,0@ is red too.
 EOD
 
     ColorOrFalseType = 
@@ -63,12 +67,51 @@ EOD
 A {type: color}, or false to say that nothing should be drawn.
 EOD
 
+    CurveFillUntilType = CmdType.new('fill-until', {
+                                       :type => :float,
+                                       :shortcuts => {
+                                         /x?axis/i => 0.0,
+                                         /b(?:ot(?:tom)?)?/i => :bottom,
+                                         /t(?:op)?/i => :top,
+                                         /no(?:ne)?/i => false
+                                       }
+                                     }, <<EOD)
+The Y values until which a filled curve will be filled. Generally a number, 
+but it can also be:
+ * @axis@ (or @xaxis@), which means 0
+ * @bottom@, to fill until the bottom of the graph
+ * @top@, to fill until the top 
+ * @none@, meaning no fill
+EOD
+
+    RegionSideType = 
+      CmdType.new('region-side', {
+                    :type => :list,
+                    :list => {},
+                    :shortcuts => {
+                      'above' => :above,
+                      'below' => :below,
+                      'ignore' => false,
+                    }
+                  }, <<EOD)
+Within a {command: region}, designates the position of the curve with
+respect to the region:
+ * @above@
+ * @below@
+ * @ignore@ if this curve is not to be taken into account
+EOD
+
+                    
+                    
     LineStyleType = 
       CmdType.new('line-style', {
                     :type => :tioga_line_style,
-                    :namespace => LineStyles
+                    :namespace => LineStyles,
+                    :shortcuts => {
+                      /no(ne)?|off/i => false,
+                    }
                   }, <<EOD)
-A line style.
+A line style, or @no@, @none@ or @off@ to mean no line.
 EOD
 
     MarkerType = 
@@ -89,20 +132,53 @@ EOD
 A given point on a figure.
 EOD
 
+# We need a very specific type for that as we want to have a reference
+# to the level too !
+    LevelType = 
+      CmdType.new('level', :level, <<EOD)
+A level on a XYZ map (that is, just a Z value).
+EOD
+
+   JustificationRE = {
+      /l(eft)?/i => Tioga::FigureConstants::LEFT_JUSTIFIED,
+      /c(enter)?/i => Tioga::FigureConstants::CENTERED,
+      /r(ight)?/i => Tioga::FigureConstants::RIGHT_JUSTIFIED
+    }
+
     JustificationType = 
-      CmdType.new('justification', :tioga_justification, <<EOD)
-Horizontal aligment for text.
+      CmdType.new('justification', {:type => :re_list,
+                    :list => JustificationRE}, <<EOD)
+Horizontal aligment for text. Can be one of:
+ * @l@ or @left@
+ * @c@, @center@
+ * @r@, @right@
 EOD
 
+   # Regular expression for vertical alignment
+   AlignmentRE = {
+      /t(op)?/i => Tioga::FigureConstants::ALIGNED_AT_TOP,
+      /c(enter)|m(idheight)/i => Tioga::FigureConstants::ALIGNED_AT_MIDHEIGHT,
+      /B|Baseline|baseline/ => Tioga::FigureConstants::ALIGNED_AT_BASELINE,
+      /b(ottom)?/ => Tioga::FigureConstants::ALIGNED_AT_BOTTOM
+    }
+
     AlignmentType = 
-      CmdType.new('alignment', :tioga_align, <<EOD)
-Vertical aligment for text.
+        CmdType.new('alignment', {:type => :re_list,
+                      :list => AlignmentRE}, 
+                    <<EOD)
+Vertical aligment for text. Can be one of:
+ * @t@ or @top@
+ * @c@, @center@, @m@ or @midheight@ (vertically centered)
+ * @B@, @Baseline@ or @baseline@ to align at the baseline
+ * @b@ or @bottom@
 EOD
 
     PDFFont = 
       CmdType.new('pdf-font', :integer, <<EOD)
 A number between 1 and 14 that designates one of the 14 standard 
-PDF fonts.
+PDF fonts. (see for instance
+{url: http://tioga.rubyforge.org/doc/classes/Tioga/MarkerConstants.html}
+for more information).
 EOD
 
     AlignedPointType = 
@@ -118,14 +194,13 @@ EOD
 Margins around a plot, ie the distance from the side of the plot to
 the corresponding side of the container (most likely the whole
 PDF). It can take three forms:
+ * @dimension@ (applies to all sides)
+ * @left_right, top_bottom@
+ * @left, right, top, bottom@
 
- * dimension (applies to all sides)
- * left_right, top_bottom
- * left, right, top, bottom
+Each of these elements is a valid {type: dimension}.
 
-Each of the elements is a valid {type: dimension}.
-
-It can also be auto, in which case the position of the margins is
+It can also be @auto@, in which case the position of the margins is
 computed automatically to accomodate the various labels/ticks.
 EOD
 
@@ -134,7 +209,13 @@ EOD
     AxisDecorationType = 
       CmdType.new('axis-decoration', :tioga_axis_type, <<EOD)
 Kinds of decoration on a axis line, such as nothing, lines, ticks, 
-tick labels...
+tick labels. Possible values:
+ * @hidden@ or @off@: no axis at all
+ * @line@: only a line
+ * @ticks@: only ticks
+ * @major@: only major ticks
+ * @major-num@: major ticks along with their labels
+ * @full@: major ticks and labels + minor ticks
 EOD
 
     # Dimensions
@@ -145,16 +226,13 @@ EOD
 
 A dimension, in absolute units, or in units of text height, figure,
 frame or page coordinates. It is in the form 
-
-@ value unit
-
-Where value is a number and unit can be one of pt,bp,in,cm (absolute
-units, same meaning as in TeX), dy (1.0 dy is the height of a text
-line), figure (for figure coordinates, i.e. the coordinates of the
-plot), frame (1.0 frame is the full size of the current subplot) and
-page (1.0 page is the whole height/width of the output file).
-
-figure can be abbreviated as f, frame as F and page as p.
+@value unit@
+where @value@ is a number and unit can be one of @pt@,
+@bp@, @in@, @cm@ (absolute units, same meaning as in TeX), 
+@dy@ (@1.0 dy@ is the height of a text
+line), @figure@ or @f@ (for figure coordinates, i.e. the coordinates of the
+plot), @frame@ or @F@ (@1.0 frame@ is the full size of the current subplot) and
+@page@ or @p@ (@1.0 page@ is the whole height/width of the output file).
 EOD
 
     # Boxes
@@ -164,20 +242,20 @@ EOD
 The specification for a box, such as an inset. Specifications vary for
 now... 
 
-TODO: to be written later on.
+@todo to be written later on.
 EOD
 
     # Coordinate transformations
     BijectionType = 
       CmdType.new('bijection', :bijection, <<EOD)
 A pair of functions of x specifying a bidirectional coordinate
-transformation , separated by a double colon (::), in the order
-from::to.
+transformation separated by a double colon (@::@), in the order
+@from::to@.
 
 Each of the functions must be valid Ruby code - it is not exactly
 mathematical functions, in particular Ruby does not like floats which
-are missing digits on either side of the dot : for instance, .3 and
-1. are not valid. Sorry.
+are missing digits on either side of the dot : for instance, @.3@ and
+@1.@ are not valid. Sorry.
 
 In most of the usual cases, the coordinate transform is an involution,
 that is from and to is the same function (this is the case for