SISFile Class Reference

The top level container of a SIS file. More...

#include <sisfile.h>

Collaboration diagram for SISFile:

Public Member Functions
	SISFile ()
virtual	~SISFile ()
SisRC	compareApp (SISFile *other)
	Compare uid and version number of this file, with another. More...
SisRC	fillFrom (uint8_t *buf, off_t len)
	Populate the fields. More...
int	getLanguage ()
	Return the currently selected installation language. More...
LangTableEntry *	getLanguage (int i)
	Find a language entry, based on the sequence number in the SISLangRecord part of the file. More...
uint8_t *	getName ()
	Get the name of this component, in the selected language. More...
uint32_t	getResidualEnd ()
	Get the number of bytes that should be copied to the residual sis file on the psion. More...
void	ownBuffer ()
bool	sameApp (SISFile *other)
	Is this the same application? More...
void	setDrive (char drive)
	Set the installed drive. More...
void	setFiles (int nFiles)
	Set the number of installed files. More...
void	setLanguage (int lang)
	Set the selected installation language. More...

Public Attributes
SISFileHeader	m_header
SISLangRecord *	m_langRecords
SISFileRecord *	m_fileRecords
SISReqRecord *	m_reqRecords

Private Member Functions
void	updateEnd (uint32_t pos)

Private Attributes
SISComponentNameRecord	m_componentRecord
bool	m_ownBuffer
uint8_t *	m_buf
uint32_t	m_end

Detailed Description

The top level container of a SIS file.

Based on documentation by Alexander Thoukydides alex@.nosp@m.thou.nosp@m.ky.co.nosp@m..uk.

Definition at line 35 of file sisfile.h.

Constructor & Destructor Documentation

SISFile()

SISFile::SISFile

(

)

Definition at line 29 of file sisfile.cpp.

~SISFile()

SISFile::~SISFile ( )

virtual

Definition at line 35 of file sisfile.cpp.

Member Function Documentation

compareApp()

SisRC SISFile::compareApp

(

SISFile *

other

)

Compare uid and version number of this file, with another.

See also

SISFileHeader::compareApp()

Definition at line 42 of file sisfile.cpp.

fillFrom()

SisRC SISFile::fillFrom	(	uint8_t *	buf,
		off_t	len
	)

Populate the fields.

Parameters

buf	The buffer to read from.
len	The length of the buffer.

Definition at line 48 of file sisfile.cpp.

getLanguage() [1/2]

int SISFile::getLanguage

(

)

Return the currently selected installation language.

Definition at line 137 of file sisfile.cpp.

getLanguage() [2/2]

LangTableEntry * SISFile::getLanguage

(

int

i

)

Find a language entry, based on the sequence number in the SISLangRecord part of the file.

Definition at line 143 of file sisfile.cpp.

getName()

uint8_t * SISFile::getName

(

)

Get the name of this component, in the selected language.

Definition at line 149 of file sisfile.cpp.

getResidualEnd()

uint32_t SISFile::getResidualEnd ( )

inline

Get the number of bytes that should be copied to the residual sis file on the psion.

Definition at line 78 of file sisfile.h.

ownBuffer()

void SISFile::ownBuffer ( )

inline

Definition at line 83 of file sisfile.h.

sameApp()

bool SISFile::sameApp

(

SISFile *

other

)

Is this the same application?

setDrive()

void SISFile::setDrive

(

char

drive

)

Set the installed drive.

Definition at line 155 of file sisfile.cpp.

setFiles()

void SISFile::setFiles

(

int

nFiles

)

Set the number of installed files.

Definition at line 161 of file sisfile.cpp.

setLanguage()

void SISFile::setLanguage

(

int

lang

)

Set the selected installation language.

Definition at line 167 of file sisfile.cpp.

updateEnd()

void SISFile::updateEnd ( uint32_t  pos )

private

Definition at line 173 of file sisfile.cpp.

Member Data Documentation

m_buf

uint8_t* SISFile::m_buf

private

Definition at line 119 of file sisfile.h.

m_componentRecord

SISComponentNameRecord SISFile::m_componentRecord

private

Definition at line 115 of file sisfile.h.

m_end

uint32_t SISFile::m_end

private

Definition at line 121 of file sisfile.h.

m_fileRecords

SISFileRecord* SISFile::m_fileRecords

Definition at line 110 of file sisfile.h.

m_header

SISFileHeader SISFile::m_header

Definition at line 108 of file sisfile.h.

m_langRecords

SISLangRecord* SISFile::m_langRecords

Definition at line 109 of file sisfile.h.

m_ownBuffer

bool SISFile::m_ownBuffer

private

Definition at line 117 of file sisfile.h.

m_reqRecords

SISReqRecord* SISFile::m_reqRecords

Definition at line 111 of file sisfile.h.

---

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

• lib/sisfile.h
• lib/sisfile.cpp