lcmaps_arguments.c

Go to the documentation of this file.

/*                                                                                                            
 * Copyright (c) Members of the EGEE Collaboration. 2004.
 * See http://eu-egee.org/partners/ for details on the copyright holders.
 * For license conditions see the license file or
 * http://eu-egee.org/license.html
 */

/*                                                                                                            
 * Copyright (c) 2001 EU DataGrid.                                                                             
 * For license conditions see http://www.eu-datagrid.org/license.html                                          
 *
 * Copyright (c) 2001, 2002 by 
 *     Martijn Steenbakkers <martijn@nikhef.nl>,
 *     David Groep <davidg@nikhef.nl>,
 *     Oscar Koeroo <okoeroo@nikhef.nl>,
 *     NIKHEF Amsterdam, the Netherlands
 */

/*****************************************************************************
                            Include header files
******************************************************************************/
#include <stdio.h>
#include <stdlib.h>
#include <string.h>

/* LCMAPS includes */
#include "lcmaps_arguments.h"

/******************************************************************************
Function:   lcmaps_setArgValue
Description:
    Fill the "value" field of the argument with name "argName" and type "argType"
    with value.
    The argument list is searched for the combination (argName,argType).

Parameters:
    argName: name of argument
    argType: type of argument
    argcx:   number of arguments
    argvx:   array of arguments structures
Returns:
    0:  success
    -1: failure (could not find structure with name argName)
******************************************************************************/

int lcmaps_setArgValue(
        char *argName,
        char *argType,
        void *value,
        int argcx,
        lcmaps_argument_t **argvx
)
{
    int argNo = -1;


    /* find the argument name in the introSpect arguments list */
    if ((argNo = lcmaps_findArgNameAndType(argName, argType, argcx, *argvx)) == -1)
        return -1;

    ((*argvx)[argNo]).value = value;
    return 0;
}


/******************************************************************************
Function:   lcmaps_getArgValue
Description:
    Gets the value of argType from values.
    The place within the lcmaps_argument_t values is determined by the argName listed in 
    lcmaps_argument_t *argvx.
    Returns a void pointer to the value.

Parameters:
    argName: name of argument
    argType: type of argument
    argcx:   number of arguments
    argvx:   array of arguments structures
Returns:
    void pointer to the value or NULL
******************************************************************************/

void *lcmaps_getArgValue(
        char *argName,
        char *argType,
        int argcx,
        lcmaps_argument_t *argvx
)
{
    int argNo = -1;

    /* find the argument name in the introSpect arguments list */
    if ((argNo = lcmaps_findArgNameAndType(argName, argType, argcx, argvx)) == -1)
        return NULL;

    return (argvx[argNo].value);
}


/******************************************************************************
Function:   lcmaps_findArgName
Description:
    Search for argName in the arguments list.
    Returns the index to lcmaps_argument_t element.

Parameters:
    argName: name of argument
    argcx:   number of arguments
    argvx:   array of arguments structures
Returns:
    index to lcmaps_argument_t element
******************************************************************************/

int lcmaps_findArgName(
        char *argName,
        int argcx,
        lcmaps_argument_t *argvx
)
{
    int i = 0;

    for (i = 0; i < argcx; i++)
    {
        if (strcmp(argName, argvx[i].argName) == 0) 
        return i;
    }
    return -1;
}


/******************************************************************************
Function:   lcmaps_findArgNameAndType
Description:
    Search for argName and Type in the arguments list.
    Returns the index to lcmaps_argument_t element.

Parameters:
    argName: name of argument
    argType: type of argument
    argcx:   number of arguments
    argvx:   array of arguments structures
Returns:
    index to lcmaps_argument_t element
******************************************************************************/

int lcmaps_findArgNameAndType(
        char *argName,
        char *argType,
        int argcx,
        lcmaps_argument_t *argvx
)
{
    int i = 0;

    for (i = 0; i < argcx; i++)
    {
        if ((strcmp(argName, argvx[i].argName) == 0) && 
            (strcmp(argType, argvx[i].argType) == 0))
        return i;
    }
    return -1;
}

/******************************************************************************
Function:   lcmaps_cntArgs
Description:
    Count the number of arguments that are defined in a plug-in
    Returns this number.

Parameters:
    argvx:   array of arguments structures
Returns:
    the number of arguments
******************************************************************************/

int lcmaps_cntArgs(lcmaps_argument_t *argvx)
{
    int i = 0;

    while (argvx[i].argName != NULL) { i++; }

    return i;
}

---