ICU 75.1 75.1
Loading...
Searching...
No Matches
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
17#if U_SHOW_CPLUSPLUS_API
18
24#if !UCONFIG_NO_COLLATION && !UCONFIG_NO_BREAK_ITERATION
25
26#include "unicode/uobject.h"
27#include "unicode/unistr.h"
28#include "unicode/chariter.h"
29#include "unicode/brkiter.h"
30#include "unicode/usearch.h"
31
35struct USearch;
39typedef struct USearch USearch;
40
41U_NAMESPACE_BEGIN
42
83
84public:
85
86 // public constructors and destructors -------------------------------
87
95
101
102 // public get and set methods ----------------------------------------
103
118
127 virtual int32_t getOffset() const = 0;
128
141
149
167
183
199
216
228
239 virtual void setText(const UnicodeString &text, UErrorCode &status);
240
257
263 const UnicodeString& getText() const;
264
265 // operator overloading ----------------------------------------------
266
275 virtual bool operator==(const SearchIterator &that) const;
276
283 bool operator!=(const SearchIterator &that) const;
284
285 // public methods ----------------------------------------------------
286
294 virtual SearchIterator* safeClone() const = 0;
295
310
329
344
369
385
400
409 virtual void reset();
410
411protected:
412 // protected data members ---------------------------------------------
413
419
429
435
436 // protected constructors and destructors -----------------------------
437
444
461 BreakIterator *breakiter = nullptr);
462
483
484 // protected methods --------------------------------------------------
485
493
514 = 0;
515
536 = 0;
537
548 virtual void setMatchLength(int32_t length);
549
561
567};
568
569inline bool SearchIterator::operator!=(const SearchIterator &that) const
570{
571 return !operator==(that);
572}
574
575#endif /* #if !UCONFIG_NO_COLLATION */
576
577#endif /* U_SHOW_CPLUSPLUS_API */
578
579#endif
580
C++ API: Break Iterator.
C++ API: Character Iterator.
The BreakIterator class implements methods for finding the location of boundaries in text.
Definition brkiter.h:106
Abstract class that defines an API for iteration on text objects.
Definition chariter.h:361
"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:82
USearch * m_search_
C search data struct.
Definition search.h:418
SearchIterator(CharacterIterator &text, BreakIterator *breakiter=nullptr)
Constructor for use by subclasses.
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 getMatchedLength() const
Returns the length of text in the string which matches the search pattern.
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.
void setAttribute(USearchAttribute attribute, USearchAttributeValue value, UErrorCode &status)
Sets the text searching attributes located in the enum USearchAttribute with values from the enum USe...
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 ...
virtual int32_t getOffset() const =0
Return the current index in the text being searched.
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.
int32_t last(UErrorCode &status)
Returns the last index in the target text at which it matches the search pattern.
const UnicodeString & getText() const
Return the string text to be searched.
virtual void setText(const UnicodeString &text, UErrorCode &status)
Set the string text to be searched.
SearchIterator()
Default constructor.
const BreakIterator * getBreakIterator() const
Returns the BreakIterator that is used to restrict the points at which matches are detected.
UnicodeString m_text_
Unicode string version of the search text.
Definition search.h:434
int32_t getMatchedStart() const
Returns the index to the match in the text string that was searched.
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.
virtual SearchIterator * safeClone() const =0
Returns a copy of SearchIterator with the same behavior, and iterating over the same text,...
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:428
virtual bool operator==(const SearchIterator &that) const
Equality operator.
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=nullptr)
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:296
U_EXPORT UBool operator==(const StringPiece &x, const StringPiece &y)
Global operator == for StringPiece.
bool operator!=(const StringPiece &x, const StringPiece &y)
Global operator != for StringPiece.
struct USearch USearch
Definition search.h:39
C++ API: Unicode String.
C++ API: Common ICU base class UObject.
C API: StringSearch.
USearchAttribute
Definition usearch.h:167
USearchAttributeValue
Definition usearch.h:209
Basic definitions for ICU, for both C and C++ APIs.
UErrorCode
Standard ICU4C error code type, a substitute for exceptions.
Definition utypes.h:415
#define U_I18N_API
Set to export library symbols from inside the i18n library, and to import them from outside.
Definition utypes.h:301