Tokenizer and analyzer package supporting precedence prioritized rules

/*********************************************************************
	Copyright (C) 2001 by

		Alexander Berthold, alexander-berthold@web.de.
		Hoegestr. 54
		79108 Freiburg i. Breisgau
		Germany

    -- This file is part of cxtPackage --

    "cxtPackage" is free software; you can redistribute it and/or 
	modify it under the terms of the GNU Lesser General Public 
	License as published by the Free Software Foundation; either 
	version 2 of the License, or any later version.

    "cxtPackage" is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser General Public
	License along with "cxtPackage"; if not, write to the Free 
	Software  Foundation, Inc., 59 Temple Place, Suite 330, 
	Boston, MA  02111-1307  USA

    ---------------------------------------------------------------
      If you find any bugs or if you make other corrections/
	  enhancements, i'd appreciate if you'd let me know about 
	  that. My email is
  
       alexander-berthold@web.de
  
      If you share this code, do not remove this text.
    ---------------------------------------------------------------

Class:      cxtPackage
Author:     Alexander Berthold
Copyright:  Alexander Berthold
Date:       2001/06/12
Version:	0.1.02
Purpose:    Serves as interface to cxTokenizer / cxAnalyzer.
			Provides methods to conveniently create a custom
			tokenizer and analyzer.


Version history:

	-	2001/06/04
		Released first version.

	-	2001/06/12
		Added support for cxaStatusCookie in papbCheckForRule.
		Current source labeled version 0.1.02
		
*********************************************************************/

// cxtPackage.h: interface for the cxtPackage class.
//
//////////////////////////////////////////////////////////////////////

#if !defined(AFX_CXTPACKAGE_H__073D39C0_EDE2_461E_9CA8_BE5E52C98860__INCLUDED_)
#define AFX_CXTPACKAGE_H__073D39C0_EDE2_461E_9CA8_BE5E52C98860__INCLUDED_

#if _MSC_VER > 1000
#pragma once
#endif // _MSC_VER > 1000

#define	CXTCFR_VALID		((cxaParseBranch*)0)
#define	CXTCFR_INVALID		((cxaParseBranch*)1)

class cxtPackage : public cxTokenizerListener
{
// Construction/Destruction
public:
	cxtPackage(std::tstringstream& init);
	virtual ~cxtPackage();

// Attributes
protected:
	// token - map
	cxTokenizerMap			m_xtmTokMap;
	// the tokenizer object
	cxTokenizer				*m_pxtTokenizer;
	// the grammar analyzer map
	cxAnalyzerTypeMap		*m_patmRuleMap;
	// the grammar analyzer object
	cxAnalyzerMain			*m_pamParser;
	// the token stream
	cxaTokenStream			*m_patsTokens;

// ReadUntilDelimeter - specific attributes
protected:
	// no. of break-id values
	int						m_nCountBreakIDValues;
	// array of break-id values
	int						*m_pnBreakIDValues;
	// a delimeting token has been recognized
	bool					m_fBreakRead;
	// no. of tokens read
	int						m_nTokenCount;

// patCheckForRule - specific attributes
protected:
	// the current starting position within the token stream
	cxaTokenStream::const_iterator	m_itCurrentToken;


// Operations
public:
	const cxaTokenStream	*patsGetTokenStream() const
							{ return m_patsTokens;	};
	void					vSetInputStream(cxTokenizerInputStream* pxtis);
	void					vSetStartFromBeginning();
	void					vSetStartFrom(const cxaTokenStream::const_iterator itStartPos);
	void					vFlush(const cxaTokenStream::const_iterator itEndPos);
	void					vFlush();
	void					vSetDelimeterIDs(const int *pnIDValues, int nCount=0);
	int						nReadUntilDelimeter();
	cxaParseBranch*			papbCheckForRule(int nIDValue, cxaTokenStream::const_iterator *pend, cxaStatusCookie* pascCondition=NULL, bool fTestOnly = false);
	void					vRebalance(cxaParseBranch *papbBranch, int nIDValue) const;

// cxTokenizerListener operations
public:
	virtual	void			vRegisterToken(	const std::tstring& strTokenText, const cxTokenizerTokenRule* pltrRule,
											const cxTokenizerInputStream *ptisStream);

// ctkCheckValid operations
public:
#ifdef _DEBUG
	virtual bool			fCheckValid() const;
	static bool				fRunDiagnostics();
#else
	virtual bool			fCheckValid() const { return true; };
#endif

// ctkExternalObjectPointer operations
public:
	virtual	bool			fShouldDelete() const { return false;};
};

#endif // !defined(AFX_CXTPACKAGE_H__073D39C0_EDE2_461E_9CA8_BE5E52C98860__INCLUDED_)