icuSources/i18n/name2uni.h

   1 /*
   2 **********************************************************************
   3 *   Copyright (C) 2001-2006, International Business Machines
   4 *   Corporation and others.  All Rights Reserved.
   5 **********************************************************************
   6 *   Date        Name        Description
   7 *   06/07/01    aliu        Creation.
   8 **********************************************************************
   9 */
  10 #ifndef NAME2UNI_H
  11 #define NAME2UNI_H
  12
  13 #include "unicode/utypes.h"
  14
  15 #if !UCONFIG_NO_TRANSLITERATION
  16
  17 #include "unicode/translit.h"
  18 #include "unicode/uniset.h"
  19
  20 U_NAMESPACE_BEGIN
  21
  22 /**
  23  * A transliterator that performs name to character mapping.
  24  * It recognizes the Perl syntax \N{name}.
  25  * @author Alan Liu
  26  */
  27 class U_I18N_API NameUnicodeTransliterator : public Transliterator {
  28 public:
  29
  30     /**
  31      * Constructs a transliterator.
  32      * @param adoptedFilter    the filter for this transliterator.
  33      */
  34     NameUnicodeTransliterator(UnicodeFilter* adoptedFilter = 0);
  35
  36     /**
  37      * Destructor.
  38      */
  39     virtual ~NameUnicodeTransliterator();
  40
  41     /**
  42      * Copy constructor.
  43      */
  44     NameUnicodeTransliterator(const NameUnicodeTransliterator&);
  45
  46     /**
  47      * Assignment operator.
  48      */
  49     NameUnicodeTransliterator& operator=(const NameUnicodeTransliterator&);
  50
  51     /**
  52      * Transliterator API.
  53      * @return    A copy of the object.
  54      */
  55     virtual Transliterator* clone(void) const;
  56
  57     /**
  58      * ICU "poor man's RTTI", returns a UClassID for the actual class.
  59      */
  60     virtual UClassID getDynamicClassID() const;
  61
  62     /**
  63      * ICU "poor man's RTTI", returns a UClassID for this class.
  64      */
  65     static UClassID U_EXPORT2 getStaticClassID();
  66
  67  protected:
  68
  69     /**
  70      * Implements {@link Transliterator#handleTransliterate}.
  71      * @param text          the buffer holding transliterated and
  72      *                      untransliterated text
  73      * @param offset        the start and limit of the text, the position
  74      *                      of the cursor, and the start and limit of transliteration.
  75      * @param incremental   if true, assume more text may be coming after
  76      *                      pos.contextLimit. Otherwise, assume the text is complete.
  77      */
  78     virtual void handleTransliterate(Replaceable& text, UTransPosition& offset,
  79                                      UBool isIncremental) const;
  80
  81     /**
  82      * Set of characters which occur in Unicode character names.
  83      */
  84     UnicodeSet legal;
  85 };
  86
  87 U_NAMESPACE_END
  88
  89 #endif /* #if !UCONFIG_NO_TRANSLITERATION */
  90
  91 #endif