43cdf20fd3
* Create FrameIterator type This commit adds the FrameIterator type to core sm along with a few methods around getting the information for each frame. * Fix incorrect documentation [skip ci] * Implement KyleS's Changes * A nit
77 lines
2.3 KiB
C++
77 lines
2.3 KiB
C++
/**
|
|
* vim: set ts=4 sw=4 tw=99 noet :
|
|
* =============================================================================
|
|
* SourceMod
|
|
* Copyright (C) 2004-2017 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 <http://www.gnu.org/licenses/>.
|
|
*
|
|
* 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 <http://www.sourcemod.net/license.php>.
|
|
*
|
|
* Version: $Id$
|
|
*/
|
|
|
|
#include "sp_vm_api.h"
|
|
#include <am-vector.h>
|
|
#include <am-string.h>
|
|
|
|
using namespace SourcePawn;
|
|
|
|
/**
|
|
* Frame iterator cache which is safe for plugins to hold handles to,
|
|
* unlike what you'd recieve from IPluginContext::CreateFrameIterator.
|
|
*/
|
|
class SafeFrameIterator
|
|
{
|
|
public:
|
|
|
|
/**
|
|
* Struct which holds all of the cached values for each individual frame.
|
|
*/
|
|
struct FrameInfo
|
|
{
|
|
ke::AString FunctionName;
|
|
ke::AString FilePath;
|
|
unsigned LineNumber;
|
|
|
|
FrameInfo(IFrameIterator *it)
|
|
{
|
|
LineNumber = it->LineNumber();
|
|
|
|
FunctionName = it->FunctionName();
|
|
FilePath = it->FilePath();
|
|
}
|
|
};
|
|
|
|
SafeFrameIterator(IFrameIterator *);
|
|
|
|
bool Done() const;
|
|
bool Next();
|
|
void Reset();
|
|
|
|
int LineNumber() const;
|
|
const char *FunctionName() const;
|
|
const char *FilePath() const;
|
|
|
|
private:
|
|
size_t current;
|
|
ke::Vector<FrameInfo> frames;
|
|
}; |