X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;f=src%2Fconf.c;h=81c280a405fcd85c7ac0062cc2923015887a9ae9;hb=bf5fc85f37af5698d477edc5dae250bf8984ed00;hp=0d80ce18427613244dc3354c3d24ea0805e48a72;hpb=e131d3f01174e54402c8872d83d9edbc246b38d1;p=ncmpc.git diff --git a/src/conf.c b/src/conf.c index 0d80ce1..81c280a 100644 --- a/src/conf.c +++ b/src/conf.c @@ -1,5 +1,6 @@ -/* - * (c) 2004 by Kalle Wallin +/* 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 @@ -10,10 +11,10 @@ * 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 "conf.h" @@ -23,30 +24,30 @@ #include "command.h" #include "colors.h" #include "screen_list.h" +#include "options.h" +#include #include #include #include #include -#include #include -#include -#include -#include #include +#include #define MAX_LINE_LENGTH 1024 #define COMMENT_TOKEN '#' /* configuration field names */ #define CONF_ENABLE_COLORS "enable-colors" +#define CONF_SCROLL_OFFSET "scroll-offset" #define CONF_AUTO_CENTER "auto-center" #define CONF_WIDE_CURSOR "wide-cursor" -#define CONF_ENABLE_BELL "enable-bell" #define CONF_KEY_DEFINITION "key" #define CONF_COLOR "color" #define CONF_COLOR_DEFINITION "colordef" #define CONF_LIST_FORMAT "list-format" +#define CONF_SEARCH_FORMAT "search-format" #define CONF_STATUS_FORMAT "status-format" #define CONF_XTERM_TITLE_FORMAT "xterm-title-format" #define CONF_LIST_WRAP "wrap-around" @@ -54,6 +55,8 @@ #define CONF_FIND_SHOW_LAST "find-show-last" #define CONF_AUDIBLE_BELL "audible-bell" #define CONF_VISIBLE_BELL "visible-bell" +#define CONF_BELL_ON_WRAP "bell-on-wrap" +#define CONF_STATUS_MESSAGE_TIME "status-message-time" #define CONF_XTERM_TITLE "set-xterm-title" #define CONF_ENABLE_MOUSE "enable-mouse" #define CONF_CROSSFADE_TIME "crossfade-time" @@ -65,20 +68,43 @@ #define CONF_HOST "host" #define CONF_PORT "port" #define CONF_PASSWORD "password" +#define CONF_TIMEOUT "timeout" #define CONF_LYRICS_TIMEOUT "lyrics-timeout" -#define CONF_SHOW_SPLASH "show-splash" #define CONF_SCROLL "scroll" #define CONF_SCROLL_SEP "scroll-sep" #define CONF_VISIBLE_BITRATE "visible-bitrate" +#define CONF_HARDWARE_CURSOR "hardware-cursor" #define CONF_WELCOME_SCREEN_LIST "welcome-screen-list" +#define CONF_DISPLAY_TIME "display-time" +#define CONF_JUMP_PREFIX_ONLY "jump-prefix-only" +#define CONF_LYRICS_AUTOSAVE "lyrics-autosave" +#define CONF_LYRICS_SHOW_PLUGIN "lyrics-show-plugin" +#define CONF_TEXT_EDITOR "text-editor" +#define CONF_TEXT_EDITOR_ASK "text-editor-ask" +#define CONF_CHAT_PREFIX "chat-prefix" +#define CONF_SECOND_COLUMN "second-column" + +gcc_const +static bool +is_space_not_null(char ch) +{ + unsigned char uch = (unsigned char)ch; + return uch <= 0x20 && uch > 0; +} -typedef enum { - KEY_PARSER_UNKNOWN, - KEY_PARSER_CHAR, - KEY_PARSER_DEC, - KEY_PARSER_HEX, - KEY_PARSER_DONE -} key_parser_state_t; +/** + * Returns the first non-space character (or a pointer to the null + * terminator). Similar to g_strchug(), but just moves the pointer + * forward without modifying the string contents. + */ +gcc_pure +static char * +skip_spaces(char *p) +{ + while (is_space_not_null(*p)) + ++p; + return p; +} static bool str2bool(char *str) @@ -95,92 +121,69 @@ print_error(const char *msg, const char *input) _("Error"), msg, input); } -static int -parse_key_value(char *str, size_t len, char **end) +gcc_const +static bool +is_word_char(char ch) { - size_t i; - int value; - key_parser_state_t state; - - i=0; - value=0; - state=KEY_PARSER_UNKNOWN; - *end = str; - - while (i < len && state != KEY_PARSER_DONE) { - int next = 0; - int c = str[i]; - - if( i+1 str+len ) - *end = str+len; + ++p; + + while (is_word_char(*p)) + ++p; - return value; + return p; } static int -parse_key_definition(char *str) +parse_key_value(char *str, char **end) { - char buf[MAX_LINE_LENGTH]; - char *p, *end; - size_t len = strlen(str), i; - int j,key; - int keys[MAX_COMMAND_KEYS]; - command_t cmd; + if (*str == '\'') { + if (str[1] == '\'' || str[2] != '\'') { + print_error(_("Malformed hotkey definition"), str); + return -1; + } + + *end = str + 3; + return str[1]; + } else { + long value = strtol(str, end, 0); + if (*end == str) { + print_error(_("Malformed hotkey definition"), str); + return -1; + } + + return (int)value; + } +} +static bool +parse_key_definition(char *str) +{ /* get the command name */ - i=0; - j=0; + const size_t len = strlen(str); + size_t i = 0; + int j = 0; + char buf[MAX_LINE_LENGTH]; memset(buf, 0, MAX_LINE_LENGTH); while (i < len && str[i] != '=' && !g_ascii_isspace(str[i])) buf[j++] = str[i++]; - if( (cmd=get_key_command_from_name(buf)) == CMD_NONE ) { - print_error(_("Unknown key command"), buf); - return -1; + + command_t cmd = get_key_command_from_name(buf); + if(cmd == CMD_NONE) { + /* the hotkey configuration contains an unknown + command */ + print_error(_("Unknown command"), buf); + return false; } /* skip whitespace */ @@ -190,132 +193,137 @@ parse_key_definition(char *str) /* get the value part */ memset(buf, 0, MAX_LINE_LENGTH); g_strlcpy(buf, str+i, MAX_LINE_LENGTH); - len = strlen(buf); - if (len == 0) { - print_error(_("Incomplete key definition"), str); - return -1; + if (*buf == 0) { + /* the hotkey configuration line is incomplete */ + print_error(_("Incomplete hotkey configuration"), str); + return false; } /* parse key values */ i = 0; - key = 0; - len = strlen(buf); - p = buf; - end = buf+len; + int key = 0; + char *p = buf; + + int keys[MAX_COMMAND_KEYS]; memset(keys, 0, sizeof(int)*MAX_COMMAND_KEYS); - while (i < MAX_COMMAND_KEYS && p < end && - (key = parse_key_value(p, len + 1, &p)) >= 0) { + while (i < MAX_COMMAND_KEYS && *p != 0 && + (key = parse_key_value(p, &p)) >= 0) { keys[i++] = key; - while (p < end && (*p==',' || *p==' ' || *p=='\t')) + while (*p==',' || *p==' ' || *p=='\t') p++; - len = strlen(p); } - if (key < 0) { - print_error(_("Bad key definition"), str); - return -1; - } + if (key < 0) + return false; return assign_keys(cmd, keys); } -static const char * +static bool parse_timedisplay_type(const char *str) { - if (!strcmp(str,"elapsed") || !strcmp(str,"remaining")) - return str; + if (strcmp(str, "elapsed") == 0) + return false; + else if (strcmp(str, "remaining") == 0) + return true; else { + /* translators: ncmpc supports displaying the + "elapsed" or "remaining" time of a song being + played; in this case, the configuration file + contained an invalid setting */ print_error(_("Bad time display type"), str); - return DEFAULT_TIMEDISPLAY_TYPE; + return false; } } #ifdef ENABLE_COLORS -static int +static char * +separate_value(char *p) +{ + char *value = strchr(p, '='); + if (value == NULL) { + /* an equals sign '=' was expected while parsing a + configuration file line */ + fprintf(stderr, "%s\n", _("Missing '='")); + return NULL; + } + + *value++ = 0; + + g_strchomp(p); + return skip_spaces(value); +} + +static bool parse_color(char *str) { - const char *name = str; - const char *value = NULL; - int len,i; + char *value = separate_value(str); + if (value == NULL) + return false; - i=0; - len=strlen(str); - /* get the color name */ - while (i < len && str[i] != '=' && !g_ascii_isspace(str[i])) - i++; + return colors_assign(str, value); +} - /* skip whitespace */ - while (i < len && (str[i] == '=' || g_ascii_isspace(str[i]))) { - str[i]='\0'; - i++; - } +/** + * Returns the first non-whitespace character after the next comma + * character, or the end of the string. This is used to parse comma + * separated values. + */ +static char * +after_comma(char *p) +{ + char *comma = strchr(p, ','); - if (i < len) - value = str+i; + if (comma != NULL) { + *comma++ = 0; + comma = skip_spaces(comma); + } else + comma = p + strlen(p); - return colors_assign(name, value); + g_strchomp(p); + return comma; } -static int +static bool parse_color_definition(char *str) { - char buf[MAX_LINE_LENGTH]; - char *p, *end, *name; - size_t len = strlen(str), i; - int j,value; - short color, rgb[3]; + char *value = separate_value(str); + if (value == NULL) + return false; /* get the command name */ - i=0; - j=0; - memset(buf, 0, MAX_LINE_LENGTH); - while (i < len && str[i] != '=' && !g_ascii_isspace(str[i])) - buf[j++] = str[i++]; - color = colors_str2color(buf); + short color = colors_str2color(str); if (color < 0) { - print_error(_("Bad color"), buf); - return -1; + char buf[MAX_LINE_LENGTH]; + print_error(_("Bad color name"), buf); + return false; } - name = g_strdup(buf); - /* skip whitespace */ - while (i < len && (str[i] == '=' || g_ascii_isspace(str[i]))) - i++; + /* parse r,g,b values */ - /* get the value part */ - memset(buf, 0, MAX_LINE_LENGTH); - g_strlcpy(buf, str+i, MAX_LINE_LENGTH); - len = strlen(buf); - if (len == 0) { - print_error(_("Incomplete color definition"), str); - g_free(name); - return -1; - } + short rgb[3]; + for (unsigned i = 0; i < 3; ++i) { + char *next = after_comma(value), *endptr; + if (*value == 0) { + print_error(_("Incomplete color definition"), str); + return false; + } - /* parse r,g.b values with the key definition parser */ - i = 0; - value = 0; - len = strlen(buf); - p = buf; - end = buf + len; - memset(rgb, 0, sizeof(short)*3); - while (i < 3 && p < end && - (value = parse_key_value(p,len+1,&p)) >= 0) { - rgb[i++] = value; - while( p milliseconds */; else if (!strcasecmp(CONF_LYRICS_TIMEOUT, name)) #ifdef ENABLE_LYRICS_SCREEN options.lyrics_timeout = atoi(get_format(value)); @@ -489,33 +545,76 @@ parse_line(char *line) else if (!strcasecmp(CONF_SCROLL_SEP, name)) { g_free(options.scroll_sep); options.scroll_sep = get_format(value); - } else - match_found = false; - - if (!match_found) - print_error(_("Unknown configuration parameter"), - name); + } else if (!strcasecmp(CONF_DISPLAY_TIME, name)) + /* obsolete, ignore */ + {} + else if (!strcasecmp(CONF_JUMP_PREFIX_ONLY, name)) +#ifdef NCMPC_MINI + {} +#else + options.jump_prefix_only = str2bool(value); +#endif + else if (!strcasecmp(CONF_LYRICS_AUTOSAVE, name)) +#ifdef ENABLE_LYRICS_SCREEN + options.lyrics_autosave = str2bool(value); +#else + {} +#endif + else if (!strcasecmp(CONF_LYRICS_SHOW_PLUGIN, name)) +#ifdef ENABLE_LYRICS_SCREEN + options.lyrics_show_plugin = str2bool(value); +#else + {} +#endif + else if (!strcasecmp(name, CONF_TEXT_EDITOR)) +#ifdef ENABLE_LYRICS_SCREEN + { + g_free(options.text_editor); + options.text_editor = get_format(value); + } +#else + {} +#endif + else if (!strcasecmp(name, CONF_TEXT_EDITOR_ASK)) +#ifdef ENABLE_LYRICS_SCREEN + options.text_editor_ask = str2bool(value); +#else + {} +#endif + else if (!strcasecmp(name, CONF_CHAT_PREFIX)) +#ifdef ENABLE_CHAT_SCREEN + options.chat_prefix = get_format(value); +#else + {} +#endif + else if (!strcasecmp(CONF_SECOND_COLUMN, name)) +#ifdef NCMPC_MINI + {} +#else + options.second_column = str2bool(value); +#endif + else { + print_error(_("Unknown configuration parameter"), name); + return false; + } - return match_found; + return true; } static int read_rc_file(char *filename) { - FILE *file; - char line[MAX_LINE_LENGTH]; - - if (filename == NULL) - return -1; + assert(filename != NULL); - file = fopen(filename, "r"); + FILE *file = fopen(filename, "r"); if (file == NULL) { - perror(filename); - return -1; - } + perror(filename); + return -1; + } + char line[MAX_LINE_LENGTH]; while (fgets(line, sizeof(line), file) != NULL) { - char *p = g_strchug(line); + char *p = skip_spaces(line); if (*p != 0 && *p != COMMENT_TOKEN) parse_line(g_strchomp(p)); @@ -525,91 +624,153 @@ read_rc_file(char *filename) return 0; } -int +bool check_user_conf_dir(void) { - int retval; char *directory = g_build_filename(g_get_home_dir(), "." PACKAGE, NULL); if (g_file_test(directory, G_FILE_TEST_IS_DIR)) { g_free(directory); - return 0; + return true; } - retval = mkdir(directory, 0755); + bool success = g_mkdir(directory, 0755) == 0; g_free(directory); - return retval; + return success; } char * -get_user_key_binding_filename(void) +build_user_conf_filename(void) { +#ifdef WIN32 + return g_build_filename(g_get_user_config_dir(), PACKAGE, "ncmpc.conf", NULL); +#else + return g_build_filename(g_get_home_dir(), "." PACKAGE, "config", NULL); +#endif +} + +char * +build_system_conf_filename(void) +{ +#ifdef WIN32 + const gchar* const *system_data_dirs; + gchar *pathname = NULL; + + for (system_data_dirs = g_get_system_config_dirs (); *system_data_dirs != NULL; system_data_dirs++) + { + pathname = g_build_filename(*system_data_dirs, PACKAGE, "ncmpc.conf", NULL); + if (g_file_test(pathname, G_FILE_TEST_EXISTS)) + { + break; + } + else + { + g_free (pathname); + pathname = NULL; + } + } + return pathname; +#else + return g_build_filename(SYSCONFDIR, PACKAGE, "config", NULL); +#endif +} + +char * +build_user_key_binding_filename(void) +{ +#ifdef WIN32 + return g_build_filename(g_get_user_config_dir(), PACKAGE, "keys.conf", NULL); +#else return g_build_filename(g_get_home_dir(), "." PACKAGE, "keys", NULL); +#endif } -int -read_configuration(void) +static char * +g_build_system_key_binding_filename(void) { - char *filename = NULL; +#ifdef WIN32 + const gchar* const *system_data_dirs; + gchar *pathname = NULL; + + for (system_data_dirs = g_get_system_config_dirs (); *system_data_dirs != NULL; system_data_dirs++) + { + pathname = g_build_filename(*system_data_dirs, PACKAGE, "keys.conf", NULL); + if (g_file_test(pathname, G_FILE_TEST_EXISTS)) + { + break; + } + else + { + g_free (pathname); + pathname = NULL; + } + } + return pathname; +#else + return g_build_filename(SYSCONFDIR, PACKAGE, "keys", NULL); +#endif +} +static char * +find_config_file(void) +{ /* check for command line configuration file */ - if (options.config_file) - filename = g_strdup(options.config_file); + if (options.config_file != NULL) + return g_strdup(options.config_file); /* check for user configuration ~/.ncmpc/config */ - if (filename == NULL) { - filename = g_build_filename(g_get_home_dir(), - "." PACKAGE, "config", NULL); - if (!g_file_test(filename, G_FILE_TEST_IS_REGULAR)) { - g_free(filename); - filename = NULL; - } - } + char *filename = build_user_conf_filename(); + if (g_file_test(filename, G_FILE_TEST_IS_REGULAR)) + return filename; + + g_free(filename); /* check for global configuration SYSCONFDIR/ncmpc/config */ - if (filename == NULL) { - filename = g_build_filename(SYSCONFDIR, PACKAGE, "config", NULL); - if (!g_file_test(filename, G_FILE_TEST_IS_REGULAR)) { - g_free(filename); - filename = NULL; - } - } + filename = build_system_conf_filename(); + if (g_file_test(filename, G_FILE_TEST_IS_REGULAR)) + return filename; - /* load configuration */ - if (filename) { - read_rc_file(filename); - g_free(filename); - filename = NULL; - } + g_free(filename); + return NULL; +} +static char * +find_keys_file(void) +{ /* check for command line key binding file */ - if (options.key_file) - filename = g_strdup(options.key_file); + if (options.key_file != NULL) + return g_strdup(options.key_file); /* check for user key bindings ~/.ncmpc/keys */ - if (filename == NULL) { - filename = get_user_key_binding_filename(); - if (!g_file_test(filename, G_FILE_TEST_IS_REGULAR)) { - g_free(filename); - filename = NULL; - } - } + char *filename = build_user_key_binding_filename(); + if (g_file_test(filename, G_FILE_TEST_IS_REGULAR)) + return filename; + + g_free(filename); /* check for global key bindings SYSCONFDIR/ncmpc/keys */ - if (filename == NULL) { - filename = g_build_filename(SYSCONFDIR, PACKAGE, "keys", NULL); - if (!g_file_test(filename, G_FILE_TEST_IS_REGULAR)) { - g_free(filename); - filename = NULL; - } + filename = g_build_system_key_binding_filename(); + if (g_file_test(filename, G_FILE_TEST_IS_REGULAR)) + return filename; + + g_free(filename); + return NULL; +} + +void +read_configuration(void) +{ + /* load configuration */ + char *filename = find_config_file(); + if (filename != NULL) { + read_rc_file(filename); + g_free(filename); } /* load key bindings */ - if (filename) { + filename = find_keys_file(); + if (filename != NULL) { read_rc_file(filename); g_free(filename); - filename = NULL; } - - return 0; }