/**

  * vim: set ts=4 :

  * =============================================================================

  * SourceMod Client Preferences Extension

  * Copyright (C) 2004-2008 AlliedModders LLC.  All rights reserved.

  * =============================================================================

  *

  * 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$

  */

 #ifndef _INCLUDE_SOURCEMOD_EXTENSION_PROPER_H_

 #define _INCLUDE_SOURCEMOD_EXTENSION_PROPER_H_

 #define MAXCLIENTS 64

 #include <stdlib.h>

 #include <stdarg.h>

 #include "smsdk_ext.h"

 #include "sh_list.h"

 #include "cookie.h"

 #include "menus.h"

 #include "query.h"

 enum DbDriver

 {

 	Driver_MySQL,

 	Driver_SQLite

 };

 #define MAX_TRANSLATE_PARAMS		32

 class TQueryOp;

 /**

  * @brief Sample implementation of the SDK Extension.

  * Note: Uncomment one of the pre-defined virtual functions in order to use it.

  */

 class ClientPrefs : public SDKExtension

 {

 public:

 	/**

 	 * @brief This is called after the initial loading sequence has been processed.

 	 *

 	 * @param error		Error message buffer.

 	 * @param maxlength	Size of error message buffer.

 	 * @param late		Whether or not the module was loaded after map load.

 	 * @return			True to succeed loading, false to fail.

 	 */

 	virtual bool SDK_OnLoad(char *error, size_t maxlength, bool late);

 	/**

 	 * @brief This is called right before the extension is unloaded.

 	 */

 	virtual void SDK_OnUnload();

 	/**

 	 * @brief This is called once all known extensions have been loaded.

 	 * Note: It is is a good idea to add natives here, if any are provided.

 	 */

 	virtual void SDK_OnAllLoaded();

 	virtual bool QueryInterfaceDrop(SMInterface *pInterface);

 	virtual void NotifyInterfaceDrop(SMInterface *pInterface);

 	void DatabaseConnect();

 	bool AddQueryToQueue(TQueryOp *query);

 	void ProcessQueryCache();

 	/**

 	 * @brief Called when the pause state is changed.

 	 */

 	//virtual void SDK_OnPauseChange(bool paused);

 	/**

 	 * @brief this is called when Core wants to know if your extension is working.

 	 *

 	 * @param error		Error message buffer.

 	 * @param maxlength	Size of error message buffer.

 	 * @return			True if working, false otherwise.

 	 */

 	//virtual bool QueryRunning(char *error, size_t maxlength);

 public:

 #if defined SMEXT_CONF_METAMOD

 	/**

 	 * @brief Called when Metamod is attached, before the extension version is called.

 	 *

 	 * @param error			Error buffer.

 	 * @param maxlength		Maximum size of error buffer.

 	 * @param late			Whether or not Metamod considers this a late load.

 	 * @return				True to succeed, false to fail.

 	 */

 	//virtual bool SDK_OnMetamodLoad(ISmmAPI *ismm, char *error, size_t maxlength, bool late);

 	/**

 	 * @brief Called when Metamod is detaching, after the extension version is called.

 	 * NOTE: By default this is blocked unless sent from SourceMod.

 	 *

 	 * @param error			Error buffer.

 	 * @param maxlength		Maximum size of error buffer.

 	 * @return				True to succeed, false to fail.

 	 */

 	//virtual bool SDK_OnMetamodUnload(char *error, size_t maxlength);

 	/**

 	 * @brief Called when Metamod's pause state is changing.

 	 * NOTE: By default this is blocked unless sent from SourceMod.

 	 *

 	 * @param paused		Pause state being set.

 	 * @param error			Error buffer.

 	 * @param maxlength		Maximum size of error buffer.

 	 * @return				True to succeed, false to fail.

 	 */

 	//virtual bool SDK_OnMetamodPauseChange(bool paused, char *error, size_t maxlength);

 #endif

 public:

 	IDBDriver *Driver;

 	IDatabase *Database;

 	bool databaseLoading;

 	IPhraseCollection *phrases;

 	const DatabaseInfo *DBInfo;

 	IMutex *cookieMutex;

 private:

 	SourceHook::List<TQueryOp *> cachedQueries;

 	IMutex *queryMutex;

 };

 class CookieTypeHandler : public IHandleTypeDispatch

 {

 public:

 	void OnHandleDestroy(HandleType_t type, void *object)

 	{

 		/* No delete needed since Cookies are persistent */

 	}

 };

 class CookieIteratorHandler : public IHandleTypeDispatch

 {

 public:

 	void OnHandleDestroy(HandleType_t type, void *object)

 	{

 		delete (SourceHook::List<Cookie *>::iterator *)object;

 	}

 };

 size_t UTIL_Format(char *buffer, size_t maxlength, const char *fmt, ...);

 extern sp_nativeinfo_t g_ClientPrefNatives[];

 extern ClientPrefs g_ClientPrefs;

 extern HandleType_t g_CookieType;

 extern CookieTypeHandler g_CookieTypeHandler;

 extern HandleType_t g_CookieIterator;

 extern CookieIteratorHandler g_CookieIteratorHandler;

 bool Translate(char *buffer, 

 				   size_t maxlength,

 				   const char *format,

 				   unsigned int numparams,

 				   size_t *pOutLength,

 				   ...);

 extern DbDriver g_DriverType;

 #endif // _INCLUDE_SOURCEMOD_EXTENSION_PROPER_H_