From bf7f7793e9c6e2fc3fcb8297ab7b3b56e3e9eea2 Mon Sep 17 00:00:00 2001 From: Robert Roebling Date: Thu, 26 Oct 2006 21:08:21 +0000 Subject: [PATCH] [ 1585253 ] Various important bugfixes to wxFileName::Normalize git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@42471 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- docs/latex/wx/filename.tex | 15 ++++--- include/wx/dynarray.h | 12 +++++ src/common/config.cpp | 7 ++- src/common/filename.cpp | 61 ++++++++++++++----------- tests/filename/filenametest.cpp | 80 ++++++++++++++++++++++++++++++++- 5 files changed, 143 insertions(+), 32 deletions(-) diff --git a/docs/latex/wx/filename.tex b/docs/latex/wx/filename.tex index b7c8e658f0..3239145221 100644 --- a/docs/latex/wx/filename.tex +++ b/docs/latex/wx/filename.tex @@ -815,20 +815,25 @@ any or-combination of the following constants: \begin{twocollist} \twocolitem{{\bf wxPATH\_NORM\_ENV\_VARS}}{replace env vars with their values} -\twocolitem{{\bf wxPATH\_NORM\_DOTS}}{squeeze all .. and . and prepend cwd} -\twocolitem{{\bf wxPATH\_NORM\_TILDE}}{Unix only: replace ~ and ~user} +\twocolitem{{\bf wxPATH\_NORM\_DOTS}}{squeeze all .. and . when possible; if there are too many .. and thus they cannot be all removed, \false will be returned} \twocolitem{{\bf wxPATH\_NORM\_CASE}}{if filesystem is case insensitive, transform to lower case} -\twocolitem{{\bf wxPATH\_NORM\_ABSOLUTE}}{make the path absolute} +\twocolitem{{\bf wxPATH\_NORM\_ABSOLUTE}}{make the path absolute prepending \arg{cwd}} \twocolitem{{\bf wxPATH\_NORM\_LONG}}{make the path the long form} \twocolitem{{\bf wxPATH\_NORM\_SHORTCUT}}{resolve if it is a shortcut (Windows only)} +\twocolitem{{\bf wxPATH\_NORM\_TILDE}}{replace ~ and ~user (Unix only)} \twocolitem{{\bf wxPATH\_NORM\_ALL}}{all of previous flags except \texttt{wxPATH\_NORM\_CASE}} \end{twocollist} }% \docparam{cwd}{If not empty, this directory will be used instead of current -working directory in normalization.} +working directory in normalization (see wxPATH\_NORM\_ABSOLUTE).} -\docparam{format}{The file name format, native by default.} +\docparam{format}{The file name format to use when processing the paths, native by default.} + + +\wxheading{Return value} + +\true if normalization was successfully or \false otherwise. \membersection{wxFileName::PrependDir}\label{wxfilenameprependdir} diff --git a/include/wx/dynarray.h b/include/wx/dynarray.h index 81c12e84b5..4c2584fb49 100644 --- a/include/wx/dynarray.h +++ b/include/wx/dynarray.h @@ -967,6 +967,18 @@ WX_DEFINE_USER_EXPORTED_ARRAY_PTR(void *, wxArrayPtrVoid, class WXDLLIMPEXP_BASE // convenience macros // ----------------------------------------------------------------------------- +// prepend all element of one array to another one; e.g. if first array contains +// elements X,Y,Z and the second contains A,B,C (in those orders), then the +// first array will be result as A,B,C,X,Y,Z +#define WX_PREPEND_ARRAY(array, other) \ + { \ + size_t wxAAcnt = (other).size(); \ + for ( size_t wxAAn = 0; wxAAn < wxAAcnt; wxAAn++ ) \ + { \ + (array).Insert((other)[wxAAn], wxAAn); \ + } \ + } + // append all element of one array to another one #define WX_APPEND_ARRAY(array, other) \ { \ diff --git a/src/common/config.cpp b/src/common/config.cpp index 4b509a7fc0..1f2134beec 100644 --- a/src/common/config.cpp +++ b/src/common/config.cpp @@ -369,7 +369,12 @@ wxString wxExpandEnvVars(const wxString& str) #ifdef __WXWINCE__ const wxChar *pszValue = NULL; #else - const wxChar *pszValue = wxGetenv(strVarName); + // NB: use wxGetEnv instead of wxGetenv as otherwise variables + // set through wxSetEnv may not be read correctly! + const wxChar *pszValue = NULL; + wxString tmp; + if (wxGetEnv(strVarName, &tmp)) + pszValue = tmp; #endif if ( pszValue != NULL ) { strResult += pszValue; diff --git a/src/common/filename.cpp b/src/common/filename.cpp index 98af00ab43..64b49c4910 100644 --- a/src/common/filename.cpp +++ b/src/common/filename.cpp @@ -1131,7 +1131,7 @@ bool wxFileName::Normalize(int flags, format = GetFormat(format); - // make the path absolute + // set up the directory to use for making the path absolute later if ( (flags & wxPATH_NORM_ABSOLUTE) && !IsAbsolute(format) ) { if ( cwd.empty() ) @@ -1142,20 +1142,6 @@ bool wxFileName::Normalize(int flags, { curDir.AssignDir(cwd); } - - // the path may be not absolute because it doesn't have the volume name - // but in this case we shouldn't modify the directory components of it - // but just set the current volume - if ( !HasVolume() && curDir.HasVolume() ) - { - SetVolume(curDir.GetVolume()); - - if ( !m_relative ) - { - // yes, it was the case - we don't need curDir then - curDir.Clear(); - } - } } // handle ~ stuff under Unix only @@ -1166,8 +1152,18 @@ bool wxFileName::Normalize(int flags, wxString dir = dirs[0u]; if ( !dir.empty() && dir[0u] == _T('~') ) { + // to make the path absolute use the home directory curDir.AssignDir(wxGetUserHome(dir.c_str() + 1)); + // if we are expanding the tilde, then this path + // *should* be already relative (since we checked for + // the tilde only in the first char of the first dir); + // if m_relative==false, it's because it was initialized + // from a string which started with /~; in that case + // we reach this point but then need m_relative=true + // for relative->absolute expansion later + m_relative = true; + dirs.RemoveAt(0u); } } @@ -1176,14 +1172,34 @@ bool wxFileName::Normalize(int flags, // transform relative path into abs one if ( curDir.IsOk() ) { - wxArrayString dirsNew = curDir.GetDirs(); - size_t count = dirs.GetCount(); - for ( size_t n = 0; n < count; n++ ) + // this path may be relative because it doesn't have the volume name + // and still have m_relative=true; in this case we shouldn't modify + // our directory components but just set the current volume + if ( !HasVolume() && curDir.HasVolume() ) { - dirsNew.Add(dirs[n]); + SetVolume(curDir.GetVolume()); + + if ( !m_relative ) + { + // yes, it was the case - we don't need curDir then + curDir.Clear(); + } } - dirs = dirsNew; + // finally, prepend curDir to the dirs array + wxArrayString dirsNew = curDir.GetDirs(); + WX_PREPEND_ARRAY(dirs, dirsNew); + + // if we used e.g. tilde expansion previously and wxGetUserHome didn't + // return for some reason an absolute path, then curDir maybe not be absolute! + if ( curDir.IsAbsolute(format) ) + { + // we have prepended an absolute path and thus we are now an absolute + // file name too + m_relative = false; + } + // else if (flags & wxPATH_NORM_ABSOLUTE): + // should we warn the user that we didn't manage to make the path absolute? } // now deal with ".", ".." and the rest @@ -1249,11 +1265,6 @@ bool wxFileName::Normalize(int flags, m_ext.MakeLower(); } - // we do have the path now - // - // NB: need to do this before (maybe) calling Assign() below - m_relative = false; - #if defined(__WIN32__) if ( (flags & wxPATH_NORM_LONG) && (format == wxPATH_DOS) ) { diff --git a/tests/filename/filenametest.cpp b/tests/filename/filenametest.cpp index 969b34d8d3..0b14219dbb 100644 --- a/tests/filename/filenametest.cpp +++ b/tests/filename/filenametest.cpp @@ -55,9 +55,14 @@ static struct FileNameInfo { _T("c:foo.bar"), _T("c"), _T(""), _T("foo"), _T("bar"), false, wxPATH_DOS }, { _T("c:\\foo.bar"), _T("c"), _T("\\"), _T("foo"), _T("bar"), true, wxPATH_DOS }, { _T("c:\\Windows\\command.com"), _T("c"), _T("\\Windows"), _T("command"), _T("com"), true, wxPATH_DOS }, + + // NB: when using the wxFileName::GetLongPath() function on these two strings, + // the program will hang various seconds. All those time is taken by the + // call to the win32 API GetLongPathName()... { _T("\\\\server\\foo.bar"), _T("server"), _T("\\"), _T("foo"), _T("bar"), true, wxPATH_DOS }, { _T("\\\\server\\dir\\foo.bar"), _T("server"), _T("\\dir"), _T("foo"), _T("bar"), true, wxPATH_DOS }, + // wxFileName support for Mac file names is broken currently #if 0 // Mac file names @@ -70,6 +75,8 @@ static struct FileNameInfo #endif // 0 // VMS file names + // NB: on Windows they have the same effect of the \\server\\ strings + // (see the note above) { _T("device:[dir1.dir2.dir3]file.txt"), _T("device"), _T("dir1.dir2.dir3"), _T("file"), _T("txt"), true, wxPATH_VMS }, { _T("file.txt"), _T(""), _T(""), _T("file"), _T("txt"), false, wxPATH_VMS }, }; @@ -90,6 +97,7 @@ private: CPPUNIT_TEST( TestSplit ); CPPUNIT_TEST( TestSetPath ); CPPUNIT_TEST( TestStrip ); + CPPUNIT_TEST( TestNormalize ); #ifdef __WINDOWS__ CPPUNIT_TEST( TestShortLongPath ); #endif // __WINDOWS__ @@ -100,6 +108,7 @@ private: void TestSplit(); void TestSetPath(); void TestStrip(); + void TestNormalize(); #ifdef __WINDOWS__ void TestShortLongPath(); #endif // __WINDOWS__ @@ -149,7 +158,6 @@ void FileNameTestCase::TestComparison() fn1.Normalize(); fn2.Normalize(); CPPUNIT_ASSERT(fn1.GetPath() == fn2.GetPath()); - } void FileNameTestCase::TestSplit() @@ -183,6 +191,76 @@ void FileNameTestCase::TestSetPath() CPPUNIT_ASSERT( fn.SameAs(wxFileName(_T("/usr/local/bin/ls"), wxPATH_UNIX)) ); } +void FileNameTestCase::TestNormalize() +{ + // prepare some data to be used later + wxString sep = wxFileName::GetPathSeparator(); + wxString cwd = wxGetCwd(); + wxString home = wxGetUserHome(); + + cwd.Replace(sep, wxT("/")); + if (cwd.Last() != wxT('/')) + cwd += wxT('/'); + home.Replace(sep, wxT("/")); + if (home.Last() != wxT('/')) + home += wxT('/'); + + // since we will always be testing paths using the wxPATH_UNIX + // format, we need to remove the volume, if present + if (home.Contains(wxT(':'))) + home = home.AfterFirst(wxT(':')); + if (cwd.Contains(wxT(':'))) + cwd = cwd.AfterFirst(wxT(':')); + + static struct FileNameTest + { + wxString original; + int flags; + wxString expected; + } tests[] = + { + // test wxPATH_NORM_ENV_VARS +#ifdef __WXMSW__ + { wxT("%ABCDEF%/g/h/i"), wxPATH_NORM_ENV_VARS, wxT("abcdef/g/h/i") }, +#else + { wxT("$(ABCDEF)/g/h/i"), wxPATH_NORM_ENV_VARS, wxT("abcdef/g/h/i") }, +#endif + + // test wxPATH_NORM_DOTS + { wxT("a/.././b/c/../../"), wxPATH_NORM_DOTS, wxT("") }, + + // test wxPATH_NORM_TILDE + // NB: do the tilde expansion also under Windows to test if it works there too + { wxT("/a/b/~"), wxPATH_NORM_TILDE, wxT("/a/b/~") }, + { wxT("/~/a/b"), wxPATH_NORM_TILDE, home + wxT("a/b") }, + { wxT("~/a/b"), wxPATH_NORM_TILDE, home + wxT("a/b") }, + + // test wxPATH_NORM_ABSOLUTE + { wxT("a/b/"), wxPATH_NORM_ABSOLUTE, cwd + wxT("a/b/") }, + { wxT("a/b/c.ext"), wxPATH_NORM_ABSOLUTE, cwd + wxT("a/b/c.ext") }, + { wxT("/a"), wxPATH_NORM_ABSOLUTE, wxT("/a") }, + + // test giving no flags at all to Normalize() + { wxT("a/b/"), 0, wxT("a/b/") }, + { wxT("a/b/c.ext"), 0, wxT("a/b/c.ext") }, + { wxT("/a"), 0, wxT("/a") } + }; + + // set the env var ABCDEF + wxSetEnv(_T("ABCDEF"), _T("abcdef")); + + for (size_t i=0; i < WXSIZEOF(tests); i++) + { + wxFileName fn(tests[i].original, wxPATH_UNIX); + + // be sure this normalization does not fail + CPPUNIT_ASSERT( fn.Normalize(tests[i].flags, cwd, wxPATH_UNIX) ); + + // compare result with expected string + CPPUNIT_ASSERT_EQUAL( tests[i].expected, fn.GetFullPath(wxPATH_UNIX) ); + } +} + wxString wxTestStripExtension(wxString szFile) { wxStripExtension(szFile); -- 2.45.2