cf12defd28
Ultraworked with [Sisyphus](https://github.com/code-yeongyu/oh-my-openagent) Co-authored-by: Sisyphus <clio-agent@sisyphuslabs.ai>
110 lines
3.1 KiB
C++
110 lines
3.1 KiB
C++
/* This file is part of the KDE libraries
|
|
SPDX-FileCopyrightText: 2000-2005 David Faure <faure@kde.org>
|
|
SPDX-FileCopyrightText: 2003 Leo Savernik <l.savernik@aon.at>
|
|
|
|
Moved from ktar.h by Roberto Teixeira <maragato@kde.org>
|
|
|
|
SPDX-License-Identifier: LGPL-2.0-or-later
|
|
*/
|
|
#ifndef KARCHIVEFILE_H
|
|
#define KARCHIVEFILE_H
|
|
|
|
#include <karchiveentry.h>
|
|
|
|
class KArchiveFilePrivate;
|
|
/**
|
|
* @class KArchiveFile karchivefile.h KArchiveFile
|
|
*
|
|
* Represents a file entry in a KArchive.
|
|
* @short A file in an archive.
|
|
*
|
|
* @see KArchive
|
|
* @see KArchiveDirectory
|
|
*/
|
|
class KARCHIVE_EXPORT KArchiveFile : public KArchiveEntry
|
|
{
|
|
public:
|
|
/**
|
|
* Creates a new file entry. Do not call this, KArchive takes care of it.
|
|
* @param archive the entries archive
|
|
* @param name the name of the entry
|
|
* @param access the permissions in unix format
|
|
* @param date the date (in seconds since 1970)
|
|
* @param user the user that owns the entry
|
|
* @param group the group that owns the entry
|
|
* @param symlink the symlink, or QString()
|
|
* @param pos the position of the file in the directory
|
|
* @param size the size of the file
|
|
*/
|
|
KArchiveFile(KArchive *archive,
|
|
const QString &name,
|
|
int access,
|
|
const QDateTime &date,
|
|
const QString &user,
|
|
const QString &group,
|
|
const QString &symlink,
|
|
qint64 pos,
|
|
qint64 size);
|
|
|
|
/**
|
|
* Destructor. Do not call this, KArchive takes care of it.
|
|
*/
|
|
~KArchiveFile() override;
|
|
|
|
/**
|
|
* Position of the data in the [uncompressed] archive.
|
|
* @return the position of the file
|
|
*/
|
|
qint64 position() const;
|
|
/**
|
|
* Size of the data.
|
|
* @return the size of the file
|
|
*/
|
|
qint64 size() const;
|
|
/**
|
|
* Set size of data, usually after writing the file.
|
|
* @param s the new size of the file
|
|
*/
|
|
void setSize(qint64 s);
|
|
|
|
/**
|
|
* Returns the data of the file.
|
|
* Call data() with care (only once per file), this data isn't cached.
|
|
* @return the content of this file.
|
|
*/
|
|
virtual QByteArray data() const;
|
|
|
|
/**
|
|
* This method returns QIODevice (internal class: KLimitedIODevice)
|
|
* on top of the underlying QIODevice. This is obviously for reading only.
|
|
*
|
|
* WARNING: Note that the ownership of the device is being transferred to the caller,
|
|
* who will have to delete it.
|
|
*
|
|
* The returned device auto-opens (in readonly mode), no need to open it.
|
|
* @return the QIODevice of the file
|
|
*/
|
|
virtual QIODevice *createDevice() const;
|
|
|
|
/**
|
|
* Checks whether this entry is a file.
|
|
* @return true, since this entry is a file
|
|
*/
|
|
bool isFile() const override;
|
|
|
|
/**
|
|
* Extracts the file to the directory @p dest
|
|
* @param dest the directory to extract to
|
|
* @return true on success, false if the file (dest + '/' + name()) couldn't be created
|
|
*/
|
|
bool copyTo(const QString &dest) const;
|
|
|
|
protected:
|
|
void virtual_hook(int id, void *data) override;
|
|
|
|
private:
|
|
KArchiveFilePrivate *const d;
|
|
};
|
|
|
|
#endif
|