Main Page | Class Hierarchy | Alphabetical List | Data Structures | File List | Data Fields | Globals | Related Pages

brkiter.h

00001 /*
00002 ********************************************************************************
00003 *   Copyright (C) 1997-2003, International Business Machines
00004 *   Corporation and others.  All Rights Reserved.
00005 ********************************************************************************
00006 *
00007 * File brkiter.h
00008 *
00009 * Modification History:
00010 *
00011 *   Date        Name        Description
00012 *   02/18/97    aliu        Added typedef for TextCount.  Made DONE const.
00013 *   05/07/97    aliu        Fixed DLL declaration.
00014 *   07/09/97    jfitz       Renamed BreakIterator and interface synced with JDK
00015 *   08/11/98    helena      Sync-up JDK1.2.
00016 *   01/13/2000  helena      Added UErrorCode parameter to createXXXInstance methods.
00017 ********************************************************************************
00018 */
00019 
00020 #ifndef BRKITER_H
00021 #define BRKITER_H
00022 
00023 #include "unicode/utypes.h"
00024 
00025 #if UCONFIG_NO_BREAK_ITERATION
00026 
00027 U_NAMESPACE_BEGIN
00028 
00029 /*
00030  * Allow the declaration of APIs with pointers to BreakIterator
00031  * even when break iteration is removed from the build.
00032  */
00033 class BreakIterator;
00034 
00035 U_NAMESPACE_END
00036 
00037 #else
00038 
00039 #include "unicode/uobject.h"
00040 #include "unicode/unistr.h"
00041 #include "unicode/chariter.h"
00042 #include "unicode/locid.h"
00043 #include "unicode/ubrk.h"
00044 #include "unicode/strenum.h"
00045 
00046 U_NAMESPACE_BEGIN
00047 
00048 typedef const void* URegistryKey;
00049 
00199 class U_COMMON_API BreakIterator : public UObject {
00200 public:
00205     virtual ~BreakIterator();
00206 
00220     virtual UBool operator==(const BreakIterator&) const = 0;
00221 
00228     UBool operator!=(const BreakIterator& rhs) const { return !operator==(rhs); }
00229 
00235     virtual BreakIterator* clone(void) const = 0;
00236 
00242     virtual UClassID getDynamicClassID(void) const = 0;
00243 
00250     virtual const CharacterIterator& getText(void) const = 0;
00251 
00258     virtual void  setText(const UnicodeString &text) = 0;
00259 
00266     virtual void  adoptText(CharacterIterator* it) = 0;
00267 
00273     static const int32_t DONE;
00274 
00279     virtual int32_t first(void) = 0;
00280 
00285     virtual int32_t last(void) = 0;
00286 
00293     virtual int32_t previous(void) = 0;
00294 
00301     virtual int32_t next(void) = 0;
00302 
00308     virtual int32_t current(void) const = 0;
00309 
00318     virtual int32_t following(int32_t offset) = 0;
00319 
00328     virtual int32_t preceding(int32_t offset) = 0;
00329 
00338     virtual UBool isBoundary(int32_t offset) = 0;
00339 
00349     virtual int32_t next(int32_t n) = 0;
00350 
00370     static BreakIterator* createWordInstance(const Locale& where,
00371                                                    UErrorCode& status);
00372 
00394     static BreakIterator* createLineInstance(const Locale& where,
00395                                                    UErrorCode& status);
00396 
00416     static BreakIterator* createCharacterInstance(const Locale& where,
00417                                                         UErrorCode& status);
00418 
00437     static BreakIterator* createSentenceInstance(const Locale& where,
00438                                                        UErrorCode& status);
00439 
00462     static BreakIterator* createTitleInstance(const Locale& where,
00463                                                        UErrorCode& status);
00464 
00473     static const Locale* getAvailableLocales(int32_t& count);
00474 
00484     static UnicodeString& getDisplayName(const Locale& objectLocale,
00485                                          const Locale& displayLocale,
00486                                          UnicodeString& name);
00487 
00496     static UnicodeString& getDisplayName(const Locale& objectLocale,
00497                                          UnicodeString& name);
00498 
00516     virtual BreakIterator *  createBufferClone(void *stackBuffer,
00517                                                int32_t &BufferSize,
00518                                                UErrorCode &status) = 0;
00519 
00526     inline UBool isBufferClone(void);
00527 
00540     static URegistryKey registerInstance(BreakIterator* toAdopt, const Locale& locale, UBreakIteratorType kind, UErrorCode& status);
00541 
00551     static UBool unregister(URegistryKey key, UErrorCode& status);
00552 
00559     static StringEnumeration* getAvailableLocales(void);
00560 
00561  private:
00562     static BreakIterator* makeCharacterInstance(const Locale& loc, UErrorCode& status);
00563     static BreakIterator* makeWordInstance(const Locale& loc, UErrorCode& status);
00564     static BreakIterator* makeLineInstance(const Locale& loc, UErrorCode& status);
00565     static BreakIterator* makeSentenceInstance(const Locale& loc, UErrorCode& status);
00566     static BreakIterator* makeTitleInstance(const Locale& loc, UErrorCode& status);
00567 
00568     static BreakIterator* createInstance(const Locale& loc, UBreakIteratorType kind, UErrorCode& status);
00569     static BreakIterator* makeInstance(const Locale& loc, int32_t kind, UErrorCode& status);
00570 
00571     friend class ICUBreakIteratorFactory;
00572     friend class ICUBreakIteratorService;
00573 
00574 protected:
00576     BreakIterator();
00578     UBool fBufferClone;
00580     BreakIterator (const BreakIterator &other) : UObject(other), fBufferClone(FALSE) {}
00581 private:
00586     BreakIterator& operator=(const BreakIterator&) { return *this; }
00587 };
00588 
00589 inline UBool BreakIterator::isBufferClone()
00590 {
00591     return fBufferClone;
00592 }
00593 
00594 U_NAMESPACE_END
00595 
00596 #endif /* #if !UCONFIG_NO_BREAK_ITERATION */
00597 
00598 #endif // _BRKITER
00599 //eof
00600 

Generated on Wed Sep 3 17:47:08 2003 for ICU 2.6 by doxygen 1.3.2