ICU 4.8.1.1  4.8.1.1
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
brkiter.h
Go to the documentation of this file.
1 /*
2 ********************************************************************************
3 * Copyright (C) 1997-2010, International Business Machines
4 * Corporation and others. All Rights Reserved.
5 ********************************************************************************
6 *
7 * File brkiter.h
8 *
9 * Modification History:
10 *
11 * Date Name Description
12 * 02/18/97 aliu Added typedef for TextCount. Made DONE const.
13 * 05/07/97 aliu Fixed DLL declaration.
14 * 07/09/97 jfitz Renamed BreakIterator and interface synced with JDK
15 * 08/11/98 helena Sync-up JDK1.2.
16 * 01/13/2000 helena Added UErrorCode parameter to createXXXInstance methods.
17 ********************************************************************************
18 */
19 
20 #ifndef BRKITER_H
21 #define BRKITER_H
22 
23 #include "unicode/utypes.h"
24 
30 #if UCONFIG_NO_BREAK_ITERATION
31 
33 
34 /*
35  * Allow the declaration of APIs with pointers to BreakIterator
36  * even when break iteration is removed from the build.
37  */
38 class BreakIterator;
39 
41 
42 #else
43 
44 #include "unicode/uobject.h"
45 #include "unicode/unistr.h"
46 #include "unicode/chariter.h"
47 #include "unicode/locid.h"
48 #include "unicode/ubrk.h"
49 #include "unicode/strenum.h"
50 #include "unicode/utext.h"
51 #include "unicode/umisc.h"
52 
54 
101 public:
106  virtual ~BreakIterator();
107 
121  virtual UBool operator==(const BreakIterator&) const = 0;
122 
129  UBool operator!=(const BreakIterator& rhs) const { return !operator==(rhs); }
130 
136  virtual BreakIterator* clone(void) const = 0;
137 
143  virtual UClassID getDynamicClassID(void) const = 0;
144 
149  virtual CharacterIterator& getText(void) const = 0;
150 
151 
166  virtual UText *getUText(UText *fillIn, UErrorCode &status) const = 0;
167 
174  virtual void setText(const UnicodeString &text) = 0;
175 
189  virtual void setText(UText *text, UErrorCode &status) = 0;
190 
199  virtual void adoptText(CharacterIterator* it) = 0;
200 
201  enum {
207  DONE = (int32_t)-1
208  };
209 
214  virtual int32_t first(void) = 0;
215 
220  virtual int32_t last(void) = 0;
221 
228  virtual int32_t previous(void) = 0;
229 
236  virtual int32_t next(void) = 0;
237 
243  virtual int32_t current(void) const = 0;
244 
253  virtual int32_t following(int32_t offset) = 0;
254 
263  virtual int32_t preceding(int32_t offset) = 0;
264 
273  virtual UBool isBoundary(int32_t offset) = 0;
274 
284  virtual int32_t next(int32_t n) = 0;
285 
305  static BreakIterator* U_EXPORT2
306  createWordInstance(const Locale& where, UErrorCode& status);
307 
329  static BreakIterator* U_EXPORT2
330  createLineInstance(const Locale& where, UErrorCode& status);
331 
351  static BreakIterator* U_EXPORT2
352  createCharacterInstance(const Locale& where, UErrorCode& status);
353 
372  static BreakIterator* U_EXPORT2
373  createSentenceInstance(const Locale& where, UErrorCode& status);
374 
397  static BreakIterator* U_EXPORT2
398  createTitleInstance(const Locale& where, UErrorCode& status);
399 
409  static const Locale* U_EXPORT2 getAvailableLocales(int32_t& count);
410 
420  static UnicodeString& U_EXPORT2 getDisplayName(const Locale& objectLocale,
421  const Locale& displayLocale,
422  UnicodeString& name);
423 
432  static UnicodeString& U_EXPORT2 getDisplayName(const Locale& objectLocale,
433  UnicodeString& name);
434 
452  virtual BreakIterator * createBufferClone(void *stackBuffer,
453  int32_t &BufferSize,
454  UErrorCode &status) = 0;
455 
462  inline UBool isBufferClone(void);
463 
464 #if !UCONFIG_NO_SERVICE
465 
477  static URegistryKey U_EXPORT2 registerInstance(BreakIterator* toAdopt,
478  const Locale& locale,
479  UBreakIteratorType kind,
480  UErrorCode& status);
481 
491  static UBool U_EXPORT2 unregister(URegistryKey key, UErrorCode& status);
492 
499  static StringEnumeration* U_EXPORT2 getAvailableLocales(void);
500 #endif
501 
507  Locale getLocale(ULocDataLocaleType type, UErrorCode& status) const;
508 
515  const char *getLocaleID(ULocDataLocaleType type, UErrorCode& status) const;
516 
517  private:
518  static BreakIterator* buildInstance(const Locale& loc, const char *type, int32_t kind, UErrorCode& status);
519  static BreakIterator* createInstance(const Locale& loc, int32_t kind, UErrorCode& status);
520  static BreakIterator* makeInstance(const Locale& loc, int32_t kind, UErrorCode& status);
521 
522  friend class ICUBreakIteratorFactory;
523  friend class ICUBreakIteratorService;
524 
525 protected:
527  BreakIterator();
531  BreakIterator (const BreakIterator &other) : UObject(other), fBufferClone(FALSE) {}
532 
533 private:
534 
536  char actualLocale[ULOC_FULLNAME_CAPACITY];
537  char validLocale[ULOC_FULLNAME_CAPACITY];
538 
543  BreakIterator& operator=(const BreakIterator&);
544 };
545 
547 {
548  return fBufferClone;
549 }
550 
552 
553 #endif /* #if !UCONFIG_NO_BREAK_ITERATION */
554 
555 #endif // _BRKITER
556 //eof
557 
The BreakIterator class implements methods for finding the location of boundaries in text...
Definition: brkiter.h:100
BreakIterator(const BreakIterator &other)
Definition: brkiter.h:531
C++ API: Unicode String.
UBreakIteratorType
The possible types of text boundaries.
Definition: ubrk.h:87
C API:misc definitions.
#define ULOC_FULLNAME_CAPACITY
Useful constant for the maximum size of the whole locale ID (including the terminating NULL and all k...
Definition: uloc.h:262
UBool isBufferClone(void)
Determine whether the BreakIterator was created in user memory by createBufferClone(), and thus should not be deleted.
Definition: brkiter.h:546
U_EXPORT UBool operator==(const StringPiece &x, const StringPiece &y)
Global operator == for StringPiece.
C API: Abstract Unicode Text API.
UBool operator!=(const BreakIterator &rhs) const
Returns the complement of the result of operator==.
Definition: brkiter.h:129
Abstract class that defines an API for iteration on text objects.
Definition: chariter.h:356
UBool fBufferClone
Definition: brkiter.h:529
#define U_NAMESPACE_BEGIN
This is used to begin a declaration of a public ICU C++ API.
Definition: uversion.h:131
UnicodeString is a string class that stores Unicode characters directly and provides similar function...
Definition: unistr.h:188
#define U_EXPORT2
Definition: platform.h:314
C++ API: Common ICU base class UObject.
const void * URegistryKey
Opaque type returned by registerInstance, registerFactory and unregister for service registration...
Definition: umisc.h:55
#define U_NAMESPACE_END
This is used to end a declaration of a public ICU C++ API.
Definition: uversion.h:132
UObject is the common ICU "boilerplate" class.
Definition: uobject.h:215
void * UClassID
UClassID is used to identify classes without using RTTI, since RTTI is not yet supported by all C++ c...
Definition: utypes.h:385
UErrorCode
Error code to replace exception handling, so that the code is compatible with all C++ compilers...
Definition: utypes.h:639
Base class for 'pure' C++ implementations of uenum api.
Definition: strenum.h:55
ULocDataLocaleType
Constants for *_getLocale() Allow user to select whether she wants information on requested...
Definition: uloc.h:336
C API: BreakIterator.
C++ API: String Enumeration.
C++ API: Locale ID object.
UText struct.
Definition: utext.h:1482
Basic definitions for ICU, for both C and C++ APIs.
#define FALSE
The FALSE value of a UBool.
Definition: umachine.h:236
#define U_COMMON_API
Set to export library symbols from inside the common library, and to import them from outside...
Definition: utypes.h:520
C++ API: Character Iterator.
A Locale object represents a specific geographical, political, or cultural region.
Definition: locid.h:181
virtual UClassID getDynamicClassID() const =0
ICU4C "poor man's RTTI", returns a UClassID for the actual ICU class.
signed int int32_t
Define 64 bit limits.
Definition: pwin32.h:143
int8_t UBool
The ICU boolean type.
Definition: umachine.h:228