Deprecate ComptimeClap in favor of parseExv0.3.0

1 files changed, 43 insertions, 0 deletions

diff --git a/example/simple-ex.zig b/example/simple-ex.zig
new file mode 100644
index 0000000..d6ecc44
--- /dev/null
+++ b/example/simple-ex.zig
@@ -0,0 +1,43 @@
+const std = @import("std");
+const clap = @import("clap");
+
+const debug = std.debug;
+
+pub fn main() !void {
+    const allocator = std.heap.page_allocator;
+
+    // First we specify what parameters our program can take.
+    // We can use `parseParam` to parse a string to a `Param(Help)`
+    const params = comptime [_]clap.Param(clap.Help){
+        clap.parseParam("-h, --help             Display this help and exit.              ") catch unreachable,
+        clap.parseParam("-n, --number <NUM>     An option parameter, which takes a value.") catch unreachable,
+        clap.parseParam("-s, --string <STR>...  An option parameter which can be specified multiple times.") catch unreachable,
+        clap.parseParam("<POS>...") catch unreachable,
+    };
+
+    // We then initialize an argument iterator. We will use the OsIterator as it nicely
+    // wraps iterating over arguments the most efficient way on each os.
+    var iter = try clap.args.OsIterator.init(allocator);
+    defer iter.deinit();
+
+    // Initalize our diagnostics, which can be used for reporting useful errors.
+    // This is optional. You can also just pass `null` to `parser.next` if you
+    // don't care about the extra information `Diagnostics` provides.
+    var diag: clap.Diagnostic = undefined;
+
+    var args = clap.parseEx(clap.Help, &params, allocator, &iter, &diag) catch |err| {
+        // Report useful error and exit
+        diag.report(std.io.getStdErr().outStream(), err) catch {};
+        return err;
+    };
+    defer args.deinit();
+
+    if (args.flag("--help"))
+        debug.warn("--help\n", .{});
+    if (args.option("--number")) |n|
+        debug.warn("--number = {}\n", .{n});
+    for (args.options("--string")) |s|
+        debug.warn("--string = {}\n", .{s});
+    for (args.positionals()) |pos|
+        debug.warn("{}\n", .{pos});
+}