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