Remove special handling of script search path on Windows
[fw/openocd] / src / helper / options.c
index 2ac9143e6de1991aab1a8cf5e188c8f59d75ce65..00f1dbed600dc2e0c55b4841503eae2eae0c0100 100644 (file)
@@ -2,7 +2,7 @@
  *   Copyright (C) 2004, 2005 by Dominic Rath                              *
  *   Dominic.Rath@gmx.de                                                   *
  *                                                                         *
- *   Copyright (C) 2007,2008 Øyvind Harboe                                 *
+ *   Copyright (C) 2007-2010 Øyvind Harboe                                 *
  *   oyvind.harboe@zylin.com                                               *
  *                                                                         *
  *   This program is free software; you can redistribute it and/or modify  *
  *   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 "replacements.h"
-
-#include "types.h"
-#include "command.h"
 #include "configuration.h"
-#include "log.h"
-#include "server.h"
+/* @todo the inclusion of server.h here is a layering violation */
+#include <server/server.h>
 
-#include <stdio.h>
-#include <stdlib.h>
 #include <getopt.h>
-#include <string.h>
 
 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'},
-       {"pipe",        no_argument,            0,              'p'},
+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);
+               }
+       }
+
+       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: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':       /* --pipe | -p */
-#if BUILD_ECOSBOARD == 1
-                               /* pipes unsupported on hosted platforms */
-                               LOG_WARNING("pipes not supported on this platform");
-#else
-#ifdef IS_MINGW
-                               /* pipes currently unsupported on win32 */
-                               LOG_WARNING("pipes currently unsupported on win32");
-                               exit(1);
-#else
-                               server_use_pipes = 1;
-#endif
-#endif
+                       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 <name>\n");
@@ -171,15 +196,19 @@ int parse_cmdline_args(struct command_context_s *cmd_ctx, int argc, char *argv[]
                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");
-               LOG_OUTPUT("--pipe       | -p\tuse pipes for gdb communication\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;
 }