userlists.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_LIST_ARRAY_SIZE		150
#define DEFAULT_LIST_GROW_SIZE		20

struct USER_LIST
{
	CString		strListName;		// User defined name of the list.
	CStringMap	mapList;				// Using a CStringMap her because
											// it will serve my purpose even
											// though it is a little overkill.
	CString		strGroup;
};

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

	// Adds an item to an existing list.
	int AddItem(const char *pszListName, const char *pszItem);
	int AddItem(int nListIndex, const char *pszItem);

	// Removes an item from a list.
	BOOL RemoveItem(const char *pszListName, const char *pszItem);
	BOOL RemoveItem(const char *pszListName, int nItemIndex);
	BOOL RemoveItem(int nListIndex, const char *pszItem);
	BOOL RemoveItem(int nListIndex, int nItemIndex);

	// Pass in the name of a list to search for.  Returns a pointer
	// to that list if found, else returns NULL.
	USER_LIST* FindByName(const char *pszListName);

	// Adds a user list to the internal list.
	int AddList(USER_LIST *pNewList);

	// Removes a user list from the internal list.
	BOOL RemoveList(int nListIndex);
	BOOL RemoveList(const char *pszListName);
	void RemoveAll();
	int  RemoveGroup(const char *pszGroup);

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

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

	USER_LIST* GetAt(int nIndex);

	// 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;
};