Print the help when --help or -h is unexpectedly encountered.

Most binaries used on Linux support the '--help' argument, this
is a convention specified by the [GNU project][1], as well as in
the [clig][2].

Currently, adding `--help` after a failing command gives an error,
following by an note at the end on how to get the help. Actually
getting the help usually involves pressing the up arrow, removing the
erroneous `--help` at the end, moving the cursor to after `picotool`
to insert `help` and then succesfully printing out the help.

This commit adds a new error type to the parser to distinguish
between parse errors, and errors that can be identified as an attempt
to obtain the help. This help error is raised only if an unexpected
argument called `--help` is encountered, or an unexpected option `-h`.

In the `main.cpp` this specific error is now caught and handled on
appropriately, still relying on the outer catch problematic parse
errors, like using command names that don't exist.

[1]: https://www.gnu.org/prep/standards/html_node/Command_002dLine-Interfaces.html
[2]: https://clig.dev/#help

Author: iwanders

cli.h

@@ -61,6 +61,10 @@ namespace cli {
     private:
         string _what;
     };
+    /// A parse error that can be identified as a user trying to obtain the help.
+    struct help_error: parse_error {
+      using parse_error::parse_error;
+    };
 
     struct group;
     template<typename T>
@@ -1023,6 +1027,13 @@ namespace cli {
             }
         }
         if (!ms.remaining_args.empty()) {
+            // Check if any argument can be identified as the user searching for the help.
+            for (const auto &remaining : ms.remaining_args) {
+                if (remaining == "-h" || remaining == "--help") {
+                    throw help_error("unexpected argument: "+remaining);
+                }
+            }
+
             if (ms.remaining_args[0].find('-')==0) {
                 throw parse_error("unexpected option: "+ms.remaining_args[0]);
             } else {

main.cpp

@@ -1618,8 +1618,16 @@ int parse(const int argc, char **argv) {
             no_global_header = true;
             throw cli::parse_error("unknown command '" + args[0] + "'");
         }
-        cli::match(settings, selected_cmd->get_cli(), args);
-    } catch (std::exception &e) {
+
+        // If a parse error occurs, and it is a cry for help, print the help instead.
+        try {
+          cli::match(settings, selected_cmd->get_cli(), args);
+        } catch (const cli::help_error &e) { 
+            help_mode = true;
+            usage();
+            return 1;
+        }
+    } catch (const std::exception &e) {
         fos.wrap_hard();
         fos << "ERROR: " << e.what() << "\n\n";
         usage();