macCore.c File Reference

#include <ctype.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include "dbDefs.h"
#include "errlog.h"
#include "dbmf.h"
#include "macLib.h"

Include dependency graph for macCore.c:

Go to the source code of this file.

Classes
struct	mac_entry

Macros
#define	MAC_MAGIC   0xbadcafe /* ...sells sub-standard coffee? */
#define	FLAG_SUPPRESS_WARNINGS   0x1
#define	FLAG_USE_ENVIRONMENT   0x80

Typedefs
typedef struct mac_entry	MAC_ENTRY

Functions
long epicsStdCall	macCreateHandle (MAC_HANDLE **pHandle, const char *pairs[])
	Creates a new macro substitution context. More...
void epicsStdCall	macSuppressWarning (MAC_HANDLE *handle, int suppress)
	Disable or enable warning messages. More...
long epicsStdCall	macExpandString (MAC_HANDLE *handle, const char *src, char *dest, long capacity)
	Expand a string which may contain macro references. More...
long epicsStdCall	macPutValue (MAC_HANDLE *handle, const char *name, const char *value)
	Sets the value of a specific macro. More...
long epicsStdCall	macGetValue (MAC_HANDLE *handle, const char *name, char *value, long capacity)
	Returns the value of a macro. More...
long epicsStdCall	macDeleteHandle (MAC_HANDLE *handle)
	Marks a handle invalid, and frees all storage associated with it. More...
long epicsStdCall	macPushScope (MAC_HANDLE *handle)
	Marks the start of a new scoping level. More...
long epicsStdCall	macPopScope (MAC_HANDLE *handle)
	Retrieve the last pushed scope (like stack operations) More...
long epicsStdCall	macReportMacros (MAC_HANDLE *handle)
	Reports details of current definitions. More...

Macro Definition Documentation

#define FLAG_SUPPRESS_WARNINGS   0x1

Definition at line 88 of file macCore.c.

#define FLAG_USE_ENVIRONMENT   0x80

Definition at line 89 of file macCore.c.

#define MAC_MAGIC   0xbadcafe /* ...sells sub-standard coffee? */

Definition at line 83 of file macCore.c.

Typedef Documentation

typedef struct mac_entry MAC_ENTRY

Function Documentation

long epicsStdCall macCreateHandle	(	MAC_HANDLE **	handle,
		const char *	pairs[]
	)

Creates a new macro substitution context.

Returns

0 = OK; <0 = ERROR

Parameters

pHandle	pointer to variable to receive pointer to new macro substitution context
pairs	pointer to NULL-terminated array of {name,value} pair strings. A NULL value implies undefined; a NULL pairs argument implies no macros.

Definition at line 100 of file macCore.c.

{
    MAC_HANDLE *handle;         /* pointer to macro substitution context */

    /* ensure NULL handle pointer is returned on error */
    *pHandle = NULL;

    /* allocate macro substitution context */
    handle = ( MAC_HANDLE * ) dbmfMalloc( sizeof( MAC_HANDLE ) );
    if ( handle == NULL ) {
        errlogPrintf( "macCreateHandle: failed to allocate context\n" );
        return -1;
    }

    /* initialize context */
    handle->magic = MAC_MAGIC;
    handle->dirty = FALSE;
    handle->level = 0;
    handle->debug = 0;
    handle->flags = 0;
    ellInit( &handle->list );

    /* use environment variables if so specified */
    if (pairs && pairs[0] && !strcmp(pairs[0],"") && pairs[1] && !strcmp(pairs[1],"environ") && !pairs[3]) {
        handle->flags |= FLAG_USE_ENVIRONMENT;
    }
    else {
        /* if supplied, load macro definitions */
        for ( ; pairs && pairs[0]; pairs += 2 ) {
            if ( macPutValue( handle, pairs[0], pairs[1] ) < 0 ) {
                dbmfFree( handle );
                return -1;
            }
        }
    }

    /* set returned handle pointer */
    *pHandle = handle;

    return 0;
}

long epicsStdCall macDeleteHandle

(

MAC_HANDLE *

handle

)

Marks a handle invalid, and frees all storage associated with it.

Returns

0 = OK; <0 = ERROR

Note

Note that this does not free any strings into which macro values have been returned. Macro values are always returned into strings which were pre-allocated by the caller.

Parameters

handle

opaque handle

Definition at line 360 of file macCore.c.

{
    MAC_ENTRY *entry, *nextEntry;

    /* check handle */
    if ( handle == NULL || handle->magic != MAC_MAGIC ) {
        errlogPrintf( "macDeleteHandle: NULL or invalid handle\n" );
        return -1;
    }

    /* debug output */
    if ( handle->debug & 1 )
        printf( "macDeleteHandle()\n" );

    /* delete all entries */
    for ( entry = first( handle ); entry != NULL; entry = nextEntry ) {
        nextEntry = next( entry );
        delete( handle, entry );
    }

    /* clear magic field and free context structure */
    handle->magic = 0;
    dbmfFree( handle );

    return 0;
}

long epicsStdCall macExpandString	(	MAC_HANDLE *	handle,
		const char *	src,
		char *	dest,
		long	capacity
	)

Expand a string which may contain macro references.

Returns

Returns the length of the expanded string, <0 if any macro are undefined

This routine parses the src string looking for macro references and passes any it finds to macGetValue() for translation.

Note

The return value is similar to that of macGetValue(). Its absolute value is the number of characters copied to dest. If the return value is negative, at least one undefined macro was left unexpanded.

Parameters

handle	opaque handle
src	source string
dest	destination string
capacity	capacity of destination buffer (dest)

Definition at line 174 of file macCore.c.

{
    MAC_ENTRY entry;
    const char *s;
    char *d;
    long length;

    /* check handle */
    if ( handle == NULL || handle->magic != MAC_MAGIC ) {
        errlogPrintf( "macExpandString: NULL or invalid handle\n" );
        return -1;
    }

    /* debug output */
    if ( handle->debug & 1 )
        printf( "macExpandString( %s, capacity = %ld )\n", src, capacity );

    /* Check size */
    if (capacity <= 1)
        return -1;

    /* expand raw values if necessary */
    if ( expand( handle ) < 0 )
        errlogPrintf( "macExpandString: failed to expand raw values\n" );

    /* fill in necessary fields in fake macro entry structure */
    entry.name  = (char *) src;
    entry.type  = "string";
    entry.error = FALSE;

    /* expand the string */
    s  = src;
    d  = dest;
    *d = '\0';
    trans( handle, &entry, 0, "", &s, &d, d + capacity - 1 );

    /* return +/- #chars copied depending on successful expansion */
    length = d - dest;
    length = ( entry.error ) ? -length : length;

    /* debug output */
    if ( handle->debug & 1 )
        printf( "macExpandString() -> %ld\n", length );

    return length;
}

long epicsStdCall macGetValue	(	MAC_HANDLE *	handle,
		const char *	name,
		char *	value,
		long	capacity
	)

Returns the value of a macro.

Returns

Returns the length of the value string, <0 if undefined

value will be zero-terminated if the length of the value is less than capacity. The return value is the number of characters copied to value (see below for behavior if the macro is undefined). If capacity is zero, no characters will be copied to value (which may be NULL) and the call can be used to check whether the macro is defined.

Note

Truncation of the value is not reported, applications should assume that truncation has occurred if the return value is equal to capacity.

If the macro is undefined, the macro reference will be returned in the value string (if permitted by maxlen) and the function value will be minus the number of characters copied. Note that treatment of capacity is intended to be consistent with the strncpy() routine.

If the value contains macro references, these references will be expanded recursively. This expansion will detect a direct or indirect self reference.

Macro references begin with a "$" immediately followed by either a "(" or a "{" character. The macro name comes next, and may optionally be succeeded by an "=" and a default value, which will be returned if the named macro is undefined at the moment of expansion. A reference is terminated by the matching ")" or "}" character.

Parameters

handle	opaque handle
name	macro name or reference
value	string to receive macro value or name argument if macro is undefined
capacity	capacity of destination buffer (value)

Definition at line 301 of file macCore.c.

{
    MAC_ENTRY   *entry;         /* pointer to this macro's entry structure */
    long        length;         /* number of characters returned */

    /* check handle */
    if ( handle == NULL || handle->magic != MAC_MAGIC ) {
        errlogPrintf( "macGetValue: NULL or invalid handle\n" );
        return -1;
    }

    /* debug output */
    if ( handle->debug & 1 )
        printf( "macGetValue( %s )\n", name );

    /* look up macro name */
    entry = lookup( handle, name, FALSE );

    /* if capacity <= 1 or VALUE == NULL just return -1 / 0 for undefined /
       defined macro */
    if ( capacity <= 1 || value == NULL ) {
        return ( entry == NULL ) ? -1 : 0;
    }

    /* if not found, copy name to value and return minus #chars copied */
    if ( entry == NULL ) {
        strncpy( value, name, capacity );
        return ( value[capacity-1] == '\0' ) ? - (long) strlen( name ) : -capacity;
    }

    /* expand raw values if necessary; if fail (can only fail because of
       memory allocation failure), return same as if not found */
    if ( expand( handle ) < 0 ) {
        errlogPrintf( "macGetValue: failed to expand raw values\n" );
        strncpy( value, name, capacity );
        return ( value[capacity-1] == '\0' ) ? - (long) strlen( name ) : -capacity;
    }

    /* copy value and return +/- #chars copied depending on successful
       expansion */
    strncpy( value, entry->value, capacity );
    length = ( value[capacity-1] == '\0' ) ? entry->length : capacity;

    return ( entry->error ) ? -length : length;
}

long epicsStdCall macPopScope

(

MAC_HANDLE *

handle

)

Retrieve the last pushed scope (like stack operations)

Returns

0 = OK; <0 = ERROR

See macPushScope()

Parameters

handle

opaque handle

Definition at line 427 of file macCore.c.

{
    MAC_ENTRY *entry, *nextEntry;

    /* check handle */
    if ( handle == NULL || handle->magic != MAC_MAGIC ) {
        errlogPrintf( "macPopScope: NULL or invalid handle\n" );
        return -1;
    }

    /* debug output */
    if ( handle->debug & 1 )
        printf( "macPopScope()\n" );

    /* check scoping level isn't already zero */
    if ( handle->level == 0 ) {
        errlogPrintf( "macPopScope: no scope to pop\n" );
        return -1;
    }

    /* look up most recent scope entry */
    entry = lookup( handle, "<scope>", TRUE );
    if ( entry == NULL ) {
        errlogPrintf( "macPopScope: no scope to pop\n" );
        return -1;
    }

    /* delete scope entry and all macros defined since it */
    for ( ; entry != NULL; entry = nextEntry ) {
        nextEntry = next( entry );
        delete( handle, entry );
    }

    /* decrement scoping level */
    handle->level--;

    return 0;
}

long epicsStdCall macPushScope

(

MAC_HANDLE *

handle

)

Marks the start of a new scoping level.

Returns

0 = OK; <0 = ERROR

Marks all macro definitions added after this call as belonging to another scope. These macros will be lost on a macPopScope() call and those at the current scope will be re-instated.

Parameters

handle

opaque handle

Definition at line 392 of file macCore.c.

{
    MAC_ENTRY *entry;

    /* check handle */
    if ( handle == NULL || handle->magic != MAC_MAGIC ) {
        errlogPrintf( "macPushScope: NULL or invalid handle\n" );
        return -1;
    }

    /* debug output */
    if ( handle->debug & 1 )
        printf( "macPushScope()\n" );

    /* increment scoping level */
    handle->level++;

    /* create new "special" entry of name "<scope>" */
    entry = create( handle, "<scope>", TRUE );
    if ( entry == NULL ) {
        handle->level--;
        errlogPrintf( "macPushScope: failed to push scope\n" );
        return -1;
    } else {
        entry->type = "scope marker";
    }

    return 0;
}

long epicsStdCall macPutValue	(	MAC_HANDLE *	handle,
		const char *	name,
		const char *	value
	)

Sets the value of a specific macro.

Returns

Returns the length of the value string.

Note

If value is NULL, all instances of name are undefined at all scoping levels (the named macro doesn't have to exist in this case). Macros referenced in value need not be defined at this point.

Parameters

handle	opaque handle
name	macro name
value	macro value

Definition at line 233 of file macCore.c.

{
    MAC_ENTRY   *entry;         /* pointer to this macro's entry structure */

    /* check handle */
    if ( handle == NULL || handle->magic != MAC_MAGIC ) {
        errlogPrintf( "macPutValue: NULL or invalid handle\n" );
        return -1;
    }

    if ( handle->debug & 1 )
        printf( "macPutValue( %s, %s )\n", name, value ? value : "NULL" );

    /* handle NULL value case: if name was found, delete entry (may be
       several entries at different scoping levels) */
    if ( value == NULL ) {
        /*
         * FIXME: shouldn't be able to delete entries from lower scopes
         * NOTE: when this is changed, this functionality of removing
         * a macro from all scopes will still be needed by iocshEnvClear
         */
        while ( ( entry = lookup( handle, name, FALSE ) ) != NULL ) {
            int done = strcmp(entry->type, "environment variable") == 0;
            delete( handle, entry );

            if (done)
                break;
        }

        return 0;
    }

    /* look up macro name */
    entry = lookup( handle, name, FALSE );

    /* new entry must be created if macro doesn't exist or if it only
       exists at a lower scoping level */
    if ( entry == NULL || entry->level < handle->level ) {
        entry = create( handle, name, FALSE );
        if ( entry == NULL ) {
            errlogPrintf( "macPutValue: failed to create macro %s = %s\n",
                            name, value );
            return -1;
        } else {
            entry->type = "macro";
        }
    }

    /* copy raw value */
    if ( rawval( handle, entry, value ) == NULL ) {
        errlogPrintf( "macPutValue: failed to copy macro %s = %s\n",
                        name, value ) ;
        return -1;
    }

    /* return length of value */
    return strlen( value );
}

long epicsStdCall macReportMacros

(

MAC_HANDLE *

handle

)

Reports details of current definitions.

Returns

0 = OK; <0 = ERROR This sends details of current definitions to standard output, and is intended purely for debugging purposes.

Parameters

handle

opaque handle

Definition at line 471 of file macCore.c.

{
    const char *format = "%-1s %-16s %-16s %s\n";
    MAC_ENTRY *entry;

    /* check handle */
    if ( handle == NULL || handle->magic != MAC_MAGIC ) {
        errlogPrintf( "macReportMacros: NULL or invalid handle\n" );
        return -1;
    }

    /* expand raw values if necessary; report but ignore failure */
    if ( expand( handle ) < 0 )
        errlogPrintf( "macGetValue: failed to expand raw values\n" );

    /* loop through macros, reporting names and values */
    printf( format, "e", "name", "rawval", "value" );
    printf( format, "-", "----", "------", "-----" );
    for ( entry = first( handle ); entry != NULL; entry = next( entry ) ) {

        /* differentiate between "special" (scope marker) and ordinary
           entries */
        if ( entry->special )
            printf( format, "s", "----", "------", "-----" );
        else
            printf( format, entry->error ? "*" : " ", entry->name,
                         entry->rawval ? entry->rawval : "",
                         entry->value  ? entry->value  : "");
    }

    return 0;
}

void epicsStdCall macSuppressWarning	(	MAC_HANDLE *	handle,
		int	falseTrue
	)

Disable or enable warning messages.

The macExpandString() routine prints warnings when it cant expand a macro. This routine can be used to silence those warnings. A non zero value will suppress the warning messages from subsequent library routines given the same handle.

Parameters

handle	opaque handle
suppress	0 means issue, 1 means suppress

Definition at line 154 of file macCore.c.

{
    if ( handle && handle->magic == MAC_MAGIC ) {
        handle->flags = (handle->flags & ~FLAG_SUPPRESS_WARNINGS) |
                        (suppress ? FLAG_SUPPRESS_WARNINGS : 0);
    }
}