show: Format channel output when no channel is available
[sigrok-cli.git] / options.c
1 /*
2  * This file is part of the sigrok-cli project.
3  *
4  * Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
5  *
6  * This program is free software: you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation, either version 3 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
18  */
19
20 #include <config.h>
21 #include <glib.h>
22 #include "sigrok-cli.h"
23
24 gboolean opt_version = FALSE;
25 gboolean opt_list_supported = FALSE;
26 gboolean opt_list_supported_wiki = FALSE;
27 gint opt_loglevel = SR_LOG_WARN; /* Show errors+warnings by default. */
28 gboolean opt_scan_devs = FALSE;
29 gboolean opt_dont_scan = FALSE;
30 gboolean opt_wait_trigger = FALSE;
31 gchar *opt_input_file = NULL;
32 gchar *opt_output_file = NULL;
33 gchar *opt_drv = NULL;
34 gchar **opt_configs = NULL;
35 gchar *opt_channels = NULL;
36 gchar *opt_channel_group = NULL;
37 gchar *opt_triggers = NULL;
38 gchar **opt_pds = NULL;
39 #ifdef HAVE_SRD
40 gchar *opt_pd_annotations = NULL;
41 gchar *opt_pd_meta = NULL;
42 gchar *opt_pd_binary = NULL;
43 gboolean opt_pd_samplenum = FALSE;
44 gboolean opt_pd_jsontrace = FALSE;
45 #endif
46 gchar *opt_input_format = NULL;
47 gchar *opt_output_format = NULL;
48 gchar *opt_transform_module = NULL;
49 gboolean opt_show = FALSE;
50 gchar *opt_time = NULL;
51 gchar *opt_samples = NULL;
52 gchar *opt_frames = NULL;
53 gboolean opt_continuous = FALSE;
54 gchar **opt_gets = NULL;
55 gboolean opt_set = FALSE;
56 gboolean opt_list_serial = FALSE;
57
58 /*
59  * Defines a callback function that generates an error if an
60  * option occurs twice.
61  */
62 #define CHECK_ONCE(option) \
63 static gboolean check_ ## option                                          \
64         (const gchar *option_name, const gchar *value,                    \
65         gpointer data, GError **error)                                    \
66 {                                                                         \
67         (void)data;                                                       \
68                                                                           \
69         static gboolean seen = FALSE;                                     \
70         if (seen) {                                                       \
71                 g_set_error(error, G_OPTION_ERROR, G_OPTION_ERROR_FAILED, \
72                             "superfluous option \"%s\"", option_name);    \
73                 return FALSE;                                             \
74         }                                                                 \
75                                                                           \
76         option = g_strdup(value);                                         \
77         seen = TRUE;                                                      \
78         return TRUE;                                                      \
79 }
80
81 CHECK_ONCE(opt_drv)
82 CHECK_ONCE(opt_input_format)
83 CHECK_ONCE(opt_output_format)
84 CHECK_ONCE(opt_transform_module)
85 CHECK_ONCE(opt_channels)
86 CHECK_ONCE(opt_channel_group)
87 CHECK_ONCE(opt_triggers)
88 #ifdef HAVE_SRD
89 CHECK_ONCE(opt_pd_annotations)
90 CHECK_ONCE(opt_pd_meta)
91 CHECK_ONCE(opt_pd_binary)
92 #endif
93 CHECK_ONCE(opt_time)
94 CHECK_ONCE(opt_samples)
95 CHECK_ONCE(opt_frames)
96
97 #undef CHECK_STR_ONCE
98
99 static gchar **input_file_array = NULL;
100 static gchar **output_file_array = NULL;
101
102 static const GOptionEntry optargs[] = {
103         {"version", 'V', 0, G_OPTION_ARG_NONE, &opt_version,
104                         "Show version", NULL},
105         {"list-supported", 'L', 0, G_OPTION_ARG_NONE, &opt_list_supported,
106                         "List supported devices/modules/decoders", NULL},
107         {"list-supported-wiki", 0, 0, G_OPTION_ARG_NONE, &opt_list_supported_wiki,
108                         "List supported decoders (MediaWiki)", NULL},
109         {"loglevel", 'l', 0, G_OPTION_ARG_INT, &opt_loglevel,
110                         "Set loglevel (5 is most verbose)", NULL},
111         {"driver", 'd', 0, G_OPTION_ARG_CALLBACK, &check_opt_drv,
112                         "The driver to use", NULL},
113         {"config", 'c', 0, G_OPTION_ARG_STRING_ARRAY, &opt_configs,
114                         "Specify device configuration options", NULL},
115         {"input-file", 'i', 0, G_OPTION_ARG_FILENAME_ARRAY, &input_file_array,
116                         "Load input from file", NULL},
117         {"input-format", 'I', 0, G_OPTION_ARG_CALLBACK, &check_opt_input_format,
118                         "Input format", NULL},
119         {"output-file", 'o', 0, G_OPTION_ARG_FILENAME_ARRAY, &output_file_array,
120                         "Save output to file", NULL},
121         {"output-format", 'O', 0, G_OPTION_ARG_CALLBACK, &check_opt_output_format,
122                         "Output format", NULL},
123         {"transform-module", 'T', 0, G_OPTION_ARG_CALLBACK, &check_opt_transform_module,
124                         "Transform module", NULL},
125         {"channels", 'C', 0, G_OPTION_ARG_CALLBACK, &check_opt_channels,
126                         "Channels to use", NULL},
127         {"channel-group", 'g', 0, G_OPTION_ARG_CALLBACK, &check_opt_channel_group,
128                         "Channel groups", NULL},
129         {"triggers", 't', 0, G_OPTION_ARG_CALLBACK, &check_opt_triggers,
130                         "Trigger configuration", NULL},
131         {"wait-trigger", 'w', 0, G_OPTION_ARG_NONE, &opt_wait_trigger,
132                         "Wait for trigger", NULL},
133 #ifdef HAVE_SRD
134         {"protocol-decoders", 'P', 0, G_OPTION_ARG_STRING_ARRAY, &opt_pds,
135                         "Protocol decoders to run", NULL},
136         {"protocol-decoder-annotations", 'A', 0, G_OPTION_ARG_CALLBACK, &check_opt_pd_annotations,
137                         "Protocol decoder annotation(s) to show", NULL},
138         {"protocol-decoder-meta", 'M', 0, G_OPTION_ARG_CALLBACK, &check_opt_pd_meta,
139                         "Protocol decoder meta output to show", NULL},
140         {"protocol-decoder-binary", 'B', 0, G_OPTION_ARG_CALLBACK, &check_opt_pd_binary,
141                         "Protocol decoder binary output to show", NULL},
142         {"protocol-decoder-samplenum", 0, 0, G_OPTION_ARG_NONE, &opt_pd_samplenum,
143                         "Show sample numbers in decoder output", NULL},
144         {"protocol-decoder-jsontrace", 0, 0, G_OPTION_ARG_NONE, &opt_pd_jsontrace,
145                         "Output in Google Trace Event format (JSON)", NULL},
146 #endif
147         {"scan", 0, 0, G_OPTION_ARG_NONE, &opt_scan_devs,
148                         "Scan for devices", NULL},
149         {"dont-scan", 'D', 0, G_OPTION_ARG_NONE, &opt_dont_scan,
150                         "Don't auto-scan (use -d spec only)", NULL},
151         {"show", 0, 0, G_OPTION_ARG_NONE, &opt_show,
152                         "Show device/format/decoder details", NULL},
153         {"time", 0, 0, G_OPTION_ARG_CALLBACK, &check_opt_time,
154                         "How long to sample (ms)", NULL},
155         {"samples", 0, 0, G_OPTION_ARG_CALLBACK, &check_opt_samples,
156                         "Number of samples to acquire", NULL},
157         {"frames", 0, 0, G_OPTION_ARG_CALLBACK, &check_opt_frames,
158                         "Number of frames to acquire", NULL},
159         {"continuous", 0, 0, G_OPTION_ARG_NONE, &opt_continuous,
160                         "Sample continuously", NULL},
161         {"get", 0, 0, G_OPTION_ARG_STRING_ARRAY, &opt_gets,
162                         "Get device options only", NULL},
163         {"set", 0, 0, G_OPTION_ARG_NONE, &opt_set, "Set device options only", NULL},
164         {"list-serial", 0, 0, G_OPTION_ARG_NONE, &opt_list_serial, "List available serial/HID/BT/BLE ports", NULL},
165         {NULL, 0, 0, 0, NULL, NULL, NULL}
166 };
167
168 /*
169  * Parses the command line and sets all the 'opt_...' variables.
170  * Returns zero on success, non-zero otherwise.
171  */
172 int parse_options(int argc, char **argv)
173 {
174         GError *error = NULL;
175         GOptionContext *context = g_option_context_new(NULL);
176         int ret = 1;
177
178         g_option_context_add_main_entries(context, optargs, NULL);
179
180         if (!g_option_context_parse(context, &argc, &argv, &error)) {
181                 g_critical("%s", error->message);
182                 goto done;
183         }
184
185         /*
186          * Because of encoding issues with filenames (mentioned in the glib
187          * documentation), we don't check them with a callback function, but
188          * collect them into arrays and then check if the arrays contain at
189          * most one element.
190          */
191         if (NULL != input_file_array) {
192                 if (NULL != input_file_array[0] && NULL != input_file_array[1]) {
193                         g_critical("option \"--input-file/-i\" only allowed once");
194                         goto done;
195                 }
196                 opt_input_file = g_strdup(input_file_array[0]);
197         }
198
199         if (NULL != output_file_array) {
200                 if (NULL != output_file_array[0] && NULL != output_file_array[1]) {
201                         g_critical("option \"--output-file/-o\" only allowed once");
202                         goto done;
203                 }
204                 opt_output_file = g_strdup(output_file_array[0]);
205         }
206
207         if (1 != argc) {
208                 g_critical("superfluous command line argument \"%s\"", argv[1]);
209                 goto done;
210         }
211
212         ret = 0;
213
214 done:
215         g_option_context_free(context);
216         g_strfreev(input_file_array);
217         g_strfreev(output_file_array);
218         input_file_array = NULL;
219         output_file_array = NULL;
220
221         return ret;
222 }
223
224 void show_help(void)
225 {
226         GOptionContext *context = g_option_context_new(NULL);
227         g_option_context_add_main_entries(context, optargs, NULL);
228
229         char *help = g_option_context_get_help(context, TRUE, NULL);
230         printf("%s", help);
231         g_free(help);
232
233         g_option_context_free(context);
234
235 #ifdef HAVE_SRD
236 #define SHOW_DECODER_TEXT "| -P <decoder> "
237 #else
238 #define SHOW_DECODER_TEXT ""
239 #endif
240         printf("Example use, typical options:\n");
241         printf("  -d <driver> --scan\n");
242         printf("  -d <driver> { --samples N | --frames N | --time T | --continuous }\n");
243         printf("  { -d <driver> | -I <format> | -O <format> %s} --show\n", SHOW_DECODER_TEXT);
244         printf("  See the manpage or the wiki for more details.\n");
245         printf("  Note: --samples/--frames/--time/--continuous is required for acquisition.\n");
246 }