class KArchiveabstract |
|
KArchive is a base class for reading and writing archives.
generic class for reading/writing archives
Author David Faure |
|
Base constructor (protected since this is a pure virtual class).
fileName - is a local path (e.g. "/tmp/myfile.ext"), from which the archive will be read from, or into which the archive will be written, depending on the mode given to open(). |
|
Base constructor (protected since this is a pure virtual class).
dev - the I/O device where the archive reads its data Note that this can be a file, but also a data buffer, a compression filter, etc. For a file in writing mode it is better to use the other constructor though, to benefit from the use of KSaveFile when saving. |
|
Writes a local directory into the archive, including all its contents, recursively.
Calls addLocalFile for each file to be added.
Since KDE 3.2 it will also add a path that is a symbolic link to a directory. The symbolic link will be dereferenced and the content of the directory it is pointing to added recursively. However, symbolic links *under* path will be stored as is. path - full path to an existing local directory, to be added to the archive. destName - the resulting name (or relative path) of the file in the archive. |
|
Writes a local file into the archive. The main difference with writeFile,
is that this method minimizes memory usage, by not loading the whole file
into memory in one go.
If fileName is a symbolic link, it will be written as is, i. e. it will not be resolved before. fileName - full path to an existing local file, to be added to the archive. destName - the resulting name (or relative path) of the file in the archive. |
|
Closes the archive.
Inherited classes might want to reimplement closeArchive instead.
Returns true if close succeeded without problems See also open |
|
Closes the archive. Called by close. |
|
Can be reimplemented in order to change the creation of the device (when using the fileName constructor). By default this method uses KSaveFile when saving, and a simple QFile on reading. This method is called by open(). |
|
The underlying device. Returns the underlying device. |
|
If an archive is opened for reading, then the contents of the archive can be accessed via this function. Returns the directory of the archive |
|
Called after writing the data.
This virtual method must be implemented by subclasses.
size - the size of the file See also finishWriting() |
|
This virtual method must be implemented by subclasses.
Depending on the archive type not all metadata might be used. name - the name of the file user - the user that owns the file group - the group that owns the file size - the size of the file perm - permissions of the file. Use 0100644 if you don't have any more specific permissions to set. atime - time the file was last accessed mtime - modification time of the file ctime - time of last status change See also prepareWriting |
|
Write a directory to the archive.
This virtual method must be implemented by subclasses.
Depending on the archive type not all metadata might be used. name - the name of the directory user - the user that owns the directory group - the group that owns the directory perm - permissions of the directory. Use 040755 if you don't have any other information. atime - time the file was last accessed mtime - modification time of the file ctime - time of last status change See also writeDir |
|
Writes a symbolic link to the archive.
This virtual method must be implemented by subclasses.
name - name of symbolic link target - target of symbolic link user - the user that owns the directory group - the group that owns the directory perm - permissions of the directory atime - time the file was last accessed mtime - modification time of the file ctime - time of last status change See also writeSymLink |
|
The name of the archive file, as passed to the constructor that takes a fileName, or an empty string if you used the QIODevice constructor. Returns the name of the file, or QString() if unknown |
|
Ensures that path exists, create otherwise.
This handles e.g. tar files missing directory entries, like mico-2.3.0.tar.gz :)
path - the path of the directory Returns the directory with the given path |
|
Call finishWriting after writing the data.
size - the size of the file See also prepareWriting() |
|
Checks whether the archive is open. Returns true if the archive is opened |
|
Returns the mode in which the archive was opened
Returns the mode in which the archive was opened (QIODevice.ReadOnly or QIODevice.WriteOnly)
See also open() |
|
Opens the archive for reading or writing.
Inherited classes might want to reimplement openArchive instead.
mode - may be QIODevice.ReadOnly or QIODevice.WriteOnly See also close |
|
Opens an archive for reading or writing.
Called by open.
mode - may be QIODevice.ReadOnly or QIODevice.WriteOnly |
|
Here's another way of writing a file into an archive:
Call prepareWriting(), then call writeData()
as many times as wanted then call finishWriting( totalSize ).
For tar.gz files, you need to know the size before hand, it is needed in the header!
For zip files, size isn't used.
This method also allows some file metadata to be set. However, depending on the archive type not all metadata might be regarded. name - the name of the file user - the user that owns the file group - the group that owns the file size - the size of the file perm - permissions of the file atime - time the file was last accessed mtime - modification time of the file ctime - time of last status change |
|
Retrieves or create the root directory. The default implementation assumes that openArchive() did the parsing, so it creates a dummy rootdir if none was set (write mode, or no '/' in the archive). Reimplement this to provide parsing/listing on demand. Returns the root directory |
|
Can be called by derived classes in order to set the underlying device. Note that KArchive will -not- own the device, it must be deleted by the derived class. |
|
Derived classes call setRootDir from openArchive, to set the root directory after parsing an existing archive. |
|
|
Write data into the current file - to be called after calling prepareWriting |
|
If an archive is opened for writing then you can add new directories
using this function. KArchive won't write one directory twice.
This method also allows some file metadata to be set. However, depending on the archive type not all metadata might be regarded. name - the name of the directory user - the user that owns the directory group - the group that owns the directory perm - permissions of the directory atime - time the file was last accessed mtime - modification time of the file ctime - time of last status change |
|
If an archive is opened for writing then you can add a new file
using this function. If the file name is for example "mydir/test1" then
the directory "mydir" is automatically appended first if that did not
happen yet.
This method also allows some file metadata to be set. However, depending on the archive type not all metadata might be regarded. name - the name of the file user - the user that owns the file group - the group that owns the file data - the data to write (@p size bytes) size - the size of the file perm - permissions of the file atime - time the file was last accessed mtime - modification time of the file ctime - time of last status change |
|
Writes a symbolic link to the archive if supported.
The archive must be opened for writing.
name - name of symbolic link target - target of symbolic link user - the user that owns the directory group - the group that owns the directory perm - permissions of the directory atime - time the file was last accessed mtime - modification time of the file ctime - time of last status change |
UnknownTime | - static_cast |
- |