1f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)/*
2f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)**********************************************************************
3f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)*   Copyright (C) 1999-2007, International Business Machines
4f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)*   Corporation and others.  All Rights Reserved.
5f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)**********************************************************************
6f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)*   Date        Name        Description
7f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)*   11/17/99    aliu        Creation.
8f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)**********************************************************************
9f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)*/
10f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)#ifndef RBT_H
11f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)#define RBT_H
12f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)
13f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)#include "unicode/utypes.h"
14f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)
15f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)#if !UCONFIG_NO_TRANSLITERATION
16f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)
17f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)#include "unicode/translit.h"
18f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)#include "unicode/utypes.h"
19f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)#include "unicode/parseerr.h"
20f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)#include "unicode/udata.h"
21f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)
22f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)#define U_ICUDATA_TRANSLIT U_ICUDATA_NAME U_TREE_SEPARATOR_STRING "translit"
23f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)
24f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)U_NAMESPACE_BEGIN
25f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)
26f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)class TransliterationRuleData;
27f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)
28f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)/**
29f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * <code>RuleBasedTransliterator</code> is a transliterator
30f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * that reads a set of rules in order to determine how to perform
31f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * translations. Rule sets are stored in resource bundles indexed by
32f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * name. Rules within a rule set are separated by semicolons (';').
33f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * To include a literal semicolon, prefix it with a backslash ('\').
34f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * Whitespace, as defined by <code>Character.isWhitespace()</code>,
35f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * is ignored. If the first non-blank character on a line is '#',
36f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * the entire line is ignored as a comment. </p>
37f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *
38f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * <p>Each set of rules consists of two groups, one forward, and one
39f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * reverse. This is a convention that is not enforced; rules for one
40f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * direction may be omitted, with the result that translations in
41f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * that direction will not modify the source text. In addition,
42f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * bidirectional forward-reverse rules may be specified for
43f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * symmetrical transformations.</p>
44f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *
45f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * <p><b>Rule syntax</b> </p>
46f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *
47f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * <p>Rule statements take one of the following forms: </p>
48f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *
49f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * <dl>
50f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *     <dt><code>$alefmadda=\u0622;</code></dt>
51f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *     <dd><strong>Variable definition.</strong> The name on the
52f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *         left is assigned the text on the right. In this example,
53f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *         after this statement, instances of the left hand name,
54f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *         &quot;<code>$alefmadda</code>&quot;, will be replaced by
55f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *         the Unicode character U+0622. Variable names must begin
56f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *         with a letter and consist only of letters, digits, and
57f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *         underscores. Case is significant. Duplicate names cause
58f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *         an exception to be thrown, that is, variables cannot be
59f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *         redefined. The right hand side may contain well-formed
60f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *         text of any length, including no text at all (&quot;<code>$empty=;</code>&quot;).
61f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *         The right hand side may contain embedded <code>UnicodeSet</code>
62f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *         patterns, for example, &quot;<code>$softvowel=[eiyEIY]</code>&quot;.</dd>
63f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *     <dd>&nbsp;</dd>
64f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *     <dt><code>ai&gt;$alefmadda;</code></dt>
65f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *     <dd><strong>Forward translation rule.</strong> This rule
66f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *         states that the string on the left will be changed to the
67f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *         string on the right when performing forward
68f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *         transliteration.</dd>
69f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *     <dt>&nbsp;</dt>
70f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *     <dt><code>ai<$alefmadda;</code></dt>
71f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *     <dd><strong>Reverse translation rule.</strong> This rule
72f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *         states that the string on the right will be changed to
73f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *         the string on the left when performing reverse
74f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *         transliteration.</dd>
75f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * </dl>
76f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *
77f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * <dl>
78f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *     <dt><code>ai<>$alefmadda;</code></dt>
79f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *     <dd><strong>Bidirectional translation rule.</strong> This
80f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *         rule states that the string on the right will be changed
81f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *         to the string on the left when performing forward
82f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *         transliteration, and vice versa when performing reverse
83f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *         transliteration.</dd>
84f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * </dl>
85f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *
86f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * <p>Translation rules consist of a <em>match pattern</em> and an <em>output
87f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * string</em>. The match pattern consists of literal characters,
88f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * optionally preceded by context, and optionally followed by
89f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * context. Context characters, like literal pattern characters,
90f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * must be matched in the text being transliterated. However, unlike
91f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * literal pattern characters, they are not replaced by the output
92f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * text. For example, the pattern &quot;<code>abc{def}</code>&quot;
93f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * indicates the characters &quot;<code>def</code>&quot; must be
94f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * preceded by &quot;<code>abc</code>&quot; for a successful match.
95f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * If there is a successful match, &quot;<code>def</code>&quot; will
96f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * be replaced, but not &quot;<code>abc</code>&quot;. The final '<code>}</code>'
97f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * is optional, so &quot;<code>abc{def</code>&quot; is equivalent to
98f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * &quot;<code>abc{def}</code>&quot;. Another example is &quot;<code>{123}456</code>&quot;
99f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * (or &quot;<code>123}456</code>&quot;) in which the literal
100f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * pattern &quot;<code>123</code>&quot; must be followed by &quot;<code>456</code>&quot;.
101f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * </p>
102f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *
103f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * <p>The output string of a forward or reverse rule consists of
104f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * characters to replace the literal pattern characters. If the
105f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * output string contains the character '<code>|</code>', this is
106f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * taken to indicate the location of the <em>cursor</em> after
107f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * replacement. The cursor is the point in the text at which the
108f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * next replacement, if any, will be applied. The cursor is usually
109f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * placed within the replacement text; however, it can actually be
110f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * placed into the precending or following context by using the
111f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * special character '<code>@</code>'. Examples:</p>
112f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *
113f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * <blockquote>
114f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *     <p><code>a {foo} z &gt; | @ bar; # foo -&gt; bar, move cursor
115f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *     before a<br>
116f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *     {foo} xyz &gt; bar @@|; #&nbsp;foo -&gt; bar, cursor between
117f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *     y and z</code></p>
118f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * </blockquote>
119f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *
120f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * <p><b>UnicodeSet</b></p>
121f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *
122f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * <p><code>UnicodeSet</code> patterns may appear anywhere that
123f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * makes sense. They may appear in variable definitions.
124f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * Contrariwise, <code>UnicodeSet</code> patterns may themselves
125f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * contain variable references, such as &quot;<code>$a=[a-z];$not_a=[^$a]</code>&quot;,
126f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * or &quot;<code>$range=a-z;$ll=[$range]</code>&quot;.</p>
127f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *
128f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * <p><code>UnicodeSet</code> patterns may also be embedded directly
129f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * into rule strings. Thus, the following two rules are equivalent:</p>
130f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *
131f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * <blockquote>
132f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *     <p><code>$vowel=[aeiou]; $vowel&gt;'*'; # One way to do this<br>
133f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *     [aeiou]&gt;'*';
134f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *     &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;#
135f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *     Another way</code></p>
136f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * </blockquote>
137f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *
138f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * <p>See {@link UnicodeSet} for more documentation and examples.</p>
139f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *
140f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * <p><b>Segments</b></p>
141f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *
142f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * <p>Segments of the input string can be matched and copied to the
143f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * output string. This makes certain sets of rules simpler and more
144f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * general, and makes reordering possible. For example:</p>
145f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *
146f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * <blockquote>
147f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *     <p><code>([a-z]) &gt; $1 $1;
148f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *     &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;#
149f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *     double lowercase letters<br>
150f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *     ([:Lu:]) ([:Ll:]) &gt; $2 $1; # reverse order of Lu-Ll pairs</code></p>
151f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * </blockquote>
152f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *
153f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * <p>The segment of the input string to be copied is delimited by
154f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * &quot;<code>(</code>&quot; and &quot;<code>)</code>&quot;. Up to
155f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * nine segments may be defined. Segments may not overlap. In the
156f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * output string, &quot;<code>$1</code>&quot; through &quot;<code>$9</code>&quot;
157f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * represent the input string segments, in left-to-right order of
158f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * definition.</p>
159f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *
160f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * <p><b>Anchors</b></p>
161f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *
162f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * <p>Patterns can be anchored to the beginning or the end of the text. This is done with the
163f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * special characters '<code>^</code>' and '<code>$</code>'. For example:</p>
164f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *
165f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * <blockquote>
166f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *   <p><code>^ a&nbsp;&nbsp; &gt; 'BEG_A'; &nbsp;&nbsp;# match 'a' at start of text<br>
167f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *   &nbsp; a&nbsp;&nbsp; &gt; 'A';&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; # match other instances
168f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *   of 'a'<br>
169f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *   &nbsp; z $ &gt; 'END_Z'; &nbsp;&nbsp;# match 'z' at end of text<br>
170f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *   &nbsp; z&nbsp;&nbsp; &gt; 'Z';&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; # match other instances
171f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *   of 'z'</code></p>
172f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * </blockquote>
173f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *
174f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * <p>It is also possible to match the beginning or the end of the text using a <code>UnicodeSet</code>.
175f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * This is done by including a virtual anchor character '<code>$</code>' at the end of the
176f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * set pattern. Although this is usually the match chafacter for the end anchor, the set will
177f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * match either the beginning or the end of the text, depending on its placement. For
178f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * example:</p>
179f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *
180f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * <blockquote>
181f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *   <p><code>$x = [a-z$]; &nbsp;&nbsp;# match 'a' through 'z' OR anchor<br>
182f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *   $x 1&nbsp;&nbsp;&nbsp; &gt; 2;&nbsp;&nbsp; # match '1' after a-z or at the start<br>
183f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *   &nbsp;&nbsp; 3 $x &gt; 4; &nbsp;&nbsp;# match '3' before a-z or at the end</code></p>
184f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * </blockquote>
185f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *
186f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * <p><b>Example</b> </p>
187f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *
188f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * <p>The following example rules illustrate many of the features of
189f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * the rule language. </p>
190f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *
191f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * <table border="0" cellpadding="4">
192f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *     <tr>
193f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *         <td valign="top">Rule 1.</td>
194f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *         <td valign="top" nowrap><code>abc{def}&gt;x|y</code></td>
195f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *     </tr>
196f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *     <tr>
197f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *         <td valign="top">Rule 2.</td>
198f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *         <td valign="top" nowrap><code>xyz&gt;r</code></td>
199f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *     </tr>
200f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *     <tr>
201f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *         <td valign="top">Rule 3.</td>
202f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *         <td valign="top" nowrap><code>yz&gt;q</code></td>
203f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *     </tr>
204f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * </table>
205f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *
206f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * <p>Applying these rules to the string &quot;<code>adefabcdefz</code>&quot;
207f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * yields the following results: </p>
208f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *
209f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * <table border="0" cellpadding="4">
210f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *     <tr>
211f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *         <td valign="top" nowrap><code>|adefabcdefz</code></td>
212f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *         <td valign="top">Initial state, no rules match. Advance
213f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *         cursor.</td>
214f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *     </tr>
215f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *     <tr>
216f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *         <td valign="top" nowrap><code>a|defabcdefz</code></td>
217f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *         <td valign="top">Still no match. Rule 1 does not match
218f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *         because the preceding context is not present.</td>
219f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *     </tr>
220f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *     <tr>
221f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *         <td valign="top" nowrap><code>ad|efabcdefz</code></td>
222f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *         <td valign="top">Still no match. Keep advancing until
223f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *         there is a match...</td>
224f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *     </tr>
225f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *     <tr>
226f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *         <td valign="top" nowrap><code>ade|fabcdefz</code></td>
227f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *         <td valign="top">...</td>
228f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *     </tr>
229f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *     <tr>
230f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *         <td valign="top" nowrap><code>adef|abcdefz</code></td>
231f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *         <td valign="top">...</td>
232f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *     </tr>
233f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *     <tr>
234f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *         <td valign="top" nowrap><code>adefa|bcdefz</code></td>
235f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *         <td valign="top">...</td>
236f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *     </tr>
237f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *     <tr>
238f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *         <td valign="top" nowrap><code>adefab|cdefz</code></td>
239f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *         <td valign="top">...</td>
240f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *     </tr>
241f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *     <tr>
242f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *         <td valign="top" nowrap><code>adefabc|defz</code></td>
243f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *         <td valign="top">Rule 1 matches; replace &quot;<code>def</code>&quot;
244f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *         with &quot;<code>xy</code>&quot; and back up the cursor
245f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *         to before the '<code>y</code>'.</td>
246f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *     </tr>
247f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *     <tr>
248f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *         <td valign="top" nowrap><code>adefabcx|yz</code></td>
249f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *         <td valign="top">Although &quot;<code>xyz</code>&quot; is
250f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *         present, rule 2 does not match because the cursor is
251f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *         before the '<code>y</code>', not before the '<code>x</code>'.
252f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *         Rule 3 does match. Replace &quot;<code>yz</code>&quot;
253f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *         with &quot;<code>q</code>&quot;.</td>
254f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *     </tr>
255f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *     <tr>
256f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *         <td valign="top" nowrap><code>adefabcxq|</code></td>
257f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *         <td valign="top">The cursor is at the end;
258f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *         transliteration is complete.</td>
259f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *     </tr>
260f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * </table>
261f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *
262f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * <p>The order of rules is significant. If multiple rules may match
263f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * at some point, the first matching rule is applied. </p>
264f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *
265f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * <p>Forward and reverse rules may have an empty output string.
266f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * Otherwise, an empty left or right hand side of any statement is a
267f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * syntax error. </p>
268f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *
269f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * <p>Single quotes are used to quote any character other than a
270f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * digit or letter. To specify a single quote itself, inside or
271f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * outside of quotes, use two single quotes in a row. For example,
272f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * the rule &quot;<code>'&gt;'&gt;o''clock</code>&quot; changes the
273f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * string &quot;<code>&gt;</code>&quot; to the string &quot;<code>o'clock</code>&quot;.
274f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * </p>
275f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *
276f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * <p><b>Notes</b> </p>
277f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *
278f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * <p>While a RuleBasedTransliterator is being built, it checks that
279f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * the rules are added in proper order. For example, if the rule
280f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * &quot;a&gt;x&quot; is followed by the rule &quot;ab&gt;y&quot;,
281f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * then the second rule will throw an exception. The reason is that
282f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * the second rule can never be triggered, since the first rule
283f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * always matches anything it matches. In other words, the first
284f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * rule <em>masks</em> the second rule. </p>
285f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) *
286f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * @author Alan Liu
287f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) * @internal Use transliterator factory methods instead since this class will be removed in that release.
288f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles) */
289f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)class RuleBasedTransliterator : public Transliterator {
290f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)private:
291f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)    /**
292f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)     * The data object is immutable, so we can freely share it with
293f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)     * other instances of RBT, as long as we do NOT own this object.
294f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)     *  TODO:  data is no longer immutable.  See bugs #1866, 2155
295f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)     */
296f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)    TransliterationRuleData* fData;
297f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)
298f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)    /**
299f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)     * If true, we own the data object and must delete it.
300f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)     */
301f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)    UBool isDataOwned;
302f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)
303f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)public:
304f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)
305f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)    /**
306f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)     * Constructs a new transliterator from the given rules.
307f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)     * @param rules rules, separated by ';'
308f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)     * @param direction either FORWARD or REVERSE.
309f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)     * @exception IllegalArgumentException if rules are malformed.
310f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)     * @internal Use transliterator factory methods instead since this class will be removed in that release.
311f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)     */
312f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)    RuleBasedTransliterator(const UnicodeString& id,
313f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)                            const UnicodeString& rules,
314f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)                            UTransDirection direction,
315f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)                            UnicodeFilter* adoptedFilter,
316f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)                            UParseError& parseError,
317f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)                            UErrorCode& status);
318f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)
319f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)    /**
320f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)     * Constructs a new transliterator from the given rules.
321f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)     * @param rules rules, separated by ';'
322f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)     * @param direction either FORWARD or REVERSE.
323f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)     * @exception IllegalArgumentException if rules are malformed.
324f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)     * @internal Use transliterator factory methods instead since this class will be removed in that release.
325f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)     */
326f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)    /*RuleBasedTransliterator(const UnicodeString& id,
327f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)                            const UnicodeString& rules,
328f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)                            UTransDirection direction,
329f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)                            UnicodeFilter* adoptedFilter,
330f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)                            UErrorCode& status);*/
331f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)
332f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)    /**
333f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)     * Covenience constructor with no filter.
334f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)     * @internal Use transliterator factory methods instead since this class will be removed in that release.
335f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)     */
336f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)    /*RuleBasedTransliterator(const UnicodeString& id,
337f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)                            const UnicodeString& rules,
338f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)                            UTransDirection direction,
339f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)                            UErrorCode& status);*/
340f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)
341f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)    /**
342f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)     * Covenience constructor with no filter and FORWARD direction.
343f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)     * @internal Use transliterator factory methods instead since this class will be removed in that release.
344f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)     */
345f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)    /*RuleBasedTransliterator(const UnicodeString& id,
346f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)                            const UnicodeString& rules,
347f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)                            UErrorCode& status);*/
348f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)
349f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)    /**
350f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)     * Covenience constructor with FORWARD direction.
351f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)     * @internal Use transliterator factory methods instead since this class will be removed in that release.
352f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)     */
353f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)    /*RuleBasedTransliterator(const UnicodeString& id,
354f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)                            const UnicodeString& rules,
355f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)                            UnicodeFilter* adoptedFilter,
356f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)                            UErrorCode& status);*/
357f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)private:
358f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)
359f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)     friend class TransliteratorRegistry; // to access TransliterationRuleData convenience ctor
360f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)    /**
361f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)     * Covenience constructor.
362f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)     * @param id            the id for the transliterator.
363f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)     * @param theData       the rule data for the transliterator.
364f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)     * @param adoptedFilter the filter for the transliterator
365f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)     */
366f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)    RuleBasedTransliterator(const UnicodeString& id,
367f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)                            const TransliterationRuleData* theData,
368f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)                            UnicodeFilter* adoptedFilter = 0);
369f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)
370f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)
371f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)    friend class Transliterator; // to access following ct
372f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)
373f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)    /**
374f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)     * Internal constructor.
375f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)     * @param id            the id for the transliterator.
376f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)     * @param theData       the rule data for the transliterator.
377f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)     * @param isDataAdopted determine who will own the 'data' object. True, the caller should not delete 'data'.
378f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)     */
379f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)    RuleBasedTransliterator(const UnicodeString& id,
380f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)                            TransliterationRuleData* data,
381f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)                            UBool isDataAdopted);
382f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)
383f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)public:
384f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)
385f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)    /**
386f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)     * Copy constructor.
387f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)     * @internal Use transliterator factory methods instead since this class will be removed in that release.
388f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)     */
389f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)    RuleBasedTransliterator(const RuleBasedTransliterator&);
390f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)
391f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)    virtual ~RuleBasedTransliterator();
392f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)
393f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)    /**
394f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)     * Implement Transliterator API.
395f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)     * @internal Use transliterator factory methods instead since this class will be removed in that release.
396f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)     */
397f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)    virtual Transliterator* clone(void) const;
398f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)
399f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)protected:
400f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)    /**
401f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)     * Implements {@link Transliterator#handleTransliterate}.
402f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)     * @internal Use transliterator factory methods instead since this class will be removed in that release.
403f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)     */
404f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)    virtual void handleTransliterate(Replaceable& text, UTransPosition& offsets,
405f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)                                     UBool isIncremental) const;
406f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)
407f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)public:
408f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)    /**
409f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)     * Return a representation of this transliterator as source rules.
410f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)     * These rules will produce an equivalent transliterator if used
411f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)     * to construct a new transliterator.
412f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)     * @param result the string to receive the rules.  Previous
413f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)     * contents will be deleted.
414f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)     * @param escapeUnprintable if TRUE then convert unprintable
415f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)     * character to their hex escape representations, \uxxxx or
416f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)     * \Uxxxxxxxx.  Unprintable characters are those other than
417f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)     * U+000A, U+0020..U+007E.
418f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)     * @internal Use transliterator factory methods instead since this class will be removed in that release.
419f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)     */
420f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)    virtual UnicodeString& toRules(UnicodeString& result,
421f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)                                   UBool escapeUnprintable) const;
422f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)
423f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)protected:
424f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)    /**
425f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)     * Implement Transliterator framework
426f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)     */
427f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)    virtual void handleGetSourceSet(UnicodeSet& result) const;
428f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)
429f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)public:
430f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)    /**
431f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)     * Override Transliterator framework
432f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)     */
433f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)    virtual UnicodeSet& getTargetSet(UnicodeSet& result) const;
434f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)
435f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)    /**
436f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)     * Return the class ID for this class.  This is useful only for
437f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)     * comparing to a return value from getDynamicClassID().  For example:
438f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)     * <pre>
439f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)     * .      Base* polymorphic_pointer = createPolymorphicObject();
440f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)     * .      if (polymorphic_pointer->getDynamicClassID() ==
441f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)     * .          Derived::getStaticClassID()) ...
442f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)     * </pre>
443f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)     * @return          The class ID for all objects of this class.
444f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)     * @internal Use transliterator factory methods instead since this class will be removed in that release.
445f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)     */
446f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)    U_I18N_API static UClassID U_EXPORT2 getStaticClassID(void);
447f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)
448f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)    /**
449f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)     * Returns a unique class ID <b>polymorphically</b>.  This method
450f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)     * is to implement a simple version of RTTI, since not all C++
451f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)     * compilers support genuine RTTI.  Polymorphic operator==() and
452f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)     * clone() methods call this method.
453f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)     *
454f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)     * @return The class ID for this object. All objects of a given
455f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)     * class have the same class ID.  Objects of other classes have
456f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)     * different class IDs.
457f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)     */
458f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)    virtual UClassID getDynamicClassID(void) const;
459f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)
460f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)private:
461f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)
462f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)    void _construct(const UnicodeString& rules,
463f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)                    UTransDirection direction,
464f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)                    UParseError& parseError,
465f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)                    UErrorCode& status);
466f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)};
467f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)
468f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)
469f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)U_NAMESPACE_END
470f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)
471f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)#endif /* #if !UCONFIG_NO_TRANSLITERATION */
472f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)
473f4ed1cf5d184064c4cf0e4359c6d5d8aadb50afaTorne (Richard Coles)#endif
474