Code

release v0.29
[ncmpc.git] / src / options.c
index 1ac3195317e335d1f607b23dbc4a5480a266f090..ca6d415e41e5da28f0c08376f3039e0af189cd80 100644 (file)
@@ -1,7 +1,6 @@
-/* 
- * $Id$
- *
- * (c) 2004 by Kalle Wallin <kaw@linux.se>
+/* ncmpc (Ncurses MPD Client)
+ * (c) 2004-2017 The Music Player Daemon Project
+ * Project homepage: http://musicpd.org
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  */
 
 #include "options.h"
 #include "config.h"
-#include "ncmpc.h"
-#include "support.h"
+#include "defaults.h"
+#include "charset.h"
 #include "command.h"
 #include "conf.h"
+#include "i18n.h"
 
 #include <stdlib.h>
+#include <stdio.h>
 #include <string.h>
-
-#define MAX_LONGOPT_LENGTH 32
+#include <glib.h>
 
 #define ERROR_UNKNOWN_OPTION    0x01
 #define ERROR_BAD_ARGUMENT      0x02
@@ -46,195 +46,257 @@ typedef struct {
 typedef void (*option_callback_fn_t)(int c, const char *arg);
 
 
-options_t options;
+options_t options = {
+       .crossfade_time = DEFAULT_CROSSFADE_TIME,
+       .seek_time = 1,
+#ifdef ENABLE_LYRICS_SCREEN
+       .lyrics_timeout = DEFAULT_LYRICS_TIMEOUT,
+       .lyrics_autosave = false,
+       .lyrics_show_plugin = false,
+       .text_editor_ask = true,
+#endif
+       .find_wrap = true,
+       .scroll_offset = 0,
+       .wide_cursor = true,
+       .audible_bell = true,
+       .bell_on_wrap = true,
+       .status_message_time = 3,
+       .timeout_ms = 0,
+#ifndef NCMPC_MINI
+       .scroll = DEFAULT_SCROLL,
+       .welcome_screen_list = true,
+       .jump_prefix_only = true,
+       .second_column = true,
+#endif
+};
 
-static arg_opt_t option_table[] = {
-  { '?', "help",     NULL,   "Show this help message" },
-  { 'V', "version",  NULL,   "Display version information" },
-  { 'c', "colors",   NULL,   "Enable colors" },
-  { 'C', "no-colors", NULL,  "Disable colors" },
+static const arg_opt_t option_table[] = {
+       { '?', "help", NULL, "Show this help message" },
+       { 'V', "version", NULL, "Display version information" },
+       { 'c', "colors", NULL, "Enable colors" },
+       { 'C', "no-colors", NULL, "Disable colors" },
 #ifdef HAVE_GETMOUSE
-  { 'm', "mouse",    NULL,   "Enable mouse" },
-  { 'M', "no-mouse", NULL,   "Disable mouse" },
+       { 'm', "mouse", NULL, "Enable mouse" },
+       { 'M', "no-mouse", NULL, "Disable mouse" },
 #endif
-  { 'e', "exit",     NULL,   "Exit on connection errors" },
-  { 'p', "port",  "PORT", "Connect to server on port [" DEFAULT_PORT_STR "]" },
-  { 'h', "host",  "HOST", "Connect to server on host [" DEFAULT_HOST "]" },
-  { 'P', "password","PASSWORD", "Connect with password" },
-  { 'f', "config",  "FILE",     "Read configuration from file" },
-  { 'k', "key-file","FILE",     "Read configuration from file" },
-  { 'S', "no-splash", NULL, "Don't show the splash screen" },
+       { 'e', "exit", NULL, "Exit on connection errors" },
+       { 'p', "port", "PORT", "Connect to server on port" },
+       { 'h', "host", "HOST", "Connect to server on host" },
+       { 'P', "password","PASSWORD", "Connect with password" },
+       { 'f', "config", "FILE", "Read configuration from file" },
+       { 'k', "key-file","FILE", "Read key bindings from file" },
 #ifndef NDEBUG
-  { 'K', "dump-keys", NULL,     "Dump key bindings to stdout" },
-  { 'D', "debug",   NULL,   "Enable debug output on stderr" },
+       { 'K', "dump-keys", NULL, "Dump key bindings to stdout" },
 #endif
-  { 0, NULL, NULL, NULL },
 };
 
-static arg_opt_t *
+static const unsigned option_table_size = sizeof(option_table) / sizeof(option_table[0]);
+
+static const arg_opt_t *
 lookup_option(int s, char *l)
 {
-  int i;
-
-  i=0;
-  while( option_table[i].descrition )
-    {
-      if( l && strcmp(l, option_table[i].longopt) == 0 )
-       return &option_table[i];;
-      if( s && s==option_table[i].shortopt )
-       return &option_table[i];;
-      i++;
-    }
-  return NULL;
+       unsigned i;
+
+       for (i = 0; i < option_table_size; ++i) {
+               if (l && strcmp(l, option_table[i].longopt) == 0)
+                       return &option_table[i];
+               if (s && s == option_table[i].shortopt)
+                       return &option_table[i];
+       }
+
+       return NULL;
 }
 
 static void
 option_error(int error, const char *option, const char *arg)
 {
-  switch(error)
-    {
-    case ERROR_UNKNOWN_OPTION:
-      fprintf(stderr, PACKAGE ": invalid option %s\n", option);
-      break;
-    case ERROR_BAD_ARGUMENT:
-      fprintf(stderr, PACKAGE ": bad argument: %s\n", option);
-      break;
-    case ERROR_GOT_ARGUMENT:
-      fprintf(stderr, PACKAGE ": invalid option %s=%s\n", option, arg);
-      break;
-    case ERROR_MISSING_ARGUMENT:
-      fprintf(stderr, PACKAGE ": missing value for %s option\n", option);
-      break;
-    default:
-      fprintf(stderr, PACKAGE ": internal error %d\n", error);
-      break;
-    }
-  exit(EXIT_FAILURE);
+       switch (error) {
+       case ERROR_UNKNOWN_OPTION:
+               fprintf(stderr, PACKAGE ": invalid option %s\n", option);
+               break;
+       case ERROR_BAD_ARGUMENT:
+               fprintf(stderr, PACKAGE ": bad argument: %s\n", option);
+               break;
+       case ERROR_GOT_ARGUMENT:
+               fprintf(stderr, PACKAGE ": invalid option %s=%s\n", option, arg);
+               break;
+       case ERROR_MISSING_ARGUMENT:
+               fprintf(stderr, PACKAGE ": missing value for %s option\n", option);
+               break;
+       default:
+               fprintf(stderr, PACKAGE ": internal error %d\n", error);
+               break;
+       }
+
+       exit(EXIT_FAILURE);
 }
 
-static void 
+static void
 display_help(void)
 {
-  int i = 0;
-
-  printf("Usage: %s [OPTION]...\n", PACKAGE);
-  while( option_table[i].descrition )
-    {
-      char tmp[MAX_LONGOPT_LENGTH];
-
-      if( option_table[i].argument )
-       g_snprintf(tmp, MAX_LONGOPT_LENGTH, "%s=%s", 
-                  option_table[i].longopt, 
-                  option_table[i].argument);
-      else
-       g_strlcpy(tmp, option_table[i].longopt, 64);
-
-      printf("  -%c, --%-20s %s\n", 
-            option_table[i].shortopt, 
-            tmp,
-            option_table[i].descrition);
-      i++;
-    }
+       printf("Usage: %s [OPTION]...\n", PACKAGE);
+
+       for (unsigned i = 0; i < option_table_size; ++i) {
+               char tmp[32];
+
+               if (option_table[i].argument)
+                       g_snprintf(tmp, sizeof(tmp), "%s=%s",
+                                  option_table[i].longopt,
+                                  option_table[i].argument);
+               else
+                       g_strlcpy(tmp, option_table[i].longopt, 64);
+
+               printf("  -%c, --%-20s %s\n",
+                      option_table[i].shortopt,
+                      tmp,
+                      option_table[i].descrition);
+       }
 }
 
-static void 
+static void
 handle_option(int c, const char *arg)
 {
-  D("option callback -%c %s\n", c, arg);
-  switch(c)
-    {
-    case '?': /* --help */
-      display_help();
-      exit(EXIT_SUCCESS);
-    case 'V': /* --version */
-      printf("%s version: %s\n", PACKAGE, VERSION);
-      printf("build options:");
+       switch (c) {
+       case '?': /* --help */
+               display_help();
+               exit(EXIT_SUCCESS);
+       case 'V': /* --version */
+               puts(PACKAGE " version: " VERSION "\n"
+                    "build options:"
+#ifdef NCMPC_MINI
+                    " mini"
+#endif
 #ifndef NDEBUG
-      printf(" debug");
+                    " debug"
+#endif
+#ifdef ENABLE_MULTIBYTE
+                    " multibyte"
+#endif
+#ifdef HAVE_CURSES_ENHANCED
+                    " wide"
+#endif
+#ifdef ENABLE_LOCALE
+                    " locale"
 #endif
 #ifdef ENABLE_NLS
-      printf(" nls");
+                    " nls"
+#endif
+#ifdef ENABLE_COLORS
+                    " colors"
+#else
+                    " no-colors"
+#endif
+#ifdef ENABLE_LIRC
+                    " lirc"
 #endif
 #ifdef HAVE_GETMOUSE
-      printf(" getmouse");
+                    " getmouse"
 #endif
 #ifdef ENABLE_ARTIST_SCREEN
-      printf(" artist-screen");
+                    " artist-screen"
+#endif
+#ifdef ENABLE_HELP_SCREEN
+                    " help-screen"
 #endif
 #ifdef ENABLE_SEARCH_SCREEN
-      printf(" search-screen");
+                    " search-screen"
+#endif
+#ifdef ENABLE_SONG_SCREEN
+                    " song-screen"
 #endif
 #ifdef ENABLE_KEYDEF_SCREEN
-      printf(" key-screen");
+                    " key-screen"
 #endif
-      printf("\n");
-      exit(EXIT_SUCCESS);
-    case 'c': /* --colors */
-      options.enable_colors = TRUE;
-      break;
-    case 'C': /* --no-colors */
-      options.enable_colors = FALSE;
-      break;
-    case 'm': /* --mouse */
-     options.enable_mouse = TRUE;
-      break;
-    case 'M': /* --no-mouse */
-      options.enable_mouse = FALSE;
-      break;
-    case 'e': /* --exit */
-      options.reconnect = FALSE;
-      break;
-    case 'p': /* --port */
-      options.port = atoi(arg);
-      break;
-    case 'h': /* --host */
-      if( options.host )
-       g_free(options.host);
-      options.host = g_strdup(arg);
-      break;
-    case 'P': /* --password */
-      if( options.password )
-       g_free(options.password);
-      options.password = locale_to_utf8(arg);
-      break;
-    case 'f': /* --config */
-      if( options.config_file )
-       g_free(options.config_file);
-      options.config_file = g_strdup(arg);
-      break;
-    case 'k': /* --key-file */
-      if( options.key_file )
-       g_free(options.key_file);
-      options.key_file = g_strdup(arg);
-      break;
-    case 'S': /* --key-file */
-      /* the splash screen was removed */
-      break;
-#ifndef NDEBUG
-    case 'K': /* --dump-keys */
-      read_configuration(&options);
-      write_key_bindings(stdout, KEYDEF_WRITE_ALL | KEYDEF_COMMENT_ALL);
-      exit(EXIT_SUCCESS);
-      break;
-    case 'D': /* --debug */
-      options.debug = TRUE;
-      break;
+#ifdef ENABLE_LYRICS_SCREEN
+                    " lyrics-screen"
+#endif
+#ifdef ENABLE_OUTPUTS_SCREEN
+                    " outputs-screen"
 #endif
-    default:
-      fprintf(stderr,"Unknown Option %c = %s\n", c, arg);
-      break;
-    }
+#ifdef ENABLE_CHAT_SCREEN
+                    " chat-screen"
+#endif
+
+                    "\n");
+#ifndef NCMPC_MINI
+               {
+                       char *user_conf = build_user_conf_filename();
+                       char *system_conf = build_system_conf_filename();
+
+                       printf("configuration files:\n %s\n %s\n\n",
+                              user_conf, system_conf);
+
+                       g_free(user_conf);
+                       g_free(system_conf);
+               }
+               if (strcmp("translator-credits", _("translator-credits")) != 0)
+                       /* To translators: these credits are shown
+                          when ncmpc is started with "--version" */
+                       printf("\n%s\n", _("translator-credits"));
+#endif
+               exit(EXIT_SUCCESS);
+       case 'c': /* --colors */
+#ifdef ENABLE_COLORS
+               options.enable_colors = true;
+#endif
+               break;
+       case 'C': /* --no-colors */
+#ifdef ENABLE_COLORS
+               options.enable_colors = false;
+#endif
+               break;
+       case 'm': /* --mouse */
+#ifdef HAVE_GETMOUSE
+               options.enable_mouse = true;
+#endif
+               break;
+       case 'M': /* --no-mouse */
+#ifdef HAVE_GETMOUSE
+               options.enable_mouse = false;
+#endif
+               break;
+       case 'e': /* --exit */
+               /* deprecated */
+               break;
+       case 'p': /* --port */
+               options.port = atoi(arg);
+               break;
+       case 'h': /* --host */
+               g_free(options.host);
+               options.host = g_strdup(arg);
+               break;
+       case 'P': /* --password */
+               g_free(options.password);
+               options.password = locale_to_utf8(arg);
+               break;
+       case 'f': /* --config */
+               g_free(options.config_file);
+               options.config_file = g_strdup(arg);
+               break;
+       case 'k': /* --key-file */
+               g_free(options.key_file);
+               options.key_file = g_strdup(arg);
+               break;
+#if !defined(NDEBUG) && !defined(NCMPC_MINI)
+       case 'K': /* --dump-keys */
+               read_configuration();
+               write_key_bindings(stdout, KEYDEF_WRITE_ALL | KEYDEF_COMMENT_ALL);
+               exit(EXIT_SUCCESS);
+               break;
+#endif
+       default:
+               fprintf(stderr,"Unknown Option %c = %s\n", c, arg);
+               break;
+       }
 }
 
-options_t *
+void
 options_parse(int argc, const char *argv[])
 {
-       int i;
-       arg_opt_t *opt = NULL;
+       const arg_opt_t *opt = NULL;
        option_callback_fn_t option_cb = handle_option;
 
-       i=1;
-       while (i < argc) {
+       for (int i = 1; i < argc; i++) {
                const char *arg = argv[i];
                size_t len = strlen(arg);
 
@@ -242,11 +304,11 @@ options_parse(int argc, const char *argv[])
                if (g_str_has_prefix(arg, "--")) {
                        char *name, *value;
 
-                       /* make shure we got an argument for the previous option */
+                       /* make sure we got an argument for the previous option */
                        if( opt && opt->argument )
                                option_error(ERROR_MISSING_ARGUMENT, opt->longopt, opt->argument);
 
-                       /* retreive a option argument */
+                       /* retrieve a option argument */
                        if ((value=g_strrstr(arg+2, "="))) {
                                *value = '\0';
                                name = g_strdup(arg);
@@ -260,7 +322,7 @@ options_parse(int argc, const char *argv[])
                                option_error(ERROR_UNKNOWN_OPTION, name, NULL);
                        g_free(name);
 
-                       /* abort if we got an argument to the option and dont want one */
+                       /* abort if we got an argument to the option and don't want one */
                        if( value && opt->argument==NULL )
                                option_error(ERROR_GOT_ARGUMENT, arg, value);
 
@@ -275,81 +337,75 @@ options_parse(int argc, const char *argv[])
                        size_t j;
 
                        for(j=1; j<len; j++) {
-                               /* make shure we got an argument for the previous option */
-                               if( opt && opt->argument )
+                               /* make sure we got an argument for the previous option */
+                               if (opt && opt->argument)
                                        option_error(ERROR_MISSING_ARGUMENT,
                                                     opt->longopt, opt->argument);
 
                                /* check if the option exists */
-                               if( (opt=lookup_option(arg[j], NULL))==NULL )
+                               if ((opt=lookup_option(arg[j], NULL)) == NULL)
                                        option_error(ERROR_UNKNOWN_OPTION, arg, NULL);
 
                                /* if no option argument is needed execute callback */
-                               if( opt->argument==NULL ) {
+                               if (opt->argument == NULL) {
                                        option_cb (opt->shortopt, NULL);
                                        opt = NULL;
                                }
                        }
                } else {
                        /* is this a option argument? */
-                       ifopt && opt->argument) {
+                       if (opt && opt->argument) {
                                option_cb (opt->shortopt, arg);
                                opt = NULL;
                        } else
                                option_error(ERROR_BAD_ARGUMENT, arg, NULL);
                }
-               i++;
        }
 
-       if( opt && opt->argument==NULL)
+       if (opt && opt->argument == NULL)
                option_cb (opt->shortopt, NULL);
-       else if( opt && opt->argument )
+       else if (opt && opt->argument)
                option_error(ERROR_MISSING_ARGUMENT, opt->longopt, opt->argument);
 
-       return  &options;
+       if (!options.host && getenv("MPD_HOST")) {
+               g_free(options.host);
+               options.host = g_strdup(getenv("MPD_HOST"));
+       }
 }
 
-options_t *
-options_init( void )
+void
+options_init(void)
 {
-       const char *value;
-       char *tmp;
-
-       memset(&options, 0, sizeof(options_t));
-
-       /* get initial values for host and password from MPD_HOST (enviroment) */
-       if ((value=g_getenv(MPD_HOST_ENV)))
-               options.host = g_strdup(value);
-       else
-               options.host = g_strdup(DEFAULT_HOST);
-
-       if ((tmp=g_strstr_len(options.host, strlen(options.host), "@"))) {
-               char *oldhost = options.host;
-               *tmp  = '\0';
-               options.password = locale_to_utf8(oldhost);
-               options.host = g_strdup(tmp+1);
-               g_free(oldhost);
-       }
-
-       /* get initial values for port from MPD_PORT (enviroment) */
-       if ((value=g_getenv(MPD_PORT_ENV)))
-               options.port = atoi(value);
-       else
-               options.port = DEFAULT_PORT;
-
        /* default option values */
-       options.reconnect = TRUE;
-       options.find_wrap = TRUE;
-       options.wide_cursor = TRUE;
-       options.welcome_screen_list = TRUE;
-       options.audible_bell = TRUE;
-       options.crossfade_time = DEFAULT_CROSSFADE_TIME;
-       options.seek_time = 1;
+       options.list_format = g_strdup(DEFAULT_LIST_FORMAT);
+       options.search_format = NULL;
+       options.status_format = g_strdup(DEFAULT_STATUS_FORMAT);
        options.screen_list = g_strsplit_set(DEFAULT_SCREEN_LIST, " ", 0);
-       options.timedisplay_type = g_strdup(DEFAULT_TIMEDISPLAY_TYPE);
-       options.lyrics_timeout = DEFAULT_LYRICS_TIMEOUT;
-       options.scroll = DEFAULT_SCROLL;
+#ifndef NCMPC_MINI
        options.scroll_sep = g_strdup(DEFAULT_SCROLL_SEP);
+#endif
+}
 
-       return &options;
+void
+options_deinit(void)
+{
+       g_free(options.host);
+       g_free(options.username);
+       g_free(options.password);
+       g_free(options.config_file);
+       g_free(options.key_file);
+       g_free(options.list_format);
+       g_free(options.search_format);
+       g_free(options.status_format);
+       g_strfreev(options.screen_list);
+#ifndef NCMPC_MINI
+       g_free(options.xterm_title_format);
+       g_free(options.scroll_sep);
+#endif
+#ifdef ENABLE_LYRICS_SCREEN
+       g_free(options.text_editor);
+#endif
+#ifdef ENABLE_CHAT_SCREEN
+       g_free(options.chat_prefix);
+#endif
 }