FMX_show.c File Reference

Implementations of the "show" commands in the FMX command line interface. More...

#include <stdio.h>
#include <stdlib.h>
#include <FMX/FMX_msgs.h>
#include <FMX/FMX_pubdefs.h>
#include <FMX_clidefs.h>
#include <FMX_prtdefs.h>

Classes
struct	_FMX_cb_showKeyPrm
	Parameter block for the show key callback routine. More...
Defines
#define	FMX_L_TAGS   ( 32 )
	Maximum length of a a tag list.
Typedefs
typedef struct _FMX_cb_showKeyPrm	FMX_cb_showKeyPrm
	Typedef for struct _FMX_cb_showKeyPrm.
Functions
static unsigned int	FMX_cb_showFOF (void *prm, unsigned int visible, unsigned int key, const char *dir, unsigned int index, unsigned int size, const char *date, const char *name)
	Callback for a "show fof" command.
static unsigned int	FMX_cb_showKey (void *usr, unsigned int key, const char *dir, FMX_FileGroup group, unsigned int flight, unsigned int visible, const char *tag, unsigned int index, unsigned int size, const char *date, const char *name, const char *pkg, const char *ver, const char *con, FMX_CaptureModule captured, unsigned int contents, unsigned int count, const unsigned int *dat)
	Callback for a "show key" command.
static unsigned int	FMX_cb_showSBS (void *prm, unsigned int visible, unsigned int key, const char *dir, unsigned int index, unsigned int size, const char *date, const char *name, const char *pkg, const char *ver, const char *con, FMX_CaptureModule captured, unsigned int contents, unsigned int count, const unsigned int *dat)
	Callback for a "show fof" command.
unsigned int	FMX_show (CLI_Control *ctl, void *user)
	Callback for the show command.
unsigned int	FMX_showCDM (CLI_Control *ctl, void *user)
	List files corresponding to key (the first parameter).
unsigned int	FMX_showConnect (CLI_Control *ctl, void *user)
	Display the connection.
unsigned int	FMX_showDevice (CLI_Control *ctl, void *user)
	Display the device table.
unsigned int	FMX_showFiletype (CLI_Control *ctl, void *user)
	Display the filetype table.
unsigned int	FMX_showFOF (CLI_Control *ctl, void *user)
	List members of a compound "file-of-files".
unsigned int	FMX_showHost (CLI_Control *ctl, void *user)
	Display the host table.
unsigned int	FMX_showInstrument (CLI_Control *ctl, void *user)
	Display the instrument table.
unsigned int	FMX_showKey (CLI_Control *ctl, void *user)
	List files corresponding to key (the first parameter).
unsigned int	FMX_showNode (CLI_Control *ctl, void *user)
	Display the node table.
unsigned int	FMX_showSBS (CLI_Control *ctl, void *user)
	List members of a compound secondary boot script.
unsigned int	FMX_showTag (CLI_Control *ctl, void *user)
	Display the tag table.

---

Detailed Description

Implementations of the "show" commands in the FMX command line interface.

CVS $Id: FMX_show.c,v 1.8 2011/03/25 20:42:51 apw Exp $

Author:

A.P.Waite

---

Function Documentation

static unsigned int FMX_cb_showFOF	(	void *	prm,
		unsigned int	visible,
		unsigned int	key,
		const char *	dir,
		unsigned int	index,
		unsigned int	size,
		const char *	date,
		const char *	name
	)			[static]

Callback for a "show fof" command.

Parameters:

	prm	(in) User parameter
	visible	(in) Is file visible (boolean)
	key	(in) Original file key
	dir	(in) File type (expressed as directory name)
	index	(in) Index of file in visible table
	size	(in) Size of file (bytes)
	date	(in) Date file added to FMX
	name	(in) Name of file

Return values:

FMX_SUCCESS

Success

Referenced by FMX_showFOF().

static unsigned int FMX_cb_showKey	(	void *	usr,
		unsigned int	key,
		const char *	dir,
		FMX_FileGroup	group,
		unsigned int	flight,
		unsigned int	visible,
		const char *	tag,
		unsigned int	index,
		unsigned int	size,
		const char *	date,
		const char *	name,
		const char *	pkg,
		const char *	ver,
		const char *	con,
		FMX_CaptureModule	captured,
		unsigned int	contents,
		unsigned int	count,
		const unsigned int *	dat
	)			[static]

Callback for a "show key" command.

Parameters:

	usr	(in) User parameter
	key	(in) Original file key
	dir	(in) File type (expressed as directory name)
	group	(in) Group to which the file belongs
	flight	(in) Is file an export file (i.e. flight-ready) (boolean)
	visible	(in) Is file visible (boolean)
	tag	(in) (iff group = module) Architecture tag
	index	(in) Index of file in visible table
	size	(in) Size of file (bytes)
	date	(in) Date file added to FMX
	name	(in) Name of file
	pkg	(in) (iff group = module) Package
	ver	(in) (iff group = module) Version
	con	(in) (iff group = module) Constituent
	captured	(in) (iff group = module) Extended data capture method
	contents	(in) (iff group = module) Extended data contents identifier
	count	(in) (iff group = module) Count of words in data array
	dat	(in) (iff group = module) Array of unsigned long data words

Return values:

FMX_SUCCESS

Success

References FMX_OPT_EXPORT, FMX_OPT_IMPORT, _FMX_cb_showKeyPrm::opt, s_export, and s_import.

Referenced by FMX_showKey().

static unsigned int FMX_cb_showSBS	(	void *	prm,
		unsigned int	visible,
		unsigned int	key,
		const char *	dir,
		unsigned int	index,
		unsigned int	size,
		const char *	date,
		const char *	name,
		const char *	pkg,
		const char *	ver,
		const char *	con,
		FMX_CaptureModule	captured,
		unsigned int	contents,
		unsigned int	count,
		const unsigned int *	dat
	)			[static]

Callback for a "show fof" command.

Parameters:

	prm	(in) User parameter
	visible	(in) Is file visible (boolean)
	key	(in) Original file key
	dir	(in) File type (expressed as directory name)
	index	(in) Index of file in visible table
	size	(in) Size of file (bytes)
	date	(in) Date file added to FMX
	name	(in) Name of file
	pkg	(in) Module package name
	ver	(in) Module version
	con	(in) Module constituent name
	captured	(in) Method by which extended data was captured
	contents	(in) Extended data contents identifier
	count	(in) Count of words in data array
	dat	(in) Array of unsigned long data words

Return values:

FMX_SUCCESS

Success

Referenced by FMX_showSBS().

unsigned int FMX_show	(	CLI_Control *	ctl,
		void *	user
	)

Callback for the show command.

Parameters:

	ctl	(in) Anonymous control pointer
	user	(in) User parameter

Returns:

Status code

A never call.

Referenced by FMX_syntax().

unsigned int FMX_showCDM	(	CLI_Control *	ctl,
		void *	user
	)

List files corresponding to key (the first parameter).

Parameters:

	ctl	(in) Anonymous control pointer
	user	(in) User parameter

Returns:

Status code

References d_0, s_absolute, and s_tag.

Referenced by FMX_syntax().

unsigned int FMX_showConnect	(	CLI_Control *	ctl,
		void *	user
	)

Display the connection.

Parameters:

	ctl	(in) Anonymous control pointer
	user	(in) User parameter

Returns:

Status code

References FMX_printConnect().

Referenced by FMX_syntax().

unsigned int FMX_showDevice	(	CLI_Control *	ctl,
		void *	user
	)

Display the device table.

Parameters:

	ctl	(in) Anonymous control pointer
	user	(in) User parameter

Returns:

Status code

References FMX_ENUM_TABLE_DEVICE, FMX_OPT_TITLE, FMX_printEnumTable(), and s_title.

Referenced by FMX_syntax().

unsigned int FMX_showFiletype	(	CLI_Control *	ctl,
		void *	user
	)

Display the filetype table.

Parameters:

	ctl	(in) Anonymous control pointer
	user	(in) User parameter

Returns:

Status code

References FMX_ENUM_TABLE_FILETYPE, FMX_OPT_TITLE, FMX_printEnumTable(), and s_title.

Referenced by FMX_syntax().

unsigned int FMX_showFOF	(	CLI_Control *	ctl,
		void *	user
	)

List members of a compound "file-of-files".

Parameters:

	ctl	(in) Anonymous control pointer
	user	(in) User parameter

Returns:

Status code

References d_0, FMX_cb_showFOF(), and s_export.

Referenced by FMX_syntax().

unsigned int FMX_showHost	(	CLI_Control *	ctl,
		void *	user
	)

Display the host table.

Parameters:

	ctl	(in) Anonymous control pointer
	user	(in) User parameter

Returns:

Status code

References FMX_ENUM_TABLE_HOST, FMX_OPT_FULL, FMX_OPT_TITLE, FMX_printEnumTable(), s_full, and s_title.

Referenced by FMX_syntax().

unsigned int FMX_showInstrument	(	CLI_Control *	ctl,
		void *	user
	)

Display the instrument table.

Parameters:

	ctl	(in) Anonymous control pointer
	user	(in) User parameter

Returns:

Status code

References FMX_ENUM_TABLE_INSTRUMENT, FMX_OPT_TITLE, FMX_printEnumTable(), and s_title.

Referenced by FMX_syntax().

unsigned int FMX_showKey	(	CLI_Control *	ctl,
		void *	user
	)

List files corresponding to key (the first parameter).

Parameters:

	ctl	(in) Anonymous control pointer
	user	(in) User parameter

Returns:

Status code

References d_0, FMX_cb_showKey(), FMX_L_TAGS, FMX_OPT_EXPORT, FMX_OPT_IMPORT, _FMX_cb_showKeyPrm::ntag, _FMX_cb_showKeyPrm::opt, s_export, s_import, s_tag, and _FMX_cb_showKeyPrm::tags.

Referenced by FMX_syntax().

unsigned int FMX_showNode	(	CLI_Control *	ctl,
		void *	user
	)

Display the node table.

Parameters:

	ctl	(in) Anonymous control pointer
	user	(in) User parameter

Returns:

Status code

References FMX_ENUM_TABLE_NODE, FMX_OPT_TITLE, FMX_printEnumTable(), and s_title.

Referenced by FMX_syntax().

unsigned int FMX_showSBS	(	CLI_Control *	ctl,
		void *	user
	)

List members of a compound secondary boot script.

Parameters:

	ctl	(in) Anonymous control pointer
	user	(in) User parameter

Returns:

Status code

References d_0, FMX_cb_showSBS(), s_export, and s_tag.

Referenced by FMX_syntax().

unsigned int FMX_showTag	(	CLI_Control *	ctl,
		void *	user
	)

Display the tag table.

Parameters:

	ctl	(in) Anonymous control pointer
	user	(in) User parameter

Returns:

Status code

References FMX_ENUM_TABLE_TAG, FMX_OPT_TITLE, FMX_printEnumTable(), and s_title.

Referenced by FMX_syntax().