605d715ddd
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@5109 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
71 lines
2.6 KiB
TeX
71 lines
2.6 KiB
TeX
\section{wxFileSystem}\label{fs}
|
|
|
|
The wxHTML library uses a {\bf virtual file systems} mechanism
|
|
similar to the one used in Midnight Commander, Dos Navigator,
|
|
FAR or almost any modern file manager. (Do you remember? You can
|
|
press enter on ZIP file and its contents is displayed as if it
|
|
were a local directory...)
|
|
|
|
\wxheading{Classes}
|
|
|
|
Three classes are used in order to provide full VFS:
|
|
|
|
\begin{itemize}\itemsep=0pt
|
|
\item The \helpref{wxFSFile}{wxfsfile} class provides information
|
|
on opened file (name, input stream, mime type and anchor).
|
|
\item The \helpref{wxFileSystem}{wxfilesystem} class is the interface.
|
|
Its main methods are ChangePathTo() and OpenFile(). This class
|
|
is most often used by the end user.
|
|
\item The \helpref{wxFileSystemHandler}{wxfilesystemhandler} is the core
|
|
if VFS mechanism. You can derive your own handler and pass it to
|
|
wxFileSystem's AddHandler() method. In the new handler you only need to
|
|
overwrite OpenFile() and CanOpen() methods.
|
|
\end{itemize}
|
|
|
|
\wxheading{Locations}
|
|
|
|
Locations (aka filenames aka addresses) are constructed from 4 parts:
|
|
|
|
\begin{itemize}\itemsep=0pt
|
|
\item {\bf protocol} - handler can recognize if it is able to open a
|
|
file by checking its protocol. Examples are "http", "file" or "ftp".
|
|
\item {\bf right location} - is the name of file within the protocol.
|
|
In "http://www.wxwindows.org/index.html" the right location is "//www.wxwindows.org/index.html".
|
|
\item {\bf anchor} - anchor is optional and is usually not present.
|
|
In "index.htm\#chapter2" the anchor is "chapter2".
|
|
\item {\bf left location} - this is usually an empty string.
|
|
It is used by 'local' protocols such as ZIP.
|
|
See Combined Protocols paragraph for details.
|
|
\end{itemize}
|
|
|
|
\wxheading{Combined Protocols}
|
|
|
|
Left location pretends protocol in URL string.
|
|
It's not used by global protocols like HTTP but it's used
|
|
by local ones - for example you can see this address:
|
|
|
|
file:archives/cpp\_doc.zip\#zip:reference/fopen.htm\#syntax
|
|
|
|
In this example, protocol is "zip", left location is
|
|
"reference/fopen.htm", anchor is "syntax" and right location
|
|
is "file:archives/cpp\_doc.zip". It is used by zip handler
|
|
to determine in what file this particular zip VFS is stored.
|
|
|
|
In fact there are two protocols used in this example: zip and file.
|
|
You can construct even more complicated addresses like this one:
|
|
|
|
http://www.archives.org/myarchive.zip\#zip:local/docs/cpp/stdio.zip\#zip:index.htm
|
|
|
|
In this example you access zip VFS stdio.zip stored in another zip (myarchive.zip)
|
|
which is at WWW.
|
|
|
|
\wxheading{File Systems Included in wxHTML}
|
|
|
|
\begin{enumerate}\itemsep=0pt
|
|
\item Local files
|
|
\item HTTP protocol
|
|
\item FTP protocol
|
|
\item .ZIP archives
|
|
\end{enumerate}
|
|
|