ICU 62.1 62.1
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
33struct USearch;
37typedef struct USearch USearch;
38
40
82
83public:
84
85 // public constructors and destructors -------------------------------
86
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
140
148
165 int32_t getMatchedStart(void) const;
166
181 int32_t getMatchedLength(void) const;
182
198
215
226 const BreakIterator * getBreakIterator(void) const;
227
238 virtual void setText(const UnicodeString &text, UErrorCode &status);
239
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
309
328
343
368
384
399
408 virtual void reset();
409
410protected:
411 // protected data members ---------------------------------------------
412
418
428
434
435 // protected constructors and destructors -----------------------------
436
443
461
482
483 // protected methods --------------------------------------------------
484
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
566};
567
568inline UBool SearchIterator::operator!=(const SearchIterator &that) const
569{
570 return !operator==(that);
571}
573
574#endif /* #if !UCONFIG_NO_COLLATION */
575
576#endif
577
C++ API: Break Iterator.
C++ API: Character Iterator.
The BreakIterator class implements methods for finding the location of boundaries in text.
Definition brkiter.h:102
Abstract class that defines an API for iteration on text objects.
Definition chariter.h:358
"Smart pointer" base class; do not use directly: use LocalPointer etc.
SearchIterator is an abstract base class that provides methods to search for a pattern within a text ...
Definition search.h:81
USearch * m_search_
C search data struct.
Definition search.h:417
int32_t getMatchedLength(void) const
Returns the length of text in the string which matches the search pattern.
SearchIterator(const SearchIterator &other)
Copy constructor that creates a SearchIterator instance with the same behavior, and iterating over th...
SearchIterator & operator=(const SearchIterator &that)
Assignment operator.
int32_t next(UErrorCode &status)
Returns the index of the next point at which the text matches the search pattern, starting from the c...
virtual void setMatchLength(int32_t length)
Sets the length of the currently matched string in the text string to be searched.
int32_t first(UErrorCode &status)
Returns the first index at which the string text matches the search pattern.
const UnicodeString & getText(void) const
Return the string text to be searched.
void setAttribute(USearchAttribute attribute, USearchAttributeValue value, UErrorCode &status)
Sets the text searching attributes located in the enum USearchAttribute with values from the enum USe...
const BreakIterator * getBreakIterator(void) const
Returns the BreakIterator that is used to restrict the points at which matches are detected.
virtual int32_t handleNext(int32_t position, UErrorCode &status)=0
Abstract method which subclasses override to provide the mechanism for finding the next match in the ...
SearchIterator(CharacterIterator &text, BreakIterator *breakiter=NULL)
Constructor for use by subclasses.
int32_t previous(UErrorCode &status)
Returns the index of the previous point at which the string text matches the search pattern,...
int32_t preceding(int32_t position, UErrorCode &status)
Returns the first index less than position at which the string text matches the search pattern.
virtual SearchIterator * safeClone(void) const =0
Returns a copy of SearchIterator with the same behavior, and iterating over the same text,...
virtual UBool operator==(const SearchIterator &that) const
Equality operator.
int32_t last(UErrorCode &status)
Returns the last index in the target text at which it matches the search pattern.
virtual int32_t getOffset(void) const =0
Return the current index in the text being searched.
int32_t getMatchedStart(void) const
Returns the index to the match in the text string that was searched.
virtual void setText(const UnicodeString &text, UErrorCode &status)
Set the string text to be searched.
SearchIterator()
Default constructor.
UnicodeString m_text_
Unicode string version of the search text.
Definition search.h:433
virtual void setMatchStart(int32_t position)
Sets the offset of the currently matched string in the text string to be searched.
void setMatchNotFound()
sets match not found
int32_t following(int32_t position, UErrorCode &status)
Returns the first index equal or greater than position at which the string text matches the search pa...
virtual void reset()
Resets the iteration.
void setBreakIterator(BreakIterator *breakiter, UErrorCode &status)
Set the BreakIterator that will be used to restrict the points at which matches are detected.
void getMatchedText(UnicodeString &result) const
Returns the text that was matched by the most recent call to first, next, previous,...
BreakIterator * m_breakiterator_
Break iterator.
Definition search.h:427
virtual int32_t handlePrev(int32_t position, UErrorCode &status)=0
Abstract method which subclasses override to provide the mechanism for finding the previous match in ...
USearchAttributeValue getAttribute(USearchAttribute attribute) const
Gets the text searching attributes.
virtual void setOffset(int32_t position, UErrorCode &status)=0
Sets the index to point to the given position, and clears any state that's affected.
virtual void setText(CharacterIterator &text, UErrorCode &status)
Set the string text to be searched.
SearchIterator(const UnicodeString &text, BreakIterator *breakiter=NULL)
Constructor for use by subclasses.
virtual ~SearchIterator()
Destructor.
UObject is the common ICU "boilerplate" class.
Definition uobject.h:223
UnicodeString is a string class that stores Unicode characters directly and provides similar function...
Definition unistr.h:287
U_EXPORT UBool operator==(const StringPiece &x, const StringPiece &y)
Global operator == for StringPiece.
UBool operator!=(const StringPiece &x, const StringPiece &y)
Global operator != for StringPiece.
struct USearch USearch
Definition search.h:37
int8_t UBool
The ICU boolean type.
Definition umachine.h:236
C++ API: Unicode String.
C++ API: Common ICU base class UObject.
C API: StringSearch.
USearchAttribute
Definition usearch.h:163
USearchAttributeValue
Definition usearch.h:205
Basic definitions for ICU, for both C and C++ APIs.
#define NULL
Define NULL if necessary, to nullptr for C++ and to ((void *)0) for C.
Definition utypes.h:188
UErrorCode
Error code to replace exception handling, so that the code is compatible with all C++ compilers,...
Definition utypes.h:396
#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_END
This is used to end a declaration of a public ICU C++ API.
Definition uversion.h:138
#define U_NAMESPACE_BEGIN
This is used to begin a declaration of a public ICU C++ API.
Definition uversion.h:137