ctioga2 0.0

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

@@ -0,0 +1,58 @@
+# items.rb: individual legend items
+# copyright (c) 2008,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'
+
+module CTioga2
+
+  Version::register_svn_info('$Revision: 2 $', '$Date: 2009-04-25 14:03:30 +0200 (Sat, 25 Apr 2009) $')
+
+  module Graphics
+
+    module Legends
+
+      # This class is in charge of providing a legend for the given
+      # dataset. Most of its job is simply to collect --legend
+      # arguments from the command-line.
+      class LegendProvider
+
+        # The legend to be used for the next curve, if applicable
+        attr_accessor :current_legend
+
+        # Whether we automatically give a name to curves or not.
+        attr_accessor :auto_legend
+
+        def initialize
+          @current_legend = nil
+          @auto_legend = false
+        end
+
+        # Returns a legend suitable for the next curve.
+        def dataset_legend(dataset)
+          if @current_legend
+            l = @current_legend
+            @current_legend = nil
+            return l
+          elsif @auto_legend
+            return dataset.name
+          else
+            return nil
+          end
+        end
+        
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,65 @@
+# storage.rb: an object holding legends
+# 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'
+
+module CTioga2
+
+  Version::register_svn_info('$Revision: 53 $', '$Date: 2009-05-20 01:05:32 +0200 (Wed, 20 May 2009) $')
+
+  module Graphics
+
+    # This module holds all the classes dealing with legends
+    module Legends
+
+      # This class holds a series of legends for curves.
+      class LegendStorage
+
+        # An array of LegendItem objects, in the order in which they
+        # should get displayed.
+        attr_accessor :contents
+
+        def initialize
+          @contents = []
+        end
+
+        # Adds a LegendItem or a Container to the LegendStorage
+        # object.
+        def add_item(item)
+          @contents << item
+        end
+
+        # Returns a flat array of LegendItem that belong to the same
+        # LegendArea as the object in which the LegendStorage was
+        # created.
+        def harvest_contents
+          retval = []
+          for el in @contents
+            if el.is_a? LegendItem
+              retval << el
+            elsif el.is_a? Elements::Container and 
+                (not el.legend_area)
+              retval.concat(el.legend_storage.harvest_contents)
+            end
+          end
+          return retval
+        end
+
+      end
+
+    end
+  end
+
+end
+

data/lib/ctioga2/graphics/root.rb

@@ -0,0 +1,209 @@
+# root.rb: the root object for creating a 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'
+
+require 'ctioga2/graphics/elements'
+require 'ctioga2/graphics/legends'
+
+require 'ctioga2/graphics/subplot-commands'
+
+module CTioga2
+
+  Version::register_svn_info('$Revision: 88 $', '$Date: 2009-06-17 00:10:31 +0200 (Wed, 17 Jun 2009) $')
+
+  # This module contains all graphical elements of CTioga2
+  module Graphics
+
+    # The root object of the plot. The PlotMaker has one object like
+    # that. It is the real object drawing the plot.
+    class RootObject
+
+      # The current Elements::Container of the object. 
+      attr_accessor :current_container
+
+      # The top-level Legends::LegendArea. This one gets necessarily
+      # displayed on one of the sides of the graph.
+      attr_accessor :legend_area
+
+      # Whether top-level legends are part of the "real size" of the
+      # graph or outside the graph (easier to align anything)
+      attr_accessor :count_legend_in_page
+
+      # The page size of the graph, a [width,height] array.
+      attr_accessor :page_size
+
+
+      def initialize
+        @current_container = nil
+
+        @container_stack = []
+
+        @legend_area = Legends::LegendArea.new
+
+        @count_legend_in_page = false
+        #     @count_legend_in_page = true
+
+        # Page size:
+        set_page_size("12cmx12cm")  # Same as old ctioga
+      end
+
+      # Returns the current Elements::Container, or create an
+      # Elements::Subplot if there isn't.
+      #
+      # This function should be used by all functions that add
+      # Elements::TiogaElement to plots (or modify plot's data, such
+      # as title, axes...).
+      def current_plot
+        if @current_container
+          return @current_container
+        else
+          subplot = Elements::Subplot.new(nil, self, nil)
+          enter_subobject(subplot)
+          return subplot
+        end
+      end
+
+      # Enters into a new Elements::Container, _new_object_.
+      def enter_subobject(new_object)
+        if @current_container
+          @current_container.add_element(new_object)
+        end
+        @current_container = new_object
+        @container_stack << @current_container
+      end
+
+      # Leaves a subobject.
+      def leave_subobject
+        if @container_stack.size == 1
+          raise "Trying to leave top-level object"
+        end
+        if @container_stack.pop != @current_container
+          raise "We have a serious problem here"
+        end
+        @current_container = @container_stack.last
+      end
+
+      # The only top-level container of the graph.
+      def top_level_container
+        return @container_stack.first
+      end
+
+      # Sets the page of the object, from a pure text object, such as
+      # "12cmx12cm"
+      def set_page_size(size)
+        @page_size = size.split(/\s*x\s*/).collect {|s| 
+          Tioga::Utils::tex_dimension_to_bp(s)
+        }
+      end
+
+
+      # Sets up the page width and other parameters for the given
+      # FigureMaker object. Must be within a figure object, so that
+      # potential modifications to the page size due to text objects
+      # (legends) can be taken into account.
+      def setup_page(t)
+        if @count_legend_in_page or ! draw_top_level_legend?
+          effective_size = @page_size
+        else
+          effective_size = @legend_area.
+            enlarged_page_size(t,  top_level_container, *@page_size)
+        end
+        t.page_setup(*effective_size)
+        t.set_frame_sides(0,1,1,0) 
+
+        # Setting label and title scale to 1
+        t.title_scale = 1
+        t.xlabel_scale = 1
+        t.ylabel_scale = 1
+        # TODO: I think this is mostly useless. Check.
+      end
+
+      # Creates a subplot of the current plot. If @current_container
+      # is null, create it as a Elements::Container: this will make it
+      # *easy* to create complex graphs (no need to disable axes and
+      # other kinds of stuff on the main plot).
+      #
+      # For the sake of convenience, returns the newly created
+      # Elements::Subplot
+      def subplot()
+        if ! @current_container
+          enter_subobject(Elements::Container.new(nil, self))
+        end
+        subplot = Elements::Subplot.new(@current_container, self, nil)
+        enter_subobject(subplot)
+        return subplot
+      end
+
+      # Returns true if not a single drawable object has been pushed
+      # unto the RootObject yet.
+      def empty?
+        return @current_container.nil?
+      end
+
+      # Draws this object onto an appropriate FigureMaker object.
+      def draw_root_object(t)
+        setup_page(t)
+        if top_level_container
+          
+          plot_margins, legend_margins =  
+            if draw_top_level_legend?
+              @legend_area.partition_frame(t, top_level_container)
+            else
+              [[0, 0, 0, 0], nil]
+            end
+
+          t.context do 
+            t.set_subframe(plot_margins)
+            top_level_container.do(t)
+          end
+
+          # Draw the legend only when applicable.
+          if legend_margins
+            t.context do 
+              t.set_subframe(legend_margins)
+              @legend_area.display_legend(t, top_level_container)
+            end
+          end
+        else
+          raise "The root object should not be drawn empty ?"
+        end
+      end
+
+      # Whether we are drawing a top-level legend
+      def draw_top_level_legend?
+        return (! top_level_container.legend_area) && 
+          ( top_level_container.legend_storage.harvest_contents.size > 0)
+      end
+
+      # Returns the legend_area in charge of the current container.
+      def current_legend_area
+        area = nil
+        for el in @container_stack
+          if el.respond_to?(:legend_area) and el.legend_area
+            area = el.legend_area
+          end
+        end
+        if ! area
+          area = @legend_area
+        end
+        return area
+      end
+          
+    end
+    
+  end
+
+end
+

data/lib/ctioga2/graphics/styles.rb

@@ -0,0 +1,30 @@
+# styles.rb: all style objects
+# 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/graphics/styles/base'
+
+require 'ctioga2/graphics/styles/drawable'
+require 'ctioga2/graphics/styles/texts'
+require 'ctioga2/graphics/styles/carrays'
+require 'ctioga2/graphics/styles/curve'
+
+require 'ctioga2/graphics/styles/sets'
+
+require 'ctioga2/graphics/styles/axes'
+require 'ctioga2/graphics/styles/background'
+require 'ctioga2/graphics/styles/plot'
+
+require 'ctioga2/graphics/styles/legend'
+
+
+require 'ctioga2/graphics/styles/factory'

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

@@ -0,0 +1,247 @@
+# axes.rb: the style of one axis or edge 
+# 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: 94 $', '$Date: 2009-06-25 23:37:13 +0200 (Thu, 25 Jun 2009) $')
+
+  module Graphics
+
+    module Styles
+
+      # The style of an axis or an egde of the plot. Unlike tioga,
+      # ctioga2 does not make any difference.
+      class AxisStyle < BasicStyle
+        include Tioga::FigureConstants
+        
+        # The type of the edge/axis. Any of the Tioga constants:
+        # AXIS_HIDDEN, AXIS_LINE_ONLY, AXIS_WITH_MAJOR_TICKS_ONLY,
+        # AXIS_WITH_TICKS_ONLY,
+        # AXIS_WITH_MAJOR_TICKS_AND_NUMERIC_LABELS, and
+        # AXIS_WITH_TICKS_AND_NUMERIC_LABELS.
+        attr_accessor :decoration
+        
+        # The position of the axis. Can be one of :left, :right, :top,
+        # :bottom, :at_y_origin or :at_x_origin.
+        attr_accessor :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
+
+        # The background lines for the given axis. _nil_ for nothing,
+        # or a StrokeStyle object if we want to draw something.
+        attr_accessor :background_lines
+
+        # The style of the tick labels
+        attr_accessor :tick_label_style
+
+        # The label of the axis, if there is one
+        attr_accessor :axis_label
+
+        # Whether the axis should be log scale or not
+        attr_accessor :log
+
+        # Transform: a Types::Bijection object specifying a coordinate
+        # transformation for the axis.
+        attr_accessor :transform
+
+        # The color of the stroke for the lines of the axis
+        attr_accessor :stroke_color
+
+
+        # Creates a new AxisStyle object at the given location with
+        # the given style.
+        def initialize(location = nil, decoration = nil, label = nil)
+          @location = location
+          @decoration = decoration
+
+          @tick_label_style = FullTextStyle.new
+          @axis_label = TextLabel.new(label)
+          @log = false
+        end
+
+        # Draws the axis within the current plot. Boundaries are the
+        # current plot boundaries. Also draw the #axis_label, if there
+        # is one.
+        #
+        # TODO:
+        # * the offset mechanism, to place the axis away from the place
+        #   where it should be...
+        # * non-linear axes (or linear, for that matter, but with
+        #   a transformation)
+        def draw_axis(t)
+          spec = get_axis_specification(t)
+          # Add tick label style:
+          spec.merge!(@tick_label_style.to_hash)
+          if @stroke_color
+            spec['stroke_color'] = @stroke_color
+          end
+          t.show_axis(spec)
+          @axis_label.loc = LocationToTiogaLocation[@location]
+          default = vertical? ? 'ylabel' : 'xlabel'
+          @axis_label.draw(t, default)
+        end
+
+        # Draw the axis background lines:
+        def draw_background_lines(t)
+          if @background_lines
+            # First, getting major ticks location from tioga
+            info = t.axis_information(get_axis_specification(t))
+
+            if info['vertical']
+              x0 = t.bounds_left
+              x1 = t.bounds_right
+            else
+              y0 = t.bounds_bottom
+              y1 = t.bounds_top
+            end
+            t.context do
+              @background_lines.set_stroke_style(t)
+              values = info['major_ticks'] || info['major']
+              for val in values
+                if info['vertical']
+                  t.stroke_line(x0, val, x1, val)
+                else
+                  t.stroke_line(val, y0, val, y1)
+                end
+              end
+            end
+          end
+        end
+
+        # Returns the AxisStyle object corresponding to the named axis
+        # in the current plot.
+        def self.current_axis_style(plotmaker, spec)
+          return PlotStyle.current_plot_style(plotmaker).
+            get_axis_style(spec)
+        end
+
+        # Returns the extension of the axis (including tick labels and
+        # labels if applicable) perpendicular to itself, in units of
+        # text height (at scale = current text scale when drawing
+        # axes).
+        #
+        # _style_ is a PlotStyle object containing the style
+        # information for the target plot.
+        #
+        # TODO: handle offset axes when that is implemented.
+        def extension(t, style = nil)
+          ticks_shift, ticks_scale = *get_ticks_parameters(t)
+          default =  vertical? ? 'ylabel' : 'xlabel'
+          le = @axis_label.label_extension(t, default, @location)
+
+          case @decoration
+          when AXIS_WITH_MAJOR_TICKS_AND_NUMERIC_LABELS,
+            AXIS_WITH_TICKS_AND_NUMERIC_LABELS
+            te = ticks_shift * ticks_scale
+          else
+            te = 0
+          end
+          return Dobjects::Dvector[le,te].max * 
+            (style ? style.text_scale || 1 : 1)
+        end
+
+        protected
+
+        # Whether the axis is vertical or not
+        def vertical?
+          return LocationVertical[@location]
+        end
+
+        # Returns: _ticks_shift_, _ticks_scale_ for the axis.
+        #
+        # TODO: try something clever with the angles ?
+        def get_ticks_parameters(t)
+          i = t.axis_information({'location' => 
+                                   LocationToTiogaLocation[@location]})
+          retval = []
+          retval << (@tick_label_style.shift || i['shift'])
+          retval << (@tick_label_style.scale || i['scale'])
+
+          retval[0] += 1
+          return retval
+        end
+        
+        # Returns an argument suitable for use for
+        # FigureMaker#show_axis or FigureMaker#axis_information.
+        #
+        # For the log axis scale to work, tioga revision 543 is
+        # absolutely necessary. It won't fail, though, without it.
+        def get_axis_specification(t)
+          if @transform
+            retval = compute_coordinate_transforms(t)
+          else
+            retval = {}
+          end
+          if @offset 
+            raise YetUnimplemented, "This has not been implemented yet"
+          else
+            retval.
+              update({'location' => 
+                       LocationToTiogaLocation[@location],
+                       'type' => @decoration, 'log' => @log})
+            return retval
+          end
+        end
+
+        # Setup coordinate transformations
+        def compute_coordinate_transforms(t)
+          return unless @transform
+          # We'll proceed by steps...
+          i = t.axis_information({'location' => 
+                                   LocationToTiogaLocation[@location]})
+          t.context do 
+            if i['vertical']
+              top,b = @transform.convert_to([t.bounds_top, t.bounds_bottom])
+              l,r = t.bounds_left, t.bounds_right
+            else
+              top,b = t.bounds_top, t.bounds_bottom
+              l,r = @transform.convert_to([t.bounds_left, t.bounds_right])
+            end
+            t.set_bounds([l,r,top,b])
+            i = t.axis_information({'location' => 
+                                     LocationToTiogaLocation[@location]})
+            # Now, we have the location of everything we need.
+          end
+          # In the following, the || are because of a fix in Tioga
+          # r545
+          return { 'labels' => i['labels'], 
+            'major_ticks' => @transform.
+            convert_from(i['major_ticks'] || i['major']),
+            'minor_ticks' => @transform.
+            convert_from(i['minor_ticks'] || i['minor'] )
+          }
+        end
+
+
+       
+      end
+
+      PartialAxisStyle = {
+        'transform' => CmdArg.new('bijection'),
+        'stroke_color' => CmdArg.new('color')
+      }
+
+      FullAxisStyle = PartialAxisStyle.dup
+      FullAxisStyle['decoration'] = CmdArg.new('axis-decoration')
+                       
+
+    end
+  end
+end