Update getrelativefilename doc + add unitary test.

Change-Id: I160a4f94db17754300f9a25e07968d8b858a2ff5

4 files changed, 221 insertions, 119 deletions

diff --git a/scilab/modules/fileio/help/en_US/getrelativefilename.xml b/scilab/modules/fileio/help/en_US/getrelativefilename.xml
index de8bec6..e759b1a 100644
--- a/scilab/modules/fileio/help/en_US/getrelativefilename.xml
+++ b/scilab/modules/fileio/help/en_US/getrelativefilename.xml
@@ -2,11 +2,11 @@
 <!--
  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
  * Copyright (C) XXXX-2008 - INRIA
- * 
+ *
  * This file must be used under the terms of the CeCILL.
  * This source file is licensed as described in the file COPYING, which
  * you should have received as part of this distribution.  The terms
- * are also available at    
+ * are also available at
  * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
  *
  -->
@@ -53,19 +53,13 @@
   </refsection>
   <refsection>
     <title>Examples</title>
-    <programlisting role="example"><![CDATA[ 
-if getos() == 'Windows' then
-  getrelativefilename('C:\program file\scilab-4.0\bin','C:\program file\scilab-4.0\modules\helptools\help.dtd')
-  getrelativefilename('C:\program file\scilab-4.0\bin\','C:\program file\scilab-4.0\modules\helptools\help.dtd')
-  getrelativefilename(SCI+'\bin',SCI+'\modules\helptools\help.dtd')
-  getrelativefilename(WSCI+'\bin',WSCI+'\modules\helptools\help.dtd')
-  getrelativefilename(pwd(),WSCI+'\bin\Wscilex')
-else
-  getrelativefilename('/usr/local/scilab-4.0/bin','/usr/local/scilab-4.0/modules/helptools/help.dtd')
-  getrelativefilename('/usr/local/scilab-4.0/bin/','/usr/local/scilab-4.0/modules/helptools/help.dtd')
-  getrelativefilename(SCI+'/bin',SCI+'/modules/helptools/help.dtd')
-  getrelativefilename(pwd(),SCI+'/bin/scilex')
-end
+    <programlisting role="example"><![CDATA[
+getrelativefilename(pwd(), SCI+'/COPYING')
+getrelativefilename(TMPDIR, SCI+'/COPYING')
+getrelativefilename(SCI+'/bin', SCI+'/COPYING')
+getrelativefilename(pwd(), SCI+'/ACKNOLEDGMENTS')
+getrelativefilename(TMPDIR, SCI+'/ACKNOLEDGMENTS')
+getrelativefilename(SCI+'/bin', SCI+'/ACKNOLEDGMENTS')
  ]]></programlisting>
   </refsection>
   <refsection role="see also">
diff --git a/scilab/modules/fileio/src/c/getrelativefilename.c b/scilab/modules/fileio/src/c/getrelativefilename.c
index acf16d0..707d333 100644
--- a/scilab/modules/fileio/src/c/getrelativefilename.c
+++ b/scilab/modules/fileio/src/c/getrelativefilename.c
@@ -1,6 +1,7 @@
 /*
 * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
 * Copyright (C) 2006 - INRIA - Pierre MARECHAL
+* Copyright (C) 2011 - DIGITEO - Allan CORNET
 * 
 * This file must be used under the terms of the CeCILL.
 * This source file is licensed as described in the file COPYING, which
@@ -14,7 +15,9 @@
 #include "getrelativefilename.h"
 #include "MALLOC.h"
 #include "PATH_MAX.h"
-
+#include "strsubst.h"
+/* ================================================================================== */
+static char *normalizeFileSeparator(const char *path);
 /* ================================================================================== */
 // getrelativefilename
 //
@@ -22,114 +25,144 @@
 // For example, if the current directory is C:\foo\bar and the filename C:\foo\whee\text.txt is given,
 // GetRelativeFilename will return ..\whee\text.txt.
 /* ================================================================================== */
-
 char* getrelativefilename(char *currentDirectory, char *absoluteFilename)
 {
-        // declarations - put here so this should work in a C compiler
-        int afMarker = 0, rfMarker = 0;
-        int cdLen = 0, afLen = 0;
-        int i = 0;
-        int levels = 0;
-        char *relativeFilename= (char*)MALLOC(PATH_MAX*sizeof(char));
-
-        cdLen = (int)strlen(currentDirectory);
-        afLen = (int)strlen(absoluteFilename);
-
-        // make sure the names are not too short
-        if( cdLen < ABSOLUTE_NAME_START+1 || afLen < ABSOLUTE_NAME_START+1)
-        {
-                // fix bug 2181
-                strcpy(relativeFilename, absoluteFilename);
-                return relativeFilename;
-        }
-
-        // Handle DOS names that are on different drives:
-        if(tolower(currentDirectory[0]) != tolower(absoluteFilename[0]))
-        {
-                // not on the same drive, so only absolute filename will do
-                strcpy(relativeFilename, absoluteFilename);
-                return relativeFilename;
-        }
-
-        // they are on the same drive, find out how much of the current directory
-        // is in the absolute filename
-        i = ABSOLUTE_NAME_START;
+    // declarations - put here so this should work in a C compiler
+    int afMarker = 0, rfMarker = 0;
+    int cdLen = 0, afLen = 0;
+    int i = 0;
+    int levels = 0;
+    char *relativeFilename= (char*)MALLOC(PATH_MAX*sizeof(char));
+    char *_currentDirectory = normalizeFileSeparator(currentDirectory);
+    char *_absoluteFilename = normalizeFileSeparator(absoluteFilename);
+
+    cdLen = (int)strlen(_currentDirectory);
+    afLen = (int)strlen(_absoluteFilename);
+
+    // make sure the names are not too short
+    if( cdLen < ABSOLUTE_NAME_START+1 || afLen < ABSOLUTE_NAME_START+1)
+    {
+        // fix bug 2181
+        strcpy(relativeFilename, _absoluteFilename);
+        if (_currentDirectory) {FREE(_currentDirectory); _currentDirectory = NULL;}
+        if (_absoluteFilename) {FREE(_absoluteFilename); _absoluteFilename = NULL;}
+        return relativeFilename;
+    }
+
+    // Handle DOS names that are on different drives:
+    if(tolower(_currentDirectory[0]) != tolower(_absoluteFilename[0]))
+    {
+        // not on the same drive, so only absolute filename will do
+        strcpy(relativeFilename, _absoluteFilename);
+        if (_currentDirectory) {FREE(_currentDirectory); _currentDirectory = NULL;}
+        if (_absoluteFilename) {FREE(_absoluteFilename); _absoluteFilename = NULL;}
+        return relativeFilename;
+    }
+
+    // they are on the same drive, find out how much of the current directory
+    // is in the absolute filename
+    i = ABSOLUTE_NAME_START;
 
 #if defined(_MSC_VER)
-        while(i < afLen && i < cdLen && tolower(currentDirectory[i])==tolower(absoluteFilename[i]) )
-        {
-                i++;
-        }
+    while(i < afLen && i < cdLen && tolower(_currentDirectory[i]) == tolower(_absoluteFilename[i]) )
+    {
+        i++;
+    }
 #else
-        while(i < afLen && i < cdLen && currentDirectory[i] == absoluteFilename[i])
-        {
-                i++;
-        }
+    while(i < afLen && i < cdLen && _currentDirectory[i] == _absoluteFilename[i])
+    {
+        i++;
+    }
 #endif
 
-        if(i == cdLen && (absoluteFilename[i] == DIR_SEPARATOR[0] || absoluteFilename[i-1] == DIR_SEPARATOR[0]))
-        {
-                // the whole current directory name is in the file name,
-                // so we just trim off the current directory name to get the
-                // current file name.
-                if(absoluteFilename[i] == DIR_SEPARATOR[0])
-                {
-                        // a directory name might have a trailing slash but a relative
-                        // file name should not have a leading one...
-                        i++;
-                }
-
-                strcpy(relativeFilename, &absoluteFilename[i]);
-                return relativeFilename;
-        }
-
-        // The file is not in a child directory of the current directory, so we
-        // need to step back the appropriate number of parent directories by
-        // using "..\"s.  First find out how many levels deeper we are than the
-        // common directory
-        afMarker = i;
-        levels = 1;
-
-        // count the number of directory levels we have to go up to get to the
-        // common directory
-        while(i < cdLen)
-        {
-                i++;
-                if(currentDirectory[i] == DIR_SEPARATOR[0])
-                {
-                        // make sure it's not a trailing slash
-                        i++;
-                        if(currentDirectory[i] != '\0')
-                        {
-                                levels++;
-                        }
-                }
-        }
-
-        // move the absolute filename marker back to the start of the directory name
-        // that it has stopped in.
-        while(afMarker > 0 && absoluteFilename[afMarker-1] != DIR_SEPARATOR[0])
-        {
-                afMarker--;
-        }
-
-        // check that the result will not be too long
-        if(levels * 3 + afLen - afMarker > PATH_MAX)
-        {
-                return NULL;
-        }
-
-        // add the appropriate number of "..\"s.
-        rfMarker = 0;
-        for(i = 0; i < levels; i++)
-        {
-                relativeFilename[rfMarker++] = '.';
-                relativeFilename[rfMarker++] = '.';
-                relativeFilename[rfMarker++] = DIR_SEPARATOR[0];
-        }
-
-        // copy the rest of the filename into the result string
-        strcpy(&relativeFilename[rfMarker], &absoluteFilename[afMarker]);
-
-        return relativeFilename;
+    if(i == cdLen && (_absoluteFilename[i] == DIR_SEPARATOR[0] || _absoluteFilename[i-1] == DIR_SEPARATOR[0]))
+    {
+        // the whole current directory name is in the file name,
+        // so we just trim off the current directory name to get the
+        // current file name.
+        if(_absoluteFilename[i] == DIR_SEPARATOR[0])
+        {
+            // a directory name might have a trailing slash but a relative
+            // file name should not have a leading one...
+            i++;
+        }
+
+        strcpy(relativeFilename, &_absoluteFilename[i]);
+        if (_currentDirectory) {FREE(_currentDirectory); _currentDirectory = NULL;}
+        if (_absoluteFilename) {FREE(_absoluteFilename); _absoluteFilename = NULL;}
+        return relativeFilename;
+    }
+
+    // The file is not in a child directory of the current directory, so we
+    // need to step back the appropriate number of parent directories by
+    // using "..\"s.  First find out how many levels deeper we are than the
+    // common directory
+    afMarker = i;
+    levels = 1;
+
+    // count the number of directory levels we have to go up to get to the
+    // common directory
+    while(i < cdLen)
+    {
+        i++;
+        if(_currentDirectory[i] == DIR_SEPARATOR[0])
+        {
+            // make sure it's not a trailing slash
+            i++;
+            if(_currentDirectory[i] != '\0')
+            {
+                levels++;
+            }
+        }
+    }
+
+    // move the absolute filename marker back to the start of the directory name
+    // that it has stopped in.
+    while(afMarker > 0 && _absoluteFilename[afMarker-1] != DIR_SEPARATOR[0])
+    {
+        afMarker--;
+    }
+
+    // check that the result will not be too long
+    if(levels * 3 + afLen - afMarker > PATH_MAX)
+    {
+        if (_currentDirectory) {FREE(_currentDirectory); _currentDirectory = NULL;}
+        if (_absoluteFilename) {FREE(_absoluteFilename); _absoluteFilename = NULL;}
+        return NULL;
+    }
+
+    // add the appropriate number of "..\"s.
+    rfMarker = 0;
+    for(i = 0; i < levels; i++)
+    {
+        relativeFilename[rfMarker++] = '.';
+        relativeFilename[rfMarker++] = '.';
+        relativeFilename[rfMarker++] = DIR_SEPARATOR[0];
+    }
+
+    // copy the rest of the filename into the result string
+    strcpy(&relativeFilename[rfMarker], &_absoluteFilename[afMarker]);
+
+    if (_currentDirectory) {FREE(_currentDirectory); _currentDirectory = NULL;}
+    if (_absoluteFilename) {FREE(_absoluteFilename); _absoluteFilename = NULL;}
+
+    return relativeFilename;
 }
+/* ================================================================================== */
+char *normalizeFileSeparator(const char *path)
+{
+#define WINDOWS_FILESEPARATOR "\\"
+#define OTHERS_FILESEPARATOR "/"
+
+    char *normalizedPath = NULL;
+    if (path)
+    {
+#ifdef _MSC_VER
+        normalizedPath = strsub((char*)path, OTHERS_FILESEPARATOR, DIR_SEPARATOR);
+#else
+        normalizedPath = strsub((char*)path, WINDOWS_FILESEPARATOR, DIR_SEPARATOR);
+#endif
+    }
+    return normalizedPath;
+}
+/* ================================================================================== */
diff --git a/scilab/modules/fileio/tests/unit_tests/getrelativefilename.dia.ref b/scilab/modules/fileio/tests/unit_tests/getrelativefilename.dia.ref
new file mode 100644
index 0000000..94fd207
--- /dev/null
+++ b/scilab/modules/fileio/tests/unit_tests/getrelativefilename.dia.ref
@@ -0,0 +1,33 @@
+// =============================================================================
+// Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
+// Copyright (C) 2011 - DIGITEO - Bruno JOFRET
+// Copyright (C) 2011 - DIGITEO - Allan CORNET
+//
+//  This file is distributed under the same license as the Scilab package.
+// =============================================================================
+// <-- JVM NOT MANDATORY -->
+ierr = execstr("getrelativefilename();","errcatch");
+if ierr <> 77 then bugmes();quit;end
+ierr = execstr("getrelativefilename([], []);","errcatch");
+if ierr <> 999 then bugmes();quit;end
+__dir1  = TMPDIR+"/dir1";
+__dir11 = TMPDIR+"/dir1/dir1.1";
+__dir12 = TMPDIR+"/dir1/dir1.2";
+mkdir(__dir1);
+mkdir(__dir11);
+mkdir(__dir12);
+__file1  = __dir1+"/file1.txt";
+__file11 = __dir11+"/file11.txt";
+__file12 =  __dir12+"/file12.txt";
+mputl("", __file1);
+mputl("", __file11);
+mputl("", __file12);
+if getrelativefilename(__dir1, __file1) <> "file1.txt" then bugmes();quit;end
+if getrelativefilename(__dir1, __file11) <> pathconvert("dir1.1/file11.txt", %f) then bugmes();quit;end
+if getrelativefilename(__dir1, __file12) <> pathconvert("dir1.2/file12.txt", %f) then bugmes();quit;end
+if getrelativefilename(__dir11, __file1) <> pathconvert("../file1.txt", %f) then bugmes();quit;end
+if getrelativefilename(__dir11, __file11) <> "file11.txt" then bugmes();quit;end
+if getrelativefilename(__dir11, __file12) <> pathconvert("../dir1.2/file12.txt", %f) then bugmes();quit;end
+if getrelativefilename(__dir12, __file1) <> pathconvert("../file1.txt", %f) then bugmes();quit;end;
+if getrelativefilename(__dir12, __file11) <> pathconvert("../dir1.1/file11.txt", %f) then bugmes();quit;end;
+if getrelativefilename(__dir12, __file12) <> "file12.txt" then bugmes();quit;end;
diff --git a/scilab/modules/fileio/tests/unit_tests/getrelativefilename.tst b/scilab/modules/fileio/tests/unit_tests/getrelativefilename.tst
new file mode 100644
index 0000000..6a3c5e3
--- /dev/null
+++ b/scilab/modules/fileio/tests/unit_tests/getrelativefilename.tst
@@ -0,0 +1,42 @@
+// =============================================================================
+// Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
+// Copyright (C) 2011 - DIGITEO - Bruno JOFRET
+// Copyright (C) 2011 - DIGITEO - Allan CORNET
+//
+//  This file is distributed under the same license as the Scilab package.
+// =============================================================================
+
+// <-- JVM NOT MANDATORY -->
+ierr = execstr("getrelativefilename();","errcatch");
+if ierr <> 77 then pause,end
+
+ierr = execstr("getrelativefilename([], []);","errcatch");
+if ierr <> 999 then pause,end
+
+__dir1  = TMPDIR+"/dir1";
+__dir11 = TMPDIR+"/dir1/dir1.1";
+__dir12 = TMPDIR+"/dir1/dir1.2";
+
+mkdir(__dir1);
+mkdir(__dir11);
+mkdir(__dir12);
+
+__file1  = __dir1+"/file1.txt";
+__file11 = __dir11+"/file11.txt";
+__file12 =  __dir12+"/file12.txt";
+
+mputl("", __file1);
+mputl("", __file11);
+mputl("", __file12);
+
+if getrelativefilename(__dir1, __file1) <> "file1.txt" then pause, end
+if getrelativefilename(__dir1, __file11) <> pathconvert("dir1.1/file11.txt", %f) then pause, end
+if getrelativefilename(__dir1, __file12) <> pathconvert("dir1.2/file12.txt", %f) then pause, end
+
+if getrelativefilename(__dir11, __file1) <> pathconvert("../file1.txt", %f) then pause, end
+if getrelativefilename(__dir11, __file11) <> "file11.txt" then pause, end
+if getrelativefilename(__dir11, __file12) <> pathconvert("../dir1.2/file12.txt", %f) then pause, end
+
+if getrelativefilename(__dir12, __file1) <> pathconvert("../file1.txt", %f) then pause, end;
+if getrelativefilename(__dir12, __file11) <> pathconvert("../dir1.1/file11.txt", %f) then pause, end;
+if getrelativefilename(__dir12, __file12) <> "file12.txt" then pause, end;