libyasm/dbgfmt.h File Reference

YASM debug format interface. More...

Go to the source code of this file.

Data Structures
struct	yasm_dbgfmt_module
	Debug format module interface. More...
Functions
const char *	yasm_dbgfmt_keyword (const yasm_dbgfmt *dbgfmt)
	Get the keyword used to select a debug format.
yasm_dbgfmt *	yasm_dbgfmt_create (const yasm_dbgfmt_module *module, yasm_object *object)
	Initialize debug output for use.
void	yasm_dbgfmt_destroy (yasm_dbgfmt *dbgfmt)
	Cleans up any allocated debug format memory.
void	yasm_dbgfmt_generate (yasm_object *object, yasm_linemap *linemap, yasm_errwarns *errwarns)
	Generate debugging information bytecodes.

---

Detailed Description

YASM debug format interface.

Definition in file dbgfmt.h.

---

Function Documentation

yasm_dbgfmt* yasm_dbgfmt_create	(	const yasm_dbgfmt_module *	module,
		yasm_object *	object
	)

Initialize debug output for use.

Must call before any other debug format functions. The filenames are provided solely for informational purposes.

Parameters:

	module	debug format module
	object	object to generate debugging information for

Returns:

NULL if object format does not provide needed support.

void yasm_dbgfmt_destroy

(

yasm_dbgfmt *

dbgfmt

)

Cleans up any allocated debug format memory.

Parameters:

dbgfmt

debug format

void yasm_dbgfmt_generate	(	yasm_object *	object,
		yasm_linemap *	linemap,
		yasm_errwarns *	errwarns
	)

Generate debugging information bytecodes.

Parameters:

	object	object
	linemap	virtual/physical line mapping
	errwarns	error/warning set

Note:

Errors and warnings are stored into errwarns.

const char* yasm_dbgfmt_keyword

(

const yasm_dbgfmt *

dbgfmt

)

Get the keyword used to select a debug format.

Parameters:

dbgfmt

debug format

Returns:

keyword

---