CMX_interface_pub.h File Reference

Public include file for the CMX component which deals with interfaces. More...

Defines
#define	CMX_M_GLOBAL   0x1
#define	CMX_M_NOINDENT   0x2
#define	CMX_M_STRENGTH   0x4
#define	CMX_M_FULL   0x1
#define	CMX_M_NOTITLE   0x2
Functions
unsigned int	CMX_interfaceCompare (struct _CMX_Interface *ifac, struct _CMX_Interface *jfac, unsigned int opts)
	Compare two interface files.
const char *	CMX_interfaceFind (struct _CMX_Interface *ifac, const char *isym)
	Identify the interface in which a symbol appears.
unsigned int	CMX_interfaceRead (struct _CMX_Interface **ifac, const char *file)
	Parse a (CMX version) linker interface description file.
unsigned int	CMX_interfaceShowGlobals (struct _CMX_Interface *head)
	Dump the global symbol list from an interface definition file.
unsigned int	CMX_interfaceShowInterface (struct _CMX_Interface *head, unsigned int opts)
	Dump the interface instance list from an interface definition file.
unsigned int	CMX_interfaceShowLookups (struct _CMX_Interface *head)
	Dump the CMX export symbol list from an interface definition file.

---

Detailed Description

Public include file for the CMX component which deals with interfaces.

CVS $Id: CMX_interface_pub.h,v 1.3 2005/07/14 22:46:41 apw Exp $

---

Function Documentation

unsigned int CMX_interfaceCompare	(	struct _CMX_Interface *	ifac,
		struct _CMX_Interface *	jfac,
		unsigned int	opts
	)

Compare two interface files.

Parameters:

ifac	First interface
jfac	Second interface
opts	Processing options

CMX_interfaceCompare() compares two interface files, determining whether the second (new) file is a viable derivative of the first (old) file and recommending the level of transition (major, minor or patch) to go from the old to the new.

Return values:

0

Always

References _CMX_Interface::hier, interfaceCompare(), _CMX_Interface::maxnam, and _CMX_Interface::maxver.

const char * CMX_interfaceFind	(	struct _CMX_Interface *	ifac,
		const char *	isym
	)

Identify the interface in which a symbol appears.

Parameters:

ifac	Handle for previously parsed interface description file
isym	Symbol name to trace

Return values:

NULL	Symbol does not appear in any interface
x	Pointer to interface name

References _CMX_Symbol::inst, _CMX_Interface::isym, _CMX_Instance::name, _CMX_Symbol::name, and _CMX_Symbol::next.

unsigned int CMX_interfaceRead	(	struct _CMX_Interface **	ifac,
		const char *	file
	)

Parse a (CMX version) linker interface description file.

Parameters:

ifac	Pointer to an interface description header block
file	Filename of script file to be parsed

Return values:

0	Success
1	Failure

References _CMX_Instance::global, hierarchy(), _CMX_Instance::local, parse_global(), parse_interface(), parse_local(), and validate().

unsigned int CMX_interfaceShowGlobals

(

struct _CMX_Interface *

head

)

Dump the global symbol list from an interface definition file.

Parameters:

head	Control structure for one complete interface file.

Return values:

0	Success
1	Failure

References _CMX_Interface::isym, _CMX_Symbol::name, and _CMX_Symbol::next.

unsigned int CMX_interfaceShowInterface	(	struct _CMX_Interface *	head,
		unsigned int	opts
	)

Dump the interface instance list from an interface definition file.

Parameters:

head	Control structure for one complete interface file.
opts	Display options

Return values:

0	Success
1	Failure

References CMX_interfaceRecurse(), _CMX_Interface::hier, and showInterface().

unsigned int CMX_interfaceShowLookups

(

struct _CMX_Interface *

head

)

Dump the CMX export symbol list from an interface definition file.

Parameters:

head	Control structure for one complete interface file.

Return values:

0	Success
1	Failure

References _CMX_Interface::isym, _CMX_Symbol::name, _CMX_Symbol::next, and _CMX_Symbol::xprt.