core/sm_memtable.h
author David Anderson <dvander@alliedmods.net>
Wed Aug 01 02:12:47 2007 +0000 (2007-08-01)
changeset 1231 17badaf66ce4
parent 653 ef60870067ff
child 1330 ab94316bb52b
permissions -rw-r--r--
updated more header files (mostly internal now)
dvander@370
     1
/**
ds@653
     2
 * vim: set ts=4 :
dvander@1231
     3
 * ================================================================
dvander@1231
     4
 * SourceMod
dvander@1231
     5
 * Copyright (C) 2004-2007 AlliedModders LLC.  All rights reserved.
dvander@1231
     6
 * ================================================================
dvander@370
     7
 *
dvander@1231
     8
 * This program is free software; you can redistribute it and/or 
dvander@1231
     9
 * modify it under the terms of the GNU General Public License, 
dvander@1231
    10
 * version 3.0, as published by the Free Software Foundation.
dvander@1231
    11
 * 
dvander@1231
    12
 * This program is distributed in the hope that it will be useful,
dvander@1231
    13
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
dvander@1231
    14
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
dvander@1231
    15
 * GNU General Public License for more details.
dvander@1231
    16
 *
dvander@1231
    17
 * You should have received a copy of the GNU General Public License
dvander@1231
    18
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
dvander@1231
    19
 *
dvander@1231
    20
 * As a special exception, AlliedModders LLC gives you permission to 
dvander@1231
    21
 * link the code of this program (as well as its derivative works) to 
dvander@1231
    22
 * "Half-Life 2," the "Source Engine," the "SourcePawn JIT," and any 
dvander@1231
    23
 * Game MODs that run on software by the Valve Corporation.  You must 
dvander@1231
    24
 * obey the GNU General Public License in all respects for all other 
dvander@1231
    25
 * code used. Additionally, AlliedModders LLC grants this exception 
dvander@1231
    26
 * to all derivative works. AlliedModders LLC defines further 
dvander@1231
    27
 * exceptions, found in LICENSE.txt (as of this writing, version 
dvander@1231
    28
 * JULY-31-2007), or <http://www.sourcemod.net/license.php>.
dvander@370
    29
 *
dvander@370
    30
 * Version: $Id$
dvander@370
    31
 */
dvander@370
    32
dvander@203
    33
#ifndef _INCLUDE_SOURCEMOD_CORE_STRINGTABLE_H_
dvander@203
    34
#define _INCLUDE_SOURCEMOD_CORE_STRINGTABLE_H_
dvander@203
    35
dvander@203
    36
class BaseMemTable
dvander@203
    37
{
dvander@203
    38
public:
dvander@203
    39
	BaseMemTable(unsigned int init_size);
dvander@203
    40
	~BaseMemTable();
dvander@203
    41
public:
dvander@203
    42
	/**
dvander@203
    43
	 * Allocates 'size' bytes of memory.
dvander@203
    44
	 * Optionally outputs the address through 'addr'.
dvander@203
    45
	 * Returns an index >= 0 on success, < 0 on failure.
dvander@203
    46
	 */
dvander@203
    47
	int CreateMem(unsigned int size, void **addr);
dvander@203
    48
dvander@203
    49
	/**
dvander@203
    50
	 * Given an index into the memory table, returns its address.
dvander@203
    51
	 * Returns NULL if invalid.
dvander@203
    52
	 */
dvander@203
    53
	void *GetAddress(int index);
dvander@203
    54
dvander@203
    55
	/**
dvander@203
    56
	 * Scraps the memory table.  For caching purposes, the memory 
dvander@203
    57
	 * is not freed, however subsequent calls to CreateMem() will 
dvander@203
    58
	 * begin at the first index again.
dvander@203
    59
	 */
dvander@203
    60
	void Reset();
dvander@404
    61
dvander@404
    62
dvander@203
    63
private:
dvander@203
    64
	unsigned char *membase;
dvander@203
    65
	unsigned int size;
dvander@203
    66
	unsigned int tail;
dvander@203
    67
};
dvander@203
    68
dvander@203
    69
class BaseStringTable
dvander@203
    70
{
dvander@203
    71
public:
dvander@203
    72
	BaseStringTable(unsigned int init_size);
dvander@203
    73
	~BaseStringTable();
dvander@203
    74
public:
dvander@203
    75
	/** 
dvander@203
    76
	 * Adds a string to the string table and returns its index.
dvander@203
    77
	 */
dvander@203
    78
	int AddString(const char *string);
dvander@203
    79
dvander@203
    80
	/**
dvander@203
    81
	 * Given an index into the string table, returns the associated string.
dvander@203
    82
	 */
dvander@293
    83
	inline const char *GetString(int str)
dvander@293
    84
	{
dvander@293
    85
		return (const char *)m_table.GetAddress(str);
dvander@293
    86
	}
dvander@203
    87
dvander@203
    88
	/**
dvander@203
    89
	 * Scraps the string table.  For caching purposes, the memory
dvander@203
    90
	 * is not freed, however subsequent calls to AddString() will 
dvander@203
    91
	 * begin at the first index again.
dvander@203
    92
	 */
dvander@203
    93
	void Reset();
dvander@203
    94
dvander@203
    95
	/**
dvander@203
    96
	 * Returns the parent BaseMemTable that this string table uses.
dvander@203
    97
	 */
dvander@203
    98
	inline BaseMemTable *GetMemTable()
dvander@203
    99
	{
dvander@203
   100
		return &m_table;
dvander@203
   101
	}
dvander@203
   102
private:
dvander@203
   103
	BaseMemTable m_table;
dvander@203
   104
};
dvander@203
   105
dvander@203
   106
#endif //_INCLUDE_SOURCEMOD_CORE_STRINGTABLE_H_