Return the old file descriptor/pointer from wx(F)File::Detach().

[wxWidgets.git] / include / wx / stdpaths.h

diff --git a/include/wx/stdpaths.h b/include/wx/stdpaths.h
index 1be4077d6596bf96a4ae66429b6439f84e608178..9d92044457ac6a98535fa52fe95344a1fb611aa9 100644 (file)
--- a/include/wx/stdpaths.h
+++ b/include/wx/stdpaths.h
@@ -4,7 +4,6 @@
 // Author:      Vadim Zeitlin
 // Modified by:
 // Created:     2004-10-17
 // Author:      Vadim Zeitlin
 // Modified by:
 // Created:     2004-10-17

-// RCS-ID:      $Id$

 // Copyright:   (c) 2004 Vadim Zeitlin <vadim@wxwindows.org>
 // Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////
 // Copyright:   (c) 2004 Vadim Zeitlin <vadim@wxwindows.org>
 // Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////


@@ -14,19 +13,21 @@
 
 #include "wx/defs.h"
 
 
 #include "wx/defs.h"
 

-#if wxUSE_STDPATHS
-

 #include "wx/string.h"
 #include "wx/filefn.h"
 
 #include "wx/string.h"
 #include "wx/filefn.h"
 

+class WXDLLIMPEXP_FWD_BASE wxStandardPaths;
+

 // ----------------------------------------------------------------------------
 // wxStandardPaths returns the standard locations in the file system
 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------
 // wxStandardPaths returns the standard locations in the file system
 // ----------------------------------------------------------------------------
 

+// NB: This is always compiled in, wxUSE_STDPATHS=0 only disables native
+//     wxStandardPaths class, but a minimal version is always available

 class WXDLLIMPEXP_BASE wxStandardPathsBase
 {
 public:
 class WXDLLIMPEXP_BASE wxStandardPathsBase
 {
 public:

-    // possible resources categorires
+    // possible resources categories

     enum ResourceCat
     {
         // no special category
     enum ResourceCat
     {
         // no special category


@@ -39,10 +40,24 @@ public:
         ResourceCat_Max
     };
 
         ResourceCat_Max
     };
 

+    // what should we use to construct paths unique to this application:
+    // (AppInfo_AppName and AppInfo_VendorName can be combined together)
+    enum
+    {
+        AppInfo_None       = 0,  // nothing
+        AppInfo_AppName    = 1,  // the application name
+        AppInfo_VendorName = 2   // the vendor name
+    };
+

 
     // return the global standard paths object
 
     // return the global standard paths object

-    static wxStandardPathsBase& Get();
+    static wxStandardPaths& Get();

 
 

+    // return the path (directory+filename) of the running executable or
+    // wxEmptyString if it couldn't be determined.
+    // The path is returned as an absolute path whenever possible.
+    // Default implementation only try to use wxApp->argv[0].
+    virtual wxString GetExecutablePath() const;

 
     // return the directory with system config files:
     // /etc under Unix, c:\Documents and Settings\All Users\Application Data
 
     // return the directory with system config files:
     // /etc under Unix, c:\Documents and Settings\All Users\Application Data


@@ -104,7 +119,7 @@ public:
     // different under Unix for message catalog category (namely the standard
     // prefix/share/locale/lang/LC_MESSAGES)
     virtual wxString
     // different under Unix for message catalog category (namely the standard
     // prefix/share/locale/lang/LC_MESSAGES)
     virtual wxString

-    GetLocalizedResourcesDir(const wxChar *lang,
+    GetLocalizedResourcesDir(const wxString& lang,

                              ResourceCat WXUNUSED(category)
                                 = ResourceCat_None) const
     {
                              ResourceCat WXUNUSED(category)
                                 = ResourceCat_None) const
     {


@@ -113,42 +128,80 @@ public:
 
     // return the "Documents" directory for the current user
     //
 
     // return the "Documents" directory for the current user
     //

-    // C:\Documents and Settings\username\Documents under Windows,
+    // C:\Documents and Settings\username\My Documents under Windows,

     // $HOME under Unix and ~/Documents under Mac
     virtual wxString GetDocumentsDir() const;
 
     // $HOME under Unix and ~/Documents under Mac
     virtual wxString GetDocumentsDir() const;
 

+    // return the directory for the documents files used by this application:
+    // it's a subdirectory of GetDocumentsDir() constructed using the
+    // application name/vendor if it exists or just GetDocumentsDir() otherwise
+    virtual wxString GetAppDocumentsDir() const;
+
+    // return the temporary directory for the current user
+    virtual wxString GetTempDir() const;
+

 
     // virtual dtor for the base class
     virtual ~wxStandardPathsBase();
 
 
     // virtual dtor for the base class
     virtual ~wxStandardPathsBase();
 

+    // Information used by AppendAppInfo
+    void UseAppInfo(int info)
+    {
+        m_usedAppInfo = info;
+    }
+
+    bool UsesAppInfo(int info) const { return (m_usedAppInfo & info) != 0; }
+
+

 protected:
 protected:

-    // append "/appname" suffix if the app name is set (doesn't append the
-    // slash if dir already ends with a slash or dot)
-    static wxString AppendAppName(const wxString& dir);
+    // Ctor is protected as this is a base class which should never be created
+    // directly.
+    wxStandardPathsBase();
+
+    // append the path component, with a leading path separator if a
+    // path separator or dot (.) is not already at the end of dir
+    static wxString AppendPathComponent(const wxString& dir, const wxString& component);
+
+    // append application information determined by m_usedAppInfo to dir
+    wxString AppendAppInfo(const wxString& dir) const;
+
+
+    // combination of AppInfo_XXX flags used by AppendAppInfo()
+    int m_usedAppInfo;

 };
 
 };
 

-#if defined(__WXMSW__)
-    #include "wx/msw/stdpaths.h"
-// We want CoreFoundation paths on both CarbonLib and Darwin (for all ports)
-#elif defined(__WXMAC__) || defined(__DARWIN__)
-    #include "wx/mac/corefoundation/stdpaths.h"
-#elif defined(__OS2__)
-    #include "wx/os2/stdpaths.h"
-#elif defined(__UNIX__)
-    #include "wx/unix/stdpaths.h"
-#elif defined(__PALMOS__)
-    #include "wx/palmos/stdpaths.h"
-#else
+#if wxUSE_STDPATHS
+    #if defined(__WINDOWS__)
+        #include "wx/msw/stdpaths.h"
+        #define wxHAS_NATIVE_STDPATHS
+    // We want CoreFoundation paths on both CarbonLib and Darwin (for all ports)
+    #elif defined(__WXMAC__) || defined(__DARWIN__)
+        #include "wx/osx/core/stdpaths.h"
+        #define wxHAS_NATIVE_STDPATHS
+    #elif defined(__OS2__)
+        #include "wx/os2/stdpaths.h"
+        #define wxHAS_NATIVE_STDPATHS
+    #elif defined(__UNIX__)
+        #include "wx/unix/stdpaths.h"
+        #define wxHAS_NATIVE_STDPATHS
+    #endif
+#endif

 
 // ----------------------------------------------------------------------------
 // Minimal generic implementation
 // ----------------------------------------------------------------------------
 
 
 // ----------------------------------------------------------------------------
 // Minimal generic implementation
 // ----------------------------------------------------------------------------
 

+// NB: Note that this minimal implementation is compiled in even if
+//     wxUSE_STDPATHS=0, so that our code can still use wxStandardPaths.
+
+#ifndef wxHAS_NATIVE_STDPATHS

 class WXDLLIMPEXP_BASE wxStandardPaths : public wxStandardPathsBase
 {
 public:
     void SetInstallPrefix(const wxString& prefix) { m_prefix = prefix; }
     wxString GetInstallPrefix() const { return m_prefix; }
 class WXDLLIMPEXP_BASE wxStandardPaths : public wxStandardPathsBase
 {
 public:
     void SetInstallPrefix(const wxString& prefix) { m_prefix = prefix; }
     wxString GetInstallPrefix() const { return m_prefix; }

+
+    virtual wxString GetExecutablePath() const { return m_prefix; }

     virtual wxString GetConfigDir() const { return m_prefix; }
     virtual wxString GetUserConfigDir() const { return m_prefix; }
     virtual wxString GetDataDir() const { return m_prefix; }
     virtual wxString GetConfigDir() const { return m_prefix; }
     virtual wxString GetUserConfigDir() const { return m_prefix; }
     virtual wxString GetDataDir() const { return m_prefix; }


@@ -157,13 +210,16 @@ public:
     virtual wxString GetPluginsDir() const { return m_prefix; }
     virtual wxString GetDocumentsDir() const { return m_prefix; }
 
     virtual wxString GetPluginsDir() const { return m_prefix; }
     virtual wxString GetDocumentsDir() const { return m_prefix; }
 

+protected:
+    // Ctor is protected because wxStandardPaths::Get() should always be used
+    // to access the global wxStandardPaths object of the correct type instead
+    // of creating one of a possibly wrong type yourself.
+    wxStandardPaths() { }
+

 private:
     wxString m_prefix;
 };
 private:
     wxString m_prefix;
 };

-
-#endif
-
-#endif // wxUSE_STDPATHS
+#endif // !wxHAS_NATIVE_STDPATHS

 
 #endif // _WX_STDPATHS_H_
 
 
 #endif // _WX_STDPATHS_H_