pretty print multi demension array keys

[nedit-bw.git] / relativeFileNormalization.diff

From: Tony Balinski <ajbj@free.fr>
Subject: Allow NormalizePathname() and ParseFilename() to use windows path

Various operations require the extension of an incomplete file specification
to a full, absolute path. Before this patch, this completion uses the
current directory of the NEdit process as the base for relative file lookup.
However, this works against NEdit's file dialogs and shell processing which
start off in the directory of the current document, which may well not be
the same as the process' directory. Using "File > Open Selected" may not, in
this situation, find the file you would expect.

This patch alters NormalizePathname() and ParseFilename(), the utility
functions that perform the expansion so that the base for relative file
specifications can be passed, then changes all relevant calls to supply the
current window's file path value. It includes the nmReadWriteRelToWin.diff
adjustments to macro file functions read_file(), write_file() and
append_file() for this same behaviour, and adds a new one, full_file_name(),
which provides the macro writer with a way of obtaining the relative file
name from a relative file path.

---

 source/built-ins.h |    1 
 source/file.c      |    8 +--
 source/macro.c     |  114 +++++++++++++++++++++++++++++++++++++++++++++++++++--
 source/menu.c      |    6 +-
 source/nc.c        |    4 -
 source/nedit.c     |    4 -
 source/selection.c |   10 ++--
 source/server.c    |    2 
 source/tags.c      |   22 +++++-----
 util/fileUtils.c   |   26 ++++++++----
 util/fileUtils.h   |    5 +-
 util/getfiles.c    |    2 
 12 files changed, 162 insertions(+), 42 deletions(-)

diff --quilt old/source/file.c new/source/file.c
--- old/source/file.c
+++ new/source/file.c
@@ -1091,7 +1091,7 @@ int SaveWindowAs(WindowInfo *window, con
         strcpy(fullname, newName);
     }
 
-    if (1 == NormalizePathname(fullname))
+    if (1 == NormalizePathname(fullname, window->path))
     {
         return False;
     }
@@ -1100,7 +1100,7 @@ int SaveWindowAs(WindowInfo *window, con
     if (addWrap)
        addWrapNewlines(window);
     
-    if (ParseFilename(fullname, filename, pathname) != 0) {
+    if (ParseFilename(fullname, filename, pathname, window->path) != 0) {
        return FALSE;
     }
 
@@ -1185,7 +1185,7 @@ static int doSave(WindowInfo *window)
     success = MacroApplyHook(window, "pre_save_hook", 0, NULL, &hookResult);
     if (success && hookResult.tag == STRING_TAG) {
         if (ParseFilename(hookResult.val.str.rep,
-                window->filename, window->path)) {
+                window->filename, window->path, window->path)) {
             return FALSE;
         }
     }
@@ -1305,7 +1305,7 @@ static int doSave(WindowInfo *window)
     
 #ifdef VMS
     /* reflect the fact that NEdit is now editing a new version of the file */
-    ParseFilename(fullname, window->filename, window->path);
+    ParseFilename(fullname, window->filename, window->path, NULL);
 #endif /*VMS*/
 
     /* success, file was written */
diff --quilt old/source/macro.c new/source/macro.c
--- old/source/macro.c
+++ new/source/macro.c
@@ -1680,7 +1680,7 @@ static int focusWindowMS(WindowInfo *win
         if (w == NULL) {
             strncpy(normalizedString, string, MAXPATHLEN);
             normalizedString[MAXPATHLEN-1] = '\0';
-            if (1 == NormalizePathname(normalizedString)) {
+            if (1 == NormalizePathname(normalizedString, window->path)) {
                 /*  Something is broken with the input pathname. */
                 *errMsg = "Pathname too long in focus_window()";
                 return False;
@@ -2116,6 +2116,108 @@ static int clipboardToStringMS(WindowInf
     return True;
 }
 
+/*
+** Resolve the partial file path in name with respect to path.
+** (We don't use NormalizePathname() since this modifies its path in place.)
+*/
+static char *convFilePathToAbsolute(const char *path, char *name)
+{
+    static char *nameText = NULL, *ptr;
+    static size_t nameTextLen = 0;
+    size_t namelen, pathlen, len;
+    Bool isRelative = False;
+    size_t needSlash = 0;
+
+    if (!path || !path[0] || strcmp(path, ".") == 0)
+        path = GetCurrentDir();
+
+#ifdef VMS
+    /* If path name is relative, make it refer to current window's directory;
+       absolute paths start with a logical name ([\w$]+) followed by a colon,
+       or with a non-relative path in brackets (not starting with . or -)
+     */
+    isRelative = ((strchr(name, ':') == NULL) && (strlen(name) > 1) &&
+                  !((name[0] == '[') && (name[1] != '-') &&
+                   (name[1] != '.')));
+#else
+    /* UNIX-like:
+       Any path starting without a "/" is considered relative; if the first
+       character is "~", we really need the user's home directory */
+    if (name[0] == '~' && name[1] == '/') {
+        path = GetHomeDir();
+        for (++name; *name == '/'; ++name)
+            continue;   /* skip slash(es) following initial tilde */
+        isRelative = True;
+    }
+    else
+        isRelative = (name[0] != '/');
+#endif
+
+    if (!isRelative)
+        return name;
+
+    namelen = strlen(name);
+    pathlen = strlen(path);
+
+#ifndef VMS
+    needSlash = (path && pathlen && path[pathlen - 1] != '/') ? 1 : 0;
+#endif
+
+    /* make sure the buffer's big enough */
+    len = namelen + pathlen + needSlash;
+
+    if (nameTextLen < len) {
+        ptr = realloc(nameText, len + 1);
+        if (!ptr)
+            return NULL;
+        nameText = ptr;
+        nameTextLen = len;
+    }
+
+    /* copy in pieces */
+    strcpy(nameText, path);
+    if (needSlash)
+        nameText[pathlen] = '/';
+    strcpy(nameText + pathlen + needSlash, name);
+
+    CompressPathname(nameText);
+
+    return nameText;
+}
+
+/*
+** Built-in macro subroutine for expanding a possibly partial file specification
+** to a full one, using the current window's directory as a base for relative
+** path specifications. It does not check for file/path validity.
+*/
+static int fullFileNameMS(WindowInfo *window, DataValue *argList, int nArgs,
+        DataValue *result, char **errMsg)
+{
+    char stringStorage[TYPE_INT_STR_SIZE(int)], *name;
+    size_t len;
+
+    /* Validate arguments and convert to int */
+    if (nArgs != 1)
+        return wrongNArgsErr(errMsg);
+    if (!readStringArg(argList[0], &name, stringStorage, errMsg))
+        return False;
+
+    name = convFilePathToAbsolute(window->path, name);
+    len = strlen(name);
+
+    if (name) {
+        result->tag = STRING_TAG;
+        AllocNString(&result->val.str, len + 1);
+        strcpy(result->val.str.rep, name);
+    }
+    else {
+        result->tag = STRING_TAG;
+        result->val.str.rep = PERM_ALLOC_STR("");
+        result->val.str.len = 0;
+    }
+
+    return True;
+}
 
 /*
 ** Built-in macro subroutine for reading the contents of a text file into
@@ -2136,7 +2238,9 @@ static int readFileMS(WindowInfo *window
        return wrongNArgsErr(errMsg);
     if (!readStringArg(argList[0], &name, stringStorage, errMsg))
        return False;
-    
+
+    name = convFilePathToAbsolute(window->path, name);
+
     /* Read the whole file into an allocated string */
     if ((fp = fopen(name, "r")) == NULL)
        goto errorNoClose;
@@ -2215,7 +2319,9 @@ static int writeOrAppendFile(int append,
        return False;
     if (!readStringArg(argList[1], &name, stringStorage[0], errMsg))
        return False;
-    
+
+    name = convFilePathToAbsolute(window->path, name);
+
     /* open the file */
     if ((fp = fopen(name, append ? "a" : "w")) == NULL) {
        result->tag = INT_TAG;
@@ -4891,7 +4997,7 @@ static int neditHomeMV(WindowInfo *windo
     const char *neditRCName = GetRCFileName(NEDIT_RC);
     char neditHome[MAXPATHLEN];
 
-    if (0 != ParseFilename(neditRCName, NULL, neditHome)) {
+    if (0 != ParseFilename(neditRCName, NULL, neditHome, NULL)) {
         M_FAILURE("Unable to parse path of nedit.rc in %s");
     }
 
diff --quilt old/source/menu.c new/source/menu.c
--- old/source/menu.c
+++ new/source/menu.c
@@ -2976,7 +2976,7 @@ static void openAP(Widget w, XEvent *eve
         fileNameToOpen = args[0];
     }
 
-    if (0 != ParseFilename(fileNameToOpen, filename, pathname)
+    if (0 != ParseFilename(fileNameToOpen, filename, pathname, window->path)
             || strlen(filename) + strlen(pathname) > MAXPATHLEN - 1) {
         fprintf(stderr, "nedit: invalid file name for open action: %s\n",
                 fileNameToOpen);
@@ -5027,7 +5027,7 @@ static void updatePrevOpenMenu(WindowInf
             XtUnmanageChild(items[n]);
             XtDestroyWidget(items[n]);          
         } else {
-            ParseFilename(prevOpenSorted[index], filename, pathname);
+            ParseFilename(prevOpenSorted[index], filename, pathname, NULL);
             fileIsOpen = !!FindWindowWithFile(filename, pathname);
             XtVaSetValues(items[n],
                 XmNlabelString, st1=XmStringCreateSimple(prevOpenSorted[index]),
@@ -5043,7 +5043,7 @@ static void updatePrevOpenMenu(WindowInf
     
     /* Add new items for the remaining file names to the menu */
     for (; index<NPrevOpen; index++) {
-        ParseFilename(prevOpenSorted[index], filename, pathname);
+        ParseFilename(prevOpenSorted[index], filename, pathname, NULL);
         fileIsOpen = !!FindWindowWithFile(filename, pathname);
         btn = XtVaCreateManagedWidget("win", xmToggleButtonWidgetClass,
                 window->prevOpenMenuPane, 
diff --quilt old/source/nc.c new/source/nc.c
--- old/source/nc.c
+++ new/source/nc.c
@@ -714,7 +714,7 @@ static void parseCommandLine(int argc, c
                XtFree(commandString);
                commandString = newCommandString;
                outPtr = newCommandString + oldLength;
-               if (ParseFilename(nameList[j], name, path) != 0) {
+                if (ParseFilename(nameList[j], name, path, NULL) != 0) {
                   /* An Error, most likely too long paths/strings given */
                   commandLine->serverRequest = NULL;
                   return;
@@ -750,7 +750,7 @@ static void parseCommandLine(int argc, c
            if (nameList != NULL)
                free(nameList);
 #else
-           if (ParseFilename(argv[i], name, path) != 0) {
+            if (ParseFilename(argv[i], name, path, NULL) != 0) {
               /* An Error, most likely too long paths/strings given */
               commandLine->serverRequest = NULL;
               return;
diff --quilt old/source/nedit.c new/source/nedit.c
--- old/source/nedit.c
+++ new/source/nedit.c
@@ -660,7 +660,7 @@ int main(int argc, char **argv)
            numFiles = VMSFileScan(argv[i], &nameList, NULL, INCLUDE_FNF);
            /* for each expanded file name do: */
            for (j = 0; j < numFiles; ++j) {
-               if (ParseFilename(nameList[j], filename, pathname) == 0) {
+                if (ParseFilename(nameList[j], filename, pathname, NULL) == 0) {
                    /* determine if file is to be openned in new tab, by
                       factoring the options -group, -tabbed & -untabbed */
                    if (group == 2) {
@@ -715,7 +715,7 @@ int main(int argc, char **argv)
            if (nameList != NULL)
                free(nameList);
 #else
-           if (ParseFilename(argv[i], filename, pathname) == 0 ) {
+            if (ParseFilename(argv[i], filename, pathname, NULL) == 0 ) {
                /* determine if file is to be openned in new tab, by
                   factoring the options -group, -tabbed & -untabbed */
                if (group == 2) {
diff --quilt old/source/selection.c new/source/selection.c
--- old/source/selection.c
+++ new/source/selection.c
@@ -328,7 +328,7 @@ static void fileCB(Widget widget, Window
        guranteed to be available, but in practice is there and does work. */
 #if defined(DONT_HAVE_GLOB) || defined(VMS)
     /* Open the file */
-    if (ParseFilename(nameText, filename, pathname) != 0) {
+    if (ParseFilename(nameText, filename, pathname, window->path) != 0) {
         XBell(TheDisplay, 0);
        return;
     }  
@@ -338,7 +338,7 @@ static void fileCB(Widget widget, Window
     { char **nameList = NULL;
       int i, nFiles = 0, maxFiles = 30;
 
-      if (ParseFilename(nameText, filename, pathname) != 0) {
+      if (ParseFilename(nameText, filename, pathname, window->path) != 0) {
            XBell(TheDisplay, 0);
           return;
       }
@@ -362,7 +362,8 @@ static void fileCB(Widget widget, Window
                 fileNameToOpen = nameList[i];
             }
 
-            if (ParseFilename(fileNameToOpen, filename, pathname) != 0) {
+            if (ParseFilename(fileNameToOpen, filename, pathname,
+                    window->path) != 0) {
                 XBell(TheDisplay, 0);
             } else {
                 EditExistingFile(GetPrefOpenInTab() ? window : NULL, filename,
@@ -399,7 +400,8 @@ static void fileCB(Widget widget, Window
                 fileNameToOpen = globbuf.gl_pathv[i];
             }
 
-            if (ParseFilename(fileNameToOpen, filename, pathname) != 0) {
+            if (ParseFilename(fileNameToOpen, filename, pathname,
+                    window->path) != 0) {
                 XBell(TheDisplay, 0);
             } else {
                 EditExistingFile(GetPrefOpenInTab() ? window : NULL, filename,
diff --quilt old/source/server.c new/source/server.c
--- old/source/server.c
+++ new/source/server.c
@@ -456,7 +456,7 @@ static void processServerCommandString(c
           existing window, or opening if they don't exist */
        editFlags = (readFlag ? PREF_READ_ONLY : 0) | CREATE |
                (createFlag ? SUPPRESS_CREATE_WARN : 0);
-       if (ParseFilename(fullname, filename, pathname) != 0) {
+        if (ParseFilename(fullname, filename, pathname, NULL) != 0) {
           fprintf(stderr, "NEdit: invalid file name\n");
            deleteFileClosedProperty2(filename, pathname);
           break;
diff --quilt old/source/tags.c new/source/tags.c
--- old/source/tags.c
+++ new/source/tags.c
@@ -254,7 +254,7 @@ static int addTag(const char *name, cons
     else
         sprintf(newfile,"%s%s", path, file);
     
-    NormalizePathname(newfile);
+    NormalizePathname(newfile, NULL);
         
     for (t = table[addr]; t; t = t->next) {
         if (strcmp(name,t->name)) continue;
@@ -265,7 +265,7 @@ static int addTag(const char *name, cons
         if (*t->file != '/') {
             char tmpfile[MAXPATHLEN];
             sprintf(tmpfile, "%s%s", t->path, t->file);
-            NormalizePathname(tmpfile);
+            NormalizePathname(tmpfile, NULL);
             if (strcmp(newfile, tmpfile)) continue;
         }
         return 0;
@@ -365,7 +365,7 @@ int AddRelTagsFile(const char *tagSpec, 
          }   
         strcat(pathName, "/");
         strcat(pathName, filename);
-        NormalizePathname(pathName);
+        NormalizePathname(pathName, NULL);
 
         for (t = FileList; t && strcmp(t->filename, pathName); t = t->next);
         if (t) {
@@ -433,7 +433,7 @@ int AddTagsFile(const char *tagSpec, int
         } else {
             strcpy(pathName,filename);
         }
-        NormalizePathname(pathName);
+        NormalizePathname(pathName, NULL);
 
         for (t = FileList; t && strcmp(t->filename,pathName); t = t->next);
         if (t) {
@@ -504,7 +504,7 @@ int DeleteTagsFile(const char *tagSpec, 
         } else {
             strcpy(pathName,filename);
         }
-        NormalizePathname(pathName);
+        NormalizePathname(pathName, NULL);
 
         for (last=NULL,t = FileList; t; last = t,t = t->next) {
             if (strcmp(t->filename, pathName))
@@ -734,7 +734,7 @@ static int loadTagsFile(const char *tags
        return 0;
     }
 
-    ParseFilename(resolvedTagsFile, NULL, tagPath);
+    ParseFilename(resolvedTagsFile, NULL, tagPath, NULL);
 
     /* Read the file and store its contents */
     while (fgets(line, MAXLINE, fp)) {
@@ -1147,7 +1147,7 @@ static int findAllMatches(WindowInfo *wi
             sprintf(tagFiles[nMatches],"%s%s",tagPath,fileToSearch);
         strcpy(tagSearch[nMatches],searchString);
         tagPosInf[nMatches]=startPos;
-        ParseFilename(tagFiles[nMatches], filename, pathname);
+        ParseFilename(tagFiles[nMatches], filename, pathname, NULL);
         /* Is this match in the current file?  If so, use it! */
         if (GetPrefSmartTags() && !strcmp(window->filename,filename)
                                && !strcmp(window->path,pathname)   ) {
@@ -1204,7 +1204,7 @@ static int findAllMatches(WindowInfo *wi
         }
 
         for (i=0; i<nMatches; i++) {
-            ParseFilename(tagFiles[i], filename, pathname);
+            ParseFilename(tagFiles[i], filename, pathname, NULL);
             if ((i<nMatches-1 && !strcmp(tagFiles[i],tagFiles[i+1])) ||
                     (i>0 && !strcmp(tagFiles[i],tagFiles[i-1]))) {
                 if(*(tagSearch[i]) && (tagPosInf[i] != -1)) { /* etags */
@@ -1326,7 +1326,7 @@ static void showMatchingCalltip( Widget 
     char *message;
     
     /* 1. Open the target file */
-    NormalizePathname(tagFiles[i]);
+    NormalizePathname(tagFiles[i], NULL);
     fp = fopen(tagFiles[i], "r");
     if (fp == NULL) {
         DialogF(DF_ERR, parent, 1, "Error opening File", "Error opening %s",
@@ -1445,7 +1445,7 @@ static void editTaggedLocation( Widget p
     WindowInfo *windowToSearch;
     WindowInfo *parentWindow = WidgetToWindow(parent);
     
-    ParseFilename(tagFiles[i],filename,pathname);
+    ParseFilename(tagFiles[i], filename, pathname, NULL);
     /* open the file containing the definition */
     EditExistingFile(parentWindow, filename, pathname, 0, NULL, False, 
            NULL, GetPrefOpenInTab(), False);
@@ -1992,7 +1992,7 @@ static int loadTipsFile(const char *tips
 #endif
 
     /* Get the path to the tips file */
-    ParseFilename(resolvedTipsFile, NULL, tipPath);
+    ParseFilename(resolvedTipsFile, NULL, tipPath, NULL);
 
     /* Open the file */
     if ((fp = fopen(resolvedTipsFile, "r")) == NULL)
diff --quilt old/util/fileUtils.c new/util/fileUtils.c
--- old/util/fileUtils.c
+++ new/util/fileUtils.c
@@ -88,8 +88,8 @@ static void copyThruSlash(char **toStrin
 ** least MAXPATHLEN chars long.
 ** To skip setting filename or pathname pass NULL for that argument.
 */
-int
-ParseFilename(const char *fullname, char *filename, char *pathname)
+int ParseFilename(const char *fullname, char *filename, char *pathname,
+        const char *relpath)
 {
     int fullLen = strlen(fullname);
     int i, pathLen, fileLen;
@@ -138,7 +138,7 @@ ParseFilename(const char *fullname, char
 
 #ifndef VMS /* UNIX specific... Modify at a later date for VMS */
     if(pathname) {
-       if (NormalizePathname(pathname)) {
+        if (NormalizePathname(pathname, relpath)) {
            return 1; /* pathname too long */
        }
        pathLen = strlen(pathname);
@@ -271,7 +271,7 @@ ResolvePath(const char * pathIn, char * 
        } else {
            strcpy(pathBuf, resolveBuf);
        }
-       NormalizePathname(pathBuf);
+        NormalizePathname(pathBuf, NULL);
        pathIn=pathBuf;
     }
 
@@ -287,9 +287,10 @@ ResolvePath(const char * pathIn, char * 
 **  FIXME: Documentation
 **  FIXME: Change return value to False and True.
 */
-int NormalizePathname(char *pathname)
+int NormalizePathname(char *pathname, const char *relpath)
 {
-    /* if this is a relative pathname, prepend current directory */
+    /* if this is a relative pathname, prepend relpath */
+    /* if relpath is a relative path, prepend the current directory */
 #ifdef __EMX__
     /* OS/2, ...: welcome to the world of drive letters ... */
     if (!_fnisabs(pathname)) {
@@ -298,12 +299,13 @@ int NormalizePathname(char *pathname)
 #endif
         char *oldPathname;
         size_t len;
+        int useRelpath = (relpath && *relpath);
 
         /* make a copy of pathname to work from */
        oldPathname=(char *)malloc(strlen(pathname)+1);
        strcpy(oldPathname, pathname);
        /* get the working directory and prepend to the path */
-       strcpy(pathname, GetCurrentDir());
+        strcpy(pathname, useRelpath ? relpath : GetCurrentDir());
 
        /* check for trailing slash, or pathname being root dir "/":
           don't add a second '/' character as this may break things
@@ -320,6 +322,14 @@ int NormalizePathname(char *pathname)
         }
        strcat(pathname, oldPathname);
        free(oldPathname);
+        if (useRelpath)
+        {
+            /* make sure our relative path wasn't relative to start with */
+            if (CompressPathname(pathname) == 0)
+                return NormalizePathname(pathname, NULL);
+            else
+                return 1; /* some non-zero value */
+        }
     }
 
     /* compress out .. and . */
@@ -472,7 +482,7 @@ copyThruSlash(char **toString, char **fr
 /*
 ** Return 0 if everything's fine, 1 else.
 */
-int NormalizePathname(char *pathname)
+int NormalizePathname(char *pathname, const char *relpath)
 {
     return 0;
 }
diff --quilt old/util/fileUtils.h new/util/fileUtils.h
--- old/util/fileUtils.h
+++ new/util/fileUtils.h
@@ -30,11 +30,12 @@
 
 enum fileFormats {UNIX_FILE_FORMAT, DOS_FILE_FORMAT, MAC_FILE_FORMAT};
 
-int ParseFilename(const char *fullname, char *filename, char *pathname);
+int ParseFilename(const char *fullname, char *filename, char *pathname,
+        const char *relpath);
 int ExpandTilde(char *pathname);
 const char* GetTrailingPathComponents(const char* path,
                                       int noOfComponents);
-int NormalizePathname(char *pathname);
+int NormalizePathname(char *pathname, const char *relpath);
 int CompressPathname(char *pathname);
 int ResolvePath(const char * pathIn, char * pathResolved); 
 
diff --quilt old/util/getfiles.c new/util/getfiles.c
--- old/util/getfiles.c
+++ new/util/getfiles.c
@@ -1024,7 +1024,7 @@ static void listCharEH(Widget w, XtPoint
     selectPos = 0;
     for (i=0; i<nItems; i++) {
        XmStringGetLtoR(items[i], XmSTRING_DEFAULT_CHARSET, &itemString);
-       if (ParseFilename(itemString, name, path) != 0) {
+        if (ParseFilename(itemString, name, path, NULL) != 0) {
           XtFree(itemString);
           return;
        }
diff --quilt old/source/built-ins.h new/source/built-ins.h
--- old/source/built-ins.h
+++ new/source/built-ins.h
@@ -76,6 +76,7 @@ MS(set_window_title, setWindowTitle)
 MS(timer_add, timerAdd)
 MS(timer_remove, timerRemove)
 MS(escape_literal, escapeLiteral)
+MS(full_file_name, fullFileName)
 
 MV(cursor, cursor)
 MV(line, line)