HACKING: Update URL to Linux kernel coding style.

[sigrok-cli.git] / options.c

diff --git a/options.c b/options.c
index 9a0bce6859306562c849a722f871577557663d07..ca16e4c18a386f88981379b8853474d2aad93361 100644 (file)
--- a/options.c
+++ b/options.c
@@ -17,10 +17,12 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-#include "sigrok-cli.h"
+#include <config.h>
 #include <glib.h>
+#include "sigrok-cli.h"
 
 gboolean opt_version = FALSE;
+gboolean opt_list_supported = FALSE;
 gint opt_loglevel = SR_LOG_WARN; /* Show errors+warnings by default. */
 gboolean opt_scan_devs = FALSE;
 gboolean opt_wait_trigger = FALSE;
@@ -31,9 +33,8 @@ gchar *opt_config = NULL;
 gchar *opt_channels = NULL;
 gchar *opt_channel_group = NULL;
 gchar *opt_triggers = NULL;
-gchar *opt_pds = NULL;
+gchar **opt_pds = NULL;
 #ifdef HAVE_SRD
-gchar *opt_pd_stack = NULL;
 gchar *opt_pd_annotations = NULL;
 gchar *opt_pd_meta = NULL;
 gchar *opt_pd_binary = NULL;
@@ -41,16 +42,18 @@ gchar *opt_pd_binary = NULL;
 gchar *opt_input_format = NULL;
 gchar *opt_output_format = NULL;
 gchar *opt_transform_module = NULL;
-gchar *opt_show = NULL;
+gboolean opt_show = FALSE;
 gchar *opt_time = NULL;
 gchar *opt_samples = NULL;
 gchar *opt_frames = NULL;
-gchar *opt_continuous = NULL;
+gboolean opt_continuous = FALSE;
 gchar *opt_get = NULL;
-gchar *opt_set = NULL;
+gboolean opt_set = FALSE;
 
-/* defines a callback function that generates
-   an error if an option occurs twice */
+/*
+ * Defines a callback function that generates an error if an
+ * option occurs twice.
+ */
 #define CHECK_ONCE(option) \
 static gboolean check_ ## option                                          \
        (const gchar *option_name, const gchar *value,                    \
@@ -79,8 +82,6 @@ CHECK_ONCE(opt_channels)
 CHECK_ONCE(opt_channel_group)
 CHECK_ONCE(opt_triggers)
 #ifdef HAVE_SRD
-CHECK_ONCE(opt_pds)
-CHECK_ONCE(opt_pd_stack)
 CHECK_ONCE(opt_pd_annotations)
 CHECK_ONCE(opt_pd_meta)
 CHECK_ONCE(opt_pd_binary)
@@ -97,7 +98,9 @@ static gchar **output_file_array = NULL;
 
 static const GOptionEntry optargs[] = {
        {"version", 'V', 0, G_OPTION_ARG_NONE, &opt_version,
-                       "Show version and support list", NULL},
+                       "Show version", NULL},
+       {"list-supported", 'L', 0, G_OPTION_ARG_NONE, &opt_list_supported,
+                       "List supported devices/modules/decoders", NULL},
        {"loglevel", 'l', 0, G_OPTION_ARG_INT, &opt_loglevel,
                        "Set loglevel (5 is most verbose)", NULL},
        {"driver", 'd', 0, G_OPTION_ARG_CALLBACK, &check_opt_drv,
@@ -123,10 +126,8 @@ static const GOptionEntry optargs[] = {
        {"wait-trigger", 'w', 0, G_OPTION_ARG_NONE, &opt_wait_trigger,
                        "Wait for trigger", NULL},
 #ifdef HAVE_SRD
-       {"protocol-decoders", 'P', 0, G_OPTION_ARG_CALLBACK, &check_opt_pds,
+       {"protocol-decoders", 'P', 0, G_OPTION_ARG_STRING_ARRAY, &opt_pds,
                        "Protocol decoders to run", NULL},
-       {"protocol-decoder-stack", 'S', 0, G_OPTION_ARG_CALLBACK, &check_opt_pd_stack,
-                       "Protocol decoder stack", NULL},
        {"protocol-decoder-annotations", 'A', 0, G_OPTION_ARG_CALLBACK, &check_opt_pd_annotations,
                        "Protocol decoder annotation(s) to show", NULL},
        {"protocol-decoder-meta", 'M', 0, G_OPTION_ARG_CALLBACK, &check_opt_pd_meta,
@@ -137,7 +138,7 @@ static const GOptionEntry optargs[] = {
        {"scan", 0, 0, G_OPTION_ARG_NONE, &opt_scan_devs,
                        "Scan for devices", NULL},
        {"show", 0, 0, G_OPTION_ARG_NONE, &opt_show,
-                       "Show device detail", NULL},
+                       "Show device/format/decoder details", NULL},
        {"time", 0, 0, G_OPTION_ARG_CALLBACK, &check_opt_time,
                        "How long to sample (ms)", NULL},
        {"samples", 0, 0, G_OPTION_ARG_CALLBACK, &check_opt_samples,
@@ -151,8 +152,10 @@ static const GOptionEntry optargs[] = {
        {NULL, 0, 0, 0, NULL, NULL, NULL}
 };
 
-/* Parses the command line and sets all the 'opt_...' variables.
-   Returns zero on success, non-zero otherwise. */
+/*
+ * Parses the command line and sets all the 'opt_...' variables.
+ * Returns zero on success, non-zero otherwise.
+ */
 int parse_options(int argc, char **argv)
 {
        GError *error = NULL;
@@ -215,4 +218,16 @@ void show_help(void)
        g_free(help);
 
        g_option_context_free(context);
+
+#ifdef HAVE_SRD
+#define SHOW_DECODER_TEXT "| -P <decoder> "
+#else
+#define SHOW_DECODER_TEXT ""
+#endif
+       printf("Example use, typical options:\n");
+       printf("  -d <driver> --scan\n");
+       printf("  -d <driver> { --samples N | --frames N | --time T | --continuous }\n");
+       printf("  { -d <driver> | -I <format> | -O <format> %s} --show\n", SHOW_DECODER_TEXT);
+       printf("  See the manpage or the wiki for more details.\n");
+       printf("  Note: --samples/--frames/--time/--continuous is required for acquisition.\n");
 }