CLI_dump.c File Reference

The implicit command verb "syntax". More...

#include <ctype.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <CLI/CLI_pubdefs.h>
#include <MDB/MDB_pubdefs.h>
#include <CLI_prvdefs.h>

Defines
#define	CLI_L_OPTS   4
#define	CLI_L_TYPE   6
Functions
static void	dumpSyntax (CLI_Syntax *sntx)
	Dump a complete syntax definition.
static void	dumpOptions (unsigned short opts)
	Dump a list of options.
static void	dumpTypes (unsigned short type, CLI_KeyList *list)
	Dump a list of types.
unsigned int	CLI_dumpSyntax (CLI_Control *ctl, void *user)
	Dump out the syntax definitions.
void	CLI_dumpKeyList (CLI_KeyList *list)
	Dump a list of keywords.
void	CLI_dumpParse (CLI_Control *ctl)
	Dump the results of a parse.

---

Detailed Description

The implicit command verb "syntax".

CVS $Id: CLI_dump.c,v 1.6 2011/03/25 00:51:25 apw Exp $

Author:

A.P.Waite

---

Function Documentation

void CLI_dumpKeyList

(

CLI_KeyList *

list

)

Dump a list of keywords.

Parameters:

list

(Opaque) pointer to keyword list

References _CLI_KeyList::id, _CLI_KeyList::key, _CLI_KeyList::name, _CLI_KeyDef::next, and _CLI_KeyDef::text.

void CLI_dumpParse

(

CLI_Control *

ctl

)

Dump the results of a parse.

Parameters:

ctl

(Opaque) pointer to CLI control structure.

References _CLI_Qual::flag, _CLI_Control::id, _CLI_Qual::list, _CLI_Parm::list, _CLI_Qual::next, _CLI_Valu::next, _CLI_Parm::next, _CLI_Tokens::parm, _CLI_Tokens::qual, _CLI_Qual::text, _CLI_Valu::text, _CLI_Control::tokens, and _CLI_Tokens::verb.

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

Dump out the syntax definitions.

Dump a command syntax (either a named syntax, or all known syntaxes).

References dumpSyntax(), and _CLI_Control::syntax.

Referenced by CLI_createSyntax().

static void dumpOptions

(

unsigned short

opts

)

[static]

Dump a list of options.

Parameters:

opts

Options word (a mask of options)

Referenced by dumpSyntax().

static void dumpSyntax

(

CLI_Syntax *

sntx

)

[static]

Dump a complete syntax definition.

Parameters:

sntx

(Opaque) pointer to syntax definition

References _CLI_VerbDef::call, dumpOptions(), dumpTypes(), _CLI_Syntax::id, _CLI_QualDef::list, _CLI_Syntax::name, _CLI_QualDef::next, _CLI_ParmDef::next, _CLI_VerbDef::next, _CLI_QualDef::opts, _CLI_ParmDef::opts, _CLI_VerbDef::parm, _CLI_VerbDef::qual, _CLI_ParmDef::sork, _CLI_QualDef::text, _CLI_VerbDef::text, _CLI_QualDef::type, _CLI_ParmDef::type, and _CLI_Syntax::verb.

Referenced by CLI_dumpSyntax().

static void dumpTypes	(	unsigned short	type,
		CLI_KeyList *	list
	)			[static]

Dump a list of types.

Parameters:

	type	Type word (a mask of types)
	list	A keyword list (if available)

References _CLI_KeyList::key, _CLI_KeyDef::next, and _CLI_KeyDef::text.

Referenced by dumpSyntax().