7035e0f475
Fixed 2 possible buffer overflow bugs Added an entry type string for error/warning messages Implemented default values in macro expansions $(name=default) Improved usefulness of error reporting
214 lines
6.7 KiB
C
214 lines
6.7 KiB
C
/*************************************************************************\
|
|
* Copyright (c) 2002 The University of Chicago, as Operator of Argonne
|
|
* National Laboratory.
|
|
* Copyright (c) 2002 The Regents of the University of California, as
|
|
* Operator of Los Alamos National Laboratory.
|
|
* EPICS BASE Versions 3.13.7
|
|
* and higher are distributed subject to a Software License Agreement found
|
|
* in file LICENSE that is included with this distribution.
|
|
\*************************************************************************/
|
|
/* $Id$
|
|
*
|
|
* Definitions for macro substitution library (macLib)
|
|
*
|
|
* William Lupton, W. M. Keck Observatory
|
|
*/
|
|
|
|
#ifndef INCmacLibH
|
|
#define INCmacLibH
|
|
|
|
/*
|
|
* EPICS include files needed by this file
|
|
*/
|
|
#include "ellLib.h"
|
|
#include "shareLib.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/*
|
|
* Standard FALSE and TRUE macros
|
|
*/
|
|
#ifndef FALSE
|
|
#define FALSE 0
|
|
#endif
|
|
|
|
#ifndef TRUE
|
|
#define TRUE 1
|
|
#endif
|
|
|
|
/*
|
|
* Magic number for validating context.
|
|
*/
|
|
#define MAC_MAGIC 0xbadcafe /* ...sells sub-standard coffee? */
|
|
|
|
/*
|
|
* Maximum size of macro name or value string (simpler to make fixed)
|
|
*/
|
|
#define MAC_SIZE 256
|
|
|
|
/*
|
|
* Special characters
|
|
*/
|
|
#define MAC_STARTCHARS "$" /* characters that indicate macro ref */
|
|
#define MAC_LEFTCHARS "{(" /* characters to left of macro name */
|
|
#define MAC_RIGHTCHARS "})" /* characters to right of macro name */
|
|
#define MAC_SEPARCHARS "," /* characters separating macro defns */
|
|
#define MAC_ASSIGNCHARS "=" /* characters denoting values assignment */
|
|
#define MAC_ESCAPECHARS "\\" /* characters escaping the next char */
|
|
|
|
typedef struct {
|
|
char *start;
|
|
char *left;
|
|
char *right;
|
|
char *separ;
|
|
char *assign;
|
|
char *escape;
|
|
} MAC_CHARS;
|
|
|
|
/*
|
|
* Macro substitution context. One of these contexts is allocated each time
|
|
* macCreateHandle() is called
|
|
*/
|
|
typedef struct {
|
|
long magic; /* magic number (used for authentication) */
|
|
MAC_CHARS chars; /* special characters */
|
|
long dirty; /* values need expanding from raw values? */
|
|
long level; /* scoping level */
|
|
long debug; /* debugging level */
|
|
ELLLIST list; /* macro name / value list */
|
|
int flags; /* operating mode flags */
|
|
} MAC_HANDLE;
|
|
|
|
/*
|
|
* Entry in linked list of macro definitions
|
|
*/
|
|
typedef struct mac_entry {
|
|
ELLNODE node; /* prev and next pointers */
|
|
char *name; /* entry name */
|
|
char *type; /* entry type */
|
|
char *rawval; /* raw (unexpanded) value */
|
|
char *value; /* expanded macro value */
|
|
long length; /* length of value */
|
|
long error; /* error expanding value? */
|
|
long visited; /* ever been visited? */
|
|
long special; /* special (internal) entry? */
|
|
long level; /* scoping level */
|
|
} MAC_ENTRY;
|
|
|
|
/*
|
|
* Function prototypes (core library)
|
|
*/
|
|
epicsShareFunc long /* 0 = OK; <0 = ERROR */
|
|
epicsShareAPI macCreateHandle(
|
|
MAC_HANDLE **handle, /* address of variable to receive pointer */
|
|
/* to new macro substitution context */
|
|
|
|
char *pairs[] /* pointer to NULL-terminated array of */
|
|
/* {name,value} pair strings; a NULL */
|
|
/* value implies undefined; a NULL */
|
|
/* argument implies no macros */
|
|
);
|
|
|
|
epicsShareFunc void
|
|
epicsShareAPI macSuppressWarning(
|
|
MAC_HANDLE *handle, /* opaque handle */
|
|
|
|
int falseTrue /*0 means issue, 1 means suppress*/
|
|
);
|
|
|
|
epicsShareFunc long /* #chars copied, <0 if any macros are */
|
|
/* undefined */
|
|
epicsShareAPI macExpandString(
|
|
MAC_HANDLE *handle, /* opaque handle */
|
|
|
|
const char *src, /* source string */
|
|
|
|
char *dest, /* destination string */
|
|
|
|
long maxlen /* maximum number of characters to copy */
|
|
/* to destination string */
|
|
);
|
|
|
|
|
|
epicsShareFunc long /* length of value */
|
|
epicsShareAPI macPutValue(
|
|
MAC_HANDLE *handle, /* opaque handle */
|
|
|
|
const char *name, /* macro name */
|
|
|
|
const char *value /* macro value */
|
|
);
|
|
|
|
epicsShareFunc long /* #chars copied (<0 if undefined) */
|
|
epicsShareAPI macGetValue(
|
|
MAC_HANDLE *handle, /* opaque handle */
|
|
|
|
const char *name, /* macro name or reference */
|
|
|
|
char *value, /* string to receive macro value or name */
|
|
/* argument if macro is undefined */
|
|
|
|
long maxlen /* maximum number of characters to copy */
|
|
/* to value */
|
|
);
|
|
|
|
epicsShareFunc long /* 0 = OK; <0 = ERROR */
|
|
epicsShareAPI macDeleteHandle(
|
|
MAC_HANDLE *handle /* opaque handle */
|
|
);
|
|
|
|
epicsShareFunc long /* 0 = OK; <0 = ERROR */
|
|
epicsShareAPI macPushScope(
|
|
MAC_HANDLE *handle /* opaque handle */
|
|
);
|
|
|
|
epicsShareFunc long /* 0 = OK; <0 = ERROR */
|
|
epicsShareAPI macPopScope(
|
|
MAC_HANDLE *handle /* opaque handle */
|
|
);
|
|
|
|
epicsShareFunc long /* 0 = OK; <0 = ERROR */
|
|
epicsShareAPI macReportMacros(
|
|
MAC_HANDLE *handle /* opaque handle */
|
|
);
|
|
|
|
/*
|
|
* Function prototypes (utility library)
|
|
*/
|
|
epicsShareFunc long /* #defns encountered; <0 = ERROR */
|
|
epicsShareAPI macParseDefns(
|
|
MAC_HANDLE *handle, /* opaque handle; can be NULL if default */
|
|
/* special characters are to be used */
|
|
|
|
const char *defns, /* macro definitions in "a=xxx,b=yyy" */
|
|
/* format */
|
|
|
|
char **pairs[] /* address of variable to receive pointer */
|
|
/* to NULL-terminated array of {name, */
|
|
/* value} pair strings; all storage is */
|
|
/* allocated contiguously */
|
|
);
|
|
|
|
epicsShareFunc long /* #macros defined; <0 = ERROR */
|
|
epicsShareAPI macInstallMacros(
|
|
MAC_HANDLE *handle, /* opaque handle */
|
|
|
|
char *pairs[] /* pointer to NULL-terminated array of */
|
|
/* {name,value} pair strings; a NULL */
|
|
/* value implies undefined; a NULL */
|
|
/* argument implies no macros */
|
|
);
|
|
|
|
epicsShareFunc char * /* expanded string; NULL if any undefined macros */
|
|
epicsShareAPI macEnvExpand(
|
|
const char *str /* string to be expanded */
|
|
);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /*INCmacLibH*/
|