/**
 * @file llkeywords.h
 * @brief Keyword list for LSL
 *
 * $LicenseInfo:firstyear=2001&license=viewergpl$
 *
 * Copyright (c) 2001-2009, Linden Research, Inc.
 *
 * Second Life Viewer Source Code
 * The source code in this file ("Source Code") is provided by Linden Lab
 * to you under the terms of the GNU General Public License, version 2.0
 * ("GPL"), unless you have obtained a separate licensing agreement
 * ("Other License"), formally executed by you and Linden Lab.  Terms of
 * the GPL can be found in doc/GPL-license.txt in this distribution, or
 * online at http://secondlifegrid.net/programs/open_source/licensing/gplv2
 *
 * There are special exceptions to the terms and conditions of the GPL as
 * it is applied to this Source Code. View the full text of the exception
 * in the file doc/FLOSS-exception.txt in this software distribution, or
 * online at
 * http://secondlifegrid.net/programs/open_source/licensing/flossexception
 *
 * By copying, modifying or distributing this software, you acknowledge
 * that you have read and understood your obligations described above,
 * and agree to abide by those obligations.
 *
 * ALL LINDEN LAB SOURCE CODE IS PROVIDED "AS IS." LINDEN LAB MAKES NO
 * WARRANTIES, EXPRESS, IMPLIED OR OTHERWISE, REGARDING ITS ACCURACY,
 * COMPLETENESS OR PERFORMANCE.
 * $/LicenseInfo$
 */

#ifndef LL_LLKEYWORDS_H
#define LL_LLKEYWORDS_H

#include <map>
#include <list>
#include <deque>

#include "llstring.h"
#include "llpreprocessor.h"
#include "llcolor3.h"

class LLTextSegment;

class LLKeywordToken
{
public:
	enum TOKEN_TYPE { WORD, LINE, TWO_SIDED_DELIMITER, ONE_SIDED_DELIMITER };

	LLKeywordToken(TOKEN_TYPE type, const LLColor3& color,
				   const LLWString& token, const LLWString& tool_tip)
	:	mType(type),
		mToken(token),
		mColor(color),
		mToolTip(tool_tip)
	{
	}

	bool isHead(const llwchar* s, bool search_end_c_comment = false) const;
	LL_INLINE S32				getLength() const	{ return mToken.size(); }
	LL_INLINE const LLWString&	getToken() const	{ return mToken; }
	LL_INLINE const LLColor3&	getColor() const	{ return mColor; }
	LL_INLINE TOKEN_TYPE		getType() const		{ return mType; }
	LL_INLINE const LLWString&	getToolTip() const	{ return mToolTip; }

#if LL_DEBUG
	void						dump();
#endif

private:
	TOKEN_TYPE	mType;
	LLWString	mToken;
	LLColor3	mColor;
	LLWString	mToolTip;
};

class LLKeywords
{
protected:
	LOG_CLASS(LLKeywords);

public:
	LLKeywords();
	~LLKeywords();

	bool loadFromFile(const std::string& filename);
	LL_INLINE bool isLoaded() const					{ return mLoaded; }

	void findSegments(std::vector<LLTextSegment*>* seg_list,
					  const LLWString& text, const LLColor4& default_color);

	// Add the token as described
	void addToken(LLKeywordToken::TOKEN_TYPE type, const std::string& key,
				  const LLColor3& color,
				  const std::string& tool_tip = LLStringUtil::null);

	typedef std::map<LLWString, LLKeywordToken*> word_token_map_t;
	typedef word_token_map_t::const_iterator keyword_iterator_t;
	LL_INLINE keyword_iterator_t begin() const		{ return mWordTokenMap.begin(); }
	LL_INLINE keyword_iterator_t end() const		{ return mWordTokenMap.end(); }

#if LL_DEBUG
	void dump();
#endif

private:
	LLColor3 readColor(const std::string& s);
	void insertSegment(std::vector<LLTextSegment*>* seg_list,
					   LLTextSegment* new_segment, S32 text_len,
					   const LLColor4& default_color);

private:
	word_token_map_t	mWordTokenMap;

	typedef std::deque<LLKeywordToken*> token_list_t;
	token_list_t		mLineTokenList;
	token_list_t		mDelimiterTokenList;

	bool				mLoaded;
};

#endif  // LL_LLKEYWORDS_H