Improve documentation of SinkSH

Summary:
- Add support for positional arguments, options, flags in the syntax tree
- Add automatic generation of usage string

TODO:

- ~~Better document the `--reduce` option in the `list` command~~
- Get the parent command for sub-commands so we could show help for `trace on` and not just `on`
- Pass the syntax to the implementation of the command so commands can easily show help on wrong usage. Also, SyntaxTree could do automatic input validation in the future, this could also help.
- Even with the new documentation, some command could still be confusing. Should we add some usage examples?

Reviewers: cmollekopf

Reviewed By: cmollekopf

Tags: #sink

Differential Revision: https://phabricator.kde.org/D14547

1 files changed, 23 insertions, 0 deletions

diff --git a/sinksh/syntaxtree.h b/sinksh/syntaxtree.h
index ce28548..3d90288 100644
--- a/sinksh/syntaxtree.h
+++ b/sinksh/syntaxtree.h
@@ -42,10 +42,33 @@ public:
     Syntax(const QString &keyword, const QString &helpText = QString(),
         std::function<bool(const QStringList &, State &)> lambda = std::function<bool(const QStringList &, State &)>(), Interactivity interactivity = NotInteractive);
 
+    struct Argument {
+        QString name;
+        QString help;
+        bool required = true;
+        bool variadic = false;
+    };
+
+    struct ParameterOptions {
+        QString name;
+        QString help;
+        bool required = false;
+    };
+
+    // TODO: add examples?
     QString keyword;
     QString help;
+    QVector<Argument> arguments;
+    QMap<QString, ParameterOptions> parameters;
+    QMap<QString, QString> flags;
     Interactivity interactivity;
 
+    void addPositionalArgument(const Argument &);
+    void addParameter(const QString &name, const ParameterOptions &options);
+    void addFlag(const QString &name, const QString &help);
+
+    QString usage() const;
+
     /**
      * This function will be called to execute the command.
      *