RIM_ground_p.h File Reference

Private definitions for the RIM ground components. More...

#include <RIM/RIM.h>
#include <XLX/XLX.h>

Classes
struct	RIM_descriptor
	Descriptor used for parsing a character element. More...
struct	RIM_tag
	Derivation of the XLX/tag structure adding RIM information. More...
struct	RIM_state
	State of a RIM parser. More...
struct	RIM_mapOptns
	Map options. More...
Functions
RIM_tag **	RIM_cfgTags (void)
	Get the address of the configuration tag tree.
RIM_tag **	RIM_mapTags (void)
	Get the address of the ignore map tag tree.
void	RIM_setRegBit (void *regmap, RIM_type type, int index, int regId)
	Set a bit in a register map (private).
void	RIM_setRegDflts (RIM *rim, void *regmap)
	Propagate default register values to exceptions (private).

---

Detailed Description

Private definitions for the RIM ground components.

Author:

James Swain & Owen Saxton

$Id: RIM_ground_p.h,v 1.4 2011/03/27 06:53:19 saxton Exp $

---

Function Documentation

RIM_tag** RIM_cfgTags

(

void

)

Get the address of the configuration tag tree.

Returns:

The address of the configuration tag tree

RIM_tag** RIM_mapTags

(

void

)

Get the address of the ignore map tag tree.

Returns:

The address of the ignore map tag tree

Referenced by RIM_genxml().

void RIM_setRegBit	(	void *	regmap,
		RIM_type	type,
		int	index,
		int	reg
	)

Set a bit in a register map (private).

Parameters:

	regmap	The address of the register map to be modified
	type	The component type number, assumed to be in range
	index	The index of the component, assumed to be in range
	reg	The register number, assumed to be in range

References setBit().

void RIM_setRegDflts	(	RIM *	rim,
		void *	regmap
	)

Propagate default register values to exceptions (private).

Parameters:

	rim	The address of the RIM structure
	regmap	The address of the map of set registers

References checkBit(), getLngLngReg(), getLongReg(), getShortReg(), CptDescription::nregs, setBit(), setLngLngReg(), setLongReg(), setShortReg(), and CptDescription::width.

Referenced by RIM_parse().