aliasmap.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_ALIAS_ARRAY_SIZE		150
#define DEFAULT_ALIAS_GROW_SIZE		20

struct ALIAS_MAP
{
	CString	strKey;		// The alias.
	BOOL		bHasVar;		// TRUE if %0-%9 is part of the alias.
	int		nVarNum;		// The replaceable var num.
	CString	strText;		// The text to replace the alias.
	CString  strGroup;
	BOOL		bEnabled;
};

////////////////////////////////////////////////////
// Sameple ALIAS_MAP might look like this.
// strKey		targ
// bHasVar		TRUE
// nVarNum		0
// strText		/var Target $0
//
// The /alias command that would represent is:
// "/alias {targ %0} {/var Target $0}"

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

	// This function will break the key down to fill in the
	// ALIAS_MAP.  It also places the alias in the array in
	// alphabetical order.
	int Add(const char *pszKey, const char *pszText,
		const char *pszGroup);

	// Remove an alias from the list.
	BOOL Remove(const char *pszKey);
	BOOL Remove(int nIndex);
	void RemoveAll();
	int RemoveGroup(const char *pszGroup);

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

	// Returns a pointer to the first ALIAS_MAP in the array.
	// Returns NULL if the array is empty.
	ALIAS_MAP* GetFirst();

	// Returns a pointer to the next ALIAS_MAP in the array.
	// Returns NULL when the end of the array is reached.
	ALIAS_MAP* GetNext();

	ALIAS_MAP* GetAt(int nIndex);

	// Takes some text and determine whether there is a match
	// in the alias list.  If the alis does NOT have a variable
	// then the matched is equal if pszText == pMap->strKey.
	// If the alias has a variable then the first word of
	// pszText must equal  pMap->strKey.
	ALIAS_MAP* FindMatch(const char *pszText);

	// Returns a pointer to the alias if it finds an exact text
	// match.  Otherwise returns NULL.
	ALIAS_MAP* FindExact(const char *pszText);

	// Takes a pointer to an ALIAS_MAP and converts it to the
	// command line equivalent:  /alias {text %0} {stuff $0}
	void MapToCommand(ALIAS_MAP *pMap, CString &strCommand);

	// Similar to above, only leaves out the "/alias".
	void MapToText(ALIAS_MAP *pMap, CString &strText, BOOL bIncludeGroup=TRUE);

	// Returns the number of aliases in the array.
	int GetCount()			{ return(m_nCount); }
	int GetFindIndex()	{ return(m_nGetIndex); }

	void HashIt();

private:
	CPtrArray m_ptrList;
	int m_nCount;

	int m_nGetIndex;

	CHashTable m_htHash;
};