dr.h

Go to the documentation of this file.

/*
 * CDDL HEADER START
 *
 * This file and its contents are supplied under the terms of the
 * Common Development and Distribution License ("CDDL"), version 1.0.
 * You may only use this file in accordance with the terms of version
 * 1.0 of the CDDL.
 *
 * A full copy of the text of the CDDL should have accompanied this
 * source.  A copy of the CDDL is also available via the Internet at
 * http://www.illumos.org/license/CDDL.
 *
 * CDDL HEADER END
*/
/*
 * Copyright 2025 Saso Kiselkov. All rights reserved.
 */
#ifndef _ACFUTILS_DR_H_
#define _ACFUTILS_DR_H_
 
#include <stdbool.h>
#include <stdlib.h>
#include <string.h>
 
#include <XPLMDataAccess.h>
 
#include "helpers.h"
#include "log.h"
#include "types.h"
 
#ifdef  __cplusplus
extern "C" {
#endif
 
#define DR_MAX_NAME_LEN 128
 
typedef struct dr_s dr_t;
 
#ifdef  __INCLUDED_FROM_DR_C__
#define DR_EXT_DEPRECATED
#else
#define DR_EXT_DEPRECATED   DEPRECATED_ATTR
#endif
 
struct dr_s {
    char        name[DR_MAX_NAME_LEN];
    XPLMDataRef dr;
    XPLMDataTypeID  type;
    bool_t      writable;
    bool_t      wide_type;
    void        *value;
    ssize_t     count;
    size_t      stride;
    DR_EXT_DEPRECATED void (*read_cb)(dr_t *dr, void *value_out);
    DR_EXT_DEPRECATED void (*write_cb)(dr_t *dr, void *value_in);
    DR_EXT_DEPRECATED bool_t (*read_scalar_cb)(dr_t *dr, void *value_out);
    DR_EXT_DEPRECATED bool_t (*write_scalar_cb)(dr_t *dr, void *value_in);
    DR_EXT_DEPRECATED int (*read_array_cb)(dr_t *dr, void *values_out,
        int offset, int count);
    DR_EXT_DEPRECATED void (*write_array_cb)(dr_t *dr, void *values_in,
        int offset, int count);
    DR_EXT_DEPRECATED void *cb_userinfo;
};
 
typedef struct {
    bool    writable;
    size_t  count;
    size_t  stride;
    void    (*read_cb)(dr_t *dr, void *value_out);
    void    (*write_cb)(dr_t *dr, void *value_in);
    bool_t  (*read_scalar_cb)(dr_t *dr, void *value_out);
    bool_t  (*write_scalar_cb)(dr_t *dr, void *value_in);
    int (*read_array_cb)(dr_t *dr, void *values_out, int off, int cnt);
    void    (*write_array_cb)(dr_t *dr, void *values_in, int off, int cnt);
    void    *cb_userinfo;
} dr_cfg_t;
 
API_EXPORT bool_t dr_find(dr_t *dr, PRINTF_FORMAT(const char *fmt), ...)
    PRINTF_ATTR(2);
#define fdr_find(dr, ...) \
    do { \
        if (!dr_find(dr, __VA_ARGS__)) { \
            char drname[DR_MAX_NAME_LEN]; \
            snprintf(drname, sizeof (drname), __VA_ARGS__); \
            VERIFY_MSG(0, "dataref \"%s\" not found", drname); \
        } \
    } while (0)
 
API_EXPORT bool_t dr_writable(dr_t *dr);
 
#define DR_DEBUG(__varstr)  log_basename(__FILE__), __LINE__, __varstr
#define DR_DEBUG_VARS   \
    const char *filename, int line, const char *varname
#define dr_geti(__dr)       dr_geti_impl((__dr), DR_DEBUG(#__dr))
API_EXPORT int dr_geti_impl(const dr_t *dr, DR_DEBUG_VARS) HOT_ATTR;
 
#define dr_seti(__dr, __i)  dr_seti_impl((__dr), DR_DEBUG(#__dr), (__i))
API_EXPORT void dr_seti_impl(const dr_t *dr, DR_DEBUG_VARS, int i) HOT_ATTR;
#define dr_getf(__dr)       dr_getf_impl((__dr), DR_DEBUG(#__dr))
API_EXPORT double dr_getf_impl(const dr_t *dr, DR_DEBUG_VARS) HOT_ATTR;
#define dr_setf(__dr, __f)  dr_setf_impl((__dr), DR_DEBUG(#__dr), (__f))
API_EXPORT void dr_setf_impl(const dr_t *dr, DR_DEBUG_VARS, double f) HOT_ATTR;
#define dr_getf_prot(__dr)  dr_getf_prot_impl((__dr), DR_DEBUG(#__dr))
HOT_ATTR static inline double
dr_getf_prot_impl(const dr_t *dr, DR_DEBUG_VARS)
{
    double x = dr_getf_impl(dr, filename, line, varname);
    ASSERT_MSG(!isnan(x) && isfinite(x), "%s:%d: Dataref %s (varname %s) "
        "contains a garbage value (%f). We didn't write that, somebody "
        "else did! Remove extraneous plugins and try to isolate the cause.",
        filename, line, dr->name, varname, x);
    return (x);
}
#define dr_getvi(__dr, __i, __off, __num) \
    dr_getvi_impl((__dr), DR_DEBUG(#__dr), (__i), (__off), (__num))
API_EXPORT int dr_getvi_impl(const dr_t *dr, DR_DEBUG_VARS,
    int *i, unsigned off, unsigned num) HOT_ATTR;
#define dr_setvi(__dr, __i, __off, __num) \
    dr_setvi_impl((__dr), DR_DEBUG(#__dr), (__i), (__off), (__num))
API_EXPORT void dr_setvi_impl(const dr_t *dr, DR_DEBUG_VARS, int *i,
    unsigned off, unsigned num) HOT_ATTR;
#define dr_getvf(__dr, __df, __off, __num) \
    dr_getvf_impl((__dr), DR_DEBUG(#__dr), (__df), (__off), (__num))
API_EXPORT int dr_getvf_impl(const dr_t *dr, DR_DEBUG_VARS, double *df,
    unsigned off, unsigned num) HOT_ATTR;
#define dr_setvf(__dr, __df, __off, __num) \
    dr_setvf_impl((__dr), DR_DEBUG(#__dr), (__df), (__off), (__num))
API_EXPORT void dr_setvf_impl(const dr_t *dr, DR_DEBUG_VARS, double *df,
    unsigned off, unsigned num) HOT_ATTR;
#define dr_getvf32(__dr, __ff, __off, __num) \
    dr_getvf32_impl((__dr), DR_DEBUG(#__dr), (__ff), (__off), (__num))
API_EXPORT int dr_getvf32_impl(const dr_t *dr, DR_DEBUG_VARS, float *ff,
    unsigned off, unsigned num) HOT_ATTR;
#define dr_setvf32(__dr, __ff, __off, __num) \
    dr_setvf32_impl((__dr), DR_DEBUG(#__dr), (__ff), (__off), (__num))
API_EXPORT void dr_setvf32_impl(const dr_t *dr, DR_DEBUG_VARS, float *ff,
    unsigned off, unsigned num) HOT_ATTR;
#define dr_gets(__dr, __str, __cap) \
    dr_gets_impl((__dr), DR_DEBUG(#__dr), (__str), (__cap))
API_EXPORT int dr_gets_impl(const dr_t *dr, DR_DEBUG_VARS, char *str,
    size_t cap) HOT_ATTR;
#define dr_sets(__dr, __str) \
    dr_sets_impl((__dr), DR_DEBUG(#__dr), (__str))
API_EXPORT void dr_sets_impl(const dr_t *dr, DR_DEBUG_VARS, char *str) HOT_ATTR;
/*
 * To read/write raw byte array datarefs, use dr_getbytes/dr_setbytes.
 * The arguments, return values and behavior are identical to XPLMGetDatab
 * and XPLMSetDatab.
 */
 
#define dr_getbytes(__dr, __data, __off, __num) \
    dr_getbytes_impl((__dr), DR_DEBUG(#__dr), (__data), (__off), (__num))
API_EXPORT int dr_getbytes_impl(const dr_t *dr, DR_DEBUG_VARS, void *data,
    unsigned off, unsigned num) HOT_ATTR;
#define dr_setbytes(__dr, __data, __off, __num) \
    dr_setbytes_impl((__dr), DR_DEBUG(#__dr), (__data), (__off), (__num))
API_EXPORT void dr_setbytes_impl(const dr_t *dr, DR_DEBUG_VARS, void *data,
    unsigned off, unsigned num) HOT_ATTR;
 
API_EXPORT void dr_create_i(dr_t *dr, int *value, bool_t writable,
    PRINTF_FORMAT(const char *fmt), ...) PRINTF_ATTR(4);
API_EXPORT void dr_create_i_cfg(dr_t *dr, int *value, dr_cfg_t cfg,
    PRINTF_FORMAT(const char *fmt), ...) PRINTF_ATTR(4);
API_EXPORT void dr_create_f(dr_t *dr, float *value, bool_t writable,
    PRINTF_FORMAT(const char *fmt), ...) PRINTF_ATTR(4);
API_EXPORT void dr_create_f_cfg(dr_t *dr, float *value, dr_cfg_t cfg,
    PRINTF_FORMAT(const char *fmt), ...) PRINTF_ATTR(4);
API_EXPORT void dr_create_f64(dr_t *dr, double *value, bool_t writable,
    PRINTF_FORMAT(const char *fmt), ...) PRINTF_ATTR(4);
API_EXPORT void dr_create_f64_cfg(dr_t *dr, double *value, dr_cfg_t cfg,
    PRINTF_FORMAT(const char *fmt), ...) PRINTF_ATTR(4);
API_EXPORT void dr_create_vi(dr_t *dr, int *value, size_t n, bool_t writable,
    PRINTF_FORMAT(const char *fmt), ...) PRINTF_ATTR(5);
API_EXPORT void dr_create_vi_cfg(dr_t *dr, int *value, dr_cfg_t cfg,
    PRINTF_FORMAT(const char *fmt), ...) PRINTF_ATTR(4);
API_EXPORT void dr_create_vf(dr_t *dr, float *value, size_t n, bool_t writable,
    PRINTF_FORMAT(const char *fmt), ...) PRINTF_ATTR(5);
API_EXPORT void dr_create_vf_cfg(dr_t *dr, float *value, dr_cfg_t cfg,
    PRINTF_FORMAT(const char *fmt), ...) PRINTF_ATTR(4);
API_EXPORT void dr_create_vf64(dr_t *dr, double *value, size_t n,
    bool_t writable, PRINTF_FORMAT(const char *fmt), ...) PRINTF_ATTR(5);
API_EXPORT void dr_create_vf64_cfg(dr_t *dr, double *value, dr_cfg_t cfg,
    PRINTF_FORMAT(const char *fmt), ...) PRINTF_ATTR(4);
API_EXPORT void dr_create_vi_autoscalar(dr_t *dr, int *value, size_t n,
    bool_t writable, PRINTF_FORMAT(const char *fmt), ...) PRINTF_ATTR(5);
API_EXPORT void dr_create_vi_autoscalar_cfg(dr_t *dr, int *value,
    dr_cfg_t cfg, PRINTF_FORMAT(const char *fmt), ...) PRINTF_ATTR(4);
API_EXPORT void dr_create_vf_autoscalar(dr_t *dr, float *value, size_t n,
    bool_t writable, PRINTF_FORMAT(const char *fmt), ...) PRINTF_ATTR(5);
API_EXPORT void dr_create_vf_autoscalar_cfg(dr_t *dr, float *value,
    dr_cfg_t cfg, PRINTF_FORMAT(const char *fmt), ...) PRINTF_ATTR(4);
API_EXPORT void dr_create_vf64_autoscalar(dr_t *dr, double *value, size_t n,
    bool_t writable, PRINTF_FORMAT(const char *fmt), ...) PRINTF_ATTR(5);
API_EXPORT void dr_create_vf64_autoscalar_cfg(dr_t *dr, double *value,
    dr_cfg_t cfg, PRINTF_FORMAT(const char *fmt), ...) PRINTF_ATTR(4);
API_EXPORT void dr_create_b(dr_t *dr, void *value, size_t n, bool_t writable,
    PRINTF_FORMAT(const char *fmt), ...) PRINTF_ATTR(5);
API_EXPORT void dr_create_b_cfg(dr_t *dr, void *value, dr_cfg_t cfg,
    PRINTF_FORMAT(const char *fmt), ...) PRINTF_ATTR(4);
DEPRECATED_ATTR API_EXPORT void dr_array_set_stride(dr_t *dr, size_t stride);
API_EXPORT void dr_delete(dr_t *dr);
API_EXPORT void *dr_get_cb_userinfo(const dr_t REQ_PTR(dr));
 
#ifdef  __cplusplus
}
#endif
 
#endif  /* _ACFUTILS_DR_H_ */