Serious-Engine/Sources/Engine/Templates/NameTable.h

73 lines
2.2 KiB
C
Raw Normal View History

2016-03-12 01:20:51 +01:00
/* Copyright (c) 2002-2012 Croteam Ltd.
This program is free software; you can redistribute it and/or modify
it under the terms of version 2 of the GNU General Public License as published by
the Free Software Foundation
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. */
2016-03-11 14:57:17 +01:00
#if !defined(TYPE) || !defined(CNameTableSlot_TYPE) || !defined(CNameTable_TYPE)
#error
#endif
#include <Engine/Templates/StaticArray.h>
class CNameTableSlot_TYPE {
public:
ULONG nts_ulKey; // hashing key
TYPE *nts_ptElement; // the element inhere
CNameTableSlot_TYPE(void) { nts_ptElement = NULL; };
void Clear(void) { nts_ptElement = NULL; };
};
/*
* Template class for storing pointers to objects for fast access by name.
*/
class CNameTable_TYPE {
// implementation:
public:
INDEX nt_ctCompartments; // number of compartments in table
INDEX nt_ctSlotsPerComp; // number of slots in one compartment
INDEX nt_ctSlotsPerCompStep; // allocation step for number of slots in one compartment
CStaticArray<CNameTableSlot_TYPE > nt_antsSlots; // all slots are here
// internal finding
CNameTableSlot_TYPE *FindSlot(ULONG ulKey, const CTString &strName);
// expand the name table to next step
void Expand(void);
// interface:
public:
// default constructor
CNameTable_TYPE(void);
// destructor -- frees all memory
~CNameTable_TYPE(void);
// remove all slots, and reset the nametable to initial (empty) state
void Clear(void);
/* Set allocation parameters. */
void SetAllocationParameters(
INDEX ctCompartments, INDEX ctSlotsPerComp, INDEX ctSlotsPerCompStep);
// find an object by name
TYPE *Find(const CTString &strName);
// add a new object
void Add(TYPE *ptNew);
// remove an object
void Remove(TYPE *ptOld);
// remove all objects but keep slots
void Reset(void);
// get estimated efficiency of the nametable
CTString GetEfficiency(void);
};