extensions/sqlite/extension.h
author Matt Woodrow <pred@alliedmods.net>
Mon Aug 17 10:53:54 2009 +1200 (2009-08-17)
changeset 2771 ea849fc91a9b
parent 2289 44045ead61cd
child 2783 5f333027ef04
permissions -rw-r--r--
Forgot makefiles patch
dvander@1203
     1
/**
dvander@1203
     2
 * vim: set ts=4 :
ds@1330
     3
 * =============================================================================
dvander@1226
     4
 * SourceMod SQLite Extension
ds@1947
     5
 * Copyright (C) 2004-2008 AlliedModders LLC.  All rights reserved.
ds@1330
     6
 * =============================================================================
dvander@1203
     7
 *
ds@1330
     8
 * This program is free software; you can redistribute it and/or modify it under
ds@1330
     9
 * the terms of the GNU General Public License, version 3.0, as published by the
ds@1330
    10
 * Free Software Foundation.
dvander@1226
    11
 * 
ds@1330
    12
 * This program is distributed in the hope that it will be useful, but WITHOUT
ds@1330
    13
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
ds@1330
    14
 * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
ds@1330
    15
 * details.
dvander@1226
    16
 *
ds@1330
    17
 * You should have received a copy of the GNU General Public License along with
ds@1330
    18
 * this program.  If not, see <http://www.gnu.org/licenses/>.
dvander@1226
    19
 *
ds@1330
    20
 * As a special exception, AlliedModders LLC gives you permission to link the
ds@1330
    21
 * code of this program (as well as its derivative works) to "Half-Life 2," the
ds@1330
    22
 * "Source Engine," the "SourcePawn JIT," and any Game MODs that run on software
ds@1330
    23
 * by the Valve Corporation.  You must obey the GNU General Public License in
ds@1330
    24
 * all respects for all other code used.  Additionally, AlliedModders LLC grants
ds@1330
    25
 * this exception to all derivative works.  AlliedModders LLC defines further
ds@1330
    26
 * exceptions, found in LICENSE.txt (as of this writing, version JULY-31-2007),
ds@1330
    27
 * or <http://www.sourcemod.net/license.php>.
dvander@1203
    28
 *
dvander@1203
    29
 * Version: $Id$
dvander@1203
    30
 */
dvander@1203
    31
dvander@1203
    32
#ifndef _INCLUDE_SOURCEMOD_EXTENSION_PROPER_H_
dvander@1203
    33
#define _INCLUDE_SOURCEMOD_EXTENSION_PROPER_H_
dvander@1203
    34
dvander@1203
    35
/**
dvander@1203
    36
 * @file extension.h
dvander@1203
    37
 * @brief Sample extension code header.
dvander@1203
    38
 */
dvander@1203
    39
dvander@1203
    40
#include "smsdk_ext.h"
dvander@1203
    41
dvander@1203
    42
dvander@1203
    43
/**
dvander@1203
    44
 * @brief Sample implementation of the SDK Extension.
dvander@1203
    45
 * Note: Uncomment one of the pre-defined virtual functions in order to use it.
dvander@1203
    46
 */
dvander@1203
    47
class SqliteExt : public SDKExtension
dvander@1203
    48
{
dvander@1203
    49
public:
dvander@1203
    50
	/**
dvander@1203
    51
	 * @brief This is called after the initial loading sequence has been processed.
dvander@1203
    52
	 *
dvander@1203
    53
	 * @param error		Error message buffer.
dvander@1203
    54
	 * @param maxlength	Size of error message buffer.
dvander@1203
    55
	 * @param late		Whether or not the module was loaded after map load.
dvander@1203
    56
	 * @return			True to succeed loading, false to fail.
dvander@1203
    57
	 */
dvander@1203
    58
	virtual bool SDK_OnLoad(char *error, size_t maxlength, bool late);
dvander@1203
    59
	
dvander@1203
    60
	/**
dvander@1203
    61
	 * @brief This is called right before the extension is unloaded.
dvander@1203
    62
	 */
dvander@1203
    63
	virtual void SDK_OnUnload();
dvander@1203
    64
dvander@1203
    65
	/**
dvander@1203
    66
	 * @brief This is called once all known extensions have been loaded.
dvander@1203
    67
	 * Note: It is is a good idea to add natives here, if any are provided.
dvander@1203
    68
	 */
dvander@1203
    69
	//virtual void SDK_OnAllLoaded();
dvander@1203
    70
dvander@1203
    71
	/**
dvander@1203
    72
	 * @brief Called when the pause state is changed.
dvander@1203
    73
	 */
dvander@1203
    74
	//virtual void SDK_OnPauseChange(bool paused);
dvander@1203
    75
dvander@1203
    76
	/**
dvander@1203
    77
	 * @brief this is called when Core wants to know if your extension is working.
dvander@1203
    78
	 *
dvander@1203
    79
	 * @param error		Error message buffer.
dvander@1203
    80
	 * @param maxlength	Size of error message buffer.
dvander@1203
    81
	 * @return			True if working, false otherwise.
dvander@1203
    82
	 */
dvander@1203
    83
	//virtual bool QueryRunning(char *error, size_t maxlength);
dvander@1203
    84
public:
dvander@1203
    85
#if defined SMEXT_CONF_METAMOD
dvander@1203
    86
	/**
dvander@1203
    87
	 * @brief Called when Metamod is attached, before the extension version is called.
dvander@1203
    88
	 *
dvander@1203
    89
	 * @param error			Error buffer.
dvander@1203
    90
	 * @param maxlength		Maximum size of error buffer.
dvander@1203
    91
	 * @param late			Whether or not Metamod considers this a late load.
dvander@1203
    92
	 * @return				True to succeed, false to fail.
dvander@1203
    93
	 */
dvander@1203
    94
	//virtual bool SDK_OnMetamodLoad(ISmmAPI *ismm, char *error, size_t maxlength, bool late);
dvander@1203
    95
dvander@1203
    96
	/**
dvander@1203
    97
	 * @brief Called when Metamod is detaching, after the extension version is called.
dvander@1203
    98
	 * NOTE: By default this is blocked unless sent from SourceMod.
dvander@1203
    99
	 *
dvander@1203
   100
	 * @param error			Error buffer.
dvander@1203
   101
	 * @param maxlength		Maximum size of error buffer.
dvander@1203
   102
	 * @return				True to succeed, false to fail.
dvander@1203
   103
	 */
dvander@1203
   104
	//virtual bool SDK_OnMetamodUnload(char *error, size_t maxlength);
dvander@1203
   105
dvander@1203
   106
	/**
dvander@1203
   107
	 * @brief Called when Metamod's pause state is changing.
dvander@1203
   108
	 * NOTE: By default this is blocked unless sent from SourceMod.
dvander@1203
   109
	 *
dvander@1203
   110
	 * @param paused		Pause state being set.
dvander@1203
   111
	 * @param error			Error buffer.
dvander@1203
   112
	 * @param maxlength		Maximum size of error buffer.
dvander@1203
   113
	 * @return				True to succeed, false to fail.
dvander@1203
   114
	 */
dvander@1203
   115
	//virtual bool SDK_OnMetamodPauseChange(bool paused, char *error, size_t maxlength);
dvander@1203
   116
#endif
dvander@1203
   117
};
dvander@1203
   118
dvander@1203
   119
size_t UTIL_Format(char *buffer, size_t maxlength, const char *fmt, ...);
dvander@1203
   120
dvander@1203
   121
#endif // _INCLUDE_SOURCEMOD_EXTENSION_PROPER_H_