Command structure and corresponding macros used to define CLE command tables. More...

Data Structures
struct	CleCommand
	CLE structure for command table. More...

Macros
#define	CLECMD_OPN(name) TsCleCommand name[]
	Starts a table with command definitions. More...

#define	CLETAB_CMD(kyw, tab, clp, par, oid, ini, map, run, fin, flg, man, hlp) {(kyw),(tab),(clp),(par),(oid),(ini),(map),(run),(fin),(flg),(man),(hlp)},
	Defines a command with the command line keyword kyw. More...

#define	CLECMD_CLS { NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, 0 , NULL, NULL}
	Ends a table with constant definitions. More...

Typedefs
typedef struct CleCommand	TsCleCommand
	CLE structure for command table. More...

Detailed Description

Command structure and corresponding macros used to define CLE command tables.

Macro Definition Documentation

◆ CLECMD_OPN

#define CLECMD_OPN ( name ) TsCleCommand name[]

Starts a table with command definitions.

Parameters

[in] name Name of this table.

◆ CLETAB_CMD

#define CLETAB_CMD	(	kyw,
		tab,
		clp,
		par,
		oid,
		ini,
		map,
		run,
		fin,
		flg,
		man,
		hlp
	)	{(kyw),(tab),(clp),(par),(oid),(ini),(map),(run),(fin),(flg),(man),(hlp)},

Defines a command with the command line keyword kyw.

Parameters

[in]	kyw	Pointer to command line keyword kyw.
[in]	tab	Pointer to the main table for this command.
[in]	clp	Pointer to the corresponding FLAMCLP structure (generated with the CLPMAC.h marcros).
[in]	par	Pointer to the corresponding parameter structure.
[in]	oid	Pointer to an integer to define the main table as overlay or NULL to define the main table as object If the pointer is set the object identifier of the chosen argument of the overlay is given back.
[in]	ini	Pointer to the initialization function for the FLAMCLP structure (see TfIni).
[in]	map	Pointer to the mapping function (see TfMap). The mapping functions maps the parsed content of the FLAMCLP structure in the PAR structure.
[in]	run	Pointer to the run function to execute the subprogram with the PAR structure (see TfRun).
[in]	fin	Pointer to the finalization function to clean up the parameter structure (see TfFin).
[in]	flg	Flag to indicate a hidden (==0) or visible (!=0) command, For correct numbering, put hidden commands to the end of the table.
[in]	man	Pointer to a null-terminated string for a detailed description of this command. (in ASCIDOC format, content behind .DESCRIPTION, usually some paragraphs plus .OPTIONS and/or .EXAMPLES) It is recommended to use a header file with a define for this long string).
[in]	hlp	String for a short context sensitive help to this command.

◆ CLECMD_CLS

#define CLECMD_CLS { NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, 0 , NULL, NULL}

Ends a table with constant definitions.

Typedef Documentation

◆ TsCleCommand

typedef struct CleCommand TsCleCommand

CLE structure for command table.

The command table defines all the commands which could be executed by CLE. To simplify the definition of command tables it is recommended to use the CLPTAB macros.

Data Structures

Macros