KAr Class Reference

#include <kar.h>

Inheritance diagram for KAr:

Public Member Functions
	KAr (const QString &filename)
	KAr (QIODevice *dev)
virtual	~KAr ()
Public Member Functions inherited from KArchive
virtual	~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	fileName () const
virtual bool	finishWriting (qint64 size)
bool	isOpen () const
QIODevice::OpenMode	mode () const
virtual bool	open (QIODevice::OpenMode mode)
virtual bool	prepareWriting (const QString &name, const QString &user, const QString &group, qint64 size, mode_t perm=0100644, time_t atime=UnknownTime, time_t mtime=UnknownTime, time_t ctime=UnknownTime)
virtual bool	writeData (const char *data, qint64 size)
virtual bool	writeDir (const QString &name, const QString &user, const QString &group, mode_t perm=040755, time_t atime=UnknownTime, time_t mtime=UnknownTime, time_t ctime=UnknownTime)
virtual bool	writeFile (const QString &name, const QString &user, const QString &group, const char *data, qint64 size, mode_t perm=0100644, time_t atime=UnknownTime, time_t mtime=UnknownTime, time_t ctime=UnknownTime)
virtual bool	writeSymLink (const QString &name, const QString &target, const QString &user, const QString &group, mode_t perm=0120755, time_t atime=UnknownTime, time_t mtime=UnknownTime, time_t ctime=UnknownTime)

Protected Member Functions
virtual bool	closeArchive ()
virtual bool	doFinishWriting (qint64 size)
virtual bool	doPrepareWriting (const QString &name, const QString &user, const QString &group, qint64 size, mode_t perm, time_t atime, time_t mtime, time_t ctime)
virtual bool	doWriteDir (const QString &name, const QString &user, const QString &group, mode_t perm, time_t atime, time_t mtime, time_t ctime)
virtual bool	doWriteSymLink (const QString &name, const QString &target, const QString &user, const QString &group, mode_t perm, time_t atime, time_t mtime, time_t ctime)
virtual bool	openArchive (QIODevice::OpenMode mode)
virtual void	virtual_hook (int id, void *data)
Protected Member Functions inherited from KArchive
	KArchive (const QString &fileName)
	KArchive (QIODevice *dev)
virtual bool	createDevice (QIODevice::OpenMode mode)
KArchiveDirectory *	findOrCreate (const QString &path)
virtual KArchiveDirectory *	rootDir ()
void	setDevice (QIODevice *dev)
void	setRootDir (KArchiveDirectory *rootDir)

Additional Inherited Members
Public Types inherited from KArchive
enum	{ UnknownTime = static_cast<time_t>( -1 ) }

Detailed Description

KAr is a class for reading archives in ar format.

Writing 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 29 of file kar.h.

Constructor & Destructor Documentation

KAr::KAr

(

const QString &

filename

)

Creates an instance that operates on the given filename.

Parameters

filename

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

Definition at line 42 of file kar.cpp.

KAr::KAr

(

QIODevice *

dev

)

Creates an instance that operates on the given device.

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

Parameters

dev	the device to read from

Definition at line 47 of file kar.cpp.

KAr::~KAr ( )

virtual

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

Definition at line 52 of file kar.cpp.

Member Function Documentation

bool KAr::closeArchive ( )

protectedvirtual

Closes the archive.

Called by close.

Implements KArchive.

Definition at line 176 of file kar.cpp.

bool KAr::doFinishWriting ( qint64  size )

protectedvirtual

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 65 of file kar.cpp.

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

protectedvirtual

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 59 of file kar.cpp.

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

protectedvirtual

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 70 of file kar.cpp.

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

protectedvirtual

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 76 of file kar.cpp.

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

protectedvirtual

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.

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

protectedvirtual

Reimplemented from KArchive.

Definition at line 182 of file kar.cpp.

---

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

• kar.h
• kar.cpp