ffi_base.h

Go to the documentation of this file.

/*
 * openSF Integration Libraries (OSFI)
 * Deimos Space, S.L.U.
 * 
 * This file is part of OSFI. OSFI is free software; you can redistribute it
 * and/or modify it under the terms of the 'ESA Software Community Licence Permissive' as
 * published by the European Space Agency; either version 2.4 of the License,
 * or (at your option) any later version. You should have received a
 * copy of the 'ESA Software Community Licence Permissive - v2.4' along with this program
 * or one can be found at <http://eop-cfi.esa.int/index.php/docs-and-mission-data/licensing-documents>.
 */
 
#ifndef OSFI_FFI_BASE_H
#define OSFI_FFI_BASE_H
 
#if __cplusplus >= 201103L || __STDC_VERSION__ >= 202311L
    #define OSFI_FFI_NORETURN [[noreturn]] // C++11 or C23: attribute
#elif __STDC_VERSION__ >= 201112L
    #define OSFI_FFI_NORETURN _Noreturn // C11: keyword
#else
    #define OSFI_FFI_NORETURN
#endif
 
#if __cplusplus >= 201402L || __STDC_VERSION__ >= 202311L
    #define OSFI_FFI_DEPRECATED(reason) [[deprecated(reason)]] // C++14 or C23: attribute
#else
    #define OSFI_FFI_DEPRECATED(reason)
#endif
 
#ifndef __cplusplus
    #include <stdbool.h>
#endif
 
// These are required because directly using a##b does not replace a,b first
#define CONCAT_(A,B) A##B
#define CONCAT(A,B) CONCAT_(A,B)
#define OSFI_FFI_DECL_PLACEHOLDER(name) typedef struct CONCAT(name,_t) name
 
#ifdef OSFI_FFI_IMPL // This macro is defined by the implementation of the FFI layer
    #undef OSFI_FFI_DECL_PLACEHOLDER
    #define OSFI_FFI_DECL_PLACEHOLDER(name) /* Empty in the implementation, which defines everything on its own */
#endif
 
#define OSFI_VEC_T(Tname) OSFI_Vec_T##Tname
#ifndef OSFI_DECL_VEC_T
    #define OSFI_DECL_VEC_T(Tname, Ttype) \
 \
        OSFI_FFI_DECL_PLACEHOLDER(OSFI_VEC_T(Tname))
#endif
 
#define OSFI_DECL_VEC_GETTER_simple(Tname, Ttype) \
 \
    Ttype osfi_confm_vector_##Tname##_get(const OSFI_VEC_T(Tname) *v, int index); \
 \
    int osfi_confm_vector_##Tname##_copyall(const OSFI_VEC_T(Tname) *v, Ttype* arr, int length);
#define OSFI_DECL_VEC_GETTER_str(Tname, Ttype) \
 \
    int osfi_confm_vector_##Tname##_get(const OSFI_VEC_T(Tname) *v, int index, Ttype buf, int bufSz); \
 \
    bool osfi_confm_vector_##Tname##_copyall(const OSFI_VEC_T(Tname) *v, Ttype* strArr, int* itemSz, int* numItems);
 
#define OSFI_DECL_VEC_OPER(Tname, Ttype, kind) \
 \
    int osfi_confm_vector_##Tname##_numel(const OSFI_VEC_T(Tname) *v); \
 \
    void osfi_confm_vector_##Tname##_destroy(OSFI_VEC_T(Tname) ** obj); \
    OSFI_DECL_VEC_GETTER_ ## kind(Tname, Ttype);
 
#define OSFI_DECL_VECTOR(Tname, Ttype, kind) \
    OSFI_DECL_VEC_T(Tname, Ttype); \
    OSFI_DECL_VEC_OPER(Tname, Ttype, kind)
// This is used only in ConFM, but it appears when declaring vector types
OSFI_FFI_DECL_PLACEHOLDER(OSFI_TimeValue); 
#endif /* OSFI_FFI_BASE_H */