Remove special handling of script search path on Windows
[fw/openocd] / src / helper / options.c
index b6b2c6dcc9302e882655f9c518ffb8b57e9d19ab..00f1dbed600dc2e0c55b4841503eae2eae0c0100 100644 (file)
-/***************************************************************************\r
- *   Copyright (C) 2004, 2005 by Dominic Rath                              *\r
- *   Dominic.Rath@gmx.de                                                   *\r
- *                                                                         *\r
- *   This program is free software; you can redistribute it and/or modify  *\r
- *   it under the terms of the GNU General Public License as published by  *\r
- *   the Free Software Foundation; either version 2 of the License, or     *\r
- *   (at your option) any later version.                                   *\r
- *                                                                         *\r
- *   This program is distributed in the hope that it will be useful,       *\r
- *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *\r
- *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *\r
- *   GNU General Public License for more details.                          *\r
- *                                                                         *\r
- *   You should have received a copy of the GNU General Public License     *\r
- *   along with this program; if not, write to the                         *\r
- *   Free Software Foundation, Inc.,                                       *\r
- *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *\r
- ***************************************************************************/\r
-#ifdef HAVE_CONFIG_H\r
-#include "config.h"\r
-#endif\r
-\r
-#include "types.h"\r
-#include "command.h"\r
-#include "configuration.h"\r
-#include "log.h"\r
-\r
-#include <stdio.h>\r
-#include <stdlib.h>\r
-#include <getopt.h>\r
-#include <string.h>\r
-\r
-\r
-static int help_flag;\r
-\r
-static struct option long_options[] =\r
-{\r
-       {"help",                        no_argument,    &help_flag, 1},\r
-\r
-       {"debug",                       optional_argument,      0, 'd'},\r
-       {"file",                        required_argument,      0, 'f'},\r
-       {"search",                      required_argument,      0, 's'},\r
-       {"log_output",          required_argument,      0, 'l'},\r
-       {"command",                     required_argument,      0, 'c'},\r
-       \r
-       {0, 0, 0, 0}\r
-};\r
-\r
-\r
-\r
-int configuration_output_handler(struct command_context_s *context, char* line)\r
-{\r
-       INFO(line);\r
-\r
-       return ERROR_OK;\r
-}\r
-\r
-\r
-int parse_cmdline_args(struct command_context_s *cmd_ctx, int argc, char *argv[])\r
-{\r
-       int c;\r
-       char command_buffer[128];\r
-\r
-       while (1)\r
-       {       \r
-               /* getopt_long stores the option index here. */\r
-               int option_index = 0;\r
-               \r
-               c = getopt_long(argc, argv, "hd::l:f:s:c:", long_options, &option_index);\r
-               \r
-               /* Detect the end of the options. */\r
-               if (c == -1)\r
-                       break;\r
-               \r
-               switch (c)\r
-               {\r
-                       case 0:\r
-                               break;\r
-                       case 'h':       /* --help | -h */\r
-                               help_flag = 1;\r
-                               break;\r
-                       case 'f':       /* --file | -f */\r
-                               snprintf(command_buffer, 128, "script %s", optarg);\r
-                               add_config_file_name(command_buffer);\r
-                               break;\r
-                       case 's':       /* --search | -s */\r
-                               add_script_search_dir(optarg);\r
-                               break;\r
-                       case 'd':       /* --debug | -d */\r
-                               if (optarg)\r
-                                       snprintf(command_buffer, 128, "debug_level %s", optarg);\r
-                               else\r
-                                       snprintf(command_buffer, 128, "debug_level 3");\r
-                               command_run_line(cmd_ctx, command_buffer);\r
-                               break;\r
-                       case 'l':       /* --log_output | -l */\r
-                               if (optarg)\r
-                               {\r
-                                       snprintf(command_buffer, 128, "log_output %s", optarg);\r
-                                       command_run_line(cmd_ctx, command_buffer);\r
-                               }       \r
-                               break;\r
-                       case 'c':       /* --command | -c */\r
-                               if (optarg)\r
-                               {\r
-                                       add_config_file_name(optarg);\r
-                               }       \r
-                               break;\r
-                               \r
-               }\r
-       }\r
-\r
-       if (help_flag)\r
-       {\r
-               printf("Open On-Chip Debugger\n(c) 2005 by Dominic Rath\n\n");\r
-               printf("--help       | -h\tdisplay this help\n");\r
-               printf("--file       | -f\tuse configuration file <name>\n");\r
-               printf("--search     | -s\tdir to search for config files and scripts.\n");\r
-               printf("--debug      | -d\tset debug level <0-3>\n");\r
-               printf("--log_output | -l\tredirect log output to file <name>\n");\r
-               printf("--command    | -c\trun <command>\n");\r
-               exit(-1);\r
-       }       \r
-\r
-       /* Add dir for openocd supplied scripts last so that user can over\r
-          ride those scripts if desired. */\r
-       add_script_search_dir(PKGDATADIR);\r
-       add_script_search_dir(PKGLIBDIR);\r
-\r
-       return ERROR_OK;\r
-}\r
+/***************************************************************************
+ *   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     *
+ *   (at your option) any later version.                                   *
+ *                                                                         *
+ *   This program is distributed in the hope that it will be useful,       *
+ *   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.,                                       *
+ *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.           *
+ ***************************************************************************/
+
+#ifdef HAVE_CONFIG_H
+#include "config.h"
+#endif
+
+#include "configuration.h"
+/* @todo the inclusion of server.h here is a layering violation */
+#include <server/server.h>
+
+#include <getopt.h>
+
+static int help_flag, version_flag;
+
+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 *context, const char *line)
+{
+       LOG_USER_N("%s", line);
+
+       return ERROR_OK;
+}
+
+#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
+       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
+       run_prefix = "";
+#endif
+
+       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);
+               }
+       }
+
+       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 *cmd_ctx, int argc, char *argv[])
+{
+       int c;
+       char command_buffer[128];
+
+       while (1) {
+               /* getopt_long stores the option index here. */
+               int option_index = 0;
+
+               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) {
+                       case 0:
+                               break;
+                       case 'h':               /* --help | -h */
+                               help_flag = 1;
+                               break;
+                       case 'v':               /* --version | -v */
+                               version_flag = 1;
+                               break;
+                       case 'f':               /* --file | -f */
+                       {
+                               snprintf(command_buffer, 128, "script {%s}", optarg);
+                               add_config_command(command_buffer);
+                               break;
+                       }
+                       case 's':               /* --search | -s */
+                               add_script_search_dir(optarg);
+                               break;
+                       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) {
+                                       snprintf(command_buffer, 128, "log_output %s", optarg);
+                                       command_run_line(cmd_ctx, command_buffer);
+                               }
+                               break;
+                       case 'c':               /* --command | -c */
+                               if (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\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 <name>\n");
+               LOG_OUTPUT("--search     | -s\tdir to search for config files and scripts\n");
+               LOG_OUTPUT("--debug      | -d\tset debug level <0-3>\n");
+               LOG_OUTPUT("--log_output | -l\tredirect log output to file <name>\n");
+               LOG_OUTPUT("--command    | -c\trun <command>\n");
+               exit(-1);
+       }
+
+       if (version_flag) {
+               /* Nothing to do, version gets printed automatically. */
+               /* 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;
+}