Utility Routines

Functions
double	s2d (char *s)
	Convert char string to double.
char *	d2s (double d, CObstack *heap)
	Convert double to char string allocating storage on given heap.
const char *	Identifier (const char *s)
	Convert a string representing an identifier to an escaped format for printing (if needed).
const char *	VrqVersionString ()
	Plugins should not be using these.
char *	GetPlusArg (const char *prefix)
	Get plusarg from command line that matches prefix.
void	GetPlusArgs (const char *prefix, list< string > &args)
	Get list of plusargs from command line that matche prefix.
void	GetPluginPaths (list< string > &paths)
	Get list of paths to where plugins may reside.
static Message *	Message::RegisterWarning (CBackend *tool, Action_t defaultAction, const char *abbrev, const char *format,...)
	Register a warning message.
static Message *	Message::RegisterError (CBackend *tool, const char *abbrev, const char *format,...)
	Register an error message.
void	message (struct Coord_t *location, Message *message,...)
	Print message.
void	vlogprintf (const char *format, va_list args)
	Print to logfile.
void	logprintf (const char *format,...)
	Print to logfile.

---

Function Documentation

char * d2s	(	double	d,
		CObstack *	heap
	)			[inline]

Convert double to char string allocating storage on given heap.

Parameters:

	d	double to convert.
	heap	heap to use for allocation.

Returns:

pointer to char string.

void GetPluginPaths

(

list< string > &

paths

)

Get list of paths to where plugins may reside.

Parameters:

paths

list of filesystem paths.

char* GetPlusArg

(

const char *

prefix

)

Get plusarg from command line that matches prefix.

Parameters:

prefix

to search for.

Returns:

complete plusarg text.

void GetPlusArgs	(	const char *	prefix,
		list< string > &	args
	)

Get list of plusargs from command line that matche prefix.

Parameters:

	prefix	to search for.
	args	list to populate with matching plusargs.

const char* Identifier

(

const char *

s

)

Convert a string representing an identifier to an escaped format for printing (if needed).

Verilog identifier escaping rules are used.

Parameters:

s

text to check and convert if needed.

Returns:

converted text. Storage for this result may be from a shared static buffer and must be either used or copied immediately.

void logprintf	(	const char *	format,
			...
	)

Print to logfile.

Parameters:

	format	format to use for output.
	...	additional arguments used by format.

void message	(	struct Coord_t *	location,
		Message *	message,
			...
	)

Print message.

Parameters:

	location	file coordinates to use in message. NULL if none.
	message	message object to use for message format.
	...	additional arguments used by format.

static Message* Message::RegisterError	(	CBackend *	tool,
		const char *	abbrev,
		const char *	format,
			...
	)			[static, inherited]

Register an error message.

Policy is set to eERROR and cannot be changed.

Parameters:

	tool	backend tool owning message, NULL for unowned.
	abbrev	message abbreviation. Must be unique per tool.
	format	format string for printing message.

Returns:

message object.

static Message* Message::RegisterWarning	(	CBackend *	tool,
		Action_t	defaultAction,
		const char *	abbrev,
		const char *	format,
			...
	)			[static, inherited]

Register a warning message.

Parameters:

	tool	backend tool owning message, NULL for unowned.
	defaultAction	default message behavior.
	abbrev	message abbreviation. Must be unique per tool.
	format	format string for printing message.

Returns:

message object.

double s2d

(

char *

s

)

[inline]

Convert char string to double.

Parameters:

s

char pointer to string to convert.

Returns:

converted real.

void vlogprintf	(	const char *	format,
		va_list	args
	)

Print to logfile.

Parameters:

	format	format to use for output.
	args	variable argument list for values.

const char* VrqVersionString

(

)

Plugins should not be using these.

Get string containing vrq version number.

Returns:

char pointer to vrq version number.