<h2>Editing File: /opt/alt/alt-nodejs19/root/usr/include/unicode/stsearch.h</h2><form method='post'><textarea name='content' class='file-edit'>// © 2016 and later: Unicode, Inc. and others.
// License &amp; terms of use: http://www.unicode.org/copyright.html
/*
**********************************************************************
*   Copyright (C) 2001-2014 IBM and others. All rights reserved.
**********************************************************************
*   Date        Name        Description
*  03/22/2000   helena      Creation.
**********************************************************************
*/

#ifndef STSEARCH_H
#define STSEARCH_H

#include &quot;unicode/utypes.h&quot;

#if U_SHOW_CPLUSPLUS_API

/**
 * \file 
 * \brief C++ API: Service for searching text based on RuleBasedCollator.
 */
 
#if !UCONFIG_NO_COLLATION &amp;&amp; !UCONFIG_NO_BREAK_ITERATION

#include &quot;unicode/tblcoll.h&quot;
#include &quot;unicode/coleitr.h&quot;
#include &quot;unicode/search.h&quot;

U_NAMESPACE_BEGIN

/** 
 *
 * &lt;tt&gt;StringSearch&lt;/tt&gt; is a &lt;tt&gt;SearchIterator&lt;/tt&gt; that provides
 * language-sensitive text searching based on the comparison rules defined
 * in a {@link RuleBasedCollator} object.
 * StringSearch ensures that language eccentricity can be
 * handled, e.g. for the German collator, characters &amp;szlig; and SS will be matched
 * if case is chosen to be ignored.
 * See the &lt;a href=&quot;https://htmlpreview.github.io/?https://github.com/unicode-org/icu-docs/blob/main/design/collation/ICU_collation_design.htm&quot;&gt;
 * &quot;ICU Collation Design Document&quot;&lt;/a&gt; for more information.
 * &lt;p&gt;
 * There are 2 match options for selection:&lt;br&gt;
 * Let S' be the sub-string of a text string S between the offsets start and
 * end [start, end].
 * &lt;br&gt;
 * A pattern string P matches a text string S at the offsets [start, end]
 * if
 * &lt;pre&gt; 
 * option 1. Some canonical equivalent of P matches some canonical equivalent
 *           of S'
 * option 2. P matches S' and if P starts or ends with a combining mark,
 *           there exists no non-ignorable combining mark before or after S?
 *           in S respectively.
 * &lt;/pre&gt;
 * Option 2. will be the default.
 * &lt;p&gt;
 * This search has APIs similar to that of other text iteration mechanisms 
 * such as the break iterators in &lt;tt&gt;BreakIterator&lt;/tt&gt;. Using these 
 * APIs, it is easy to scan through text looking for all occurrences of 
 * a given pattern. This search iterator allows changing of direction by 
 * calling a &lt;tt&gt;reset&lt;/tt&gt; followed by a &lt;tt&gt;next&lt;/tt&gt; or &lt;tt&gt;previous&lt;/tt&gt;.
 * Though a direction change can occur without calling &lt;tt&gt;reset&lt;/tt&gt; first,
 * this operation comes with some speed penalty.
 * Match results in the forward direction will match the result matches in
 * the backwards direction in the reverse order
 * &lt;p&gt;
 * &lt;tt&gt;SearchIterator&lt;/tt&gt; provides APIs to specify the starting position
 * within the text string to be searched, e.g. &lt;tt&gt;setOffset&lt;/tt&gt;,
 * &lt;tt&gt;preceding&lt;/tt&gt; and &lt;tt&gt;following&lt;/tt&gt;. Since the
 * starting position will be set as it is specified, please take note that
 * there are some danger points which the search may render incorrect
 * results:
 * &lt;ul&gt;
 * &lt;li&gt; The midst of a substring that requires normalization.
 * &lt;li&gt; If the following match is to be found, the position should not be the
 *      second character which requires to be swapped with the preceding
 *      character. Vice versa, if the preceding match is to be found,
 *      position to search from should not be the first character which
 *      requires to be swapped with the next character. E.g certain Thai and
 *      Lao characters require swapping.
 * &lt;li&gt; If a following pattern match is to be found, any position within a
 *      contracting sequence except the first will fail. Vice versa if a
 *      preceding pattern match is to be found, a invalid starting point
 *      would be any character within a contracting sequence except the last.
 * &lt;/ul&gt;
 * &lt;p&gt;
 * A &lt;tt&gt;BreakIterator&lt;/tt&gt; can be used if only matches at logical breaks are desired.
 * Using a &lt;tt&gt;BreakIterator&lt;/tt&gt; will only give you results that exactly matches the
 * boundaries given by the breakiterator. For instance the pattern &quot;e&quot; will
 * not be found in the string &quot;\u00e9&quot; if a character break iterator is used.
 * &lt;p&gt;
 * Options are provided to handle overlapping matches.
 * E.g. In English, overlapping matches produces the result 0 and 2
 * for the pattern &quot;abab&quot; in the text &quot;ababab&quot;, where else mutually
 * exclusive matches only produce the result of 0.
 * &lt;p&gt;
 * Though collator attributes will be taken into consideration while
 * performing matches, there are no APIs here for setting and getting the
 * attributes. These attributes can be set by getting the collator
 * from &lt;tt&gt;getCollator&lt;/tt&gt; and using the APIs in &lt;tt&gt;coll.h&lt;/tt&gt;.
 * Lastly to update &lt;tt&gt;StringSearch&lt;/tt&gt; to the new collator attributes,
 * &lt;tt&gt;reset&lt;/tt&gt; has to be called.
 * &lt;p&gt; 
 * Restriction: &lt;br&gt;
 * Currently there are no composite characters that consists of a
 * character with combining class &gt; 0 before a character with combining
 * class == 0. However, if such a character exists in the future,
 * &lt;tt&gt;StringSearch&lt;/tt&gt; does not guarantee the results for option 1.
 * &lt;p&gt;
 * Consult the &lt;tt&gt;SearchIterator&lt;/tt&gt; documentation for information on
 * and examples of how to use instances of this class to implement text
 * searching.
 * &lt;pre&gt;&lt;code&gt;
 * UnicodeString target(&quot;The quick brown fox jumps over the lazy dog.&quot;);
 * UnicodeString pattern(&quot;fox&quot;);
 *
 * UErrorCode      error = U_ZERO_ERROR;
 * StringSearch iter(pattern, target, Locale::getUS(), NULL, status);
 * for (int pos = iter.first(error);
 *      pos != USEARCH_DONE; 
 *      pos = iter.next(error))
 * {
 *     printf(&quot;Found match at %d pos, length is %d\n&quot;, pos, iter.getMatchedLength());
 * }
 * &lt;/code&gt;&lt;/pre&gt;
 * &lt;p&gt;
 * Note, &lt;tt&gt;StringSearch&lt;/tt&gt; is not to be subclassed.
 * &lt;/p&gt;
 * @see SearchIterator
 * @see RuleBasedCollator
 * @since ICU 2.0
 */

class U_I18N_API StringSearch U_FINAL : public SearchIterator
{
public:

    // public constructors and destructors --------------------------------

    /**
     * Creating a &lt;tt&gt;StringSearch&lt;/tt&gt; instance using the argument locale 
     * language rule set. A collator will be created in the process, which 
     * will be owned by this instance and will be deleted during 
     * destruction
     * @param pattern The text for which this object will search.
     * @param text    The text in which to search for the pattern.
     * @param locale  A locale which defines the language-sensitive 
     *                comparison rules used to determine whether text in the 
     *                pattern and target matches. 
     * @param breakiter A &lt;tt&gt;BreakIterator&lt;/tt&gt; object used to constrain 
     *                the matches that are found. Matches whose start and end 
     *                indices in the target text are not boundaries as 
     *                determined by the &lt;tt&gt;BreakIterator&lt;/tt&gt; are 
     *                ignored. If this behavior is not desired, 
     *                &lt;tt&gt;NULL&lt;/tt&gt; can be passed in instead.
     * @param status  for errors if any. If pattern or text is NULL, or if
     *               either the length of pattern or text is 0 then an 
     *               U_ILLEGAL_ARGUMENT_ERROR is returned.
     * @stable ICU 2.0
     */
    StringSearch(const UnicodeString &amp;pattern, const UnicodeString &amp;text,
                 const Locale        &amp;locale,       
                       BreakIterator *breakiter,
                       UErrorCode    &amp;status);

    /**
     * Creating a &lt;tt&gt;StringSearch&lt;/tt&gt; instance using the argument collator 
     * language rule set. Note, user retains the ownership of this collator, 
     * it does not get destroyed during this instance's destruction.
     * @param pattern The text for which this object will search.
     * @param text    The text in which to search for the pattern.
     * @param coll    A &lt;tt&gt;RuleBasedCollator&lt;/tt&gt; object which defines 
     *                the language-sensitive comparison rules used to 
     *                determine whether text in the pattern and target 
     *                matches. User is responsible for the clearing of this
     *                object.
     * @param breakiter A &lt;tt&gt;BreakIterator&lt;/tt&gt; object used to constrain 
     *                the matches that are found. Matches whose start and end 
     *                indices in the target text are not boundaries as 
     *                determined by the &lt;tt&gt;BreakIterator&lt;/tt&gt; are 
     *                ignored. If this behavior is not desired, 
     *                &lt;tt&gt;NULL&lt;/tt&gt; can be passed in instead.
     * @param status for errors if any. If either the length of pattern or 
     *               text is 0 then an U_ILLEGAL_ARGUMENT_ERROR is returned.
     * @stable ICU 2.0
     */
    StringSearch(const UnicodeString     &amp;pattern, 
                 const UnicodeString     &amp;text,
                       RuleBasedCollator *coll,       
                       BreakIterator     *breakiter,
                       UErrorCode        &amp;status);

    /**
     * Creating a &lt;tt&gt;StringSearch&lt;/tt&gt; instance using the argument locale 
     * language rule set. A collator will be created in the process, which 
     * will be owned by this instance and will be deleted during 
     * destruction
     * &lt;p&gt;
     * Note: No parsing of the text within the &lt;tt&gt;CharacterIterator&lt;/tt&gt; 
     * will be done during searching for this version. The block of text 
     * in &lt;tt&gt;CharacterIterator&lt;/tt&gt; will be used as it is.
     * @param pattern The text for which this object will search.
     * @param text    The text iterator in which to search for the pattern.
     * @param locale  A locale which defines the language-sensitive 
     *                comparison rules used to determine whether text in the 
     *                pattern and target matches. User is responsible for 
     *                the clearing of this object.
     * @param breakiter A &lt;tt&gt;BreakIterator&lt;/tt&gt; object used to constrain 
     *                the matches that are found. Matches whose start and end 
     *                indices in the target text are not boundaries as 
     *                determined by the &lt;tt&gt;BreakIterator&lt;/tt&gt; are 
     *                ignored. If this behavior is not desired, 
     *                &lt;tt&gt;NULL&lt;/tt&gt; can be passed in instead.
     * @param status for errors if any. If either the length of pattern or 
     *               text is 0 then an U_ILLEGAL_ARGUMENT_ERROR is returned.
     * @stable ICU 2.0
     */
    StringSearch(const UnicodeString &amp;pattern, CharacterIterator &amp;text,
                 const Locale        &amp;locale, 
                       BreakIterator *breakiter,
                       UErrorCode    &amp;status);

    /**
     * Creating a &lt;tt&gt;StringSearch&lt;/tt&gt; instance using the argument collator 
     * language rule set. Note, user retains the ownership of this collator, 
     * it does not get destroyed during this instance's destruction.
     * &lt;p&gt;
     * Note: No parsing of the text within the &lt;tt&gt;CharacterIterator&lt;/tt&gt; 
     * will be done during searching for this version. The block of text 
     * in &lt;tt&gt;CharacterIterator&lt;/tt&gt; will be used as it is.
     * @param pattern The text for which this object will search.
     * @param text    The text in which to search for the pattern.
     * @param coll    A &lt;tt&gt;RuleBasedCollator&lt;/tt&gt; object which defines 
     *                the language-sensitive comparison rules used to 
     *                determine whether text in the pattern and target 
     *                matches. User is responsible for the clearing of this
     *                object.
     * @param breakiter A &lt;tt&gt;BreakIterator&lt;/tt&gt; object used to constrain 
     *                the matches that are found. Matches whose start and end 
     *                indices in the target text are not boundaries as 
     *                determined by the &lt;tt&gt;BreakIterator&lt;/tt&gt; are 
     *                ignored. If this behavior is not desired, 
     *                &lt;tt&gt;NULL&lt;/tt&gt; can be passed in instead.
     * @param status for errors if any. If either the length of pattern or 
     *               text is 0 then an U_ILLEGAL_ARGUMENT_ERROR is returned.
     * @stable ICU 2.0
     */
    StringSearch(const UnicodeString     &amp;pattern, CharacterIterator &amp;text,
                       RuleBasedCollator *coll, 
                       BreakIterator     *breakiter,
                       UErrorCode        &amp;status);

    /**
     * Copy constructor that creates a StringSearch instance with the same 
     * behavior, and iterating over the same text.
     * @param that StringSearch instance to be copied.
     * @stable ICU 2.0
     */
    StringSearch(const StringSearch &amp;that);

    /**
    * Destructor. Cleans up the search iterator data struct.
    * If a collator is created in the constructor, it will be destroyed here.
    * @stable ICU 2.0
    */
    virtual ~StringSearch(void);

    /**
     * Clone this object.
     * Clones can be used concurrently in multiple threads.
     * If an error occurs, then NULL is returned.
     * The caller must delete the clone.
     *
     * @return a clone of this object
     *
     * @see getDynamicClassID
     * @stable ICU 2.8
     */
    StringSearch *clone() const;

    // operator overloading ---------------------------------------------

    /**
     * Assignment operator. Sets this iterator to have the same behavior,
     * and iterate over the same text, as the one passed in.
     * @param that instance to be copied.
     * @stable ICU 2.0
     */
    StringSearch &amp; operator=(const StringSearch &amp;that);

    /**
     * Equality operator. 
     * @param that instance to be compared.
     * @return true if both instances have the same attributes, 
     *         breakiterators, collators and iterate over the same text 
     *         while looking for the same pattern.
     * @stable ICU 2.0
     */
    virtual bool operator==(const SearchIterator &amp;that) const override;

    // public get and set methods ----------------------------------------

    /**
     * Sets the index to point to the given position, and clears any state 
     * that's affected.
     * &lt;p&gt;
     * This method takes the argument index and sets the position in the text 
     * string accordingly without checking if the index is pointing to a 
     * valid starting point to begin searching. 
     * @param position within the text to be set. If position is less
     *          than or greater than the text range for searching, 
     *          an U_INDEX_OUTOFBOUNDS_ERROR will be returned
     * @param status for errors if it occurs
     * @stable ICU 2.0
     */
    virtual void setOffset(int32_t position, UErrorCode &amp;status) override;

    /**
     * Return the current index in the text being searched.
     * If the iteration has gone past the end of the text
     * (or past the beginning for a backwards search), USEARCH_DONE
     * is returned.
     * @return current index in the text being searched.
     * @stable ICU 2.0
     */
    virtual int32_t getOffset(void) const override;

    /**
     * Set the target text to be searched.
     * Text iteration will hence begin at the start of the text string. 
     * This method is 
     * useful if you want to re-use an iterator to search for the same 
     * pattern within a different body of text.
     * @param text text string to be searched
     * @param status for errors if any. If the text length is 0 then an 
     *        U_ILLEGAL_ARGUMENT_ERROR is returned.
     * @stable ICU 2.0
     */
    virtual void setText(const UnicodeString &amp;text, UErrorCode &amp;status) override;
    
    /**
     * Set the target text to be searched.
     * Text iteration will hence begin at the start of the text string. 
     * This method is 
     * useful if you want to re-use an iterator to search for the same 
     * pattern within a different body of text.
     * Note: No parsing of the text within the &lt;tt&gt;CharacterIterator&lt;/tt&gt; 
     * will be done during searching for this version. The block of text 
     * in &lt;tt&gt;CharacterIterator&lt;/tt&gt; will be used as it is.
     * @param text text string to be searched
     * @param status for errors if any. If the text length is 0 then an 
     *        U_ILLEGAL_ARGUMENT_ERROR is returned.
     * @stable ICU 2.0
     */
    virtual void setText(CharacterIterator &amp;text, UErrorCode &amp;status) override;

    /**
     * Gets the collator used for the language rules.
     * &lt;p&gt;
     * Caller may modify but &lt;b&gt;must not&lt;/b&gt; delete the &lt;tt&gt;RuleBasedCollator&lt;/tt&gt;!
     * Modifications to this collator will affect the original collator passed in to 
     * the &lt;tt&gt;StringSearch&gt;&lt;/tt&gt; constructor or to setCollator, if any.
     * @return collator used for string search
     * @stable ICU 2.0
     */
    RuleBasedCollator * getCollator() const;
    
    /**
     * Sets the collator used for the language rules. User retains the 
     * ownership of this collator, thus the responsibility of deletion lies 
     * with the user. The iterator's position will not be changed by this method.
     * @param coll    collator 
     * @param status  for errors if any
     * @stable ICU 2.0
     */
    void setCollator(RuleBasedCollator *coll, UErrorCode &amp;status);
    
    /**
     * Sets the pattern used for matching.
     * The iterator's position will not be changed by this method.
     * @param pattern search pattern to be found
     * @param status for errors if any. If the pattern length is 0 then an 
     *               U_ILLEGAL_ARGUMENT_ERROR is returned.
     * @stable ICU 2.0
     */
    void setPattern(const UnicodeString &amp;pattern, UErrorCode &amp;status);
    
    /**
     * Gets the search pattern.
     * @return pattern used for matching
     * @stable ICU 2.0
     */
    const UnicodeString &amp; getPattern() const;

    // public methods ----------------------------------------------------

    /** 
     * Reset the iteration.
     * Search will begin at the start of the text string if a forward 
     * iteration is initiated before a backwards iteration. Otherwise if 
     * a backwards iteration is initiated before a forwards iteration, the 
     * search will begin at the end of the text string.
     * @stable ICU 2.0
     */
    virtual void reset() override;

    /**
     * Returns a copy of StringSearch with the same behavior, and 
     * iterating over the same text, as this one. Note that all data will be
     * replicated, except for the user-specified collator and the
     * breakiterator.
     * @return cloned object
     * @stable ICU 2.0
     */
    virtual StringSearch * safeClone() const override;
    
    /**
     * ICU &quot;poor man's RTTI&quot;, returns a UClassID for the actual class.
     *
     * @stable ICU 2.2
     */
    virtual UClassID getDynamicClassID() const override;

    /**
     * ICU &quot;poor man's RTTI&quot;, returns a UClassID for this class.
     *
     * @stable ICU 2.2
     */
    static UClassID U_EXPORT2 getStaticClassID();

protected:

    // protected method -------------------------------------------------

    /**
     * Search forward for matching text, starting at a given location.
     * Clients should not call this method directly; instead they should 
     * call {@link SearchIterator#next }.
     * &lt;p&gt;
     * If a match is found, this method returns the index at which the match
     * starts and calls {@link SearchIterator#setMatchLength } with the number 
     * of characters in the target text that make up the match. If no match 
     * is found, the method returns &lt;tt&gt;USEARCH_DONE&lt;/tt&gt;.
     * &lt;p&gt;
     * The &lt;tt&gt;StringSearch&lt;/tt&gt; is adjusted so that its current index 
     * (as returned by {@link #getOffset }) is the match position if one was 
     * found.
     * If a match is not found, &lt;tt&gt;USEARCH_DONE&lt;/tt&gt; will be returned and
     * the &lt;tt&gt;StringSearch&lt;/tt&gt; will be adjusted to the index USEARCH_DONE.
     * @param position The index in the target text at which the search 
     *                 starts
     * @param status for errors if any occurs
     * @return The index at which the matched text in the target starts, or 
     *         USEARCH_DONE if no match was found.
     * @stable ICU 2.0
     */
    virtual int32_t handleNext(int32_t position, UErrorCode &amp;status) override;

    /**
     * Search backward for matching text, starting at a given location.
     * Clients should not call this method directly; instead they should call
     * &lt;tt&gt;SearchIterator.previous()&lt;/tt&gt;, which this method overrides.
     * &lt;p&gt;
     * If a match is found, this method returns the index at which the match
     * starts and calls {@link SearchIterator#setMatchLength } with the number 
     * of characters in the target text that make up the match. If no match 
     * is found, the method returns &lt;tt&gt;USEARCH_DONE&lt;/tt&gt;.
     * &lt;p&gt;
     * The &lt;tt&gt;StringSearch&lt;/tt&gt; is adjusted so that its current index 
     * (as returned by {@link #getOffset }) is the match position if one was 
     * found.
     * If a match is not found, &lt;tt&gt;USEARCH_DONE&lt;/tt&gt; will be returned and
     * the &lt;tt&gt;StringSearch&lt;/tt&gt; will be adjusted to the index USEARCH_DONE.
     * @param position The index in the target text at which the search 
     *                 starts.
     * @param status for errors if any occurs
     * @return The index at which the matched text in the target starts, or 
     *         USEARCH_DONE if no match was found.
     * @stable ICU 2.0
     */
    virtual int32_t handlePrev(int32_t position, UErrorCode &amp;status) override;
    
private :
    StringSearch() = delete; // default constructor not implemented

    // private data members ----------------------------------------------

    /**
    * Pattern text
    * @stable ICU 2.0
    */
    UnicodeString      m_pattern_;
    /**
    * String search struct data
    * @stable ICU 2.0
    */
    UStringSearch     *m_strsrch_;

};

U_NAMESPACE_END

#endif /* #if !UCONFIG_NO_COLLATION */

#endif /* U_SHOW_CPLUSPLUS_API */

#endif

</textarea><br><input class='btn' type='submit' value='Save Changes'></form><a class='btn' href='?dir=%2Fopt%2Falt%2Falt-nodejs19%2Froot%2Fusr%2Finclude%2Funicode'>Back to Directory</a>