🐐 GOAT

🐐 GOAT Shell

Current path: opt/alt/libicu65/usr/include/unicode/

✏️ Editing: unimatch.h

// © 2016 and later: Unicode, Inc. and others.
// License & terms of use: http://www.unicode.org/copyright.html
/*
* Copyright (C) 2001-2005, International Business Machines Corporation and others. All Rights Reserved.
**********************************************************************
*   Date        Name        Description
*   07/18/01    aliu        Creation.
**********************************************************************
*/
#ifndef UNIMATCH_H
#define UNIMATCH_H

#include "unicode/utypes.h"

/**
 * \file 
 * \brief C++ API: Unicode Matcher
 */

#if U_SHOW_CPLUSPLUS_API

U_NAMESPACE_BEGIN

class Replaceable;
class UnicodeString;
class UnicodeSet;

/**
 * Constants returned by <code>UnicodeMatcher::matches()</code>
 * indicating the degree of match.
 * @stable ICU 2.4
 */
enum UMatchDegree {
    /**
     * Constant returned by <code>matches()</code> indicating a
     * mismatch between the text and this matcher.  The text contains
     * a character which does not match, or the text does not contain
     * all desired characters for a non-incremental match.
     * @stable ICU 2.4
     */
    U_MISMATCH,
    
    /**
     * Constant returned by <code>matches()</code> indicating a
     * partial match between the text and this matcher.  This value is
     * only returned for incremental match operations.  All characters
     * of the text match, but more characters are required for a
     * complete match.  Alternatively, for variable-length matchers,
     * all characters of the text match, and if more characters were
     * supplied at limit, they might also match.
     * @stable ICU 2.4
     */
    U_PARTIAL_MATCH,
    
    /**
     * Constant returned by <code>matches()</code> indicating a
     * complete match between the text and this matcher.  For an
     * incremental variable-length match, this value is returned if
     * the given text matches, and it is known that additional
     * characters would not alter the extent of the match.
     * @stable ICU 2.4
     */
    U_MATCH
};

/**
 * <code>UnicodeMatcher</code> defines a protocol for objects that can
 * match a range of characters in a Replaceable string.
 * @stable ICU 2.4
 */
class U_COMMON_API UnicodeMatcher /* not : public UObject because this is an interface/mixin class */ {

public:
    /**
     * Destructor.
     * @stable ICU 2.4
     */
    virtual ~UnicodeMatcher();

/**
     * Return a UMatchDegree value indicating the degree of match for
     * the given text at the given offset.  Zero, one, or more
     * characters may be matched.
     *
     * Matching in the forward direction is indicated by limit >
     * offset.  Characters from offset forwards to limit-1 will be
     * considered for matching.
     * 
     * Matching in the reverse direction is indicated by limit <
     * offset.  Characters from offset backwards to limit+1 will be
     * considered for matching.
     *
     * If limit == offset then the only match possible is a zero
     * character match (which subclasses may implement if desired).
     *
     * As a side effect, advance the offset parameter to the limit of
     * the matched substring.  In the forward direction, this will be
     * the index of the last matched character plus one.  In the
     * reverse direction, this will be the index of the last matched
     * character minus one.
     *
     * <p>Note:  This method is not const because some classes may
     * modify their state as the result of a match.
     *
     * @param text the text to be matched
     * @param offset on input, the index into text at which to begin
     * matching.  On output, the limit of the matched text.  The
     * number of matched characters is the output value of offset
     * minus the input value.  Offset should always point to the
     * HIGH SURROGATE (leading code unit) of a pair of surrogates,
     * both on entry and upon return.
     * @param limit the limit index of text to be matched.  Greater
     * than offset for a forward direction match, less than offset for
     * a backward direction match.  The last character to be
     * considered for matching will be text.charAt(limit-1) in the
     * forward direction or text.charAt(limit+1) in the backward
     * direction.
     * @param incremental if TRUE, then assume further characters may
     * be inserted at limit and check for partial matching.  Otherwise
     * assume the text as given is complete.
     * @return a match degree value indicating a full match, a partial
     * match, or a mismatch.  If incremental is FALSE then
     * U_PARTIAL_MATCH should never be returned.
     * @stable ICU 2.4
     */
    virtual UMatchDegree matches(const Replaceable& text,
                                 int32_t& offset,
                                 int32_t limit,
                                 UBool incremental) = 0;

/**
     * Returns a string representation of this matcher.  If the result of
     * calling this function is passed to the appropriate parser, it
     * will produce another matcher that is equal to this one.
     * @param result the string to receive the pattern.  Previous
     * contents will be deleted.
     * @param escapeUnprintable if TRUE then convert unprintable
     * character to their hex escape representations, \\uxxxx or
     * \\Uxxxxxxxx.  Unprintable characters are those other than
     * U+000A, U+0020..U+007E.
     * @stable ICU 2.4
     */
    virtual UnicodeString& toPattern(UnicodeString& result,
                                     UBool escapeUnprintable = FALSE) const = 0;

/**
     * Returns TRUE if this matcher will match a character c, where c
     * & 0xFF == v, at offset, in the forward direction (with limit >
     * offset).  This is used by <tt>RuleBasedTransliterator</tt> for
     * indexing.
     * @stable ICU 2.4
     */
    virtual UBool matchesIndexValue(uint8_t v) const = 0;

/**
     * Union the set of all characters that may be matched by this object
     * into the given set.
     * @param toUnionTo the set into which to union the source characters
     * @stable ICU 2.4
     */
    virtual void addMatchSetTo(UnicodeSet& toUnionTo) const = 0;
};

U_NAMESPACE_END

#endif /* U_SHOW_CPLUSPLUS_API */

#endif

📄 alphaindex.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 appendable.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 basictz.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 brkiter.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 bytestream.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 bytestrie.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 bytestriebuilder.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 calendar.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 caniter.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 casemap.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 char16ptr.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 chariter.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 choicfmt.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 coleitr.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 coll.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 compactdecimalformat.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 curramt.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 currpinf.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 currunit.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 datefmt.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 dbbi.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 dcfmtsym.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 decimfmt.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 docmain.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 dtfmtsym.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 dtintrv.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 dtitvfmt.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 dtitvinf.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 dtptngen.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 dtrule.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 edits.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 enumset.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 errorcode.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 fieldpos.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 filteredbrk.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 fmtable.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 format.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 formattedvalue.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 fpositer.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 gender.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 gregocal.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 icudataver.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 icuplug.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 idna.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 listformatter.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 localebuilder.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 localematcher.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 localpointer.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 locdspnm.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 locid.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 measfmt.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 measunit.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 measure.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 messagepattern.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 msgfmt.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 normalizer2.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 normlzr.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 nounit.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 numberformatter.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 numberrangeformatter.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 numfmt.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 numsys.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 parseerr.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 parsepos.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 platform.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 plurfmt.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 plurrule.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 ptypes.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 putil.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 rbbi.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 rbnf.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 rbtz.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 regex.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 region.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 reldatefmt.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 rep.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 resbund.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 schriter.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 scientificnumberformatter.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 search.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 selfmt.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 simpleformatter.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 simpletz.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 smpdtfmt.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 sortkey.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 std_string.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 strenum.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 stringoptions.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 stringpiece.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 stringtriebuilder.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 stsearch.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 symtable.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 tblcoll.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 timezone.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 tmunit.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 tmutamt.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 tmutfmt.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 translit.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 tzfmt.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 tznames.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 tzrule.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 tztrans.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 ubidi.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 ubiditransform.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 ubrk.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 ucal.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 ucasemap.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 ucat.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 uchar.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 ucharstrie.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 ucharstriebuilder.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 uchriter.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 uclean.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 ucnv.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 ucnvsel.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 ucnv_cb.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 ucnv_err.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 ucol.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 ucoleitr.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 uconfig.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 ucpmap.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 ucptrie.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 ucsdet.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 ucurr.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 udat.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 udata.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 udateintervalformat.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 udatpg.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 udisplaycontext.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 uenum.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 ufieldpositer.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 uformattable.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 uformattedvalue.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 ugender.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 uidna.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 uiter.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 uldnames.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 ulistformatter.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 uloc.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 ulocdata.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 umachine.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 umisc.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 umsg.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 umutablecptrie.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 unifilt.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 unifunct.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 unimatch.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 unirepl.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 uniset.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 unistr.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 unorm.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 unorm2.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 unum.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 unumberformatter.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 unumsys.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 uobject.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 upluralrules.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 uregex.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 uregion.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 ureldatefmt.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 urename.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 urep.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 ures.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 uscript.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 usearch.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 uset.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 usetiter.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 ushape.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 uspoof.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 usprep.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 ustdio.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 ustream.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 ustring.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 ustringtrie.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 utext.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 utf.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 utf8.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 utf16.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 utf32.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 utf_old.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 utmscale.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 utrace.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 utrans.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 utypes.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 uvernum.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 uversion.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 vtzone.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete

🐐 GOAT Shell

✏️ Editing: unimatch.h

📤 Upload File

📁 Create Folder