OP_OTLLibrary Class Reference

#include <OP_OTLLibrary.h>

Inheritance diagram for OP_OTLLibrary:

FS_IndexFile

List of all members.

Public Types

enum  OP_ModTimeStatus {
  MOD_TIME_OK, MOD_TIME_INTERNAL, MOD_TIME_SAVE_QUIT, MOD_TIME_DISCARD_QUIT,
  MOD_TIME_EMBED, MOD_TIME_REFRESH_ALL, MOD_TIME_LOAD_FILE
}

Public Member Functions

 OP_OTLLibrary ()
 OP_OTLLibrary (FS_Reader *reader)
 OP_OTLLibrary (const char *source, const char *metasrc)
virtual ~OP_OTLLibrary ()
const UT_StringgetMetaSource () const
const UT_StringgetSource () const
OP_ModTimeStatus getSourceModTime (int &mod_time, const char *type_name=NULL) const
bool addDefinition (const OP_OTLDefinition &definition, int modtime=-1)
bool removeDefinition (int index)
int getNumDefinitions () const
int getDefinitionIndex (const char *tablename, const char *opname) const
int getDefinitionModTime (int index) const
const UT_StringgetDefinitionName (int index) const
const UT_StringgetDefinitionOpTableName (int index) const
bool getDefinitionIsDummy (int index) const
bool getDefinition (int index, OP_OTLDefinition &definition) const
FS_IndexFilegetDefinitionIndexFile (const char *tablename, const char *opname) const
void mergeLibrary (const OP_OTLLibrary &lib)
virtual bool expandToDirectory (const char *destdir)
virtual bool collapseFromDirectory (const char *srcdir)
virtual void writeFile (ostream &os)
void setIsBeingRefreshed (bool beingrefreshed)
bool getIsBeingRefreshed () const
bool getIsModTimeAccessOK () const

Static Public Member Functions

static bool forceOTLExtension (UT_String &filename)
static void getVexAndVflSectionNames (const char *suggestion, UT_String &vexsect, UT_String &vflsect)
static bool createBackupFile (const char *filename)
static bool isReservedSectionName (const char *sectname)
static const char * getEventName (int index)
static const char * getEventSectionName (int index)
static const char * getVexCodeSectionName (VEX_ContextType type)
static const char * getVflCodeSectionName (VEX_ContextType type)


Detailed Description

Definition at line 111 of file OP_OTLLibrary.h.


Member Enumeration Documentation

Enumerator:
MOD_TIME_OK 
MOD_TIME_INTERNAL 
MOD_TIME_SAVE_QUIT 
MOD_TIME_DISCARD_QUIT 
MOD_TIME_EMBED 
MOD_TIME_REFRESH_ALL 
MOD_TIME_LOAD_FILE 

Definition at line 122 of file OP_OTLLibrary.h.


Constructor & Destructor Documentation

OP_OTLLibrary::OP_OTLLibrary (  ) 

OP_OTLLibrary::OP_OTLLibrary ( FS_Reader reader  ) 

OP_OTLLibrary::OP_OTLLibrary ( const char *  source,
const char *  metasrc 
)

virtual OP_OTLLibrary::~OP_OTLLibrary (  )  [virtual]


Member Function Documentation

bool OP_OTLLibrary::addDefinition ( const OP_OTLDefinition definition,
int  modtime = -1 
)

virtual bool OP_OTLLibrary::collapseFromDirectory ( const char *  srcdir  )  [virtual]

Reimplemented from FS_IndexFile.

static bool OP_OTLLibrary::createBackupFile ( const char *  filename  )  [static]

virtual bool OP_OTLLibrary::expandToDirectory ( const char *  destdir  )  [virtual]

Reimplemented from FS_IndexFile.

static bool OP_OTLLibrary::forceOTLExtension ( UT_String filename  )  [static]

Checks if filename has a .otl, if not, appends it. Respects OTL_INTERNAL and other magic constants. Returns true if filename was modified

bool OP_OTLLibrary::getDefinition ( int  index,
OP_OTLDefinition definition 
) const

int OP_OTLLibrary::getDefinitionIndex ( const char *  tablename,
const char *  opname 
) const

FS_IndexFile* OP_OTLLibrary::getDefinitionIndexFile ( const char *  tablename,
const char *  opname 
) const

bool OP_OTLLibrary::getDefinitionIsDummy ( int  index  )  const

int OP_OTLLibrary::getDefinitionModTime ( int  index  )  const

const UT_String& OP_OTLLibrary::getDefinitionName ( int  index  )  const

const UT_String& OP_OTLLibrary::getDefinitionOpTableName ( int  index  )  const

static const char* OP_OTLLibrary::getEventName ( int  index  )  [static]

static const char* OP_OTLLibrary::getEventSectionName ( int  index  )  [static]

bool OP_OTLLibrary::getIsBeingRefreshed (  )  const

bool OP_OTLLibrary::getIsModTimeAccessOK (  )  const

const UT_String& OP_OTLLibrary::getMetaSource (  )  const

int OP_OTLLibrary::getNumDefinitions (  )  const

const UT_String& OP_OTLLibrary::getSource (  )  const

OP_ModTimeStatus OP_OTLLibrary::getSourceModTime ( int &  mod_time,
const char *  type_name = NULL 
) const

static void OP_OTLLibrary::getVexAndVflSectionNames ( const char *  suggestion,
UT_String vexsect,
UT_String vflsect 
) [static]

Constructs a good vfl and vex code section names given the original suggestion.

static const char* OP_OTLLibrary::getVexCodeSectionName ( VEX_ContextType  type  )  [static]

static const char* OP_OTLLibrary::getVflCodeSectionName ( VEX_ContextType  type  )  [static]

static bool OP_OTLLibrary::isReservedSectionName ( const char *  sectname  )  [static]

void OP_OTLLibrary::mergeLibrary ( const OP_OTLLibrary lib  ) 

bool OP_OTLLibrary::removeDefinition ( int  index  ) 

void OP_OTLLibrary::setIsBeingRefreshed ( bool  beingrefreshed  ) 

virtual void OP_OTLLibrary::writeFile ( ostream &  os  )  [virtual]

Reimplemented from FS_IndexFile.


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

Generated on Thu Jan 31 00:31:44 2013 for HDK by  doxygen 1.5.9