dvander@592: /**
ds@653: * vim: set ts=4 :
dvander@1231: * ================================================================
dvander@1231: * SourceMod
dvander@1231: * Copyright (C) 2004-2007 AlliedModders LLC. All rights reserved.
dvander@1231: * ================================================================
dvander@592: *
dvander@1231: * This program is free software; you can redistribute it and/or
dvander@1231: * modify it under the terms of the GNU General Public License,
dvander@1231: * version 3.0, as published by the Free Software Foundation.
dvander@1231: *
dvander@1231: * This program is distributed in the hope that it will be useful,
dvander@1231: * but WITHOUT ANY WARRANTY; without even the implied warranty of
dvander@1231: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
dvander@1231: * GNU General Public License for more details.
dvander@1231: *
dvander@1231: * You should have received a copy of the GNU General Public License
dvander@1231: * along with this program. If not, see .
dvander@1231: *
dvander@1231: * As a special exception, AlliedModders LLC gives you permission to
dvander@1231: * link the code of this program (as well as its derivative works) to
dvander@1231: * "Half-Life 2," the "Source Engine," the "SourcePawn JIT," and any
dvander@1231: * Game MODs that run on software by the Valve Corporation. You must
dvander@1231: * obey the GNU General Public License in all respects for all other
dvander@1231: * code used. Additionally, AlliedModders LLC grants this exception
dvander@1231: * to all derivative works. AlliedModders LLC defines further
dvander@1231: * exceptions, found in LICENSE.txt (as of this writing, version
dvander@1231: * JULY-31-2007), or .
dvander@592: *
dvander@592: * Version: $Id$
dvander@592: */
dvander@592:
dvander@592: #include "DebugReporter.h"
dvander@592: #include "Logger.h"
dvander@592: #include "PluginSys.h"
dvander@1269: #include "sm_stringutil.h"
dvander@592:
dvander@616: DebugReport g_DbgReporter;
dvander@592:
dvander@1269: /* I'm really lazy. This should probably be exported to ISourcePawnEngine someday,
dvander@1269: * but we need to make sure the JIT will deal with the version bump.
dvander@1269: */
dvander@1269: extern const char *GetSourcePawnErrorMessage(int error);
dvander@1269:
dvander@616: void DebugReport::OnSourceModAllInitialized()
dvander@592: {
dvander@592: g_pSourcePawn->SetDebugListener(this);
dvander@592: }
dvander@592:
dvander@1269: void DebugReport::GenerateError(IPluginContext *ctx, cell_t func_idx, int err, const char *message, ...)
dvander@1269: {
dvander@1269: va_list ap;
dvander@1269: char buffer[512];
dvander@1269:
dvander@1269: va_start(ap, message);
dvander@1269: UTIL_FormatArgs(buffer, sizeof(buffer), message, ap);
dvander@1269: va_end(ap);
dvander@1269:
dvander@1269: const char *plname = g_PluginSys.FindPluginByContext(ctx->GetContext())->GetFilename();
dvander@1269: const char *error = GetSourcePawnErrorMessage(err);
dvander@1269:
dvander@1269: if (error)
dvander@1269: {
dvander@1269: g_Logger.LogError("[SM] Plugin \"%s\" encountered error %d: %s", plname, err, error);
dvander@1269: } else {
dvander@1269: g_Logger.LogError("[SM] Plugin \"%s\" encountered unknown error %d", plname, err);
dvander@1269: }
dvander@1269:
dvander@1269: g_Logger.LogError("[SM] %s", buffer);
dvander@1269:
dvander@1269: const char *func_name = NULL;
dvander@1269: if (func_idx != -1)
dvander@1269: {
dvander@1269: if (func_idx & 1)
dvander@1269: {
dvander@1269: func_idx >>= 1;
dvander@1269: sp_public_t *function;
dvander@1269: if (ctx->GetPublicByIndex(func_idx, &function) == SP_ERROR_NONE)
dvander@1269: {
dvander@1269: g_Logger.LogError("[SM] Unable to call function \"%s\" due to above errors.", function->name);
dvander@1269: }
dvander@1269: }
dvander@1269: }
dvander@1269: }
dvander@1269:
dvander@616: void DebugReport::OnContextExecuteError(IPluginContext *ctx, IContextTrace *error)
dvander@592: {
dvander@592: const char *lastname;
dvander@592: const char *plname = g_PluginSys.FindPluginByContext(ctx->GetContext())->GetFilename();
dvander@592: int n_err = error->GetErrorCode();
dvander@592:
dvander@592: if (n_err != SP_ERROR_NATIVE)
dvander@592: {
dvander@1036: g_Logger.LogError("[SM] Plugin encountered error %d: %s",
dvander@592: n_err,
dvander@592: error->GetErrorString());
dvander@592: }
dvander@592:
dvander@592: if ((lastname=error->GetLastNative(NULL)) != NULL)
dvander@592: {
dvander@592: const char *custerr;
dvander@592: if ((custerr=error->GetCustomErrorString()) != NULL)
dvander@592: {
dvander@592: g_Logger.LogError("[SM] Native \"%s\" reported: %s", lastname, custerr);
dvander@592: } else {
dvander@592: g_Logger.LogError("[SM] Native \"%s\" encountered a generic error.", lastname);
dvander@592: }
dvander@592: }
dvander@592:
dvander@592: if (!error->DebugInfoAvailable())
dvander@592: {
dvander@1036: g_Logger.LogError("[SM] Debug mode is not enabled for \"%s\"", plname);
dvander@592: g_Logger.LogError("[SM] To enable debug mode, edit plugin_settings.cfg, or type: sm plugins debug %d on",
dvander@592: _GetPluginIndex(ctx));
dvander@592: return;
dvander@592: }
dvander@592:
dvander@592: CallStackInfo stk_info;
dvander@592: int i = 0;
dvander@592: g_Logger.LogError("[SM] Displaying call stack trace:");
dvander@592: while (error->GetTraceInfo(&stk_info))
dvander@592: {
dvander@592: g_Logger.LogError("[SM] [%d] Line %d, %s::%s()",
dvander@592: i++,
dvander@592: stk_info.line,
dvander@592: stk_info.filename,
dvander@592: stk_info.function);
dvander@592: }
dvander@592: }
dvander@592:
dvander@616: int DebugReport::_GetPluginIndex(IPluginContext *ctx)
dvander@592: {
dvander@592: int id = 1;
dvander@592: IPluginIterator *iter = g_PluginSys.GetPluginIterator();
dvander@592:
dvander@592: for (; iter->MorePlugins(); iter->NextPlugin(), id++)
dvander@592: {
dvander@592: IPlugin *pl = iter->GetPlugin();
dvander@592: if (pl->GetBaseContext() == ctx)
dvander@592: {
dvander@592: iter->Release();
dvander@592: return id;
dvander@592: }
dvander@592: }
dvander@592:
dvander@592: iter->Release();
dvander@592: return -1;
dvander@592: }
dvander@592: