ꦫꦣꦺꦤ꧀ꦄꦤ꧀ꦠꦱꦺꦤ

PATH: usr / include / unicode

/*
**********************************************************************
* Copyright (C) 1999-2010, International Business Machines Corporation and others.
* All Rights Reserved.
**********************************************************************
*   Date        Name        Description
*   11/17/99    aliu        Creation.
**********************************************************************
*/
#ifndef UNIFILT_H
#define UNIFILT_H

#include "unicode/unifunct.h"
#include "unicode/unimatch.h"

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

U_NAMESPACE_BEGIN

/**
 * U_ETHER is used to represent character values for positions outside
 * a range.  For example, transliterator uses this to represent
 * characters outside the range contextStart..contextLimit-1.  This
 * allows explicit matching by rules and UnicodeSets of text outside a
 * defined range.
 * @stable ICU 3.0
 */
#define U_ETHER ((UChar)0xFFFF)

/**
 *
 * <code>UnicodeFilter</code> defines a protocol for selecting a
 * subset of the full range (U+0000 to U+10FFFF) of Unicode characters.
 * Currently, filters are used in conjunction with classes like {@link
 * Transliterator} to only process selected characters through a
 * transformation.
 *
 * Note: UnicodeFilter currently stubs out two pure virtual methods
 * of its base class, UnicodeMatcher. These methods are toPattern()
 * and matchesIndexValue(). This is done so that filter classes that
 * are not actually used as matchers -- specifically, those in the
 * UnicodeFilterLogic component, and those in tests -- can continue to
 * work without defining these methods. As long as a filter is not
 * used in an RBT during real transliteration, these methods will not
 * be called. However, this breaks the UnicodeMatcher base class
 * protocol, and it is not a correct solution.
 *
 * In the future we may revisit the UnicodeMatcher / UnicodeFilter
 * hierarchy and either redesign it, or simply remove the stubs in
 * UnicodeFilter and force subclasses to implement the full
 * UnicodeMatcher protocol.
 *
 * @see UnicodeFilterLogic
 * @stable ICU 2.0
 */
class U_COMMON_API UnicodeFilter : public UnicodeFunctor, public UnicodeMatcher {

public:
    /**
     * Destructor
     * @stable ICU 2.0
     */
    virtual ~UnicodeFilter();

/**
 * Returns <tt>true</tt> for characters that are in the selected
 * subset. In other words, if a character is to be
 * filtered, then <tt>contains()</tt> returns
 * <tt>false</tt>.
 * @stable ICU 2.0
 */
 virtual UBool contains(UChar32 c) const = 0;

/**
     * UnicodeFunctor API.  Cast 'this' to a UnicodeMatcher* pointer
     * and return the pointer.
     * @stable ICU 2.4
     */
    virtual UnicodeMatcher* toMatcher() const;

/**
     * Implement UnicodeMatcher API.
     * @stable ICU 2.4
     */
    virtual UMatchDegree matches(const Replaceable& text,
                                 int32_t& offset,
                                 int32_t limit,
                                 UBool incremental);

/**
     * UnicodeFunctor API.  Nothing to do.
     * @stable ICU 2.4
     */
    virtual void setData(const TransliterationRuleData*);

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

protected:

/*
     * Since this class has pure virtual functions,
     * a constructor can't be used.
     * @stable ICU 2.0
     */
/*    UnicodeFilter();*/
};

/*inline UnicodeFilter::UnicodeFilter() {}*/

U_NAMESPACE_END

#endif

[-] tzrule.h [edit]
[-] utrans.h [edit]
[-] ucnv.h [edit]
[-] dtrule.h [edit]
[-] format.h [edit]
[-] uvernum.h [edit]
[-] utf32.h [edit]
[-] ubidi.h [edit]
[-] enumset.h [edit]
[-] normlzr.h [edit]
[-] measfmt.h [edit]
[-] ubrk.h [edit]
[-] upluralrules.h [edit]
[-] sortkey.h [edit]
[-] bytestrie.h [edit]
[-] fpositer.h [edit]
[-] utf_old.h [edit]
[-] tmutamt.h [edit]
[-] uconfig.h [edit]
[-] alphaindex.h [edit]
[-] vtzone.h [edit]
[-] locdspnm.h [edit]
[-] numsys.h [edit]
[-] simpletz.h [edit]
[-] tznames.h [edit]
[-] stringpiece.h [edit]
[-] parseerr.h [edit]
[-] ucsdet.h [edit]
[-] appendable.h [edit]
[+] ..
[-] dtptngen.h [edit]
[-] dtintrv.h [edit]
[-] resbund.h [edit]
[-] ptypes.h [edit]
[-] ustdio.h [edit]
[-] symtable.h [edit]
[-] ucnv_err.h [edit]
[-] utypes.h [edit]
[-] bytestream.h [edit]
[-] dtfmtsym.h [edit]
[-] unorm2.h [edit]
[-] udateintervalformat.h [edit]
[-] ucat.h [edit]
[-] usearch.h [edit]
[-] platform.h [edit]
[-] unum.h [edit]
[-] locid.h [edit]
[-] uversion.h [edit]
[-] regex.h [edit]
[-] strenum.h [edit]
[-] ucasemap.h [edit]
[-] utmscale.h [edit]
[-] decimfmt.h [edit]
[-] messagepattern.h [edit]
[-] brkiter.h [edit]
[-] ucurr.h [edit]
[-] uset.h [edit]
[-] tztrans.h [edit]
[-] udata.h [edit]
[-] currpinf.h [edit]
[-] datefmt.h [edit]
[-] rbbi.h [edit]
[-] parsepos.h [edit]
[-] rbtz.h [edit]
[-] ucnv_cb.h [edit]
[-] ucoleitr.h [edit]
[-] udat.h [edit]
[-] putil.h [edit]
[-] coll.h [edit]
[-] gender.h [edit]
[-] ucharstriebuilder.h [edit]
[-] unimatch.h [edit]
[-] currunit.h [edit]
[-] ugender.h [edit]
[-] colldata.h [edit]
[-] uchriter.h [edit]
[-] tmunit.h [edit]
[-] ulocdata.h [edit]
[-] timezone.h [edit]
[-] unirepl.h [edit]
[-] umisc.h [edit]
[-] tmutfmt.h [edit]
[-] ushape.h [edit]
[-] dtitvinf.h [edit]
[-] usetiter.h [edit]
[-] uniset.h [edit]
[-] listformatter.h [edit]
[-] umsg.h [edit]
[-] ustream.h [edit]
[-] ustringtrie.h [edit]
[-] icudataver.h [edit]
[-] bytestriebuilder.h [edit]
[-] bms.h [edit]
[-] uldnames.h [edit]
[-] uregex.h [edit]
[-] schriter.h [edit]
[-] uenum.h [edit]
[-] uclean.h [edit]
[-] bmsearch.h [edit]
[-] utf16.h [edit]
[-] normalizer2.h [edit]
[-] calendar.h [edit]
[-] udatpg.h [edit]
[-] unifunct.h [edit]
[-] dbbi.h [edit]
[-] utext.h [edit]
[-] uchar.h [edit]
[-] tzfmt.h [edit]
[-] urep.h [edit]
[-] uscript.h [edit]
[-] urename.h [edit]
[-] std_string.h [edit]
[-] choicfmt.h [edit]
[-] rep.h [edit]
[-] idna.h [edit]
[-] unorm.h [edit]
[-] dtitvfmt.h [edit]
[-] utrace.h [edit]
[-] uidna.h [edit]
[-] search.h [edit]
[-] uobject.h [edit]
[-] basictz.h [edit]
[-] dcfmtsym.h [edit]
[-] coleitr.h [edit]
[-] translit.h [edit]
[-] ures.h [edit]
[-] unistr.h [edit]
[-] udisplaycontext.h [edit]
[-] fmtable.h [edit]
[-] rbnf.h [edit]
[-] gregocal.h [edit]
[-] uiter.h [edit]
[-] umachine.h [edit]
[-] plurrule.h [edit]
[-] plurfmt.h [edit]
[-] ucnvsel.h [edit]
[-] curramt.h [edit]
[-] ucal.h [edit]
[-] measure.h [edit]
[-] utf8.h [edit]
[-] uspoof.h [edit]
[-] icuplug.h [edit]
[-] chariter.h [edit]
[-] stringtriebuilder.h [edit]
[-] caniter.h [edit]
[-] utf.h [edit]
[-] fieldpos.h [edit]
[-] ucharstrie.h [edit]
[-] tblcoll.h [edit]
[-] ustring.h [edit]
[-] errorcode.h [edit]
[-] stsearch.h [edit]
[-] localpointer.h [edit]
[-] usprep.h [edit]
[-] docmain.h [edit]
[-] msgfmt.h [edit]
[-] selfmt.h [edit]
[-] unifilt.h [edit]
[-] uloc.h [edit]
[-] measunit.h [edit]
[-] ucol.h [edit]
[-] numfmt.h [edit]
[-] smpdtfmt.h [edit]