scummvm/engines/tinsel/heapmem.h
Max Horn 6591010f66 TINSEL: Further untangle memory managment.
* Add new function MemoryNoAlloc
* Make MemoryAlloc private
* Get rid of params to various memory related functions

svn-id: r45409
2009-10-26 16:01:34 +00:00

80 lines
2.8 KiB
C++

/* ScummVM - Graphic Adventure Engine
*
* ScummVM is the legal property of its developers, whose names
* are too numerous to list here. Please refer to the COPYRIGHT
* file distributed with this source distribution.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU 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 General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
* $URL$
* $Id$
*
* This file contains the handle based Memory Manager defines
*/
#ifndef TINSEL_HEAPMEM_H
#define TINSEL_HEAPMEM_H
#include "tinsel/dw.h" // new data types
namespace Tinsel {
#define NUM_MNODES 192 // the number of memory management nodes (was 128, then 192)
struct MEM_NODE {
MEM_NODE *pNext; // link to the next node in the list
MEM_NODE *pPrev; // link to the previous node in the list
uint8 *pBaseAddr; // base address of the memory object
long size; // size of the memory object
uint32 lruTime; // time when memory object was last accessed
int flags; // allocation attributes
};
// allocation flags for the MemoryAlloc function
/*----------------------------------------------------------------------*\
|* Memory Function Prototypes *|
\*----------------------------------------------------------------------*/
void MemoryInit(void); // initialises the memory manager
// reserves a memory node for a movable & discardable block
MEM_NODE *MemoryNoAlloc();
// allocates a fixed block with the specified number of bytes
void *MemoryAllocFixed(long size);
void MemoryDiscard( // discards the specified memory object
MEM_NODE *pMemNode); // node of the memory object
void *MemoryLock( // locks a memory object and returns a pointer to the first byte of the objects memory block
MEM_NODE *pMemNode); // node of the memory object
void MemoryReAlloc( // changes the size or attributes of a specified memory object
MEM_NODE *pMemNode, // node of the memory object
long size); // new size of block
void MemoryUnlock( // unlocks a memory object
MEM_NODE *pMemNode); // node of the memory object
bool HeapCompact( // Allocates the specified number of bytes from the specified heap
long size, // number of bytes to free up
bool bDiscard); // when set - will discard blocks to fullfill the request
} // End of namespace Tinsel
#endif