core/sm_trie.h
author Erik Minekus <erik@minekus.com>
Thu Aug 01 09:26:34 2013 -0400 (2013-08-01)
changeset 3967 ceafb87d38a7
parent 2289 44045ead61cd
permissions -rw-r--r--
Numerous code documentation fixups (bug 5720, r=psychonic).
     1 /**
     2  * vim: set ts=4 :
     3  * =============================================================================
     4  * SourceMod
     5  * Copyright (C) 2004-2008 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_SIMPLE_TRIE_H_
    33 #define _INCLUDE_SOURCEMOD_SIMPLE_TRIE_H_
    34 
    35 struct Trie;
    36 
    37 typedef void (*SM_TRIE_BAD_ITERATOR)(Trie *pTrie, const char *key, void **value, void *data);
    38 
    39 Trie *sm_trie_create();
    40 void sm_trie_destroy(Trie *trie);
    41 bool sm_trie_insert(Trie *trie, const char *key, void *value);
    42 bool sm_trie_replace(Trie *trie, const char *key, void *value);
    43 bool sm_trie_retrieve(Trie *trie, const char *key, void **value);
    44 bool sm_trie_delete(Trie *trie, const char *key);
    45 void sm_trie_clear(Trie *trie);
    46 size_t sm_trie_mem_usage(Trie *trie);
    47 void sm_trie_bad_iterator(Trie *trie,
    48 						  char *buffer,
    49 						  size_t maxlength,
    50 						  SM_TRIE_BAD_ITERATOR iter,
    51 						  void *data);
    52 
    53 #endif //_INCLUDE_SOURCEMOD_SIMPLE_TRIE_H_