/**
* vim: set ts=4 :
* =============================================================================
* SourceMod SDKTools Extension
* Copyright (C) 2004-2010 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 .
*
* 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 .
*
* Version: $Id$
*/
#include "extension.h"
#include "output.h"
ISourcePawnEngine *spengine = NULL;
EntityOutputManager g_OutputManager;
CDetour *fireOutputDetour = NULL;
EntityOutputManager::EntityOutputManager()
{
info_address = NULL;
info_callback = NULL;
HookCount = 0;
enabled = false;
}
void EntityOutputManager::Shutdown()
{
if (!enabled)
{
return;
}
EntityOutputs->Destroy();
ClassNames->Destroy();
fireOutputDetour->Destroy();
}
void EntityOutputManager::Init()
{
enabled = CreateFireEventDetour();
if (!enabled)
{
return;
}
EntityOutputs = adtfactory->CreateBasicTrie();
ClassNames = adtfactory->CreateBasicTrie();
}
bool EntityOutputManager::IsEnabled()
{
return enabled;
}
#ifdef PLATFORM_WINDOWS
DETOUR_DECL_MEMBER8(FireOutput, void, int, what, int, the, int, hell, int, msvc, void *, variant_t, CBaseEntity *, pActivator, CBaseEntity *, pCaller, float, fDelay)
{
g_OutputManager.FireEventDetour((void *)this, pActivator, pCaller, fDelay);
DETOUR_MEMBER_CALL(FireOutput)(what, the, hell, msvc, variant_t, pActivator, pCaller, fDelay);
}
#else
DETOUR_DECL_MEMBER4(FireOutput, void, void *, variant_t, CBaseEntity *, pActivator, CBaseEntity *, pCaller, float, fDelay)
{
g_OutputManager.FireEventDetour((void *)this, pActivator, pCaller, fDelay);
DETOUR_MEMBER_CALL(FireOutput)(variant_t, pActivator, pCaller, fDelay);
}
#endif
bool EntityOutputManager::CreateFireEventDetour()
{
fireOutputDetour = DETOUR_CREATE_MEMBER(FireOutput, "FireOutput");
if (fireOutputDetour) return true;
return false;
}
void EntityOutputManager::FireEventDetour(void *pOutput, CBaseEntity *pActivator, CBaseEntity *pCaller, float fDelay)
{
if (!pCaller)
{
return;
}
char sOutput[20];
Q_snprintf(sOutput, sizeof(sOutput), "%p", pOutput);
// attempt to directly lookup a hook using the pOutput pointer
OutputNameStruct *pOutputName = NULL;
bool fastLookup = false;
// Fast lookup failed - check the slow way for hooks that haven't fired yet
if ((fastLookup = EntityOutputs->Retrieve(sOutput, (void **)&pOutputName)) == false)
{
const char *classname = GetEntityClassname(pCaller);
const char *outputname = FindOutputName(pOutput, pCaller);
if (!outputname)
{
return;
}
pOutputName = FindOutputPointer(classname, outputname, false);
if (!pOutputName)
{
return;
}
}
if (!pOutputName->hooks.empty())
{
if (!fastLookup)
{
// hook exists on this classname and output - map it into our quick find trie
EntityOutputs->Insert(sOutput, pOutputName);
}
SourceHook::List::iterator _iter;
omg_hooks *hook;
_iter = pOutputName->hooks.begin();
while (_iter != pOutputName->hooks.end())
{
hook = (omg_hooks *)*_iter;
hook->in_use = true;
cell_t ref = gamehelpers->EntityToReference(pCaller);
if (hook->entity_ref != -1
&& gamehelpers->ReferenceToIndex(hook->entity_ref) == gamehelpers->ReferenceToIndex(ref)
&& ref != hook->entity_ref)
{
// same entity index but different reference. Entity has changed, kill the hook.
_iter = pOutputName->hooks.erase(_iter);
CleanUpHook(hook);
continue;
}
if (hook->entity_ref == -1 || hook->entity_ref == ref) // Global classname hook
{
//fire the forward to hook->pf
hook->pf->PushString(pOutputName->Name);
hook->pf->PushCell(gamehelpers->ReferenceToBCompatRef(ref));
hook->pf->PushCell(gamehelpers->EntityToBCompatRef(pActivator));
//hook->pf->PushCell(handle);
hook->pf->PushFloat(fDelay);
hook->pf->Execute(NULL);
if ((hook->entity_ref != -1) && hook->only_once)
{
_iter = pOutputName->hooks.erase(_iter);
CleanUpHook(hook);
continue;
}
if (hook->delete_me)
{
_iter = pOutputName->hooks.erase(_iter);
CleanUpHook(hook);
continue;
}
}
hook->in_use = false;
_iter++;
}
}
}
omg_hooks *EntityOutputManager::NewHook()
{
omg_hooks *hook;
if (FreeHooks.empty())
{
hook = new omg_hooks;
}
else
{
hook = g_OutputManager.FreeHooks.front();
g_OutputManager.FreeHooks.pop();
}
return hook;
}
void EntityOutputManager::OnHookAdded()
{
HookCount++;
if (HookCount == 1)
{
// This is the first hook created
fireOutputDetour->EnableDetour();
}
}
void EntityOutputManager::OnHookRemoved()
{
HookCount--;
if (HookCount == 0)
{
fireOutputDetour->DisableDetour();
}
}
void EntityOutputManager::CleanUpHook(omg_hooks *hook)
{
FreeHooks.push(hook);
OnHookRemoved();
IPlugin *pPlugin = plsys->FindPluginByContext(hook->pf->GetParentContext()->GetContext());
SourceHook::List *pList = NULL;
if (!pPlugin->GetProperty("OutputHookList", (void **)&pList, false) || !pList)
{
return;
}
SourceHook::List::iterator p_iter = pList->begin();
omg_hooks *pluginHook;
while (p_iter != pList->end())
{
pluginHook = (omg_hooks *)*p_iter;
if (pluginHook == hook)
{
p_iter = pList->erase(p_iter);
}
else
{
p_iter++;
}
}
}
void EntityOutputManager::OnPluginDestroyed(IPlugin *plugin)
{
SourceHook::List *pList = NULL;
if (plugin->GetProperty("OutputHookList", (void **)&pList, true))
{
SourceHook::List::iterator p_iter = pList->begin();
omg_hooks *hook;
while (p_iter != pList->end())
{
hook = (omg_hooks *)*p_iter;
p_iter = pList->erase(p_iter); //remove from this plugins list
hook->m_parent->hooks.remove(hook); // remove from the y's list
FreeHooks.push(hook); //save the omg_hook
OnHookRemoved();
}
}
}
OutputNameStruct *EntityOutputManager::FindOutputPointer(const char *classname, const char *outputname, bool create)
{
ClassNameStruct *pClassname;
if (!ClassNames->Retrieve(classname, (void **)&pClassname))
{
if (create)
{
pClassname = new ClassNameStruct;
ClassNames->Insert(classname, pClassname);
}
else
{
return NULL;
}
}
OutputNameStruct *pOutputName;
if (!pClassname->OutputList->Retrieve(outputname, (void **)&pOutputName))
{
if (create)
{
pOutputName = new OutputNameStruct;
pClassname->OutputList->Insert(outputname, pOutputName);
strncpy(pOutputName->Name, outputname, sizeof(pOutputName->Name));
pOutputName->Name[49] = 0;
}
else
{
return NULL;
}
}
return pOutputName;
}
// Iterate the datamap of pCaller and look for output pointers with the same address as pOutput
const char *EntityOutputManager::FindOutputName(void *pOutput, CBaseEntity *pCaller)
{
datamap_t *pMap = gamehelpers->GetDataMap(pCaller);
while (pMap)
{
for (int i=0; idataNumFields; i++)
{
if (pMap->dataDesc[i].flags & FTYPEDESC_OUTPUT)
{
if ((char *)pCaller + GetTypeDescOffs(&pMap->dataDesc[i]) == pOutput)
{
return pMap->dataDesc[i].externalName;
}
}
}
pMap = pMap->baseMap;
}
return NULL;
}
const char *EntityOutputManager::GetEntityClassname(CBaseEntity *pEntity)
{
static int offset = -1;
if (offset == -1)
{
datamap_t *pMap = gamehelpers->GetDataMap(pEntity);
typedescription_t *pDesc = gamehelpers->FindInDataMap(pMap, "m_iClassname");
offset = GetTypeDescOffs(pDesc);
}
return *(const char **)(((unsigned char *)pEntity) + offset);
}