/
HEAP.CPP
556 lines (496 loc) · 28.9 KB
/
HEAP.CPP
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
//
// Copyright 2020 Electronic Arts Inc.
//
// TiberianDawn.DLL and RedAlert.dll and corresponding source code 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 3 of the License, or (at your option) any later version.
// TiberianDawn.DLL and RedAlert.dll and corresponding source code is distributed
// in the hope that it will be useful, but with permitted additional restrictions
// under Section 7 of the GPL. See the GNU General Public License in LICENSE.TXT
// distributed with this program. You should have received a copy of the
// GNU General Public License along with permitted additional restrictions
// with this program. If not, see https://github.com/electronicarts/CnC_Remastered_Collection
/* $Header: F:\projects\c&c\vcs\code\heap.cpv 2.18 16 Oct 1995 16:49:56 JOE_BOSTIC $ */
/***********************************************************************************************
*** C O N F I D E N T I A L --- W E S T W O O D S T U D I O S ***
***********************************************************************************************
* *
* Project Name : Command & Conquer *
* *
* File Name : HEAP.CPP *
* *
* Programmer : Joe L. Bostic *
* *
* Start Date : 02/18/95 *
* *
* Last Update : May 22, 1995 [JLB] *
* *
*---------------------------------------------------------------------------------------------*
* Functions: *
* FixedIHeapClass::Free -- Frees an object in the heap. *
* FixedHeapClass::FixedHeapClass -- Normal constructor for heap management class. *
* FixedHeapClass::~FixedHeapClass -- Destructor for the heap manager class. *
* FixedHeapClass::Set_Heap -- Assigns a memory block for this heap manager. *
* FixedHeapClass::Allocate -- Allocate a sub-block from the heap. *
* FixedHeapClass::Free -- Frees a sub-block in the heap. *
* FixedHeapClass::ID -- Converts a pointer to a sub-block index number. *
* FixedHeapClass::Clear -- Clears (and frees) the heap manager memory. *
* TFixedIHeapClass::Save -- Saves all active objects *
* TFixedIHeapClass::Load -- Loads all active objects *
* TFixedIHeapClass::Code_Pointers -- codes pointers for every object, to prepare for save *
* TFixedIHeapClass::Decode_Pointers -- Decodes all object pointers, for after loading *
* FixedHeapClass::Free_All -- Frees all objects in the fixed heap. *
* FixedIHeapClass::Free_All -- Frees all objects out of the indexed heap. *
* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
#include "function.h"
#include "heap.h"
//#include <mem.h>
#include <stdio.h>
#include <stddef.h>
#include <conio.h>
#include <string.h>
/***********************************************************************************************
* FixedHeapClass::FixedHeapClass -- Normal constructor for heap management class. *
* *
* This is the normal constructor used for the heap manager class. This initializes *
* the class but doesn't yet assign actual heap memory to this manager. That is handled *
* by the Set_Heap() function. *
* *
* INPUT: size -- The size of the individual sub-blocks in this heap. This value is *
* typically the size of some class or structure. *
* *
* OUTPUT: none *
* *
* WARNINGS: The heap must first be assigned a block of memory to manage before it can *
* be used. *
* *
* HISTORY: *
* 02/21/1995 JLB : Created. *
*=============================================================================================*/
FixedHeapClass::FixedHeapClass(int size)
{
Size = size;
Buffer = 0;
IsAllocated = false;
TotalCount = 0;
ActiveCount = 0;
}
/***********************************************************************************************
* FixedHeapClass::~FixedHeapClass -- Destructor for the heap manager class. *
* *
* This is the default constructor for the heap manager class. It handles freeing the *
* memory assigned to this heap. *
* *
* INPUT: none *
* *
* OUTPUT: none *
* *
* WARNINGS: none *
* *
* HISTORY: *
* 02/21/1995 JLB : Created. *
*=============================================================================================*/
FixedHeapClass::~FixedHeapClass(void)
{
FixedHeapClass::Clear();
}
/***********************************************************************************************
* FixedHeapClass::Set_Heap -- Assigns a memory block for this heap manager. *
* *
* This routine is used to assign a memory heap to this object. A memory heap so assigned *
* will start with all sub-blocks unallocated. After this routine is called, normal *
* allocation and freeing may occur. This routine will allocate necessary memory if the *
* buffer parameter is NULL. *
* *
* INPUT: count -- The number of objects that this heap should manage. *
* *
* buffer -- Pointer to pre-allocated buffer that this manager will use. If this *
* parameter is NULL, then memory will be automatically allocated. *
* *
* OUTPUT: bool; Was the heap successfully initialized? *
* *
* WARNINGS: none *
* *
* HISTORY: *
* 02/21/1995 JLB : Created. *
*=============================================================================================*/
int FixedHeapClass::Set_Heap(int count, void * buffer)
{
/*
** Clear out the old heap data.
*/
Clear();
/*
** If there is no size to the objects in the heap, then this block memory
** handler can NEVER function. Return with a failure condition.
*/
if (!Size) return(false);
/*
** If there is no count specified, then this indicates that the heap should
** be disabled.
*/
if (!count) return(true);
/*
** Initialize the free boolean vector and the buffer for the actual
** allocation objects.
*/
if (FreeFlag.Resize(count)) {
if (!buffer) {
buffer = new char[count * Size];
if (!buffer) {
FreeFlag.Clear();
return(false);
}
IsAllocated = true;
}
Buffer = buffer;
TotalCount = count;
memset((unsigned char *)Buffer, 0x00, count * Size); // Added. Needed to identify bad states in saved games. ST - 10/3/2019 11:49AM
return(true);
}
return(false);
}
/***********************************************************************************************
* FixedHeapClass::Allocate -- Allocate a sub-block from the heap. *
* *
* Finds the first available sub-block in the heap and returns a pointer to it. The sub- *
* block is marked as allocated by this routine. If there are no more sub-blocks *
* available, then this routine will return NULL. *
* *
* INPUT: none *
* *
* OUTPUT: Returns with a pointer to the newly allocated sub-block. *
* *
* WARNINGS: none *
* *
* HISTORY: *
* 02/21/1995 JLB : Created. *
*=============================================================================================*/
void * FixedHeapClass::Allocate(void)
{
if (ActiveCount < TotalCount) {
int index = FreeFlag.First_False();
if (index != -1) {
ActiveCount++;
FreeFlag[index] = true;
return((*this)[index]);
}
}
return(0);
}
/***********************************************************************************************
* FixedHeapClass::Free -- Frees a sub-block in the heap. *
* *
* Use this routine to free a previously allocated sub-block in the heap. *
* *
* INPUT: pointer -- A pointer to the sub-block to free. This is the same pointer that *
* was returned from the Allocate() function. *
* *
* OUTPUT: bool; Was the deallocation successful? Failure could indicate a pointer that *
* doesn't refer to this heap or a null pointer. *
* *
* WARNINGS: none *
* *
* HISTORY: *
* 02/21/1995 JLB : Created. *
*=============================================================================================*/
int FixedHeapClass::Free(void * pointer)
{
if (pointer && ActiveCount) {
int index = ID(pointer);
if (index < TotalCount) {
if (FreeFlag[index]) {
ActiveCount--;
FreeFlag[index] = false;
return(true);
}
}
}
return(false);
}
/***********************************************************************************************
* FixedHeapClass::ID -- Converts a pointer to a sub-block index number. *
* *
* Use this routine to convert a pointer (returned by Allocate) into the sub-block *
* index number. This index number can be used as a form of identifier for the block. *
* *
* INPUT: pointer -- A pointer to the sub-block to conver into an ID number. *
* *
* OUTPUT: Returns with the index (ID) number for the sub-block specified. This number will *
* range between 0 and the sub-block max -1. If -1 is returned, then the pointer *
* was invalid. *
* *
* WARNINGS: none *
* *
* HISTORY: *
* 02/21/1995 JLB : Created. *
*=============================================================================================*/
int FixedHeapClass::ID(void const * pointer)
{
if (pointer && Size) {
return((int)(((char *)pointer - (char *)Buffer) / Size));
}
return(-1);
}
/***********************************************************************************************
* FixedHeapClass::Clear -- Clears (and frees) the heap manager memory. *
* *
* This routine is used to bring the heap manager back into a non-functioning state. All *
* memory allocated by this manager is freeed. Any previous pointers to allocated blocks *
* from this heap are now invalid. *
* *
* INPUT: none *
* *
* OUTPUT: none *
* *
* WARNINGS: none *
* *
* HISTORY: *
* 02/21/1995 JLB : Created. *
*=============================================================================================*/
void FixedHeapClass::Clear(void)
{
/*
** Free the old buffer (if present).
*/
if (Buffer && IsAllocated) {
delete[] Buffer;
}
Buffer = 0;
IsAllocated = false;
ActiveCount = 0;
TotalCount = 0;
FreeFlag.Clear();
}
/***********************************************************************************************
* FixedHeapClass::Free_All -- Frees all objects in the fixed heap. *
* *
* This routine will free all previously allocated objects out of the heap. Use this *
* routine to ensure that the heap is empty. *
* *
* INPUT: none *
* *
* OUTPUT: Was the heap successfully cleared of all objects? *
* *
* WARNINGS: none *
* *
* HISTORY: *
* 05/22/1995 JLB : Created. *
*=============================================================================================*/
int FixedHeapClass::Free_All(void)
{
ActiveCount = 0;
FreeFlag.Reset();
return(true);
}
/////////////////////////////////////////////////////////////////////
/***********************************************************************************************
* FixedIHeapClass::Free_All -- Frees all objects out of the indexed heap. *
* *
* Use this routine to free all previously allocated objects in the heap. This routine will *
* also clear out the allocated object vector as well. *
* *
* INPUT: none *
* *
* OUTPUT: Was the heap successfully cleared of objects? *
* *
* WARNINGS: none *
* *
* HISTORY: *
* 05/22/1995 JLB : Created. *
*=============================================================================================*/
int FixedIHeapClass::Free_All(void)
{
ActivePointers.Delete_All();
return(FixedHeapClass::Free_All());
}
void FixedIHeapClass::Clear(void)
{
FixedHeapClass::Clear();
ActivePointers.Clear();
}
int FixedIHeapClass::Set_Heap(int count, void * buffer)
{
Clear();
if (FixedHeapClass::Set_Heap(count, buffer)) {
ActivePointers.Resize(count);
return(true);
}
return(false);
}
void * FixedIHeapClass::Allocate(void)
{
void * ptr = FixedHeapClass::Allocate();
if (ptr) {
ActivePointers.Add(ptr);
memset (ptr, 0, Size);
}
return(ptr);
}
/***********************************************************************************************
* FixedIHeapClass::Free -- Frees an object in the heap. *
* *
* This routine is used to free an object in the heap. Freeing is accomplished by marking *
* the object's memory as free to be reallocated. The object is also removed from the *
* allocated object pointer vector. *
* *
* INPUT: pointer -- Pointer to the object that is to be removed from the heap. *
* *
* OUTPUT: none *
* *
* WARNINGS: none *
* *
* HISTORY: *
* 02/21/1995 JLB : Created. *
*=============================================================================================*/
int FixedIHeapClass::Free(void * pointer)
{
if (FixedHeapClass::Free(pointer)) {
ActivePointers.Delete(pointer);
}
return(false);
}
#if (0)
/***********************************************************************************************
* TFixedIHeapClass::Save -- Saves all active objects *
* *
* INPUT: file file to write to *
* *
* OUTPUT: true = OK, false = error *
* *
* WARNINGS: none *
* *
* HISTORY: *
* 03/15/1995 BRR : Created. *
*=============================================================================================*/
template<class T>
int TFixedIHeapClass<T>::Save(FileClass &file)
{
int i; // loop counter
int idx; // object index
/*
** Save the number of instances of this class
*/
if (file.Write(&ActiveCount, sizeof(ActiveCount)) != sizeof(ActiveCount)) {
return(false);
}
/*
** Save each instance of this class
*/
for (i = 0; i < ActiveCount; i++) {
/*
** Save the array index of the object, so it can be loaded back into the
** same array location (so TARGET translations will work)
*/
idx = ID(Ptr(i));
if (file.Write(&idx, sizeof(idx)) != sizeof(idx)) {
return(false);
}
/*
** Save the object itself
*/
if (!Ptr(i)->Save(file)) {
return(false);
}
}
return(true);
}
/***********************************************************************************************
* TFixedIHeapClass::Load -- Loads all active objects *
* *
* INPUT: file file to read from *
* *
* OUTPUT: true = OK, false = error *
* *
* WARNINGS: none *
* *
* HISTORY: *
* 03/15/1995 BRR : Created. *
*=============================================================================================*/
template<class T>
int TFixedIHeapClass<T>::Load(FileClass &file)
{
int i; // loop counter
int idx; // object index
T *ptr; // object pointer
int a_count;
/*
** Read the number of instances of this class
*/
if (file.Read(&a_count, sizeof(a_count)) != sizeof(a_count)) {
return(false);
}
/*
** Error if more objects than we can hold
*/
if (a_count > TotalCount) {
return(false);
}
/*
** Read each class instance
*/
for (i = 0; i < a_count; i++) {
/*
** Read the object's array index
*/
if (file.Read (&idx, sizeof(idx)) != sizeof(idx)) {
return(false);
}
/*
** Get a pointer to the object, activate that object
*/
ptr = (T *)(*this)[idx];
FreeFlag[idx] = true;
ActiveCount++;
ActivePointers.Add(ptr);
/*
** Load the object
*/
if (!ptr->Load(file)) {
return(false);
}
}
return(true);
}
/***********************************************************************************************
* TFixedIHeapClass::Code_Pointers -- codes pointers for every object, to prepare for save *
* *
* INPUT: file file to read from *
* *
* OUTPUT: true = OK, false = error *
* *
* WARNINGS: none *
* *
* HISTORY: *
* 03/15/1995 BRR : Created. *
*=============================================================================================*/
template<class T>
void TFixedIHeapClass<T>::Code_Pointers(void)
{
int i;
for (i = 0; i < ActiveCount; i++) {
Ptr(i)->Code_Pointers();
}
}
/***********************************************************************************************
* TFixedIHeapClass::Decode_Pointers -- Decodes all object pointers, for after loading *
* *
* INPUT: file file to read from *
* *
* OUTPUT: true = OK, false = error *
* *
* WARNINGS: none *
* *
* HISTORY: *
* 03/15/1995 BRR : Created. *
*=============================================================================================*/
template<class T>
void TFixedIHeapClass<T>::Decode_Pointers(void)
{
int i;
for (i = 0; i < ActiveCount; i++) {
Ptr(i)->Decode_Pointers();
}
}
#endif