debugstack.h

MudMaster 2000 的C++源码

/************************************************************************************
	Copyright (c) 2000 Aaron O'Neil
	All rights reserved.

	Redistribution and use in source and binary forms, with or without
	modification, are permitted provided that the following conditions
	are met:

		1) Redistributions of source code must retain the above copyright notice, 
				this list of conditions and the following disclaimer.
		2) Redistributions in binary form must reproduce the above copyright notice, 
				this list of conditions and the following disclaimer in the documentation
				and/or other materials provided with the distribution.
		3) Redistributions in binary form must reproduce the above copyright notice on
				program startup. Additional credits for program modification are acceptable
				but original copyright and credits must be visible at startup.
		4) You may charge a reasonable copying fee for any distribution of Mud Master. 
				You may charge any fee you choose for support of Mud Master. You may not 
				charge a fee for Mud Master itself.

  THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
	IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
	OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
	IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
	INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
	NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
	DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
	THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
	(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
	THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

**************************************************************************************/

// Max depth of the stack.
#define STACK_DEPTH					3000

// Types of items in the stack.
#define STACK_TYPE_ACTION			0
#define STACK_TYPE_ALIAS			1
#define STACK_TYPE_EVENT			2
#define STACK_TYPE_MACRO			3
#define STACK_TYPE_USER_INPUT		4
#define STACK_TYPE_DLL_CALLBACK	5
#define STACK_TYPE_DLL_RETURN		6

class CDebugStack
{
public:
	CDebugStack();
	~CDebugStack();

	// nNum is the reference number.  Like action #3.  Returns TRUE
	// if there was room on the stack.
	void Push(int nNum, int nType);
	// Removes an element from the stack.  It doesn't actually give you
	// the data back from this element.  The data is only used for 
	// information purposes if there is an error.  And then the only
	// data needed is the data that's STILL on the stack.
	void Pop();

	// Dumps a specific number of stack entries.  This doesn't clear the
	// entries from the stack, just prints the info.
	void DumpStack(UINT nDepth);

	UINT GetDepth()							{return(m_nCurrentDepth);}

private:
	// The stack data.
	int *m_pnNum;
	int *m_pnType;

	// Current position in the stack.  Stack is really 1 less than the depth.
	// When the depth is 0, it's considered empty.
	UINT m_nCurrentDepth;

};