1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/public/IADTFactory.h	Sun Mar 30 07:00:22 2008 +0000
     1.3 @@ -0,0 +1,114 @@
     1.4 +/**
     1.5 + * vim: set ts=4 :
     1.6 + * =============================================================================
     1.7 + * SourceMod
     1.8 + * Copyright (C) 2004-2008 AlliedModders LLC.  All rights reserved.
     1.9 + * =============================================================================
    1.10 + *
    1.11 + * This program is free software; you can redistribute it and/or modify it under
    1.12 + * the terms of the GNU General Public License, version 3.0, as published by the
    1.13 + * Free Software Foundation.
    1.14 + * 
    1.15 + * This program is distributed in the hope that it will be useful, but WITHOUT
    1.16 + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
    1.17 + * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
    1.18 + * details.
    1.19 + *
    1.20 + * You should have received a copy of the GNU General Public License along with
    1.21 + * this program.  If not, see <http://www.gnu.org/licenses/>.
    1.22 + *
    1.23 + * As a special exception, AlliedModders LLC gives you permission to link the
    1.24 + * code of this program (as well as its derivative works) to "Half-Life 2," the
    1.25 + * "Source Engine," the "SourcePawn JIT," and any Game MODs that run on software
    1.26 + * by the Valve Corporation.  You must obey the GNU General Public License in
    1.27 + * all respects for all other code used.  Additionally, AlliedModders LLC grants
    1.28 + * this exception to all derivative works.  AlliedModders LLC defines further
    1.29 + * exceptions, found in LICENSE.txt (as of this writing, version JULY-31-2007),
    1.30 + * or <http://www.sourcemod.net/license.php>.
    1.31 + *
    1.32 + * Version: $Id$
    1.33 + */
    1.34 +
    1.35 +#ifndef _INCLUDE_SOURCEMOD_ADT_FACTORY_H_
    1.36 +#define _INCLUDE_SOURCEMOD_ADT_FACTORY_H_
    1.37 +
    1.38 +#include <IShareSys.h>
    1.39 +
    1.40 +#define SMINTERFACE_ADTFACTORY_NAME		"IADTFactory"
    1.41 +#define SMINTERFACE_ADTFACTORY_VERSION	2
    1.42 +
    1.43 +/**
    1.44 +* @file IADTFactory.h
    1.45 +* @brief Creates abstract data types.
    1.46 +*/
    1.47 +
    1.48 +namespace SourceMod
    1.49 +{
    1.50 +	/**
    1.51 +	 * @brief A "Trie" data type.
    1.52 +	 */
    1.53 +	class IBasicTrie
    1.54 +	{
    1.55 +	public:
    1.56 +		/**
    1.57 +		 * @brief Inserts a key/value pair.
    1.58 +		 *
    1.59 +		 * @param key		Key string (null terminated).
    1.60 +		 * @param value		Value pointer (may be anything).
    1.61 +		 * @return			True on success, false if key already exists.
    1.62 +		 */
    1.63 +		virtual bool Insert(const char *key, void *value) =0;
    1.64 +
    1.65 +		/**
    1.66 +		 * @brief Retrieves the value of a key.
    1.67 +		 *
    1.68 +		 * @param key		Key string (null terminated).
    1.69 +		 * @param value		Optional pointer to store value pointer.
    1.70 +		 * @return			True on success, false if key was not found.
    1.71 +		 */
    1.72 +		virtual bool Retrieve(const char *key, void **value) =0;
    1.73 +
    1.74 +		/**
    1.75 +		 * @brief Deletes a key.
    1.76 +		 *
    1.77 +		 * @param key		Key string (null terminated).
    1.78 +		 * @return			True on success, false if key was not found.
    1.79 +		 */
    1.80 +		virtual bool Delete(const char *key) =0;
    1.81 +
    1.82 +		/**
    1.83 +		 * @brief Flushes the entire trie of all keys.
    1.84 +		 */
    1.85 +		virtual void Clear() =0;
    1.86 +
    1.87 +		/**
    1.88 +		 * @brief Destroys the IBasicTrie object and frees all associated 
    1.89 +		 * memory.
    1.90 +		 */
    1.91 +		virtual void Destroy() =0;
    1.92 +
    1.93 +		/**
    1.94 +		 * @brief Inserts a key/value pair, replacing an old inserted
    1.95 +		 * value if it already exists.
    1.96 +		 *
    1.97 +		 * @param key		Key string (null terminated).
    1.98 +		 * @param value		Value pointer (may be anything).
    1.99 +		 * @return			True on success, false on failure.
   1.100 +		 */
   1.101 +		virtual bool Replace(const char *key, void *value) =0;
   1.102 +	};
   1.103 +
   1.104 +	class IADTFactory : public SMInterface
   1.105 +	{
   1.106 +	public:
   1.107 +		/**
   1.108 +		 * @brief Creates a basic Trie object.
   1.109 +		 *
   1.110 +		 * @return			A new IBasicTrie object which must be destroyed
   1.111 +		 *					via IBasicTrie::Destroy().
   1.112 +		 */
   1.113 +		virtual IBasicTrie *CreateBasicTrie() =0;
   1.114 +	};
   1.115 +}
   1.116 +
   1.117 +#endif //_INCLUDE_SOURCEMOD_ADT_FACTORY_H_