Changed GetDocuments() to remove cast, added GetTemplates()

[wxWidgets.git] / src / common / filename.cpp

diff --git a/src/common/filename.cpp b/src/common/filename.cpp
index 99dce6eb04fd57548ac7a96675f0ccc091fbadad..91318e43bf2bdfe9b481b5d58c8e8620f067be7d 100644 (file)
--- 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$
 // Modified by:
 // Created:     28.12.2000
 // RCS-ID:      $Id$


@@ -9,6 +9,14 @@
 // Licence:     wxWindows license
 /////////////////////////////////////////////////////////////////////////////
 
 // Licence:     wxWindows license
 /////////////////////////////////////////////////////////////////////////////
 

+// ============================================================================
+// declarations
+// ============================================================================
+
+// ----------------------------------------------------------------------------
+// headers
+// ----------------------------------------------------------------------------
+

 #ifdef __GNUG__
     #pragma implementation "filename.h"
 #endif
 #ifdef __GNUG__
     #pragma implementation "filename.h"
 #endif


@@ -27,197 +35,379 @@
 
 #include "wx/filename.h"
 #include "wx/tokenzr.h"
 
 #include "wx/filename.h"
 #include "wx/tokenzr.h"

-#include "wx/filefn.h"
+#include "wx/config.h"          // for wxExpandEnvVars
+#include "wx/utils.h"

 
 

-//----------------------------------------------------------------------------
-// wxFileName
-//----------------------------------------------------------------------------
+// ============================================================================
+// implementation
+// ============================================================================

 
 

-wxFileName::wxFileName( const wxFileName &filename )
+// ----------------------------------------------------------------------------
+// wxFileName construction
+// ----------------------------------------------------------------------------
+
+void wxFileName::Assign( const wxFileName &filepath )

 {
 {

-    m_ext = filename.GetExt();
-    m_name = filename.GetName();
-    const wxArrayString &dirs = filename.GetDirs();
-    for (size_t i = 0; i < dirs.GetCount(); i++)
+    m_ext = filepath.GetExt();
+    m_name = filepath.GetName();
+    m_dirs = filepath.GetDirs();
+}
+
+void wxFileName::Assign( const wxString& path,
+                         const wxString& name,
+                         const wxString& ext,
+                         wxPathFormat format )
+{
+    wxStringTokenizer tn(path, GetPathSeparators(format),
+                         wxTOKEN_RET_EMPTY_ALL);
+    bool first = TRUE;
+    m_dirs.Clear();
+    while ( tn.HasMoreTokens() )

     {
     {

-        m_dirs.Add( dirs[i] );
+        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;

     }
     }

+
+    m_ext = ext;
+    m_name = name;

 }
 
 }
 

-void wxFileName::Assign( const wxString &path, bool dir_only, wxPathFormat format )
+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_ext = wxEmptyString;
-    m_name = wxEmptyString;

     m_dirs.Clear();
     m_dirs.Clear();

+    m_name =
+    m_ext = wxEmptyString;
+}

 
 

-    format = GetFormat( format );
+/* static */
+wxFileName wxFileName::FileName(const wxString& file)
+{
+    return wxFileName(file);
+}

 
 

-    wxString seps;
-    if (format == wxPATH_DOS)
-    {
-        seps = "/\\";
-    }
-    else
-    if (format == wxPATH_UNIX)
-    {
-        seps = "/";
-    }
-    else
-    {
-        seps = "/";  // or maybe ":" or both ?
-    }
-    
-    wxStringTokenizer tn( path, seps );
-    while (tn.HasMoreTokens())
-    {
-        wxString token( tn.GetNextToken() );
-        if (!token.IsEmpty())
-            m_dirs.Add( token );
-    }
-    
-    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)
-        {
-            // 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)
-        {
-            // add dot back
-            m_name.Prepend( "." );
-            return;
-        }
-    }
+/* static */
+wxFileName wxFileName::DirName(const wxString& dir)
+{
+    wxFileName fn;
+    fn.AssignDir(dir);
+    return fn;

 }
 
 }
 

+// ----------------------------------------------------------------------------
+// existence tests
+// ----------------------------------------------------------------------------
+

 bool wxFileName::FileExists()
 {
 bool wxFileName::FileExists()
 {

-    return ::wxFileExists( GetFullPath() );
+    return wxFileName::FileExists( GetFullPath() );
+}
+
+bool wxFileName::FileExists( const wxString &file )
+{
+    return ::wxFileExists( file );

 }
 
 bool wxFileName::DirExists()
 {
 }
 
 bool wxFileName::DirExists()
 {

-    return ::wxDirExists( GetFullPath() );
+    return wxFileName::DirExists( GetFullPath() );

 }
 
 }
 

+bool wxFileName::DirExists( const wxString &dir )
+{
+    return ::wxDirExists( dir );
+}
+
+// ----------------------------------------------------------------------------
+// CWD and HOME stuff
+// ----------------------------------------------------------------------------
+

 void wxFileName::AssignCwd()
 {
 void wxFileName::AssignCwd()
 {

-    Assign( wxGetCwd(), TRUE );
+    AssignDir(wxFileName::GetCwd());

 }
 
 }
 

-void wxFileName::SetCwd()
+/* static */
+wxString wxFileName::GetCwd()

 {
 {

-    wxSetWorkingDirectory( GetFullPath() );
+    return ::wxGetCwd();

 }
 
 }
 

-void wxFileName::AssignTempFileName( const wxString &prefix )
+bool wxFileName::SetCwd()

 {
 {

+    return wxFileName::SetCwd( GetFullPath() );

 }
 
 }
 

-void wxFileName::Mkdir( int perm )
+bool wxFileName::SetCwd( const wxString &cwd )

 {
 {

-    wxMkdir( GetFullPath(), perm );
+    return ::wxSetWorkingDirectory( cwd );

 }
 
 }
 

-void wxFileName::Rmdir()
+void wxFileName::AssignHomeDir()

 {
 {

-    wxRmdir( GetFullPath() );
+    AssignDir(wxFileName::GetHomeDir());

 }
 
 }
 

-void wxFileName::MakeAbsolute()
+wxString wxFileName::GetHomeDir()

 {
 {

+    return ::wxGetHomeDir();

 }
 
 }
 

-bool wxFileName::SameAs( const wxFileName &filename, bool upper_on_dos )
+void wxFileName::AssignTempFileName( const wxString &prefix )

 {
 {

-    wxString file1( GetFullPath() );
-    wxString file2( filename.GetFullPath() );
-   
-#ifdef __WXMSW__
-    if (upper_on_dos)
+    wxString fullname;
+    if ( wxGetTempFileName(prefix, fullname) )

     {
     {

-        file1.MakeUpper();
-        file2.MakeUpper();
+        Assign(fullname);
+    }
+    else // error
+    {
+        Clear();

     }
     }

-#endif
-   
-    return (file1 == file2);

 }
 
 }
 

-bool wxFileName::IsCaseSensitive( wxPathFormat format )
+// ----------------------------------------------------------------------------
+// directory operations
+// ----------------------------------------------------------------------------
+
+bool wxFileName::Mkdir( int perm )

 {
 {

-    format = GetFormat( format );
-    
-    return (format != wxPATH_DOS);
+    return wxFileName::Mkdir( GetFullPath(), perm );

 }
 
 }
 

-bool wxFileName::IsRelative( wxPathFormat format )
+bool wxFileName::Mkdir( const wxString &dir, int perm )

 {
 {

-    format = GetFormat( format );
-    
-    for (size_t i = 0; i < m_dirs.GetCount(); i++)
+    return ::wxMkdir( dir, perm );
+}
+
+bool wxFileName::Rmdir()
+{
+    return wxFileName::Rmdir( GetFullPath() );
+}
+
+bool wxFileName::Rmdir( const wxString &dir )
+{
+    return ::wxRmdir( dir );
+}
+
+// ----------------------------------------------------------------------------
+// path normalization
+// ----------------------------------------------------------------------------
+
+bool wxFileName::Normalize(wxPathNormalize flags,
+                           const wxString& cwd,
+                           wxPathFormat format)
+{
+    // 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.empty() )
+            curDir.AssignCwd();
+        else
+            curDir.AssignDir(cwd);
+    }
+
+    // handle ~ stuff under Unix only
+    if ( (format == wxPATH_UNIX) && (flags & wxPATH_NORM_TILDE) )
+    {
+        if ( !dirs.IsEmpty() )
+        {
+            wxString dir = dirs[0u];
+            if ( !dir.empty() && dir[0u] == _T('~') )
+            {
+                curDir.AssignDir(wxGetUserHome(dir.c_str() + 1));
+
+                dirs.RemoveAt(0u);
+            }
+        }
+    }
+
+    if ( curDir.IsOk() )
+    {
+        wxArrayString dirsNew = curDir.GetDirs();
+        size_t count = dirs.GetCount();
+        for ( size_t n = 0; n < count; n++ )
+        {
+            dirsNew.Add(dirs[n]);
+        }
+
+        dirs = dirsNew;
+    }
+
+    // now deal with ".", ".." and the rest
+    m_dirs.Empty();
+    size_t count = dirs.GetCount();
+    for ( size_t n = 0; n < count; n++ )

     {
     {

-        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;
+        wxString dir = dirs[n];
+
+        if ( flags && wxPATH_NORM_DOTS )
+        {
+            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);
+        }
+
+        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();
+    }
+
+    return TRUE;
+}
+
+// ----------------------------------------------------------------------------
+// filename kind tests
+// ----------------------------------------------------------------------------
+
+bool wxFileName::SameAs( const wxFileName &filepath, wxPathFormat format)
+{
+    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;
 }
 
     return FALSE;
 }
 

+/* static */
+bool wxFileName::IsCaseSensitive( wxPathFormat format )
+{
+    // only DOS filenames are case-sensitive
+    return GetFormat(format) != wxPATH_DOS;
+}
+
+bool wxFileName::IsRelative( wxPathFormat format )
+{
+    return !IsAbsolute(format);
+}
+

 bool wxFileName::IsAbsolute( wxPathFormat format )
 {
 bool wxFileName::IsAbsolute( wxPathFormat format )
 {

-    return (!IsRelative(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('~') );

 }
 
 }
 

-bool wxFileName::IsWild( wxPathFormat format )
+/* static */
+wxString wxFileName::GetPathSeparators(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
+    wxString seps;
+    switch ( GetFormat(format) )

     {
     {

-       if (m_name.Find( wxT('*') ) != -1) 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;
+}
+
+/* static */
+bool wxFileName::IsPathSeparator(wxChar ch, wxPathFormat format)
+{
+    return GetPathSeparators(format).Find(ch) != wxNOT_FOUND;

 }
 
 }
 

+bool wxFileName::IsWild( wxPathFormat format )
+{
+    // 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 );
 void wxFileName::AppendDir( const wxString &dir )
 {
     m_dirs.Add( dir );


@@ -238,95 +428,131 @@ void wxFileName::RemoveDir( int pos )
     m_dirs.Remove( (size_t)pos );
 }
 
     m_dirs.Remove( (size_t)pos );
 }
 

-wxString wxFileName::GetPath( wxPathFormat format ) const
+// ----------------------------------------------------------------------------
+// accessors
+// ----------------------------------------------------------------------------
+
+void wxFileName::SetFullName(const wxString& fullname)

 {
 {

-    format = GetFormat( format );
-    
-    wxString ret;
-    if (format == wxPATH_DOS)
-    {
-        for (size_t i = 0; i < m_dirs.GetCount(); i++)
-        {
-            ret += m_dirs[i];
-            if (i != m_dirs.GetCount()-1) ret += '\\';
-        }
-    }
-    else
-    if (format == wxPATH_DOS)
+    SplitPath(fullname, NULL /* no path */, &m_name, &m_ext);
+}
+
+wxString wxFileName::GetFullName() const
+{
+    wxString fullname = m_name;
+    if ( !m_ext.empty() )

     {
     {

-        for (size_t i = 0; i < m_dirs.GetCount(); i++)
-        {
-            ret += m_dirs[i];
-            if (i != m_dirs.GetCount()-1) ret += '/';
-        }
+        fullname << wxFILE_SEP_EXT << m_ext;

     }
     }

-    else
+
+    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++ )

     {
     {

-        for (size_t i = 0; i < m_dirs.GetCount(); i++)
-        {
-            ret += m_dirs[i];
-            if (i != m_dirs.GetCount()-1) ret += "//";  // or maybe ":" ?
-        }
+        ret += m_dirs[i];
+        if ( add_separator || (i < count) )
+            ret += wxFILE_SEP_PATH;

     }
     }

-    
+

     return ret;
 }
 
 wxString wxFileName::GetFullPath( wxPathFormat format ) const
 {
     return ret;
 }
 
 wxString wxFileName::GetFullPath( wxPathFormat format ) const
 {

-    format = GetFormat( format );
-    
-    wxString ret;
-    if (format == wxPATH_DOS)
+    return GetPathWithSep() + GetFullName();
+}
+
+wxPathFormat wxFileName::GetFormat( wxPathFormat format )
+{
+    if (format == wxPATH_NATIVE)

     {
     {

-        for (size_t i = 0; i < m_dirs.GetCount(); i++)
-        {
-            ret += m_dirs[i];
-            ret += '\\';
-        }
+#if defined(__WXMSW__) || defined(__WXPM__)
+        format = wxPATH_DOS;
+#elif defined(__WXMAC__)
+        format = wxPATH_MAC;
+#else
+        format = wxPATH_UNIX;
+#endif

     }
     }

-    else
-    if (format == wxPATH_DOS)
+    return format;
+}
+
+// ----------------------------------------------------------------------------
+// path splitting function
+// ----------------------------------------------------------------------------
+
+void wxFileName::SplitPath(const wxString& fullpath,
+                           wxString *pstrPath,
+                           wxString *pstrName,
+                           wxString *pstrExt,
+                           wxPathFormat format)
+{
+    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];
-            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 ( (posLastDot != wxString::npos) && (posLastDot < posLastSlash) )

     {
     {

-        for (size_t i = 0; i < m_dirs.GetCount(); i++)
+        // the dot is part of the path, not the start of the extension
+        posLastDot = wxString::npos;
+    }
+
+    // now fill in the variables provided by user
+    if ( pstrPath )
+    {
+        if ( posLastSlash == wxString::npos )
+        {
+            // no path at all
+            pstrPath->Empty();
+        }
+        else

         {
         {

-            ret += m_dirs[i];
-            ret += '/';  // or maybe ":" ?
+            // take all until the separator
+            *pstrPath = fullpath.Left(posLastSlash);

         }
     }
         }
     }

-    
-    ret += m_name;
-    
-    if (!m_ext.IsEmpty())
+
+    if ( pstrName )

     {
     {

-        ret += '.';
-        ret += m_ext;
+        size_t nStart = posLastSlash == wxString::npos ? 0 : posLastSlash + 1;
+        size_t count = posLastDot == wxString::npos ? wxString::npos
+                                                    : posLastDot - posLastSlash;
+
+        *pstrName = fullpath.Mid(nStart, count);

     }
     }

-    
-    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;

 }
 }