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/>.
20 #include "sigrok-cli.h"
23 gboolean opt_version = FALSE;
24 gint opt_loglevel = SR_LOG_WARN; /* Show errors+warnings by default. */
25 gboolean opt_scan_devs = FALSE;
26 gboolean opt_wait_trigger = FALSE;
27 gchar *opt_input_file = NULL;
28 gchar *opt_output_file = NULL;
29 gchar *opt_drv = NULL;
30 gchar *opt_config = NULL;
31 gchar *opt_channels = NULL;
32 gchar *opt_channel_group = NULL;
33 gchar *opt_triggers = NULL;
34 gchar *opt_pds = NULL;
36 gchar *opt_pd_stack = 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_show = NULL;
44 gchar *opt_time = NULL;
45 gchar *opt_samples = NULL;
46 gchar *opt_frames = NULL;
47 gchar *opt_continuous = NULL;
48 gchar *opt_set = NULL;
50 /* defines a callback function that generates
51 an error if an option occurs twice */
52 #define CHECK_ONCE(option) \
53 static gboolean check_ ## option \
54 (const gchar *option_name, const gchar *value, \
55 gpointer data, GError **error) \
59 static gboolean seen = FALSE; \
61 g_set_error(error, G_OPTION_ERROR, G_OPTION_ERROR_FAILED, \
62 "superfluous option \"%s\"", option_name); \
66 option = g_strdup(value); \
72 CHECK_ONCE(opt_config)
73 CHECK_ONCE(opt_input_format)
74 CHECK_ONCE(opt_output_format)
75 CHECK_ONCE(opt_channels)
76 CHECK_ONCE(opt_channel_group)
77 CHECK_ONCE(opt_triggers)
80 CHECK_ONCE(opt_pd_stack)
81 CHECK_ONCE(opt_pd_annotations)
82 CHECK_ONCE(opt_pd_meta)
83 CHECK_ONCE(opt_pd_binary)
86 CHECK_ONCE(opt_samples)
87 CHECK_ONCE(opt_frames)
91 static gchar **input_file_array = NULL;
92 static gchar **output_file_array = NULL;
94 static const GOptionEntry optargs[] = {
95 {"version", 'V', 0, G_OPTION_ARG_NONE, &opt_version,
96 "Show version and support list", NULL},
97 {"loglevel", 'l', 0, G_OPTION_ARG_INT, &opt_loglevel,
98 "Set loglevel (5 is most verbose)", NULL},
99 {"driver", 'd', 0, G_OPTION_ARG_CALLBACK, &check_opt_drv,
100 "The driver to use", NULL},
101 {"config", 'c', 0, G_OPTION_ARG_CALLBACK, &check_opt_config,
102 "Specify device configuration options", NULL},
103 {"input-file", 'i', 0, G_OPTION_ARG_FILENAME_ARRAY, &input_file_array,
104 "Load input from file", NULL},
105 {"input-format", 'I', 0, G_OPTION_ARG_CALLBACK, &check_opt_input_format,
106 "Input format", NULL},
107 {"output-file", 'o', 0, G_OPTION_ARG_FILENAME_ARRAY, &output_file_array,
108 "Save output to file", NULL},
109 {"output-format", 'O', 0, G_OPTION_ARG_CALLBACK, &check_opt_output_format,
110 "Output format", NULL},
111 {"channels", 'C', 0, G_OPTION_ARG_CALLBACK, &check_opt_channels,
112 "Channels to use", NULL},
113 {"channel-group", 'g', 0, G_OPTION_ARG_CALLBACK, &check_opt_channel_group,
114 "Channel groups", NULL},
115 {"triggers", 't', 0, G_OPTION_ARG_CALLBACK, &check_opt_triggers,
116 "Trigger configuration", NULL},
117 {"wait-trigger", 'w', 0, G_OPTION_ARG_NONE, &opt_wait_trigger,
118 "Wait for trigger", NULL},
120 {"protocol-decoders", 'P', 0, G_OPTION_ARG_CALLBACK, &check_opt_pds,
121 "Protocol decoders to run", NULL},
122 {"protocol-decoder-stack", 'S', 0, G_OPTION_ARG_CALLBACK, &check_opt_pd_stack,
123 "Protocol decoder stack", NULL},
124 {"protocol-decoder-annotations", 'A', 0, G_OPTION_ARG_CALLBACK, &check_opt_pd_annotations,
125 "Protocol decoder annotation(s) to show", NULL},
126 {"protocol-decoder-meta", 'M', 0, G_OPTION_ARG_CALLBACK, &check_opt_pd_meta,
127 "Protocol decoder meta output to show", NULL},
128 {"protocol-decoder-binary", 'B', 0, G_OPTION_ARG_CALLBACK, &check_opt_pd_binary,
129 "Protocol decoder binary output to show", NULL},
131 {"scan", 0, 0, G_OPTION_ARG_NONE, &opt_scan_devs,
132 "Scan for devices", NULL},
133 {"show", 0, 0, G_OPTION_ARG_NONE, &opt_show,
134 "Show device detail", NULL},
135 {"time", 0, 0, G_OPTION_ARG_CALLBACK, &check_opt_time,
136 "How long to sample (ms)", NULL},
137 {"samples", 0, 0, G_OPTION_ARG_CALLBACK, &check_opt_samples,
138 "Number of samples to acquire", NULL},
139 {"frames", 0, 0, G_OPTION_ARG_CALLBACK, &check_opt_frames,
140 "Number of frames to acquire", NULL},
141 {"continuous", 0, 0, G_OPTION_ARG_NONE, &opt_continuous,
142 "Sample continuously", NULL},
143 {"set", 0, 0, G_OPTION_ARG_NONE, &opt_set, "Set device options only", NULL},
144 {NULL, 0, 0, 0, NULL, NULL, NULL}
147 /* Parses the command line and sets all the 'opt_...' variables.
148 Returns zero on success, non-zero otherwise. */
149 int parse_options(int argc, char **argv)
151 GError *error = NULL;
152 GOptionContext *context = g_option_context_new(NULL);
155 g_option_context_add_main_entries(context, optargs, NULL);
157 if (!g_option_context_parse(context, &argc, &argv, &error)) {
158 g_critical("%s", error->message);
163 * Because of encoding issues with filenames (mentioned in the glib
164 * documentation), we don't check them with a callback function, but
165 * collect them into arrays and then check if the arrays contain at
168 if (NULL != input_file_array) {
169 if (NULL != input_file_array[0] && NULL != input_file_array[1]) {
170 g_critical("option \"--input-file/-i\" only allowed once");
173 opt_input_file = g_strdup(input_file_array[0]);
176 if (NULL != output_file_array) {
177 if (NULL != output_file_array[0] && NULL != output_file_array[1]) {
178 g_critical("option \"--output-file/-o\" only allowed once");
181 opt_output_file = g_strdup(output_file_array[0]);
187 g_option_context_free(context);
188 g_strfreev(input_file_array);
189 g_strfreev(output_file_array);
190 input_file_array = NULL;
191 output_file_array = NULL;
198 GOptionContext *context = g_option_context_new(NULL);
199 g_option_context_add_main_entries(context, optargs, NULL);
201 char *help = g_option_context_get_help(context, TRUE, NULL);
205 g_option_context_free(context);