|
ds@1952
|
1 |
/** |
|
ds@1952
|
2 |
* vim: set ts=4 : |
|
ds@1952
|
3 |
* ============================================================================= |
|
ds@1952
|
4 |
* SourceMod |
|
ds@1952
|
5 |
* Copyright (C) 2004-2008 AlliedModders LLC. All rights reserved. |
|
ds@1952
|
6 |
* ============================================================================= |
|
ds@1952
|
7 |
* |
|
ds@1952
|
8 |
* This program is free software; you can redistribute it and/or modify it under |
|
ds@1952
|
9 |
* the terms of the GNU General Public License, version 3.0, as published by the |
|
ds@1952
|
10 |
* Free Software Foundation. |
|
ds@1952
|
11 |
* |
|
ds@1952
|
12 |
* This program is distributed in the hope that it will be useful, but WITHOUT |
|
ds@1952
|
13 |
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS |
|
ds@1952
|
14 |
* FOR A PARTICULAR PURPOSE. See the GNU General Public License for more |
|
ds@1952
|
15 |
* details. |
|
ds@1952
|
16 |
* |
|
ds@1952
|
17 |
* You should have received a copy of the GNU General Public License along with |
|
ds@1952
|
18 |
* this program. If not, see <http://www.gnu.org/licenses/>. |
|
ds@1952
|
19 |
* |
|
ds@1952
|
20 |
* As a special exception, AlliedModders LLC gives you permission to link the |
|
ds@1952
|
21 |
* code of this program (as well as its derivative works) to "Half-Life 2," the |
|
ds@1952
|
22 |
* "Source Engine," the "SourcePawn JIT," and any Game MODs that run on software |
|
ds@1952
|
23 |
* by the Valve Corporation. You must obey the GNU General Public License in |
|
ds@1952
|
24 |
* all respects for all other code used. Additionally, AlliedModders LLC grants |
|
ds@1952
|
25 |
* this exception to all derivative works. AlliedModders LLC defines further |
|
ds@1952
|
26 |
* exceptions, found in LICENSE.txt (as of this writing, version JULY-31-2007), |
|
ds@1952
|
27 |
* or <http://www.sourcemod.net/license.php>. |
|
ds@1952
|
28 |
* |
|
ds@1952
|
29 |
* Version: $Id$ |
|
ds@1952
|
30 |
*/ |
|
ds@1952
|
31 |
|
|
ds@1952
|
32 |
#ifndef _INCLUDE_SOURCEMOD_ADT_FACTORY_H_ |
|
ds@1952
|
33 |
#define _INCLUDE_SOURCEMOD_ADT_FACTORY_H_ |
|
ds@1952
|
34 |
|
|
ds@1952
|
35 |
#include <IShareSys.h> |
|
ds@1952
|
36 |
|
|
ds@1952
|
37 |
#define SMINTERFACE_ADTFACTORY_NAME "IADTFactory" |
|
ds@1952
|
38 |
#define SMINTERFACE_ADTFACTORY_VERSION 2 |
|
ds@1952
|
39 |
|
|
ds@1952
|
40 |
/** |
|
ds@1952
|
41 |
* @file IADTFactory.h |
|
ds@1952
|
42 |
* @brief Creates abstract data types. |
|
ds@1952
|
43 |
*/ |
|
ds@1952
|
44 |
|
|
ds@1952
|
45 |
namespace SourceMod |
|
ds@1952
|
46 |
{ |
|
ds@1952
|
47 |
/** |
|
ds@1952
|
48 |
* @brief A "Trie" data type. |
|
ds@1952
|
49 |
*/ |
|
ds@1952
|
50 |
class IBasicTrie |
|
ds@1952
|
51 |
{ |
|
ds@1952
|
52 |
public: |
|
ds@1952
|
53 |
/** |
|
ds@1952
|
54 |
* @brief Inserts a key/value pair. |
|
ds@1952
|
55 |
* |
|
ds@1952
|
56 |
* @param key Key string (null terminated). |
|
ds@1952
|
57 |
* @param value Value pointer (may be anything). |
|
ds@1952
|
58 |
* @return True on success, false if key already exists. |
|
ds@1952
|
59 |
*/ |
|
ds@1952
|
60 |
virtual bool Insert(const char *key, void *value) =0; |
|
ds@1952
|
61 |
|
|
ds@1952
|
62 |
/** |
|
ds@1952
|
63 |
* @brief Retrieves the value of a key. |
|
ds@1952
|
64 |
* |
|
ds@1952
|
65 |
* @param key Key string (null terminated). |
|
ds@1952
|
66 |
* @param value Optional pointer to store value pointer. |
|
ds@1952
|
67 |
* @return True on success, false if key was not found. |
|
ds@1952
|
68 |
*/ |
|
ds@1952
|
69 |
virtual bool Retrieve(const char *key, void **value) =0; |
|
ds@1952
|
70 |
|
|
ds@1952
|
71 |
/** |
|
ds@1952
|
72 |
* @brief Deletes a key. |
|
ds@1952
|
73 |
* |
|
ds@1952
|
74 |
* @param key Key string (null terminated). |
|
ds@1952
|
75 |
* @return True on success, false if key was not found. |
|
ds@1952
|
76 |
*/ |
|
ds@1952
|
77 |
virtual bool Delete(const char *key) =0; |
|
ds@1952
|
78 |
|
|
ds@1952
|
79 |
/** |
|
ds@1952
|
80 |
* @brief Flushes the entire trie of all keys. |
|
ds@1952
|
81 |
*/ |
|
ds@1952
|
82 |
virtual void Clear() =0; |
|
ds@1952
|
83 |
|
|
ds@1952
|
84 |
/** |
|
ds@1952
|
85 |
* @brief Destroys the IBasicTrie object and frees all associated |
|
ds@1952
|
86 |
* memory. |
|
ds@1952
|
87 |
*/ |
|
ds@1952
|
88 |
virtual void Destroy() =0; |
|
ds@1952
|
89 |
|
|
ds@1952
|
90 |
/** |
|
ds@1952
|
91 |
* @brief Inserts a key/value pair, replacing an old inserted |
|
ds@1952
|
92 |
* value if it already exists. |
|
ds@1952
|
93 |
* |
|
ds@1952
|
94 |
* @param key Key string (null terminated). |
|
ds@1952
|
95 |
* @param value Value pointer (may be anything). |
|
ds@1952
|
96 |
* @return True on success, false on failure. |
|
ds@1952
|
97 |
*/ |
|
ds@1952
|
98 |
virtual bool Replace(const char *key, void *value) =0; |
|
ds@1952
|
99 |
}; |
|
ds@1952
|
100 |
|
|
ds@1952
|
101 |
class IADTFactory : public SMInterface |
|
ds@1952
|
102 |
{ |
|
ds@1952
|
103 |
public: |
|
ds@1952
|
104 |
/** |
|
ds@1952
|
105 |
* @brief Creates a basic Trie object. |
|
ds@1952
|
106 |
* |
|
ds@1952
|
107 |
* @return A new IBasicTrie object which must be destroyed |
|
ds@1952
|
108 |
* via IBasicTrie::Destroy(). |
|
ds@1952
|
109 |
*/ |
|
ds@1952
|
110 |
virtual IBasicTrie *CreateBasicTrie() =0; |
|
ds@1952
|
111 |
}; |
|
ds@1952
|
112 |
} |
|
ds@1952
|
113 |
|
|
ds@1952
|
114 |
#endif //_INCLUDE_SOURCEMOD_ADT_FACTORY_H_ |
