ICU 72.1 72.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
213 getSize(void) const;
214
225 UnicodeString
226 getString(UErrorCode& status) const;
227
240 const uint8_t*
241 getBinary(int32_t& len, UErrorCode& status) const;
242
243
255 const int32_t*
256 getIntVector(int32_t& len, UErrorCode& status) const;
257
269 uint32_t
270 getUInt(UErrorCode& status) const;
271
283 int32_t
284 getInt(UErrorCode& status) const;
285
292 UBool
293 hasNext(void) const;
294
300 void
301 resetIterator(void);
302
310 const char*
311 getKey(void) const;
312
320 const char*
321 getName(void) const;
322
323
330 UResType
331 getType(void) const;
332
340 ResourceBundle
341 getNext(UErrorCode& status);
342
351 UnicodeString
352 getNextString(UErrorCode& status);
353
363 UnicodeString
364 getNextString(const char ** key,
365 UErrorCode& status);
366
375 ResourceBundle
376 get(int32_t index,
377 UErrorCode& status) const;
378
387 UnicodeString
388 getStringEx(int32_t index,
389 UErrorCode& status) const;
390
400 ResourceBundle
401 get(const char* key,
402 UErrorCode& status) const;
403
413 UnicodeString
414 getStringEx(const char* key,
415 UErrorCode& status) const;
416
417 #ifndef U_HIDE_DEPRECATED_API
427 const char*
428 getVersionNumber(void) const;
429 #endif /* U_HIDE_DEPRECATED_API */
430
438 void
439 getVersion(UVersionInfo versionInfo) const;
440
441 #ifndef U_HIDE_DEPRECATED_API
448 const Locale&
449 getLocale(void) const;
450 #endif /* U_HIDE_DEPRECATED_API */
451
462 const Locale
463 getLocale(ULocDataLocaleType type, UErrorCode &status) const;
464 #ifndef U_HIDE_INTERNAL_API
469 ResourceBundle
470 getWithFallback(const char* key, UErrorCode& status);
471 #endif /* U_HIDE_INTERNAL_API */
477 virtual UClassID getDynamicClassID() const override;
478
484 static UClassID U_EXPORT2 getStaticClassID();
485
486 private:
487 ResourceBundle() = delete; // default constructor not implemented
488
489 UResourceBundle *fResource;
490 void constructForLocale(const UnicodeString& path, const Locale& locale, UErrorCode& error);
491 Locale *fLocale;
492 };
493
494 U_NAMESPACE_END
495
496 #endif /* U_SHOW_CPLUSPLUS_API */
497
498 #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::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 NULL 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::ResourceBundle
ResourceBundle(UErrorCode &err)
Construct a resource bundle for the ICU default bundle.
icu::ResourceBundle::resetIterator
void resetIterator(void)
Resets the internal context of a resource so that iteration starts from the first element.
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::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 NULL if there are no more resources to iterate over.
icu::ResourceBundle::getLocale
const Locale getLocale(ULocDataLocaleType type, UErrorCode &status) const
Return the Locale associated with this ResourceBundle.
icu::ResourceBundle::getLocale
const Locale & getLocale(void) const
Return the Locale associated with this ResourceBundle.
icu::ResourceBundle::getType
UResType getType(void) const
Returns the type of a resource.
icu::ResourceBundle::getUInt
uint32_t getUInt(UErrorCode &status) const
returns an unsigned integer from a resource.
icu::ResourceBundle::getSize
int32_t getSize(void) const
Returns the size of a 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 NULL if there are no more resources to iterate over.
icu::ResourceBundle::getVersionNumber
const char * getVersionNumber(void) const
Return the version number associated with this ResourceBundle as a string.
icu::ResourceBundle::ResourceBundle
ResourceBundle(const UnicodeString &packageName, const Locale &locale, UErrorCode &err)
Constructor.
icu::ResourceBundle::getName
const char * getName(void) const
Gets the locale ID of the resource bundle as a string.
icu::ResourceBundle::getBinary
const uint8_t * getBinary(int32_t &len, UErrorCode &status) const
returns a binary data from a resource.
icu::ResourceBundle::getKey
const char * getKey(void) const
Returns the key associated with this resource.
icu::ResourceBundle::getString
UnicodeString getString(UErrorCode &status) const
returns a string from a string resource type
icu::ResourceBundle::hasNext
UBool hasNext(void) const
Checks whether the resource has another element to iterate over.
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:269
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:69
UResourceBundle
struct UResourceBundle UResourceBundle
Definition: ures.h:62
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:415
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:300
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