substitute.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_SUB_ARRAY_SIZE		150
#define DEFAULT_SUB_GROW_SIZE			20

// This is the number of time it will do a sub before
// it breaks out of the loop.  When a sub is found the
// list starts over and looks to see if there are any
// more to be replaced.  A problem with this is if a
// user has two subs that continually replace each other
// it gets in an endless loop.  This will limite errors
// such as those to 10.
#define MAX_SUBS							10

struct SUB
{
	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 strSub;			// Text to replace it with.  Can contain vars and procs.
	CString strGroup;
	BOOL bEnabled;
};

// Temporary object used to handle overlapping buffers in a substitution.
extern CTextLine _tlSub;

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

	// Adds a substitute to the list.  The sbustittiue is inserted into the
	// list in sorted order.
	int Add(const char *pszTrigger, const char *pszSub,
		const char *pszGroup);

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

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

	void SubToTrigger(SUB *pSub, CString &strTrigger);
	void CopySub(SUB *pDest, SUB *pSource);

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

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

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

	SUB* GetAt(int nIndex);

	// Replaces the text in tl, starting from nStart.  nOrigLen is the len of
	// the text to be replaced.  pszReplace is the new text.  nReplaceLen is
	// the length of pszReplace. bWholeLine replaces the whole line with the
	// text of the sub.
	// Returns TRUE if successful. FALSE means that inserting the sub would
	// make tl exceed max len.
	BOOL ReplaceText(CTextLine &tl, int nStart, int nOrigLen, const char *pszReplace, int nReplaceLen, BOOL bWholeLine);

	// Pass in the line to check against the action list.  If an action
	// matches, the replacement text is passed back in strLine.  
	void CheckSub(CTextLine &tl);

	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:
	// This is an array of bools that is cleared each time the substitutes are checked.
	// It keeps track of which subs have already been used to prevent a sub from subbing
	// itself.
	BOOL *m_pbUsed;

	CPtrArray m_ptrList;
	int m_nCount;
	int m_nGetIndex;
};