1 /* ncmpc (Ncurses MPD Client)
2 * (c) 2004-2009 The Music Player Daemon Project
3 * Project homepage: http://musicpd.org
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
18 */
20 #include "options.h"
21 #include "config.h"
22 #include "defaults.h"
23 #include "charset.h"
24 #include "command.h"
25 #include "conf.h"
26 #include "i18n.h"
28 #include <stdlib.h>
29 #include <stdio.h>
30 #include <string.h>
31 #include <glib.h>
33 #define MAX_LONGOPT_LENGTH 32
35 #define ERROR_UNKNOWN_OPTION 0x01
36 #define ERROR_BAD_ARGUMENT 0x02
37 #define ERROR_GOT_ARGUMENT 0x03
38 #define ERROR_MISSING_ARGUMENT 0x04
40 typedef struct {
41 int shortopt;
42 const char *longopt;
43 const char *argument;
44 const char *descrition;
45 } arg_opt_t;
48 typedef void (*option_callback_fn_t)(int c, const char *arg);
51 options_t options = {
52 .crossfade_time = DEFAULT_CROSSFADE_TIME,
53 .seek_time = 1,
54 #ifdef ENABLE_LYRICS_SCREEN
55 .lyrics_timeout = DEFAULT_LYRICS_TIMEOUT,
56 .lyrics_autosave = false,
57 #endif
58 .find_wrap = true,
59 .scroll_offset = 0,
60 .wide_cursor = true,
61 .audible_bell = true,
62 .bell_on_wrap = true,
63 .status_message_time = 3,
64 #ifndef NCMPC_MINI
65 .scroll = DEFAULT_SCROLL,
66 .welcome_screen_list = true,
67 .jump_prefix_only = true,
68 .second_column = true,
69 #endif
70 };
72 static const arg_opt_t option_table[] = {
73 { '?', "help", NULL, "Show this help message" },
74 { 'V', "version", NULL, "Display version information" },
75 { 'c', "colors", NULL, "Enable colors" },
76 { 'C', "no-colors", NULL, "Disable colors" },
77 #ifdef HAVE_GETMOUSE
78 { 'm', "mouse", NULL, "Enable mouse" },
79 { 'M', "no-mouse", NULL, "Disable mouse" },
80 #endif
81 { 'e', "exit", NULL, "Exit on connection errors" },
82 { 'p', "port", "PORT", "Connect to server on port" },
83 { 'h', "host", "HOST", "Connect to server on host" },
84 { 'P', "password","PASSWORD", "Connect with password" },
85 { 'f', "config", "FILE", "Read configuration from file" },
86 { 'k', "key-file","FILE", "Read configuration from file" },
87 { 'S', "no-splash", NULL, "Don't show the splash screen" },
88 #ifndef NDEBUG
89 { 'K', "dump-keys", NULL, "Dump key bindings to stdout" },
90 #endif
91 };
93 static const unsigned option_table_size = sizeof(option_table) / sizeof(option_table[0]);
95 static const arg_opt_t *
96 lookup_option(int s, char *l)
97 {
98 unsigned i;
100 for (i = 0; i < option_table_size; ++i) {
101 if (l && strcmp(l, option_table[i].longopt) == 0)
102 return &option_table[i];;
103 if (s && s == option_table[i].shortopt)
104 return &option_table[i];;
105 }
107 return NULL;
108 }
110 static void
111 option_error(int error, const char *option, const char *arg)
112 {
113 switch (error) {
114 case ERROR_UNKNOWN_OPTION:
115 fprintf(stderr, PACKAGE ": invalid option %s\n", option);
116 break;
117 case ERROR_BAD_ARGUMENT:
118 fprintf(stderr, PACKAGE ": bad argument: %s\n", option);
119 break;
120 case ERROR_GOT_ARGUMENT:
121 fprintf(stderr, PACKAGE ": invalid option %s=%s\n", option, arg);
122 break;
123 case ERROR_MISSING_ARGUMENT:
124 fprintf(stderr, PACKAGE ": missing value for %s option\n", option);
125 break;
126 default:
127 fprintf(stderr, PACKAGE ": internal error %d\n", error);
128 break;
129 }
131 exit(EXIT_FAILURE);
132 }
134 static void
135 display_help(void)
136 {
137 unsigned i;
139 printf("Usage: %s [OPTION]...\n", PACKAGE);
141 for (i = 0; i < option_table_size; ++i) {
142 char tmp[MAX_LONGOPT_LENGTH];
144 if (option_table[i].argument)
145 g_snprintf(tmp, MAX_LONGOPT_LENGTH, "%s=%s",
146 option_table[i].longopt,
147 option_table[i].argument);
148 else
149 g_strlcpy(tmp, option_table[i].longopt, 64);
151 printf(" -%c, --%-20s %s\n",
152 option_table[i].shortopt,
153 tmp,
154 option_table[i].descrition);
155 }
156 }
158 static void
159 handle_option(int c, const char *arg)
160 {
161 switch (c) {
162 case '?': /* --help */
163 display_help();
164 exit(EXIT_SUCCESS);
165 case 'V': /* --version */
166 puts(PACKAGE " version: " VERSION "\n"
167 "build options:"
168 #ifdef NCMPC_MINI
169 " mini"
170 #endif
171 #ifndef NDEBUG
172 " debug"
173 #endif
174 #ifdef ENABLE_MULTIBYTE
175 " multibyte"
176 #endif
177 #ifdef ENABLE_WIDE
178 " wide"
179 #endif
180 #ifdef ENABLE_LOCALE
181 " locale"
182 #endif
183 #ifdef ENABLE_NLS
184 " nls"
185 #endif
186 #ifdef ENABLE_COLORS
187 " colors"
188 #else
189 " no-colors"
190 #endif
191 #ifdef ENABLE_LIRC
192 " lirc"
193 #endif
194 #ifdef HAVE_GETMOUSE
195 " getmouse"
196 #endif
197 #ifdef ENABLE_ARTIST_SCREEN
198 " artist-screen"
199 #endif
200 #ifdef ENABLE_HELP_SCREEN
201 " help-screen"
202 #endif
203 #ifdef ENABLE_SEARCH_SCREEN
204 " search-screen"
205 #endif
206 #ifdef ENABLE_SONG_SCREEN
207 " song-screen"
208 #endif
209 #ifdef ENABLE_KEYDEF_SCREEN
210 " key-screen"
211 #endif
212 #ifdef ENABLE_LYRICS_SCREEN
213 " lyrics-screen"
214 #endif
215 #ifdef ENABLE_OUTPUTS_SCREEN
216 " outputs-screen"
217 #endif
219 "\n");
220 #ifndef NCMPC_MINI
221 if (strcmp("translator-credits", _("translator-credits")) != 0)
222 /* To translators: these credits are shown
223 when ncmpc is started with "--version" */
224 printf("\n%s\n", _("translator-credits"));
225 #endif
226 exit(EXIT_SUCCESS);
227 case 'c': /* --colors */
228 #ifdef ENABLE_COLORS
229 options.enable_colors = true;
230 #endif
231 break;
232 case 'C': /* --no-colors */
233 #ifdef ENABLE_COLORS
234 options.enable_colors = false;
235 #endif
236 break;
237 case 'm': /* --mouse */
238 #ifdef HAVE_GETMOUSE
239 options.enable_mouse = true;
240 #endif
241 break;
242 case 'M': /* --no-mouse */
243 #ifdef HAVE_GETMOUSE
244 options.enable_mouse = false;
245 #endif
246 break;
247 case 'e': /* --exit */
248 /* deprecated */
249 break;
250 case 'p': /* --port */
251 options.port = atoi(arg);
252 break;
253 case 'h': /* --host */
254 g_free(options.host);
255 options.host = g_strdup(arg);
256 break;
257 case 'P': /* --password */
258 g_free(options.password);
259 options.password = locale_to_utf8(arg);
260 break;
261 case 'f': /* --config */
262 g_free(options.config_file);
263 options.config_file = g_strdup(arg);
264 break;
265 case 'k': /* --key-file */
266 g_free(options.key_file);
267 options.key_file = g_strdup(arg);
268 break;
269 case 'S': /* --key-file */
270 /* the splash screen was removed */
271 break;
272 #ifndef NDEBUG
273 #ifndef NCMPC_MINI
274 case 'K': /* --dump-keys */
275 read_configuration();
276 write_key_bindings(stdout, KEYDEF_WRITE_ALL | KEYDEF_COMMENT_ALL);
277 exit(EXIT_SUCCESS);
278 break;
279 #endif
280 #endif
281 default:
282 fprintf(stderr,"Unknown Option %c = %s\n", c, arg);
283 break;
284 }
285 }
287 void
288 options_parse(int argc, const char *argv[])
289 {
290 int i;
291 const arg_opt_t *opt = NULL;
292 option_callback_fn_t option_cb = handle_option;
294 i=1;
295 while (i < argc) {
296 const char *arg = argv[i];
297 size_t len = strlen(arg);
299 /* check for a long option */
300 if (g_str_has_prefix(arg, "--")) {
301 char *name, *value;
303 /* make sure we got an argument for the previous option */
304 if( opt && opt->argument )
305 option_error(ERROR_MISSING_ARGUMENT, opt->longopt, opt->argument);
307 /* retrieve a option argument */
308 if ((value=g_strrstr(arg+2, "="))) {
309 *value = '\0';
310 name = g_strdup(arg);
311 *value = '=';
312 value++;
313 } else
314 name = g_strdup(arg);
316 /* check if the option exists */
317 if( (opt=lookup_option(0, name+2)) == NULL )
318 option_error(ERROR_UNKNOWN_OPTION, name, NULL);
319 g_free(name);
321 /* abort if we got an argument to the option and don't want one */
322 if( value && opt->argument==NULL )
323 option_error(ERROR_GOT_ARGUMENT, arg, value);
325 /* execute option callback */
326 if (value || opt->argument==NULL) {
327 option_cb (opt->shortopt, value);
328 opt = NULL;
329 }
330 }
331 /* check for short options */
332 else if (len>=2 && g_str_has_prefix(arg, "-")) {
333 size_t j;
335 for(j=1; j<len; j++) {
336 /* make sure we got an argument for the previous option */
337 if (opt && opt->argument)
338 option_error(ERROR_MISSING_ARGUMENT,
339 opt->longopt, opt->argument);
341 /* check if the option exists */
342 if ((opt=lookup_option(arg[j], NULL)) == NULL)
343 option_error(ERROR_UNKNOWN_OPTION, arg, NULL);
345 /* if no option argument is needed execute callback */
346 if (opt->argument == NULL) {
347 option_cb (opt->shortopt, NULL);
348 opt = NULL;
349 }
350 }
351 } else {
352 /* is this a option argument? */
353 if (opt && opt->argument) {
354 option_cb (opt->shortopt, arg);
355 opt = NULL;
356 } else
357 option_error(ERROR_BAD_ARGUMENT, arg, NULL);
358 }
359 i++;
360 }
362 if (opt && opt->argument == NULL)
363 option_cb (opt->shortopt, NULL);
364 else if (opt && opt->argument)
365 option_error(ERROR_MISSING_ARGUMENT, opt->longopt, opt->argument);
366 }
368 void
369 options_init(void)
370 {
371 /* default option values */
372 options.list_format = g_strdup(DEFAULT_LIST_FORMAT);
373 options.status_format = g_strdup(DEFAULT_STATUS_FORMAT);
374 options.screen_list = g_strsplit_set(DEFAULT_SCREEN_LIST, " ", 0);
375 #ifndef NCMPC_MINI
376 options.scroll_sep = g_strdup(DEFAULT_SCROLL_SEP);
377 #endif
378 }
380 void
381 options_deinit(void)
382 {
383 g_free(options.host);
384 g_free(options.username);
385 g_free(options.password);
386 g_free(options.config_file);
387 g_free(options.key_file);
388 g_free(options.list_format);
389 g_free(options.status_format);
390 g_strfreev(options.screen_list);
391 #ifndef NCMPC_MINI
392 g_free(options.xterm_title_format);
393 g_free(options.scroll_sep);
394 #endif
395 }