X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/4fdfb5587f4d6f704336b57bae57cc0268f8768c..4fdae9972d39fbe62adaa1c1d721ba1762cd8950:/src/common/filename.cpp diff --git a/src/common/filename.cpp b/src/common/filename.cpp index 28c761783c..086598ef3b 100644 --- a/src/common/filename.cpp +++ b/src/common/filename.cpp @@ -1,7 +1,7 @@ ///////////////////////////////////////////////////////////////////////////// -// Name: filename.cpp -// Purpose: wxFileName - encapsulates candy -// Author: Robert Roebling +// Name: src/common/filename.cpp +// Purpose: wxFileName - encapsulates a file path +// Author: Robert Roebling, Vadim Zeitlin // Modified by: // Created: 28.12.2000 // RCS-ID: $Id$ @@ -9,6 +9,14 @@ // Licence: wxWindows license ///////////////////////////////////////////////////////////////////////////// +// ============================================================================ +// declarations +// ============================================================================ + +// ---------------------------------------------------------------------------- +// headers +// ---------------------------------------------------------------------------- + #ifdef __GNUG__ #pragma implementation "filename.h" #endif @@ -27,113 +35,93 @@ #include "wx/filename.h" #include "wx/tokenzr.h" +#include "wx/config.h" // for wxExpandEnvVars #include "wx/utils.h" -//---------------------------------------------------------------------------- -// wxFileName -//---------------------------------------------------------------------------- +// ============================================================================ +// implementation +// ============================================================================ -wxFileName::wxFileName( const wxFileName &filepath ) -{ - m_ext = filepath.GetExt(); - m_name = filepath.GetName(); - const wxArrayString &dirs = filepath.GetDirs(); - for (size_t i = 0; i < dirs.GetCount(); i++) - m_dirs.Add( dirs[i] ); -} +// ---------------------------------------------------------------------------- +// wxFileName construction +// ---------------------------------------------------------------------------- void wxFileName::Assign( const wxFileName &filepath ) { - m_dirs.Clear(); m_ext = filepath.GetExt(); m_name = filepath.GetName(); - const wxArrayString &dirs = filepath.GetDirs(); - for (size_t i = 0; i < dirs.GetCount(); i++) - m_dirs.Add( dirs[i] ); + m_dirs = filepath.GetDirs(); } -void wxFileName::Assign( const wxString &path, bool dir_only, wxPathFormat format ) +void wxFileName::Assign( const wxString& path, + const wxString& name, + const wxString& ext, + wxPathFormat format ) { - m_ext = wxEmptyString; - m_name = wxEmptyString; - m_dirs.Clear(); - - format = GetFormat( format ); - - wxString seps; - if (format == wxPATH_DOS) - { - seps = "/\\"; - } - else - if (format == wxPATH_UNIX) - { - seps = "/"; - } - else - { - seps = ":"; - } - - wxStringTokenizer tn( path, seps, wxTOKEN_RET_EMPTY_ALL ); + wxStringTokenizer tn(path, GetPathSeparators(format), + wxTOKEN_RET_EMPTY_ALL); bool first = TRUE; - while (tn.HasMoreTokens()) + m_dirs.Clear(); + while ( tn.HasMoreTokens() ) { - wxString token( tn.GetNextToken() ); - + wxString token = tn.GetNextToken(); + // If the path starts with a slash, we need the first // dir entry to be an empty for later reassembly. - if (first || !token.IsEmpty()) m_dirs.Add( token ); + first = FALSE; } - - if (!dir_only) - { - // make last m_dir -> m_name - size_t last = m_dirs.GetCount(); - if (last == 0) return; - last--; - m_name = m_dirs[last]; - m_dirs.Remove( last ); - - if (m_name == wxT(".")) return; - if (m_name == wxT("..")) return; - - // ext? - int pos = m_name.Find( wxT('.') ); - if (pos == -1) return; - - bool has_starting_dot = (pos == 0); - if (has_starting_dot && (format == wxPATH_UNIX)) - { - // remove dot - m_name.Remove(0,1); - - // search again - pos = m_name.Find( wxT('.') ); - if (pos == -1) - { - // add dot back - m_name.Prepend( "." ); - return; - } - } - m_ext = m_name; - m_ext.Remove( 0, pos+1 ); - - m_name.Remove( pos, m_name.Len()-pos ); - - if (has_starting_dot && (format == wxPATH_UNIX)) - { - // add dot back - m_name.Prepend( "." ); - return; - } - } + + m_ext = ext; + m_name = name; +} + +void wxFileName::Assign(const wxString& fullpath, + wxPathFormat format) +{ + wxString path, name, ext; + SplitPath(fullpath, &path, &name, &ext, format); + + Assign(path, name, ext, format); +} + +void wxFileName::Assign(const wxString& path, + const wxString& fullname, + wxPathFormat format) +{ + wxString name, ext; + SplitPath(fullname, NULL /* no path */, &name, &ext, format); + + Assign(path, name, ext, format); +} + +void wxFileName::Clear() +{ + m_dirs.Clear(); + m_name = + m_ext = wxEmptyString; +} + +/* static */ +wxFileName wxFileName::FileName(const wxString& file) +{ + return wxFileName(file); +} + +/* static */ +wxFileName wxFileName::DirName(const wxString& dir) +{ + wxFileName fn; + fn.AssignDir(dir); + return fn; } +// ---------------------------------------------------------------------------- +// existence tests +// ---------------------------------------------------------------------------- + bool wxFileName::FileExists() { return wxFileName::FileExists( GetFullPath() ); @@ -154,11 +142,16 @@ bool wxFileName::DirExists( const wxString &dir ) return ::wxDirExists( dir ); } +// ---------------------------------------------------------------------------- +// CWD and HOME stuff +// ---------------------------------------------------------------------------- + void wxFileName::AssignCwd() { - Assign( wxFileName::GetCwd(), TRUE ); + AssignDir(wxFileName::GetCwd()); } +/* static */ wxString wxFileName::GetCwd() { return ::wxGetCwd(); @@ -176,18 +169,31 @@ bool wxFileName::SetCwd( const wxString &cwd ) void wxFileName::AssignHomeDir() { - Assign( wxFileName::GetHomeDir(), TRUE ); + AssignDir(wxFileName::GetHomeDir()); } - + wxString wxFileName::GetHomeDir() { return ::wxGetHomeDir(); } - + void wxFileName::AssignTempFileName( const wxString &prefix ) { + wxString fullname; + if ( wxGetTempFileName(prefix, fullname) ) + { + Assign(fullname); + } + else // error + { + Clear(); + } } +// ---------------------------------------------------------------------------- +// directory operations +// ---------------------------------------------------------------------------- + bool wxFileName::Mkdir( int perm ) { return wxFileName::Mkdir( GetFullPath(), perm ); @@ -208,123 +214,200 @@ bool wxFileName::Rmdir( const wxString &dir ) return ::wxRmdir( dir ); } -bool wxFileName::Normalize( const wxString &cwd, const wxString &home ) +// ---------------------------------------------------------------------------- +// path normalization +// ---------------------------------------------------------------------------- + +bool wxFileName::Normalize(wxPathNormalize flags, + const wxString& cwd, + wxPathFormat format) { - wxFileName tmp( *this ); - m_dirs.Clear(); - const wxArrayString &dirs = tmp.GetDirs(); - - if (dirs.GetCount() == 0) return FALSE; - - size_t start = 0; - - if (dirs[0] == wxT(".")) + // the existing path components + wxArrayString dirs = GetDirs(); + + // the path to prepend in front to make the path absolute + wxFileName curDir; + + format = GetFormat(format); + + // make the path absolute + if ( (flags & wxPATH_NORM_ABSOLUTE) && !IsAbsolute() ) { - if (cwd == wxEmptyString) - Assign( wxFileName::GetCwd(), TRUE ); + if ( cwd.empty() ) + curDir.AssignCwd(); else - Assign( cwd ); - start = 1; + curDir.AssignDir(cwd); } - else - if (dirs[0] == wxT("..")) + + // handle ~ stuff under Unix only + if ( (format == wxPATH_UNIX) && (flags & wxPATH_NORM_TILDE) ) { - if (cwd == wxEmptyString) - Assign( wxFileName::GetCwd(), TRUE ); - else - Assign( cwd ); - m_dirs.Remove( m_dirs.GetCount()-1 ); - start = 1; + if ( !dirs.IsEmpty() ) + { + wxString dir = dirs[0u]; + if ( !dir.empty() && dir[0u] == _T('~') ) + { + curDir.AssignDir(wxGetUserHome(dir.c_str() + 1)); + + dirs.RemoveAt(0u); + } + } } - else - if (dirs[0] == wxT("~")) + + if ( curDir.IsOk() ) { - if (home == wxEmptyString) - Assign( wxFileName::GetHomeDir(), TRUE ); - else - Assign( home ); - start = 1; + wxArrayString dirsNew = curDir.GetDirs(); + size_t count = dirs.GetCount(); + for ( size_t n = 0; n < count; n++ ) + { + dirsNew.Add(dirs[n]); + } + + dirs = dirsNew; } - - for (size_t i = start; i < dirs.GetCount(); i++) + + // now deal with ".", ".." and the rest + m_dirs.Empty(); + size_t count = dirs.GetCount(); + for ( size_t n = 0; n < count; n++ ) { - if (dirs[i] == wxT(".")) continue; - - if (dirs[i] == wxT("..")) + wxString dir = dirs[n]; + + if ( flags && wxPATH_NORM_DOTS ) { - m_dirs.Remove( m_dirs.GetCount()-1 ); - continue; + if ( dir == wxT(".") ) + { + // just ignore + continue; + } + + if ( dir == wxT("..") ) + { + if ( m_dirs.IsEmpty() ) + { + wxLogError(_("The path '%s' contains too many \"..\"!"), + GetFullPath().c_str()); + return FALSE; + } + + m_dirs.Remove(m_dirs.GetCount() - 1); + continue; + } + } + + if ( flags & wxPATH_NORM_ENV_VARS ) + { + dir = wxExpandEnvVars(dir); } - - // expand env vars here ? - - m_dirs.Add( dirs[i] ); + + if ( (flags & wxPATH_NORM_CASE) && !IsCaseSensitive(format) ) + { + dir.MakeLower(); + } + + m_dirs.Add(dir); + } + + if ( (flags & wxPATH_NORM_CASE) && !IsCaseSensitive(format) ) + { + // VZ: expand env vars here too? + + m_name.MakeLower(); + m_ext.MakeLower(); } - - m_name = tmp.GetName(); - m_ext = tmp.GetExt(); - + return TRUE; } -bool wxFileName::SameAs( const wxFileName &filepath, bool upper_case ) +// ---------------------------------------------------------------------------- +// filename kind tests +// ---------------------------------------------------------------------------- + +bool wxFileName::SameAs( const wxFileName &filepath, wxPathFormat format) { - wxString file1( GetFullPath() ); - wxString file2( filepath.GetFullPath() ); - - if (upper_case) - { - file1.MakeUpper(); // what does MSW do to non-ascii chars etc? native funcs? - file2.MakeUpper(); - } - - return (file1 == file2); + wxFileName fn1 = *this, + fn2 = filepath; + + // get cwd only once - small time saving + wxString cwd = wxGetCwd(); + fn1.Normalize(wxPATH_NORM_ALL, cwd, format); + fn2.Normalize(wxPATH_NORM_ALL, cwd, format); + + if ( fn1.GetFullPath() == fn2.GetFullPath() ) + return TRUE; + + // TODO: compare inodes for Unix, this works even when filenames are + // different but files are the same (symlinks) (VZ) + + return FALSE; } +/* static */ bool wxFileName::IsCaseSensitive( wxPathFormat format ) { - format = GetFormat( format ); - - return (format != wxPATH_DOS); + // only DOS filenames are case-sensitive + return GetFormat(format) != wxPATH_DOS; } bool wxFileName::IsRelative( wxPathFormat format ) { - format = GetFormat( format ); - - for (size_t i = 0; i < m_dirs.GetCount(); i++) + return !IsAbsolute(format); +} + +bool wxFileName::IsAbsolute( wxPathFormat format ) +{ + wxChar ch = m_dirs.IsEmpty() ? _T('\0') : m_dirs[0u][0u]; + + // the path is absolute if it starts with a path separator or, only for + // Unix filenames, with "~" or "~user" + return IsPathSeparator(ch, format) || + (GetFormat(format) == wxPATH_UNIX && ch == _T('~') ); +} + +/* static */ +wxString wxFileName::GetPathSeparators(wxPathFormat format) +{ + wxString seps; + switch ( GetFormat(format) ) { - if ((format == wxPATH_UNIX) && (i == 0) && (m_dirs[0] == wxT("~"))) return TRUE; - - if (m_dirs[i] == wxT(".")) return TRUE; - if (m_dirs[i] == wxT("..")) return TRUE; + case wxPATH_DOS: + // accept both as native APIs do + seps << wxFILE_SEP_PATH_UNIX << wxFILE_SEP_PATH_DOS; + break; + + default: + wxFAIL_MSG( _T("unknown wxPATH_XXX style") ); + // fall through + + case wxPATH_UNIX: + seps = wxFILE_SEP_PATH_UNIX; + break; + + case wxPATH_MAC: + seps = wxFILE_SEP_PATH_MAC; + break; } - return FALSE; + return seps; } -bool wxFileName::IsAbsolute( wxPathFormat format ) +/* static */ +bool wxFileName::IsPathSeparator(wxChar ch, wxPathFormat format) { - return (!IsRelative(format)); + return GetPathSeparators(format).Find(ch) != wxNOT_FOUND; } bool wxFileName::IsWild( wxPathFormat format ) { - format = GetFormat( format ); - - if (format == wxPATH_DOS) - { - if (m_name.Find( wxT('*') ) != -1) return TRUE; - if (m_name.Find( wxT('?') ) != -1) return TRUE; - } - else - { - if (m_name.Find( wxT('*') ) != -1) return TRUE; - } - - return FALSE; + // FIXME: this is probably false for Mac and this is surely wrong for most + // of Unix shells (think about "[...]") + return m_name.find_first_of(_T("*?")) != wxString::npos; } +// ---------------------------------------------------------------------------- +// path components manipulation +// ---------------------------------------------------------------------------- + void wxFileName::AppendDir( const wxString &dir ) { m_dirs.Add( dir ); @@ -345,153 +428,148 @@ void wxFileName::RemoveDir( int pos ) m_dirs.Remove( (size_t)pos ); } -void wxFileName::SetFullName( const wxString name, wxPathFormat format ) +// ---------------------------------------------------------------------------- +// accessors +// ---------------------------------------------------------------------------- + +void wxFileName::SetFullName(const wxString& fullname) { - format = GetFormat( format ); - - m_name = name; - m_ext = wxEmptyString; - - if (m_name == wxT(".")) return; - if (m_name == wxT("..")) return; - - // ext? - int pos = m_name.Find( wxT('.') ); - if (pos == -1) return; - - bool has_starting_dot = (pos == 0); - if (has_starting_dot && (format == wxPATH_UNIX)) + SplitPath(fullname, NULL /* no path */, &m_name, &m_ext); +} + +wxString wxFileName::GetFullName() const +{ + wxString fullname = m_name; + if ( !m_ext.empty() ) { - // remove dot - m_name.Remove(0,1); - - // search again - pos = m_name.Find( wxT('.') ); - if (pos == -1) - { - // add dot back - m_name.Prepend( "." ); - return; - } + fullname << wxFILE_SEP_EXT << m_ext; } - - m_ext = m_name; - m_ext.Remove( 0, pos+1 ); - - m_name.Remove( pos, m_name.Len()-pos ); - - if (has_starting_dot && (format == wxPATH_UNIX)) + + return fullname; +} + +wxString wxFileName::GetPath( bool add_separator, wxPathFormat format ) const +{ + format = GetFormat( format ); + + wxString ret; + size_t count = m_dirs.GetCount(); + for ( size_t i = 0; i < count; i++ ) { - // add dot back - m_name.Prepend( "." ); - return; + ret += m_dirs[i]; + if ( add_separator || (i < count) ) + ret += wxFILE_SEP_PATH; } + + return ret; +} + +wxString wxFileName::GetFullPath( wxPathFormat format ) const +{ + return GetPathWithSep() + GetFullName(); } -wxString wxFileName::GetFullName() +wxPathFormat wxFileName::GetFormat( wxPathFormat format ) { - wxString ret( m_name ); - if (!m_ext.IsEmpty()) - { - ret += '.'; - ret += m_ext; + if (format == wxPATH_NATIVE) + { +#if defined(__WXMSW__) || defined(__WXPM__) + format = wxPATH_DOS; +#elif defined(__WXMAC__) + format = wxPATH_MAC; +#else + format = wxPATH_UNIX; +#endif } - return ret; + return format; } -wxString wxFileName::GetPath( bool add_separator, wxPathFormat format ) const +// ---------------------------------------------------------------------------- +// path splitting function +// ---------------------------------------------------------------------------- + +void wxFileName::SplitPath(const wxString& fullpath, + wxString *pstrPath, + wxString *pstrName, + wxString *pstrExt, + wxPathFormat format) { - format = GetFormat( format ); - - wxString ret; - if (format == wxPATH_DOS) + format = GetFormat(format); + + // find the positions of the last dot and last path separator in the path + size_t posLastDot = fullpath.find_last_of(wxFILE_SEP_EXT); + size_t posLastSlash = fullpath.find_last_of(GetPathSeparators(format)); + + if ( (posLastDot != wxString::npos) && (format == wxPATH_UNIX) ) { - for (size_t i = 0; i < m_dirs.GetCount(); i++) + if ( (posLastDot == 0) || + (fullpath[posLastDot - 1] == wxFILE_SEP_PATH_UNIX) ) { - ret += m_dirs[i]; - if (add_separator || (i != m_dirs.GetCount()-1)) - ret += '\\'; + // under Unix, dot may be (and commonly is) the first character of + // the filename, don't treat the entire filename as extension in + // this case + posLastDot = wxString::npos; } } - else - if (format == wxPATH_UNIX) + + // if we do have a dot and a slash, check that the dot is in the name part + if ( (posLastDot != wxString::npos) && + (posLastSlash != wxString::npos) && + (posLastDot < posLastSlash) ) { - for (size_t i = 0; i < m_dirs.GetCount(); i++) - { - ret += m_dirs[i]; - if (add_separator || (i != m_dirs.GetCount()-1)) - ret += '/'; - } + // the dot is part of the path, not the start of the extension + posLastDot = wxString::npos; } - else + + // now fill in the variables provided by user + if ( pstrPath ) { - for (size_t i = 0; i < m_dirs.GetCount(); i++) + if ( posLastSlash == wxString::npos ) + { + // no path at all + pstrPath->Empty(); + } + else { - ret += m_dirs[i]; - if (add_separator || (i != m_dirs.GetCount()-1)) - ret += ":"; + // take all until the separator + *pstrPath = fullpath.Left(posLastSlash); } } - - return ret; -} -wxString wxFileName::GetFullPath( wxPathFormat format ) const -{ - format = GetFormat( format ); - - wxString ret; - if (format == wxPATH_DOS) + if ( pstrName ) { - for (size_t i = 0; i < m_dirs.GetCount(); i++) + // take all characters starting from the one after the last slash and + // up to, but excluding, the last dot + size_t nStart = posLastSlash == wxString::npos ? 0 : posLastSlash + 1; + size_t count; + if ( posLastDot == wxString::npos ) { - ret += m_dirs[i]; - ret += '\\'; + // take all until the end + count = wxString::npos; } - } - else - if (format == wxPATH_UNIX) - { - for (size_t i = 0; i < m_dirs.GetCount(); i++) + else if ( posLastSlash == wxString::npos ) { - ret += m_dirs[i]; - ret += '/'; + count = posLastDot; } - } - else - { - for (size_t i = 0; i < m_dirs.GetCount(); i++) + else // have both dot and slash { - ret += m_dirs[i]; - ret += ':'; + count = posLastDot - posLastSlash - 1; } + + *pstrName = fullpath.Mid(nStart, count); } - - ret += m_name; - - if (!m_ext.IsEmpty()) - { - ret += '.'; - ret += m_ext; - } - - return ret; -} -wxPathFormat wxFileName::GetFormat( wxPathFormat format ) -{ - if (format == wxPATH_NATIVE) + if ( pstrExt ) { -#if defined(__WXMSW__) || defined(__WXPM__) - format = wxPATH_DOS; -#endif -#if defined(__WXMAC__) - format = wxPATH_MAC; -#endif -#if !defined(__WXMSW__) && !defined(__WXPM__) && !defined(__WXMAC__) - format = wxPATH_UNIX; -#endif + if ( posLastDot == wxString::npos ) + { + // no extension + pstrExt->Empty(); + } + else + { + // take everything after the dot + *pstrExt = fullpath.Mid(posLastDot + 1); + } } - return format; } -