ctioga2 0.3 → 0.4

data/Changelog

@@ -1,3 +1,21 @@
+ctioga2 (0.4)
+
+  * Fixed a bug in /which (dataset) options
+  * Added some context to error reporting, that may help understand where 
+    errors come from
+  * Improved error reporting on empty plots
+  * New command: --draw-box
+  * Improvements to the customization of legends, including the possiblity to 
+    draw a (possibly filled) frame around it
+  * Improvements of axis customization
+  * xcolor-like color mixing capacities
+  * An emacs major mode for editing ctioga2 command files
+  * Added a fully-fledged styling system that make it much simpler now to
+    change the style of a whole graph with a minimum of effort
+  * Added tests for most of the new possibilities
+
+ -- Vincent Fourmond <vincent.fourmond@9online.fr>  Fri Dec 28 17:49:07 CET 2012
+
 ctioga2 (0.3)
 
   * Implemented a compute-contour command to directly manipulate contours

data/lib/ctioga2/commands/arguments.rb

@@ -16,14 +16,19 @@ require 'ctioga2/commands/type'
 
 module CTioga2
 
-  Version::register_svn_info('$Revision$', '$Date$')
+  Version::register_svn_info('$Revision: 355 $', '$Date: 2012-12-26 00:19:04 +0100 (Wed, 26 Dec 2012) $')
 
   module Commands
 
     # An argument to a Command
+    #
+    # @todo There should be real options mangling capacities, with:
+    # * (possibly deprecated) aliases for options
+    # * _ to - mangling
+    # * other things ?
     class CommandArgument
 
-      # The type of the argument, a CTioga2::MetaBuilder::Type object.
+      # The type of the argument, a CommandType object.
       attr_accessor :type
 
       # The name of the argument. Uniquely for display in the help
@@ -33,11 +38,21 @@ module CTioga2
       # A small description of the argument
       attr_accessor :description
 
+      # The target for the option, in case it is different from its
+      # name
+      attr_accessor :option_target
+
+      # Whether or not the option is deprecated
+      attr_accessor :option_deprecated
+
       # _type_ is a named CommandType
       def initialize(type, name = nil, desc = nil)
         @type = CommandType.get_type(type)
         @name = name
         @description = desc
+
+        @option_target = nil
+        @option_deprecated = false
       end
       
       # Returns a name suitable for display in a documentation, such

data/lib/ctioga2/commands/commands.rb

@@ -17,7 +17,7 @@ require 'ctioga2/commands/groups'
 
 module CTioga2
 
-  Version::register_svn_info('$Revision$', '$Date$')
+  Version::register_svn_info('$Revision: 355 $', '$Date: 2012-12-26 00:19:04 +0100 (Wed, 26 Dec 2012) $')
 
   module Commands
 
@@ -214,12 +214,20 @@ module CTioga2
           if ! @optional_arguments.key? k
             raise CommandOptionUnkown, "Unkown option #{k} for command #{@name}"
           end
+          opt = @optional_arguments[k]
           if v.is_a? String
-            target_options[k] = @optional_arguments[k].type.
-              string_to_type(v)
-          else
-            target_options[k] = v
+            v = opt.type.string_to_type(v)
+          end
+          target = opt.option_target || k
+          if opt.option_deprecated
+            expl = ""
+            if opt.option_target
+              expl = " -- please use #{opt.option_target} instead"
+            end
+            Log::warn { "Deprecated option #{k}#{expl}" }
           end
+
+          target_options[target] = v
         end
         return target_options
       end

data/lib/ctioga2/commands/context.rb

@@ -0,0 +1,53 @@
+# context.rb: parsing context (for error reports)
+# 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/commands/type'
+
+module CTioga2
+
+  Version::register_svn_info('$Revision$', '$Date$')
+
+  module Commands
+
+    # Context of parsing, mostly for error reporting
+    class ParsingContext
+
+      # Currently parsing an option
+      def parsing_option(opt, number)
+        @option = opt
+        @number = number
+      end
+
+      # Currently within a file
+      def parsing_file(command, file, line = -1)
+        @option = nil
+        @command = command
+        @file = file
+        @number = line
+      end
+
+      def to_s
+        if @option
+          "option #{@option} (##{@number})"
+        else
+          "command #{@command} in file #{@file} line #{@number}"
+        end
+      end
+
+    end
+
+  end
+
+end
+

data/lib/ctioga2/commands/doc/doc.rb

@@ -17,7 +17,7 @@ require 'ctioga2/commands/doc/markup'
 
 module CTioga2
 
-  Version::register_svn_info('$Revision$', '$Date$')
+  Version::register_svn_info('$Revision: 138 $', '$Date: 2010-01-21 22:39:55 +0100 (Thu, 21 Jan 2010) $')
 
   module Commands
 

data/lib/ctioga2/commands/doc/documentation-commands.rb

@@ -20,7 +20,7 @@ require 'ctioga2/commands/doc/markup'
 
 module CTioga2
 
-  Version::register_svn_info('$Revision$', '$Date$')
+  Version::register_svn_info('$Revision: 106 $', '$Date: 2009-10-21 01:31:34 +0200 (Wed, 21 Oct 2009) $')
 
   module Commands
 

data/lib/ctioga2/commands/doc/help.rb

@@ -18,7 +18,7 @@ require 'ctioga2/commands/doc/wordwrap'
 
 module CTioga2
 
-  Version::register_svn_info('$Revision$', '$Date$')
+  Version::register_svn_info('$Revision: 132 $', '$Date: 2010-01-14 23:18:19 +0100 (Thu, 14 Jan 2010) $')
 
   module Commands
 

data/lib/ctioga2/commands/doc/html.rb

@@ -16,7 +16,7 @@ require 'ctioga2/commands/commands'
 
 module CTioga2
 
-  Version::register_svn_info('$Revision$', '$Date$')
+  Version::register_svn_info('$Revision: 216 $', '$Date: 2010-12-31 16:18:17 +0100 (Fri, 31 Dec 2010) $')
 
   module Commands
 

data/lib/ctioga2/commands/doc/introspection.rb

@@ -16,7 +16,7 @@ require 'ctioga2/commands/commands'
 
 module CTioga2
 
-  Version::register_svn_info('$Revision$', '$Date$')
+  Version::register_svn_info('$Revision: 336 $', '$Date: 2012-12-23 00:29:48 +0100 (Sun, 23 Dec 2012) $')
 
   module Commands
 
@@ -49,6 +49,20 @@ module CTioga2
               commands[n] = command
             end
             puts YAML.dump(commands)
+          when :spec
+            for n in names
+              cmd = cmds[n]
+              puts "#{n}:"
+              for a in cmd.arguments
+                puts " - #{a.type.name}"
+              end
+
+              opts = cmd.optional_arguments.keys.sort
+              for on in opts
+                opt = cmd.optional_arguments[on]
+                puts " * /#{on}=#{opt.type.name}"
+              end
+            end
           else
             puts "Known commands:" 
             max = names.inject(0) {|m,x| [m,x.size].max}
@@ -132,6 +146,7 @@ module CTioga2
       InternalFormatRE = {
         /list|raw/i => :list,
         /default|pretty/i => :pretty,
+        /spec/i => :spec,
         /yaml/i => :yaml
       }
       

data/lib/ctioga2/commands/doc/man.rb

@@ -18,7 +18,7 @@ require 'ctioga2/commands/parsers/command-line'
 
 module CTioga2
 
-  Version::register_svn_info('$Revision$', '$Date$')
+  Version::register_svn_info('$Revision: 213 $', '$Date: 2010-12-31 02:50:00 +0100 (Fri, 31 Dec 2010) $')
 
   module Commands
 

data/lib/ctioga2/commands/doc/markup.rb

@@ -16,7 +16,7 @@ require 'ctioga2/log'
 
 module CTioga2
 
-  Version::register_svn_info('$Revision$', '$Date$')
+  Version::register_svn_info('$Revision: 216 $', '$Date: 2010-12-31 16:18:17 +0100 (Fri, 31 Dec 2010) $')
 
   module Commands
 

data/lib/ctioga2/commands/doc/wordwrap.rb

@@ -17,7 +17,7 @@ require 'ctioga2/commands/parsers/command-line'
 
 module CTioga2
 
-  Version::register_svn_info('$Revision$', '$Date$')
+  Version::register_svn_info('$Revision: 131 $', '$Date: 2010-01-14 22:51:09 +0100 (Thu, 14 Jan 2010) $')
 
   module Commands
 

data/lib/ctioga2/commands/general-commands.rb

@@ -17,7 +17,7 @@ require 'ctioga2/commands/parsers/file'
 
 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) $')
 
   module Commands
  

data/lib/ctioga2/commands/general-types.rb

@@ -15,7 +15,7 @@ require 'ctioga2/utils'
 
 module CTioga2
 
-  Version::register_svn_info('$Revision$', '$Date$')
+  Version::register_svn_info('$Revision: 223 $', '$Date: 2011-01-11 01:07:48 +0100 (Tue, 11 Jan 2011) $')
 
   module Commands
  

data/lib/ctioga2/commands/groups.rb

@@ -16,7 +16,7 @@ require 'ctioga2/metabuilder/types'
 
 module CTioga2
 
-  Version::register_svn_info('$Revision$', '$Date$')
+  Version::register_svn_info('$Revision: 14 $', '$Date: 2009-04-27 21:49:16 +0200 (Mon, 27 Apr 2009) $')
 
   module Commands
 

data/lib/ctioga2/commands/interpreter.rb

@@ -13,6 +13,7 @@
 
 require 'ctioga2/utils'
 require 'ctioga2/commands/commands'
+require 'ctioga2/commands/context'
 require 'ctioga2/commands/variables'
 require 'ctioga2/commands/strings'
 require 'ctioga2/commands/parsers/command-line'
@@ -20,7 +21,7 @@ require 'ctioga2/commands/doc/doc'
 
 module CTioga2
 
-  Version::register_svn_info('$Revision$', '$Date$')
+  Version::register_svn_info('$Revision: 355 $', '$Date: 2012-12-26 00:19:04 +0100 (Wed, 26 Dec 2012) $')
 
   # This module contains the real core of ctioga2: a set of classes
   # that implement the concept of commands. Each command translates
@@ -162,6 +163,9 @@ module CTioga2
       # The Parsers::FileParser object used to... parse files ?
       attr_reader :file_parser
 
+      # The current context
+      attr_accessor :context
+
       # Creates an Interpreter with _target_ as the PlotMaker target
       # object.
       #
@@ -187,6 +191,7 @@ module CTioga2
         end
 
         @file_parser = Parsers::FileParser.new
+        @context = ParsingContext.new
       end
 
 
@@ -246,6 +251,22 @@ module CTioga2
                             converted_options)
       end
     end
+
+    def self.make_alias_for_option(cmd_name, option, 
+                                   new_name, deprecated = false)
+      cmd = Interpreter.command(cmd_name)
+      if ! cmd
+        raise "Impossible to find command #{cmd_name}"
+      end
+      new_opt = cmd.optional_arguments[option]
+      if ! new_opt
+        raise "No #{option} option to command #{cmd_name}"
+      end
+      new_opt = new_opt.dup
+      new_opt.option_deprecated = deprecated
+      new_opt.option_target = option
+      cmd.optional_arguments[new_name] = new_opt
+    end
   end
   
   # An alias for Commands::Command

data/lib/ctioga2/commands/parsers/command-line.rb

@@ -17,7 +17,7 @@ require 'ctioga2/commands/commands'
 
 module CTioga2
 
-  Version::register_svn_info('$Revision$', '$Date$')
+  Version::register_svn_info('$Revision: 327 $', '$Date: 2012-11-28 14:47:52 +0100 (Wed, 28 Nov 2012) $')
 
   module Commands
 
@@ -71,6 +71,7 @@ module CTioga2
           # We duplicate the original array
           argv = argv.dup
           options = nil         # currently never used.
+          number = 0
           while argv.size > 0
             current = argv.shift
             if current =~ /^--(.*)/ # a long option
@@ -78,6 +79,8 @@ module CTioga2
                 command, arguments, options = 
                   extract_command_arguments(argv, @long_options[$1])
 
+                number += 1
+                interpreter.context.parsing_option(current, number)
                 interpreter.run_command(command, arguments, options)
               else
                 raise OptionUnkown, "Long option #{current} is not known"
@@ -89,6 +92,8 @@ module CTioga2
                 if @short_options.key?(short)
                   command, arguments, options = 
                     extract_command_arguments(argv, @short_options[short])
+                  number += 1
+                  interpreter.context.parsing_option("-#{short}", number)
                   interpreter.run_command(command, arguments, options)
                 else
                   raise OptionUnkown, "Short option -#{short} is not known"
@@ -99,6 +104,8 @@ module CTioga2
                 argv.unshift current
                 command, arguments, options = 
                   extract_command_arguments(argv, @default_command)
+                number += 1
+                interpreter.context.parsing_option("(default)", number)
                 interpreter.run_command(command, arguments, options)
               else
                 yield current

data/lib/ctioga2/commands/parsers/file.rb

@@ -19,7 +19,7 @@ require 'ctioga2/commands/strings'
 
 module CTioga2
 
-  Version::register_svn_info('$Revision$', '$Date$')
+  Version::register_svn_info('$Revision: 327 $', '$Date: 2012-11-28 14:47:52 +0100 (Wed, 28 Nov 2012) $')
 
   module Commands
 
@@ -110,6 +110,7 @@ module CTioga2
                   end
                 end
 
+                interpreter.context.parsing_file(symbol, io) # Missing line number
                 interpreter.run_command(cmd, real_args, options)
                 io.getc         # Slurp up the )
                 break

data/lib/ctioga2/commands/strings.rb

@@ -16,7 +16,7 @@ require 'stringio'              # For debugging purposes
 
 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 Commands
 

data/lib/ctioga2/commands/type.rb

@@ -16,7 +16,7 @@ require 'ctioga2/metabuilder/types'
 
 module CTioga2
 
-  Version::register_svn_info('$Revision$', '$Date$')
+  Version::register_svn_info('$Revision: 173 $', '$Date: 2010-10-22 21:41:39 +0200 (Fri, 22 Oct 2010) $')
 
   module Commands
 

data/lib/ctioga2/commands/variables.rb

@@ -16,7 +16,7 @@ require 'ctioga2/commands/strings'
 
 module CTioga2
 
-  Version::register_svn_info('$Revision$', '$Date$')
+  Version::register_svn_info('$Revision: 302 $', '$Date: 2012-01-03 14:02:43 +0100 (Tue, 03 Jan 2012) $')
 
   module Commands
 

data/lib/ctioga2/data/backends/backend.rb

@@ -21,7 +21,7 @@ require 'ctioga2/data/backends/description'
 
 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) $')
   
 
   module Data