/**************************************************************
 * 
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 * 
 *   http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 * 
 *************************************************************/



#ifndef ADC_TKPCONTX_HXX
#define ADC_TKPCONTX_HXX

// USED SERVICES
	// BASE CLASSES
	// COMPONENTS
	// PARAMETERS
#include <tokens/token.hxx>
class CharacterSource;
class TkpNullContext;

/**	@task
	Specifies a context within which tokens are interpreted in a special
	way. For example in parsing C++ there could be a context for code,
	one for comments and a third one for preprocessor statements, because
	each of these would give the same token different meanings.

	The three functions
			ReadCharChain()
			PassNewToken()
			FollowUpContext()
	have to be called in this sequence.

**/
class TkpContext
{
  public:
	// LIFECYCLE
	virtual					~TkpContext() {}

	// OPERATIONS
	/** @descr
		The functions starts to parse with the CurChar() of io_rText.
		It leaves io_rText.CurChar() at the first char of the following Token or
		the following Context.

		This function returns, when a context has parsed some characterss
		and completed a token OR left the context.
		If the token is to be ignored, it is cut from io_rText.

		If the token is to be parsed further in a different context,
		it is NOT cut from io_rText.

		After this function PassNewToken() has to be called.

		If the function has found a valid and complete token, PassNewToken()
		passes the parsed token to the internally known receiver and
		returns true. The token is cut from io_rText.
	**/
	virtual void		ReadCharChain(
							CharacterSource &	io_rText ) = 0;
	/** Has to pass the parsed token to a known receiver.
		If the token is to be parsed further in a different context,
		PassNewToken() returns false, but the token is NOT cut from io_rText.

		@return true, if a token was passed.
				false, if the token was not parsed completely by this context
					   or if the token is to be ignored.
	*/
	virtual bool		PassNewToken() = 0;
	virtual TkpContext &
						FollowUpContext() = 0;

	static TkpNullContext &
						Null_();
};

class StateMachineContext
{
  public:
	typedef TextToken::F_CRTOK F_CRTOK;

    virtual ~StateMachineContext() {}

	/// Is used by StmBoundsStatus only.
	virtual	void		PerformStatusFunction(
							uintt				i_nStatusSignal,
							F_CRTOK		        i_fTokenCreateFunction,
							CharacterSource &	io_rText ) = 0;
};

class TkpNullContext : public TkpContext
{
  public:
						~TkpNullContext();

	virtual void		ReadCharChain(
							CharacterSource &	io_rText );
	virtual bool		PassNewToken();
	virtual TkpContext &
						FollowUpContext();
};

namespace autodoc
{

class TkpDocuContext : public TkpContext
{
  public:
	virtual void	  	SetParentContext(
							TkpContext &		io_rParentContext,
							const char *		i_sMultiLineEndToken ) = 0;
	virtual void	  	AssignDealer(
							TokenDealer &		o_rDealer ) = 0;
	virtual void	   	SetMode_IsMultiLine(
							bool				i_bTrue ) = 0;
};

} // namespace autodoc

#endif