#include <FS_IndexFile.h>
|
| FS_IndexFile () |
| Default constructor. More...
|
|
| FS_IndexFile (const char *source) |
|
| FS_IndexFile (FS_Reader *reader, const char *source=nullptr) |
|
virtual | ~FS_IndexFile () |
|
bool | hasSection (const UT_StringRef §ion) const |
|
bool | hasTempSection (const UT_StringRef §ion) const |
|
bool | hasRegularSection (const UT_StringRef §ion) const |
|
int | getSectionModTime (const UT_StringRef §ion) const |
|
int | getSectionDataSize (const UT_StringRef §ion) const |
|
bool | readSection (const UT_StringRef §ion, char *buffer) const |
|
bool | readSection (const UT_StringRef §ion, UT_WorkBuffer &buffer) const |
|
bool | readOptionsSection (const UT_StringRef §ion, UT_Options &options) const |
|
void | addSection (const UT_StringRef §ion, const char *filename) |
|
void | addSection (const UT_StringRef §ion, const UT_WorkBuffer &buf, int modtime=-1) |
|
void | addSection (const UT_StringRef §ion, const char *buffer, int len, int modtime=-1) |
|
void | addSection (const UT_StringRef §ion, const FS_IndexFile &file) |
|
void | modifySection (const UT_StringRef §ion, const char *buffer, int len, int modtime=-1) |
|
void | modifySection (const UT_StringRef §ion, const UT_WorkBuffer &buf, int modtime=-1) |
|
void | removeSection (const UT_StringRef §ion) |
|
void | mergeIndexFile (const FS_IndexFile &file, bool overwrite) |
|
void | moveSections (int first, int last, int offset) |
|
int | getModTime () const |
|
int64 | getFileDataSize () const |
|
void | setFilters (FS_WriteFilterFactory *encrypt_factory, FS_IStreamFilterFactory *decrypt_factory) |
|
FS_WriteFilterFactory * | getEncryptionFilter () const |
|
FS_IStreamFilterFactory * | getDecryptionFilter () const |
|
FS_Section * | getSection (const UT_StringRef §ion) const |
|
FS_Reader * | getSectionReader (const UT_StringRef §ion) const |
|
FS_ReaderStream * | getSectionStream (const UT_StringRef §ion) const |
|
FS_ReaderStream * | getStreamCopy () const |
|
FS_IndexFileHandle | getIndexFileFromSection (const UT_StringRef §ion, const char *source=nullptr) const |
|
int | getNumSections () const |
|
const UT_StringHolder & | getSectionName (int index) const |
|
const UT_StringHolder & | getSourceFile () const |
|
const UT_StringHolder & | getDescription () const |
|
void | setDescription (const UT_StringHolder &description) |
|
exint | guessStreamSize () const |
|
virtual void | writeFile (std::ostream &os) const |
|
virtual bool | expandToDirectory (const char *destdir) |
|
virtual bool | collapseFromDirectory (const char *srcdir) |
|
bool | isCopyProtected () const |
| Tests if the index file is copy-protected. More...
|
|
bool | isBlackBoxed () const |
| Tests if the index file is black boxed. More...
|
|
bool | isExpanded () const |
| Tests if the index file is stored as expanded. More...
|
|
bool | getSectionFileName (const char *section, UT_String &filename) |
|
Definition at line 41 of file FS_IndexFile.h.
FS_IndexFile::FS_IndexFile |
( |
| ) |
|
FS_IndexFile::FS_IndexFile |
( |
const char * |
source | ) |
|
This constructor takes a path of some sort (e.g. a file path, an oplib: path, an opdef: path, an http:// path, etc) to the index file.
FS_IndexFile::FS_IndexFile |
( |
FS_Reader * |
reader, |
|
|
const char * |
source = nullptr |
|
) |
| |
This constructor takes a reader that will be used to retrieve section data. The index file takes ownership and will delete the reader in the destructor. (If null is passed in, this object creates its own default FS_Reader, but unless a source is given nothing can be read from such an index file.)
If no source is given, closing the index file and reopening it again will have no effect on the underlying reader. The reader will only be closed and deleted when the index file object is deleted. If a source is passed in, though, the reader will be deleted when the index file is closed and subsequent openings will use the source path to construct a new reader.
virtual FS_IndexFile::~FS_IndexFile |
( |
| ) |
|
|
virtual |
static bool FS_IndexFile::canWriteFile |
( |
const char * |
filename | ) |
|
|
static |
virtual bool FS_IndexFile::collapseFromDirectory |
( |
const char * |
srcdir | ) |
|
|
virtual |
virtual bool FS_IndexFile::expandToDirectory |
( |
const char * |
destdir | ) |
|
|
virtual |
static int FS_IndexFile::getCurrentTime |
( |
| ) |
|
|
static |
int64 FS_IndexFile::getFileDataSize |
( |
| ) |
const |
int FS_IndexFile::getModTime |
( |
| ) |
const |
int FS_IndexFile::getNumSections |
( |
| ) |
const |
bool FS_IndexFile::getSectionFileName |
( |
const char * |
section, |
|
|
UT_String & |
filename |
|
) |
| |
exint FS_IndexFile::guessStreamSize |
( |
| ) |
const |
bool FS_IndexFile::isBlackBoxed |
( |
| ) |
const |
Tests if the index file is black boxed.
bool FS_IndexFile::isCopyProtected |
( |
| ) |
const |
Tests if the index file is copy-protected.
bool FS_IndexFile::isExpanded |
( |
| ) |
const |
|
inline |
Tests if the index file is stored as expanded.
Definition at line 176 of file FS_IndexFile.h.
void FS_IndexFile::moveSections |
( |
int |
first, |
|
|
int |
last, |
|
|
int |
offset |
|
) |
| |
void FS_IndexFile::setModified |
( |
| ) |
|
|
inlineprotected |
virtual void FS_IndexFile::writeFile |
( |
std::ostream & |
os | ) |
const |
|
virtual |
exint FS_IndexFile::writeHeader |
( |
std::ostream & |
os | ) |
const |
|
protected |
friend class FS_DiskSection |
|
friend |
friend class FS_EmbeddedSection |
|
friend |
The documentation for this class was generated from the following file: