memblock.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (c) 2016, Fougue Ltd. <http://www.fougue.pro>
** All rights reserved.
**
** Redistribution and use in source and binary forms, with or without
** modification, are permitted provided that the following conditions
** are met:
**
**     1. Redistributions of source code must retain the above copyright
**        notice, this list of conditions and the following disclaimer.
**
**     2. Redistributions in binary form must reproduce the above
**        copyright notice, this list of conditions and the following
**        disclaimer in the documentation and/or other materials provided
**        with the distribution.
**
** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
****************************************************************************/

#ifndef GMIO_MEMBLOCK_H
#define GMIO_MEMBLOCK_H

#include "global.h"

#include <stddef.h>

struct gmio_memblock
{
    void* ptr;

    size_t size;

    void (*func_deallocate)(void* ptr);
};

GMIO_C_LINKAGE_BEGIN

GMIO_API bool gmio_memblock_isnull(const struct gmio_memblock* mblock);

GMIO_API struct gmio_memblock gmio_memblock(
                void* ptr, size_t size, void (*func_deallocate)(void*));

GMIO_API struct gmio_memblock gmio_memblock_malloc(size_t size);

GMIO_API struct gmio_memblock gmio_memblock_calloc(size_t num, size_t size);

GMIO_API struct gmio_memblock gmio_memblock_realloc(void* ptr, size_t size);

GMIO_API void gmio_memblock_deallocate(struct gmio_memblock* mblock);

typedef struct gmio_memblock (*gmio_memblock_constructor_func_t)();

GMIO_API void gmio_memblock_set_default_constructor(
                gmio_memblock_constructor_func_t ctor);

GMIO_API gmio_memblock_constructor_func_t gmio_memblock_default_constructor();

GMIO_API struct gmio_memblock gmio_memblock_default();

GMIO_C_LINKAGE_END

#endif /* GMIO_MEMBLOCK_H */