/*-
 * Copyright (c) 2004 - 2011 CTPP Team
 *
 * 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.
 * 4. Neither the name of the CTPP Team nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``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 REGENTS OR CONTRIBUTORS 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.
 *
 *      CTPP2CharIterator.hpp
 *
 * $CTPP$
 */
#ifndef _CTPP2_CHAR_ITERATOR_HPP__
#define _CTPP2_CHAR_ITERATOR_HPP__ 1

/**
  @file CTPP2CharIterator.hpp
  @brief String iterator
*/

#include "CTPP2Types.h"

namespace CTPP // C++ Template Engine
{

/**
  @class CharIterator CTPP2CharIterator.hpp <CTPP2CharIterator.hpp>
  @brief Character iterator
*/
template <typename T> class CharIterator
{
public:
	/** Data string           */
	T       * szData;
	/** Current position      */
	INT_32    iPos;
	/** Current Line          */
	INT_32    iLine;
	/** Current line position */
	INT_32    iLinePos;
public:
	/**
	  @brief Constructor
	  @param szIData - data
	*/
	inline CharIterator(T * szIData): szData(szIData), iPos(0), iLine(1), iLinePos(1) { ;; }

	/**
	  @brief Operator *
	  @return reference to symbol
	*/
	inline T operator*() { return szData[iPos]; }

	/**
	  @brief Pre increment operator
	  @return reference to self
	*/
	inline CharIterator operator++()
	{
		if (szData[iPos] == '\n') { ++iLine; iLinePos = 0; }
		++iLinePos;
		++iPos;

	return *this;
	}

	/**
	  @brief Post increment operator
	  @return reference to self
	*/
	inline CharIterator operator++(int)
	{
		CharIterator oTMP = *this;

		if (szData[iPos] == '\n') { ++iLine; iLinePos = 0; }
		++iLinePos;
		++iPos;

	return oTMP;
	}

	/**
	  @brief Compare two iterators
	  @return true if iterators are equal
	*/
	inline bool operator==(const CharIterator & x) const throw() { return ((szData + iPos) == (x.szData + x.iPos)); }

	/**
	  @brief Compare two iterators
	  @return true if iterators are NOT equal
	*/
	inline bool operator!=(const CharIterator & x) const throw() { return ((szData + iPos) != (x.szData + x.iPos)); }

	/**
	  @brief Get data
	  @return pointer to current data
	*/
	inline T * operator()() { return (szData + iPos); }

	/**
	  @brief Get data
	  @return pointer to current data
	*/
	inline INT_32 GetLine()    const throw() { return iLine; }

	/**
	  @brief Get data
	  @return pointer to current data
	*/
	inline INT_32 GetLinePos() const throw() { return iLinePos; }

	/**
	  @brief Get data
	  @return pointer to current data
	*/
	inline INT_32 GetPos()     const throw() { return iPos; }
};


typedef CharIterator<CCHAR_8>  CCharIterator;

} // namespace CTPP
#endif // _CTPP2_CHAR_ITERATOR_HPP__
// End.
