blob: 5b9893178eae9b8492bb2b38e6f6fa65a7a31844 [file] [log] [blame]
/*
* Copyright © {1997-1999}, International Business Machines Corporation and others. All Rights Reserved.
*******************************************************************************
*
* File PARSEPOS.H
*
* Modification History:
*
* Date Name Description
* 07/09/97 helena Converted from java.
* 07/17/98 stephen Added errorIndex support.
* 05/11/99 stephen Cleaned up.
*******************************************************************************
*/
#ifndef PARSEPOS_H
#define PARSEPOS_H
#include "unicode/utypes.h"
/**
* <code>ParsePosition</code> is a simple class used by <code>Format</code>
* and its subclasses to keep track of the current position during parsing.
* The <code>parseObject</code> method in the various <code>Format</code>
* classes requires a <code>ParsePosition</code> object as an argument.
*
* <p>
* By design, as you parse through a string with different formats,
* you can use the same <code>ParsePosition</code>, since the index parameter
* records the current position.
*
* @version 1.3 10/30/97
* @author Mark Davis, Helena Shih
* @see java.text.Format
*/
class U_I18N_API ParsePosition {
public:
/**
* Default constructor, the index starts with 0 as default.
* @stable
*/
ParsePosition()
{ this->index = 0; this->errorIndex = -1; }
/**
* Create a new ParsePosition with the given initial index.
* @param newIndex the new text offset.
* @stable
*/
ParsePosition(UTextOffset newIndex)
{ this->index = newIndex; this->errorIndex = -1; }
/**
* Copy constructor
* @param copy the object to be copied from.
* @stable
*/
ParsePosition(const ParsePosition& copy)
{ this->index = copy.index; this->errorIndex = copy.errorIndex; }
/**
* Destructor
* @stable
*/
~ParsePosition() {}
/**
* Assignment operator
* @stable
*/
ParsePosition& operator=(const ParsePosition& copy);
/**
* Equality operator.
* @return TRUE if the two parse positions are equal, FALSE otherwise.
* @stable
*/
UBool operator==(const ParsePosition& that) const;
/**
* Equality operator.
* @return TRUE if the two parse positions are not equal, FALSE otherwise.
* @stable
*/
UBool operator!=(const ParsePosition& that) const;
/**
* Retrieve the current parse position. On input to a parse method, this
* is the index of the character at which parsing will begin; on output, it
* is the index of the character following the last character parsed.
* @return the current index.
* @stable
*/
UTextOffset getIndex(void) const;
/**
* Set the current parse position.
* @param index the new index.
* @stable
*/
void setIndex(UTextOffset index);
/**
* Set the index at which a parse error occurred. Formatters
* should set this before returning an error code from their
* parseObject method. The default value is -1 if this is not
* set.
* @stable
*/
void setErrorIndex(UTextOffset ei);
/**
* Retrieve the index at which an error occurred, or -1 if the
* error index has not been set.
* @stable
*/
UTextOffset getErrorIndex(void) const;
private:
/**
* Input: the place you start parsing.
* <br>Output: position where the parse stopped.
* This is designed to be used serially,
* with each call setting index up for the next one.
*/
UTextOffset index;
/**
* The index at which a parse error occurred.
*/
UTextOffset errorIndex;
};
inline ParsePosition&
ParsePosition::operator=(const ParsePosition& copy)
{
index = copy.index;
errorIndex = copy.errorIndex;
return *this;
}
inline UBool
ParsePosition::operator==(const ParsePosition& copy) const
{
if(index != copy.index || errorIndex != copy.errorIndex)
return FALSE;
else
return TRUE;
}
inline UBool
ParsePosition::operator!=(const ParsePosition& copy) const
{
return !operator==(copy);
}
inline UTextOffset
ParsePosition::getIndex() const
{
return index;
}
inline void
ParsePosition::setIndex(UTextOffset offset)
{
this->index = offset;
}
inline UTextOffset
ParsePosition::getErrorIndex() const
{
return errorIndex;
}
inline void
ParsePosition::setErrorIndex(UTextOffset ei)
{
this->errorIndex = ei;
}
#endif