rep.h

Go to the documentation of this file.

/*
**************************************************************************
* Copyright (C) 1999-2012, International Business Machines Corporation and
* others. All Rights Reserved.
**************************************************************************
*   Date        Name        Description
*   11/17/99    aliu        Creation.  Ported from java.  Modified to
*                           match current UnicodeString API.  Forced
*                           to use name "handleReplaceBetween" because
*                           of existing methods in UnicodeString.
**************************************************************************
*/
 
#ifndef REP_H
#define REP_H
 
#include "unicode/uobject.h"
 
U_NAMESPACE_BEGIN
 
class UnicodeString;
 
class U_COMMON_API Replaceable : public UObject {
 
public:
    virtual ~Replaceable();
 
    inline int32_t length() const;
 
    inline UChar charAt(int32_t offset) const;
 
    inline UChar32 char32At(int32_t offset) const;
 
    virtual void extractBetween(int32_t start,
                                int32_t limit,
                                UnicodeString& target) const = 0;
 
    virtual void handleReplaceBetween(int32_t start,
                                      int32_t limit,
                                      const UnicodeString& text) = 0;
    // Note: All other methods in this class take the names of
    // existing UnicodeString methods.  This method is the exception.
    // It is named differently because all replace methods of
    // UnicodeString return a UnicodeString&.  The 'between' is
    // required in order to conform to the UnicodeString naming
    // convention; API taking start/length are named <operation>, and
    // those taking start/limit are named <operationBetween>.  The
    // 'handle' is added because 'replaceBetween' and
    // 'doReplaceBetween' are already taken.
 
    virtual void copy(int32_t start, int32_t limit, int32_t dest) = 0;
 
    virtual UBool hasMetaData() const;
 
    virtual Replaceable *clone() const;
 
protected:
 
    inline Replaceable();
 
    /*
     * Assignment operator not declared. The compiler will provide one
     * which does nothing since this class does not contain any data members.
     * API/code coverage may show the assignment operator as present and
     * untested - ignore.
     * Subclasses need this assignment operator if they use compiler-provided
     * assignment operators of their own. An alternative to not declaring one
     * here would be to declare and empty-implement a protected or public one.
    Replaceable &Replaceable::operator=(const Replaceable &);
     */
 
    virtual int32_t getLength() const = 0;
 
    virtual UChar getCharAt(int32_t offset) const = 0;
 
    virtual UChar32 getChar32At(int32_t offset) const = 0;
};
 
inline Replaceable::Replaceable() {}
 
inline int32_t
Replaceable::length() const {
    return getLength();
}
 
inline UChar
Replaceable::charAt(int32_t offset) const {
    return getCharAt(offset);
}
 
inline UChar32
Replaceable::char32At(int32_t offset) const {
    return getChar32At(offset);
}
 
// There is no rep.cpp, see unistr.cpp for Replaceable function implementations.
 
U_NAMESPACE_END
 
#endif