listfmt.h File Reference

YASM list format interface. More...

Go to the source code of this file.

Data Structures
struct	yasm_listfmt_module
	YASM list format module interface. More...

Typedefs
typedef struct yasm_listfmt_module	yasm_listfmt_module
	YASM list format module interface. More...

Functions
const char *	yasm_listfmt_keyword (const yasm_listfmt *listfmt)
	Get the keyword used to select a list format. More...
yasm_listfmt *	yasm_listfmt_create (const yasm_listfmt_module *module, const char *in_filename, const char *obj_filename)
	Initialize list format for use. More...
void	yasm_listfmt_destroy (yasm_listfmt *listfmt)
	Cleans up any allocated list format memory. More...
void	yasm_listfmt_output (yasm_listfmt *listfmt, FILE *f, yasm_linemap *linemap, yasm_arch *arch)
	Write out list to the list file. More...

Detailed Description

YASM list format interface.

Definition in file listfmt.h.

Typedef Documentation

typedef struct yasm_listfmt_module yasm_listfmt_module

YASM list format module interface.

Function Documentation

yasm_listfmt* yasm_listfmt_create	(	const yasm_listfmt_module *	module,
		const char *	in_filename,
		const char *	obj_filename
	)

Initialize list format for use.

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

Parameters

module	list format module
in_filename	primary input filename
obj_filename	object filename

Returns

NULL if object format does not provide needed support.

void yasm_listfmt_destroy

(

yasm_listfmt *

listfmt

)

Cleans up any allocated list format memory.

Parameters

listfmt

list format

const char* yasm_listfmt_keyword

(

const yasm_listfmt *

listfmt

)

Get the keyword used to select a list format.

Parameters

listfmt

list format

Returns

keyword

void yasm_listfmt_output	(	yasm_listfmt *	listfmt,
		FILE *	f,
		yasm_linemap *	linemap,
		yasm_arch *	arch
	)

Write out list to the list file.

This function may call all read-only yasm_* functions as necessary.

Parameters

listfmt	list format
f	output list file
linemap	line mapping repository
arch	architecture