OFX::Log Namespace Reference

this namespace wraps up logging functionality More...

Functions
void	indent (void)
	Indent it, not MP sane at the moment.
void	outdent (void)
	Outdent it, not MP sane at the moment.
void	setFileName (const std::string &value)
	Sets the name of the log file.
bool	open (void)
	Opens the log file, returns whether this was sucessful or not.
void	close (void)
	Closes the log file.
void	print (const char *format,...)
	Prints to the log file.
void	warning (bool condition, const char *format,...)
	Prints to the log file only if the condition is true and prepends a warning notice.
void	error (bool condition, const char *format,...)
	Prints to the log file only if the condition is true and prepends an error notice.
static std::string	gLogFileName (getenv(kLogFileEnvVar)?getenv(kLogFileEnvVar):"ofxTestLog.txt")
	the global logfile name
static void	doIndent (void)
	do the indenting
Variables
static FILE *	gLogFP = 0
	log file
static int	gIndent = 0
	global indent level, not MP sane

---

Detailed Description

this namespace wraps up logging functionality

---

Function Documentation

void OFX::Log::close

(

void

)

Closes the log file.

Definition at line 86 of file ofxsLog.cpp.

References gLogFP.

static void OFX::Log::doIndent

(

void

)

[static]

do the indenting

Definition at line 108 of file ofxsLog.cpp.

References gIndent, gLogFP, and open().

Referenced by error(), print(), and warning().

Here is the call graph for this function:

void OFX::Log::error	(	bool	condition,
		const char *	format,
			...
	)

Prints to the log file only if the condition is true and prepends an error notice.

Definition at line 153 of file ofxsLog.cpp.

References doIndent(), gLogFP, and open().

Referenced by OFX::Private::checkMainHandles(), copy_sequence(), tuttle::plugin::av::LibAVVideoReader::decodeImage(), tuttle::plugin::av::LibAVVideoWriter::execute(), OFX::Private::fetchHostDescription(), OFX::fetchSuite(), tuttle::plugin::av::LibAVVideoWriter::finishInit(), OFX::Clip::getFieldOrder(), OFX::Clip::getPixelComponents(), OFX::Clip::getPixelDepth(), OFX::Clip::getPreMultiplication(), OFX::Private::getRenderActionArguments(), OFX::Private::getTimeDomainAction(), OFX::Clip::getUnmappedPixelComponents(), OFX::Clip::getUnmappedPixelDepth(), OFX::Image::Image(), OFX::Private::instanceChangedAction(), OFX::Private::loadAction(), main(), OFX::Private::mainEntryStr(), OFX::mapContextEnumToString(), OFX::mapContextStringToEnum(), OFX::mapInstanceChangedReasonStringToEnum(), OFX::mapMessageReplyEnumToStatus(), OFX::mapMessageReplyStatusToEnum(), OFX::mapMessageTypeEnumToString(), OfxGetPlugin(), tuttle::plugin::av::LibAVVideoReader::open(), layer::text< view_t >::operator()(), tuttle::plugin::av::AVOptionPlugin< IOPlugin >::optionSet(), OFX::PropertySet::propGetDimension(), OFX::PropertySet::propGetDouble(), OFX::PropertySet::propGetInt(), OFX::PropertySet::propGetPointer(), OFX::PropertySet::propGetString(), OFX::PropertySet::propReset(), OFX::PropertySet::propSetDouble(), OFX::PropertySet::propSetInt(), OFX::PropertySet::propSetPointer(), OFX::PropertySet::propSetString(), tuttle::plugin::av::LibAVVideoReader::read(), OFX::Private::retrieveImageEffectPointer(), OFX::Private::retrieveInteractPointer(), sammvcp(), and OFX::Validation::PropertyDescription::validate().

Here is the call graph for this function:

static std::string OFX::Log::gLogFileName

(

getenv(kLogFileEnvVar)?getenv(kLogFileEnvVar):"ofxTestLog.txt"

)

[static]

the global logfile name

Referenced by open(), and setFileName().

void OFX::Log::indent

(

void

)

Indent it, not MP sane at the moment.

Definition at line 96 of file ofxsLog.cpp.

References gIndent.

Referenced by OFX::Private::interactMainEntry(), main(), OFX::Private::mainEntryStr(), and OFX::Validation::PropertySetDescription::validate().

bool OFX::Log::open

(

void

)

Opens the log file, returns whether this was sucessful or not.

Definition at line 73 of file ofxsLog.cpp.

References gLogFileName(), and gLogFP.

Referenced by doIndent(), error(), print(), and warning().

Here is the call graph for this function:

void OFX::Log::outdent

(

void

)

Outdent it, not MP sane at the moment.

Definition at line 102 of file ofxsLog.cpp.

References gIndent.

Referenced by OFX::Private::interactMainEntry(), OFX::Private::mainEntryStr(), and OFX::Validation::PropertySetDescription::validate().

void OFX::Log::print	(	const char *	format,
			...
	)

Prints to the log file.

Definition at line 120 of file ofxsLog.cpp.

References doIndent(), gLogFP, and open().

Referenced by OFX::Private::interactMainEntry(), OFX::Private::mainEntryStr(), OFX::PropertySet::propGetDimension(), OFX::PropertySet::propGetDouble(), OFX::PropertySet::propGetInt(), OFX::PropertySet::propGetPointer(), OFX::PropertySet::propGetString(), OFX::PropertySet::propReset(), OFX::PropertySet::propSetDouble(), OFX::PropertySet::propSetInt(), OFX::PropertySet::propSetPointer(), OFX::PropertySet::propSetString(), and OFX::Validation::PropertySetDescription::validate().

Here is the call graph for this function:

void OFX::Log::setFileName

(

const std::string &

value

)

Sets the name of the log file.

Definition at line 67 of file ofxsLog.cpp.

References gLogFileName().

Here is the call graph for this function:

void OFX::Log::warning	(	bool	condition,
		const char *	format,
			...
	)

Prints to the log file only if the condition is true and prepends a warning notice.

Definition at line 135 of file ofxsLog.cpp.

References doIndent(), gLogFP, and open().

Referenced by OFX::Private::checkMainHandles(), OFX::fetchSuite(), main(), and sammvcp().

Here is the call graph for this function:

---

Variable Documentation

int OFX::Log::gIndent = 0 [static]

global indent level, not MP sane

Definition at line 64 of file ofxsLog.cpp.

Referenced by doIndent(), indent(), and outdent().

FILE* OFX::Log::gLogFP = 0 [static]

log file

Definition at line 55 of file ofxsLog.cpp.

Referenced by close(), doIndent(), error(), open(), print(), and warning().