summaryrefslogtreecommitdiff
path: root/sourcemod-1.5-dev/scripting/include/adt_trie.inc
diff options
context:
space:
mode:
authornavewindre <nw@moneybot.cc>2023-11-13 14:28:08 +0100
committernavewindre <nw@moneybot.cc>2023-11-13 14:28:08 +0100
commitda518fdc0f32839730ccdee8098b59c6f842d93f (patch)
treed6f856a6148c0b4d5819f88f068b7287b8044513 /sourcemod-1.5-dev/scripting/include/adt_trie.inc
parentbc678b10830cdaef64bcc592ca2524ebe0fcdc45 (diff)
ya
Diffstat (limited to 'sourcemod-1.5-dev/scripting/include/adt_trie.inc')
-rw-r--r--sourcemod-1.5-dev/scripting/include/adt_trie.inc156
1 files changed, 156 insertions, 0 deletions
diff --git a/sourcemod-1.5-dev/scripting/include/adt_trie.inc b/sourcemod-1.5-dev/scripting/include/adt_trie.inc
new file mode 100644
index 0000000..4e9f120
--- /dev/null
+++ b/sourcemod-1.5-dev/scripting/include/adt_trie.inc
@@ -0,0 +1,156 @@
+/**
+ * vim: set ts=4 sw=4 tw=99 noet :
+ * =============================================================================
+ * SourceMod (C)2004-2008 AlliedModders LLC. All rights reserved.
+ * =============================================================================
+ *
+ * This file is part of the SourceMod/SourcePawn SDK.
+ *
+ * This program is free software; you can redistribute it and/or modify it under
+ * the terms of the GNU General Public License, version 3.0, 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, see <http://www.gnu.org/licenses/>.
+ *
+ * As a special exception, AlliedModders LLC gives you permission to link the
+ * code of this program (as well as its derivative works) to "Half-Life 2," the
+ * "Source Engine," the "SourcePawn JIT," and any Game MODs that run on software
+ * by the Valve Corporation. You must obey the GNU General Public License in
+ * all respects for all other code used. Additionally, AlliedModders LLC grants
+ * this exception to all derivative works. AlliedModders LLC defines further
+ * exceptions, found in LICENSE.txt (as of this writing, version JULY-31-2007),
+ * or <http://www.sourcemod.net/license.php>.
+ *
+ * Version: $Id$
+ */
+
+#if defined _adt_trie_included
+ #endinput
+#endif
+#define _adt_trie_included
+
+/**
+ * Creates a hash map. A hash map is a container that can map strings (called
+ * "keys") to arbitrary values (cells, arrays, or strings). Keys in a hash map
+ * are unique. That is, there is at most one entry in the map for a given key.
+ *
+ * Insertion, deletion, and lookup in a hash map are all considered to be fast
+ * operations, amortized to O(1), or constant time.
+ *
+ * The word "Trie" in this API is historical. As of SourceMod 1.6, tries have
+ * been internally replaced with hash tables, which have O(1) insertion time
+ * instead of O(n).
+ *
+ * @return New Map Handle, which must be freed via CloseHandle().
+ */
+native Handle:CreateTrie();
+
+/**
+ * Sets a value in a hash map, either inserting a new entry or replacing an old one.
+ *
+ * @param map Map Handle.
+ * @param key Key string.
+ * @param value Value to store at this key.
+ * @param replace If false, operation will fail if the key is already set.
+ * @return True on success, false on failure.
+ * @error Invalid Handle.
+ */
+native bool:SetTrieValue(Handle:map, const String:key[], any:value, bool:replace=true);
+
+/**
+ * Sets an array value in a Map, either inserting a new entry or replacing an old one.
+ *
+ * @param map Map Handle.
+ * @param key Key string.
+ * @param array Array to store.
+ * @param num_items Number of items in the array.
+ * @param replace If false, operation will fail if the key is already set.
+ * @return True on success, false on failure.
+ * @error Invalid Handle.
+ */
+native bool:SetTrieArray(Handle:map, const String:key[], const any:array[], num_items, bool:replace=true);
+
+/**
+ * Sets a string value in a Map, either inserting a new entry or replacing an old one.
+ *
+ * @param map Map Handle.
+ * @param key Key string.
+ * @param value String to store.
+ * @param replace If false, operation will fail if the key is already set.
+ * @return True on success, false on failure.
+ * @error Invalid Handle.
+ */
+native bool:SetTrieString(Handle:map, const String:key[], const String:value[], bool:replace=true);
+
+/**
+ * Retrieves a value in a Map.
+ *
+ * @param map Map Handle.
+ * @param key Key string.
+ * @param value Variable to store value.
+ * @return True on success. False if the key is not set, or the key is set
+ * as an array or string (not a value).
+ * @error Invalid Handle.
+ */
+native bool:GetTrieValue(Handle:map, const String:key[], &any:value);
+
+/**
+ * Retrieves an array in a Map.
+ *
+ * @param map Map Handle.
+ * @param key Key string.
+ * @param array Buffer to store array.
+ * @param max_size Maximum size of array buffer.
+ * @param size Optional parameter to store the number of elements written to the buffer.
+ * @return True on success. False if the key is not set, or the key is set
+ * as a value or string (not an array).
+ * @error Invalid Handle.
+ */
+native bool:GetTrieArray(Handle:map, const String:key[], any:array[], max_size, &size=0);
+
+/**
+ * Retrieves a string in a Map.
+ *
+ * @param map Map Handle.
+ * @param key Key string.
+ * @param value Buffer to store value.
+ * @param max_size Maximum size of string buffer.
+ * @param size Optional parameter to store the number of bytes written to the buffer.
+ * @return True on success. False if the key is not set, or the key is set
+ * as a value or array (not a string).
+ * @error Invalid Handle.
+ */
+native bool:GetTrieString(Handle:map, const String:key[], String:value[], max_size, &size=0);
+
+/**
+ * Removes a key entry from a Map.
+ *
+ * @param map Map Handle.
+ * @param key Key string.
+ * @return True on success, false if the value was never set.
+ * @error Invalid Handle.
+ */
+native RemoveFromTrie(Handle:map, const String:key[]);
+
+/**
+ * Clears all entries from a Map.
+ *
+ * @param map Map Handle.
+ * @error Invalid Handle.
+ */
+native ClearTrie(Handle:map);
+
+/**
+ * Retrieves the number of elements in a map.
+ *
+ * @param map Map Handle.
+ * @return Number of elements in the trie.
+ * @error Invalid Handle.
+ */
+native GetTrieSize(Handle:map);