ctioga2 0.0 → 0.1

data/Changelog

@@ -1,6 +1,30 @@
+ctioga2 (0.1)
+
+  * Setting any set now resets its index
+  * Implemented a mechanism for tangents !
+  * Added a filter for averaging on successive identical values of X
+  * Make the gnuplot backend able to change the number of samples
+    required.
+  * Implemented error bars
+  * Implemented a grid layout (via setup-grid and the grid inset specification)
+  * Implemented alternate axes (y2, x2)
+  * Neatly colored help with pager(1) using the --help option 
+  * Filled curves
+  * Implemented colored regions
+  * Automatic output file name incrementation
+  * Neat and easy color gradients for successive curves using the
+    --gradient command
+  * XYZ maps display
+  * Contours on XYZ maps
+  * The text backend now supports naming columns
+  * Added a --merge-datasets function to merge data sets with common X
+    (and more) values...
+  * Setup of a tests/ directory containing a whole bunch of visual tests.
+
+ -- Vincent Fourmond <vincent.fourmond@9online.fr>  Mon Jan 31 19:00:00 CET 2011
+
 ctioga2 (0.0)
 
   * New version of ctioga, rewritten from scratch, with a whole new structure.
 
  -- Vincent Fourmond <vincent.fourmond@9online.fr>  Sat Apr 18 13:16:34 CEST 2009
-

data/lib/ctioga2/commands/commands.rb

@@ -17,7 +17,7 @@ require 'ctioga2/commands/groups'
 
 module CTioga2
 
-  Version::register_svn_info('$Revision: 16 $', '$Date: 2009-04-28 00:50:08 +0200 (Tue, 28 Apr 2009) $')
+  Version::register_svn_info('$Revision: 144 $', '$Date: 2010-04-06 13:31:39 +0200 (Tue, 06 Apr 2010) $')
 
   module Commands
 
@@ -32,6 +32,13 @@ module CTioga2
     end
 
     # One of the commands that can be used.
+    #
+    # \todo Write a Shortcut command that would simply be a shortcut
+    # for other things. Possibly taking arguments ? It could take a
+    # description, though that wouldn't be necessary.
+    #
+    # \todo Use this Shortcut to write DeprecatedShortcut for old
+    # ctioga options.
     class Command
 
       # The name of the command, ie how to call it in a commands file
@@ -219,7 +226,11 @@ module CTioga2
 
       # Whether the Command accepts the named _option_.
       #
-      # TODO: maybe convert everything to lowercase ?????
+      # \todo Several conversions could be used, to facilitate the
+      # writing of options:
+      #
+      # * convert everything to lowercase .
+      # * ignore the difference between _ and - (a bit delicate).
       def has_option?(option)
         return @optional_arguments.key? option
       end

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

@@ -17,7 +17,7 @@ require 'ctioga2/commands/doc/markup'
 
 module CTioga2
 
-  Version::register_svn_info('$Revision: 61 $', '$Date: 2009-05-29 01:00:56 +0200 (Fri, 29 May 2009) $')
+  Version::register_svn_info('$Revision: 138 $', '$Date: 2010-01-21 22:39:55 +0100 (Thu, 21 Jan 2010) $')
 
   module Commands
 
@@ -25,12 +25,6 @@ module CTioga2
     module Documentation
 
       # The base class for all documentation.
-      #
-      # TODO: create a class that would parse a description from a
-      # group/command/type and understand some 'markup': lists, links
-      # to other commands/groups/types, and maybe bold or things of
-      # this kind. Then the various outputs should have a means to
-      # parse this.
       class Doc
         
         # The hash containing all the commands, as returned
@@ -45,25 +39,23 @@ module CTioga2
         # by Interpreter::commands.
         attr_accessor :types
 
+        # The hash containing all the backends, as returned by
+        # Data::Backends::Backend::list_backends
+        attr_accessor :backends
+
         # Wether or not to ignore blacklisted commands
         attr_accessor :ignore_blacklisted
 
-        # The CommandLineHelp object in charge of displaying
-        # information about command-line
-        attr_accessor :command_line_help
-
-
         # Create a Doc object caring about the current state of
         # registered commands and such.
         def initialize
           @commands = Interpreter::commands
           @groups = Interpreter::groups
           @types = Interpreter::types
+          @backends = Data::Backends::Backend::list_backends
 
           @ignore_blacklisted = ! (ENV.key?("CT2_DEV") && 
                                    ! ENV["CT2_DEV"].empty?)
-
-          @command_line_help = CommandLineHelp.new
         end
 
         # Returns a [ cmds, groups ] hash containing the list of
@@ -77,7 +69,11 @@ module CTioga2
             elsif ! b
               -1
             else
-              a.priority <=> b.priority
+              if a.priority == b.priority
+                a.name <=> b.name
+              else
+                a.priority <=> b.priority
+              end
             end
           end
           if @ignore_blacklisted
@@ -87,8 +83,8 @@ module CTioga2
         end
 
         # Display command-line help.
-        def display_command_line_help
-          @command_line_help.
+        def display_command_line_help(options)
+          CommandLineHelp.new(options).
             print_commandline_options(*self.documented_commands)
         end
 

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

@@ -20,7 +20,7 @@ require 'ctioga2/commands/doc/markup'
 
 module CTioga2
 
-  Version::register_svn_info('$Revision: 77 $', '$Date: 2009-06-05 00:20:49 +0200 (Fri, 05 Jun 2009) $')
+  Version::register_svn_info('$Revision: 106 $', '$Date: 2009-10-21 01:31:34 +0200 (Wed, 21 Oct 2009) $')
 
   module Commands
 
@@ -74,6 +74,19 @@ EOH
       WriteHTMLTypes.describe("HTML documentation for types",
                               <<EOH, DocumentationGenerationGroup)
 Prints the HTML documentation for all types.
+EOH
+
+      WriteHTMLBackends = 
+        Cmd.new("write-html-backends", nil, "--write-html-backends", 
+                []) do |plotmaker|
+        html = HTML.new(plotmaker.interpreter.doc)
+        html.write_backends()
+      end
+      
+      WriteHTMLBackends.describe("HTML documentation for backends",
+                                 <<EOH, DocumentationGenerationGroup)
+Writes the documentation for all backends, in one monolithic HTML page
+for now (but this would be a good idea to change).
 EOH
 
       WriteHTMLCommandLineOptions = 

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

@@ -14,10 +14,11 @@
 require 'ctioga2/utils'
 require 'ctioga2/commands/commands'
 require 'ctioga2/commands/parsers/command-line'
+require 'ctioga2/commands/doc/wordwrap'
 
 module CTioga2
 
-  Version::register_svn_info('$Revision: 34 $', '$Date: 2009-05-03 20:22:29 +0200 (Sun, 03 May 2009) $')
+  Version::register_svn_info('$Revision: 132 $', '$Date: 2010-01-14 23:18:19 +0100 (Thu, 14 Jan 2010) $')
 
   module Commands
 
@@ -29,52 +30,138 @@ module CTioga2
         # How much space to leave for the options ?
         attr_accessor :options_column_width
 
-        def initialize
+        # How many columns do we have at all ?
+        attr_accessor :total_width
+
+        # Whether output has (moderate) terminal capabilities
+        attr_accessor :to_tty
+
+        # Whether we should send output to pager if output has
+        # terminal support.
+        attr_accessor :to_pager
+
+        # Styles, ie a hash 'object' (option, argument...) => ANSI
+        # color code.
+        attr_accessor :styles
+
+        # Color output ?
+        attr_accessor :color
+
+        # The default value for the #styles attribute.
+        DefaultStyles = {
+          'switch' => "01",
+          'title' => "01;04",
+          'arguments' => '32',
+          'options' => '34'
+        }
+
+        # Creates an object to display command-line help. Available
+        # values for the options are given by the hash
+        # CommandLineHelpOptions. Their meaning is:
+        # 
+        # * 'pager': disables or enables the use of a pager when
+        #   sending output to a terminal
+        def initialize(options)
           @options_column_width = 20
+          @to_pager = if options.key? 'pager'
+                        options['pager']
+                      else
+                        true
+                      end
+
+          @styles = DefaultStyles.dup
+          @color = true
         end
 
         # Prints short help text suitable for a --help option about
         # available commands, by groups (ungrouped last). It takes a
         # list of all commands (_cmds_) and the list of _groups_ to
         # display.
-        #
-        # TODO: word splitting.
-        #
-        # TODO: why not try color, too ;-) ???
+        # 
+        # \todo maybe the part about sending to the pager should be
+        # factorized into a neat utility class ?
         def print_commandline_options(cmds, groups)
+          @to_tty = false
+          if STDOUT.tty? 
+            begin
+              require 'curses'
+              Curses.init_screen
+              @total_width = Curses.cols
+              Curses.close_screen
+              @to_tty = true
+            rescue
+            end
+          end
+          @total_width ||= 80   # 80 by default
+
+          # Disable color output if not a to a terminal
+          if ! @to_tty
+            @color = false
+          end
+
+          if @to_tty and @to_pager
+            # We pass -R as default value...
+            ENV['LESS'] = 'R'
+            output = IO::popen("pager", "w")
+            pager = true
+          else
+            output = $stdout
+            pager = false
+          end
+          
           for group in groups
-            puts unless group == groups[0]
+            output.puts unless group == groups[0]
             name = (group && group.name) || "Ungrouped commands"
             if group && group.blacklisted 
               name << " (blacklisted)"
             end
-            puts name
+            output.puts style(name, 'title')
             for cmd in cmds[group].sort {|a,b|
                 a.long_option <=> b.long_option
               }
 
-              strings = cmd.option_strings
-              puts "#{leading_spaces}%2s%1s %-#{@options_column_width}s%s" % 
-                [ 
-                 strings[0], (strings[0] ? "," : " "),
-                 strings[1],
-                 if strings[1].size >= @options_column_width
-                   "\n#{total_leading_spaces}#{strings[2]}"
-                 else
-                   strings[2]
-                 end
-                ]
-              if cmd.has_options?
-                puts "#{total_leading_spaces}  options: %s" %
-                  cmd.optional_arguments.keys.sort.map {|x| "/#{x}"}.join(' ')
-              end
+              output.puts format_one_entry(cmd)
             end
           end
-
+          output.close
         end
 
         protected
 
+        # Formats one entry of the commands
+        def format_one_entry(cmd)
+          sh, long, desc = cmd.option_strings
+          
+          str = "#{leading_spaces}%2s%1s %-#{@options_column_width}s" % 
+            [ sh, (sh ? "," : " "), long]
+
+          size = @total_width - total_leading_spaces.size
+
+          # Do the coloring: we need to parse option string first
+          if str =~ /(.*--\S+)(.*)/
+            switch = $1
+            args = $2
+            str = "#{style(switch,'switch')}#{style(args,'arguments')}"
+          end
+          
+          # Now, add the description.
+          desc_lines = WordWrapper.wrap(desc, size)
+          if long.size >= @options_column_width
+            str += "\n#{total_leading_spaces}"
+          end
+          str += desc_lines.join("\n#{total_leading_spaces}")
+
+          if cmd.has_options?
+            op_start = '  options: '
+            options = cmd.optional_arguments.
+              keys.sort.map { |x| "/#{x}"}.join(' ') 
+            opts_lines = WordWrapper.wrap(options, size - op_start.size)
+            str += "\n#{total_leading_spaces}#{style(op_start,'switch')}" + 
+              style(opts_lines.join("\n#{total_leading_spaces}#{' ' * op_start.size}"), 'options')
+          end
+          return str
+        end
+
         # Leading spaces to align a string with the other option texts
         def total_leading_spaces
           return "#{leading_spaces}#{" " *(@options_column_width + 4)}"
@@ -85,7 +172,31 @@ module CTioga2
         def leading_spaces
           return "    "
         end
-        
+
+        # Colorizes some text with the given ANSI code.
+        #
+        # Word wrapping should be used *before*, as it will not work
+        # after.
+        def colorize(str, code)
+          # We split into lines, as I'm unsure color status is kept
+          # across lines
+          return str.split("\n").map {|s|
+            "\e[#{code}m#{s}\e[0m"
+          }.join("\n")
+        end
+
+        # Changes the style of the object.
+        def style(str, what)
+          if ! @color
+            return str
+          end
+          if @styles[what]
+            return colorize(str, @styles[what])
+          else
+            return str
+          end
+        end
+
       end
 
     end

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

@@ -16,7 +16,7 @@ require 'ctioga2/commands/commands'
 
 module CTioga2
 
-  Version::register_svn_info('$Revision: 77 $', '$Date: 2009-06-05 00:20:49 +0200 (Fri, 05 Jun 2009) $')
+  Version::register_svn_info('$Revision: 216 $', '$Date: 2010-12-31 16:18:17 +0100 (Fri, 31 Dec 2010) $')
 
   module Commands
 
@@ -29,9 +29,16 @@ module CTioga2
         # The Doc object the HTML class should document
         attr_accessor :doc
 
-        # The base URL for file where types are documented.
+        # The base URL for the file where the types are documented.
         attr_accessor :types_url
 
+        # The base URL for the file where the backends are documented.
+        #
+        # \todo maybe this should be turned into a directory, and each
+        # file would document a backend on its own ? That would make
+        # sense, but that would be rather difficult, I have to admit.
+        attr_accessor :backends_url
+
         # The base URL for file where commands and groups are
         # documented.
         attr_accessor :commands_url
@@ -40,6 +47,7 @@ module CTioga2
           @doc = doc
           @types_url = "types.html"
           @commands_url = "commands.html"
+          @backends_url = "backends.html"
         end
 
         # Ouputs HTML code to document all groups and commands 
@@ -125,6 +133,34 @@ module CTioga2
         end
         
 
+        # Ouputs HTML code to all backends
+        def write_backends(out = STDOUT)
+          backends = @doc.backends.sort.map { |d| d[1]}
+
+
+          out.puts "<div class='quick-jump'>"
+          out.puts "Quick jump to a specific backend:\n"
+          out.puts "<ul>\n"
+          for b in backends
+            out.puts "<li><a href='#backend-#{b.name}'>#{b.name}</a></li>\n"
+          end
+          out.puts "</ul>\n"
+          out.puts "</div>"
+ 
+          for b in backends
+            out.puts
+            out.puts "<h3 id='backend-#{b.name}' class='backend'><code>#{b.name}</code>: #{b.long_name}</h3>\n"
+            out.puts markup_to_html(b.description)
+            out.puts
+            for param in b.param_list
+              out.puts "<h4 id='backend-#{b.name}-#{param.name}'>Parameter: #{param.name}</h4>"
+              out.puts "<p><code>/#{param.name}=<a href='#{@types_url}#type-#{param.type.name}'>#{param.type.name}</a></p>"
+              out.puts markup_to_html(param.description)
+            end
+          end
+        end
+        
+
         protected
 
         # The string that represents a full command
@@ -182,7 +218,7 @@ module CTioga2
         # equivalent in HTML format. Alternativelely, it can take a
         # String and feed it to MarkedUpText.
         #
-        # TODO: escape correctly the produced HTML code...
+        # \todo escape correctly the produced HTML code...
         def markup_to_html(items)
           if items.is_a? String 
             mup = MarkedUpText.new(@doc, items)
@@ -192,7 +228,19 @@ module CTioga2
           for it in items
             case it
             when MarkedUpText::MarkupText
-              str << it.to_s
+              el = nil
+              case it.kind
+              when :code
+                el = "code"
+              end
+              if el
+                prefix = "<#{el}>"
+                suffix = "</#{el}>"
+              else
+                prefix = ""
+                suffix = ""
+              end
+              str << "#{prefix}#{it.to_s}#{suffix}"
             when MarkedUpText::MarkupLink
               case it.target
               when Command
@@ -201,6 +249,10 @@ module CTioga2
                 link = "#{@commands_url}#group-#{it.target.id}"
               when CommandType
                 link = "#{@types_url}#type-#{it.target.name}"
+              when Data::Backends::BackendDescription
+                link = "#{@backends_url}#backend-#{it.target.name}"
+              when String       # plain URL target
+                link = "#{it.target}"
               else
                 raise "The link target should be either a group, a command or a type, but is a #{it.target.class}"
               end