include/wx/stdpaths.h

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/stdpaths.h
   3 // Purpose:     declaration of wxStandardPaths class
   4 // Author:      Vadim Zeitlin
   5 // Modified by:
   6 // Created:     2004-10-17
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) 2004 Vadim Zeitlin <vadim@wxwindows.org>
   9 // Licence:     wxWindows licence
  10 ///////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_STDPATHS_H_
  13 #define _WX_STDPATHS_H_
  14
  15 #include "wx/defs.h"
  16
  17 #include "wx/string.h"
  18 #include "wx/filefn.h"
  19
  20 class WXDLLIMPEXP_FWD_BASE wxStandardPaths;
  21
  22 // ----------------------------------------------------------------------------
  23 // wxStandardPaths returns the standard locations in the file system
  24 // ----------------------------------------------------------------------------
  25
  26 // NB: This is always compiled in, wxUSE_STDPATHS=0 only disables native
  27 //     wxStandardPaths class, but a minimal version is always available
  28 class WXDLLIMPEXP_BASE wxStandardPathsBase
  29 {
  30 public:
  31     // possible resources categories
  32     enum ResourceCat
  33     {
  34         // no special category
  35         ResourceCat_None,
  36
  37         // message catalog resources
  38         ResourceCat_Messages,
  39
  40         // end of enum marker
  41         ResourceCat_Max
  42     };
  43
  44     // what should we use to construct paths unique to this application:
  45     // (AppInfo_AppName and AppInfo_VendorName can be combined together)
  46     enum
  47     {
  48         AppInfo_None       = 0,  // nothing
  49         AppInfo_AppName    = 1,  // the application name
  50         AppInfo_VendorName = 2   // the vendor name
  51     };
  52
  53
  54     // return the global standard paths object
  55     static wxStandardPaths& Get();
  56
  57     // return the path (directory+filename) of the running executable or
  58     // wxEmptyString if it couldn't be determined.
  59     // The path is returned as an absolute path whenever possible.
  60     // Default implementation only try to use wxApp->argv[0].
  61     virtual wxString GetExecutablePath() const;
  62
  63     // return the directory with system config files:
  64     // /etc under Unix, c:\Documents and Settings\All Users\Application Data
  65     // under Windows, /Library/Preferences for Mac
  66     virtual wxString GetConfigDir() const = 0;
  67
  68     // return the directory for the user config files:
  69     // $HOME under Unix, c:\Documents and Settings\username under Windows,
  70     // ~/Library/Preferences under Mac
  71     //
  72     // only use this if you have a single file to put there, otherwise
  73     // GetUserDataDir() is more appropriate
  74     virtual wxString GetUserConfigDir() const = 0;
  75
  76     // return the location of the applications global, i.e. not user-specific,
  77     // data files
  78     //
  79     // prefix/share/appname under Unix, c:\Program Files\appname under Windows,
  80     // appname.app/Contents/SharedSupport app bundle directory under Mac
  81     virtual wxString GetDataDir() const = 0;
  82
  83     // return the location for application data files which are host-specific
  84     //
  85     // same as GetDataDir() except under Unix where it is /etc/appname
  86     virtual wxString GetLocalDataDir() const;
  87
  88     // return the directory for the user-dependent application data files
  89     //
  90     // $HOME/.appname under Unix,
  91     // c:\Documents and Settings\username\Application Data\appname under Windows
  92     // and ~/Library/Application Support/appname under Mac
  93     virtual wxString GetUserDataDir() const = 0;
  94
  95     // return the directory for user data files which shouldn't be shared with
  96     // the other machines
  97     //
  98     // same as GetUserDataDir() for all platforms except Windows where it is
  99     // the "Local Settings\Application Data\appname" directory
 100     virtual wxString GetUserLocalDataDir() const;
 101
 102     // return the directory where the loadable modules (plugins) live
 103     //
 104     // prefix/lib/appname under Unix, program directory under Windows and
 105     // Contents/Plugins app bundle subdirectory under Mac
 106     virtual wxString GetPluginsDir() const = 0;
 107
 108     // get resources directory: resources are auxiliary files used by the
 109     // application and include things like image and sound files
 110     //
 111     // same as GetDataDir() for all platforms except Mac where it returns
 112     // Contents/Resources subdirectory of the app bundle
 113     virtual wxString GetResourcesDir() const { return GetDataDir(); }
 114
 115     // get localized resources directory containing the resource files of the
 116     // specified category for the given language
 117     //
 118     // in general this is just GetResourcesDir()/lang under Windows and Unix
 119     // and GetResourcesDir()/lang.lproj under Mac but is something quite
 120     // different under Unix for message catalog category (namely the standard
 121     // prefix/share/locale/lang/LC_MESSAGES)
 122     virtual wxString
 123     GetLocalizedResourcesDir(const wxString& lang,
 124                              ResourceCat WXUNUSED(category)
 125                                 = ResourceCat_None) const
 126     {
 127         return GetResourcesDir() + wxFILE_SEP_PATH + lang;
 128     }
 129
 130     // return the "Documents" directory for the current user
 131     //
 132     // C:\Documents and Settings\username\My Documents under Windows,
 133     // $HOME under Unix and ~/Documents under Mac
 134     virtual wxString GetDocumentsDir() const;
 135
 136     // return the directory for the documents files used by this application:
 137     // it's a subdirectory of GetDocumentsDir() constructed using the
 138     // application name/vendor if it exists or just GetDocumentsDir() otherwise
 139     virtual wxString GetAppDocumentsDir() const;
 140
 141     // return the temporary directory for the current user
 142     virtual wxString GetTempDir() const;
 143
 144
 145     // virtual dtor for the base class
 146     virtual ~wxStandardPathsBase();
 147
 148     // Information used by AppendAppInfo
 149     void UseAppInfo(int info)
 150     {
 151         m_usedAppInfo = info;
 152     }
 153
 154     bool UsesAppInfo(int info) const { return (m_usedAppInfo & info) != 0; }
 155
 156
 157 protected:
 158     // Ctor is protected as this is a base class which should never be created
 159     // directly.
 160     wxStandardPathsBase();
 161
 162     // append the path component, with a leading path separator if a
 163     // path separator or dot (.) is not already at the end of dir
 164     static wxString AppendPathComponent(const wxString& dir, const wxString& component);
 165
 166     // append application information determined by m_usedAppInfo to dir
 167     wxString AppendAppInfo(const wxString& dir) const;
 168
 169
 170     // combination of AppInfo_XXX flags used by AppendAppInfo()
 171     int m_usedAppInfo;
 172 };
 173
 174 #if wxUSE_STDPATHS
 175     #if defined(__WINDOWS__)
 176         #include "wx/msw/stdpaths.h"
 177         #define wxHAS_NATIVE_STDPATHS
 178     // We want CoreFoundation paths on both CarbonLib and Darwin (for all ports)
 179     #elif defined(__WXMAC__) || defined(__DARWIN__)
 180         #include "wx/osx/core/stdpaths.h"
 181         #define wxHAS_NATIVE_STDPATHS
 182     #elif defined(__OS2__)
 183         #include "wx/os2/stdpaths.h"
 184         #define wxHAS_NATIVE_STDPATHS
 185     #elif defined(__UNIX__)
 186         #include "wx/unix/stdpaths.h"
 187         #define wxHAS_NATIVE_STDPATHS
 188     #endif
 189 #endif
 190
 191 // ----------------------------------------------------------------------------
 192 // Minimal generic implementation
 193 // ----------------------------------------------------------------------------
 194
 195 // NB: Note that this minimal implementation is compiled in even if
 196 //     wxUSE_STDPATHS=0, so that our code can still use wxStandardPaths.
 197
 198 #ifndef wxHAS_NATIVE_STDPATHS
 199 class WXDLLIMPEXP_BASE wxStandardPaths : public wxStandardPathsBase
 200 {
 201 public:
 202     void SetInstallPrefix(const wxString& prefix) { m_prefix = prefix; }
 203     wxString GetInstallPrefix() const { return m_prefix; }
 204
 205     virtual wxString GetExecutablePath() const { return m_prefix; }
 206     virtual wxString GetConfigDir() const { return m_prefix; }
 207     virtual wxString GetUserConfigDir() const { return m_prefix; }
 208     virtual wxString GetDataDir() const { return m_prefix; }
 209     virtual wxString GetLocalDataDir() const { return m_prefix; }
 210     virtual wxString GetUserDataDir() const { return m_prefix; }
 211     virtual wxString GetPluginsDir() const { return m_prefix; }
 212     virtual wxString GetDocumentsDir() const { return m_prefix; }
 213
 214 protected:
 215     // Ctor is protected because wxStandardPaths::Get() should always be used
 216     // to access the global wxStandardPaths object of the correct type instead
 217     // of creating one of a possibly wrong type yourself.
 218     wxStandardPaths() { }
 219
 220 private:
 221     wxString m_prefix;
 222 };
 223 #endif // !wxHAS_NATIVE_STDPATHS
 224
 225 #endif // _WX_STDPATHS_H_
 226