env.h

Go to the documentation of this file.

#ifndef CMR_ENV_H
#define CMR_ENV_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <cmr/config.h>
#include <cmr/export.h>
#include <stdbool.h>
#include <stdlib.h>
#include <stdio.h>
#include <assert.h>
 
/* Macro for intended non-use of variables. */
#define CMR_UNUSED(x) (void)(x)
 
 
typedef enum
{
  CMR_OKAY = 0,               
  CMR_ERROR_INPUT = 1,        
  CMR_ERROR_OUTPUT = 2,       
  CMR_ERROR_MEMORY = 3,       
  CMR_ERROR_INVALID = 4,      
  CMR_ERROR_OVERFLOW = 5,     
  CMR_ERROR_TIMEOUT = 6,      
  CMR_ERROR_STRUCTURE = 7,    
  CMR_ERROR_INCONSISTENT = 8, 
  CMR_ERROR_PARAMS = 9,       
} CMR_ERROR;
 
#define CMR_CALL(call) \
  do \
  { \
    CMR_ERROR _cmr_error = call; \
    if (_cmr_error) \
    { \
      if (_cmr_error == CMR_ERROR_INPUT) \
        fprintf(stderr, "User input error"); \
      else if (_cmr_error == CMR_ERROR_OUTPUT) \
        fprintf(stderr, "Error when writing user output"); \
      else if (_cmr_error == CMR_ERROR_MEMORY) \
        fprintf(stderr, "Memory (re)allocation failed"); \
      else if (_cmr_error == CMR_ERROR_INVALID) \
        fprintf(stderr, "Invalid input"); \
      else if (_cmr_error == CMR_ERROR_TIMEOUT) \
        fprintf(stderr, "Time limit exceeded"); \
      else if (_cmr_error == CMR_ERROR_OVERFLOW) \
        fprintf(stderr, "Integer overflow"); \
      else if (_cmr_error == CMR_ERROR_STRUCTURE) \
        fprintf(stderr, "Invalid matrix structure"); \
      else if (_cmr_error == CMR_ERROR_INCONSISTENT) \
        fprintf(stderr, "Inconsistent input"); \
      else if (_cmr_error == CMR_ERROR_PARAMS) \
        fprintf(stderr, "Invalid parameters"); \
      else \
        fprintf(stderr, "Unknown error"); \
      fprintf(stderr, " in %s:%d.\n", __FILE__, __LINE__); \
      return _cmr_error; \
    } \
  } while (false)
 
struct CMR_ENVIRONMENT;
 
typedef struct CMR_ENVIRONMENT CMR;
 
CMR_EXPORT
CMR_ERROR CMRcreateEnvironment(
  CMR** pcmr  
);
 
CMR_EXPORT
CMR_ERROR CMRfreeEnvironment(
  CMR** pcmr  
);
 
#define CMRallocBlock(cmr, ptr) \
  _CMRallocBlock(cmr, (void**) ptr, sizeof(**ptr))
 
CMR_EXPORT
CMR_ERROR _CMRallocBlock(CMR* cmr, void** ptr, size_t size);
 
#define CMRfreeBlock(cmr, ptr) \
  _CMRfreeBlock(cmr, (void**) ptr, sizeof(**ptr))
 
CMR_EXPORT
CMR_ERROR _CMRfreeBlock(CMR* cmr, void** ptr, size_t size);
 
#define CMRallocBlockArray(cmr, ptr, length) \
  _CMRallocBlockArray(cmr, (void**) ptr, sizeof(**ptr), length)
 
CMR_EXPORT
CMR_ERROR _CMRallocBlockArray(CMR* cmr, void** ptr, size_t size, size_t length);
 
#define CMRreallocBlockArray(cmr, ptr, length) \
  _CMRreallocBlockArray(cmr, (void**) ptr, sizeof(**ptr), length)
 
CMR_EXPORT
CMR_ERROR _CMRreallocBlockArray(CMR* cmr, void** ptr, size_t size, size_t length);
 
#define CMRduplicateBlockArray(cmr, ptr, length, source) \
  _CMRduplicateBlockArray(cmr, (void**) ptr, sizeof(**ptr), length, source)
 
CMR_EXPORT
CMR_ERROR _CMRduplicateBlockArray(CMR* cmr, void** ptr, size_t size, size_t length, void* source);
 
#define CMRfreeBlockArray(cmr, ptr) \
  _CMRfreeBlockArray(cmr, (void**) ptr)
 
CMR_EXPORT
CMR_ERROR _CMRfreeBlockArray(CMR* cmr, void** ptr);
 
CMR_EXPORT
char* CMRgetErrorMessage(
  CMR* cmr  
);
 
CMR_EXPORT
void CMRclearErrorMessage(
  CMR* cmr  
);
 
 
#ifdef __cplusplus
}
#endif
 
#endif /* CMR_ENV_H */