Changeset 93

Timestamp:

02/04/07 00:56:59 (2 years ago)

Author:

KirkMcDonald

Message:

Default arguments.

Files:

• misc/optparse.d (modified) (6 diffs)
• misc/optparse.html (modified) (5 diffs)
• misc/opttest.d (modified) (2 diffs)

misc/optparse.d

@@ -26 +26 @@
-
-import std.stdio : writefln, writef;
-
+, toString
-import std.c.stdlib : exit, EXIT_FAILURE, EXIT_SUCCESS;
-import std.conv : toInt, ConvError;
@@ -180 +180 @@
-    char[] name, argname;
-    char[] const_value;
+
+    char[] default_string;
+    int default_value;
+    bool default_flag, has_default;
+
-    OptionCallbackArg callback;
-    OptionCallbackInt int_callback;
@@ -203 +208 @@
-        this.name = name;
-        this.argname = toupper(name);
+        this.default_string = "";
+        this.default_value = 0;
+        this.default_flag = false;
-
-        // Perform sanity checks.
@@ -265 +273 @@
-        return result;
-    }
+    //enum Action { Store, StoreConst, Append, AppendConst, Count, SetTrue, SetFalse, Callback, CallbackFancy, Help }
+    void issue_default(Options results) {
+        // Only set the default if the option doesn't already have a value.
+        char[][]* val = this.name in results.opts;
+        switch (this.action) {
+            case Action.Store, Action.Append:
+                if (val !is null) return;
+                if (this.type == ArgType.String) {
+                    results.opts[name] = [default_string];
+                } else {
+                    results.opts[name] = [.toString(default_value)];
+                }
+                break;
+            case Action.StoreConst, Action.AppendConst:
+                if (val !is null) return;
+                results.opts[name] = [default_string];
+                break;
+            case Action.SetTrue, Action.SetFalse:
+                if (val !is null) return;
+                if (default_flag) {
+                    results.opts[name] = ["1"];
+                } else {
+                    results.opts[name] = ["0"];
+                }
+                break;
+            default:
+                return;
+        }
+    }
-    // Does whatever this option is supposed to do.
-    void perform_action(OptionParser parser, Options results, inout char[][] args, inout int idx, char[] arg) {
@@ -338 +375 @@
-    Option argName(char[] argname) {
-        this.argname = argname;
+        return this;
+    }
+    Option def(char[] val) {
+        if (
+            (this.type != ArgType.String || (this.action != Action.Store && this.action != Action.Append)) &&
+            this.action != Action.StoreConst && this.action != Action.AppendConst
+        )
+            throw new OptionError("Cannot specify string default for non-string option '"~this.name~"'");
+        this.has_default = true;
+        this.default_string = val;
+        return this;
+    }
+    Option def(int val) {
+        if (this.type != ArgType.Integer || (this.action != Action.Store && this.action != Action.Append))
+            throw new OptionError("Cannot specify integer default for non-integer option '"~this.name~"'");
+        this.has_default = true;
+        this.default_value = val;
+        return this;
+    }
+    Option def(bool val) {
+        if (this.action != Action.SetTrue && this.action != Action.SetFalse)
+            throw new OptionError("Cannot specify boolean default for non-flag option '"~this.name~"'");
+        this.has_default = true;
+        this.default_flag = val;
-        return this;
-    }
@@ -552 +613 @@
-                }
-            }
+        }
+        foreach (o; this.options) {
+            o.issue_default(options);
-        }
-        return options;

misc/optparse.html

@@ -135 +135 @@
-<blockquote><tt>int num = options.value("number");</tt></blockquote>
-
-
+and no default was supplied with <tt>def</tt>, 
-
-<h4>Example</h4>
@@ -176 +176 @@
-<blockquote><tt>int[] values = options.value_list("value");</tt></blockquote>
-
-
+and no default was provided with <tt>def</tt>, 
-
-<h4>Example</h4>
@@ -210 +210 @@
-
-<h4>Results</h4>
-
+and no default was provided with <tt>def</tt>, 
-
-<p>At this time, only strings are supported as constant values.</p>
@@ -274 +274 @@
-<blockquote><tt>bool flag = options.flag("flag");</tt></blockquote>
-
-
+and no default was provided with <tt>def</tt>, 
-
-<h4>Example</h4>
@@ -574 +574 @@
-<dt><tt>Option argName(char[] argname);</tt></dt> <dd>When an option accepts an argument, the <tt>Help</tt> action will indicate this by putting something informative after the option. By default, it uses the all-caps form of the option's name. You can supply a different string to this method, which will be converted to all-caps.</dd>
-
+<dt><tt>Option def(char[] val);</tt></dt>
+<dt><tt>Option def(int val);</tt></dt>
+<dt><tt>Option def(bool val);</tt></dt>
+<dd>Supplies the default value for an option. This only applies to the following actions: <tt>Store</tt>, <tt>Append</tt>, <tt>StoreConst</tt>, <tt>AppendConst</tt>, <tt>SetTrue</tt>, and <tt>SetFalse</tt>. In the case of the two "append" actions, supplying a default will result in a single-element array with the default in it, in the event that the option is never specified on the command-line. If multiple options have the same name, only the first default supplied is used. An exception will be raised if (for example) an integer default value is provided to an option which expects a string argument.</dd>
+
-<dt><tt>bool hasArg();</tt></dt> <dd>Returns whether this option accepts an argument.</dd>
-

misc/opttest.d

@@ -10 +10 @@
-    writefln("number list: ", options.value_list("list"));
-    writefln("switch:      ", options.flag("switch"));
+    writefln("turn-off:    ", options.flag("turn"));
+    writefln("color:       ", options["color"]);
-    writefln("args:        ", options.args);
-}
@@ -33 +35 @@
-    parser.add_option(["--enable"], "switch", Action.SetTrue).help("Enables the switch.");
-    parser.add_option(["--disable"], "switch", Action.SetFalse).help("Disables the switch.");
+    parser.add_option(["--turn-off"], "turn", Action.SetFalse).help("Tests default values for flags.").def(true);
+    parser.add_option(["--set-blue"], "color", Action.StoreConst, "blue").help("Tests default values for consts.").def("green");
-    parser.add_option(["-V", "--value"], ArgType.Integer).help("Stores a single number").argName("NUMBER");
-    parser.add_option(["-l", "--list"], Action.Append, ArgType.Integer).help("Adds numbers to a list.").argName("NUMBER");