ctioga2 0.3 → 0.4

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$', '$Date$')
+  Version::register_svn_info('$Revision: 161 $', '$Date: 2010-08-03 12:07:49 +0200 (Tue, 03 Aug 2010) $')
 
   module Graphics
 

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

@@ -0,0 +1,348 @@
+# sheet.rb: handling of style sheets
+# 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'
+
+require 'ctioga2/graphics/coordinates'
+
+# This module contains all the classes used by ctioga
+module CTioga2
+
+  Version::register_svn_info('$Revision$', '$Date$')
+
+  module Graphics
+
+    module Styles
+   
+      # This is a style sheet, is a storage place for style
+      # objects. It has two related functions:
+      # * first, store the user-specified preferences
+      # * second, provide the appropriate default style for any given
+      #   object, most probably at construction time (although that
+      #   may get hard some times)
+      #
+      # The style are cascading and scoped. A scope should begin in
+      # each plot.
+      #
+      # Cascades happen in two ways:
+      # 
+      # * more specific styles inherit from less specific (axis ->
+      #   yaxis -> left)
+      # * children style inherit from parent style
+      class StyleSheet
+
+        # The parent of the style sheet, or nil if this is the top one.
+        attr_accessor :parent
+
+        # The styles, in form of a style class -> style name -> style
+        # object nested hash
+        #
+        # The style object is actually a hash ready to be fed to the
+        # BasicStyle#set_from_hash
+        attr_accessor :own_styles
+
+        def initialize(par = nil)
+          @parent = par
+          @own_styles = {}
+        end
+
+        # This hash contains the parent style for each of the style
+        # listed in
+        #
+        # Keyed by class -> style name -> parent name
+        @style_parent = {}
+
+        # Sets the parent for the given style
+        def self.set_parent(cls, style, parent)
+          @style_parent[cls] ||= {}
+          @style_parent[cls][style] = parent
+        end
+        
+        # Returns the parent style for the style (or _nil_ should the
+        # style have no parent)
+        #
+        # All styles (but base) derive from the corresponding "base"
+        # style.
+        def self.get_parent(cls, style)
+          @style_parent[cls] ||= {}
+          stl = @style_parent[cls][style]
+          if (! stl) and (! (style == 'base'))
+            return 'base'
+          end
+          return stl
+        end
+
+        set_parent AxisStyle, "x",  "base"
+        set_parent AxisStyle, "y",  "base"
+
+        set_parent AxisStyle, "bottom", "x"
+        set_parent AxisStyle, "top",    "x"
+        set_parent AxisStyle, "left",   "y"
+        set_parent AxisStyle, "right",  "y"
+
+
+        # This returns the style we have in this object for the given
+        # name. Inner cascading should take place (ie object
+        # hierarchy, but not scope hierarchy).
+        #
+        # This returns a hash that can be modified.
+        def own_style_hash_for(cls, name)
+          p = self.class.get_parent(cls, name)
+          base = {}
+          if p
+            base = own_style_hash_for(cls, p)
+          end
+          @own_styles[cls] ||= {}
+          style = @own_styles[cls][name]
+          if ! style
+            return base
+          end
+          style = style.dup
+          style.merge!(base) { |key, v1, v2| v1 }
+          return style
+        end
+
+        # The style for the given name, including all cascading
+        def get_style_hash_for(cls, name)
+          ps = {}
+          if @parent
+            ps = @parent.get_style_hash_for(cls, name);
+          end
+          style = own_style_hash_for(cls, name)
+          style.merge!(ps) { |key, v1, v2| v1 }
+          return style
+        end
+
+
+
+        # The current sheet
+        @sheet = StyleSheet.new
+        
+        # Returns a suitable style object for the given style name, or
+        # crashes if the name isn't known.
+        #
+        # Additional arguments are passed to the constructor
+        def self.style_for(cls, name, *args)
+          a = cls.new(*args)
+          a.set_from_hash(@sheet.get_style_hash_for(cls, name))
+          return a
+        end
+
+        def self.enter_scope()
+          @sheet = StyleSheet.new(@sheet)
+        end
+
+        def self.leave_scope()
+          if @sheet.parent
+            @sheet = @sheet.parent
+          else
+            warn { "Trying to leave top-level stylesheet scope" }
+          end
+        end
+
+        def self.current_sheet()
+          return @sheet
+        end
+        
+      end
+
+      StyleSheetGroup = CmdGroup.new('style-sheets',
+                                     "Default styles", 
+                                     <<EOD, 40)
+Commands for defining default styles.
+
+All commands take the name of the style to redefine. Different styles
+live in a different name space, so there is no risk naming an @axis@ and
+a @text@ style with the same name. All styles for a given type inherit from 
+the style name @base@.
+
+ctioga2 does not support changing a style after its use. It may
+affect only the following objects or all the ones that were created
+from the beginning, depending on the context. For safety, only define
+style before issueing any graphics command.
+
+ctioga2 may support at a later time loading style files, but that is
+not the case for now.
+
+EOD
+      # We create the commands programmatically
+      kinds = [
+               ['axis', AxisStyle, 'axis'],
+               ['background', BackgroundStyle, 'plot background'],
+               ['title', TextLabel, 'plot title'],
+               ['text', FullTextStyle, 'text'],
+               ['marker', MarkerStringStyle, 'marker'],
+               ['box', BoxStyle, 'boxes'],
+               ['arrow', ArrowStyle, 'arrows'],
+               ['line', StrokeStyle, 'lines']
+              ]
+
+      StyleSheetCommands = {}
+      StyleSheetPredefinedNames = {}
+
+      kinds.each do |k|
+        name, cls, desc = *k
+
+        StyleSheetCommands[name] = 
+          Cmd.new("define-#{name}-style",nil,
+                  "--define-#{name}-style", 
+                  [
+                   CmdArg.new('text'),
+                  ], 
+                  cls.options_hash
+                  ) do |plotmaker, what, opts|
+          StyleSheet.current_sheet.own_styles[cls] ||= {}
+          StyleSheet.current_sheet.own_styles[cls][what] ||= {}
+          StyleSheet.current_sheet.own_styles[cls][what].merge!(opts)
+        end
+        StyleSheetCommands[name].
+          describe("Sets the default style for the given #{desc}.", 
+                   <<"EOH", StyleSheetGroup)
+Sets the default style for the named #{desc}.
+EOH
+      end
+      
+      StyleSheetCommands['line'].long_description = <<EOD
+Sets the default style for lines. All line styles descend from the
+@base@ style. Use a style different than @base@ by passing its name as
+the @/base-style@ option to the {command: draw-line} command.
+
+Meaning of the style parameters:
+
+ * @color@: the color of the line, see {type: color}
+ * @style@: the line style, see {type: line-style}
+ * @width@: the line width (in points)
+
+> --define-line-style base /color=Pink
+
+makes all lines  pink (unless overriden by the /color option to
+{command: draw-line}), while
+
+> --define-line-style line-pink /color=Pink
+
+only affect those to which the /base-style=line-pink style option
+was given.
+EOD
+
+      StyleSheetCommands['arrow'].long_description = <<EOD
+Sets the default style for arrows. All arrow styles descend from the
+@base@ style. Use a style different than @base@ by passing its name as
+the @/base-style@ option to the {command: draw-arrow} command.
+
+Meaning of the style parameters:
+
+ * @color@, @style@ and @width@: same as in {command: define-line-style}
+ * @head_marker@, @tail_marker@: a {type: marker} to be used for the head 
+   or for the tail
+ * @head_scale@, @tail_scale@: scale of the head or tail markers
+ * @head_angle@, @tail_angle@: rotate the head or the tail by that many
+   degrees
+ * @head_color@, @tail_color@: the {type: color} of the head or tail
+EOD
+
+      StyleSheetCommands['box'].long_description = <<EOD
+Sets the default style for boxes. All box styles descend from the
+@base@ style. Use a style different than @base@ by passing its name as
+the @/base-style@ option to the {command: draw-box} command.
+
+Meaning of the style parameters:
+
+ * @color@, @style@ and @width@: same as in {command: define-line-style}
+ * @fill_color@: fill color for the box
+ * @fill_transparency@: the transparency for the fill, from 0 to 1
+EOD
+
+      StyleSheetCommands['text'].long_description = <<EOD
+Sets the default style for texts. All text styles descend from the
+@base@ style. Use a style different than @base@ by passing its name as
+the @/base-style@ option to the {command: draw-text} command.
+
+Meaning of the style parameters:
+
+ * @alignment@: vertical alignment
+ * @justification@: horizontal alignment
+ * @angle@: angle in degrees to the horizontal (or default orientation in
+   some cases)
+ * @color@: text color
+ * @scale@: text scale
+EOD
+
+      StyleSheetCommands['title'].long_description = <<EOD
+Sets the style for title. All title styles descend from the
+@base@ style. In addition, the title of a plot is addressed by the 
+style name @title@.
+
+Meaning of the style parameters:
+
+ * @alignment@, @justification@, @angle@, @color@ and @scale@: 
+   as in {command: define-text-style}
+ * @text@: sets the title text
+ * @loc@: the side on which to display the title, a {type: location}
+ * @shift@: the distance away from the plot in text size units 
+   (maybe a dimension should be better later)
+ * @position@: shift from the center (parallel to the plot side)
+EOD
+
+      StyleSheetCommands['marker'].long_description = <<EOD
+Sets the style for marker and marker strings.  All marker and marker
+string styles descend from the @base@ style. Use a style different
+than @base@ by passing its name as the @/base-style@ option to the
+{command: draw-marker} or {command: draw-string-marker} commands.
+
+Meaning of the style parameters:
+
+ * @alignment@, @justification@, @angle@, @color@ and @scale@: 
+   as in {command: define-text-style}
+ * @fill_color@ and @stroke_color@: markers are both stroked and filled,
+   you can control all colors in one go using @color@ or specifying each
+   with @fill_color@ and @stroke_color@
+ * @font@: is a PDF font number (from 1 to 14), only used for marker
+   strings
+ * @horizontal_scale@, @vertical_scale@: scales the marker only
+   horizontally or vertically
+EOD
+
+      StyleSheetCommands['background'].long_description = <<EOD
+Sets the style for plot background. All background styles descend from the
+@base@ style. In addition, the background of a plot is change by the 
+style name @background@.
+
+Meaning of the style parameters:
+
+ * @watermark@: the text of the watermark
+ * all @watermark_@ styles have the same meaning as in 
+   {command: define-text-style}, as the watermark is a string marker
+ * @background_color@: the color of the background
+EOD
+
+      StyleSheetCommands['axis'].long_description = <<EOD
+Sets the style for a whole axis. All axis styles descend from the
+@base@ style. Horizontal and vertical axis styles descend from the 
+@x@ and @y@ styles, and plot sides are styled with the @left@, @right@, 
+@top@ and @bottom@ styles.
+
+Axis styles have lots of parameters:
+
+ * @axis_label_@ and @tick_label_@ parameters are title style parameters
+   whose meaning is given in {command: define-title-style}, that affect
+   ticks and axis labels
+ * @decoration@: a {type: axis-decoration} that specify which ticks and 
+   tick labels to draw
+ * @background_lines_@ parameters define the style of background lines, 
+   as in {command: define-line-style}
+EOD
+      
+    end
+  end
+end

data/lib/ctioga2/graphics/styles/texts.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: 370 $', '$Date: 2012-12-28 17:40:18 +0100 (Fri, 28 Dec 2012) $')
 
   module Graphics
 
@@ -26,31 +26,36 @@ module CTioga2
       # The style of a text object. This class is suitable for
       # inclusion as a Hash to FigureMaker#show_axis, for the tick
       # labels.
+      #
+      # @todo alignement and justification are poor names. halign
+      # and/or valign would be better.
       class BaseTextStyle < BasicStyle
         
         # The angle of the text
-        attr_accessor :angle
+        typed_attribute :angle, 'float'
 
         # The 'shift' of the text. Only meaningful for axes and tick
         # labels, where the position of the text is specified using a
-        # side rather than a precise position
-        attr_accessor :shift
+        # side rather than a precise position. In frame coordinates ?
+        typed_attribute :shift, 'float'
 
         # The scale of the text
-        attr_accessor :scale
+        typed_attribute :scale, 'float'
 
         # The vertical alignment 
-        attr_accessor :alignement
+        typed_attribute :alignment, 'alignment'
 
         # The horizontal alignment
-        attr_accessor :justification
+        typed_attribute :justification, 'justification'
 
         # Draw the _text_ at the given location with the given style.
         # If _y_ is _nil_, then _x_or_loc_ is taken to be a location
         # (see FigureMaker#show_text).
         def draw_text(t, text, x_or_loc, y = nil, measure = nil)
-          dict = prepare_show_text_dict(text, x_or_loc, y, measure)
-          t.show_text(dict)
+          t.context do
+            dict = prepare_show_text_dict(text, x_or_loc, y, measure)
+            t.show_text(dict)
+          end
         end
 
         protected
@@ -83,38 +88,35 @@ module CTioga2
       # The style of a full text object.
       class FullTextStyle < BaseTextStyle
         # The color of the text
-        attr_accessor :color
+        typed_attribute :color, 'color'
 
         # The (horizontal) position with respect to a location. You'll
         # seldom need that.
-        attr_accessor :position
+        #
+        # @todo Maybe this needs to fo in TextLabel rather than here ?
+        typed_attribute :position, 'float'
       end
 
       # A hash that can be used as a base for optional arguments to
       # things that take texts.
-      FullTextStyleOptions = {
-        'angle' => CmdArg.new('float'),
-        'shift' => CmdArg.new('float'),
-        'scale' => CmdArg.new('float'),
-        'justification' => CmdArg.new('justification'),
-        'color' => CmdArg.new('color'),
-        'align' => CmdArg.new('alignment'),
-      }
+      FullTextStyleOptions = FullTextStyle.options_hash()
 
       # A label.
       class TextLabel < FullTextStyle
         # The text of the label. _nil_ or _false_ means there will be
         # no text displayed
-        attr_accessor :text
+        typed_attribute :text, "text"
         
         # The location of the label.
         #
         # @todo This will have to eventually use PlotLocation, as it
         # makes much more sense.
-        attr_accessor :loc
+        typed_attribute :loc, "location"
 
-        def initialize(text = nil)
+        def initialize(text = nil, loc = nil)
+          super()
           @text = text
+          @loc = loc
         end
         
         # Draw the label, if #text is not _nil_ or _false_.
@@ -159,10 +161,8 @@ module CTioga2
 
       end
 
-      # Same thing as FullTextStyleOptions, but also permits to
-      # override the #text part of the whole stuff..
-      FullTextLabelOptions = FullTextStyleOptions.dup
-      FullTextLabelOptions['text'] = CmdArg.new('text')
+
+      FullTextLabelOptions = TextLabel.options_hash()
 
 
 
@@ -171,44 +171,32 @@ module CTioga2
       # like that.
       class MarkerStringStyle < BasicStyle
         
-        MarkerOptions = {
-          'color' => 'color',
-          'stroke_color' => 'color',
-          'fill_color' => 'color',
-          'scale' => 'float',
-          'horizontal_scale' => 'float',
-          'vertical_scale' => 'float',
-          'angle' => 'float',
-          'justification' => 'justification',
-          'alignment' => 'alignment',
-        }
-
-
         # The angle of the text
-        attr_accessor :angle
+        typed_attribute :angle, 'float'
 
         # The scale of the text
-        attr_accessor :scale
+        typed_attribute :scale, "float"
 
         # The horizontal scale of the text
-        attr_accessor :horizontal_scale
+        typed_attribute :horizontal_scale, "float"
 
         # The vertical scale of the text
-        attr_accessor :vertical_scale
+        typed_attribute :vertical_scale, "float"
 
         # The vertical alignment 
-        attr_accessor :alignement
+        typed_attribute :alignment, "alignment"
 
         # The horizontal alignment
-        attr_accessor :justification
+        typed_attribute :justification, "justification"
 
         # Colors
-        attr_accessor :color
-        attr_accessor :stroke_color
-        attr_accessor :fill_color
+        typed_attribute :color, 'color-or-false'
+        typed_attribute :stroke_color, 'color-or-false'
+        typed_attribute :fill_color, 'color-or-false'
+
 
         # A number between 1 to 14 -- a PDF font
-        attr_accessor :font
+        typed_attribute :font, "pdf-font"
 
         # The rendering mode.
         attr_accessor :mode
@@ -226,8 +214,14 @@ module CTioga2
           dict = self.to_hash
           dict['text'] = text
           dict['at'] = [x, y]
-          # TODO !
-          dict['mode'] = 
+          t.show_marker(dict)
+        end
+
+        # Draws the string marker at the given location
+        def draw_marker(t, marker, x, y)
+          dict = self.to_hash
+          dict['marker'] = marker
+          dict['at'] = [x, y]
           t.show_marker(dict)
         end
 
@@ -237,19 +231,6 @@ module CTioga2
         end
       end
       
-      StringMarkerOptions = {
-        'color' => CmdArg.new('color'),
-        'stroke_color' => CmdArg.new('color'),
-        'fill_color' => CmdArg.new('color'),
-        'scale' => CmdArg.new('float'),
-        'horizontal_scale' => CmdArg.new('float'),
-        'vertical_scale' => CmdArg.new('float'),
-        'angle' => CmdArg.new('float'),
-        'justification' => CmdArg.new('justification'),
-        'alignment' => CmdArg.new('alignment'),
-        'font' => CmdArg.new('pdf-font')
-      }
-
       # A LaTeX font. It should be applied to text using the function
       # #fontify.
       #