Changeset 84

Timestamp:

01/14/07 06:20:39 (2 years ago)

Author:

KirkMcDonald

Message:

Added doc-comments, changed to Tango naming conventions.

Files:

• misc/tango/optparse.d (modified) (27 diffs)
• misc/tango/opttest.d (modified) (3 diffs)

misc/tango/optparse.d

@@ -22 +22 @@
-/**
- * Command-line option parsing, in the style of Python's optparse.
+ *
+ * Refer to the complete docs for more information.
- */
-module optparse;
@@ -83 +85 @@
-}
-
-
+/
-class OptionError : Exception {
-    this(char[] msg) { super(msg); }
@@ -92 +94 @@
-}
-
+/++
+This class represents the results after parsing the command-line.
++/
-class Options {
-    char[][][char[]] opts;
-    int[char[]] counted_opts;
+    /// By default, leftover arguments are placed in this array.
-    char[][] args;
-
+    /// Retrieves the results of the Store and StoreConst actions.
-    char[] opIndex(char[] opt) {
-        char[][]* o = opt in opts;
@@ -105 +112 @@
-        }
-    }
+    /// Retrieves the results of the Store action, when the type is Integer.
-    int value(char[] opt) {
-        char[][]* o = opt in opts;
@@ -113 +121 @@
-        }
-    }
+    /// Retrieves the results of the Append and AppendConst actions.
-    char[][] list(char[] opt) {
-        char[][]* o = opt in opts;
@@ -121 +130 @@
-        }
-    }
-
+
+
-        char[][]* o = opt in opts;
-        int[] l;
@@ -132 +142 @@
-        return l;
-    }
+    /// Retrieves the results of the Count action.
-    int count(char[] opt) {
-        int* c = opt in counted_opts;
@@ -140 +151 @@
-        }
-    }
+    /// Retrieves the results of the SetTrue and SetFalse actions.
-    bool flag(char[] opt) {
-        char[][]* o = opt in opts;
@@ -151 +163 @@
-
-// Options, args, this opt's index in args, name[, arg]
+///
-alias void delegate(Options, inout char[][], inout int, char[], char[]) OptionCallbackFancyArg;
+///
-alias void delegate(Options, inout char[][], inout int, char[], int)    OptionCallbackFancyInt;
+///
-alias void delegate(Options, inout char[][], inout int, char[])         OptionCallbackFancy;
-
+///
-alias void delegate(char[]) OptionCallbackArg;
+///
-alias void delegate(int)    OptionCallbackInt;
+///
-alias void delegate()       OptionCallback;
-
@@ -169 +187 @@
- * CallbackVoid: dg
-*/
-
-
+
+
+
+
-
-ArgType defaultType(Action action) {
@@ -183 +203 @@
-}
-
+/++
+This class represents a single command-line option.
++/
-class Option {
-    char[][] shortopts, longopts;
@@ -275 +298 @@
-    }
-    // Does whatever this option is supposed to do.
-_a
+A
-        int i;
-        if (this.type == ArgType.Integer) {
@@ -333 +356 @@
-                break;
-            case Action.Help:
-_t
+T
-                exit(EXIT_SUCCESS);
-                break;
-        }
-    }
+    /// Returns whether this option accepts an argument.
-    bool hasArg() {
-        return this.type != ArgType.None;
-    }
+    /// Sets the help text for this option.
-    Option help(char[] help) {
-        this.helptext = help;
-        return this;
-    }
+    /// Sets the name of this option's argument, if it has one.
-    Option argName(char[] argname) {
-        this.argname = argname;
@@ -376 +402 @@
-}
-
+/++
+This class is used to define a set of options, and parse the command-line
+arguments.
++/
-class OptionParser {
-    OptionCallbackArg leftover_cb;
+    /// An array of all of the options known by this parser.
-    Option[] options;
-
+
+
+
-    private void delegate(char[]) error_callback;
-
@@ -388 +421 @@
-    }
-
-
+
+
-        error_callback = dg;
-    }
-_opt_e
+OptE
-        error("Unknown argument '"~opt~"'");
-    }
-_arg_e
+ArgE
-        error("'"~opt~"' option expects an argument.");
-    }
+    /// Displays an error message and terminates the program.
-    void error(char[] err) {
-        if (error_callback !is null) {
-            error_callback(err);
-        } else {
-_t
+T
-            Stdout.println(err);
-        }
@@ -409 +444 @@
-        int i;
-        uint ate;
-
+.
-        if (ate != s.length)
-            error("Could not convert '"~s~"' to an integer.");
@@ -415 +450 @@
-    }
-
-
+
+
-        int optWidth;
-        char[][] optStrs;
@@ -456 +492 @@
-        return path[idx+1 .. $];
-    }
-_program_n
+ProgramN
-        version(Windows) {
-            // (Unicode note: ".exe" only contains 4 code units, so this slice
@@ -467 +503 @@
-        return getBaseName(path);
-    }
-
-
+
+
+
-        args = args[1 .. $];
-        Options options = new Options;
@@ -521 +558 @@
-                match = matches(newopt);
-                if (match is null) {
-_opt_e
+OptE
-                }
-                if (match.hasArg) {
-_arg_e
+ArgE
-                    arg = args[i+1];
-                    ++i;
@@ -530 +567 @@
-                    arg = null;
-                }
-_a
+A
-            } else if (opt.startswith("-")) {
-                if (opt.length >= 2) {
@@ -538 +575 @@
-                        match = matches(newopt);
-                        if (match is null) {
-_opt_e
+OptE
-                        }
-                        if (match.hasArg) {
@@ -544 +581 @@
-                            // next element of args for the arg.
-                            if (j == opt32.length-1) {
-_arg_e
+ArgE
-                                arg = args[i+1];
-                                ++i;
@@ -551 +588 @@
-                            } else {
-                                arg = .toUtf8(opt32[j+1 .. $]);
-_a
+A
-                                break;
-                            }
@@ -557 +594 @@
-                            arg = null;
-                        }
-_a
+A
-                    }
-                } else {
-_opt_e
+OptE
-                }
-            } else {
@@ -573 +610 @@
-    }
-
-
+
+
+
+
+
-        this.leftover_cb = dg;
-    }
-
+
+
-        this.options ~= option;
-        return option;
-    }
-    //                    options  action             name  type                       const_value  dga   dgv   dgi   fdga  fdgi  fdg
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-    }
-    // Although users certainly /can/ call this, all those overloads are there
-    // for a reason.
-_o
+O
-        char[][] options, 
-        Action action, char[] name, ArgType type, char[] const_value,
@@ -684 +745 @@
-            else
-                throw new OptionError(
-_o
+O
-                );
-        }

misc/tango/opttest.d

@@ -22 +22 @@
-    Stdout.formatln("verbosity:   {0}", options.count("verbose"));
-    Stdout.formatln("value:       {0}", options.value("value"));
-_l
+L
-    Stdout.formatln("switch:      {0}", options.flag("switch"));
-    Stdout.formatln("args:        {0}", format_arr(options.args));
@@ -29 +29 @@
-int main(char[][] args) {
-    format = new Format!(char);
-
+//
-    auto parser = new OptionParser("A test suite for optparser.");
-_o
-_o
-_o
+O
+O
+O
-        Stdout.formatln("callback encountered");
-    }).help("Calls a callback.");
-_o
+O
-        Stdout.formatln("number callback: {0} * 2 = {1}", i, i*2);
-    }).help("Calls a callback with a number.");
-    // A fancy callback
-_o
+O
-        Stdout.formatln("Current file: {0}", opts["file"]);
-        Stdout.formatln("Remaining args: {0}", a[i+1 .. $]);
@@ -47 +47 @@
-        Stdout.formatln("This arg's name: {0}", name);
-    }).help("Tests optparse's fancy callbacks.");
-_o
-_o
-_o
-_o
-_o
-_o
-_args
+O
+O
+O
+O
+O
+O
+
-
-    print_opts(options);