libRASCH

Home   General About libRASCH/News Design Screen shots Sample programs (with source code) License   Download libRASCH Tools   Documentation User Developer   Resources Mailing list Supported Formats Plugins Status Links   Contact About this site   Last updated Tue Mar 27 23:03:52 2007

ra_priv.h Go to the documentation of this file. /*---------------------------------------------------------------------------- * * Copyright (C) 2002-2005, Raphael Schneider * See the file COPYING for information on usage and redistribution. * * $Id: ra_priv.h 797 2005-05-10 08:37:10Z rasch $ * *--------------------------------------------------------------------------*/ #ifndef _RA_PRIV_H #define _RA_PRIV_H #ifdef __cplusplus extern "C" { #endif /* do gettext defines first */ #include <libintl.h> #define _(String) gettext (String) #define gettext_noop(String) String #define N_(String) gettext_noop (String) /* #define _(String) (String) #define N_(String) String #define textdomain(Domain) #define bindtextdomain(Package, Directory)*/ #include <ra_defines.h> /* handles evaluations */ #include <ra_eval.h> #include <ra_pl_comm.h> /* ------------------------------ globals ------------------------------ */ /* This variable (set in libRASCH init-function()) controls if debug-infos will be send to stderr. The variable will be set to 1 if the environment variable "LIBRASCH_DEBUG" exists. */ extern int ra_print_debug_infos; /* variables for i18n */ #define MAX_I18N_LEN 250 extern char ra_i18n_codeset[MAX_I18N_LEN]; /* ------------------------------ defines ------------------------------ */ /* standard functions in plugin which _must_ be available in plugin */ #define LOAD_PLUGIN_FUNC "load_ra_plugin" #define INIT_PLUGIN_FUNC "init_ra_plugin" #define FINI_PLUGIN_FUNC "fini_ra_plugin" /* license types for plugins */ #define LICENSE_GPL 0 #define LICENSE_LGPL 1 #define LICENSE_PROPRIETARY 2 #define LICENSE_NOT_CHOOSEN 3 #define _ra_set_error(h, nr, str) _ra_set_error_int(h, nr, str, __FILE__, __LINE__) /* ------------------------------ struct's ------------------------------ */ /* forward declarations */ struct librasch; struct ra_meas; struct ra_rec { unsigned short handle_id; struct ra_rec *next; struct ra_rec *prev; struct ra_rec *child; struct ra_rec *parent; struct ra_meas *meas; void *private_data; /* can be used to store rec. specific info */ }; /* struct ra_rec */ struct ra_session { char name[RA_VALUE_NAME_MAX]; char desc[RA_VALUE_DESC_MAX]; struct ra_rec *root_rec; }; /* struct ra_session */ struct find_meas { unsigned short handle_id; int num; int curr; char **names; }; /* struct find_meas */ struct plugin_infos { char name[RA_VALUE_NAME_MAX]; char desc[RA_VALUE_DESC_MAX]; char file[MAX_PATH_RA]; int use_plugin; unsigned long type; char version[10]; char build_ts[50]; int license; long num_options; struct ra_option_infos *opt; long num_results; struct ra_result_infos *res; long num_create_class; struct ra_auto_create_class *create_class; long num_create_prop; struct ra_auto_create_prop *create_prop; }; /* struct plugin_infos */ struct plugin_access_func { /* check if measurement name is handled by this plugin */ int (*check_meas) (const char *name); int (*find_meas) (const char *dir, struct find_meas * f); meas_handle (*open_meas) (ra_handle ra, const char *name); meas_handle (*new_meas) (const char *dir, const char *name); int (*save_meas) (meas_handle mh); int (*close_meas) (meas_handle mh); int (*get_info_id) (any_handle h, int id, value_handle vh); int (*get_info_idx) (any_handle h, int info_type, int idx, value_handle vh); int (*set_info) (any_handle h, value_handle vh); rec_handle (*rec_add)(meas_handle mh, rec_handle parent); int (*dev_add)(rec_handle rh); int (*ch_add)(rec_handle rh); int (*session_new)(meas_handle mh); size_t(*add_raw)(meas_handle mh, int channel, value_handle vh); size_t(*get_raw) (meas_handle mh, rec_handle rh, int ch, size_t start, size_t num_data, DWORD *data, DWORD *data_high); size_t(*get_raw_unit) (meas_handle mh, rec_handle rh, int ch, size_t start, size_t num_data, double *data); int (*get_eval_info)(meas_handle mh, value_handle vh_name, value_handle vh_desc); long (*get_class_num)(meas_handle mh); int (*get_class_info)(meas_handle mh, long class_num, value_handle vh_id, value_handle vh_name, value_handle vh_desc); long (*get_prop_num)(class_handle clh); int (*get_prop_info)(class_handle clh, long prop_num, value_handle vh_id, value_handle vh_type, value_handle vh_len, value_handle vh_name, value_handle vh_desc, value_handle vh_unit, value_handle vh_use_minmax, value_handle vh_min, value_handle vh_max); int (*get_ev_info)(prop_handle ph, value_handle vh_start, value_handle vh_end); int (*get_ev_value)(prop_handle ph, long event, value_handle vh_value, value_handle vh_ch); long (*get_sum_num)(class_handle clh); int (*get_sum_info)(class_handle clh, long sum_num, value_handle vh_id, value_handle vh_ch, value_handle vh_name, value_handle vh_desc); int (*get_sum_ch_info)(class_handle clh, long sum_num, long ch, value_handle vh_fid_offset, value_handle vh_dim_unit, value_handle vh_dim_name); int (*get_sum_events)(sum_handle sh, value_handle vh_events); int (*get_sum_part_data)(sum_handle sh, long ch, long dim, value_handle vh); }; /* struct plugin_access_func */ struct plugin_process_func { int (*get_info_id) (int id, value_handle vh); proc_handle (*get_proc_handle)(plugin_handle pl); void (*free_proc_handle)(proc_handle proc); int (*do_processing)(proc_handle proc); }; /* struct plugin_process_func */ struct plugin_view_func { int (*check_channels) (rec_handle rh, long ch); int (*check_plugin_usage) (const char *pl_name); int (*get_view) (view_handle vh); }; /* struct plugin_view_func */ struct plugin_struct { unsigned short handle_id; struct plugin_struct *next; struct plugin_struct *prev; void *dl; ra_handle ra; struct plugin_infos info; /* definition in ra_defines.h; will be set _in_ plugin; will be used for get plugin infos */ struct plugin_access_func access; struct plugin_process_func proc; struct plugin_view_func view; /* pointer to function calling gui (e.g. dialogs); this must be available for all type of plugins */ int (*call_gui) (any_handle h); /* for inter-plugin communication */ void (*handle_signal) (meas_handle mh, dest_handle dh, const char *sig_name, int num_para, struct comm_para * p); /* for setting/getting options (no longer used, but perhaps when options used by other plugins, the functions can be useful; therefore they will stay here) */ int (*set_option) (proc_handle proc, char *opt_name, value_handle vh); int (*get_option) (proc_handle proc, char *opt_name, value_handle vh); }; /* struct plugin_struct */ struct plugin_helpers { struct plugin_struct *(*get_plugin)(struct librasch *ra, const char *name); }; /* struct plugin_helpers */ struct config_info { char plugin_dir[MAX_PATH_RA]; char po_dir[MAX_PATH_RA]; }; /* struct config_info */ struct librasch { unsigned short handle_id; struct config_info config; struct plugin_struct *pl_head; /* linked list to all plugins */ struct plugin_helpers hf; /* structure with helper functions */ /* error number: - negative values: os/c-lib specific errors - postive values: libRASCH specific errors */ long error_number; /* a short desc where the error comes from (e.g. libRASCH, plugin-oxford, plugin-hrt) and the name of the source-file (incl. line number) where the error was set */ char *error_from; long err_number_lib; char *err_desc_lib; }; /* struct librasch */ struct eval_info { char filename[MAX_PATH_RA]; struct eval_attribute *attribute; struct eval *evaluations; }; /* struct eval_info */ /* measurement specific structure contains pointers to - plugin which handles measurement, - plugin-private-infos - array with pointers to sessions (which include pointers to recordings) - evaluation(s) of measurement - communication between plugins - scaling-factors for x-axis */ struct ra_meas { unsigned short handle_id; struct librasch *ra; struct plugin_struct *p; /* plugin which handles measurement */ /* plugin-specific infos about this measurement */ void *priv; int num_sessions; struct ra_session *sessions; struct eval_info eval; struct plugin_comm plc; /* scaling factors for the x-axis for every single channel; needed for calculating the position if measurement has different sampling rates */ long num_ch; /* for parameter checking in func ra_get_ch_x_scale() */ double *x_scale; double max_samplerate; }; /* struct ra_meas */ /* Plugins which have options and want to support the getting/setting of options with function calls, can use this structure to store the information. */ struct ra_option_infos { char *name; char *desc; long type; long offset; /* The next element is only needed when the option-type is an array. The variable described will hold the number of elements in the array. It must be from type long. */ long num_offset; /* offset of variable where #elements can be found */ }; /* struct ra_option_infos */ struct ra_result_infos { char *name; char *desc; int type; int def; }; /* struct ra_result_infos */ struct proc_info { unsigned short handle_id; plugin_handle plugin; ra_handle ra; meas_handle mh; rec_handle rh; void (*callback) (const char *text, int percent); long num_options; void *options; long num_result_sets; long num_results; value_handle *results; }; /* struct proc_info */ /* ---------- prototypes ---------- */ /* "external" interface but should only be used from libRASCH or plugin code */ LIBRAAPI void _ra_set_error_int(any_handle h, long error, const char *error_from, const char *src_file, int src_line); LIBRAAPI int ra_eval_save_result(eval_handle eh, class_handle clh, prop_handle ph, proc_handle proc, long res_set); void get_error_text(long err, char *text, int len); /* os specific function; get os/c-lib error or calls get_error_text_ra() */ void get_error_text_ra(long err, char *text, int len); void set_endian_type(); LIBRAAPI int get_endian_type(); void init_i18n(struct librasch *ra); LIBRAAPI int local_to_utf8(const char *src, char *dest, size_t dest_size); LIBRAAPI int local_to_utf8_inplace(char *string, size_t buf_size); LIBRAAPI int utf8_to_local(const char *src, char *dest, size_t dest_size); LIBRAAPI int utf8_to_local_inplace(char *string, size_t buf_size); int read_config(struct librasch *ra); void init_config(struct config_info *conf); #ifdef WIN32 int read_win32_registry(struct librasch *ra); #endif int find_config_file(char *fn); int read_modules(struct librasch *ra); int dload_module(struct librasch *ra, char *file); void close_modules(struct librasch *ra); struct plugin_struct *get_plugin(struct librasch *ra, int index); struct plugin_struct *get_plugin_by_name(struct librasch *r, const char *name); int calc_x_scales(struct ra_meas *meas); int check_handle_type(any_handle h, int id); int get_lib_info(ra_handle ra, int id, value_handle vh); int get_plugin_info(plugin_handle pl, int id, value_handle vh); int get_meas_general_info(meas_handle meas, int id, value_handle vh); int get_session_info(any_handle h, int id, value_handle vh); int get_proc_info(any_handle h, int id, value_handle vh); struct plugin_struct *get_plugin_from_handle(any_handle h); void free_mem(struct ra_value *v); int find_option(const char *name, struct ra_option_infos *infos, int num_opt); int get_option(void *options, struct ra_option_infos *opt_info, value_handle vh, long num_offset); int set_option(void *options, struct ra_option_infos *opt_info, value_handle vh, long num_offset); int valid_value_handle(value_handle vh, int line_num); LIBRAAPI int set_meta_info(value_handle vh, const char *name, const char *desc, int id); int copy_move_meas(meas_handle mh, const char *dest_dir, int copy); int create_auto_class(eval_handle eh, struct ra_auto_create_class *acc, value_handle *res, long res_offset); int create_auto_prop(eval_handle eh, class_handle clh, struct proc_info *pi, struct ra_auto_create_class *acc, struct ra_auto_create_prop *acp, value_handle *res, long res_offset); #ifdef __cplusplus } #endif #endif /* _RA_PRIV_H */