Mkd64 module API  1.3b
API for creating own mkd64 modules
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
Mkd64 Class Reference

Class representing the mkd64 application. More...

#include <mkd64/mkd64.h>

Related Functions

(Note that these are not member functions.)

ModRepoMkd64_modRepo (Mkd64 *self)
 Get the current module repository.
void Mkd64_suggestOption (Mkd64 *self, IModule *mod, int fileNo, char opt, const char *arg, const char *reason)
 Suggest a better option to the user.
Mkd64Mkd64_instance (void)
 Get the current instance of mkd64.
#define MKD64
 Convencience macro for getting the current mkd64 instance.

Detailed Description

Class representing the mkd64 application.

This is a singleton allowing only one instance at a time.

Friends And Related Function Documentation

Mkd64 * Mkd64_instance ( void  )
related

Get the current instance of mkd64.

Returns
the mkd64 instance or 0 if no instance was created
ModRepo * Mkd64_modRepo ( Mkd64 self)
related

Get the current module repository.

Parameters
selfthe Mkd64 instance
Returns
the module repository instance in use
void Mkd64_suggestOption ( Mkd64 self,
IModule mod,
int  fileNo,
char  opt,
const char *  arg,
const char *  reason 
)
related

Suggest a better option to the user.

Call this from a module if you found a situation where specifying different options would have resulted in a "better" image (e.g. less fragmentation).

Parameters
selfthe Mkd64 instance
modthe module suggesting the option
fileNothe number of the concerned file, or 0 if it is a global option
optthe option suggested to use
argthe option argument suggested to use (may be 0).
reasona brief explanation why this is suggested.

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