pipeline.h

Go to the documentation of this file.

/*
 *    Pipeline Transformer Module
 *
 *    Copyright CAPLIN Systems Ltd 2000-2013
 *
 *    $Author$
 *    $DateTime$
 *    $Change$
 *    $Id$
 *
 *    Public API into the pipeline module
 */

#ifndef PIPELINE_H
#define PIPELINE_H


#include "transformer.h"

#ifndef WIN32
#ifndef MODULEAPI
#define MODULEAPI
#endif
#else /* WIN32 */
#ifndef MODULEAPI
#define MODULEAPI _declspec(dllimport)
#endif
#endif /* WIN32 */


#define EMBED_LUA                /* We only support lua at the moment */

typedef struct _pipeline pipeline_t;
typedef struct pipeline_argument_s pipeline_argument_t;

struct _pipeline {
    void            (*recv_update)(pipeline_t *pipeline, int feed, ds_data_t *dsdata, time_t tim, int update_from_memory_file);  
    void            (*recv_nodata)(pipeline_t *pipeline, int feed, const char *subject, int flags);       
    void            (*recv_status)(pipeline_t *pipeline, int feed, const char *subject, int status, int code, char *status_message);  
    int             (*handle_request)(pipeline_t *pipeline, int feed, const char *subject);  
    int             (*handle_discard)(pipeline_t *pipeline, int feed, const char *subject);  
    void            (*recv_udp_signal)(pipeline_t *pipeline, const char *msg);       
    int             (*exec_function)(pipeline_t *pipe, const char *func, int argc, char *argv[]); /* Execute an arbitrary function */
    int             (*exec_with_args)(pipeline_t *pipe, const char *func, int num_args, pipeline_argument_t *args);
    int             (*exec_with_args_ret)(pipeline_t *pipe, const char *func, int num_args, pipeline_argument_t *args, pipeline_argument_t *ret_args);
};

typedef struct {
    char            *initialise; 
    char            *update;     
    char            *nodata;     
    char            *status;     
    char            *request;    
    char            *discard;    
    char            *udpsig;     
} pipeline_eventnames_t;

typedef enum {
    PIPELINE_INTEGER = 0,        
    PIPELINE_STRING,             
    PIPELINE_FLOAT,              
    PIPELINE_DSDATA,             
    PIPELINE_COUNTER,            
    PIPELINE_NULL,               
    PIPELINE_ARRAY,              
    PIPELINE_MAP,                
    PIPELINE_BOOLEAN,            
    PIPELINE_DSDATA_NO_FREE,     
} pipeline_datatype_t;


struct pipeline_argument_s {
    pipeline_datatype_t type;
    int                 size;
    union {
        int                      num;
        double                   fnum;
        const char              *str;
        ds_data_t               *dsdata;
        pipeline_argument_t     *values;
    } value;
};



#ifdef EMBED_LUA
#define NATIVE_FUNC(funcname,paramname)     pipeline_return_type_t (funcname)(void *(paramname))
typedef int         pipeline_return_type_t;
typedef pipeline_return_type_t     (*pipeline_cb)(void *state);
#endif


typedef struct {
    const char      *lua_name;            
    const char      *js_name;             
    int            (*func)(void *state);  
} pipeline_module_func_t;

typedef struct {
    char         *name;                    
    int           value;                   
    const char   *string;                  
} pipeline_module_const_t;

typedef struct {
    int           version;           
    int           patch;             
    /* Functions for user extensions */
    int         (*pipeline_register_function)(char *name, pipeline_cb callback);
    int         (*pipeline_getarg)(void *state, int argnum, pipeline_datatype_t type, void *dest);
    int         (*pipeline_setret)(void *state, pipeline_datatype_t type, void *retval);
    pipeline_return_type_t (*pipeline_return)(void *state);
    /* Functions to control the generation and execution of a pipeline */
    pipeline_t *(*pipeline_generate)(char *file,  pipeline_eventnames_t *eventnames);
    int (*pipeline_initialise)(pipeline_t *pipe);
    int         (*pipeline_release)(pipeline_t *pipeline);
    /* Functions to store and retrieve data items from the object's database */
    int         (*pipeline_database_insert)(const char *symbol, const char *key, pipeline_datatype_t type, void *dataptr);
    int         (*pipeline_database_retrieve)(const char *symbol, const char *key, pipeline_datatype_t *type, void **dataptr);
    int         (*pipeline_database_delete)(const char *symbol);
    int         (*pipeline_register_function_closure)(char *name, pipeline_cb callback, void *closure);
    void       *(*pipeline_get_closure)(void *state);
    int         (*pipeline_setret_array)(void *state, int num, char **array);
    int         (*pipeline_setret_map)(void *state, int num, char **map_values);
     int         (*pipeline_getarg_from_map)(void *state, int argnum, const char *key, pipeline_datatype_t type, void *dest);
     int         (*pipeline_getarg_map_keys)(void *state, int argnum, char ***dest);
    pipeline_t *(*pipeline_generate_with_log)(char *file, ds_log_t *logfile, pipeline_eventnames_t *eventnames);
    int         (*pipeline_get_num_args)(void *state);
    int         (*pipeline_register_library)(const char *libname, const pipeline_module_func_t *funcs, const pipeline_module_const_t *constants);
    int         (*pipeline_call_func)(void *state, int argnum, pipeline_argument_t *args, int num_args);
} pipeline_interface_t;





#endif /* PIPELINE_H */