ICU 77.1 77.1

resbund.h
Go to the documentation of this file.
1 // © 2016 and later: Unicode, Inc. and others.
2 // License & terms of use: http://www.unicode.org/copyright.html
3 /*
4 ******************************************************************************
5 *
6 * Copyright (C) 1996-2013, International Business Machines Corporation
7 * and others. All Rights Reserved.
8 *
9 ******************************************************************************
10 *
11 * File resbund.h
12 *
13 * CREATED BY
14 * Richard Gillam
15 *
16 * Modification History:
17 *
18 * Date Name Description
19 * 2/5/97 aliu Added scanForLocaleInFile. Added
20 * constructor which attempts to read resource bundle
21 * from a specific file, without searching other files.
22 * 2/11/97 aliu Added UErrorCode return values to constructors. Fixed
23 * infinite loops in scanForFile and scanForLocale.
24 * Modified getRawResourceData to not delete storage
25 * in localeData and resourceData which it doesn't own.
26 * Added Mac compatibility #ifdefs for tellp() and
27 * ios::nocreate.
28 * 2/18/97 helena Updated with 100% documentation coverage.
29 * 3/13/97 aliu Rewrote to load in entire resource bundle and store
30 * it as a Hashtable of ResourceBundleData objects.
31 * Added state table to govern parsing of files.
32 * Modified to load locale index out of new file
33 * distinct from default.txt.
34 * 3/25/97 aliu Modified to support 2-d arrays, needed for timezone
35 * data. Added support for custom file suffixes. Again,
36 * needed to support timezone data.
37 * 4/7/97 aliu Cleaned up.
38 * 03/02/99 stephen Removed dependency on FILE*.
39 * 03/29/99 helena Merged Bertrand and Stephen's changes.
40 * 06/11/99 stephen Removed parsing of .txt files.
41 * Reworked to use new binary format.
42 * Cleaned up.
43 * 06/14/99 stephen Removed methods taking a filename suffix.
44 * 11/09/99 weiv Added getLocale(), fRealLocale, removed fRealLocaleID
45 ******************************************************************************
46 */
47
48 #ifndef RESBUND_H
49 #define RESBUND_H
50
51 #include "unicode/utypes.h"
52
53 #if U_SHOW_CPLUSPLUS_API
54
55 #include "unicode/uobject.h"
56 #include "unicode/ures.h"
57 #include "unicode/unistr.h"
58 #include "unicode/locid.h"
59
65 U_NAMESPACE_BEGIN
66
83 class U_COMMON_API ResourceBundle : public UObject {
84 public:
111 ResourceBundle(const UnicodeString& packageName,
112 const Locale& locale,
113 UErrorCode& err);
114
126 ResourceBundle(const UnicodeString& packageName,
127 UErrorCode& err);
128
135 ResourceBundle(UErrorCode &err);
136
151 ResourceBundle(const char* packageName,
152 const Locale& locale,
153 UErrorCode& err);
154
161 ResourceBundle(const ResourceBundle &original);
162
172 ResourceBundle(UResourceBundle *res,
173 UErrorCode &status);
174
181 ResourceBundle&
182 operator=(const ResourceBundle& other);
183
187 virtual ~ResourceBundle();
188
200 ResourceBundle *clone() const;
201
212 int32_t getSize() const;
213
224 UnicodeString
225 getString(UErrorCode& status) const;
226
239 const uint8_t*
240 getBinary(int32_t& len, UErrorCode& status) const;
241
242
254 const int32_t*
255 getIntVector(int32_t& len, UErrorCode& status) const;
256
268 uint32_t
269 getUInt(UErrorCode& status) const;
270
282 int32_t
283 getInt(UErrorCode& status) const;
284
291 UBool hasNext() const;
292
298 void resetIterator();
299
307 const char* getKey() const;
308
316 const char* getName() const;
317
324 UResType getType() const;
325
333 ResourceBundle
334 getNext(UErrorCode& status);
335
344 UnicodeString
345 getNextString(UErrorCode& status);
346
356 UnicodeString
357 getNextString(const char ** key,
358 UErrorCode& status);
359
368 ResourceBundle
369 get(int32_t index,
370 UErrorCode& status) const;
371
380 UnicodeString
381 getStringEx(int32_t index,
382 UErrorCode& status) const;
383
393 ResourceBundle
394 get(const char* key,
395 UErrorCode& status) const;
396
406 UnicodeString
407 getStringEx(const char* key,
408 UErrorCode& status) const;
409
410 #ifndef U_HIDE_DEPRECATED_API
420 const char* getVersionNumber() const;
421 #endif /* U_HIDE_DEPRECATED_API */
422
430 void
431 getVersion(UVersionInfo versionInfo) const;
432
433 #ifndef U_HIDE_DEPRECATED_API
440 const Locale& getLocale() const;
441 #endif /* U_HIDE_DEPRECATED_API */
442
453 Locale
454 getLocale(ULocDataLocaleType type, UErrorCode &status) const;
455 #ifndef U_HIDE_INTERNAL_API
460 ResourceBundle
461 getWithFallback(const char* key, UErrorCode& status);
462 #endif /* U_HIDE_INTERNAL_API */
468 virtual UClassID getDynamicClassID() const override;
469
475 static UClassID U_EXPORT2 getStaticClassID();
476
477 private:
478 ResourceBundle() = delete; // default constructor not implemented
479
480 UResourceBundle *fResource;
481 void constructForLocale(const UnicodeString& path, const Locale& locale, UErrorCode& error);
482 Locale *fLocale;
483 };
484
485 U_NAMESPACE_END
486
487 #endif /* U_SHOW_CPLUSPLUS_API */
488
489 #endif
icu::Locale
A Locale object represents a specific geographical, political, or cultural region.
Definition: locid.h:195
icu::ResourceBundle
A class representing a collection of resource information pertaining to a given locale.
Definition: resbund.h:83
icu::ResourceBundle::ResourceBundle
ResourceBundle(UResourceBundle *res, UErrorCode &status)
Constructor from a C UResourceBundle.
icu::ResourceBundle::ResourceBundle
ResourceBundle(const ResourceBundle &original)
Copy constructor.
icu::ResourceBundle::ResourceBundle
ResourceBundle(const char *packageName, const Locale &locale, UErrorCode &err)
Standard constructor, constructs a resource bundle for the locale-specific bundle in the specified pa...
icu::ResourceBundle::get
ResourceBundle get(int32_t index, UErrorCode &status) const
Returns the resource in a resource at the specified index.
icu::ResourceBundle::clone
ResourceBundle * clone() const
Clone this object.
icu::ResourceBundle::getSize
int32_t getSize() const
Returns the size of a resource.
icu::ResourceBundle::getType
UResType getType() const
Returns the type of a resource.
icu::ResourceBundle::ResourceBundle
ResourceBundle(const UnicodeString &packageName, UErrorCode &err)
Construct a resource bundle for the default bundle in the specified package.
icu::ResourceBundle::getInt
int32_t getInt(UErrorCode &status) const
returns a signed integer from a resource.
icu::ResourceBundle::get
ResourceBundle get(const char *key, UErrorCode &status) const
Returns a resource in a resource that has a given key.
icu::ResourceBundle::getVersion
void getVersion(UVersionInfo versionInfo) const
Return the version number associated with this ResourceBundle as a UVersionInfo array.
icu::ResourceBundle::getNext
ResourceBundle getNext(UErrorCode &status)
Returns the next resource in a given resource or nullptr if there are no more resources.
icu::ResourceBundle::getDynamicClassID
virtual UClassID getDynamicClassID() const override
ICU "poor man's RTTI", returns a UClassID for the actual class.
icu::ResourceBundle::getStaticClassID
static UClassID getStaticClassID()
ICU "poor man's RTTI", returns a UClassID for this class.
icu::ResourceBundle::getName
const char * getName() const
Gets the locale ID of the resource bundle as a string.
icu::ResourceBundle::getLocale
Locale getLocale(ULocDataLocaleType type, UErrorCode &status) const
Return the Locale associated with this ResourceBundle.
icu::ResourceBundle::ResourceBundle
ResourceBundle(UErrorCode &err)
Construct a resource bundle for the ICU default bundle.
icu::ResourceBundle::getIntVector
const int32_t * getIntVector(int32_t &len, UErrorCode &status) const
returns an integer vector from a resource.
icu::ResourceBundle::operator=
ResourceBundle & operator=(const ResourceBundle &other)
Assignment operator.
icu::ResourceBundle::getStringEx
UnicodeString getStringEx(int32_t index, UErrorCode &status) const
Returns the string in a given resource at the specified index.
icu::ResourceBundle::hasNext
UBool hasNext() const
Checks whether the resource has another element to iterate over.
icu::ResourceBundle::getWithFallback
ResourceBundle getWithFallback(const char *key, UErrorCode &status)
This API implements multilevel fallback.
icu::ResourceBundle::getNextString
UnicodeString getNextString(UErrorCode &status)
Returns the next string in a resource or nullptr if there are no more resources to iterate over.
icu::ResourceBundle::resetIterator
void resetIterator()
Resets the internal context of a resource so that iteration starts from the first element.
icu::ResourceBundle::getUInt
uint32_t getUInt(UErrorCode &status) const
returns an unsigned integer from a resource.
icu::ResourceBundle::getKey
const char * getKey() const
Returns the key associated with this resource.
icu::ResourceBundle::~ResourceBundle
virtual ~ResourceBundle()
Destructor.
icu::ResourceBundle::getNextString
UnicodeString getNextString(const char **key, UErrorCode &status)
Returns the next string in a resource or nullptr if there are no more resources to iterate over.
icu::ResourceBundle::ResourceBundle
ResourceBundle(const UnicodeString &packageName, const Locale &locale, UErrorCode &err)
Constructor.
icu::ResourceBundle::getBinary
const uint8_t * getBinary(int32_t &len, UErrorCode &status) const
returns a binary data from a resource.
icu::ResourceBundle::getLocale
const Locale & getLocale() const
Return the Locale associated with this ResourceBundle.
icu::ResourceBundle::getVersionNumber
const char * getVersionNumber() const
Return the version number associated with this ResourceBundle as a string.
icu::ResourceBundle::getString
UnicodeString getString(UErrorCode &status) const
returns a string from a string resource type
icu::ResourceBundle::getStringEx
UnicodeString getStringEx(const char *key, UErrorCode &status) const
Returns a string in a resource that has a given key.
icu::UObject
UObject is the common ICU "boilerplate" class.
Definition: uobject.h:223
icu::UnicodeString
UnicodeString is a string class that stores Unicode characters directly and provides similar function...
Definition: unistr.h:296
locid.h
C++ API: Locale ID object.
ULocDataLocaleType
ULocDataLocaleType
Constants for *_getLocale() Allow user to select whether she wants information on requested,...
Definition: uloc.h:338
UBool
int8_t UBool
The ICU boolean type, a signed-byte integer.
Definition: umachine.h:247
unistr.h
C++ API: Unicode String.
uobject.h
C++ API: Common ICU base class UObject.
UClassID
void * UClassID
UClassID is used to identify classes without using the compiler's RTTI.
Definition: uobject.h:96
ures.h
C API: Resource Bundle.
UResType
UResType
Numeric constants for types of resource items.
Definition: ures.h:70
UResourceBundle
struct UResourceBundle UResourceBundle
Definition: ures.h:63
utypes.h
Basic definitions for ICU, for both C and C++ APIs.
UErrorCode
UErrorCode
Standard ICU4C error code type, a substitute for exceptions.
Definition: utypes.h:430
U_COMMON_API
#define U_COMMON_API
Set to export library symbols from inside the common library, and to import them from outside.
Definition: utypes.h:315
UVersionInfo
uint8_t UVersionInfo[U_MAX_VERSION_LENGTH]
The binary form of a version on ICU APIs is an array of 4 uint8_t.
Definition: uversion.h:59