scuffed-code/icu4c/source/i18n/translit.cpp
Vladimir Weinstein 8e6698de87 ICU-903 updated copyright notices
X-SVN-Rev: 4237
2001-03-21 20:31:13 +00:00

946 lines
34 KiB
C++

/*
**********************************************************************
* Copyright (C) 1999-2001, International Business Machines
* Corporation and others. All Rights Reserved.
**********************************************************************
* Date Name Description
* 11/17/99 aliu Creation.
**********************************************************************
*/
#include "unicode/translit.h"
#include "cmemory.h"
#include "cstring.h"
#include "unicode/hextouni.h"
#include "unicode/locid.h"
#include "unicode/msgfmt.h"
#include "mutex.h"
#include "rbt_data.h"
#include "rbt_pars.h"
#include "unicode/rep.h"
#include "unicode/resbund.h"
#include "hash.h"
#include "unicode/unifilt.h"
#include "unicode/unitohex.h"
#include "unicode/nultrans.h"
#include "unicode/putil.h"
#include "unicode/cpdtrans.h"
#include "unicode/jamohang.h"
#include "unicode/hangjamo.h"
#include <stdio.h>
const UChar Transliterator::ID_SEP = 0x002D; /*-*/
const UChar Transliterator::ID_DELIM = 0x003B; /*;*/
static Hashtable _cache;
static Hashtable _internalCache;
/**
* Cache of public system transliterators. Keys are UnicodeString
* names, values are CacheEntry objects.
*/
Hashtable* Transliterator::cache = &_cache;
/**
* Like 'cache', but IDs are not public. Internal transliterators are
* combined together and aliased to public IDs.
*/
Hashtable* Transliterator::internalCache = &_internalCache;
/**
* The mutex controlling access to the cache.
*/
UMTX Transliterator::cacheMutex = NULL;
/**
* When set to TRUE, the cache has been initialized. Any code must
* check this boolean before accessing the cache, and if the boolean
* is FALSE, it must call initializeCache(). We do this form of lazy
* evaluation for two reasons: (1) so we don't initialize if we don't
* have to (i.e., if no one is using Transliterator, but has included
* the code as part of a shared library, and (2) to avoid static
* intialization problems.
*/
UBool Transliterator::cacheInitialized = FALSE;
/**
* Prefix for resource bundle key for the display name for a
* transliterator. The ID is appended to this to form the key.
* The resource bundle value should be a String.
*/
const char* Transliterator::RB_DISPLAY_NAME_PREFIX = "%Translit%%";
/**
* Prefix for resource bundle key for the display name for a
* transliterator SCRIPT. The ID is appended to this to form the key.
* The resource bundle value should be a String.
*/
const char* Transliterator::RB_SCRIPT_DISPLAY_NAME_PREFIX = "%Translit%";
/**
* Resource bundle key for display name pattern.
* The resource bundle value should be a String forming a
* MessageFormat pattern, e.g.:
* "{0,choice,0#|1#{1} Transliterator|2#{1} to {2} Transliterator}".
*/
const char* Transliterator::RB_DISPLAY_NAME_PATTERN =
"TransliteratorNamePattern";
/**
* Resource bundle key for the list of RuleBasedTransliterator IDs.
* The resource bundle value should be a String[] with each element
* being a valid ID. The ID will be appended to RB_RULE_BASED_PREFIX
* to obtain the class name in which the RB_RULE key will be sought.
*/
const char* Transliterator::RB_RULE_BASED_IDS =
"RuleBasedTransliteratorIDs";
/**
* Resource bundle key for the RuleBasedTransliterator rule.
*/
const char* Transliterator::RB_RULE = "Rule";
/**
* Default constructor.
* @param theID the string identifier for this transliterator
* @param theFilter the filter. Any character for which
* <tt>filter.contains()</tt> returns <tt>FALSE</tt> will not be
* altered by this transliterator. If <tt>filter</tt> is
* <tt>null</tt> then no filtering is applied.
*/
Transliterator::Transliterator(const UnicodeString& theID,
UnicodeFilter* adoptedFilter) :
ID(theID), filter(adoptedFilter),
maximumContextLength(0) {}
/**
* Destructor.
*/
Transliterator::~Transliterator() {
delete filter;
}
/**
* Copy constructor.
*/
Transliterator::Transliterator(const Transliterator& other) :
ID(other.ID), filter(0),
maximumContextLength(other.maximumContextLength) {
if (other.filter != 0) {
// We own the filter, so we must have our own copy
filter = other.filter->clone();
}
}
/**
* Assignment operator.
*/
Transliterator& Transliterator::operator=(const Transliterator& other) {
ID = other.ID;
maximumContextLength = other.maximumContextLength;
// MUST go through adoptFilter in case latter is overridden
adoptFilter((other.filter == 0) ? 0 : other.filter->clone());
return *this;
}
/**
* Transliterates a segment of a string. <code>Transliterator</code> API.
* @param text the string to be transliterated
* @param start the beginning index, inclusive; <code>0 <= start
* <= limit</code>.
* @param limit the ending index, exclusive; <code>start <= limit
* <= text.length()</code>.
* @return the new limit index
*/
int32_t Transliterator::transliterate(Replaceable& text,
int32_t start, int32_t limit) const {
UTransPosition offsets;
offsets.contextStart= start;
offsets.contextLimit = limit;
offsets.start = start;
offsets.limit = limit;
handleTransliterate(text, offsets, FALSE);
return offsets.limit;
}
/**
* Transliterates an entire string in place. Convenience method.
* @param text the string to be transliterated
*/
void Transliterator::transliterate(Replaceable& text) const {
transliterate(text, 0, text.length());
}
/**
* Transliterates the portion of the text buffer that can be
* transliterated unambiguosly after new text has been inserted,
* typically as a result of a keyboard event. The new text in
* <code>insertion</code> will be inserted into <code>text</code>
* at <code>index.contextLimit</code>, advancing
* <code>index.contextLimit</code> by <code>insertion.length()</code>.
* Then the transliterator will try to transliterate characters of
* <code>text</code> between <code>index.start</code> and
* <code>index.contextLimit</code>. Characters before
* <code>index.start</code> will not be changed.
*
* <p>Upon return, values in <code>index</code> will be updated.
* <code>index.contextStart</code> will be advanced to the first
* character that future calls to this method will read.
* <code>index.start</code> and <code>index.contextLimit</code> will
* be adjusted to delimit the range of text that future calls to
* this method may change.
*
* <p>Typical usage of this method begins with an initial call
* with <code>index.contextStart</code> and <code>index.contextLimit</code>
* set to indicate the portion of <code>text</code> to be
* transliterated, and <code>index.start == index.contextStart</code>.
* Thereafter, <code>index</code> can be used without
* modification in future calls, provided that all changes to
* <code>text</code> are made via this method.
*
* <p>This method assumes that future calls may be made that will
* insert new text into the buffer. As a result, it only performs
* unambiguous transliterations. After the last call to this
* method, there may be untransliterated text that is waiting for
* more input to resolve an ambiguity. In order to perform these
* pending transliterations, clients should call {@link
* #finishKeyboardTransliteration} after the last call to this
* method has been made.
*
* @param text the buffer holding transliterated and untransliterated text
* @param index an array of three integers.
*
* <ul><li><code>index.contextStart</code>: the beginning index,
* inclusive; <code>0 <= index.contextStart <= index.contextLimit</code>.
*
* <li><code>index.contextLimit</code>: the ending index, exclusive;
* <code>index.contextStart <= index.contextLimit <= text.length()</code>.
* <code>insertion</code> is inserted at
* <code>index.contextLimit</code>.
*
* <li><code>index.start</code>: the next character to be
* considered for transliteration; <code>index.contextStart <=
* index.start <= index.contextLimit</code>. Characters before
* <code>index.start</code> will not be changed by future calls
* to this method.</ul>
*
* @param insertion text to be inserted and possibly
* transliterated into the translation buffer at
* <code>index.contextLimit</code>. If <code>null</code> then no text
* is inserted.
* @see #START
* @see #LIMIT
* @see #CURSOR
* @see #handleTransliterate
* @exception IllegalArgumentException if <code>index</code>
* is invalid
*/
void Transliterator::transliterate(Replaceable& text,
UTransPosition& index,
const UnicodeString& insertion,
UErrorCode &status) const {
_transliterate(text, index, &insertion, status);
}
/**
* Transliterates the portion of the text buffer that can be
* transliterated unambiguosly after a new character has been
* inserted, typically as a result of a keyboard event. This is a
* convenience method; see {@link
* #transliterate(Replaceable, int[], String)} for details.
* @param text the buffer holding transliterated and
* untransliterated text
* @param index an array of three integers. See {@link
* #transliterate(Replaceable, int[], String)}.
* @param insertion text to be inserted and possibly
* transliterated into the translation buffer at
* <code>index.contextLimit</code>.
* @see #transliterate(Replaceable, int[], String)
*/
void Transliterator::transliterate(Replaceable& text,
UTransPosition& index,
UChar insertion,
UErrorCode& status) const {
UnicodeString str(insertion);
_transliterate(text, index, &str, status);
}
/**
* Transliterates the portion of the text buffer that can be
* transliterated unambiguosly. This is a convenience method; see
* {@link #transliterate(Replaceable, int[], String)} for
* details.
* @param text the buffer holding transliterated and
* untransliterated text
* @param index an array of three integers. See {@link
* #transliterate(Replaceable, int[], String)}.
* @see #transliterate(Replaceable, int[], String)
*/
void Transliterator::transliterate(Replaceable& text,
UTransPosition& index,
UErrorCode& status) const {
_transliterate(text, index, 0, status);
}
/**
* Finishes any pending transliterations that were waiting for
* more characters. Clients should call this method as the last
* call after a sequence of one or more calls to
* <code>transliterate()</code>.
* @param text the buffer holding transliterated and
* untransliterated text.
* @param index the array of indices previously passed to {@link
* #transliterate}
*/
void Transliterator::finishTransliteration(Replaceable& text,
UTransPosition& index) const {
handleTransliterate(text, index, FALSE);
}
/**
* This internal method does keyboard transliteration. If the
* 'insertion' is non-null then we append it to 'text' before
* proceeding. This method calls through to the pure virtual
* framework method handleTransliterate() to do the actual
* work.
*/
void Transliterator::_transliterate(Replaceable& text,
UTransPosition& index,
const UnicodeString* insertion,
UErrorCode &status) const {
if (U_FAILURE(status)) {
return;
}
if (index.contextStart < 0 ||
index.contextLimit > text.length() ||
index.start < index.contextStart ||
index.start > index.contextLimit) {
status = U_ILLEGAL_ARGUMENT_ERROR;
return;
}
int32_t originalStart = index.contextStart;
if (insertion != 0) {
text.handleReplaceBetween(index.limit, index.limit, *insertion);
index.limit += insertion->length();
index.contextLimit += insertion->length();
}
handleTransliterate(text, index, TRUE);
index.contextStart = uprv_max(index.start - getMaximumContextLength(),
originalStart);
}
/**
* Method for subclasses to use to set the maximum context length.
* @see #getMaximumContextLength
*/
void Transliterator::setMaximumContextLength(int32_t maxContextLength) {
maximumContextLength = maxContextLength;
}
/**
* Returns a programmatic identifier for this transliterator.
* If this identifier is passed to <code>getInstance()</code>, it
* will return this object, if it has been registered.
* @see #registerInstance
* @see #getAvailableIDs
*/
const UnicodeString& Transliterator::getID(void) const {
return ID;
}
/**
* Returns a name for this transliterator that is appropriate for
* display to the user in the default locale. See {@link
* #getDisplayName(Locale)} for details.
*/
UnicodeString& Transliterator::getDisplayName(const UnicodeString& ID,
UnicodeString& result) {
return getDisplayName(ID, Locale::getDefault(), result);
}
/**
* Returns a name for this transliterator that is appropriate for
* display to the user in the given locale. This name is taken
* from the locale resource data in the standard manner of the
* <code>java.text</code> package.
*
* <p>If no localized names exist in the system resource bundles,
* a name is synthesized using a localized
* <code>MessageFormat</code> pattern from the resource data. The
* arguments to this pattern are an integer followed by one or two
* strings. The integer is the number of strings, either 1 or 2.
* The strings are formed by splitting the ID for this
* transliterator at the first ID_SEP. If there is no ID_SEP, then the
* entire ID forms the only string.
* @param inLocale the Locale in which the display name should be
* localized.
* @see java.text.MessageFormat
*/
UnicodeString& Transliterator::getDisplayName(const UnicodeString& ID,
const Locale& inLocale,
UnicodeString& result) {
UErrorCode status = U_ZERO_ERROR;
ResourceBundle bundle(u_getDataDirectory(), inLocale, status);
// Suspend checking status until later...
// build the char* key
char key[100];
uprv_strcpy(key, RB_DISPLAY_NAME_PREFIX);
int32_t length=uprv_strlen(RB_DISPLAY_NAME_PREFIX);
key[length + ID.extract(0, sizeof(key)-length-1, key+length, "")]=0;
// Try to retrieve a UnicodeString* from the bundle. The result,
// if any, should NOT be deleted.
/*const UnicodeString* resString = bundle.getString(key, status);*/
UnicodeString resString = bundle.getStringEx(key, status);
/*if (U_SUCCESS(status) && resString != 0) {*/
if (U_SUCCESS(status) && resString.length() != 0) {
/*return result = *resString; // [sic] assign & return*/
return result = resString; // [sic] assign & return
}
// We have failed to get a name from the locale data. This is
// typical, since most transliterators will not have localized
// name data. The next step is to retrieve the MessageFormat
// pattern from the locale data and to use it to synthesize the
// name from the ID.
status = U_ZERO_ERROR;
/*resString = bundle.getString(RB_DISPLAY_NAME_PATTERN, status);*/
resString = bundle.getStringEx(RB_DISPLAY_NAME_PATTERN, status);
/*if (U_SUCCESS(status) && resString != 0) {*/
if (U_SUCCESS(status) && resString.length() != 0) {
/*MessageFormat msg(*resString, inLocale, status);*/
MessageFormat msg(resString, inLocale, status);
// Suspend checking status until later...
// We pass either 2 or 3 Formattable objects to msg.
Formattable args[3];
int32_t i = ID.indexOf(ID_SEP);
int32_t nargs;
if (i < 0) {
args[0].setLong(1); // # of args to follow
args[1].setString(ID);
nargs = 2;
} else {
UnicodeString left, right;
ID.extractBetween(0, i, left);
ID.extractBetween(i+1, ID.length(), right);
args[0].setLong(2); // # of args to follow
args[1].setString(left);
args[2].setString(right);
nargs = 3;
}
// Use display names for the scripts, if they exist
UnicodeString s;
for (int j=1; j<=((i<0)?1:2); ++j) {
status = U_ZERO_ERROR;
uprv_strcpy(key, RB_SCRIPT_DISPLAY_NAME_PREFIX);
length=uprv_strlen(RB_SCRIPT_DISPLAY_NAME_PREFIX);
args[j].getString(s);
key[length + s.extract(0, sizeof(key)-length-1, key+length, "")]=0;
/*resString = bundle.getString(key, status);*/
resString = bundle.getStringEx(key, status);
if (U_SUCCESS(status)) {
/*args[j] = *resString;*/
args[j] = resString;
}
}
status = U_ZERO_ERROR;
FieldPosition pos; // ignored by msg
msg.format(args, nargs, result, pos, status);
if (U_SUCCESS(status)) {
return result;
}
}
// We should not reach this point unless there is something
// wrong with the build or the RB_DISPLAY_NAME_PATTERN has
// been deleted from the root RB_LOCALE_ELEMENTS resource.
result = ID;
return result;
}
/**
* Returns the filter used by this transliterator, or <tt>null</tt>
* if this transliterator uses no filter. Caller musn't delete
* the result!
*/
const UnicodeFilter* Transliterator::getFilter(void) const {
return filter;
}
/**
* Returns the filter used by this transliterator, or
* <tt>NULL</tt> if this transliterator uses no filter. The
* caller must eventually delete the result. After this call,
* this transliterator's filter is set to <tt>NULL</tt>.
*/
UnicodeFilter* Transliterator::orphanFilter(void) {
UnicodeFilter *result = filter;
// MUST go through adoptFilter in case latter is overridden
adoptFilter(0);
return result;
}
/**
* Changes the filter used by this transliterator. If the filter
* is set to <tt>null</tt> then no filtering will occur.
*
* <p>Callers must take care if a transliterator is in use by
* multiple threads. The filter should not be changed by one
* thread while another thread may be transliterating.
*/
void Transliterator::adoptFilter(UnicodeFilter* filterToAdopt) {
delete filter;
filter = filterToAdopt;
}
/**
* Returns this transliterator's inverse. See the class
* documentation for details. This implementation simply inverts
* the two entities in the ID and attempts to retrieve the
* resulting transliterator. That is, if <code>getID()</code>
* returns "A-B", then this method will return the result of
* <code>getInstance("B-A")</code>, or <code>null</code> if that
* call fails.
*
* <p>This method does not take filtering into account. The
* returned transliterator will have no filter.
*
* <p>Subclasses with knowledge of their inverse may wish to
* override this method.
*
* @return a transliterator that is an inverse, not necessarily
* exact, of this transliterator, or <code>null</code> if no such
* transliterator is registered.
* @see #registerInstance
*/
Transliterator* Transliterator::createInverse(void) const {
return Transliterator::createInstance(ID, UTRANS_REVERSE);
}
/**
* Returns a <code>Transliterator</code> object given its ID.
* The ID must be either a system transliterator ID or a ID registered
* using <code>registerInstance()</code>.
*
* @param ID a valid ID, as enumerated by <code>getAvailableIDs()</code>
* @return A <code>Transliterator</code> object with the given ID
* @see #registerInstance
* @see #getAvailableIDs
* @see #getID
*/
Transliterator* Transliterator::createInstance(const UnicodeString& ID,
UTransDirection dir,
UParseError* parseError) {
Transliterator* t = 0;
if (ID.indexOf(ID_DELIM) >= 0) {
UErrorCode status = U_ZERO_ERROR;
t = new CompoundTransliterator(ID, dir, 0, status);
if (U_FAILURE(status)) {
delete t;
t = 0;
}
} else {
// The 'facadeID' is the ID to be applied to an alias
// transliterator like Hangul-Latin, which is really
// Hangul-Jamo;Jamo-Latin, but which should have a getID()
// result of "Hangul-Latin". The 'facadeID' is only used in
// that way for alias transliterators. The 'alias' parameter
// is non-empty if _createInstance() finds that the given ID
// refers to an alias. The reason _createInstance() doesn't
// call createInstance() (this method) directly is to avoid
// deadlock. There are other ways to do this but this is one
// of the more efficient ways.
UnicodeString alias, facadeID;
if (dir == UTRANS_REVERSE) {
int32_t i = ID.indexOf(ID_SEP);
if (i >= 0) {
UnicodeString right;
ID.extractBetween(i+1, ID.length(), facadeID);
ID.extractBetween(0, i, right);
facadeID.append(ID_SEP).append(right);
t = _createInstance(facadeID, alias, parseError);
}
} else {
t = _createInstance(ID, alias, parseError);
facadeID = ID;
}
if (alias.length() > 0) { // assert(t==0)
t = createInstance(alias);
if (t != 0) {
t->setID(ID);
}
}
}
return t;
}
/**
* Returns a transliterator object given its ID. Unlike getInstance(),
* this method returns null if it cannot make use of the given ID.
* @param aliasReturn if ID is an alias transliterator this is set
* the the parameter to be passed to createInstance() and 0 is
* returned; otherwise, this is unchanged
*/
Transliterator* Transliterator::_createInstance(const UnicodeString& ID,
UnicodeString& aliasReturn,
UParseError* parseError) {
UErrorCode status = U_ZERO_ERROR;
if (!cacheInitialized) {
initializeCache();
}
Mutex lock(&cacheMutex);
CacheEntry* entry = (CacheEntry*) cache->get(ID);
if (entry == 0) {
entry = (CacheEntry*) internalCache->get(ID);
}
TransliterationRuleData* data = 0;
if (entry == 0) {
return 0;
}
if (entry->entryType == CacheEntry::RBT_DATA) {
data = entry->u.data;
// Fall through to construct transliterator from cached Data object.
} else if (entry->entryType == CacheEntry::PROTOTYPE) {
return entry->u.prototype->clone();
} else if (entry->entryType == CacheEntry::ALIAS) {
// We can't call createInstance() here because of deadlock.
aliasReturn = entry->stringArg;
return 0;
} else {
// At this point entry type must be either RULES_FORWARD
// or RULES_REVERSE
UBool isReverse = (entry->entryType == CacheEntry::RULES_REVERSE);
// We use the file name, taken from another resource bundle
// 2-d array at static init time, as a locale language. We're
// just using the locale mechanism to map through to a file
// name; this in no way represents an actual locale.
char *ch;
ch = new char[entry->stringArg.length() + 1];
ch[entry->stringArg.extract(0, 0x7fffffff, ch, "")] = 0;
Locale fakeLocale(ch);
delete [] ch;
ResourceBundle bundle((char *)0,
fakeLocale, status);
// Call RBT to parse the rules from the resource bundle
UnicodeString rules = bundle.getStringEx(RB_RULE, status);
// If the status indicates a failure, then we don't have any
// rules -- there is probably an installation error. The list
// in the root locale should correspond to all the installed
// transliterators; if it lists something that's not
// installed, we'll get an error from ResourceBundle.
if (U_SUCCESS(status)) {
data = TransliterationRuleParser::parse(rules, isReverse
? UTRANS_REVERSE
: UTRANS_FORWARD,
parseError);
// Double check to see if someone has modified the entry
// since we last looked at it.
if (entry->entryType != CacheEntry::RBT_DATA) {
entry->entryType = CacheEntry::RBT_DATA;
entry->u.data = data;
} else {
// Oops! Another thread has updated this cache entry
// already to point to a data object. Discard the
// one we just created and use the one in the cache
// instead.
delete data;
data = entry->u.data;
}
}
}
if (data != 0) {
return new RuleBasedTransliterator(ID, data);
} else {
// We have a failure of some kind. Remove the ID from the
// cache so we don't keep trying. NOTE: This will throw off
// anyone who is, at the moment, trying to iterate over the
// available IDs. That's acceptable since we should never
// really get here except under installation, configuration,
// or unrecoverable run time memory failures.
_unregister(ID);
}
return 0;
}
/**
* Registers a instance <tt>obj</tt> of a subclass of
* <code>Transliterator</code> with the system. This object must
* implement the <tt>clone()</tt> method. When
* <tt>getInstance()</tt> is called with an ID string that is
* equal to <tt>obj.getID()</tt>, then <tt>obj.clone()</tt> is
* returned.
*
* @param obj an instance of subclass of
* <code>Transliterator</code> that defines <tt>clone()</tt>
* @see #getInstance
* @see #unregister
*/
void Transliterator::registerInstance(Transliterator* adoptedPrototype,
UErrorCode &status) {
if (!cacheInitialized) {
initializeCache();
}
Mutex lock(&cacheMutex);
_registerInstance(adoptedPrototype, status);
}
/**
* This internal method registers a prototype instance in the cache.
* The CALLER MUST MUTEX using cacheMutex before calling this method.
*/
void Transliterator::_registerInstance(Transliterator* adoptedPrototype,
UErrorCode &status) {
if (U_FAILURE(status)) {
return;
}
/*int32_t hashCode = hash(adoptedPrototype->getID());*/
// This needs explaining: The string reference that getID returns
// is to the ID data member of Transliterator. As long as the
// Transliterator object exists, this reference is valid, and in
// fact we can take its address and store it in IDS. No problem
// there. The only thing we have to be sure of is that before we
// remove the prototype (via unregister()), we remove the ID
// entry.
cacheIDs.addElement((void*) &adoptedPrototype->getID());
CacheEntry* entry = (CacheEntry*) cache->get(adoptedPrototype->getID());
if (entry == 0) {
entry = new CacheEntry();
}
entry->adoptPrototype(adoptedPrototype);
//uhash_putKey(cache, hashCode, entry, &status);
cache->put(adoptedPrototype->getID(), entry, status);
}
/**
* Unregisters a transliterator or class. This may be either
* a system transliterator or a user transliterator or class.
*
* @param ID the ID of the transliterator or class
* @see #registerInstance
*/
void Transliterator::unregister(const UnicodeString& ID) {
if (!cacheInitialized) {
initializeCache();
}
Mutex lock(&cacheMutex);
_unregister(ID);
}
/**
* Unregisters a transliterator or class. Internal method.
* Prerequisites: The cache must be initialized, and the
* caller must own the cacheMutex.
*/
void Transliterator::_unregister(const UnicodeString& ID) {
cacheIDs.removeElement((void*) &ID);
//int32_t hc = hash(ID);
CacheEntry* entry = (CacheEntry*) cache->get(ID);
if (entry != 0) {
cache->remove(ID);
delete entry;
}
}
/**
* Vector of registered IDs.
*/
UVector Transliterator::cacheIDs;
/**
* Return the number of IDs currently registered with the system.
* To retrieve the actual IDs, call getAvailableID(i) with
* i from 0 to countAvailableIDs() - 1.
*/
int32_t Transliterator::countAvailableIDs(void) {
if (!cacheInitialized) {
initializeCache();
}
Mutex lock(&cacheMutex);
return cacheIDs.size();
}
/**
* Return the index-th available ID. index must be between 0
* and countAvailableIDs() - 1, inclusive. If index is out of
* range, the result of getAvailableID(0) is returned.
*/
const UnicodeString& Transliterator::getAvailableID(int32_t index) {
if (index < 0 || index >= cacheIDs.size()) {
index = 0;
}
if (!cacheInitialized) {
initializeCache();
}
Mutex lock(&cacheMutex);
return *(const UnicodeString*) cacheIDs[index];
}
/**
* Method for subclasses to use to obtain a character in the given
* string, with filtering.
*/
UChar Transliterator::filteredCharAt(const Replaceable& text, int32_t i) const {
UChar c;
const UnicodeFilter* localFilter = getFilter();
return (localFilter == 0) ? text.charAt(i) :
(localFilter->contains(c = text.charAt(i)) ? c : (UChar)0xFFFE);
}
/**
* Comparison function for UVector. Compares two UnicodeString
* objects given void* pointers to them.
*/
UBool Transliterator::compareIDs(void* a, void* b) {
const UnicodeString* aa = (const UnicodeString*) a;
const UnicodeString* bb = (const UnicodeString*) b;
return *aa == *bb;
}
void Transliterator::initializeCache(void) {
// Lock first, check init boolean second
Mutex lock(&cacheMutex);
if (cacheInitialized) {
return;
}
UErrorCode status = U_ZERO_ERROR;
// Before looking for the resource, construct our cache.
// That way if the resource is absent, we will at least
// have a valid cache object.
cacheIDs.setComparer(compareIDs);
/* The following code parses the index table located in
* icu/data/translit_index.txt. The index is an n x 4 table
* that follows this format:
*
* <id>:file:<resource>:<direction>
* <id>:internal:<resource>:<direction>
* <id>:alias:<getInstanceArg>:
*
* <id> is the ID of the system transliterator being defined. These
* are public IDs enumerated by Transliterator.getAvailableIDs(),
* unless the second field is "internal".
*
* <resource> is a ResourceReader resource name. Currently these refer
* to file names under com/ibm/text/resources. This string is passed
* directly to ResourceReader, together with <encoding>.
*
* <direction> is either "FORWARD" or "REVERSE".
*
* <getInstanceArg> is a string to be passed directly to
* Transliterator.getInstance(). The returned Transliterator object
* then has its ID changed to <id> and is returned.
*
* The extra blank field on "alias" lines is to make the array square.
*/
Locale indexLoc("translit_index");
ResourceBundle bundle((char *)0,
indexLoc, status);
ResourceBundle transIDs(bundle.get(RB_RULE_BASED_IDS, status));
int32_t row, maxRows;
if (U_SUCCESS(status)) {
maxRows = transIDs.getSize();
for (row = 0; row < maxRows; row++) {
ResourceBundle colBund(transIDs.get(row, status));
if (U_SUCCESS(status) && colBund.getSize() == 4) {
UnicodeString id(colBund.getStringEx((int32_t)0, status));
UChar type = colBund.getStringEx(1, status).charAt(0);
UnicodeString resource(colBund.getStringEx(2, status));
if (U_SUCCESS(status)) {
CacheEntry* entry = new CacheEntry();
if (type == 0x0066 || type == 0x0069) { // 'f', 'i'
// 'file' or 'internal'; row[2]=resource, row[3]=direction
if ((colBund.getStringEx(3, status).charAt(0)) == 0x0052) {// 'R'
entry->entryType = CacheEntry::RULES_REVERSE;
} else {
entry->entryType = CacheEntry::RULES_FORWARD;
}
} else { // assert(type == 0x0061 /*a*/)
// 'alias'; row[2]=createInstance argument
entry->entryType = CacheEntry::ALIAS;
}
entry->stringArg = resource;
// Use internalCache for 'internal' entries
Hashtable* c = (type == 0x0069/*i*/) ? internalCache : cache;
c->put(id, entry, status);
// cacheIDs owns & should delete the following string
cacheIDs.addElement((void*) new UnicodeString(id));
}
}
}
}
// Manually add prototypes that the system knows about to the
// cache. This is how new non-rule-based transliterators are
// added to the system.
status = U_ZERO_ERROR; // Reset status for following calls
_registerInstance(new HexToUnicodeTransliterator(), status);
_registerInstance(new UnicodeToHexTransliterator(), status);
_registerInstance(new JamoHangulTransliterator(), status);
_registerInstance(new HangulJamoTransliterator(), status);
_registerInstance(new NullTransliterator(), status);
cacheInitialized = TRUE;
}
Transliterator::CacheEntry::CacheEntry() {
u.prototype = 0;
entryType = NONE;
}
Transliterator::CacheEntry::~CacheEntry() {
if (entryType == PROTOTYPE) {
delete u.prototype;
}
}
void Transliterator::CacheEntry::adoptPrototype(Transliterator* adopted) {
if (entryType == PROTOTYPE) {
delete u.prototype;
}
entryType = PROTOTYPE;
u.prototype = adopted;
}