1 // © 2016 and later: Unicode, Inc. and others.
2 // License & terms of use: http://www.unicode.org/copyright.html
4 *******************************************************************************
5 * Copyright (C) 2001-2014, International Business Machines Corporation.
7 *******************************************************************************
10 #include "unicode/utypes.h"
12 #if !UCONFIG_NO_SERVICE
17 #undef SERVICE_REFCOUNT
19 // in case we use the refcount stuff
24 ******************************************************************
27 const UChar
ICUServiceKey::PREFIX_DELIMITER
= 0x002F; /* '/' */
29 ICUServiceKey::ICUServiceKey(const UnicodeString
& id
)
33 ICUServiceKey::~ICUServiceKey()
38 ICUServiceKey::getID() const
44 ICUServiceKey::canonicalID(UnicodeString
& result
) const
46 return result
.append(_id
);
50 ICUServiceKey::currentID(UnicodeString
& result
) const
52 return canonicalID(result
);
56 ICUServiceKey::currentDescriptor(UnicodeString
& result
) const
59 result
.append(PREFIX_DELIMITER
);
60 return currentID(result
);
64 ICUServiceKey::fallback()
70 ICUServiceKey::isFallbackOf(const UnicodeString
& id
) const
76 ICUServiceKey::prefix(UnicodeString
& result
) const
82 ICUServiceKey::parsePrefix(UnicodeString
& result
)
84 int32_t n
= result
.indexOf(PREFIX_DELIMITER
);
93 ICUServiceKey::parseSuffix(UnicodeString
& result
)
95 int32_t n
= result
.indexOf(PREFIX_DELIMITER
);
97 result
.remove(0, n
+1);
104 ICUServiceKey::debug(UnicodeString
& result
) const
107 result
.append((UnicodeString
)" id: ");
113 ICUServiceKey::debugClass(UnicodeString
& result
) const
115 return result
.append((UnicodeString
)"ICUServiceKey");
119 UOBJECT_DEFINE_RTTI_IMPLEMENTATION(ICUServiceKey
)
122 ******************************************************************
125 ICUServiceFactory::~ICUServiceFactory() {}
127 SimpleFactory::SimpleFactory(UObject
* instanceToAdopt
, const UnicodeString
& id
, UBool visible
)
128 : _instance(instanceToAdopt
), _id(id
), _visible(visible
)
132 SimpleFactory::~SimpleFactory()
138 SimpleFactory::create(const ICUServiceKey
& key
, const ICUService
* service
, UErrorCode
& status
) const
140 if (U_SUCCESS(status
)) {
142 if (_id
== key
.currentID(temp
)) {
143 return service
->cloneInstance(_instance
);
150 SimpleFactory::updateVisibleIDs(Hashtable
& result
, UErrorCode
& status
) const
153 result
.put(_id
, (void*)this, status
); // cast away const
160 SimpleFactory::getDisplayName(const UnicodeString
& id
, const Locale
& /* locale */, UnicodeString
& result
) const
162 if (_visible
&& _id
== id
) {
172 SimpleFactory::debug(UnicodeString
& toAppendTo
) const
174 debugClass(toAppendTo
);
175 toAppendTo
.append((UnicodeString
)" id: ");
176 toAppendTo
.append(_id
);
177 toAppendTo
.append((UnicodeString
)", visible: ");
178 toAppendTo
.append(_visible
? (UnicodeString
)"T" : (UnicodeString
)"F");
183 SimpleFactory::debugClass(UnicodeString
& toAppendTo
) const
185 return toAppendTo
.append((UnicodeString
)"SimpleFactory");
189 UOBJECT_DEFINE_RTTI_IMPLEMENTATION(SimpleFactory
)
192 ******************************************************************
195 ServiceListener::~ServiceListener() {}
197 UOBJECT_DEFINE_RTTI_IMPLEMENTATION(ServiceListener
)
200 ******************************************************************
203 // Record the actual id for this service in the cache, so we can return it
204 // even if we succeed later with a different id.
205 class CacheEntry
: public UMemory
{
210 UnicodeString actualDescriptor
;
214 * Releases a reference to the shared resource.
220 CacheEntry(const UnicodeString
& _actualDescriptor
, UObject
* _service
)
221 : refcount(1), actualDescriptor(_actualDescriptor
), service(_service
) {
225 * Instantiation creates an initial reference, so don't call this
226 * unless you're creating a new pointer to this. Management of
227 * that pointer will have to know how to deal with refcounts.
228 * Return true if the resource has not already been released.
236 * Destructions removes a reference, so don't call this unless
237 * you're removing pointer to this somewhere. Management of that
238 * pointer will have to know how to deal with refcounts. Once
239 * the refcount drops to zero, the resource is released. Return
240 * false if the resouce has been released.
242 CacheEntry
* unref() {
243 if ((--refcount
) == 0) {
251 * Return TRUE if there is at least one reference to this and the
252 * resource has not been released.
254 UBool
isShared() const {
259 // UObjectDeleter for serviceCache
261 static void U_CALLCONV
262 cacheDeleter(void* obj
) {
263 U_NAMESPACE_USE ((CacheEntry
*)obj
)->unref();
267 * Deleter for UObjects
269 static void U_CALLCONV
270 deleteUObject(void *obj
) {
271 U_NAMESPACE_USE
delete (UObject
*) obj
;
276 ******************************************************************
279 class DNCache
: public UMemory
{
284 DNCache(const Locale
& _locale
)
285 : cache(), locale(_locale
)
287 // cache.setKeyDeleter(uprv_deleteUObject);
293 ******************************************************************
297 StringPair::create(const UnicodeString
& displayName
,
298 const UnicodeString
& id
,
301 if (U_SUCCESS(status
)) {
302 StringPair
* sp
= new StringPair(displayName
, id
);
303 if (sp
== NULL
|| sp
->isBogus()) {
304 status
= U_MEMORY_ALLOCATION_ERROR
;
314 StringPair::isBogus() const {
315 return displayName
.isBogus() || id
.isBogus();
318 StringPair::StringPair(const UnicodeString
& _displayName
,
319 const UnicodeString
& _id
)
320 : displayName(_displayName
)
326 static void U_CALLCONV
327 userv_deleteStringPair(void *obj
) {
328 U_NAMESPACE_USE
delete (StringPair
*) obj
;
333 ******************************************************************
338 ICUService::ICUService()
348 ICUService::ICUService(const UnicodeString
& newName
)
358 ICUService::~ICUService()
369 ICUService::get(const UnicodeString
& descriptor
, UErrorCode
& status
) const
371 return get(descriptor
, NULL
, status
);
375 ICUService::get(const UnicodeString
& descriptor
, UnicodeString
* actualReturn
, UErrorCode
& status
) const
377 UObject
* result
= NULL
;
378 ICUServiceKey
* key
= createKey(&descriptor
, status
);
380 result
= getKey(*key
, actualReturn
, status
);
387 ICUService::getKey(ICUServiceKey
& key
, UErrorCode
& status
) const
389 return getKey(key
, NULL
, status
);
392 // this is a vector that subclasses of ICUService can override to further customize the result object
393 // before returning it. All other public get functions should call this one.
396 ICUService::getKey(ICUServiceKey
& key
, UnicodeString
* actualReturn
, UErrorCode
& status
) const
398 return getKey(key
, actualReturn
, NULL
, status
);
401 // make it possible to call reentrantly on systems that don't have reentrant mutexes.
402 // we can use this simple approach since we know the situation where we're calling
403 // reentrantly even without knowing the thread.
404 class XMutex
: public UMemory
{
406 inline XMutex(UMutex
*mutex
, UBool reentering
)
408 , fActive(!reentering
)
410 if (fActive
) umtx_lock(fMutex
);
413 if (fActive
) umtx_unlock(fMutex
);
421 struct UVectorDeleter
{
423 UVectorDeleter() : _obj(NULL
) {}
424 ~UVectorDeleter() { delete _obj
; }
427 // called only by factories, treat as private
429 ICUService::getKey(ICUServiceKey
& key
, UnicodeString
* actualReturn
, const ICUServiceFactory
* factory
, UErrorCode
& status
) const
431 if (U_FAILURE(status
)) {
436 return handleDefault(key
, actualReturn
, status
);
439 ICUService
* ncthis
= (ICUService
*)this; // cast away semantic const
441 CacheEntry
* result
= NULL
;
443 // The factory list can't be modified until we're done,
444 // otherwise we might update the cache with an invalid result.
445 // The cache has to stay in synch with the factory list.
446 // ICU doesn't have monitors so we can't use rw locks, so
447 // we single-thread everything using this service, for now.
449 // if factory is not null, we're calling from within the mutex,
450 // and since some unix machines don't have reentrant mutexes we
451 // need to make sure not to try to lock it again.
452 XMutex
mutex(&lock
, factory
!= NULL
);
454 if (serviceCache
== NULL
) {
455 ncthis
->serviceCache
= new Hashtable(status
);
456 if (ncthis
->serviceCache
== NULL
) {
459 if (U_FAILURE(status
)) {
463 serviceCache
->setValueDeleter(cacheDeleter
);
466 UnicodeString currentDescriptor
;
467 UVectorDeleter cacheDescriptorList
;
468 UBool putInCache
= FALSE
;
470 int32_t startIndex
= 0;
471 int32_t limit
= factories
->size();
472 UBool cacheResult
= TRUE
;
474 if (factory
!= NULL
) {
475 for (int32_t i
= 0; i
< limit
; ++i
) {
476 if (factory
== (const ICUServiceFactory
*)factories
->elementAt(i
)) {
481 if (startIndex
== 0) {
482 // throw new InternalError("Factory " + factory + "not registered with service: " + this);
483 status
= U_ILLEGAL_ARGUMENT_ERROR
;
490 currentDescriptor
.remove();
491 key
.currentDescriptor(currentDescriptor
);
492 result
= (CacheEntry
*)serviceCache
->get(currentDescriptor
);
493 if (result
!= NULL
) {
497 // first test of cache failed, so we'll have to update
498 // the cache if we eventually succeed-- that is, if we're
499 // going to update the cache at all.
502 int32_t index
= startIndex
;
503 while (index
< limit
) {
504 ICUServiceFactory
* f
= (ICUServiceFactory
*)factories
->elementAt(index
++);
505 UObject
* service
= f
->create(key
, this, status
);
506 if (U_FAILURE(status
)) {
510 if (service
!= NULL
) {
511 result
= new CacheEntry(currentDescriptor
, service
);
512 if (result
== NULL
) {
514 status
= U_MEMORY_ALLOCATION_ERROR
;
522 // prepare to load the cache with all additional ids that
523 // will resolve to result, assuming we'll succeed. We
524 // don't want to keep querying on an id that's going to
525 // fallback to the one that succeeded, we want to hit the
526 // cache the first time next goaround.
527 if (cacheDescriptorList
._obj
== NULL
) {
528 cacheDescriptorList
._obj
= new UVector(uprv_deleteUObject
, NULL
, 5, status
);
529 if (U_FAILURE(status
)) {
533 UnicodeString
* idToCache
= new UnicodeString(currentDescriptor
);
534 if (idToCache
== NULL
|| idToCache
->isBogus()) {
535 status
= U_MEMORY_ALLOCATION_ERROR
;
539 cacheDescriptorList
._obj
->addElement(idToCache
, status
);
540 if (U_FAILURE(status
)) {
543 } while (key
.fallback());
546 if (result
!= NULL
) {
547 if (putInCache
&& cacheResult
) {
548 serviceCache
->put(result
->actualDescriptor
, result
, status
);
549 if (U_FAILURE(status
)) {
553 if (cacheDescriptorList
._obj
!= NULL
) {
554 for (int32_t i
= cacheDescriptorList
._obj
->size(); --i
>= 0;) {
555 UnicodeString
* desc
= (UnicodeString
*)cacheDescriptorList
._obj
->elementAt(i
);
557 serviceCache
->put(*desc
, result
, status
);
558 if (U_FAILURE(status
)) {
563 cacheDescriptorList
._obj
->removeElementAt(i
);
568 if (actualReturn
!= NULL
) {
570 if (result
->actualDescriptor
.indexOf((UChar
)0x2f) == 0) { // U+002f=slash (/)
571 actualReturn
->remove();
572 actualReturn
->append(result
->actualDescriptor
,
574 result
->actualDescriptor
.length() - 1);
576 *actualReturn
= result
->actualDescriptor
;
579 if (actualReturn
->isBogus()) {
580 status
= U_MEMORY_ALLOCATION_ERROR
;
586 UObject
* service
= cloneInstance(result
->service
);
587 if (putInCache
&& !cacheResult
) {
594 return handleDefault(key
, actualReturn
, status
);
598 ICUService::handleDefault(const ICUServiceKey
& /* key */, UnicodeString
* /* actualIDReturn */, UErrorCode
& /* status */) const
604 ICUService::getVisibleIDs(UVector
& result
, UErrorCode
& status
) const {
605 return getVisibleIDs(result
, NULL
, status
);
609 ICUService::getVisibleIDs(UVector
& result
, const UnicodeString
* matchID
, UErrorCode
& status
) const
611 result
.removeAllElements();
613 if (U_FAILURE(status
)) {
619 const Hashtable
* map
= getVisibleIDMap(status
);
621 ICUServiceKey
* fallbackKey
= createKey(matchID
, status
);
623 for (int32_t pos
= UHASH_FIRST
;;) {
624 const UHashElement
* e
= map
->nextElement(pos
);
629 const UnicodeString
* id
= (const UnicodeString
*)e
->key
.pointer
;
630 if (fallbackKey
!= NULL
) {
631 if (!fallbackKey
->isFallbackOf(*id
)) {
636 UnicodeString
* idClone
= new UnicodeString(*id
);
637 if (idClone
== NULL
|| idClone
->isBogus()) {
639 status
= U_MEMORY_ALLOCATION_ERROR
;
642 result
.addElement(idClone
, status
);
643 if (U_FAILURE(status
)) {
651 if (U_FAILURE(status
)) {
652 result
.removeAllElements();
658 ICUService::getVisibleIDMap(UErrorCode
& status
) const {
659 if (U_FAILURE(status
)) return NULL
;
661 // must only be called when lock is already held
663 ICUService
* ncthis
= (ICUService
*)this; // cast away semantic const
664 if (idCache
== NULL
) {
665 ncthis
->idCache
= new Hashtable(status
);
666 if (idCache
== NULL
) {
667 status
= U_MEMORY_ALLOCATION_ERROR
;
668 } else if (factories
!= NULL
) {
669 for (int32_t pos
= factories
->size(); --pos
>= 0;) {
670 ICUServiceFactory
* f
= (ICUServiceFactory
*)factories
->elementAt(pos
);
671 f
->updateVisibleIDs(*idCache
, status
);
673 if (U_FAILURE(status
)) {
675 ncthis
->idCache
= NULL
;
685 ICUService::getDisplayName(const UnicodeString
& id
, UnicodeString
& result
) const
687 return getDisplayName(id
, result
, Locale::getDefault());
691 ICUService::getDisplayName(const UnicodeString
& id
, UnicodeString
& result
, const Locale
& locale
) const
694 UErrorCode status
= U_ZERO_ERROR
;
696 const Hashtable
* map
= getVisibleIDMap(status
);
698 ICUServiceFactory
* f
= (ICUServiceFactory
*)map
->get(id
);
700 f
->getDisplayName(id
, locale
, result
);
705 status
= U_ZERO_ERROR
;
706 ICUServiceKey
* fallbackKey
= createKey(&id
, status
);
707 while (fallbackKey
!= NULL
&& fallbackKey
->fallback()) {
709 fallbackKey
->currentID(us
);
710 f
= (ICUServiceFactory
*)map
->get(us
);
712 f
->getDisplayName(id
, locale
, result
);
725 ICUService::getDisplayNames(UVector
& result
, UErrorCode
& status
) const
727 return getDisplayNames(result
, Locale::getDefault(), NULL
, status
);
732 ICUService::getDisplayNames(UVector
& result
, const Locale
& locale
, UErrorCode
& status
) const
734 return getDisplayNames(result
, locale
, NULL
, status
);
738 ICUService::getDisplayNames(UVector
& result
,
739 const Locale
& locale
,
740 const UnicodeString
* matchID
,
741 UErrorCode
& status
) const
743 result
.removeAllElements();
744 result
.setDeleter(userv_deleteStringPair
);
745 if (U_SUCCESS(status
)) {
746 ICUService
* ncthis
= (ICUService
*)this; // cast away semantic const
749 if (dnCache
!= NULL
&& dnCache
->locale
!= locale
) {
751 ncthis
->dnCache
= NULL
;
754 if (dnCache
== NULL
) {
755 const Hashtable
* m
= getVisibleIDMap(status
);
756 if (U_FAILURE(status
)) {
759 ncthis
->dnCache
= new DNCache(locale
);
760 if (dnCache
== NULL
) {
761 status
= U_MEMORY_ALLOCATION_ERROR
;
765 int32_t pos
= UHASH_FIRST
;
766 const UHashElement
* entry
= NULL
;
767 while ((entry
= m
->nextElement(pos
)) != NULL
) {
768 const UnicodeString
* id
= (const UnicodeString
*)entry
->key
.pointer
;
769 ICUServiceFactory
* f
= (ICUServiceFactory
*)entry
->value
.pointer
;
771 f
->getDisplayName(*id
, locale
, dname
);
772 if (dname
.isBogus()) {
773 status
= U_MEMORY_ALLOCATION_ERROR
;
775 dnCache
->cache
.put(dname
, (void*)id
, status
); // share pointer with visibleIDMap
776 if (U_SUCCESS(status
)) {
781 ncthis
->dnCache
= NULL
;
787 ICUServiceKey
* matchKey
= createKey(matchID
, status
);
788 /* To ensure that all elements in the hashtable are iterated, set pos to -1.
789 * nextElement(pos) will skip the position at pos and begin the iteration
790 * at the next position, which in this case will be 0.
792 int32_t pos
= UHASH_FIRST
;
793 const UHashElement
*entry
= NULL
;
794 while ((entry
= dnCache
->cache
.nextElement(pos
)) != NULL
) {
795 const UnicodeString
* id
= (const UnicodeString
*)entry
->value
.pointer
;
796 if (matchKey
!= NULL
&& !matchKey
->isFallbackOf(*id
)) {
799 const UnicodeString
* dn
= (const UnicodeString
*)entry
->key
.pointer
;
800 StringPair
* sp
= StringPair::create(*id
, *dn
, status
);
801 result
.addElement(sp
, status
);
802 if (U_FAILURE(status
)) {
803 result
.removeAllElements();
813 ICUService::registerInstance(UObject
* objToAdopt
, const UnicodeString
& id
, UErrorCode
& status
)
815 return registerInstance(objToAdopt
, id
, TRUE
, status
);
819 ICUService::registerInstance(UObject
* objToAdopt
, const UnicodeString
& id
, UBool visible
, UErrorCode
& status
)
821 ICUServiceKey
* key
= createKey(&id
, status
);
823 UnicodeString canonicalID
;
824 key
->canonicalID(canonicalID
);
827 ICUServiceFactory
* f
= createSimpleFactory(objToAdopt
, canonicalID
, visible
, status
);
829 return registerFactory(f
, status
);
837 ICUService::createSimpleFactory(UObject
* objToAdopt
, const UnicodeString
& id
, UBool visible
, UErrorCode
& status
)
839 if (U_SUCCESS(status
)) {
840 if ((objToAdopt
!= NULL
) && (!id
.isBogus())) {
841 return new SimpleFactory(objToAdopt
, id
, visible
);
843 status
= U_ILLEGAL_ARGUMENT_ERROR
;
849 ICUService::registerFactory(ICUServiceFactory
* factoryToAdopt
, UErrorCode
& status
)
851 if (U_SUCCESS(status
) && factoryToAdopt
!= NULL
) {
854 if (factories
== NULL
) {
855 factories
= new UVector(deleteUObject
, NULL
, status
);
856 if (U_FAILURE(status
)) {
861 factories
->insertElementAt(factoryToAdopt
, 0, status
);
862 if (U_SUCCESS(status
)) {
865 delete factoryToAdopt
;
866 factoryToAdopt
= NULL
;
870 if (factoryToAdopt
!= NULL
) {
874 return (URegistryKey
)factoryToAdopt
;
878 ICUService::unregister(URegistryKey rkey
, UErrorCode
& status
)
880 ICUServiceFactory
*factory
= (ICUServiceFactory
*)rkey
;
881 UBool result
= FALSE
;
882 if (factory
!= NULL
&& factories
!= NULL
) {
885 if (factories
->removeElement(factory
)) {
889 status
= U_ILLEGAL_ARGUMENT_ERROR
;
904 reInitializeFactories();
911 ICUService::reInitializeFactories()
913 if (factories
!= NULL
) {
914 factories
->removeAllElements();
919 ICUService::isDefault() const
921 return countFactories() == 0;
925 ICUService::createKey(const UnicodeString
* id
, UErrorCode
& status
) const
927 return (U_FAILURE(status
) || id
== NULL
) ? NULL
: new ICUServiceKey(*id
);
931 ICUService::clearCaches()
933 // callers synchronize before use
939 delete serviceCache
; serviceCache
= NULL
;
943 ICUService::clearServiceCache()
945 // callers synchronize before use
946 delete serviceCache
; serviceCache
= NULL
;
950 ICUService::acceptsListener(const EventListener
& l
) const
952 return dynamic_cast<const ServiceListener
*>(&l
) != NULL
;
956 ICUService::notifyListener(EventListener
& l
) const
958 ((ServiceListener
&)l
).serviceChanged(*this);
962 ICUService::getName(UnicodeString
& result
) const
964 return result
.append(name
);
968 ICUService::countFactories() const
970 return factories
== NULL
? 0 : factories
->size();
974 ICUService::getTimestamp() const
981 /* UCONFIG_NO_SERVICE */