OP_OTLManager Class Reference

#include <OP_OTLManager.h>

List of all members.

Public Member Functions
	OP_OTLManager ()
virtual	~OP_OTLManager ()
bool	getSaveToHipFile () const
void	setSaveToHipFile (bool savetohip)
bool	getSaveUnlockedToHipFile () const
void	setSaveUnlockedToHipFile (bool saveunlockedtohip)
bool	getWarnOutOfDateOps () const
void	setWarnOutOfDateOps (bool warn)
bool	getWarnDummyOpsOnLoad () const
void	setWarnDummyOpsOnLoad (bool warn)
bool	getPreferLatestDate () const
void	setPreferLatestDate (bool preferlatest)
bool	getPreferInternal () const
void	setPreferInternal (bool preferinternal)
bool	getPreferIndexFile () const
void	setPreferIndexFile (bool preferindexfile)
bool	getCreateBackups () const
void	setCreateBackups (bool createbackups)
bool	getSafeguardOpDefs () const
void	setSafeguardOpDefs (bool safeguardopdefs)
bool	getLeaveDefaultsUnchanged () const
void	setLeaveDefaultsUnchanged (bool leavedefaultsunchanged)
bool	getUseOplibrariesFiles () const
void	setUseOplibrariesFiles (bool useoplibrariesfiles)
const UT_String &	getOperatorTypeBarMode () const
void	setOperatorTypeBarMode (const char *mode)
const UT_StringArray &	getAllowedOperatorTypeBarModes () const
bool	runOTLCallbacks (const char *otl_name, UT_String &error_out)
UT_StringArray &	getFailedOTLs ()
void	clearFailedOTLList ()
bool	loadOpLibrariesFile (UT_IStream &is, const char *metasrc, int &libpos)
bool	saveInternalMetaFile (ostream &os, const char *prefix=0) const
void	setLibraryPreference (const char *tablename, const char *opname, const char *libfile)
void	setLibraryPreferencesIfRequired (int index)
const char *	getLibraryPreference (const char *tablename, const char *opname) const
void	clearLibraryPreferences (bool refreshlibs)
bool	loadLibraryPreferences (UT_IStream &is)
void	saveLibraryPreferences (ostream &os, bool includeinternal=true, bool protectstrings=false) const
const UT_String &	getMetaSourceName (OP_OTLLibrary *lib, bool withpath=true) const
void	getMetaSourceName (const char *metasrc, UT_String &metasrcname, bool withpath=true) const
bool	setMetaSourceName (const char *metasrc, const char *metasrcname)
bool	getIsPerformingAtomicAddRemove () const
bool	getIsPerformingRefreshAll () const
bool	getIsCreatingNewHDA () const
void	loadAutoOTLs ()
int	findLibrary (const char *libfile, const char *metasrc=0) const
int	findNextLibrary (const char *libfile, int after) const
bool	refreshLibrary (int index, bool force=true)
bool	removeLibrary (const char *libfile, const char *metasrc, bool changeoplibraries)
bool	removeMetaSource (const char *metasrc)
void	refreshAll (bool reloadOpLibraries)
OP_OTLLibrary *	addLibrary (const char *libfile, const char *metasrc, bool changeoplibraries, bool installinternaliffail, UT_WorkBuffer &errors)
int	getNumLibraries () const
int	getPreferredLibrary (const char *tablename, const char *opname)
OP_OTLLibrary *	getLibrary (int index) const
int	getLatestLibrary (const char *tablename, const char *opname, OP_OTLLibrary *tiegoesto=0)
bool	getOutOfDateInternalOps (UT_StringArray &ops)
int	getNextLibrary (const char *tablename, const char *opname, OP_OTLLibrary *startat)
bool	addToLibrary (OP_OTLLibrary *lib, OP_OTLDefinition &definition, FS_IndexFile *deffile, bool dummydefinition=false) const
bool	addToLibrary (const char *libfile, OP_OTLDefinition &definition, FS_IndexFile *deffile, bool dummydefinition=false)
bool	mergeLibraries (const char *primary, const char *secondary)
bool	addToInternalLibrary (OP_OTLLibrary *newlib)
bool	addToInternalLibrary (UT_IStream &is, int modtime)
bool	removeFromLibrary (const char *libfile, const UT_StringArray &ops)
bool	touchDefinition (const char *libfile, const char *tablename, const char *opname, int newtime=-1)
void	modifyDefinitionToInternalPaths (OP_OTLDefinition &def, FS_IndexFile *deffile) const
void	saveOpTypeFromNode (OP_Node *node, UT_String &errors)
void	updateContentsFromNode (FS_IndexFile *deffile, OP_Node *node, bool gzipcontents, bool compilebasic, bool compilevopnets, bool compilechannels, bool compilenodenames, const char *library)
void	updateDefinitionFromNode (FS_IndexFile *deffile, OP_Node *node, bool lockcontents, bool usedsparms, bool gzipcontents, bool savespareparms, bool compile_asset, const char *library)
void	setContentsCompression (FS_IndexFile *deffile, int gzipcontents)
bool	getComment (FS_IndexFile &deffile, UT_String &result)
void	setComment (FS_IndexFile *deffile, const char *comment)
bool	getVersion (FS_IndexFile &deffile, UT_String &result)
void	setVersion (FS_IndexFile *deffile, const char *version)
void	listLibraries (ostream &os) const
void	listLibrariesWithDefinition (const char *tablename, const char *opname, ostream &os) const
void	listOperators (const char *libfile, ostream &os) const
void	listOperator (const char *libfile, const char *tablename, const char *opname, const char *format, ostream &os) const
void	getLibrariesWithDefinition (const char *tablename, const char *opname, UT_PtrArray< OP_OTLLibrary * > &list)
bool	getAllMatchingOperators (const char *opmask, const OP_OTLLibrary *library, bool onlyotlops, UT_StringArray &results, UT_SymbolTable &resultstable) const
void	addManagerSink (OP_OTLManagerSink *sink)
void	removeManagerSink (OP_OTLManagerSink *sink)
bool	checkValidNodeName (const char *name, OP_OperatorTable *table, UT_WorkBuffer &errors)
bool	createOptype (const char *tablename, const char *opname, const char *oplabel, const char *installpath, int min, int max, const char *extradsinfo, const char *installmetasrc, const char *extrainfo, bool subnet, UT_WorkBuffer &errors)
void	fullyQualifyMetaSrcName (const char *libfilebase, UT_String &libfile) const
void	getSimplifiedPath (UT_String &destpath, const char *srcpath, const char *srcmeta) const
bool	canSavePreferences () const
void	pushFallbackLibraryContext ()
void	popFallbackLibraryContext ()
void	saveFallbackLibraryPaths (ostream &os, const OP_OperatorList &ops) const
bool	loadFallbackLibraryPaths (UT_IStream &is)
bool	loadFallbackLibrary (const char *tablename, const char *opname)
void	setDummyDefinition (const OP_OTLDefinition &definition, const FS_IndexFile *deffile)
bool	getDummyDefinition (const OP_Operator *op, FS_IndexFile *deffile) const
bool	loadDummyDefinitions (UT_IStream &is, int modtime)
void	saveDummyDefinitions (ostream &os, const OP_OperatorList &ops) const
void	writeOutDefinitionContents (const OP_OTLDefinition &definition, FS_IndexFile &contents, ostream &os) const
void	setFilters (const OP_OTLDefinition &definition, FS_IndexFile &contents) const
void	refreshLicenses ()
const UT_String &	getInternalTempFile () const
bool	hasNCAsset (const OP_OTLLibrary *lib)
void	getNCAssets (const OP_OTLLibrary *lib, UT_IntArray &nc_assets)
Static Public Member Functions
static void	registerOTLLoadCallback (OP_OTLLoadCallback *cb)
static bool	getHelpTemplateFile (UT_String &helptemplatefile)
static void	createDefaultOptypeName (OP_Node *fromnode, UT_String &name, UT_String &label)
static void	fullyQualifyLibFileName (const char *libfilebase, UT_String &libfile, const char *basedir=0)
static void	saveDefaultDialogScript (ostream &os, const char *opname, const char *oplabel, const char *extradsinfo)
static void	saveDefaultCreationScript (ostream &os, const char *op, const char *table)

---

Detailed Description

Definition at line 50 of file OP_OTLManager.h.

---

Constructor & Destructor Documentation

OP_OTLManager::OP_OTLManager

(

)

virtual OP_OTLManager::~OP_OTLManager

(

)

[virtual]

---

Member Function Documentation

OP_OTLLibrary* OP_OTLManager::addLibrary	(	const char *	libfile,
		const char *	metasrc,
		bool	changeoplibraries,
		bool	installinternaliffail,
		UT_WorkBuffer &	errors
	)

void OP_OTLManager::addManagerSink

(

OP_OTLManagerSink *

sink

)

bool OP_OTLManager::addToInternalLibrary	(	UT_IStream &	is,
		int	modtime
	)

bool OP_OTLManager::addToInternalLibrary

(

OP_OTLLibrary *

newlib

)

bool OP_OTLManager::addToLibrary	(	const char *	libfile,
		OP_OTLDefinition &	definition,
		FS_IndexFile *	deffile,
		bool	dummydefinition = false
	)

bool OP_OTLManager::addToLibrary	(	OP_OTLLibrary *	lib,
		OP_OTLDefinition &	definition,
		FS_IndexFile *	deffile,
		bool	dummydefinition = false
	)			const

bool OP_OTLManager::canSavePreferences

(

)

const

bool OP_OTLManager::checkValidNodeName	(	const char *	name,
		OP_OperatorTable *	table,
		UT_WorkBuffer &	errors
	)

void OP_OTLManager::clearFailedOTLList

(

)

void OP_OTLManager::clearLibraryPreferences

(

bool

refreshlibs

)

static void OP_OTLManager::createDefaultOptypeName	(	OP_Node *	fromnode,
		UT_String &	name,
		UT_String &	label
	)			[static]

bool OP_OTLManager::createOptype	(	const char *	tablename,
		const char *	opname,
		const char *	oplabel,
		const char *	installpath,
		int	min,
		int	max,
		const char *	extradsinfo,
		const char *	installmetasrc,
		const char *	extrainfo,
		bool	subnet,
		UT_WorkBuffer &	errors
	)

int OP_OTLManager::findLibrary	(	const char *	libfile,
		const char *	metasrc = 0
	)			const

int OP_OTLManager::findNextLibrary	(	const char *	libfile,
		int	after
	)			const

static void OP_OTLManager::fullyQualifyLibFileName	(	const char *	libfilebase,
		UT_String &	libfile,
		const char *	basedir = 0
	)			[static]

void OP_OTLManager::fullyQualifyMetaSrcName	(	const char *	libfilebase,
		UT_String &	libfile
	)			const

bool OP_OTLManager::getAllMatchingOperators	(	const char *	opmask,
		const OP_OTLLibrary *	library,
		bool	onlyotlops,
		UT_StringArray &	results,
		UT_SymbolTable &	resultstable
	)			const

const UT_StringArray& OP_OTLManager::getAllowedOperatorTypeBarModes

(

)

const

bool OP_OTLManager::getComment	(	FS_IndexFile &	deffile,
		UT_String &	result
	)

bool OP_OTLManager::getCreateBackups

(

)

const

bool OP_OTLManager::getDummyDefinition	(	const OP_Operator *	op,
		FS_IndexFile *	deffile
	)			const

UT_StringArray& OP_OTLManager::getFailedOTLs

(

)

static bool OP_OTLManager::getHelpTemplateFile

(

UT_String &

helptemplatefile

)

[static]

const UT_String& OP_OTLManager::getInternalTempFile

(

)

const

bool OP_OTLManager::getIsCreatingNewHDA

(

)

const

bool OP_OTLManager::getIsPerformingAtomicAddRemove

(

)

const

bool OP_OTLManager::getIsPerformingRefreshAll

(

)

const

int OP_OTLManager::getLatestLibrary	(	const char *	tablename,
		const char *	opname,
		OP_OTLLibrary *	tiegoesto = 0
	)

bool OP_OTLManager::getLeaveDefaultsUnchanged

(

)

const

void OP_OTLManager::getLibrariesWithDefinition	(	const char *	tablename,
		const char *	opname,
		UT_PtrArray< OP_OTLLibrary * > &	list
	)

OP_OTLLibrary* OP_OTLManager::getLibrary

(

int

index

)

const

const char* OP_OTLManager::getLibraryPreference	(	const char *	tablename,
		const char *	opname
	)			const

void OP_OTLManager::getMetaSourceName	(	const char *	metasrc,
		UT_String &	metasrcname,
		bool	withpath = true
	)			const

const UT_String& OP_OTLManager::getMetaSourceName	(	OP_OTLLibrary *	lib,
		bool	withpath = true
	)			const

void OP_OTLManager::getNCAssets	(	const OP_OTLLibrary *	lib,
		UT_IntArray &	nc_assets
	)

int OP_OTLManager::getNextLibrary	(	const char *	tablename,
		const char *	opname,
		OP_OTLLibrary *	startat
	)

int OP_OTLManager::getNumLibraries

(

)

const

const UT_String& OP_OTLManager::getOperatorTypeBarMode

(

)

const

bool OP_OTLManager::getOutOfDateInternalOps

(

UT_StringArray &

ops

)

bool OP_OTLManager::getPreferIndexFile

(

)

const

bool OP_OTLManager::getPreferInternal

(

)

const

bool OP_OTLManager::getPreferLatestDate

(

)

const

int OP_OTLManager::getPreferredLibrary	(	const char *	tablename,
		const char *	opname
	)

bool OP_OTLManager::getSafeguardOpDefs

(

)

const

bool OP_OTLManager::getSaveToHipFile

(

)

const

bool OP_OTLManager::getSaveUnlockedToHipFile

(

)

const

void OP_OTLManager::getSimplifiedPath	(	UT_String &	destpath,
		const char *	srcpath,
		const char *	srcmeta
	)			const

bool OP_OTLManager::getUseOplibrariesFiles

(

)

const

bool OP_OTLManager::getVersion	(	FS_IndexFile &	deffile,
		UT_String &	result
	)

bool OP_OTLManager::getWarnDummyOpsOnLoad

(

)

const

bool OP_OTLManager::getWarnOutOfDateOps

(

)

const

bool OP_OTLManager::hasNCAsset

(

const OP_OTLLibrary *

lib

)

void OP_OTLManager::listLibraries

(

ostream &

os

)

const

void OP_OTLManager::listLibrariesWithDefinition	(	const char *	tablename,
		const char *	opname,
		ostream &	os
	)			const

void OP_OTLManager::listOperator	(	const char *	libfile,
		const char *	tablename,
		const char *	opname,
		const char *	format,
		ostream &	os
	)			const

void OP_OTLManager::listOperators	(	const char *	libfile,
		ostream &	os
	)			const

void OP_OTLManager::loadAutoOTLs

(

)

bool OP_OTLManager::loadDummyDefinitions	(	UT_IStream &	is,
		int	modtime
	)

bool OP_OTLManager::loadFallbackLibrary	(	const char *	tablename,
		const char *	opname
	)

bool OP_OTLManager::loadFallbackLibraryPaths

(

UT_IStream &

is

)

bool OP_OTLManager::loadLibraryPreferences

(

UT_IStream &

is

)

bool OP_OTLManager::loadOpLibrariesFile	(	UT_IStream &	is,
		const char *	metasrc,
		int &	libpos
	)

bool OP_OTLManager::mergeLibraries	(	const char *	primary,
		const char *	secondary
	)

void OP_OTLManager::modifyDefinitionToInternalPaths	(	OP_OTLDefinition &	def,
		FS_IndexFile *	deffile
	)			const

void OP_OTLManager::popFallbackLibraryContext

(

)

void OP_OTLManager::pushFallbackLibraryContext

(

)

void OP_OTLManager::refreshAll

(

bool

reloadOpLibraries

)

bool OP_OTLManager::refreshLibrary	(	int	index,
		bool	force = true
	)

void OP_OTLManager::refreshLicenses

(

)

static void OP_OTLManager::registerOTLLoadCallback

(

OP_OTLLoadCallback *

cb

)

[static]

bool OP_OTLManager::removeFromLibrary	(	const char *	libfile,
		const UT_StringArray &	ops
	)

bool OP_OTLManager::removeLibrary	(	const char *	libfile,
		const char *	metasrc,
		bool	changeoplibraries
	)

void OP_OTLManager::removeManagerSink

(

OP_OTLManagerSink *

sink

)

bool OP_OTLManager::removeMetaSource

(

const char *

metasrc

)

bool OP_OTLManager::runOTLCallbacks	(	const char *	otl_name,
		UT_String &	error_out
	)

static void OP_OTLManager::saveDefaultCreationScript	(	ostream &	os,
		const char *	op,
		const char *	table
	)			[static]

static void OP_OTLManager::saveDefaultDialogScript	(	ostream &	os,
		const char *	opname,
		const char *	oplabel,
		const char *	extradsinfo
	)			[static]

void OP_OTLManager::saveDummyDefinitions	(	ostream &	os,
		const OP_OperatorList &	ops
	)			const

void OP_OTLManager::saveFallbackLibraryPaths	(	ostream &	os,
		const OP_OperatorList &	ops
	)			const

bool OP_OTLManager::saveInternalMetaFile	(	ostream &	os,
		const char *	prefix = 0
	)			const

void OP_OTLManager::saveLibraryPreferences	(	ostream &	os,
		bool	includeinternal = true,
		bool	protectstrings = false
	)			const

void OP_OTLManager::saveOpTypeFromNode	(	OP_Node *	node,
		UT_String &	errors
	)

void OP_OTLManager::setComment	(	FS_IndexFile *	deffile,
		const char *	comment
	)

void OP_OTLManager::setContentsCompression	(	FS_IndexFile *	deffile,
		int	gzipcontents
	)

void OP_OTLManager::setCreateBackups

(

bool

createbackups

)

void OP_OTLManager::setDummyDefinition	(	const OP_OTLDefinition &	definition,
		const FS_IndexFile *	deffile
	)

void OP_OTLManager::setFilters	(	const OP_OTLDefinition &	definition,
		FS_IndexFile &	contents
	)			const

void OP_OTLManager::setLeaveDefaultsUnchanged

(

bool

leavedefaultsunchanged

)

void OP_OTLManager::setLibraryPreference	(	const char *	tablename,
		const char *	opname,
		const char *	libfile
	)

void OP_OTLManager::setLibraryPreferencesIfRequired

(

int

index

)

bool OP_OTLManager::setMetaSourceName	(	const char *	metasrc,
		const char *	metasrcname
	)

void OP_OTLManager::setOperatorTypeBarMode

(

const char *

mode

)

void OP_OTLManager::setPreferIndexFile

(

bool

preferindexfile

)

void OP_OTLManager::setPreferInternal

(

bool

preferinternal

)

void OP_OTLManager::setPreferLatestDate

(

bool

preferlatest

)

void OP_OTLManager::setSafeguardOpDefs

(

bool

safeguardopdefs

)

void OP_OTLManager::setSaveToHipFile

(

bool

savetohip

)

void OP_OTLManager::setSaveUnlockedToHipFile

(

bool

saveunlockedtohip

)

void OP_OTLManager::setUseOplibrariesFiles

(

bool

useoplibrariesfiles

)

void OP_OTLManager::setVersion	(	FS_IndexFile *	deffile,
		const char *	version
	)

void OP_OTLManager::setWarnDummyOpsOnLoad

(

bool

warn

)

void OP_OTLManager::setWarnOutOfDateOps

(

bool

warn

)

bool OP_OTLManager::touchDefinition	(	const char *	libfile,
		const char *	tablename,
		const char *	opname,
		int	newtime = -1
	)

void OP_OTLManager::updateContentsFromNode	(	FS_IndexFile *	deffile,
		OP_Node *	node,
		bool	gzipcontents,
		bool	compilebasic,
		bool	compilevopnets,
		bool	compilechannels,
		bool	compilenodenames,
		const char *	library
	)

void OP_OTLManager::updateDefinitionFromNode	(	FS_IndexFile *	deffile,
		OP_Node *	node,
		bool	lockcontents,
		bool	usedsparms,
		bool	gzipcontents,
		bool	savespareparms,
		bool	compile_asset,
		const char *	library
	)

void OP_OTLManager::writeOutDefinitionContents	(	const OP_OTLDefinition &	definition,
		FS_IndexFile &	contents,
		ostream &	os
	)			const

---

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

• OP/OP_OTLManager.h