macros.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_MACRO_ARRAY_SIZE		150
#define DEFAULT_MACRO_GROW_SIZE		20

// Key names are created as follows:
// prefix 'a' = alt
// prefix 'c' = ctrl
// prefix 's' = shift
// name of the key
// af1 = Alt-F1
// cf1 = Ctrl-F1
// sf1 = Shift-F1
// asf1 = Alt-Shift-F1
// aa = Alt-A
// acsa = Alt-Shift-Control-A

struct KEYVALUES
{
	char szKeyName[31];
	int  nKeyCode;
};

struct MACRO
{
	CString strKeyName;	// F1, AF1, CF1, etc...
	int nKeyID;				// KeyID from the KEYBOARDCHAR structure.
	CString strText;		// What the user has defined for it.
	BOOL bSend;				// TRUE to send to mud, FALSE stick in input line.
	BOOL bCR;				// This is only relevant if bSend is FALSE.  When
								// true the text is sent to input line with a CR.
	CString strGroup;
	BOOL	  bEnabled;
};

struct KEYBOARDCHAR;

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

	// Adds a macro to the list.
	BOOL Assign(const char *pszKey, const char *pszText,
		const char *pszGroup);

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

	BOOL DisableMacro(const char *pszKey);
	BOOL EnableMacro(const char *pszKey);

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

	// Converts the text name to a key ID.  Returns 0 if the name
	// is an invalid key name.
	int NameToKeyID(const char *pszKey);

	// Pass in a key name, returns TRUE and fill in macro
	// if it finds it.
	MACRO *FindKeyByName(const char *pszKey);
	MACRO *FindKeyByValue(KEYBOARDCHAR &kbch);

	// Walks the list.
	MACRO *GetFirst();
	MACRO *GetNext();
	MACRO *GetAt(int nIndex);

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

private:
	CPtrArray m_ptrList;
	int m_nCount;
   int m_nGetIndex;

	// Pass in the name of a key, returns the virtual key code.
	int KeyCodeFromName(const char *pszName);
};