X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/8c94336825149d5f329eaea77ba32ae5b5fd3a31..bf7bd4b18521e52b4c6651a974e5f43a0101f71b:/include/wx/stdpaths.h

diff --git a/include/wx/stdpaths.h b/include/wx/stdpaths.h
index d0b9dee54d..999720d3ac 100644
--- a/include/wx/stdpaths.h
+++ b/include/wx/stdpaths.h
@@ -14,14 +14,15 @@
 
 #include "wx/defs.h"
 
-#if wxUSE_STDPATHS
-
 #include "wx/string.h"
+#include "wx/filefn.h"
 
 // ----------------------------------------------------------------------------
 // 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:
@@ -38,10 +39,24 @@ public:
         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
     static wxStandardPathsBase& 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
@@ -103,59 +118,98 @@ public:
     // 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
     {
         return GetResourcesDir() + wxFILE_SEP_PATH + lang;
     }
 
+    // return the "Documents" directory for the current user
+    //
+    // C:\Documents and Settings\username\Documents under Windows,
+    // $HOME under Unix and ~/Documents under Mac
+    virtual wxString GetDocumentsDir() const;
+
+    // return the temporary directory for the current user
+    virtual wxString GetTempDir() const;
+
+
+    // ctor for the base class
+    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:
-    // 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);
+    // append the path component, with a leading path seperator if a
+    // path seperator 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(__WXMSW__)
+        #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/mac/corefoundation/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
+    #elif defined(__PALMOS__)
+        #include "wx/palmos/stdpaths.h"
+        #define wxHAS_NATIVE_STDPATHS
+    #endif
+#endif
 
 // ----------------------------------------------------------------------------
 // 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; }
+
+    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 GetLocalDataDir() const { return m_prefix; }
     virtual wxString GetUserDataDir() const { return m_prefix; }
     virtual wxString GetPluginsDir() const { return m_prefix; }
+    virtual wxString GetDocumentsDir() const { return m_prefix; }
 
 private:
     wxString m_prefix;
 };
-
-#endif
-
-#endif // wxUSE_STDPATHS
+#endif // !wxHAS_NATIVE_STDPATHS
 
 #endif // _WX_STDPATHS_H_