parse.c File Reference

A keyword command parser. More...

#include <stdio.h>
#include <string.h>
#include <math.h>
#include <stdlib.h>
#include <ctype.h>
#include "MathType.h"
#include "SysDefs.h"
#include "macros.h"
#include "parse.h"
#include "general.h"

Go to the source code of this file.

Macros
#define	LF   10
#define	CR   13
#define	DIC   34 /* Double inverted commas */

Functions
int	blParse (char *comline, int nkeys, KeyWd *keywords, REAL *floatparam, char **strparam)
int	blMatch (char *comstring, char *string2, int *nletters)
int	blGetString (char *command, char *strparam)
int	blGetParam (char *command, REAL *value, int *nletters)
int	blMparse (char *comline, int nkeys, MKeyWd *keywords, REAL *floatparam, char **strparam, int *nparam)

Detailed Description

A keyword command parser.

Version

V1.11

Date

07.07.14

Copyright

(c) UCL / Dr. Andrew C. R. Martin 1990-2014

Author

Dr. Andrew C. R. Martin

Institute of Structural & Molecular Biology, University College London, Gower Street, London. WC1E 6BT.

andre.nosp@m.w@bi.nosp@m.oinf..nosp@m.org..nosp@m.uk andre.nosp@m.w.ma.nosp@m.rtin@.nosp@m.ucl..nosp@m.ac.uk

This code is NOT IN THE PUBLIC DOMAIN, but it may be copied according to the conditions laid out in the accompanying file COPYING.DOC.

The code may be modified as required, but any modifications must be documented so that the person responsible can be identified.

The code may not be sold commercially or included as part of a commercial product except as described in the file COPYING.DOC.

Description:

blParse() is a command line parser which will accept upper or lower case commands and abbreviations. Comment lines may be indicated using a !. The keyword structure array and returned string array are defined thus:

KeyWd keywords[NCOMM];
char  *strparam[MAXSTRPARAM];

The returned REAL parameters are defined thus:

REAL  floatparam[MAXFLOATPARAM];

Space for the returned strings must be allocated thus:

strparam[n] = (char *)malloc(MAXSTRLEN * sizeof(char));

and repeated for each parameter.

The keyword list with type and numbers of returned parameters is constructed using the MAKEKEY macros:

MAKEKEY(keywords[0],"RANGE",NUMBER,2);
MAKEKEY(keywords[1],"STRING",STRING,1);

Here, the keywords must be defined in upper case.

blMparse() is used in the same way, but allows a variable number of parameters for each keyword. Keywords are of type MKeyWd and are defined using the macro MAKEMKEY:

MAKEMKEY(keywords[0],"RANGE",NUMBER,2,2);
MAKEMKEY(keywords[1],"STRING",STRING,1,3);

Usage:

blParse(comline,nkeys,keywords,floatparam,strparam)

Parameters

[in]	*comline	A command line string to parse
[in]	nkeys	Number of keywords
[in]	*keywords	Array of keyword structures
[out]	*floatparam	Array of returned strings
[out]	**strparam	Array of pointers to returned strings

Returns

Index of found command or error flag

blMparse(comline,nkeys,keywords,floatparam,strparam,nparam)

Parameters

[in]	*comline	A command line string to parse
[in]	nkeys	Number of keywords
[in]	*keywords	Array of keyword structures
[out]	*floatparam	Array of returned strings
[out]	**strparam	Array of pointers to returned strings
[out]	*nparam	Number of parameters found

Returns

Index of found command or error flag

Revision History:

• V1.0 11.07.90 Original
• V1.1 29.10.90 match() now frees the memory it allocates and calls terminate() parse() now calls terminate() on the keyword string
• V1.2 25.09.91 Messages will only appear from parse() if NOISY is #defined. Added FPU support.
• V1.3 28.05.92 ANSIed and autodoc'd
• V1.4 08.12.92 Includes stdlib.h
• V1.5 22.04.93 Various tidying to exact ANSI standard and of function headers. Corrected some calls to free()
• V1.6 16.06.93 Tidied for book
• V1.7 01.03.94 Added mparse()
• V1.8 11.03.94 Added internal support for lines starting with a $. The line is passed as a system() call and parse() acts as if the line had been a comment.
• V1.9 08.10.99 Initialised some variables
• V1.10 28.02.11 Added # as a comment introducer
• V1.11 07.07.14 Use bl prefix for functions By: CTP

Definition in file parse.c.

Macro Definition Documentation

#define CR   13

Definition at line 176 of file parse.c.

#define DIC   34 /* Double inverted commas */

Definition at line 177 of file parse.c.

#define LF   10

Definition at line 175 of file parse.c.

Function Documentation

int blGetParam	(	char *	command,
		REAL *	value,
		int *	nletters
	)

Parameters

[in]	*command	A character string
[out]	*value	Returned float value
[out]	*nletters	Number of charcters pulled out of the command string

Returns

0 If error 1 If OK

Extracts the first space-delimited number from the `command' character string.

• 11.07.90 Original By: ACRM
• 22.04.93 Tidied comments, etc. Corrected NULL to 0
• 07.07.14 Use bl prefix for functions By: CTP

Definition at line 412 of file parse.c.

int blGetString	(	char *	command,
		char *	strparam
	)

Parameters

[in]	*command	A character string
[out]	*strparam	Returned character string

Returns

Number of characters pulled out of the command string

Returns the first space-delimited group of characters from character string `command'

• 11.07.90 Original By: ACRM
• 22.04.93 Tidied comments, etc. Changed toggle method
• 07.07.14 Use bl prefix for functions By: CTP

Definition at line 358 of file parse.c.

int blMatch	(	char *	comstring,
		char *	string2,
		int *	nletters
	)

Parameters

[in]	*comstring	A character string
[in]	*string2	A second string
[out]	*nletters	Number of letters matched

Returns

0 String mismatch 1 First string finished first 2 Second string finished first

Matches two strings, but stops the comparison as soon as a space or NULL is found in either string. The returned value indicates which string finished first or 0 if the letters before the space or NULL have a mismatch. The routine calls StringToUpper() on `comstring' before the comparison.

• 11.07.90 Original By: ACRM
• 22.04.93 Tidied comments, etc. Added check on malloc and corrected calls to free()
• 07.07.14 Use bl prefix for functions By: CTP

Definition at line 304 of file parse.c.

int blMparse	(	char *	comline,
		int	nkeys,
		MKeyWd *	keywords,
		REAL *	floatparam,
		char **	strparam,
		int *	nparam
	)

Parameters

[in]	*comline	A command line string to parse
[in]	nkeys	Number of keywords
[in]	*keywords	Array of keyword structures
[out]	*floatparam	Array of returned strings
[out]	**strparam	Array of pointers to returned strings
[out]	*nparam	Number of parameters found

Returns

Index of found command or error flag

As blParse(), but allows variable number of parameters to each keyword.

• 23.02.94 Original based on parse() By: ACRM
• 11.03.94 Added $ line handling
• 08.10.99 Initialise nlett to 0
• 07.07.14 Use bl prefix for functions By: CTP

Definition at line 447 of file parse.c.

int blParse	(	char *	comline,
		int	nkeys,
		KeyWd *	keywords,
		REAL *	floatparam,
		char **	strparam
	)

Parameters

[in]	*comline	A command line string to parse
[in]	nkeys	Number of keywords
[in]	*keywords	Array of keyword structures
[out]	*floatparam	Array of returned strings
[out]	**strparam	Array of pointers to returned strings

Returns

Index of found command or error flag

Keyword-based command parser using a fixed number of parameters per command

• 11.07.90 Original By: ACRM
• 22.04.93 Tidied comments, etc. Corrected NULL to 0.
• 11.03.94 Added $ line handling
• 08.10.99 Initialise nlett
• 28.02.11 Added # for comments
• 07.07.14 Use bl prefix for functions By: CTP

Definition at line 202 of file parse.c.