Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

ures.h File Reference

C API: Resource Bundle. More...

#include "unicode/utypes.h"
#include "unicode/uloc.h"

Go to the source code of this file.

Typedefs

typedef struct UResourceBundle UResourceBundle

Enumerations

enum  UResType {
  RES_NONE = -1, RES_STRING = 0, RES_BINARY = 1, RES_TABLE = 2,
  RES_INT = 7, RES_ARRAY = 8, RES_INT_VECTOR = 14, RES_RESERVED = 15
}

Functions

U_CAPI UResourceBundle* U_EXPORT2 ures_open (const char* path, const char* locale, UErrorCode* status)
 Opens a UResourceBundle, from which users can extract strings by using their corresponding keys. More...

U_CAPI UResourceBundle* U_EXPORT2 ures_openW (const wchar_t* path, const char* locale, UErrorCode* status)
 Opens a UResourceBundle, from which users can extract strings by using their corresponding keys. More...

U_CAPI UResourceBundle* U_EXPORT2 ures_openU (const UChar* path, const char* locale, UErrorCode* status)
U_CAPI int32_t U_EXPORT2 ures_countArrayItems (const UResourceBundle* resourceBundle, const char* resourceKey, UErrorCode* err)
 Returns the number of strings/arrays in resource bundles. More...

U_CAPI void U_EXPORT2 ures_close (UResourceBundle* resourceBundle)
 close a resource bundle, all pointers returned from the various ures_getXXX calls on this particular bundle are INVALID henceforth. More...

U_CAPI const char* U_EXPORT2 ures_getVersionNumber (const UResourceBundle* resourceBundle)
 Return the version number associated with this ResourceBundle. More...

U_CAPI void U_EXPORT2 ures_getVersion (const UResourceBundle* resB, UVersionInfo versionInfo)
U_CAPI const char* ures_getLocale (const UResourceBundle* resourceBundle, UErrorCode* status)
 Return the name of the Locale associated with this ResourceBundle. More...

U_CAPI void ures_openFillIn (UResourceBundle *r, const char* path, const char* localeID, UErrorCode* status)
 New API.

U_CAPI const UChar* U_EXPORT2 ures_getString (const UResourceBundle* resourceBundle, int32_t* len, UErrorCode* status)
 returns a string from a string resource type. More...

U_CAPI const uint8_t* U_EXPORT2 ures_getBinary (const UResourceBundle* resourceBundle, int32_t* len, UErrorCode* status)
 returns a binary data from a resource. More...

U_CAPI uint32_t U_EXPORT2 ures_getInt (const UResourceBundle* resourceBundle, UErrorCode *status)
 returns an integer from a resource. More...

U_CAPI int32_t U_EXPORT2 ures_getSize (UResourceBundle *resourceBundle)
 Returns the size of a resource. More...

U_CAPI UResType U_EXPORT2 ures_getType (UResourceBundle *resourceBundle)
 Returns the type of a resource. More...

U_CAPI const char* U_EXPORT2 ures_getKey (UResourceBundle *resB)
 Returns the key associated with a given resource. More...

U_CAPI void U_EXPORT2 ures_resetIterator (UResourceBundle *resourceBundle)
 Resets the internal context of a resource so that iteration starts from the first element. More...

U_CAPI UBool U_EXPORT2 ures_hasNext (UResourceBundle *resourceBundle)
 Checks whether the given resource has another element to iterate over. More...

U_CAPI UResourceBundle* U_EXPORT2 ures_getNextResource (UResourceBundle *resourceBundle, UResourceBundle *fillIn, UErrorCode *status)
 Returns the next resource in a given resource or NULL if there are no more resources to iterate over. More...

U_CAPI const UChar* U_EXPORT2 ures_getNextString (UResourceBundle *resourceBundle, int32_t* len, const char ** key, UErrorCode *status)
 Returns the next string in a given resource or NULL if there are no more resources to iterate over. More...

U_CAPI UResourceBundle* U_EXPORT2 ures_getByIndex (const UResourceBundle *resourceBundle, int32_t indexR, UResourceBundle *fillIn, UErrorCode *status)
 Returns the resource in a given resource at the specified index. More...

U_CAPI const UChar* U_EXPORT2 ures_getStringByIndex (const UResourceBundle *resB, int32_t indexS, int32_t* len, UErrorCode *status)
 Returns the string in a given resource at the specified index. More...

U_CAPI UResourceBundle* U_EXPORT2 ures_getByKey (const UResourceBundle *resourceBundle, const char* key, UResourceBundle *fillIn, UErrorCode *status)
 Returns a resource in a given resource that has a given key. More...

U_CAPI const UChar* U_EXPORT2 ures_getStringByKey (const UResourceBundle *resB, const char* key, int32_t* len, UErrorCode *status)
 Returns a string in a given resource that has a given key. More...

U_CFUNC const char* ures_getName (const UResourceBundle* resB)
U_CFUNC const char* ures_getPath (const UResourceBundle* resB)
U_CFUNC const char* ures_getTag (const UResourceBundle* resB)


Detailed Description

C API: Resource Bundle.

C API: Resource Bundle

C API representing a collection of resource information pertaining to a given locale. A resource bundle provides a way of accessing locale- specific information in a data file. You create a resource bundle that manages the resources for a given locale and then ask it for individual resources.

The resource bundle file is a text (ASCII or Unicode) file with the format:

 
    locale {
       tag1 {...}
       tag2 {...}
    }
The tags are used to retrieve the data later. You may not have multiple instances of the same tag.

Four data types are supported. These are solitary strings, comma-delimited lists of strings, 2-dimensional arrays of strings, and tagged lists of strings.

Note that all data is textual. Adjacent strings are merged by the low-level tokenizer, so that the following effects occur: foo bar, baz // 2 elements, "foo bar", and "baz" "foo" "bar", baz // 2 elements, "foobar", and "baz" Note that a single intervening space is added between merged strings, unless they are both double quoted. This extends to more than two strings in a row.

Whitespace is ignored, as in a C source file.

Solitary strings have the format:

 
    Tag { Data }
This is indistinguishable from a comma-delimited list with only one element, and in fact may be retrieved as such (as an array, or as element 0 or an array).

Comma-delimited lists have the format:

 
    Tag { Data, Data, Data }
Parsing is lenient; a final string, after the last element, is allowed.

Tagged lists have the format:

 
    Tag { Subtag { Data } Subtag {Data} }
Data is retrieved by specifying the subtag.

Two-dimensional arrays have the format:

 
    TwoD {
        { r1c1, r1c2, ..., r1cm },
        { r2c1, r2c2, ..., r2cm },
        ...
        { rnc1, rnc2, ..., rncm }
    }
where n is the number of rows, and m is the number of columns. Parsing is lenient (as in other data types). A final comma is always allowed after the last element; either the last string in a row, or the last row itself. Furthermore, since there is no ambiguity, the commas between the rows are entirely optional. (However, if a comma is present, there can only be one comma, no more.) It is possible to have zero columns, as follows:
 
    Odd { {} {} {} } // 3 x 0 array
But it is impossible to have zero rows. The smallest array is thus a 1 x 0 array, which looks like this:
 
   Smallest { {} } // 1 x 0 array
The array must be strictly rectangular; that is, each row must have the same number of elements.

Usage model:

Resource bundles contain resources. In code, both types of entities are treated the same and are represented with a same data structure
UResourceBundle
. Resource bundle has a tree structure, where leaf nodes can be strings, binaries and integers while non-leaf nodes (including the root node) can be tables and arrays. One or more resource bundles are used to represent data needed by the application for running in the particular locale. Complete set of resource bundles for an application would contain all the data needed to run in intended locales.

If the data for the requested locale is missing, an effort will be made to obtain most usable data. This process is called fallback. Also, fallback happens when a resource is not present in the given bundle. Then, the other bundles in the fallback chain are also searched for the requested resource.

Retrieving data from resources is possible in several ways, depending on the type of the resources:

1) Access by a key: this approach works only for table resources

2) Access by an index: tables and arrays can be addressed by an index

3) Iteration: works for tables and arrays

To use data in resource bundles, following steps are needed:

1) opening a bundle for a particular locale:

 
      UErrorCode status = U_ZERO_ERROR;
      UResourceBundle* resB = ures_open("/datadir/resources/GUI", "de_AT_EURO", &status);
Status allows, besides testing for plain error, to see whether fallback occured. There are two extra non error values for status after this operation: U_USING_FALLBACK_ERROR, which implies that the bundle for the requested locale was not found, but that one of the bundles in the fallback chain was used (de_AT and de in this case) and U_USING_DEFAULT_ERROR which implies that not one bundle in the fallback chain was found and that default locale was used. In any case, 'root' locale is always at the end of the chain.

This is an example for using a possible custom resource:

 
     const char *currentLocale;
     UErrorCode success = U_ZERO_ERROR;
     UResourceBundle* myResources=ures_open("MyResources", currentLocale, &success );
 
     UChar *button1Title, *button2Title;
     button1Title= ures_get(myResources, "OkKey", &success );
     button2Title= ures_get(myResources, "CancelKey", &success );

Definition in file ures.h.


Typedef Documentation

typedef struct UResourceBundle UResourceBundle
 

Definition at line 171 of file ures.h.


Enumeration Type Documentation

enum UResType
 

Enumeration values:
RES_NONE  
RES_STRING  
RES_BINARY  
RES_TABLE  
RES_INT  
RES_ARRAY  
RES_INT_VECTOR  
RES_RESERVED  

Definition at line 173 of file ures.h.


Function Documentation

U_CAPI void U_EXPORT2 ures_close ( UResourceBundle * resourceBundle )
 

close a resource bundle, all pointers returned from the various ures_getXXX calls on this particular bundle are INVALID henceforth.

Parameters:
resourceBundle:   a succesfully opened resourceBundle.
status:   fills in the outgoing error code could be U_MISSING_RESOURCE_ERROR if the key is not found could be a non-failing error e.g.: U_USING_FALLBACK_ERROR,U_USING_DEFAULT_ERROR
See also:
ures_open , ures_openW
Draft:

U_CAPI int32_t U_EXPORT2 ures_countArrayItems ( const UResourceBundle * resourceBundle,
const char * resourceKey,
UErrorCode * err )
 

Returns the number of strings/arrays in resource bundles.

Parameters:
resourceBundle:   resource bundle containing the desired strings
resourceKey:   key tagging the resource
err:   fills in the outgoing error code could be U_MISSING_RESOURCE_ERROR if the key is not found could be a non-failing error e.g.: U_USING_FALLBACK_ERROR,U_USING_DEFAULT_ERROR
Returns:
for Arrays: returns the number of strings in the array 2d Arrays: returns the number of 1d arrays taggedArrays: returns the number of strings in the array single string: returns 1
See also:
ures_get , ures_getArrayItem , ures_getTaggedArrayItem , ures_get2dArrayItem
Draft:

U_CAPI const uint8_t *U_EXPORT2 ures_getBinary ( const UResourceBundle * resourceBundle,
int32_t * len,
UErrorCode * status )
 

returns a binary data from a resource.

Can be used at most primitive resource types (binaries, strings, ints)

Parameters:
resourceBundle:   a string resource
len:   fills in the length of resulting byte chunk
status:   fills in the outgoing error code could be U_MISSING_RESOURCE_ERROR if the key is not found could be a non-failing error e.g.: U_USING_FALLBACK_ERROR,U_USING_DEFAULT_ERROR
Returns:
a pointer to a chuck of unsigned bytes which live in a memory mapped/DLL file.
Draft:

U_CAPI UResourceBundle *U_EXPORT2 ures_getByIndex ( const UResourceBundle * resourceBundle,
int32_t indexR,
UResourceBundle * fillIn,
UErrorCode * status )
 

Returns the resource in a given resource at the specified index.

Features a fill-in parameter.

Parameters:
resourceBundle   a resource
indexR   an index to the wanted resource.
fillIn   if NULL a new UResourceBundle struct is allocated and must be deleted by the caller. Alternatively, you can supply a struct to be filled by this function.
status   fills in the outgoing error code
Returns:
a pointer to a UResourceBundle struct. If fill in param was NULL, caller must delete it
Stable:

U_CAPI UResourceBundle *U_EXPORT2 ures_getByKey ( const UResourceBundle * resourceBundle,
const char * key,
UResourceBundle * fillIn,
UErrorCode * status )
 

Returns a resource in a given resource that has a given key.

This procedure works only with table resources. Features a fill-in parameter.

Parameters:
resourceBundle   a resource
key   a key associated with the wanted resource
fillIn   if NULL a new UResourceBundle struct is allocated and must be deleted by the caller. Alternatively, you can supply a struct to be filled by this function.
status   fills in the outgoing error code.
Returns:
a pointer to a UResourceBundle struct. If fill in param was NULL, caller must delete it
Stable:

U_CAPI uint32_t U_EXPORT2 ures_getInt ( const UResourceBundle * resourceBundle,
UErrorCode * status )
 

returns an integer from a resource.

Parameters:
resourceBundle:   a string resource
status:   fills in the outgoing error code could be U_MISSING_RESOURCE_ERROR if the key is not found could be a non-failing error e.g.: U_USING_FALLBACK_ERROR,U_USING_DEFAULT_ERROR
Returns:
an integer value
Draft:

U_CAPI const char *U_EXPORT2 ures_getKey ( UResourceBundle * resB )
 

Returns the key associated with a given resource.

Not all the resources have a key - only those that are members of a table.

Parameters:
resourceBundle:   a resource
Returns:
a key associated to this resource, or NULL if it doesn't have a key
Draft:

U_CAPI const char * ures_getLocale ( const UResourceBundle * resourceBundle,
UErrorCode * status )
 

Return the name of the Locale associated with this ResourceBundle.

Parameters:
resourceBundle:   resource bundle in question
status:   just for catching illegal arguments
Returns:
A Locale name
Draft:

U_CFUNC const char* ures_getName ( const UResourceBundle * resB )
 

U_CAPI UResourceBundle *U_EXPORT2 ures_getNextResource ( UResourceBundle * resourceBundle,
UResourceBundle * fillIn,
UErrorCode * status )
 

Returns the next resource in a given resource or NULL if there are no more resources to iterate over.

Features a fill-in parameter.

Parameters:
resourceBundle   a resource
fillIn   if NULL a new UResourceBundle struct is allocated and must be deleted by the caller. Alternatively, you can supply a struct to be filled by this function.
status   fills in the outgoing error code
Returns:
a pointer to a UResourceBundle struct. If fill in param was NULL, caller must delete it
Draft:

U_CAPI const UChar *U_EXPORT2 ures_getNextString ( UResourceBundle * resourceBundle,
int32_t * len,
const char ** key,
UErrorCode * status )
 

Returns the next string in a given resource or NULL if there are no more resources to iterate over.

Parameters:
resourceBundle   a resource
len   fill in length of the string
key   fill in for key associated with this string
status   fills in the outgoing error code
Returns:
a pointer to a zero-terminated UChar array which lives in a memory mapped/DLL file.
Draft:

U_CFUNC const char* ures_getPath ( const UResourceBundle * resB )
 

U_CAPI int32_t U_EXPORT2 ures_getSize ( UResourceBundle * resourceBundle )
 

Returns the size of a resource.

Size for scalar types is always 1, and for vector/table types is the number of child resources.

Parameters:
resourceBundle:   a resource
Returns:
number of resources in a given resource.
Draft:

U_CAPI const UChar *U_EXPORT2 ures_getString ( const UResourceBundle * resourceBundle,
int32_t * len,
UErrorCode * status )
 

returns a string from a string resource type.

Parameters:
resourceBundle:   a string resource
len:   fills in the length of resulting string
status:   fills in the outgoing error code could be U_MISSING_RESOURCE_ERROR if the key is not found could be a non-failing error e.g.: U_USING_FALLBACK_ERROR,U_USING_DEFAULT_ERROR
Returns:
a pointer to a zero-terminated UChar array which lives in a memory mapped/DLL file.
Draft:

U_CAPI const UChar *U_EXPORT2 ures_getStringByIndex ( const UResourceBundle * resB,
int32_t indexS,
int32_t * len,
UErrorCode * status )
 

Returns the string in a given resource at the specified index.

Parameters:
resourceBundle   a resource
indexS   an index to the wanted string.
len   fill in length of the string
status   fills in the outgoing error code
Returns:
a pointer to a zero-terminated UChar array which lives in a memory mapped/DLL file.
Stable:

U_CAPI const UChar *U_EXPORT2 ures_getStringByKey ( const UResourceBundle * resB,
const char * key,
int32_t * len,
UErrorCode * status )
 

Returns a string in a given resource that has a given key.

This procedure works only with table resources.

Parameters:
resourceBundle   a resource
key   a key associated with the wanted string
len   fill in length of the string
status   fills in the outgoing error code
Returns:
a pointer to a zero-terminated UChar array which lives in a memory mapped/DLL file.
Stable:

U_CFUNC const char* ures_getTag ( const UResourceBundle * resB )
 

U_CAPI UResType U_EXPORT2 ures_getType ( UResourceBundle * resourceBundle )
 

Returns the type of a resource.

Available types are defined in enum UResType

Parameters:
resourceBundle:   a resource
Returns:
type of the given resource.
Draft:

U_CAPI void U_EXPORT2 ures_getVersion ( const UResourceBundle * resB,
UVersionInfo versionInfo )
 

U_CAPI const char *U_EXPORT2 ures_getVersionNumber ( const UResourceBundle * resourceBundle )
 

Return the version number associated with this ResourceBundle.

This version number is a string of the form MAJOR.MINOR, where MAJOR is the version number of the current analytic code package, and MINOR is the version number contained in the resource file as the value of the tag "Version". A change in the MINOR version indicated an updated data file. A change in the MAJOR version indicates a new version of the code which is not binary-compatible with the previous version. If no "Version" tag is present in a resource file, the MINOR version "0" is assigned. For example, if the Collation sort key algorithm changes, the MAJOR version increments. If the collation data in a resource file changes, the MINOR version for that file increments.

Parameters:
resourceBundle:   resource bundle in question
Returns:
A string of the form N.n, where N is the major version number, representing the code version, and n is the minor version number, representing the resource data file. The caller does not own this string.
Draft:

U_CAPI UBool U_EXPORT2 ures_hasNext ( UResourceBundle * resourceBundle )
 

Checks whether the given resource has another element to iterate over.

Parameters:
resourceBundle   a resource
Returns:
TRUE if there are more elements, FALSE if there is no more elements
Draft:

U_CAPI UResourceBundle *U_EXPORT2 ures_open ( const char * path,
const char * locale,
UErrorCode * status )
 

Opens a UResourceBundle, from which users can extract strings by using their corresponding keys.

Note that the caller is responsible of calling ures_close on each succesfully opened resource bundle.

Parameters:
path   : string containing the full path pointing to the directory where the resources reside followed by the package name e.g. "/usr/resource/my_app/resources/guimessages" on a Unix system. if NULL, ICU default data files will be used.
locale:   specifies the locale for which we want to open the resource if NULL, the default locale will be used. If strlen(locale) == 0 root locale will be used.
status   : fills in the outgoing error code. The UErrorCode err parameter is used to return status information to the user. To check whether the construction succeeded or not, you should check the value of U_SUCCESS(err). If you wish more detailed information, you can check for informational error results which still indicate success. U_USING_FALLBACK_ERROR indicates that a fall back locale was used. For example, 'de_CH' was requested, but nothing was found there, so 'de' was used. U_USING_DEFAULT_ERROR indicates that the default locale data or root locale data was used; neither the requested locale nor any of its fall back locales could be found.
Returns:
a newly allocated resource bundle.
See also:
ures_close
Draft:

U_CAPI void ures_openFillIn ( UResourceBundle * r,
const char * path,
const char * localeID,
UErrorCode * status )
 

New API.

U_CAPI UResourceBundle* U_EXPORT2 ures_openU ( const UChar * path,
const char * locale,
UErrorCode * status )
 

U_CAPI UResourceBundle *U_EXPORT2 ures_openW ( const wchar_t * path,
const char * locale,
UErrorCode * status )
 

Opens a UResourceBundle, from which users can extract strings by using their corresponding keys.

This version of open requires the path string to be of type const wchar_t*. Note that the caller is responsible of calling ures_close on each succesfully opened resource bundle.

Parameters:
path:   string containing the full path pointing to the directory where the resources reside (should end with a directory separator. e.g. "/usr/resource/my_app/resources/" on a Unix system if NULL will use the system's current data directory
locale:   specifies the locale for which we want to open the resource if NULL will use the default locale
status:   fills in the outgoing error code.
See also:
ures_close
Returns:
: a newly allocated resource bundle.
Draft:

U_CAPI void U_EXPORT2 ures_resetIterator ( UResourceBundle * resourceBundle )
 

Resets the internal context of a resource so that iteration starts from the first element.

Parameters:
resourceBundle:   a resource
Draft:


Generated at Tue Jun 12 14:04:15 2001 for ICU 1.8.1 by doxygen1.2.3 written by Dimitri van Heesch, © 1997-2000