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