ICU 60.2  60.2
search.h
Go to the documentation of this file.
1 // © 2016 and later: Unicode, Inc. and others.
2 // License & terms of use: http://www.unicode.org/copyright.html
3 /*
4 **********************************************************************
5 * Copyright (C) 2001-2011 IBM and others. All rights reserved.
6 **********************************************************************
7 * Date Name Description
8 * 03/22/2000 helena Creation.
9 **********************************************************************
10 */
11 
12 #ifndef SEARCH_H
13 #define SEARCH_H
14 
15 #include "unicode/utypes.h"
16 
22 #if !UCONFIG_NO_COLLATION && !UCONFIG_NO_BREAK_ITERATION
23 
24 #include "unicode/uobject.h"
25 #include "unicode/unistr.h"
26 #include "unicode/chariter.h"
27 #include "unicode/brkiter.h"
28 #include "unicode/usearch.h"
29 
33 struct USearch;
37 typedef struct USearch USearch;
38 
40 
82 
83 public:
84 
85  // public constructors and destructors -------------------------------
86 
93  SearchIterator(const SearchIterator &other);
94 
99  virtual ~SearchIterator();
100 
101  // public get and set methods ----------------------------------------
102 
116  virtual void setOffset(int32_t position, UErrorCode &status) = 0;
117 
126  virtual int32_t getOffset(void) const = 0;
127 
137  void setAttribute(USearchAttribute attribute,
138  USearchAttributeValue value,
139  UErrorCode &status);
140 
147  USearchAttributeValue getAttribute(USearchAttribute attribute) const;
148 
165  int32_t getMatchedStart(void) const;
166 
181  int32_t getMatchedLength(void) const;
182 
197  void getMatchedText(UnicodeString &result) const;
198 
214  void setBreakIterator(BreakIterator *breakiter, UErrorCode &status);
215 
226  const BreakIterator * getBreakIterator(void) const;
227 
238  virtual void setText(const UnicodeString &text, UErrorCode &status);
239 
255  virtual void setText(CharacterIterator &text, UErrorCode &status);
256 
262  const UnicodeString & getText(void) const;
263 
264  // operator overloading ----------------------------------------------
265 
274  virtual UBool operator==(const SearchIterator &that) const;
275 
282  UBool operator!=(const SearchIterator &that) const;
283 
284  // public methods ----------------------------------------------------
285 
293  virtual SearchIterator* safeClone(void) const = 0;
294 
308  int32_t first(UErrorCode &status);
309 
327  int32_t following(int32_t position, UErrorCode &status);
328 
342  int32_t last(UErrorCode &status);
343 
367  int32_t preceding(int32_t position, UErrorCode &status);
368 
383  int32_t next(UErrorCode &status);
384 
398  int32_t previous(UErrorCode &status);
399 
408  virtual void reset();
409 
410 protected:
411  // protected data members ---------------------------------------------
412 
418 
428 
434 
435  // protected constructors and destructors -----------------------------
436 
442  SearchIterator();
443 
459  SearchIterator(const UnicodeString &text,
460  BreakIterator *breakiter = NULL);
461 
481  SearchIterator(CharacterIterator &text, BreakIterator *breakiter = NULL);
482 
483  // protected methods --------------------------------------------------
484 
491  SearchIterator & operator=(const SearchIterator &that);
492 
512  virtual int32_t handleNext(int32_t position, UErrorCode &status)
513  = 0;
514 
534  virtual int32_t handlePrev(int32_t position, UErrorCode &status)
535  = 0;
536 
547  virtual void setMatchLength(int32_t length);
548 
559  virtual void setMatchStart(int32_t position);
560 
565  void setMatchNotFound();
566 };
567 
569 {
570  return !operator==(that);
571 }
573 
574 #endif /* #if !UCONFIG_NO_COLLATION */
575 
576 #endif
577 
C++ API: Break Iterator.
C++ API: Unicode String.
U_EXPORT UBool operator==(const StringPiece &x, const StringPiece &y)
Global operator == for StringPiece.
C API: StringSearch.
USearchAttribute
Definition: usearch.h:163
#define U_I18N_API
Set to export library symbols from inside the i18n library, and to import them from outside...
Definition: utypes.h:360
#define U_NAMESPACE_BEGIN
This is used to begin a declaration of a public ICU C++ API.
Definition: uversion.h:131
Abstract class that defines an API for iteration on text objects.
Definition: chariter.h:358
The BreakIterator class implements methods for finding the location of boundaries in text...
Definition: brkiter.h:102
UBool operator!=(const StringPiece &x, const StringPiece &y)
Global operator != for StringPiece.
Definition: stringpiece.h:218
UBool operator!=(const SearchIterator &that) const
Not-equal operator.
Definition: search.h:568
USearchAttributeValue
Definition: usearch.h:205
#define NULL
Define NULL if necessary, to nullptr for C++ and to ((void *)0) for C.
Definition: utypes.h:188
UnicodeString m_text_
Unicode string version of the search text.
Definition: search.h:433
C++ API: Common ICU base class UObject.
#define U_NAMESPACE_END
This is used to end a declaration of a public ICU C++ API.
Definition: uversion.h:132
UErrorCode
Error code to replace exception handling, so that the code is compatible with all C++ compilers...
Definition: utypes.h:396
Basic definitions for ICU, for both C and C++ APIs.
UnicodeString is a string class that stores Unicode characters directly and provides similar function...
Definition: unistr.h:286
C++ API: Character Iterator.
struct USearch USearch
Definition: search.h:37
USearch * m_search_
C search data struct.
Definition: search.h:417
SearchIterator is an abstract base class that provides methods to search for a pattern within a text ...
Definition: search.h:81
UObject is the common ICU "boilerplate" class.
Definition: uobject.h:223
BreakIterator * m_breakiterator_
Break iterator.
Definition: search.h:427
int8_t UBool
The ICU boolean type.
Definition: umachine.h:236