Open-RJ C/C++ User's Journal Synesis Software STLSoft - ... Robust, Lightweight, Cross-platform, Template Software ...

openrj/openrj_memory.h

Go to the documentation of this file.
00001 /* /////////////////////////////////////////////////////////////////////////////
00002  * File:    openrj/openrj_memory.h
00003  *
00004  * Purpose: Memory aspect of the Open-RJ C-API
00005  *
00006  * Created: 11th June 2004
00007  * Updated: 5th March 2006
00008  *
00009  * Home:    http://openrj.org/
00010  *
00011  * Copyright (c) 2004-2006, Matthew Wilson and Synesis Software
00012  * All rights reserved.
00013  *
00014  * Redistribution and use in source and binary forms, with or without
00015  * modification, are permitted provided that the following conditions are met:
00016  *
00017  * - Redistributions of source code must retain the above copyright notice, this
00018  *   list of conditions and the following disclaimer.
00019  * - Redistributions in binary form must reproduce the above copyright notice,
00020  *   this list of conditions and the following disclaimer in the documentation
00021  *   and/or other materials provided with the distribution.
00022  * - Neither the names of Matthew Wilson and Synesis Software nor the names of
00023  *   any contributors may be used to endorse or promote products derived from
00024  *   this software without specific prior written permission.
00025  *
00026  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
00027  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00028  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
00029  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
00030  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
00031  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
00032  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
00033  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
00034  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
00035  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
00036  * POSSIBILITY OF SUCH DAMAGE.
00037  *
00038  * ////////////////////////////////////////////////////////////////////////// */
00039 
00040 
00045 #ifndef OPENRJ_INCL_OPENRJ_H_OPENRJ_MEMORY
00046 #define OPENRJ_INCL_OPENRJ_H_OPENRJ_MEMORY
00047 
00048 /* /////////////////////////////////////////////////////////////////////////////
00049  * Version information
00050  */
00051 
00052 #ifndef OPENRJ_DOCUMENTATION_SKIP_SECTION
00053 # define OPENRJ_VER_OPENRJ_H_OPENRJ_MEMORY_MAJOR    1
00054 # define OPENRJ_VER_OPENRJ_H_OPENRJ_MEMORY_MINOR    0
00055 # define OPENRJ_VER_OPENRJ_H_OPENRJ_MEMORY_REVISION 5
00056 # define OPENRJ_VER_OPENRJ_H_OPENRJ_MEMORY_EDIT     9
00057 #endif /* !OPENRJ_DOCUMENTATION_SKIP_SECTION */
00058 
00059 /* /////////////////////////////////////////////////////////////////////////////
00060  * Includes
00061  */
00062 
00063 #ifndef OPENRJ_INCL_OPENRJ_H_OPENRJ
00064 # error Must include openrj.h before openrj_memory.h. (Actually, you shouldn not really be including this anyway!)
00065 #endif /* !OPENRJ_INCL_OPENRJ_H_OPENRJ */
00066 
00067 #include <stdlib.h>
00068 
00069 /* /////////////////////////////////////////////////////////////////////////////
00070  * Functions
00071  */
00072 
00073 ORJ_CALL(void*) openrj_ator_alloc_(IORJAllocator *ator, size_t cb);
00074 
00075 ORJ_CALL(void*) openrj_ator_realloc_(IORJAllocator *ator, void *pv, size_t cb);
00076 
00077 ORJ_CALL(void) openrj_ator_free_(IORJAllocator *ator, void *pv);
00078 
00079 /* ////////////////////////////////////////////////////////////////////////// */
00080 
00081 #endif /* !OPENRJ_INCL_OPENRJ_H_OPENRJ_MEMORY */
00082 
00083 /* ////////////////////////////////////////////////////////////////////////// */

Open-RJ Library documentation © Synesis Software Pty Ltd, 2004-2005