icuSources/i18n/uni2name.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/06/01    aliu        Creation.
   8 **********************************************************************
   9 */
  10 #ifndef UNI2NAME_H
  11 #define UNI2NAME_H
  12
  13 #include "unicode/utypes.h"
  14
  15 #if !UCONFIG_NO_TRANSLITERATION
  16
  17 #include "unicode/translit.h"
  18
  19 U_NAMESPACE_BEGIN
  20
  21 /**
  22  * A transliterator that performs character to name mapping.
  23  * It generates the Perl syntax \N{name}.
  24  * @author Alan Liu
  25  */
  26 class U_I18N_API UnicodeNameTransliterator : public Transliterator {
  27
  28  public:
  29
  30     /**
  31      * Constructs a transliterator.
  32      * @param adoptedFilter the filter to be adopted.
  33      */
  34     UnicodeNameTransliterator(UnicodeFilter* adoptedFilter = 0);
  35
  36     /**
  37      * Destructor.
  38      */
  39     virtual ~UnicodeNameTransliterator();
  40
  41     /**
  42      * Copy constructor.
  43      */
  44     UnicodeNameTransliterator(const UnicodeNameTransliterator&);
  45
  46     /**
  47      * Assignment operator.
  48      */
  49     UnicodeNameTransliterator& operator=(const UnicodeNameTransliterator&);
  50
  51     /**
  52      * Transliterator API.
  53      */
  54     virtual Transliterator* clone(void) const;
  55
  56     /**
  57      * ICU "poor man's RTTI", returns a UClassID for the actual class.
  58      */
  59     virtual UClassID getDynamicClassID() const;
  60
  61     /**
  62      * ICU "poor man's RTTI", returns a UClassID for this class.
  63      */
  64     static UClassID U_EXPORT2 getStaticClassID();
  65
  66  protected:
  67
  68     /**
  69      * Implements {@link Transliterator#handleTransliterate}.
  70      * @param text        the buffer holding transliterated and
  71      *                    untransliterated text
  72      * @param offset      the start and limit of the text, the position
  73      *                    of the cursor, and the start and limit of transliteration.
  74      * @param incremental if true, assume more text may be coming after
  75      *                    pos.contextLimit.  Otherwise, assume the text is complete.
  76      */
  77     virtual void handleTransliterate(Replaceable& text, UTransPosition& offset,
  78                                      UBool isIncremental) const;
  79
  80 };
  81
  82 U_NAMESPACE_END
  83
  84 #endif /* #if !UCONFIG_NO_TRANSLITERATION */
  85
  86 #endif