ScummVM API documentation
heap.h
1/* ScummVM - Graphic Adventure Engine
2 *
3 * ScummVM is the legal property of its developers, whose names
4 * are too numerous to list here. Please refer to the COPYRIGHT
5 * file distributed with this source distribution.
6 *
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation, either version 3 of the License, or
10 * (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program. If not, see <http://www.gnu.org/licenses/>.
19 *
20 */
21
22#ifndef MADS_CORE_HEAP_H
23#define MADS_CORE_HEAP_H
24
25#include "mads/core/general.h"
26
27namespace MADS {
28
29struct Heap {
30 byte module; /* Identifier for heap module */
31 byte destruct; /* Flag if can be destroyed */
32 char *base; /* Base memory pointer for heap */
33 char *marker; /* Pointer to free area */
34 long base_size; /* Original size of the heap */
35 long size; /* Free space remaining */
36};
37
38extern int heap_create(Heap *heap, int module_id, long heap_size, const char *heap_name);
39extern void heap_destroy(Heap *heap);
40extern void heap_declare(Heap *heap, int module_id, char *buffer, long heap_size);
41
42extern void *heap_get(Heap *heap, long size);
43
44} // namespace MADS
45
46#endif
Definition: heap.h:29