ctioga2 0.10.1 → 0.11

data/lib/ctioga2/graphics/elements.rb

@@ -13,7 +13,9 @@
 
 
 require 'ctioga2/graphics/types'
+require 'ctioga2/graphics/styles'
 require 'ctioga2/graphics/elements/element'
+require 'ctioga2/graphics/elements/plot-elements'
 require 'ctioga2/graphics/elements/containers'
 require 'ctioga2/graphics/elements/redirecting-container'
 require 'ctioga2/graphics/elements/subplot'

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

@@ -60,9 +60,11 @@ module CTioga2
         # children or not ?)
 
         # Creates an empty new Container with the given _parent_.
-        def initialize(parent = nil, root = nil)
+        def initialize(parent, root, options)
           super()
           @parent = parent
+
+          setup_style(parent, options)
           
           # elements to be given to tioga
           @elements = []

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

@@ -1,5 +1,5 @@
 # element.rb: base class of all drawable elements
-# copyright (c) 2006, 2007, 2008, 2009 by Vincent Fourmond: 
+# copyright (c) 2006, 2007, 2008, 2009, 2014 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
@@ -23,9 +23,25 @@ module CTioga2
 
     # All elements that can be drawn onto a FigureMaker object
     module Elements
-      
+
       # The base class for every single object that is drawn on
-      # Tioga's output.
+      # Tioga's output. Each object can have a style attached to it,
+      # and obtained from the StyleSheet class.
+      #
+      # For styling-related purposes, all subclasses of this class
+      # have the following characteristics:
+      #  * a style name (a "type selector")
+      #  * a style class (the corresponding underlying class)
+      #
+      # All instances of this classes have several properties:
+      #  * a (unique) id
+      #  * a list of classes (specified as comma-separated stuff)
+      #
+      # Ideas for how the style should be used:
+      #  - first create the object
+      #  - then, soon afterwards, use #setup_style to give it a
+      #    workable position in the style list
+      #  - then, use get_style to get the style ;-)...
       class TiogaElement
         include Log
 
@@ -43,7 +59,105 @@ module CTioga2
         # Depth
         attr_writer :depth
 
-        def initialize()
+        # Style-related attributes:
+        
+        # The id
+        attr_reader :object_id
+
+        # The classes (order matter)
+        attr_accessor :object_classes
+
+        # The parent (in the style point of view, which may be
+        # different from the rest)
+        attr_accessor :object_parent
+
+        # Wether or not the object is hidden
+        attr_accessor :hidden
+
+        StyleBaseOptions = {
+          'id' => CmdArg.new('text'),
+          'class' => CmdArg.new('text-list')
+        }
+
+        def self.define_style(name, cls = nil)
+          @style_name = name
+          @style_class = cls
+          register_style(name, cls)
+        end
+
+        @@style_classes = {}
+        @@all_styles = {}
+
+        def self.styled_classes
+          return @@all_styles
+        end
+
+        def self.register_style(name, cls)
+          @@all_styles[name] = self
+          if @@style_classes.key? name
+            if @@style_classes[name] != cls
+              raise "Trying to register different classes under the same name"
+            end
+          else
+            @@style_classes[name] = cls
+          end
+        end
+
+        def self.base_style
+          if @style_name
+            return self
+          elsif self == TiogaElement
+            return nil
+          else
+            return self.superclass.base_style
+          end
+        end
+
+        def self.style_class
+          if @style_name
+            return @style_class
+          else
+            bs = base_style
+            return (bs ? bs.style_class : nil)
+          end
+        end
+
+        def self.style_name
+          if @style_name
+            return @style_name
+          else
+            bs = base_style
+            return (bs ? bs.style_name : nil)
+          end
+        end
+
+        def style_class
+          return self.class.style_class
+        end
+
+        def style_name
+          return self.class.style_name
+        end
+
+        def has_style?
+          if style_class
+            return true
+          else
+            return false
+          end
+        end
+
+        def self.all_styles
+          return @style_classes
+        end
+
+
+
+        def self.inherited(cls)
+          # p cls
+        end
+
+        def initialize
           @clipped = true
 
           @depth = 50           # Hey, like xfig
@@ -51,6 +165,57 @@ module CTioga2
           @gp_cache = {}
         end
 
+        def self.register_object(obj)
+          @registered_objects ||= {}
+          if i = obj.object_id
+            if @registered_objects.key? i
+              warn { "Second object with ID #{i}, ignoring the name" }
+            else
+              @registered_objects[i] = obj
+            end
+          end
+        end
+
+        def self.find_object(obj_id)
+          @registered_objects ||= {}
+          if @registered_objects.key? obj_id
+            return @registered_objects[obj_id]
+          else
+            raise "No such object: '#{obj_id}'"
+          end
+        end
+              
+        
+        def setup_style(obj_parent, opts) 
+          @cached_options = opts
+          @object_id = opts["id"] || nil
+          @object_classes = opts["class"] || []
+          @object_parent = obj_parent
+
+          TiogaElement.register_object(self)
+          @style_is_setup = true
+        end
+
+
+        def get_style()
+          check_styled()
+          return Styles::StyleSheet.style_for(self)
+        end
+
+        def update_style(style)
+          check_styled()
+          stl = Styles::StyleSheet.style_hash_for(self)
+          style.set_from_hash(stl)
+        end
+
+        def check_styled()
+          if ! self.style_class
+            raise "Object has no attached style class !"
+          elsif ! @style_is_setup
+            raise "Should have setup style before !"
+          end
+        end
+
         def depth
           @depth || 50
         end
@@ -66,7 +231,12 @@ module CTioga2
         # #real_do, which should be redefined by the children. You can
         # redefine _do_ too if you need another debugging output.
         def do(f)
-          debug { "plotting #{self.inspect}" }
+          if @hidden
+            debug { "not plotting hidden #{self.inspect}" }
+            return 
+          else
+            debug { "plotting #{self.inspect}" }
+          end
           @gp_cache = {}
           real_do(f)
         end
@@ -107,6 +277,8 @@ module CTioga2
         # drawn.
         attr_accessor :curve_style
 
+        define_style 'curve', Styles::CurveStyle
+
         undef :location=, :location
 
         # Returns the LocationStyle object of the curve. Returns the
@@ -132,6 +304,23 @@ module CTioga2
         end
       end
 
+      ObjectType = 
+        CmdType.new('object', {:type => :function_based,
+                      :class => Elements::TiogaElement,
+                      :func_name => :find_object}, <<EOD)
+A named object (whose name was given using the /id= option to the
+appropriate command).
+EOD
+
+      ObjectsType = 
+        CmdType.new('objects', {:type => :array,
+                      :subtype => {:type => :function_based,
+                        :class => Elements::TiogaElement,
+                        :func_name => :find_object}
+                      }, <<EOD)
+A list of comma-separated {type: object}s.
+EOD
+
     end
   end
 end

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

@@ -1,4 +1,4 @@
-# region.rb: draw curves-delimited fills
+# gradient-region.rb: draw neat color gradient
 # copyright (c) 2010 by Vincent Fourmond
   
 # This program is free software; you can redistribute it and/or modify
@@ -34,6 +34,8 @@ module CTioga2
         undef :elements
         undef :subframe
 
+        define_style "gradient"
+
         # The curves which delimit the region
         attr_accessor :curves
 
@@ -41,8 +43,9 @@ module CTioga2
         attr_accessor :start_color, :end_color
 
         # Creates a new empty region
-        def initialize(parent = nil, root = nil)
+        def initialize(parent, root, options)
           @parent = parent
+          setup_style(parent, options)
           
           # The curves whose color we should change
           @curves = []

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

@@ -228,7 +228,12 @@ module CTioga2
             # values (which means in particular that they won't be
             # positioned at the exact X value, but that's already the
             # case anyway).
-            width = (x_values.max - x_values.min)/(x_values.size - 1)
+            width = (x_values.max - x_values.min)/(x_values.size - 1).to_f
+            if width.nan? || width == 0.0
+              # Only 1 X value, we use a width of 1
+              # ?? 
+              width = 0.8
+            end
 
             # Available width
             aw = width - intra_sep - inter_sep
@@ -250,7 +255,7 @@ module CTioga2
               offset += iw
               next unless col
               if col.first.histogram_style.intra_sep
-                offset += h.histogram_style.intra_sep.to_figure(t, :x)
+                offset += col.first.histogram_style.intra_sep.to_figure(t, :x)
               end
               for h in col
                 cache[h] = c

data/lib/ctioga2/graphics/elements/plot-elements.rb

@@ -0,0 +1,88 @@
+# -*- coding: utf-8 -*-
+# plot-element.rb: collection of small wrappers used for plots
+# copyright (c) 2014 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
+
+  # This module contains all graphical elements of CTioga2
+  module Graphics
+
+    module Elements
+      
+      # This simple wrapper makes it possible to style axes (at least
+      # using parents styling)
+      class AxisElement < TiogaElement
+        
+        define_style 'axis', Styles::AxisStyle
+
+        attr_accessor :style
+
+        def initialize_style(loc, dec, label)
+          @style = Styles::AxisStyle::new(loc, dec, label)
+          update_style(@style)
+        end
+      end
+
+      # This simple wrapper makes it possible to style axes (at least
+      # using parents styling)
+      class MapAxisElement < TiogaElement
+        
+        define_style 'zaxis', Styles::MapAxisStyle
+
+        attr_accessor :style
+
+        def initialize(parent, opts)
+          setup_style(parent, opts)
+          @style = get_style()
+        end
+      end
+
+      # Wrapper for the title
+      class TitleElement < TiogaElement
+
+        define_style 'title', Styles::TextLabel
+
+        attr_accessor :style
+
+        def initialize(parent, opts)
+          setup_style(parent, opts)
+          @style = Styles::TextLabel.new(nil, Types::PlotLocation.new(:top))
+          update_style(@style)
+        end
+      end
+
+      # Wrapper for the background
+      class BackgroundElement < TiogaElement
+        define_style 'background', Styles::BackgroundStyle
+
+        attr_accessor :style
+
+        def initialize(parent, opts)
+          setup_style(parent, opts)
+          @style = get_style()
+        end
+
+        def draw_background(t)
+          @style.draw_background(t)
+        end
+      end
+      
+
+    end
+  end
+end

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

@@ -51,6 +51,9 @@ module CTioga2
           # compulsory arguments and a hash containing optional ones.
           attr_accessor :funcall
 
+          # The underlying nameless class
+          attr_accessor :primitive_class
+
           # Creates a TiogaPrimitive object
           def initialize(name, comp, opts = {}, &code)
             @name = name
@@ -111,6 +114,9 @@ module CTioga2
                            desc = nil, &code)
           primitive = TiogaPrimitive.new(name, comp, opts, &code)
           @known_primitives[name] = primitive
+
+          primitive_class = Class.new(TiogaPrimitiveCall)
+          primitive.primitive_class = primitive_class
           
           # Now, create the command
           cmd_args = comp.map do |x|
@@ -132,15 +138,17 @@ module CTioga2
 
           cmd_opts['clipped'] = CmdArg.new('boolean')
           cmd_opts['depth'] = CmdArg.new('integer')
+          cmd_opts.merge!(TiogaElement::StyleBaseOptions)
+
           cmd = Cmd.new("draw-#{name}",nil,"--draw-#{name}", 
                         cmd_args, cmd_opts) do |plotmaker, *rest|
             options = rest.pop
-            call = Elements::
-              TiogaPrimitiveCall.new(primitive,
+            call = primitive_class.new(primitive,
                                      rest, options)
+            container = plotmaker.root_object.current_plot
+            call.setup_style(container, options)
             call.last_curve_style = plotmaker.curve_style_stack.last
-            plotmaker.root_object.current_plot.
-              add_element(call)
+            container.add_element(call)
           end
           if ! desc
             desc = "Directly draws #{long_name} on the current plot"
@@ -150,6 +158,7 @@ module CTioga2
                        PrimitiveGroup)
 
           PrimitiveCommands[name] = cmd
+          return primitive_class
         end
 
         # This creates a primitive base on a style object, given a
@@ -164,13 +173,10 @@ module CTioga2
         def self.styled_primitive(name, long_name, comp, style_class, 
                                   style_name, without = [],
                                   additional_options = {},
-                                  set_style_command = nil, # This
-                                                           # could be
-                                                           # removed
+                                  set_style_command = nil,
                                   &code)
           options = style_class.options_hash.without(without)
           options.merge!(additional_options)
-          options['base-style'] = 'text' # the base style name
 
           set_style_command ||= style_name
           desc = <<"EOD"
@@ -179,14 +185,15 @@ For more information on the available options, see the
 {command: define-#{set_style_command}-style} command.
 EOD
 
-          self.primitive(name, long_name, comp, options, desc) do |*all|
+          cls = self.primitive(name, long_name, comp, options, desc) do |*all|
             opts = all.pop
-            st_name = opts['base-style'] || "base"
-            style = Styles::StyleSheet.style_for(style_class,st_name) 
+            style = get_style()
             style.set_from_hash(opts)
             all << style << opts
             code.call(*all)
           end
+          cls.define_style(set_style_command, style_class)
+          return cls
         end
 
 
@@ -251,6 +258,15 @@ EOD
                           head.to_figure_xy(t) ))
         end
 
+        # @todo Do the same thing for arrows...
+        styled_primitive("oriented-line", "oriented-line", 
+                         [ 'point', 'dimension' ],
+                         Styles::OrientedLineStyle,
+                         'oriented-line'
+                  ) do |t, org, dim, style, options|
+          style.draw_oriented_line(t, *org.to_figure_xy(t), dim)
+        end
+
 
         styled_primitive("image", "image", 
                          [ CmdArg.new('text', 'file'), 
@@ -291,7 +307,7 @@ EOD
           ## @todo this is a really ugly hack for passing
           ## last_curve_style around
           $last_curve_style = @last_curve_style
-          primitive.funcall.call(t, *args)
+          instance_exec(t, *args, &primitive.funcall)
         end
         
         DrawingSpecType =