KAr

#include <KAr>

Inheritance diagram for KAr:

Public Member Functions
	KAr (const QString &filename)

	KAr (QIODevice *dev)

	~KAr () override

Public Member Functions inherited from KArchive
bool	addLocalDirectory (const QString &path, const QString &destName)

bool	addLocalFile (const QString &fileName, const QString &destName)

virtual bool	close ()

QIODevice *	device () const

const KArchiveDirectory *	directory () const

QString	errorString () const

QString	fileName () const

bool	finishWriting (qint64 size)

bool	isOpen () const

QIODevice::OpenMode	mode () const

virtual bool	open (QIODevice::OpenMode mode)

bool	prepareWriting (const QString &name, const QString &user, const QString &group, qint64 size, mode_t perm=0100644, const QDateTime &atime=QDateTime(), const QDateTime &mtime=QDateTime(), const QDateTime &ctime=QDateTime())

bool	writeData (const char *data, qint64 size)

bool	writeData (QByteArrayView data)

bool	writeDir (const QString &name, const QString &user=QString(), const QString &group=QString(), mode_t perm=040755, const QDateTime &atime=QDateTime(), const QDateTime &mtime=QDateTime(), const QDateTime &ctime=QDateTime())

bool	writeFile (const QString &name, QByteArrayView data, mode_t perm=0100644, const QString &user=QString(), const QString &group=QString(), const QDateTime &atime=QDateTime(), const QDateTime &mtime=QDateTime(), const QDateTime &ctime=QDateTime())

bool	writeSymLink (const QString &name, const QString &target, const QString &user=QString(), const QString &group=QString(), mode_t perm=0120755, const QDateTime &atime=QDateTime(), const QDateTime &mtime=QDateTime(), const QDateTime &ctime=QDateTime())

Protected Member Functions
bool	closeArchive () override

bool	doFinishWriting (qint64 size) override

bool	doPrepareWriting (const QString &name, const QString &user, const QString &group, qint64 size, mode_t perm, const QDateTime &atime, const QDateTime &mtime, const QDateTime &ctime) override

bool	doWriteDir (const QString &name, const QString &user, const QString &group, mode_t perm, const QDateTime &atime, const QDateTime &mtime, const QDateTime &ctime) override

bool	doWriteSymLink (const QString &name, const QString &target, const QString &user, const QString &group, mode_t perm, const QDateTime &atime, const QDateTime &mtime, const QDateTime &ctime) override

bool	openArchive (QIODevice::OpenMode mode) override

void	virtual_hook (int id, void *data) override

Protected Member Functions inherited from KArchive
	KArchive (const QString &fileName)

	KArchive (QIODevice *dev)

virtual bool	createDevice (QIODevice::OpenMode mode)

virtual bool	doWriteData (const char *data, qint64 size)

KArchiveDirectory *	findOrCreate (const QString &path)

virtual KArchiveDirectory *	rootDir ()

void	setDevice (QIODevice *dev)

void	setErrorString (const QString &errorStr)

void	setRootDir (KArchiveDirectory *rootDir)

Detailed Description

KAr is a class for reading archives in ar format.

Writing is not supported. Reading archives that contain files bigger than INT_MAX - 32 bytes is not supported.

A class for reading ar archives.

Author: Laurence Anderson l.d.a.nosp@m.nder.nosp@m.son@w.nosp@m.arwi.nosp@m.ck.ac.nosp@m..uk

Definition at line 20 of file kar.h.

Constructor & Destructor Documentation

◆ KAr() [1/2]

KAr::KAr ( const QString & filename )

explicit

Creates an instance that operates on the given filename.

Parameters

filename is a local path (e.g. "/home/holger/myfile.ar")

Definition at line 34 of file kar.cpp.

◆ KAr() [2/2]

KAr::KAr ( QIODevice * dev )

explicit

Creates an instance that operates on the given device.

The device can be compressed (KCompressionDevice) or not (QFile, etc.).

Parameters

dev	the device to read from

Definition at line 40 of file kar.cpp.

◆ ~KAr()

KAr::~KAr ( )

override

If the ar file is still opened, then it will be closed automatically by the destructor.

Definition at line 46 of file kar.cpp.

Member Function Documentation

◆ closeArchive()

bool KAr::closeArchive ( )

overrideprotectedvirtual

Closes the archive.

Called by close.

Implements KArchive.

Definition at line 186 of file kar.cpp.

◆ doFinishWriting()

bool KAr::doFinishWriting ( qint64 size )

overrideprotectedvirtual

Called after writing the data.

This virtual method must be implemented by subclasses.

Parameters

size	the size of the file

See also: finishWriting()

Implements KArchive.

Definition at line 61 of file kar.cpp.

◆ doPrepareWriting()

bool KAr::doPrepareWriting	(	const QString &	name,
		const QString &	user,
		const QString &	group,
		qint64	size,
		mode_t	perm,
		const QDateTime &	atime,
		const QDateTime &	mtime,
		const QDateTime &	ctime )

overrideprotectedvirtual

This virtual method must be implemented by subclasses.

Depending on the archive type not all metadata might be used.

Parameters

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

Implements KArchive.

Definition at line 54 of file kar.cpp.

◆ doWriteDir()

bool KAr::doWriteDir	(	const QString &	name,
		const QString &	user,
		const QString &	group,
		mode_t	perm,
		const QDateTime &	atime,
		const QDateTime &	mtime,
		const QDateTime &	ctime )

overrideprotectedvirtual

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.

Parameters

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

Implements KArchive.

Definition at line 68 of file kar.cpp.

◆ doWriteSymLink()

bool KAr::doWriteSymLink	(	const QString &	name,
		const QString &	target,
		const QString &	user,
		const QString &	group,
		mode_t	perm,
		const QDateTime &	atime,
		const QDateTime &	mtime,
		const QDateTime &	ctime )

overrideprotectedvirtual

Writes a symbolic link to the archive.

This virtual method must be implemented by subclasses.

Parameters

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

Implements KArchive.

Definition at line 75 of file kar.cpp.

◆ openArchive()

bool KAr::openArchive ( QIODevice::OpenMode mode )

overrideprotectedvirtual

Opens the archive for reading.

Parses the directory listing of the archive and creates the KArchiveDirectory/KArchiveFile entries.

Implements KArchive.

Definition at line 82 of file kar.cpp.

◆ virtual_hook()

void KAr::virtual_hook	(	int	id,
		void *	data )

overrideprotectedvirtual

Reimplemented from KArchive.

Definition at line 192 of file kar.cpp.

The documentation for this class was generated from the following files:

KDE's Doxygen guidelines are available online.

Class Picker

Quick Links

About KArchive

KAr

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ KAr() [1/2]

◆ KAr() [2/2]

◆ ~KAr()

Member Function Documentation

◆ closeArchive()

◆ doFinishWriting()

◆ doPrepareWriting()

◆ doWriteDir()

◆ doWriteSymLink()

◆ openArchive()

◆ virtual_hook()