chfPlugin.h

Go to the documentation of this file.

/*************************************************************************\
* Copyright (c) 2010 Brookhaven National Laboratory.
* Copyright (c) 2010 Helmholtz-Zentrum Berlin
* für Materialien und Energie GmbH.
* Copyright (c) 2014 ITER Organization.
* SPDX-License-Identifier: EPICS
* EPICS BASE is distributed subject to a Software License Agreement found
* in file LICENSE that is included with this distribution.
\*************************************************************************/

/*
 * Author: Ralph Lange <[email protected]>
 */

/* Based on the linkoptions utility by Michael Davidsaver (BNL) */

#ifndef CHFPLUGIN_H
#define CHFPLUGIN_H

#include <dbCoreAPI.h>
#include <dbDefs.h>
#include <epicsTypes.h>
#include <dbChannel.h>

struct db_field_log;

#ifdef __cplusplus
extern "C" {
#endif

typedef struct chfPluginIf {

 /* Memory management */
 void * (* allocPvt) (void);

 void (* freePvt) (void *pvt);

 /* Parameter parsing results */
 void (* parse_error) (void *pvt);

 int (* parse_ok) (void *pvt);

 /* Channel operations */
 long (* channel_open) (dbChannel *chan, void *pvt);

 void (* channelRegisterPre) (dbChannel *chan, void *pvt,
 chPostEventFunc **cb_out, void **arg_out,
 db_field_log *probe);

 void (* channelRegisterPost) (dbChannel *chan, void *pvt,
 chPostEventFunc **cb_out, void **arg_out,
 db_field_log *probe);

 void (* channel_report) (dbChannel *chan, void *pvt, int level, const unsigned short indent);

 void (* channel_close) (dbChannel *chan, void *pvt);

} chfPluginIf;

typedef enum chfPluginArg {
 chfPluginArgInvalid=0,
 chfPluginArgBoolean,
 chfPluginArgInt32,
 chfPluginArgDouble,
 chfPluginArgString,
 chfPluginArgEnum
} chfPluginArg;

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

typedef struct chfPluginArgDef {
 const char * name;
 chfPluginArg optType;
 unsigned int required:1;
 unsigned int convert:1;
 unsigned int tagged:1;
 epicsUInt32 tagOffset;
 epicsUInt32 choice;
 epicsUInt32 dataOffset;
 epicsUInt32 size;
 const chfPluginEnumType *enums;
} chfPluginArgDef;

/* Simple arguments */

#define chfInt32(Struct, Member, Name, Req, Conv) \
 {Name, chfPluginArgInt32, Req, Conv, 0, 0, 0, \
 OFFSET(Struct, Member), sizeof( ((Struct*)0)->Member ), NULL}

#define chfBoolean(Struct, Member, Name, Req, Conv) \
 {Name, chfPluginArgBoolean, Req, Conv, 0, 0, 0, \
 OFFSET(Struct, Member), sizeof( ((Struct*)0)->Member ), NULL}

#define chfDouble(Struct, Member, Name, Req, Conv) \
 {Name, chfPluginArgDouble, Req, Conv, 0, 0, 0, \
 OFFSET(Struct, Member), sizeof( ((Struct*)0)->Member ), NULL}

#define chfString(Struct, Member, Name, Req, Conv) \
 {Name, chfPluginArgString, Req, Conv, 0, 0, 0, \
 OFFSET(Struct, Member), sizeof( ((Struct*)0)->Member ), NULL}

#define chfEnum(Struct, Member, Name, Req, Conv, Enums) \
 {Name, chfPluginArgEnum, Req, Conv, 0, 0, 0, \
 OFFSET(Struct, Member), sizeof( ((Struct*)0)->Member ), Enums}

/* Tagged arguments */

#define chfTagInt32(Struct, Member, Name, Tag, Choice, Req, Conv) \
 {Name, chfPluginArgInt32, Req, Conv, 1, OFFSET(Struct, Tag), Choice, \
 OFFSET(Struct, Member), sizeof( ((Struct*)0)->Member ), NULL}

#define chfTagBoolean(Struct, Member, Name, Tag, Choice, Req, Conv) \
 {Name, chfPluginArgBoolean, Req, Conv, 1, OFFSET(Struct, Tag), Choice, \
 OFFSET(Struct, Member), sizeof( ((Struct*)0)->Member ), NULL}

#define chfTagDouble(Struct, Member, Name, Tag, Choice, Req, Conv) \
 {Name, chfPluginArgDouble, Req, Conv, 1, OFFSET(Struct, Tag), Choice, \
 OFFSET(Struct, Member), sizeof( ((Struct*)0)->Member ), NULL}

#define chfTagString(Struct, Member, Name, Tag, Choice, Req, Conv) \
 {Name, chfPluginArgString, Req, Conv, 1, OFFSET(Struct, Tag), Choice, \
 OFFSET(Struct, Member), sizeof( ((Struct*)0)->Member ), NULL}

#define chfTagEnum(Struct, Member, Name, Tag, Choice, Req, Conv, Enums) \
 {Name, chfPluginArgEnum, Req, Conv, 1, OFFSET(Struct, Tag), Choice, \
 OFFSET(Struct, Member), sizeof( ((Struct*)0)->Member ), Enums}

#define chfPluginArgEnd {0}

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

DBCORE_API const char* chfPluginEnumString(const chfPluginEnumType *Enums, int i, const char* def);

DBCORE_API int chfPluginRegister(const char* key, const chfPluginIf *pif, const chfPluginArgDef* opts);

#ifdef __cplusplus
}
#endif

#endif // CHFPLUGIN_H