linkoptions.h

Go to the documentation of this file.

/*************************************************************************\
* Copyright (c) 2010 Brookhaven Science Associates, as Operator of
*     Brookhaven National Laboratory.
* mrfioc2 is distributed subject to a Software License Agreement found
* in file LICENSE that is included with this distribution.
\*************************************************************************/
/*
 * Author: Michael Davidsaver <mdavidsaver@gmail.com>
 */

#ifndef LINKOPTIONS_H
#define LINKOPTIONS_H

#include <shareLib.h>
#include <dbDefs.h>
#include <epicsTypes.h>

#ifdef __cplusplus
extern "C" {
#endif

typedef enum linkOption {
    linkOptionInvalid=0,
    linkOptionInt32,
    linkOptionDouble,
    linkOptionString,
    linkOptionEnum
} linkOption;

typedef struct linkOptionEnumType {
    const char *name;
    const int value;
} linkOptionEnumType;

typedef struct linkOptionDef {
    const char * name;
    linkOption optType;
    int required:1;
    int overwrite:1;
    epicsUInt32 offset;
    epicsUInt32 size;
    const linkOptionEnumType *Enums;
} linkOptionDef;

#define linkInt32(Struct, Member, Name, Req, Over) \
{Name, linkOptionInt32, Req, Over, OFFSET(Struct, Member), sizeof( ((Struct*)0)->Member ), NULL}

#define linkDouble(Struct, Member, Name, Req, Over) \
{Name, linkOptionDouble, Req, Over, OFFSET(Struct, Member), sizeof( ((Struct*)0)->Member ), NULL}

#define linkString(Struct, Member, Name, Req, Over) \
{Name, linkOptionString, Req, Over, OFFSET(Struct, Member), sizeof( ((Struct*)0)->Member ), NULL}

#define linkEnum(Struct, Member, Name, Req, Over, Enums) \
{Name, linkOptionEnum, Req, Over, OFFSET(Struct, Member), sizeof( ((Struct*)0)->Member ), Enums}

#define linkOptionEnd {0,linkOptionInvalid,0,0,0,0,NULL}

/* Extra output when parsing and converting */
#define LINKOPTIONDEBUG 1

epicsShareFunc
int
epicsShareAPI
linkOptionsStore(const linkOptionDef* opts, void* user, const char* str, int options);

epicsShareFunc
const char*
epicsShareAPI
linkOptionsEnumString(const linkOptionEnumType *Enums, int i, const char* def);

#ifdef __cplusplus
}
#endif

#endif /* LINKOPTIONS_H */