actions.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.

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

#define DEFAULT_ACTION_ARRAY_SIZE		150
#define DEFAULT_ACTION_GROW_SIZE			20

struct ACTION 
{
	BOOL bAnchored;			// TRUE is the trigger must be the start of a line.
	int nTokens;				// Number of tokens in the action.
	int nVars;					// Number of variables in the action.
	int nVar[10];				// There can be up to 10 variables.  A user can
									// decclare them in any order.
	CString strToken[10];	// The tokens for the action.
	BOOL bStartVar;			// True if the action starts with a variable.
	CString strAction;		// The action to take if a match is found.
	CString strGroup;
	BOOL bEnabled;
};

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

	// Adds an action to the list.  The action is inserted into the
	// list in sorted order. Returns the number of the action if it
	// get inserted. (1 based for the user) 0 = failed.
	int Add(const char *pszTrigger, const char *pszAction,
		const char *pszGroup);

	// Searches the list for a matching trigger, removes the action
	// from the list if it finds a match.  Returns TRUE if the item
	// is removed.
	BOOL Remove(const char *pszTrigger);

	// Removes an action by index number.
	BOOL Remove(int nIndex);

	void ActionToTrigger(ACTION *pAct, CString &strTrigger);
	void CopyAction(ACTION *pDest, ACTION *pSource);

	// Searches the triggers for an exact text match.  Returns NULL
	// if a match is not found.
	ACTION* FindExact(const char *pszTrigger);

	// Gets a pointer to the first action in the list.  Returns NULL
	// if the list is empty.
	ACTION* GetFirst();

	// Gets a pointer to the next action in the list.  Need to call
	// GetFirst() before you call this.  Returns NULL once the end
	// of the list is reached.
	ACTION* GetNext();

	ACTION* GetAt(int nIndex);

	// Pass in the line to check against the action list.  If an action
	// matches, the replacement text is passed back in strLine.  
	// Optionally a starting index number can be passed in.  This is
	// used for continuing to search the list of actions after a 
	// match has already been found.
	// Returns the index of the matching item. -1 if not found.
	void CheckAction(CString &strLine);

	int GetCount()			{ return(m_nCount); }
	int GetFindIndex()	{ return(m_nGetIndex); }

	void RemoveAll();
	int RemoveGroup(const char *pszGroup);

	int DisableGroup(const char *pszGroup);
	int EnableGroup(const char *pszGroup);

private:
	CPtrArray m_ptrList;
	int m_nCount;

	int m_nGetIndex;
};