OSFIC.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_C_INTERFACE
#define OSFI_C_INTERFACE 1
 
#include <stdbool.h>
#include <stdint.h>
 
 
#if __STDC_VERSION__ >= 202311L
    #define OSFI_NO_RETURN [[noreturn]] /* In C23: attribute */
#elif __STDC_VERSION__ >= 201112L
    #define OSFI_NO_RETURN _Noreturn /* In C11: keyword */
#else
    #define OSFI_NO_RETURN /* Below C11: nothing */
#endif
 
#if __STDC_VERSION__ >= 202311L
    #define OSFI_DEPRECATED(reason) [[deprecated(reason)]] // In C23: attribute
#else
    #define OSFI_DEPRECATED(reason) // Below C23: nothing
#endif
 
 
void osfiLoggerError(const char *format,...);
 
void osfiLoggerWarning(const char *format,...);
 
void osfiLoggerInfo(const char *format,...);
 
void osfiLoggerDebug(const char *format,...);
 
void osfiLoggerProgress(int n, int m);
 
OSFI_NO_RETURN void osfiLoggerFinishExecution(int errorCode);
 
void osfiLoggerQuality(const char *name, const char *value);
 
void osfiLoggerQualityDouble(const char *name, double value);
 
typedef struct osfi_clp_files {
    int count;
    const char* files[];
} osfi_clp_files_t;
 
typedef struct osfi_clp_args {
    osfi_clp_files_t * config;
    osfi_clp_files_t * input;
    osfi_clp_files_t * output;
} osfi_clp_args_t;
 
osfi_clp_args_t* osfiClpParseArgs(int argc, char *argv[]);
 
void osfiClpFree(osfi_clp_args_t* p);
 
enum osfi_confm_param_type {
    OSFI_CONFM_PT_INTEGER = 1,
    OSFI_CONFM_PT_DOUBLE,
    OSFI_CONFM_PT_BOOLEAN,
    OSFI_CONFM_PT_STRING,
    OSFI_CONFM_PT_FILE,
    OSFI_CONFM_PT_FOLDER,
    OSFI_CONFM_PT_TIME
};
 
typedef struct osfi_paramreader osfi_paramreader_t;
 
enum osfi_confm_val_res {
    OSFI_CONFM_VAL_PASSED = 1,
    OSFI_CONFM_VAL_INVALID,
    OSFI_CONFM_VAL_ERRORS,
};
 
typedef struct osfi_timevalue {
    int16_t year; 
    int8_t month; 
    int8_t dom; 
    int8_t hour; 
    int8_t minute; 
    int8_t sec; 
    int32_t nanosec; 
} osfi_timevalue_t;
 
int osfiTimevalue_cmp(const osfi_timevalue_t *a, const osfi_timevalue_t *b);
 
#define OSFI_STRTYPE struct {\
        int size; \
        char value[]; \
    }
// Note: in order for the generic getters to work, str and file must be different types!
typedef OSFI_STRTYPE osfi_ownstr_t;
typedef OSFI_STRTYPE osfi_ownfile_t;
#undef OSFI_STRTYPE
 
#define OSFI_VECTYPE(T) struct {\
        int count; \
        T values[]; \
    }
typedef OSFI_VECTYPE(int32_t) osfi_vecInteger_t;
typedef OSFI_VECTYPE(double) osfi_vecDouble_t;
typedef OSFI_VECTYPE(bool) osfi_vecBoolean_t;
typedef OSFI_VECTYPE(osfi_timevalue_t) osfi_vecTime_t;
typedef OSFI_VECTYPE(char*) osfi_vecString_t;
typedef OSFI_VECTYPE(char*) osfi_vecFile_t;
#undef OSFI_VECTYPE
 
#define OSFI_MATTYPE(T) struct {\
        int numel; \
        int rows; \
        int cols; \
\
\
\
        T values[];\
    }
typedef OSFI_MATTYPE(int32_t) osfi_matInteger_t;
typedef OSFI_MATTYPE(double) osfi_matDouble_t;
typedef OSFI_MATTYPE(bool) osfi_matBoolean_t;
typedef OSFI_MATTYPE(osfi_timevalue_t) osfi_matTime_t;
typedef OSFI_MATTYPE(char*) osfi_matString_t;
typedef OSFI_MATTYPE(char*) osfi_matFile_t;
#undef OSFI_MATTYPE
 
osfi_paramreader_t* osfiConFmCfgFileOpen(const char* path);
 
void osfiConFmCfgFileClose(osfi_paramreader_t* pr);
 
#if __STDC_VERSION__ >= 201112L
#define osfiConFmParamValue(dest, pr, param) \
    _Generic((dest),\
        int32_t*:            osfiConFmParamValueInteger,\
        double*:             osfiConFmParamValueDouble,\
        bool*:               osfiConFmParamValueBoolean,\
        osfi_timevalue_t*:   osfiConFmParamValueTime,\
        osfi_ownstr_t**:     osfiConFmParamValueString,\
        osfi_ownfile_t**:    osfiConFmParamValueFile,\
        osfi_vecInteger_t**: osfiConFmParamVectorInteger,\
        osfi_vecDouble_t**:  osfiConFmParamVectorDouble,\
        osfi_vecBoolean_t**: osfiConFmParamVectorBoolean,\
        osfi_vecTime_t**:    osfiConFmParamVectorTime,\
        osfi_vecString_t**:  osfiConFmParamVectorString,\
        osfi_vecFile_t**:    osfiConFmParamVectorFile,\
        osfi_matInteger_t**: osfiConFmParamMatrixInteger,\
        osfi_matDouble_t**:  osfiConFmParamMatrixDouble,\
        osfi_matBoolean_t**: osfiConFmParamMatrixBoolean,\
        osfi_matTime_t**:    osfiConFmParamMatrixTime,\
        osfi_matString_t**:  osfiConFmParamMatrixString,\
        osfi_matFile_t**:    osfiConFmParamMatrixFile\
    )((dest), (pr), (param))
 
#define osfiConFmParamArrayLeaf(dest, pr, param, depth, node) \
    _Generic((dest),\
        osfi_vecInteger_t**: osfiConFmParamArrayLeafInteger,\
        osfi_vecDouble_t**:  osfiConFmParamArrayLeafDouble,\
        osfi_vecBoolean_t**: osfiConFmParamArrayLeafBoolean,\
        osfi_vecTime_t**:    osfiConFmParamArrayLeafTime,\
        osfi_vecString_t**:  osfiConFmParamArrayLeafString,\
        osfi_vecFile_t**:    osfiConFmParamArrayLeafFile\
    )((dest), (pr), (param), (depth), (node))
#endif // C11-exclusive generic getters
 // Member group "Basic usage"
 
enum osfi_confm_val_res osfiConFmValidateSchema(osfi_paramreader_t* pr, const char* schemaFile);
 
bool osfiConFmParamExists(osfi_paramreader_t* pr, const char* param);
 
bool osfiConFmGetAllParams(osfi_vecString_t** out, osfi_paramreader_t* pr);
 
bool osfiConFmGetChildParams(osfi_vecString_t** out, osfi_paramreader_t* pr, const char* group);
 // Member group "Queries about a configuration file"
 
bool osfiConFmParamIsArray(osfi_paramreader_t* pr, const char* param);
bool osfiConFmParamLocalName(osfi_ownstr_t** out, osfi_paramreader_t* pr, const char* param);
bool osfiConFmParamDescription(osfi_ownstr_t** out, osfi_paramreader_t* pr, const char* param);
bool osfiConFmParamMinValue(osfi_ownstr_t** out, osfi_paramreader_t* pr, const char* param);
bool osfiConFmParamMaxValue(osfi_ownstr_t** out, osfi_paramreader_t* pr, const char* param);
bool osfiConFmParamUnits(osfi_ownstr_t** out, osfi_paramreader_t* pr, const char* param);
bool osfiConFmParamRawValue(osfi_ownstr_t** out, osfi_paramreader_t* pr, const char* param);
bool osfiConFmParamDimensions(osfi_vecInteger_t** out, osfi_paramreader_t* pr, const char* param);
enum osfi_confm_param_type osfiConFmParamElementType(osfi_paramreader_t* pr, const char* param);
bool osfiConFmParamNodeIsLeaf(osfi_paramreader_t* pr, const char* param, int depth, const int node[depth]);
int osfiConFmParamNodeSize(osfi_paramreader_t* pr, const char* param, int depth, const int node[depth]);
void osfiConFmParamPrint(osfi_paramreader_t* pr, const char* param); // Member group "Non-value queries about a specific parameter"
 
#define OSFI_DECL_TYPED_GETTERS(Type, Tsc) \
    bool osfiConFmParamValue##Type(Tsc* dest, osfi_paramreader_t* pr, const char* param); \
    bool osfiConFmParamVector##Type(osfi_vec##Type##_t** dest, osfi_paramreader_t* pr, const char* param); \
    bool osfiConFmParamMatrix##Type(osfi_mat##Type##_t** dest, osfi_paramreader_t* pr, const char* param); \
    bool osfiConFmParamArrayLeaf##Type(osfi_vec##Type##_t** dest, osfi_paramreader_t* pr, \
            const char* param, int depth, const int node[depth]);
 
OSFI_DECL_TYPED_GETTERS(Integer, int32_t)
OSFI_DECL_TYPED_GETTERS(Double, double)
OSFI_DECL_TYPED_GETTERS(Boolean, bool)
OSFI_DECL_TYPED_GETTERS(Time, osfi_timevalue_t)
OSFI_DECL_TYPED_GETTERS(String, osfi_ownstr_t*)
OSFI_DECL_TYPED_GETTERS(File, osfi_ownfile_t*)
 
#undef OSFI_DECL_TYPED_GETTERS
 // Member group "Typed value getters"
 // Group ConFM
 
#define MAX_LENGTH_FILE_NAME 255
 
OSFI_DEPRECATED("Use osfiClpParseArgs() instead.")
int osfiCLP(int argc, char *argv[]);
 
OSFI_DEPRECATED("Modules with a single configuration file are deprecated.")
void osfiCLPGetConfFile(char * fileName, int *length);
 
OSFI_DEPRECATED("Use osfiClpParseArgs() instead.")
void osfiCLPGetConfFiles(char *confFiles[], int *noFiles);
 
OSFI_DEPRECATED("Use osfiClpParseArgs() instead.")
void osfiCLPGetInputFiles(char *inputFiles[], int *noFiles);
 
OSFI_DEPRECATED("Use osfiClpParseArgs() instead.")
void osfiCLPGetOutputFiles(char *outputFiles[], int *noFiles);
 
# define MAX_LENGTH_STRING 255
# define MAX_PARAMETER_FIELD_SIZE 255
# define MAX_PARAMETER_NAME_SIZE 255
# define MAX_PARAMETER_DESC_SIZE 255
 
typedef enum
{
    ParamInteger = OSFI_CONFM_PT_INTEGER,
    ParamDouble = OSFI_CONFM_PT_DOUBLE,
    ParamBoolean = OSFI_CONFM_PT_BOOLEAN,
    ParamString = OSFI_CONFM_PT_STRING,
    ParamFile = OSFI_CONFM_PT_FILE,
    ParamFolder = OSFI_CONFM_PT_FOLDER,
    ParamTime = OSFI_CONFM_PT_TIME
} ParamType;
 
typedef struct {
    char *name;
    char *description;
    char *value;
    char *units;
    int dims[3];
    char *min;
    char *max;
    ParamType type;
} osfiParameter;
 
OSFI_DEPRECATED("Use osfiConFMReadConfigFile() followed by osfiConFMValidateAgainst()")
int osfiConFMParamReader(const char *fileName, const char *schemaName);
 
OSFI_DEPRECATED("Replaced by osfiConFmCfgFileOpen()")
bool osfiConFMReadConfigFile(const char *fileName);
 
OSFI_DEPRECATED("Replaced by osfiConFmValidateSchema()")
enum osfi_confm_val_res osfiConFMValidateAgainst(const char* schemaFile);
 
void osfiConFMPrintParameters();
 
OSFI_DEPRECATED("Replaced by osfiConFmParamValue() or its family")
void osfiConFMGetIntegerValue(int *value, const char *paramName);
 
OSFI_DEPRECATED("Replaced by osfiConFmParamValue() or its family")
void osfiConFMGetDoubleValue(double *value, const char *paramName);
 
OSFI_DEPRECATED("Replaced by osfiConFmParamValue() or its family")
void osfiConFMGetTimeValue(osfi_timevalue_t *value, const char *paramName);
 
OSFI_DEPRECATED("Replaced by osfiConFmParamValue() or its family")
bool osfiConFMGetBoolValue(const char *paramName);
 
OSFI_DEPRECATED("Replaced by osfiConFmParamValue() or its family")
void osfiConFMGetFileValue(char *param, int *length, const char *paramName);
 
OSFI_DEPRECATED("Replaced by osfiConFmParamValue() or its family")
void osfiConFMGetStringValue(char *param, int *length, const char *paramName);
 
void osfiConFMGetParameter(osfiParameter *param, const char *paramName);
 
void osfiConFMPrintParameter(const char *paramName);
 
OSFI_DEPRECATED("Replaced by osfiConFmParamValue() or its family")
void osfiConFMGetVectorDoubleValues(double *doubleList, int *size,
    const char *paramName);
 
OSFI_DEPRECATED("Replaced by osfiConFmParamValue() or its family")
void osfiConFMGetVectorIntegerValues(int *intList, int *size, const char *paramName);
 
OSFI_DEPRECATED("Replaced by osfiConFmParamValue() or its family")
void osfiConFMGetVectorTimeValues(osfi_timevalue_t *list, int *size, const char *paramName);
 
OSFI_DEPRECATED("Replaced by osfiConFmParamValue() or its family")
void osfiConFMGetVectorStringValues(char *stringList[], int *size, const char *paramName);
 
OSFI_DEPRECATED("Replaced by osfiConFmParamValue() or its family")
void osfiConFMGetVectorFileValues(char *fileList[], int *size, const char *paramName);
 
OSFI_DEPRECATED("Replaced by osfiConFmParamValue() or its family")
void osfiConFMGetVectorBooleanValues(bool *boolList, int *size, const char *paramName);
 
OSFI_DEPRECATED("Replaced by osfiConFmParamArrayLeaf() or its family")
void osfiConFMGetLeafVectorDoubleValues(double *doubleList, int *size,
    const char *paramName, int node[], int depth);
 
OSFI_DEPRECATED("Replaced by osfiConFmParamArrayLeaf() or its family")
void osfiConFMGetLeafVectorIntegerValues(int *intList, int *size, const char *paramName, int node[], int depth);
 
OSFI_DEPRECATED("Replaced by osfiConFmParamArrayLeaf() or its family")
void osfiConFMGetLeafVectorTimeValues(osfi_timevalue_t *list, int *size, const char *paramName, int node[], int depth);
 
OSFI_DEPRECATED("Replaced by osfiConFmParamArrayLeaf() or its family")
void osfiConFMGetLeafVectorStringValues(char *stringList[], int *size, const char *paramName, int node[], int depth);
 
OSFI_DEPRECATED("Replaced by osfiConFmParamArrayLeaf() or its family")
void osfiConFMGetLeafVectorFileValues(char *fileList[], int *size, const char *paramName, int node[], int depth);
 
OSFI_DEPRECATED("Replaced by osfiConFmParamArrayLeaf() or its family")
void osfiConFMGetLeafVectorBooleanValues(bool *boolList, int *size, const char *paramName, int node[], int depth);
 
OSFI_DEPRECATED("Replaced by osfiConFmParamValue() or its family")
void osfiConFMGetMatrixStringValues(char *stringMatrix[], int *rows, int *columns, const char *paramName);
 
OSFI_DEPRECATED("Replaced by osfiConFmParamValue() or its family")
void osfiConFMGetMatrixFileValues(char *fileMatrix[], int *rows, int *columns, const char *paramName);
 
OSFI_DEPRECATED("Replaced by osfiConFmParamValue() or its family")
void osfiConFMGetMatrixBooleanValues(bool *booleanMatrix, int *rows, int *columns, const char *paramName);
 
void osfiConFMfileExist(bool *booleanMatrix, int *rows, int *columns, const char *paramName);
 
OSFI_DEPRECATED("Replaced by osfiConFmParamValue() or its family")
void osfiConFMGetMatrixDoubleValues(double *doubleMatrix, int *rows,
    int *columns, const char *paramName);
 
OSFI_DEPRECATED("Replaced by osfiConFmParamValue() or its family")
void osfiConFMGetMatrixIntegerValues(int *intMatrix, int *rows, int *columns,
    const char *paramName);
 
OSFI_DEPRECATED("Replaced by osfiConFmParamValue() or its family")
void osfiConFMGetMatrixTimeValues(osfi_timevalue_t *intMatrix, int *rows, int *columns,
    const char *paramName);
 
OSFI_DEPRECATED("Replaced by osfiConFmParamDimensions()")
void osfiConFMGetDimension(const char *paramName, int index, int *size);
 
OSFI_DEPRECATED("Replaced by osfiConFmParamNodeSize()")
void osfiConFMGetNodeDimension(const char *paramName, int node[], int depth, int *size);
 
OSFI_DEPRECATED("Replaced by osfiConFmParamNodeIsLeaf()")
bool osfiConFMIsLeaf(const char *paramName, int node[], int depth);
OSFI_DEPRECATED("Replaced by osfiConFmParamDimensions()")
int osfiConFMGetRows(const char *paramName);
 
OSFI_DEPRECATED("Replaced by osfiConFmParamDimensions()")
int osfiConFMGetColumns(const char *paramName);
 
OSFI_DEPRECATED("Replaced by osfiConFmParamExists()")
bool osfiConFMExistParameter(const char *paramName);
 
OSFI_DEPRECATED("Replaced by osfiConFmParamElementType()")
ParamType osfiConFMGetElementType(const char* paramName);
OSFI_DEPRECATED("Replaced by osfiConFmParamIsArray()")
bool osfiConFMIsArray(const char* paramName);
 
int osfiCommonClose();
 
#endif // !defined(OSFI_C_INTERFACE)