iflDatabase(3) Image Format Library C++ Reference Manual iflDatabase(3)NAMEiflDatabase - access to image file format database
INHERITS FROM
This is a base class with no inheritance.
HEADER FILE
#include <il/ilCdefs.h>
CLASS DESCRIPTIONiflDatabase is a lightweight version of the iflFormat class, with
abbreviated functionality. Basically, the information here is what can
be obtained from variables in the file format database without opening
the specific DSO. Looking up an object of this class will never cause a
DSO to be opened. The intended use is by apps who know they only need
the restricted methods provided here.
Refer to the iflFormat(3) man page for more detail on iflFormat
functionality.
CLASS MEMBER FUNCTION SUMMARY
Format lookup
static iflDatabase* iflDatabaseFindNext(iflDatabase *obj,
int* index)
static iflDatabase* iflDatabaseFindByMagic(iflDatabase *obj,
int fd)
static iflDatabase* iflDatabaseFindByFormatName(iflDatabase *obj,
const char* formatName)
static iflDatabase* iflDatabaseFindByFileName(iflDatabase *obj,
const char* fileName,
int noMatchRule)
Attribute queries
const char* iflDatabaseGetName(iflDatabase *obj)
const char* iflDatabaseGetDefaultSuffix(iflDatabase *obj)
const char* iflDatabaseGetDescription(iflDatabase *obj)
int iflDatabaseAccessModeIsSupported(iflDatabase *obj,
int mode)
const char* iflDatabaseGetDSOName(iflDatabase *obj)
const char* iflDatabaseGetInstSubSystem(iflDatabase *obj)
Conversion to iflFormat
iflFormat* iflDatabaseGetFormat(iflDatabase *obj, int openDSOifNecessary)
Page 1
iflDatabase(3) Image Format Library C++ Reference Manual iflDatabase(3)FUNCTION DESCRIPTIONSaccessModeIsSupported()
int iflDatabaseAccessModeIsSupported(iflDatabase *obj,
int mode)
This member function tells whether the given access mode (which must
be one of O_RDONLY, O_WRONLY, or O_RDWR) is supported by the
subclass.
findByFileName()
static iflDatabase* iflDatabaseFindByFileName(iflDatabase *obj,
const char* fileName,
int noMatchRule)
This static class member function is used to look up an image file
format by file name, where the file name is given by the fileName
argument. This is accomplished by matching the tail end of fileName
against each value of the suffixes variable given for each image
file format in the FTR database. The noMatchRule argument can be
used to limit searching to those formats that have no match rule.
findByFormatName()
static iflDatabase* iflDatabaseFindByFormatName(iflDatabase *obj,
const char* formatName)
This static class member function is used to look up an image file
format by name, where the name is given by the formatName argument.
findByMagic()
static iflDatabase* iflDatabaseFindByMagic(iflDatabase *obj,
int fd)
This static class member function is used to look up an image file
format by magic number of a given file that is open for reading with
the file descriptor, fd.
findNext()
static iflDatabase* iflDatabaseFindNext(iflDatabase *obj,
int* index)
Page 2
iflDatabase(3) Image Format Library C++ Reference Manual iflDatabase(3)
This static class member function is used to step through the
(static, lazily created) list of supported file formats.
To start searching initialize the index paramter to zero. It will be
automatically updated by each call so that successive calls will iterate
through all available formats. If there are no more formats, the
function returns NULL.
The following example prints the names of all supported formats:
iflDatabase *db;
int index = 0;
while ((db = iflDatabase::findNext(index)) != NULL)
printf("%s0, db->getName());
getDSOName()
const char* iflDatabaseGetDSOName(iflDatabase *obj)
This member function returns the 'soname' for the DSO that
implements this format (used internally to pass to dlopen()).
getDefaultSuffix()
const char* iflDatabaseGetDefaultSuffix(iflDatabase *obj)
This member function returns the default filename suffix (the first
suffix listed in the "suffixes" declaration for a format in the IFL
format database). The returned value is a pointer to a static string
that is valid forever. Note that the returned value may be NULL.
getDescription()
const char* iflDatabaseGetDescription(iflDatabase *obj)
This member function returns the format description, or NULL if
there is none.
getFormat()
iflFormat* iflDatabaseGetFormat(iflDatabase *obj, int openDSOifNecessary)
This method returns the full iflFormat correspnding to this
iflDatabase object. This may involve some overhead the first time a
particular format is accessed (opening the DSO and such).
Page 3
iflDatabase(3) Image Format Library C++ Reference Manual iflDatabase(3)getInstSubSystem()
const char* iflDatabaseGetInstSubSystem(iflDatabase *obj)
This member function returns the inst sub-system that must be
installed to use this format. This is used internally to format
error messages.
getName()
const char* iflDatabaseGetName(iflDatabase *obj)
This member function returns the format name, which is a pointer to
a static string that is valid forever.
SEE ALSO
iflFormat
Page 4
