3 * =============================================================================
5 * Copyright (C) 2004-2008 AlliedModders LLC. All rights reserved.
6 * =============================================================================
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.
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
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/>.
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>.
32 #include <IPluginSys.h>
33 #include "DebugReporter.h"
35 DebugReport g_DbgReporter;
37 void DebugReport::OnSourceModAllInitialized()
39 g_pSourcePawn->SetDebugListener(this);
42 void DebugReport::OnDebugSpew(const char *msg, ...)
48 smcore.FormatArgs(buffer, sizeof(buffer), msg, ap);
51 smcore.Log("[SM] %s", buffer);
54 void DebugReport::GenerateError(IPluginContext *ctx, cell_t func_idx, int err, const char *message, ...)
58 va_start(ap, message);
59 GenerateErrorVA(ctx, func_idx, err, message, ap);
63 void DebugReport::GenerateErrorVA(IPluginContext *ctx, cell_t func_idx, int err, const char *message, va_list ap)
66 smcore.FormatArgs(buffer, sizeof(buffer), message, ap);
68 const char *plname = pluginsys->FindPluginByContext(ctx->GetContext())->GetFilename();
69 const char *error = g_pSourcePawn2->GetErrorString(err);
73 smcore.LogError("[SM] Plugin \"%s\" encountered error %d: %s", plname, err, error);
75 smcore.LogError("[SM] Plugin \"%s\" encountered unknown error %d", plname, err);
78 smcore.LogError("[SM] %s", buffer);
85 sp_public_t *function;
86 if (ctx->GetRuntime()->GetPublicByIndex(func_idx, &function) == SP_ERROR_NONE)
88 smcore.LogError("[SM] Unable to call function \"%s\" due to above error(s).", function->name);
94 void DebugReport::GenerateCodeError(IPluginContext *pContext, uint32_t code_addr, int err, const char *message, ...)
99 va_start(ap, message);
100 smcore.FormatArgs(buffer, sizeof(buffer), message, ap);
103 const char *plname = pluginsys->FindPluginByContext(pContext->GetContext())->GetFilename();
104 const char *error = g_pSourcePawn2->GetErrorString(err);
108 smcore.LogError("[SM] Plugin \"%s\" encountered error %d: %s", plname, err, error);
110 smcore.LogError("[SM] Plugin \"%s\" encountered unknown error %d", plname, err);
113 smcore.LogError("[SM] %s", buffer);
115 IPluginDebugInfo *pDebug;
116 if ((pDebug = pContext->GetRuntime()->GetDebugInfo()) == NULL)
118 smcore.LogError("[SM] Debug mode is not enabled for \"%s\"", plname);
119 smcore.LogError("[SM] To enable debug mode, edit plugin_settings.cfg, or type: sm plugins debug %d on",
120 _GetPluginIndex(pContext));
125 if (pDebug->LookupFunction(code_addr, &name) == SP_ERROR_NONE)
127 smcore.LogError("[SM] Unable to call function \"%s\" due to above error(s).", name);
129 smcore.LogError("[SM] Unable to call function (name unknown, address \"%x\").", code_addr);
133 void DebugReport::OnContextExecuteError(IPluginContext *ctx, IContextTrace *error)
135 const char *lastname;
136 const char *plname = pluginsys->FindPluginByContext(ctx->GetContext())->GetFilename();
137 int n_err = error->GetErrorCode();
139 if (n_err != SP_ERROR_NATIVE)
141 smcore.LogError("[SM] Plugin encountered error %d: %s",
143 error->GetErrorString());
146 if ((lastname=error->GetLastNative(NULL)) != NULL)
149 if ((custerr=error->GetCustomErrorString()) != NULL)
151 smcore.LogError("[SM] Native \"%s\" reported: %s", lastname, custerr);
153 smcore.LogError("[SM] Native \"%s\" encountered a generic error.", lastname);
157 if (!error->DebugInfoAvailable())
159 smcore.LogError("[SM] Debug mode is not enabled for \"%s\"", plname);
160 smcore.LogError("[SM] To enable debug mode, edit plugin_settings.cfg, or type: sm plugins debug %d on",
161 _GetPluginIndex(ctx));
165 CallStackInfo stk_info;
167 smcore.LogError("[SM] Displaying call stack trace for plugin \"%s\":", plname);
168 while (error->GetTraceInfo(&stk_info))
170 smcore.LogError("[SM] [%d] Line %d, %s::%s()",
178 int DebugReport::_GetPluginIndex(IPluginContext *ctx)
181 IPluginIterator *iter = pluginsys->GetPluginIterator();
183 for (; iter->MorePlugins(); iter->NextPlugin(), id++)
185 IPlugin *pl = iter->GetPlugin();
186 if (pl->GetBaseContext() == ctx)
195 /* If we don't know which plugin this is, it's one being loaded. Fake its index for now. */
197 return pluginsys->GetPluginCount() + 1;