X-Git-Url: https://review.openocd.org/gitweb?a=blobdiff_plain;f=src%2Fhelper%2Foptions.c;h=a378131a60df234e89eea68d59d33a3c09d529d5;hb=a74b5687a7195a6d816a251df59af21acf05aae6;hp=4922aa8772349dd47be6d2efe537ec5499691407;hpb=6e5416106e8e6305c48f09f810d4535fe7acec3e;p=openocd.git diff --git a/src/helper/options.c b/src/helper/options.c index 4922aa8772..a378131a60 100644 --- a/src/helper/options.c +++ b/src/helper/options.c @@ -2,6 +2,9 @@ * Copyright (C) 2004, 2005 by Dominic Rath * * Dominic.Rath@gmx.de * * * + * Copyright (C) 2007-2010 Øyvind Harboe * + * oyvind.harboe@zylin.com * + * * * 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 * * the Free Software Foundation; either version 2 of the License, or * @@ -15,135 +18,188 @@ * 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. * + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. * ***************************************************************************/ + #ifdef HAVE_CONFIG_H #include "config.h" #endif -#include "types.h" -#include "command.h" #include "configuration.h" -#include "log.h" +/* @todo the inclusion of server.h here is a layering violation */ +#include -#include -#include #include -#include static int help_flag, version_flag; -static struct option long_options[] = -{ - {"help", no_argument, &help_flag, 1}, - {"version", no_argument, &version_flag, 1}, - {"debug", optional_argument, 0, 'd'}, - {"file", required_argument, 0, 'f'}, - {"search", required_argument, 0, 's'}, - {"log_output", required_argument, 0, 'l'}, - {"command", required_argument, 0, 'c'}, +static const struct option long_options[] = { + {"help", no_argument, &help_flag, 1}, + {"version", no_argument, &version_flag, 1}, + {"debug", optional_argument, 0, 'd'}, + {"file", required_argument, 0, 'f'}, + {"search", required_argument, 0, 's'}, + {"log_output", required_argument, 0, 'l'}, + {"command", required_argument, 0, 'c'}, + {"pipe", no_argument, 0, 'p'}, {0, 0, 0, 0} }; -int configuration_output_handler(struct command_context_s *context, const char* line) +int configuration_output_handler(struct command_context *context, const char *line) { - LOG_USER_N(line); + LOG_USER_N("%s", line); return ERROR_OK; } -int add_default_dirs(void) +#ifdef _WIN32 +static char *find_suffix(const char *text, const char *suffix) +{ + size_t text_len = strlen(text); + size_t suffix_len = strlen(suffix); + + if (suffix_len == 0) + return (char *)text + text_len; + + if (suffix_len > text_len || strncmp(text + text_len - suffix_len, suffix, suffix_len) != 0) + return NULL; /* Not a suffix of text */ + + return (char *)text + text_len - suffix_len; +} +#endif + +static void add_default_dirs(void) { + const char *run_prefix; + char *path; + #ifdef _WIN32 - /* Add the parent of the directory where openocd.exe resides to the - * config script search path. - * Directory layout: - * bin\openocd.exe - * lib\openocd - * event\at91eb40a_reset.cfg - * target\at91eb40a.cfg - */ - { - char strExePath [MAX_PATH]; - GetModuleFileName (NULL, strExePath, MAX_PATH); - /* Either this code will *always* work or it will SEGFAULT giving - * excellent information on the culprit. - */ - *strrchr(strExePath, '\\')=0; - strcat(strExePath, "\\.."); - add_script_search_dir(strExePath); + char strExePath[MAX_PATH]; + GetModuleFileName(NULL, strExePath, MAX_PATH); + + /* Strip executable file name, leaving path */ + *strrchr(strExePath, '\\') = '\0'; + + /* Convert path separators to UNIX style, should work on Windows also. */ + for (char *p = strExePath; *p; p++) { + if (*p == '\\') + *p = '/'; } + + char *end_of_prefix = find_suffix(strExePath, BINDIR); + if (end_of_prefix != NULL) + *end_of_prefix = '\0'; + + run_prefix = strExePath; #else - /* Add dir for openocd supplied scripts last so that user can over - ride those scripts if desired. */ - add_script_search_dir(PKGDATADIR); - add_script_search_dir(PKGLIBDIR); + run_prefix = ""; #endif - return ERROR_OK; + + LOG_DEBUG("bindir=%s", BINDIR); + LOG_DEBUG("pkgdatadir=%s", PKGDATADIR); + LOG_DEBUG("run_prefix=%s", run_prefix); + + /* + * The directory containing OpenOCD-supplied scripts should be + * listed last in the built-in search order, so the user can + * override these scripts with site-specific customizations. + */ + const char *home = getenv("HOME"); + + if (home) { + path = alloc_printf("%s/.openocd", home); + if (path) { + add_script_search_dir(path); + free(path); + } + } +#ifdef _WIN32 + const char *appdata = getenv("APPDATA"); + + if (appdata) { + path = alloc_printf("%s/OpenOCD", appdata); + if (path) { + add_script_search_dir(path); + free(path); + } + } +#endif + + path = alloc_printf("%s%s%s", run_prefix, PKGDATADIR, "/site"); + if (path) { + add_script_search_dir(path); + free(path); + } + + path = alloc_printf("%s%s%s", run_prefix, PKGDATADIR, "/scripts"); + if (path) { + add_script_search_dir(path); + free(path); + } } -int parse_cmdline_args(struct command_context_s *cmd_ctx, int argc, char *argv[]) +int parse_cmdline_args(struct command_context *cmd_ctx, int argc, char *argv[]) { int c; char command_buffer[128]; - while (1) - { + while (1) { /* getopt_long stores the option index here. */ int option_index = 0; - - c = getopt_long(argc, argv, "hvd::l:f:s:c:", long_options, &option_index); - + + c = getopt_long(argc, argv, "hvd::l:f:s:c:p", long_options, &option_index); + /* Detect the end of the options. */ if (c == -1) break; - - switch (c) - { + + switch (c) { case 0: break; - case 'h': /* --help | -h */ + case 'h': /* --help | -h */ help_flag = 1; break; - case 'v': /* --version | -v */ + case 'v': /* --version | -v */ version_flag = 1; break; - case 'f': /* --file | -f */ + case 'f': /* --file | -f */ { snprintf(command_buffer, 128, "script {%s}", optarg); add_config_command(command_buffer); break; } - case 's': /* --search | -s */ + case 's': /* --search | -s */ add_script_search_dir(optarg); break; - case 'd': /* --debug | -d */ + case 'd': /* --debug | -d */ if (optarg) snprintf(command_buffer, 128, "debug_level %s", optarg); else snprintf(command_buffer, 128, "debug_level 3"); command_run_line(cmd_ctx, command_buffer); break; - case 'l': /* --log_output | -l */ - if (optarg) - { + case 'l': /* --log_output | -l */ + if (optarg) { snprintf(command_buffer, 128, "log_output %s", optarg); command_run_line(cmd_ctx, command_buffer); - } + } break; - case 'c': /* --command | -c */ + case 'c': /* --command | -c */ if (optarg) - { - add_config_command(optarg); - } + add_config_command(optarg); + break; + case 'p': + /* to replicate the old syntax this needs to be synchronous + * otherwise the gdb stdin will overflow with the warning message */ + command_run_line(cmd_ctx, "gdb_port pipe; log_output openocd.log"); + LOG_WARNING("deprecated option: -p/--pipe. Use '-c \"gdb_port pipe; " + "log_output openocd.log\"' instead."); break; - } } - if (help_flag) - { - LOG_OUTPUT("Open On-Chip Debugger\n(c) 2005-2008 by Dominic Rath\n\n"); + if (help_flag) { + LOG_OUTPUT("Open On-Chip Debugger\nLicensed under GNU GPL v2\n"); LOG_OUTPUT("--help | -h\tdisplay this help\n"); LOG_OUTPUT("--version | -v\tdisplay OpenOCD version\n"); LOG_OUTPUT("--file | -f\tuse configuration file \n"); @@ -152,14 +208,18 @@ int parse_cmdline_args(struct command_context_s *cmd_ctx, int argc, char *argv[] LOG_OUTPUT("--log_output | -l\tredirect log output to file \n"); LOG_OUTPUT("--command | -c\trun \n"); exit(-1); - } + } - if (version_flag) - { + if (version_flag) { /* Nothing to do, version gets printed automatically. */ - exit(-1); - } + /* It is not an error to request the VERSION number. */ + exit(0); + } + /* paths specified on the command line take precedence over these + * built-in paths + */ + add_default_dirs(); return ERROR_OK; }