CAENAllocator.h

Go to the documentation of this file.

/******************************************************************************
*
*   CAEN SpA - Software Division
*   Via Vetraia, 11 - 55049 - Viareggio ITALY
*   +39 0594 388 398 - www.caen.it
*
*******************************************************************************
*
*   Copyright (C) 2019-2022 CAEN SpA
*
*   This file is part of the CAEN Utility.
*
*   The CAEN Utility is free software; you can redistribute it and/or
*   modify it under the terms of the GNU Lesser General Public
*   License as published by the Free Software Foundation; either
*   version 3 of the License, or (at your option) any later version.
*
*   The CAEN Utility is distributed in the hope that it will be useful,
*   but WITHOUT ANY WARRANTY; without even the implied warranty of
*   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
*   Lesser General Public License for more details.
*
*   You should have received a copy of the GNU Lesser General Public
*   License along with the CAEN Utility; if not, see
*   https://www.gnu.org/licenses/.
*
*   SPDX-License-Identifier: LGPL-3.0-or-later
*
******************************************************************************
*
*   \file       CAENAllocator.h
*   \brief      Utilities to handle memory allocation in C minimizing memory leaks
*   \author     Francesco Pepe
*
******************************************************************************/

#ifndef CAEN_INCLUDE_CAENALLOCATOR_H_
#define CAEN_INCLUDE_CAENALLOCATOR_H_

#ifdef __cplusplus
extern "C" {
#endif

#include <stdint.h>

#include <types/CAENAllocatorTypes.h>
#include <CAENUtility.h>

c_nodiscard
CAEN_UTILITY_DLLAPI c_allocator_t CAEN_UTILITY_API c_allocator_create();

c_nodiscard
CAEN_UTILITY_DLLAPI void* CAEN_UTILITY_API c_allocator_resource_create(c_allocator_t* allocator, c_resource_destroy_function df, void* resource);

c_nodiscard c_declspec_allocator c_attribute_malloc c_attribute_alloc_size(2)
CAEN_UTILITY_DLLAPI void* CAEN_UTILITY_API c_allocator_malloc(c_allocator_t* allocator, size_t size);

c_nodiscard c_declspec_allocator c_attribute_malloc c_attribute_alloc_size(2, 3)
CAEN_UTILITY_DLLAPI void* CAEN_UTILITY_API c_allocator_calloc(c_allocator_t* allocator, size_t nmemb, size_t size);

// TODO: realloc: search the list for an element and realloc it if found. Manage pointer changes and case of new allocation.

c_nodiscard
CAEN_UTILITY_DLLAPI int32_t CAEN_UTILITY_API c_allocator_error_count(const c_allocator_t* allocator);

CAEN_UTILITY_DLLAPI void CAEN_UTILITY_API c_allocator_release(c_allocator_t* allocator, void* ptr);

CAEN_UTILITY_DLLAPI void CAEN_UTILITY_API c_allocator_clear(c_allocator_t* allocator);

CAEN_UTILITY_DLLAPI void CAEN_UTILITY_API c_allocator_free(c_allocator_t* allocator, void* ptr);

CAEN_UTILITY_DLLAPI void CAEN_UTILITY_API c_allocator_freeall(c_allocator_t* allocator);

#define c_allocator_freeall_and_return(A, R) (c_allocator_freeall(A), R)

// TODO: free a single element: search the linkedlist for such element, free and remove it from list

#ifdef __cplusplus
}
#endif

#endif // CAEN_INCLUDE_CAENALLOCATOR_H_