ICU 49.1.1  49.1.1
brkiter.h
Go to the documentation of this file.
1 /*
2 ********************************************************************************
3 * Copyright (C) 1997-2011, 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 
509 #ifndef U_HIDE_INTERNAL_API
510 
516  const char *getLocaleID(ULocDataLocaleType type, UErrorCode& status) const;
517 #endif /* U_HIDE_INTERNAL_API */
518 
544  virtual BreakIterator &refreshInputText(UText *input, UErrorCode &status) = 0;
545 
546  private:
547  static BreakIterator* buildInstance(const Locale& loc, const char *type, int32_t kind, UErrorCode& status);
548  static BreakIterator* createInstance(const Locale& loc, int32_t kind, UErrorCode& status);
549  static BreakIterator* makeInstance(const Locale& loc, int32_t kind, UErrorCode& status);
550 
551  friend class ICUBreakIteratorFactory;
552  friend class ICUBreakIteratorService;
553 
554 protected:
555  // Do not enclose protected default/copy constructors with #ifndef U_HIDE_INTERNAL_API
556  // or else the compiler will create a public ones.
558  BreakIterator();
562  BreakIterator (const BreakIterator &other) : UObject(other), fBufferClone(FALSE) {}
563 
564 private:
565 
567  char actualLocale[ULOC_FULLNAME_CAPACITY];
568  char validLocale[ULOC_FULLNAME_CAPACITY];
569 
574  BreakIterator& operator=(const BreakIterator&);
575 };
576 
578 {
579  return fBufferClone;
580 }
581 
583 
584 #endif /* #if !UCONFIG_NO_BREAK_ITERATION */
585 
586 #endif // _BRKITER
587 //eof
588