ctioga2 0.0 → 0.1

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

@@ -16,24 +16,41 @@ require 'ctioga2/commands/commands'
 
 module CTioga2
 
-  Version::register_svn_info('$Revision: 36 $', '$Date: 2009-05-04 21:23:15 +0200 (Mon, 04 May 2009) $')
+  Version::register_svn_info('$Revision: 238 $', '$Date: 2011-01-23 21:58:08 +0100 (Sun, 23 Jan 2011) $')
 
   module Commands
 
-    # The base of the 'self-documentation' of CTioga2
     module Documentation
 
       # This class provides facilities to display information
       class Introspection
         
         # Display all known commands, along with their definition place
-        def list_commands(raw = false)
-          puts "Known commands:" unless raw
+        def list_commands(format = :pretty)
           cmds = Interpreter::commands
           names = cmds.keys.sort
-          if raw
+          case format
+          when :list
             puts names
+          when :yaml
+            require 'yaml'
+            commands = {}
+            for n in names
+              cmd = cmds[n]
+              command = {}
+              command['name'] = n
+              f,l = cmd.context
+              command['file'] = f
+              command['line'] = l.to_i
+              command['long_option'] = cmd.long_option
+              command['short_option'] = cmd.short_option
+              command['short_description'] = cmd.short_description
+              command['long_description'] = cmd.long_description
+              commands[n] = command
+            end
+            puts YAML.dump(commands)
           else
+            puts "Known commands:" 
             max = names.inject(0) {|m,x| [m,x.size].max}
             max2 = names.inject(0) {|m,x| [m,cmds[x].long_option.size].max}
             for n in names
@@ -112,17 +129,36 @@ module CTioga2
 
       end
 
+      InternalFormatRE = {
+        /list|raw/i => :list,
+        /default|pretty/i => :pretty,
+        /yaml/i => :yaml
+      }
+      
+      
+      InternalFormatType = CmdType.new('internal-format',
+                                       { :type => :re_list,
+                                         :list => InternalFormatRE}, <<EOD)
+Output format for internals.
+EOD
+
+
       IntrospectionGroup = 
         CmdGroup.new('introspection', "Introspection",
-                     "Displays information about the internals of ctioga2",
-                     100, true)
+                     <<EOD, 100)
+Commands displaying information about the internals of ctioga2, such 
+as known types/commands/backends...
+EOD
 
+      TypeOption = {'format' => CmdArg.new('internal-format')}
       RawOption = {'raw' => CmdArg.new('boolean')}
 
       ListCommandsCmd = 
         Cmd.new('list-commands', nil, '--list-commands',
-                [], RawOption) do |p, opts|
-        Introspection.new.list_commands(opts['raw'])
+                [], RawOption.dup.update(TypeOption)) do |p, opts|
+        opts['format'] = :list if opts['raw']
+        
+        Introspection.new.list_commands(opts['format'])
       end
 
       ListCommandsCmd.describe("List known commands",

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

@@ -18,7 +18,7 @@ require 'ctioga2/commands/parsers/command-line'
 
 module CTioga2
 
-  Version::register_svn_info('$Revision: 40 $', '$Date: 2009-05-08 00:45:47 +0200 (Fri, 08 May 2009) $')
+  Version::register_svn_info('$Revision: 213 $', '$Date: 2010-12-31 02:50:00 +0100 (Fri, 31 Dec 2010) $')
 
   module Commands
 
@@ -45,6 +45,7 @@ module CTioga2
         #
         # NO... We should *input* a manual page, and spit out
         # replacement texts.
+        #
         def write_manual_page(version, input, out = STDOUT)
           passed_header = false
           if input.is_a? String
@@ -67,12 +68,13 @@ module CTioga2
               passed_header = true
             when /^#{RoffCommentRE}\s*write-commands\s*$/
               write_commands(out)
+              # \todo add a write-backends command....
             when /^#{RoffCommentRE}\s*write-group:\s*(.*)\s*$/
               id = $1
               if @groups[id]
                 write_group(out, g)
               else
-                warn "Unkown group: #{id}"
+                warn { "Unkown group: #{id}" }
               end
             when /^#{RoffCommentRE}\s*write-types\s*$/
               write_types(out)
@@ -97,12 +99,12 @@ module CTioga2
         # equivalent in roff format. Alternativelely, it can take a
         # String and feed it to MarkedUpText.
         #
-        # TODO: make sure things are escaped the way they should be.
+        # \todo make sure things are escaped the way they should be.
         #
         # if _inside_cmds_ is true, additional indentation is added
         # for the lists, so that is looks neat in the end.
         #
-        # TODO: try to be more clever about spaces in the target
+        # \todo try to be more clever about spaces in the target
         # file. (does not matter too much for the output of man)
         def markup_to_man(items, inside_cmds = true)
           if items.is_a? String 
@@ -242,7 +244,7 @@ module CTioga2
         def write_type(out, type, indent = "")
           out.puts ".TP #{indent}"
           out.puts ".I #{type.name}"
-          out.puts "#{type.description}"
+          out.puts markup_to_man(type.description)
         end
 
         # Returns the header string

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

@@ -16,14 +16,18 @@ require 'ctioga2/log'
 
 module CTioga2
 
-  Version::register_svn_info('$Revision: 84 $', '$Date: 2009-06-12 00:09:41 +0200 (Fri, 12 Jun 2009) $')
+  Version::register_svn_info('$Revision: 216 $', '$Date: 2010-12-31 16:18:17 +0100 (Fri, 31 Dec 2010) $')
 
   module Commands
 
     module Documentation
 
       # The documentation strings are written in a simple markup
-      # language. 
+      # language.
+      #
+      # \todo we should provide tags to specifically mark TODO items
+      # in documentation, in such a way that it would be easy to make
+      # a list of them, and possibly ignore it for output.
       class MarkedUpText
 
         # Do we really need logging ?
@@ -48,16 +52,18 @@ module CTioga2
         end
 
         # A markup item representing plain text.
-        #
-        # TODO: in to_s a simple word-wrapping algorithm could be
-        # used.
         class MarkupText < MarkupItem
           # The text
           attr_accessor :text
           
-          def initialize(doc, text = "", strip = true)
+          # The kind of markup, nil means no markup
+          attr_accessor :kind
+          
+          def initialize(doc, text = "", strip = true, 
+                         kind = nil)
             super(doc)
             @text = text
+            @kind = kind
             if strip
               @text.gsub!(/\n/, " ")
             end
@@ -104,15 +110,23 @@ module CTioga2
           attr_accessor :target
           
           # _target_ is the name of the target, which can be of _type_
-          # 'group', 'command' and 'type'.
+          # 'group', 'command', 'backend', 'type' and 'url'
           def initialize(doc, target, type)
             super(doc)
-            @target = doc.send("#{type}s")[target]
+            if type =~ /url/
+              @target = target
+            else
+              @target = doc.send("#{type}s")[target]
+            end
           end
 
           def to_s
-            if @target
-              return @target.name
+            if @target 
+              begin
+                return @target.name
+              rescue NoMethodError
+                return @target
+              end
             else
               return "unknown"
             end
@@ -215,6 +229,9 @@ module CTioga2
         # * a {group: ...} or {type: ...} or {command: ...} is a link
         #   to the element.
         # * a blank line marks a paragraph break.
+        #
+        # \todo Add elements to do some inline markup (such as bold,
+        # code, italics; mostly code for now will do very fine)
         def parse_from_string(string)
           @last_type = nil
           @last_string = ""
@@ -263,15 +280,25 @@ module CTioga2
 
         protected 
 
+        # A few constants to help writing out the paragraph markup
+        LinkRE = /\{(group|type|command|backend|url):\s*([^}]+?)\s*\}/
+
+        MarkOnceRE = /@([^@]+)@/
+        
+
         # Parses the markup found within a paragraph (ie: links and
         # other text attributes, but not verbatim, list or other
         # markings) and returns an array containing the MarkupItem
         # elements.
         def parse_paragraph_markup(doc, string)
           els = []
-          while string =~ /\{(group|type|command):\s*([^}]+?)\s*\}/
+          while string =~ /#{LinkRE}|#{MarkOnceRE}/
             els << MarkupText.new(doc, $`)
-            els << MarkupLink.new(doc, $2, $1) 
+            if $1
+              els << MarkupLink.new(doc, $2, $1) 
+            elsif $3
+              els << MarkupText.new(doc, $3, true, :code)
+            end
             string = $'
           end
           els << MarkupText.new(doc, string)

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

@@ -0,0 +1,70 @@
+## \file wordwrap.rb small word-wrapping utility
+# 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/commands/commands'
+require 'ctioga2/commands/parsers/command-line'
+
+module CTioga2
+
+  Version::register_svn_info('$Revision: 131 $', '$Date: 2010-01-14 22:51:09 +0100 (Thu, 14 Jan 2010) $')
+
+  module Commands
+
+    module Documentation
+
+
+      # A small utility class to do word wrapping.
+      #
+      # \todo Maybe this belongs in Utils ?
+      class WordWrapper
+        
+        # A regex matching word separation.
+        attr_accessor :word_sep
+
+        # What to replace the separator with
+        attr_accessor :new_sep
+
+        def initialize(ws = /\s+/, ns = " ")
+          @word_sep = ws
+          @new_sep = ns
+        end
+
+        # Split strings into an array of string whose length is each
+        # less than _cols_
+        def wrap(str, cols)
+          words = str.split(@word_sep)
+          lines = [words.shift]
+          while w = words.shift
+            if (lines.last.size + w.size + @new_sep.size) <= cols
+              lines.last.concat("#{@new_sep}#{w}")
+            else
+              lines << w
+            end
+          end
+          return lines
+        end
+
+        # Calls #wrap for default values of the parameters
+        def self.wrap(str, cols)
+          return WordWrapper.new.wrap(str, cols)
+        end
+
+      end
+
+
+    end
+
+  end
+
+end

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

@@ -17,7 +17,7 @@ require 'ctioga2/commands/parsers/file'
 
 module CTioga2
 
-  Version::register_svn_info('$Revision: 55 $', '$Date: 2009-05-27 00:01:34 +0200 (Wed, 27 May 2009) $')
+  Version::register_svn_info('$Revision: 155 $', '$Date: 2010-06-21 21:41:32 +0200 (Mon, 21 Jun 2010) $')
 
   module Commands
  
@@ -27,12 +27,15 @@ module CTioga2
                    "General scope commands", 1000)
     
 
+    CommandLineHelpOptions = {
+      'pager' => CmdArg.new('boolean')
+    }
     
     # Display help on the command-line
     CommandLineHelpCommand = 
       Cmd.new("command-line-help", 'h', 
-              "--help", [ ]) do |plotmaker|
-      plotmaker.interpreter.doc.display_command_line_help
+              "--help", [ ], CommandLineHelpOptions) do |plotmaker, options|
+      plotmaker.interpreter.doc.display_command_line_help(options)
       exit 
     end
     
@@ -85,7 +88,7 @@ EOH
 
     # Write debugging information.
     #
-    # TODO: this should be the place where a lot of customization of
+    # \todo this should be the place where a lot of customization of
     # the debug output could go - including channels or things like
     # that. To be seen later on...
     DebugLogging = 

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

@@ -15,7 +15,7 @@ require 'ctioga2/utils'
 
 module CTioga2
 
-  Version::register_svn_info('$Revision: 101 $', '$Date: 2009-07-21 23:29:59 +0200 (Tue, 21 Jul 2009) $')
+  Version::register_svn_info('$Revision: 223 $', '$Date: 2011-01-11 01:07:48 +0100 (Tue, 11 Jan 2011) $')
 
   module Commands
  
@@ -73,16 +73,29 @@ EOD
     # Data-point. Unlike other types, this one needs to be processed
     # afterwards, actually, since an access to a plotmaker object is
     # necessary.
-    DataPointType = CmdType.new('data-point', :string, <<EOD)
+    DataPointType = CmdType.new('data-point', :data_point, <<EOD)
 A point from a Dataset.
 
-TODO: document ;-)...
+\todo document ;-)...
 EOD
 
+    # A LaTeX font
+    LaTeXFontType = CmdType.new('latex-font', :latex_font, <<EOD)
+A LaTeX font.
 
+\todo document !
+EOD
+
+    # A color map
+    ColorMapType = CmdType.new('colormap', :colormap, <<EOD)
+A Z color map
+
+\todo document !
+EOD
 
     # This ones get here since they mess up with syntax highlighting
 
+
     # A stored dataset.
     StoredDatasetType = CmdType.new('stored-dataset', 
                                     :string, <<EOD)
@@ -96,20 +109,22 @@ EOD
 
     # Something meant to be fed to PlotStyle#get_axis_style
     AxisType = CmdType.new('axis', :string, <<EOD)
-The name of an axis. It can be:
- * left, top, bottom or right;
- * x, xaxis, y, yaxis, which return one of the above depending 
-   on the preferences of the current plot;
- * one of the named axes.
+The name of the axis of a plot. It can be:
+ * @left@, @top@, @bottom@ or @right@;
+ * @x@, @xaxis@, @y@, @yaxis@, which return one of the above depending 
+   on the preferences of the current plot (see {command: xaxis} and 
+   {command: yaxis} to change them);
+ * one of the named axes, such as the ones created by 
+   {command: new-zaxis}.
 EOD
 
     # Something meant to be fed to PlotStyle#get_label_style
     LabelType = CmdType.new('label', :string, <<EOD)
 The name of an label. It can be:
- * title to mean the current plot's title.
- * axis_tick or axis_ticks or simply axis, where axis is a a valid
-   {type: axis}.  It means the ticks of the given axis.
- * axis_label, same as above but targets the label of the given axis.
+ * @title@ to mean the current plot's title.
+ * @axis_tick@ or @axis_ticks@ or simply @axis@, where @axis@ is a a valid
+   {type: axis}. It designates the ticks of the named axis.
+ * @axis_label@, same as above but targets the label of the named axis.
 EOD
 
     

data/lib/ctioga2/commands/interpreter.rb

@@ -20,7 +20,7 @@ require 'ctioga2/commands/doc/doc'
 
 module CTioga2
 
-  Version::register_svn_info('$Revision: 18 $', '$Date: 2009-04-28 23:43:54 +0200 (Tue, 28 Apr 2009) $')
+  Version::register_svn_info('$Revision: 155 $', '$Date: 2010-06-21 21:41:32 +0200 (Mon, 21 Jun 2010) $')
 
   # This module contains the real core of ctioga2: a set of classes
   # that implement the concept of commands. Each command translates
@@ -169,7 +169,7 @@ module CTioga2
       # snapshot of the current commands known to the system, so
       # please instantiate it last.
       #
-      # TODO: probably this behavior is not really desired.
+      # \todo probably this behavior is not really desired.
       # Easy to fix.
       def initialize(target)
         @plotmaker_target = target

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

@@ -17,7 +17,7 @@ require 'ctioga2/commands/commands'
 
 module CTioga2
 
-  Version::register_svn_info('$Revision: 2 $', '$Date: 2009-04-25 14:03:30 +0200 (Sat, 25 Apr 2009) $')
+  Version::register_svn_info('$Revision: 151 $', '$Date: 2010-06-19 23:45:20 +0200 (Sat, 19 Jun 2010) $')
 
   module Commands
 
@@ -164,13 +164,17 @@ module CTioga2
           end
           
           # We try and go fishing for options, in the form
-          # /option=stuff.
-          while argv.first =~ /^\/([\w-]+)=(.*)/
+          # /option=stuff, or /option stuff...
+          while argv.first =~ /^\/([\w-]+)(?:=(.*))?$/
             if command.has_option? $1
-              options[$1] = $2
               argv.shift
+              if $2
+                options[$1] = $2
+              else
+                options[$1] = argv.shift
+              end
             else
-              warn "Argument #{argv.first} looks like an option, but does not match any of the command #{command.name}"
+              warn { "Argument #{argv.first} looks like an option, but does not match any of the command #{command.name}" }
               break
             end
           end