extensions/structs/extension.h
author systematicmania <systematicmania@gmail.com>
Thu Jul 18 11:38:04 2013 -0400 (2013-07-18)
changeset 3949 3fefd8346c23
parent 2224 676c3b826f13
permissions -rw-r--r--
Fixed clients not being marked as in kick queue in some cases (bug 5746, r=psychonic).
     1 /**
     2  * vim: set ts=4 :
     3  * =============================================================================
     4  * SourceMod Sample Extension
     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_EXTENSION_PROPER_H_
    33 #define _INCLUDE_SOURCEMOD_EXTENSION_PROPER_H_
    34 
    35 /**
    36  * @file extension.h
    37  * @brief Sample extension code header.
    38  */
    39 
    40 #include "smsdk_ext.h"
    41 #include "StructManager.h"
    42 #include "StructHandle.h"
    43 #include "Struct.h"
    44 
    45 /**
    46  * @brief Sample implementation of the SDK Extension.
    47  * Note: Uncomment one of the pre-defined virtual functions in order to use it.
    48  */
    49 class Structs : 
    50 	public SDKExtension,
    51 	public ITextListener_SMC
    52 {
    53 public:
    54 	/**
    55 	 * @brief This is called after the initial loading sequence has been processed.
    56 	 *
    57 	 * @param error		Error message buffer.
    58 	 * @param maxlength	Size of error message buffer.
    59 	 * @param late		Whether or not the module was loaded after map load.
    60 	 * @return			True to succeed loading, false to fail.
    61 	 */
    62 	virtual bool SDK_OnLoad(char *error, size_t maxlength, bool late);
    63 	
    64 	/**
    65 	 * @brief This is called right before the extension is unloaded.
    66 	 */
    67 	virtual void SDK_OnUnload();
    68 
    69 	/**
    70 	 * @brief This is called once all known extensions have been loaded.
    71 	 * Note: It is is a good idea to add natives here, if any are provided.
    72 	 */
    73 	virtual void SDK_OnAllLoaded();
    74 
    75 	/**
    76 	 * @brief Called when the pause state is changed.
    77 	 */
    78 	//virtual void SDK_OnPauseChange(bool paused);
    79 
    80 	/**
    81 	 * @brief this is called when Core wants to know if your extension is working.
    82 	 *
    83 	 * @param error		Error message buffer.
    84 	 * @param maxlength	Size of error message buffer.
    85 	 * @return			True if working, false otherwise.
    86 	 */
    87 	//virtual bool QueryRunning(char *error, size_t maxlength);
    88 public:
    89 #if defined SMEXT_CONF_METAMOD
    90 	/**
    91 	 * @brief Called when Metamod is attached, before the extension version is called.
    92 	 *
    93 	 * @param error			Error buffer.
    94 	 * @param maxlength		Maximum size of error buffer.
    95 	 * @param late			Whether or not Metamod considers this a late load.
    96 	 * @return				True to succeed, false to fail.
    97 	 */
    98 	//virtual bool SDK_OnMetamodLoad(ISmmAPI *ismm, char *error, size_t maxlength, bool late);
    99 
   100 	/**
   101 	 * @brief Called when Metamod is detaching, after the extension version is called.
   102 	 * NOTE: By default this is blocked unless sent from SourceMod.
   103 	 *
   104 	 * @param error			Error buffer.
   105 	 * @param maxlength		Maximum size of error buffer.
   106 	 * @return				True to succeed, false to fail.
   107 	 */
   108 	//virtual bool SDK_OnMetamodUnload(char *error, size_t maxlength);
   109 
   110 	/**
   111 	 * @brief Called when Metamod's pause state is changing.
   112 	 * NOTE: By default this is blocked unless sent from SourceMod.
   113 	 *
   114 	 * @param paused		Pause state being set.
   115 	 * @param error			Error buffer.
   116 	 * @param maxlength		Maximum size of error buffer.
   117 	 * @return				True to succeed, false to fail.
   118 	 */
   119 	//virtual bool SDK_OnMetamodPauseChange(bool paused, char *error, size_t maxlength);
   120 #endif
   121 
   122 public:
   123 	//ITextListener_SMC
   124 	SMCResult ReadSMC_NewSection(const SMCStates *states, const char *name);
   125 	SMCResult ReadSMC_KeyValue(const SMCStates *states, const char *key, const char *value);
   126 	SMCResult ReadSMC_LeavingSection(const SMCStates *states);
   127 	void ReadSMC_ParseStart();
   128 
   129 private:
   130 	bool m_bInStruct;
   131 	StructInfo *m_currentStruct;
   132 	bool m_bInMember;
   133 	MemberInfo *m_currentMember;
   134 
   135 	KTrie<MemberType> m_typeLookup;
   136 };
   137 
   138 size_t UTIL_Format(char *buffer, size_t maxlength, const char *fmt, ...);
   139 
   140 class StructHandler : public IHandleTypeDispatch
   141 {
   142 public:
   143 	void OnHandleDestroy(HandleType_t type, void *object)
   144 	{
   145 		StructHandle *pHandle = (StructHandle *)object;
   146 
   147 		if (pHandle->canDelete)
   148 		{
   149 			//delete pHandle->data;
   150 		}
   151 
   152 		delete pHandle;
   153 	}
   154 };
   155 
   156 extern HandleType_t g_StructHandle;
   157 extern StructHandler g_StructHandler;
   158 
   159 extern StructManager g_StructManager;
   160 
   161 extern const sp_nativeinfo_t MyNatives[];
   162 
   163 extern IGameConfig *conf;
   164 
   165 #endif // _INCLUDE_SOURCEMOD_EXTENSION_PROPER_H_