]>
Commit | Line | Data |
---|---|---|
5526e819 | 1 | ///////////////////////////////////////////////////////////////////////////// |
ce7208d4 | 2 | // Name: wx/filesys.h |
5526e819 VS |
3 | // Purpose: class for opening files - virtual file system |
4 | // Author: Vaclav Slavik | |
5 | // Copyright: (c) 1999 Vaclav Slavik | |
aaa66113 | 6 | // RCS-ID: $Id$ |
65571936 | 7 | // Licence: wxWindows licence |
5526e819 VS |
8 | ///////////////////////////////////////////////////////////////////////////// |
9 | ||
10 | #ifndef __FILESYS_H__ | |
11 | #define __FILESYS_H__ | |
12 | ||
2ecf902b | 13 | #include "wx/defs.h" |
d30e0edd | 14 | |
24528b0c VS |
15 | #if !wxUSE_STREAMS |
16 | #error You cannot compile virtual file systems without wxUSE_STREAMS | |
17 | #endif | |
18 | ||
19 | #if wxUSE_HTML && !wxUSE_FILESYSTEM | |
20 | #error You cannot compile wxHTML without virtual file systems | |
21 | #endif | |
22 | ||
23 | #if wxUSE_FILESYSTEM | |
d30e0edd RR |
24 | |
25 | #include "wx/stream.h" | |
6ee654e6 | 26 | #include "wx/datetime.h" |
9548c49a | 27 | #include "wx/filename.h" |
52ad298e | 28 | #include "wx/hashmap.h" |
5526e819 | 29 | |
b5dbe15d VS |
30 | class WXDLLIMPEXP_FWD_BASE wxFSFile; |
31 | class WXDLLIMPEXP_FWD_BASE wxFileSystemHandler; | |
32 | class WXDLLIMPEXP_FWD_BASE wxFileSystem; | |
5526e819 VS |
33 | |
34 | //-------------------------------------------------------------------------------- | |
35 | // wxFSFile | |
36 | // This class is a file opened using wxFileSystem. It consists of | |
37 | // input stream, location, mime type & optional anchor | |
38 | // (in 'index.htm#chapter2', 'chapter2' is anchor) | |
39 | //-------------------------------------------------------------------------------- | |
40 | ||
bddd7a8d | 41 | class WXDLLIMPEXP_BASE wxFSFile : public wxObject |
5526e819 | 42 | { |
19008b7b | 43 | public: |
46837272 | 44 | wxFSFile(wxInputStream *stream, const wxString& loc, |
e2b87f38 VZ |
45 | const wxString& mimetype, const wxString& anchor |
46 | #if wxUSE_DATETIME | |
47 | , wxDateTime modif | |
48 | #endif // wxUSE_DATETIME | |
49 | ) | |
19008b7b VS |
50 | { |
51 | m_Stream = stream; | |
52 | m_Location = loc; | |
69cce151 | 53 | m_MimeType = mimetype.Lower(); |
19008b7b | 54 | m_Anchor = anchor; |
e2b87f38 | 55 | #if wxUSE_DATETIME |
19008b7b | 56 | m_Modif = modif; |
e2b87f38 | 57 | #endif // wxUSE_DATETIME |
19008b7b | 58 | } |
e2b87f38 | 59 | |
03402e29 | 60 | virtual ~wxFSFile() { delete m_Stream; } |
19008b7b | 61 | |
03402e29 MW |
62 | // returns stream. This doesn't give away ownership of the stream object. |
63 | wxInputStream *GetStream() const { return m_Stream; } | |
19008b7b | 64 | |
03402e29 MW |
65 | // gives away the ownership of the current stream. |
66 | wxInputStream *DetachStream() | |
67 | { | |
68 | wxInputStream *stream = m_Stream; | |
69 | m_Stream = NULL; | |
70 | return stream; | |
71 | } | |
72 | ||
73 | // deletes the current stream and takes ownership of another. | |
74 | void SetStream(wxInputStream *stream) | |
75 | { | |
76 | delete m_Stream; | |
77 | m_Stream = stream; | |
78 | } | |
84d1cd43 | 79 | |
19008b7b | 80 | // returns file's mime type |
69cce151 | 81 | const wxString& GetMimeType() const; |
19008b7b VS |
82 | |
83 | // returns the original location (aka filename) of the file | |
03402e29 | 84 | const wxString& GetLocation() const { return m_Location; } |
19008b7b | 85 | |
03402e29 | 86 | const wxString& GetAnchor() const { return m_Anchor; } |
19008b7b | 87 | |
e2b87f38 | 88 | #if wxUSE_DATETIME |
03402e29 | 89 | wxDateTime GetModificationTime() const { return m_Modif; } |
e2b87f38 | 90 | #endif // wxUSE_DATETIME |
19008b7b VS |
91 | |
92 | private: | |
93 | wxInputStream *m_Stream; | |
94 | wxString m_Location; | |
95 | wxString m_MimeType; | |
96 | wxString m_Anchor; | |
e2b87f38 | 97 | #if wxUSE_DATETIME |
19008b7b | 98 | wxDateTime m_Modif; |
e2b87f38 | 99 | #endif // wxUSE_DATETIME |
46837272 RD |
100 | |
101 | DECLARE_ABSTRACT_CLASS(wxFSFile) | |
22f3361e | 102 | DECLARE_NO_COPY_CLASS(wxFSFile) |
5526e819 VS |
103 | }; |
104 | ||
105 | ||
106 | ||
107 | ||
108 | ||
109 | //-------------------------------------------------------------------------------- | |
110 | // wxFileSystemHandler | |
111 | // This class is FS handler for wxFileSystem. It provides | |
112 | // interface to access certain | |
113 | // kinds of files (HTPP, FTP, local, tar.gz etc..) | |
114 | //-------------------------------------------------------------------------------- | |
115 | ||
bddd7a8d | 116 | class WXDLLIMPEXP_BASE wxFileSystemHandler : public wxObject |
5526e819 | 117 | { |
19008b7b VS |
118 | public: |
119 | wxFileSystemHandler() : wxObject() {} | |
120 | ||
a62848fd | 121 | // returns true if this handler is able to open given location |
19008b7b VS |
122 | virtual bool CanOpen(const wxString& location) = 0; |
123 | ||
124 | // opens given file and returns pointer to input stream. | |
125 | // Returns NULL if opening failed. | |
126 | // The location is always absolute path. | |
127 | virtual wxFSFile* OpenFile(wxFileSystem& fs, const wxString& location) = 0; | |
128 | ||
129 | // Finds first/next file that matches spec wildcard. flags can be wxDIR for restricting | |
130 | // the query to directories or wxFILE for files only or 0 for either. | |
131 | // Returns filename or empty string if no more matching file exists | |
132 | virtual wxString FindFirst(const wxString& spec, int flags = 0); | |
133 | virtual wxString FindNext(); | |
134 | ||
69cce151 VS |
135 | // Returns MIME type of the file - w/o need to open it |
136 | // (default behaviour is that it returns type based on extension) | |
137 | static wxString GetMimeTypeFromExt(const wxString& location); | |
138 | ||
19008b7b VS |
139 | protected: |
140 | // returns protocol ("file", "http", "tar" etc.) The last (most right) | |
141 | // protocol is used: | |
142 | // {it returns "tar" for "file:subdir/archive.tar.gz#tar:/README.txt"} | |
69cce151 | 143 | static wxString GetProtocol(const wxString& location); |
19008b7b VS |
144 | |
145 | // returns left part of address: | |
146 | // {it returns "file:subdir/archive.tar.gz" for "file:subdir/archive.tar.gz#tar:/README.txt"} | |
69cce151 | 147 | static wxString GetLeftLocation(const wxString& location); |
19008b7b VS |
148 | |
149 | // returns anchor part of address: | |
150 | // {it returns "anchor" for "file:subdir/archive.tar.gz#tar:/README.txt#anchor"} | |
151 | // NOTE: anchor is NOT a part of GetLeftLocation()'s return value | |
69cce151 | 152 | static wxString GetAnchor(const wxString& location); |
19008b7b VS |
153 | |
154 | // returns right part of address: | |
155 | // {it returns "/README.txt" for "file:subdir/archive.tar.gz#tar:/README.txt"} | |
69cce151 | 156 | static wxString GetRightLocation(const wxString& location); |
5526e819 | 157 | |
19008b7b | 158 | DECLARE_ABSTRACT_CLASS(wxFileSystemHandler) |
5526e819 VS |
159 | }; |
160 | ||
161 | ||
162 | ||
163 | ||
164 | //-------------------------------------------------------------------------------- | |
165 | // wxFileSystem | |
166 | // This class provides simple interface for opening various | |
167 | // kinds of files (HTPP, FTP, local, tar.gz etc..) | |
168 | //-------------------------------------------------------------------------------- | |
169 | ||
8c3dbc46 MW |
170 | // Open Bit Flags |
171 | enum { | |
172 | wxFS_READ = 1, // Open for reading | |
8c3dbc46 MW |
173 | wxFS_SEEKABLE = 4 // Returned stream will be seekable |
174 | }; | |
175 | ||
01c3ebb8 | 176 | WX_DECLARE_VOIDPTR_HASH_MAP_WITH_DECL(wxFileSystemHandler*, wxFSHandlerHash, class WXDLLIMPEXP_BASE); |
52ad298e | 177 | |
bddd7a8d | 178 | class WXDLLIMPEXP_BASE wxFileSystem : public wxObject |
5526e819 | 179 | { |
19008b7b | 180 | public: |
bf07249c | 181 | wxFileSystem() : wxObject() { m_FindFileHandler = NULL;} |
52ad298e | 182 | virtual ~wxFileSystem(); |
19008b7b VS |
183 | |
184 | // sets the current location. Every call to OpenFile is | |
185 | // relative to this location. | |
186 | // NOTE !! | |
a62848fd | 187 | // unless is_dir = true 'location' is *not* the directory but |
19008b7b VS |
188 | // file contained in this directory |
189 | // (so ChangePathTo("dir/subdir/xh.htm") sets m_Path to "dir/subdir/") | |
a62848fd | 190 | void ChangePathTo(const wxString& location, bool is_dir = false); |
19008b7b VS |
191 | |
192 | wxString GetPath() const {return m_Path;} | |
193 | ||
194 | // opens given file and returns pointer to input stream. | |
195 | // Returns NULL if opening failed. | |
196 | // It first tries to open the file in relative scope | |
197 | // (based on ChangePathTo()'s value) and then as an absolute | |
198 | // path. | |
8c3dbc46 | 199 | wxFSFile* OpenFile(const wxString& location, int flags = wxFS_READ); |
19008b7b VS |
200 | |
201 | // Finds first/next file that matches spec wildcard. flags can be wxDIR for restricting | |
202 | // the query to directories or wxFILE for files only or 0 for either. | |
203 | // Returns filename or empty string if no more matching file exists | |
204 | wxString FindFirst(const wxString& spec, int flags = 0); | |
205 | wxString FindNext(); | |
206 | ||
3ab6fcee | 207 | // find a file in a list of directories, returns false if not found |
593177c5 VS |
208 | bool FindFileInPath(wxString *pStr, |
209 | const wxString& path, const wxString& file); | |
3ab6fcee | 210 | |
19008b7b | 211 | // Adds FS handler. |
43e8916f | 212 | // In fact, this class is only front-end to the FS handlers :-) |
19008b7b VS |
213 | static void AddHandler(wxFileSystemHandler *handler); |
214 | ||
5949d307 RR |
215 | // Removes FS handler |
216 | static wxFileSystemHandler* RemoveHandler(wxFileSystemHandler *handler); | |
217 | ||
b8b37ced VZ |
218 | // Returns true if there is a handler which can open the given location. |
219 | static bool HasHandlerForPath(const wxString& location); | |
220 | ||
19008b7b VS |
221 | // remove all items from the m_Handlers list |
222 | static void CleanUpHandlers(); | |
223 | ||
2b5f62a0 | 224 | // Returns the native path for a file URL |
9548c49a | 225 | static wxFileName URLToFileName(const wxString& url); |
2b5f62a0 VZ |
226 | |
227 | // Returns the file URL for a native path | |
9548c49a | 228 | static wxString FileNameToURL(const wxFileName& filename); |
2b5f62a0 VZ |
229 | |
230 | ||
19008b7b | 231 | protected: |
52ad298e MW |
232 | wxFileSystemHandler *MakeLocal(wxFileSystemHandler *h); |
233 | ||
19008b7b VS |
234 | wxString m_Path; |
235 | // the path (location) we are currently in | |
236 | // this is path, not file! | |
237 | // (so if you opened test/demo.htm, it is | |
238 | // "test/", not "test/demo.htm") | |
239 | wxString m_LastName; | |
240 | // name of last opened file (full path) | |
241 | static wxList m_Handlers; | |
242 | // list of FS handlers | |
243 | wxFileSystemHandler *m_FindFileHandler; | |
244 | // handler that succeed in FindFirst query | |
52ad298e MW |
245 | wxFSHandlerHash m_LocalHandlers; |
246 | // Handlers local to this instance | |
5526e819 | 247 | |
19008b7b | 248 | DECLARE_DYNAMIC_CLASS(wxFileSystem) |
22f3361e | 249 | DECLARE_NO_COPY_CLASS(wxFileSystem) |
5526e819 VS |
250 | }; |
251 | ||
252 | ||
253 | /* | |
254 | ||
255 | 'location' syntax: | |
256 | ||
257 | To determine FS type, we're using standard KDE notation: | |
258 | file:/absolute/path/file.htm | |
259 | file:relative_path/xxxxx.html | |
260 | /some/path/x.file ('file:' is default) | |
261 | http://www.gnome.org | |
262 | file:subdir/archive.tar.gz#tar:/README.txt | |
263 | ||
264 | special characters : | |
265 | ':' - FS identificator is before this char | |
266 | '#' - separator. It can be either HTML anchor ("index.html#news") | |
267 | (in case there is no ':' in the string to the right from it) | |
268 | or FS separator | |
269 | (example : http://www.wxhtml.org/wxhtml-0.1.tar.gz#tar:/include/wxhtml/filesys.h" | |
270 | this would access tgz archive stored on web) | |
271 | '/' - directory (path) separator. It is used to determine upper-level path. | |
272 | HEY! Don't use \ even if you're on Windows! | |
273 | ||
274 | */ | |
275 | ||
19008b7b | 276 | |
bddd7a8d | 277 | class WXDLLIMPEXP_BASE wxLocalFSHandler : public wxFileSystemHandler |
19008b7b VS |
278 | { |
279 | public: | |
280 | virtual bool CanOpen(const wxString& location); | |
281 | virtual wxFSFile* OpenFile(wxFileSystem& fs, const wxString& location); | |
282 | virtual wxString FindFirst(const wxString& spec, int flags = 0); | |
283 | virtual wxString FindNext(); | |
46837272 | 284 | |
19008b7b VS |
285 | // wxLocalFSHandler will prefix all filenames with 'root' before accessing |
286 | // files on disk. This effectively makes 'root' the top-level directory | |
46837272 | 287 | // and prevents access to files outside this directory. |
19008b7b VS |
288 | // (This is similar to Unix command 'chroot'.) |
289 | static void Chroot(const wxString& root) { ms_root = root; } | |
46837272 | 290 | |
19008b7b VS |
291 | protected: |
292 | static wxString ms_root; | |
293 | }; | |
294 | ||
295 | ||
296 | ||
d30e0edd | 297 | #endif |
24528b0c | 298 | // wxUSE_FILESYSTEM |
d30e0edd | 299 | |
269e8200 | 300 | #endif |
d30e0edd | 301 | // __FILESYS_H__ |