2 * This file is part of the sigrok-cli project.
4 * Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
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.
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.
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/>.
22 #include "sigrok-cli.h"
24 gboolean opt_version = FALSE;
25 gint opt_loglevel = SR_LOG_WARN; /* Show errors+warnings by default. */
26 gboolean opt_scan_devs = FALSE;
27 gboolean opt_wait_trigger = FALSE;
28 gchar *opt_input_file = NULL;
29 gchar *opt_output_file = NULL;
30 gchar *opt_drv = NULL;
31 gchar *opt_config = NULL;
32 gchar *opt_channels = NULL;
33 gchar *opt_channel_group = NULL;
34 gchar *opt_triggers = NULL;
35 gchar *opt_pds = NULL;
37 gchar *opt_pd_annotations = NULL;
38 gchar *opt_pd_meta = NULL;
39 gchar *opt_pd_binary = NULL;
41 gchar *opt_input_format = NULL;
42 gchar *opt_output_format = NULL;
43 gchar *opt_transform_module = NULL;
44 gboolean opt_show = FALSE;
45 gchar *opt_time = NULL;
46 gchar *opt_samples = NULL;
47 gchar *opt_frames = NULL;
48 gboolean opt_continuous = FALSE;
49 gchar *opt_get = NULL;
50 gboolean opt_set = FALSE;
53 * Defines a callback function that generates an error if an
54 * option occurs twice.
56 #define CHECK_ONCE(option) \
57 static gboolean check_ ## option \
58 (const gchar *option_name, const gchar *value, \
59 gpointer data, GError **error) \
63 static gboolean seen = FALSE; \
65 g_set_error(error, G_OPTION_ERROR, G_OPTION_ERROR_FAILED, \
66 "superfluous option \"%s\"", option_name); \
70 option = g_strdup(value); \
76 CHECK_ONCE(opt_config)
77 CHECK_ONCE(opt_input_format)
78 CHECK_ONCE(opt_output_format)
79 CHECK_ONCE(opt_transform_module)
80 CHECK_ONCE(opt_channels)
81 CHECK_ONCE(opt_channel_group)
82 CHECK_ONCE(opt_triggers)
85 CHECK_ONCE(opt_pd_annotations)
86 CHECK_ONCE(opt_pd_meta)
87 CHECK_ONCE(opt_pd_binary)
90 CHECK_ONCE(opt_samples)
91 CHECK_ONCE(opt_frames)
96 static gchar **input_file_array = NULL;
97 static gchar **output_file_array = NULL;
99 static const GOptionEntry optargs[] = {
100 {"version", 'V', 0, G_OPTION_ARG_NONE, &opt_version,
101 "Show version and support list", NULL},
102 {"loglevel", 'l', 0, G_OPTION_ARG_INT, &opt_loglevel,
103 "Set loglevel (5 is most verbose)", NULL},
104 {"driver", 'd', 0, G_OPTION_ARG_CALLBACK, &check_opt_drv,
105 "The driver to use", NULL},
106 {"config", 'c', 0, G_OPTION_ARG_CALLBACK, &check_opt_config,
107 "Specify device configuration options", NULL},
108 {"input-file", 'i', 0, G_OPTION_ARG_FILENAME_ARRAY, &input_file_array,
109 "Load input from file", NULL},
110 {"input-format", 'I', 0, G_OPTION_ARG_CALLBACK, &check_opt_input_format,
111 "Input format", NULL},
112 {"output-file", 'o', 0, G_OPTION_ARG_FILENAME_ARRAY, &output_file_array,
113 "Save output to file", NULL},
114 {"output-format", 'O', 0, G_OPTION_ARG_CALLBACK, &check_opt_output_format,
115 "Output format", NULL},
116 {"transform-module", 'T', 0, G_OPTION_ARG_CALLBACK, &check_opt_transform_module,
117 "Transform module", NULL},
118 {"channels", 'C', 0, G_OPTION_ARG_CALLBACK, &check_opt_channels,
119 "Channels to use", NULL},
120 {"channel-group", 'g', 0, G_OPTION_ARG_CALLBACK, &check_opt_channel_group,
121 "Channel groups", NULL},
122 {"triggers", 't', 0, G_OPTION_ARG_CALLBACK, &check_opt_triggers,
123 "Trigger configuration", NULL},
124 {"wait-trigger", 'w', 0, G_OPTION_ARG_NONE, &opt_wait_trigger,
125 "Wait for trigger", NULL},
127 {"protocol-decoders", 'P', 0, G_OPTION_ARG_CALLBACK, &check_opt_pds,
128 "Protocol decoders to run", NULL},
129 {"protocol-decoder-annotations", 'A', 0, G_OPTION_ARG_CALLBACK, &check_opt_pd_annotations,
130 "Protocol decoder annotation(s) to show", NULL},
131 {"protocol-decoder-meta", 'M', 0, G_OPTION_ARG_CALLBACK, &check_opt_pd_meta,
132 "Protocol decoder meta output to show", NULL},
133 {"protocol-decoder-binary", 'B', 0, G_OPTION_ARG_CALLBACK, &check_opt_pd_binary,
134 "Protocol decoder binary output to show", NULL},
136 {"scan", 0, 0, G_OPTION_ARG_NONE, &opt_scan_devs,
137 "Scan for devices", NULL},
138 {"show", 0, 0, G_OPTION_ARG_NONE, &opt_show,
139 "Show device/format/decoder details", NULL},
140 {"time", 0, 0, G_OPTION_ARG_CALLBACK, &check_opt_time,
141 "How long to sample (ms)", NULL},
142 {"samples", 0, 0, G_OPTION_ARG_CALLBACK, &check_opt_samples,
143 "Number of samples to acquire", NULL},
144 {"frames", 0, 0, G_OPTION_ARG_CALLBACK, &check_opt_frames,
145 "Number of frames to acquire", NULL},
146 {"continuous", 0, 0, G_OPTION_ARG_NONE, &opt_continuous,
147 "Sample continuously", NULL},
148 {"get", 0, 0, G_OPTION_ARG_CALLBACK, &check_opt_get, "Get device option only", NULL},
149 {"set", 0, 0, G_OPTION_ARG_NONE, &opt_set, "Set device options only", NULL},
150 {NULL, 0, 0, 0, NULL, NULL, NULL}
154 * Parses the command line and sets all the 'opt_...' variables.
155 * Returns zero on success, non-zero otherwise.
157 int parse_options(int argc, char **argv)
159 GError *error = NULL;
160 GOptionContext *context = g_option_context_new(NULL);
163 g_option_context_add_main_entries(context, optargs, NULL);
165 if (!g_option_context_parse(context, &argc, &argv, &error)) {
166 g_critical("%s", error->message);
171 * Because of encoding issues with filenames (mentioned in the glib
172 * documentation), we don't check them with a callback function, but
173 * collect them into arrays and then check if the arrays contain at
176 if (NULL != input_file_array) {
177 if (NULL != input_file_array[0] && NULL != input_file_array[1]) {
178 g_critical("option \"--input-file/-i\" only allowed once");
181 opt_input_file = g_strdup(input_file_array[0]);
184 if (NULL != output_file_array) {
185 if (NULL != output_file_array[0] && NULL != output_file_array[1]) {
186 g_critical("option \"--output-file/-o\" only allowed once");
189 opt_output_file = g_strdup(output_file_array[0]);
193 g_critical("superfluous command line argument \"%s\"", argv[1]);
200 g_option_context_free(context);
201 g_strfreev(input_file_array);
202 g_strfreev(output_file_array);
203 input_file_array = NULL;
204 output_file_array = NULL;
211 GOptionContext *context = g_option_context_new(NULL);
212 g_option_context_add_main_entries(context, optargs, NULL);
214 char *help = g_option_context_get_help(context, TRUE, NULL);
218 g_option_context_free(context);