/***************************************************************************
 *   Copyright (C) 2009 by Dominik Seichter                                *
 *   domseichter@web.de                                                    *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU Library General Public License as       *
 *   published by the Free Software Foundation; either version 2 of the    *
 *   License, or (at your option) any later version.                       *
 *                                                                         *
 *   This program 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 General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU Library General Public     *
 *   License along with this program; if not, write to the                 *
 *   Free Software Foundation, Inc.,                                       *
 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 *                                                                         *
 *   In addition, as a special exception, the copyright holders give       *
 *   permission to link the code of portions of this program with the      *
 *   OpenSSL library under certain conditions as described in each         *
 *   individual source file, and distribute linked combinations            *
 *   including the two.                                                    *
 *   You must obey the GNU General Public License in all respects          *
 *   for all of the code used other than OpenSSL.  If you modify           *
 *   file(s) with this exception, you may extend this exception to your    *
 *   version of the file(s), but you are not obligated to do so.  If you   *
 *   do not wish to do so, delete this exception statement from your       *
 *   version.  If you delete this exception statement from all source      *
 *   files in the program, then also delete it here.                       *
 ***************************************************************************/

#ifndef _PDF_MEMORY_MANAGEMENT_H_
#define _PDF_MEMORY_MANAGEMENT_H_

// PdfMemoryManagement.h should not include PdfDefines.h, since it is included by it.
// It should avoid depending on anything defined in PdfDefines.h .

#include "podofoapi.h"
#include <stdlib.h>

namespace PoDoFo {

/**
 * Wrapper around malloc of the c-library used by PoDoFo.
 *
 * Is used to allocate buffers inside of PoDoFo.
 */
PODOFO_API void* podofo_malloc( size_t size );

/**
* Wrapper around calloc of the c-library used by PoDoFo.
*
* Is used to allocate buffers inside of PoDoFo, guarding against count*size size_t overflow.
*/
PODOFO_API void* podofo_calloc( size_t count, size_t size );

/**
 * Wrapper around realloc of the c-library used by PoDoFo.
 */
PODOFO_API void* podofo_realloc( void* buffer, size_t size );

/**
 * Wrapper around free of the c-library used by PoDoFo.
 *
 * Use this to free memory allocated inside of PoDoFo
 * with podofo_malloc.
 */
PODOFO_API void podofo_free( void* buffer );

/**
 * Check during runtime if the current architecture is big- or little-endian.
 * \returns true if the architecture is little-endian
 */
PODOFO_API bool podofo_is_little_endian();

/**
 * Check if multiplying two numbers will overflow. This is crucial when calculating buffer sizes that are the product of two numbers/
 * \returns true if multiplication will overflow
 */
PODOFO_API bool podofo_multiplication_overflow( size_t nmemb, size_t size );

};

#endif // _PDF_MEMORY_MANAGEMENT_H_

