Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

VFS -> virtual file system expansion; fixed typos in fs.tex

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/branches/WX_2_2_BRANCH@7254 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Václav Slavík
2000-04-23 19:07:42 +00:00
parent 4a969a50f3
commit 6d2df48070
2 changed files with 29 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

48
docs/latex/wx/fs.tex
View File

@@ -2,21 +2,22 @@
The wxHTML library uses a {\bf virtual file systems} mechanism The wxHTML library uses a {\bf virtual file systems} mechanism
similar to the one used in Midnight Commander, Dos Navigator, similar to the one used in Midnight Commander, Dos Navigator,
FAR or almost any modern file manager. (Do you remember? You can FAR or almost any modern file manager. It allows the user to access
press enter on a ZIP file and its contents are displayed as if it data stored in archives as if they were ordinary files. On-the-fly
were a local directory.) generated files that exist only in memory are also supported.
\wxheading{Classes} \wxheading{Classes}
Three classes are used in order to provide full VFS: Three classes are used in order to provide virtual file systems mechanism:
\begin{itemize}\itemsep=0pt \begin{itemize}\itemsep=0pt
\item The \helpref{wxFSFile}{wxfsfile} class provides information \item The \helpref{wxFSFile}{wxfsfile} class provides information
on opened file (name, input stream, mime type and anchor). about opened file (name, input stream, mime type and anchor).
\item The \helpref{wxFileSystem}{wxfilesystem} class is the interface. \item The \helpref{wxFileSystem}{wxfilesystem} class is the interface.
Its main methods are ChangePathTo() and OpenFile(). This class Its main methods are ChangePathTo() and OpenFile(). This class
is most often used by the end user. is most often used by the end user.
\item The \helpref{wxFileSystemHandler}{wxfilesystemhandler} is the core \item The \helpref{wxFileSystemHandler}{wxfilesystemhandler} is the core
of virtual file systems mechanism. You can derive your own handler and pass it to
of the VFS mechanism. You can derive your own handler and pass it to of the VFS mechanism. You can derive your own handler and pass it to
wxFileSystem's AddHandler() method. In the new handler you only need to wxFileSystem's AddHandler() method. In the new handler you only need to
override the OpenFile() and CanOpen() methods. override the OpenFile() and CanOpen() methods.
@@ -31,7 +32,7 @@ Locations (aka filenames aka addresses) are constructed from four parts:
file by checking its protocol. Examples are "http", "file" or "ftp". file by checking its protocol. Examples are "http", "file" or "ftp".
\item {\bf right location} - is the name of file within the protocol. \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". 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. \item {\bf anchor} - an anchor is optional and is usually not present.
In "index.htm\#chapter2" the anchor is "chapter2". In "index.htm\#chapter2" the anchor is "chapter2".
\item {\bf left location} - this is usually an empty string. \item {\bf left location} - this is usually an empty string.
It is used by 'local' protocols such as ZIP. It is used by 'local' protocols such as ZIP.
@@ -40,33 +41,37 @@ See Combined Protocols paragraph for details.
\wxheading{Combined Protocols} \wxheading{Combined Protocols}
The left location pretends the protocol in the URL string. The left location precedes protocol in the URL string.
It is not used by global protocols like HTTP but it is used It is not used by global protocols like HTTP but it becomes handy when nesting
by local ones - for example you can see this address: protocols - for example you may want to access files in ZIP archive that is
located on some FTP server:
ftp:ftp.archives.org/pub/cpp\_doc.zip\#zip:reference/fopen.htm\#syntax
In fact, you have to use 'left location' even when accessing local ZIPs:
file:archives/cpp\_doc.zip\#zip:reference/fopen.htm\#syntax file:archives/cpp\_doc.zip\#zip:reference/fopen.htm\#syntax
In this example, protocol is "zip", left location is In this example, the protocol is "zip", the left location is
"reference/fopen.htm", anchor is "syntax" and right location "reference/fopen.htm", the anchor is "syntax" and the right location
is "file:archives/cpp\_doc.zip". It is used by zip handler is "file:archives/cpp\_doc.zip".
to determine in what file this particular zip VFS is stored.
In fact there are two protocols used in this example: zip and file. There are {\bf two} protocols used in this example: "zip" and "file".
You can construct even more complicated addresses like this one: 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 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) In this example you access zip virtual file system stdio.zip stored in another zip (myarchive.zip)
which is at WWW. which can be found at WWW.
\wxheading{File Systems Included in wxHTML} \wxheading{File Systems Included in wxHTML}
The following VFS handlers are part of wxWindows so far: The following virtual file system handlers are part of wxWindows so far:
\begin{twocollist} \begin{twocollist}
\twocolitem{{\bf wxInternetFSHandler}}{Handler for accessing documents \twocolitem{{\bf wxInternetFSHandler}}{A handler for accessing documents
via HTTP or FTP protocols. Include file is <wx/fs_inet.h>.} via HTTP or FTP protocols. Include file is <wx/fs_inet.h>.}
\twocolitem{{\bf wxZipFSHandler}}{Handler for ZIP archives. \twocolitem{{\bf wxZipFSHandler}}{A handler for ZIP archives.
Include file is <wx/fs_zip.h>. URL is in form "archive.zip\#zip:filename".} Include file is <wx/fs_zip.h>. URL is in form "archive.zip\#zip:filename".}
\twocolitem{{\bf wxMemoryFSHandler}}{This handler allows you to access \twocolitem{{\bf wxMemoryFSHandler}}{This handler allows you to access
data stored in memory (such as bitmaps) as if they were regular files. data stored in memory (such as bitmaps) as if they were regular files.
@@ -75,7 +80,10 @@ Include file is <wx/fs_mem.h>. UURL is prefixed with memory:, e.g.
"memory:myfile.htm"} "memory:myfile.htm"}
\end{twocollist} \end{twocollist}
In addition, wxFileSystem can access local files. In addition, wxFileSystem itself can access local files.
\wxheading{Initializing file system handlers}
Use \helpref{wxFileSystem::AddHandler}{wxfilesystemaddhandler} to initialize Use \helpref{wxFileSystem::AddHandler}{wxfilesystemaddhandler} to initialize
a handler, for example: a handler, for example:

2
docs/latex/wx/tsamples.tex
View File

@@ -239,7 +239,7 @@ the library to work with unsupported tags.
handler (ships with wxWindows) allows you to access HTML pages stored handler (ships with wxWindows) allows you to access HTML pages stored
in compressed archive as if they were ordinary files. in compressed archive as if they were ordinary files.
{\bf Virtual} is yet another VFS demo. This one generates pages at run-time. {\bf Virtual} is yet another virtual file systems demo. This one generates pages at run-time.
You may find it useful if you need to display some reports in your application. You may find it useful if you need to display some reports in your application.
{\bf Printing} explains use of \helpref{wxHtmlEasyPrinting}{wxhtmleasyprinting} {\bf Printing} explains use of \helpref{wxHtmlEasyPrinting}{wxhtmleasyprinting}