ICU 62.1 62.1
stsearch.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-2014 IBM and others. All rights reserved.
6**********************************************************************
7* Date Name Description
8* 03/22/2000 helena Creation.
9**********************************************************************
10*/
11
12#ifndef STSEARCH_H
13#define STSEARCH_H
14
15#include "unicode/utypes.h"
16
22#if !UCONFIG_NO_COLLATION && !UCONFIG_NO_BREAK_ITERATION
23
24#include "unicode/tblcoll.h"
25#include "unicode/coleitr.h"
26#include "unicode/search.h"
27
29
135{
136public:
137
138 // public constructors and destructors --------------------------------
139
161 StringSearch(const UnicodeString &pattern, const UnicodeString &text,
162 const Locale &locale,
165
188 const UnicodeString &text,
192
219 const Locale &locale,
222
252
260
266 virtual ~StringSearch(void);
267
280
281 // operator overloading ---------------------------------------------
282
290
299 virtual UBool operator==(const SearchIterator &that) const;
300
301 // public get and set methods ----------------------------------------
302
316 virtual void setOffset(int32_t position, UErrorCode &status);
317
326 virtual int32_t getOffset(void) const;
327
339 virtual void setText(const UnicodeString &text, UErrorCode &status);
340
356
367
377
387
393 const UnicodeString & getPattern() const;
394
395 // public methods ----------------------------------------------------
396
405 virtual void reset();
406
415 virtual SearchIterator * safeClone(void) const;
416
423
430
431protected:
432
433 // protected method -------------------------------------------------
434
457 virtual int32_t handleNext(int32_t position, UErrorCode &status);
458
481 virtual int32_t handlePrev(int32_t position, UErrorCode &status);
482
483private :
484 StringSearch(); // default constructor not implemented
485
486 // private data members ----------------------------------------------
487
492 UnicodeString m_pattern_;
497 UStringSearch *m_strsrch_;
498
499};
500
502
503#endif /* #if !UCONFIG_NO_COLLATION */
504
505#endif
506
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.
A Locale object represents a specific geographical, political, or cultural region.
Definition locid.h:188
The RuleBasedCollator class provides the implementation of Collator, using data-driven tables.
Definition tblcoll.h:113
SearchIterator is an abstract base class that provides methods to search for a pattern within a text ...
Definition search.h:81
StringSearch is a SearchIterator that provides language-sensitive text searching based on the compari...
Definition stsearch.h:135
StringSearch * clone() const
Clone this object.
StringSearch(const StringSearch &that)
Copy constructor that creates a StringSearch instance with the same behavior, and iterating over the ...
StringSearch(const UnicodeString &pattern, const UnicodeString &text, const Locale &locale, BreakIterator *breakiter, UErrorCode &status)
Creating a StringSearch instance using the argument locale language rule set.
virtual SearchIterator * safeClone(void) const
Returns a copy of StringSearch with the same behavior, and iterating over the same text,...
virtual UClassID getDynamicClassID() const
ICU "poor man's RTTI", returns a UClassID for the actual class.
StringSearch(const UnicodeString &pattern, CharacterIterator &text, const Locale &locale, BreakIterator *breakiter, UErrorCode &status)
Creating a StringSearch instance using the argument locale language rule set.
const UnicodeString & getPattern() const
Gets the search pattern.
virtual int32_t handleNext(int32_t position, UErrorCode &status)
Search forward for matching text, starting at a given location.
virtual void setOffset(int32_t position, UErrorCode &status)
Sets the index to point to the given position, and clears any state that's affected.
virtual int32_t handlePrev(int32_t position, UErrorCode &status)
Search backward for matching text, starting at a given location.
StringSearch(const UnicodeString &pattern, const UnicodeString &text, RuleBasedCollator *coll, BreakIterator *breakiter, UErrorCode &status)
Creating a StringSearch instance using the argument collator language rule set.
virtual UBool operator==(const SearchIterator &that) const
Equality operator.
RuleBasedCollator * getCollator() const
Gets the collator used for the language rules.
static UClassID getStaticClassID()
ICU "poor man's RTTI", returns a UClassID for this class.
void setCollator(RuleBasedCollator *coll, UErrorCode &status)
Sets the collator used for the language rules.
void setPattern(const UnicodeString &pattern, UErrorCode &status)
Sets the pattern used for matching.
virtual int32_t getOffset(void) const
Return the current index in the text being searched.
virtual void setText(const UnicodeString &text, UErrorCode &status)
Set the target text to be searched.
StringSearch(const UnicodeString &pattern, CharacterIterator &text, RuleBasedCollator *coll, BreakIterator *breakiter, UErrorCode &status)
Creating a StringSearch instance using the argument collator language rule set.
virtual void reset()
Reset the iteration.
virtual ~StringSearch(void)
Destructor.
virtual void setText(CharacterIterator &text, UErrorCode &status)
Set the target text to be searched.
StringSearch & operator=(const StringSearch &that)
Assignment operator.
UnicodeString is a string class that stores Unicode characters directly and provides similar function...
Definition unistr.h:287
C++ API: Collation Element Iterator.
C++ API: SearchIterator object.
C++ API: The RuleBasedCollator class implements the Collator abstract base class.
int8_t UBool
The ICU boolean type.
Definition umachine.h:236
void * UClassID
UClassID is used to identify classes without using the compiler's RTTI.
Definition uobject.h:93
struct UStringSearch UStringSearch
Data structure for searching.
Definition usearch.h:158
Basic definitions for ICU, for both C and C++ APIs.
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