common.h

Go to the documentation of this file.

#pragma once
 
#include <MRCMisc/exports.h>
 
#include <stddef.h>
 
#ifdef __APPLE__
#include <stddef.h>
typedef ptrdiff_t MR_int64_t;
typedef size_t MR_uint64_t;
#else
#include <stdint.h>
typedef int64_t MR_int64_t;
typedef uint64_t MR_uint64_t;
#endif
 
 
typedef enum MR_PassBy
{
    MR_PassBy_DefaultConstruct, // Default-construct this parameter, the associated pointer must be null.
    MR_PassBy_Copy, // Copy the object into the function. For most types this doesn't modify the input object, so feel free to cast away constness from it if needed.
    MR_PassBy_Move, // Move the object into the function. The input object remains alive and still needs to be manually destroyed after.
    MR_PassBy_DefaultArgument, // If this function has a default argument value for this parameter, uses that; illegal otherwise. The associated pointer must be null.
    MR_PassBy_NoObject, // This is used to pass no object to the function (functions supporting this will document this fact). This is used e.g. for C++ `std::optional<T>` parameters.
} MR_PassBy;
 
MRC_API void *MR_Alloc(size_t num_bytes);
 
MRC_API void MR_Free(void *ptr);
 
MRC_API void *MR_AllocArray(size_t num_bytes);
 
MRC_API void MR_FreeArray(void *ptr);