Inherits DD::Image::ReaderDescription.
Public Types | |
typedef Reader *(* | ReaderConstructor) (Read *, int fd, const unsigned char *buf, int bufsize) |
typedef ReaderFormat *(* | ReaderFormatConstructor) (Read *) |
typedef bool(* | Tester) (int fd, const unsigned char *buf, int bufsize) |
Public Types inherited from DD::Image::Description | |
typedef Node *(* | NodeBuilder) (void *) |
typedef std::vector< Description * > | DescriptionList |
Public Member Functions | |
Description (const char *n, const char *l, ReaderConstructor c, Tester t=nullptr, License *f=nullptr) | |
Description (const char *n, const char *l, ReaderConstructor c, Tester t, ReaderFormatConstructor format, License *f=nullptr) | |
Description (const char *n, ReaderConstructor c, Tester t=nullptr, License *f=nullptr) | |
Description (const char *n, ReaderConstructor c, Tester t, ReaderFormatConstructor format, License *f=nullptr) | |
Public Member Functions inherited from DD::Image::ReaderDescription | |
ReaderDescription (const char *n, const char *l) | |
Static Public Member Functions | |
static const Description * | find (int i) |
static const Description * | find (const char *name) |
Static Public Member Functions inherited from DD::Image::ReaderDescription | |
static const Description * | find (const DescriptionList &list, const char *name, const char *pluginSuffix, const char *&triedPlugin) |
Public Attributes | |
ReaderConstructor | constructor |
ReaderFormatConstructor | format_constructor |
Tester | test |
Public Attributes inherited from DD::Image::ReaderDescription | |
const char * | names |
const char * | label |
Public Attributes inherited from DD::Image::Description | |
const char * | compiled |
const char * | plugin |
License * | license |
Additional Inherited Members | |
Protected Member Functions inherited from DD::Image::Description | |
void | ctor (void(*f)(Description *)) |
void | ctor (void(*f)(Description *), NodeBuilder nodeBuilder) |
This structure describes a subclass of Reader. The constructor builds these into a list that Read operators search to find a way to read a filename given to them.
Sample code for a plugin that defines a Reader:
typedef Reader*(* DD::Image::Reader::Description::ReaderConstructor) (Read *, int fd, const unsigned char *buf, int bufsize) |
Make an instance of the reader.
If test is not null then fd is an opened file, it is seeked to bufsize, and buf contains the first bufsize bytes of the file. You can use this data to store stuff into the info_ (however you cannot report error messages and filename() does not work yet).
typedef bool(* DD::Image::Reader::Description::Tester) (int fd, const unsigned char *buf, int bufsize) |
If this pointer is non-null, it indicates a named Unix file is used to store the image. In this case Read will open the file and call this function. If it returns non-zero then the constructor will be called. This allows Read to poll all the Readers to see which one can read an unknown file format.
If this is null then zero is passed as the fd to the constructors.
buf points at the first bufsize characters of the file. bufsize is at least 512. If necessary you can mess with the fd, but be sure to seek it back to bufsize.
|
inline |
Constructor that fills all fields and allows a license check.
|
inline |
Constructor that fills all fields and allows a license check.
|
inline |
Simpler constructor that sets names and label to same value.
|
inline |
Constructor that fills all fields and allows a license check.
|
static |
Return the i'th Description known about, or return a null pointer for the last one.
|
static |
Search all the defined Descriptions for one whose name matches the passed string, or return NULL if none. This will also try to plugin_load("xyzReader") (where xyz is id) in order to find external file reader code.
References DD::Image::plugin_load().
©2021 The Foundry Visionmongers, Ltd. All Rights Reserved. |