SDL_locale.c File Reference

#include "../SDL_internal.h"
#include "SDL_syslocale.h"
#include "SDL_hints.h"

Include dependency graph for SDL_locale.c:

Go to the source code of this file.

Functions
static SDL_Locale *	build_locales_from_csv_string (char *csv)
SDL_Locale *	SDL_GetPreferredLocales (void)
	Report the user's preferred locale. More...

Function Documentation

build_locales_from_csv_string()

static SDL_Locale* build_locales_from_csv_string ( char *  csv )

static

Definition at line 27 of file SDL_locale.c.

{
    size_t num_locales = 1;  /* at least one */
    size_t slen;
    size_t alloclen;
    char *ptr;
    SDL_Locale *loc;
    SDL_Locale *retval;
 
    if (!csv || !csv[0]) {
        return NULL;  /* nothing to report */
    }
 
    for (ptr = csv; *ptr; ptr++) {
        if (*ptr == ',') {
            num_locales++;
        }
    }
 
    num_locales++;  /* one more for terminator */
 
    slen = ((size_t) (ptr - csv)) + 1;  /* strlen(csv) + 1 */
    alloclen = slen + (num_locales * sizeof (SDL_Locale));
 
    loc = retval = (SDL_Locale *) SDL_calloc(1, alloclen);
    if (!retval) {
        SDL_OutOfMemory();
        return NULL;  /* oh well */
    }
    ptr = (char *) (retval + num_locales);
    SDL_strlcpy(ptr, csv, slen);
 
    while (SDL_TRUE) {  /* parse out the string */
        while (*ptr == ' ') ptr++;  /* skip whitespace. */
        if (*ptr == '\0') {
            break;
        }
        loc->language = ptr++;
        while (SDL_TRUE) {
            const char ch = *ptr;
            if (ch == '_') {
                *(ptr++) = '\0';
                loc->country = ptr;
            } else if (ch == ' ') {
                *(ptr++) = '\0';  /* trim ending whitespace and keep going. */
            } else if (ch == ',') {
                *(ptr++) = '\0';
                loc++;
                break;
            } else if (ch == '\0') {
                loc++;
                break;
            } else {
                ptr++;  /* just keep going, still a valid string */
            }
        }
    }
 
    return retval;
}

References SDL_Locale::country, SDL_Locale::language, NULL, ptr, retval, SDL_calloc, SDL_OutOfMemory, SDL_strlcpy, and SDL_TRUE.

Referenced by SDL_GetPreferredLocales().

SDL_GetPreferredLocales()

SDL_Locale* SDL_GetPreferredLocales

(

void

)

Report the user's preferred locale.

This returns an array of SDL_Locale structs, the final item zeroed out. When the caller is done with this array, it should call SDL_free() on the returned value; all the memory involved is allocated in a single block, so a single SDL_free() will suffice.

Returned language strings are in the format xx, where 'xx' is an ISO-639 language specifier (such as "en" for English, "de" for German, etc). Country strings are in the format YY, where "YY" is an ISO-3166 country code (such as "US" for the United States, "CA" for Canada, etc). Country might be NULL if there's no specific guidance on them (so you might get { "en", "US" } for American English, but { "en", NULL } means "English language, generically"). Language strings are never NULL, except to terminate the array.

Please note that not all of these strings are 2 characters; some are three or more.

The returned list of locales are in the order of the user's preference. For example, a German citizen that is fluent in US English and knows enough Japanese to navigate around Tokyo might have a list like: { "de", "en_US", "jp", NULL }. Someone from England might prefer British English (where "color" is spelled "colour", etc), but will settle for anything like it: { "en_GB", "en", NULL }.

This function returns NULL on error, including when the platform does not supply this information at all.

This might be a "slow" call that has to query the operating system. It's best to ask for this once and save the results. However, this list can change, usually because the user has changed a system preference outside of your program; SDL will send an SDL_LOCALECHANGED event in this case, if possible, and you can call this function again to get an updated copy of preferred locales.

Returns

array of locales, terminated with a locale with a NULL language field. Will return NULL on error.

Definition at line 89 of file SDL_locale.c.

{
    char locbuf[128];  /* enough for 21 "xx_YY," language strings. */
    const char *hint = SDL_GetHint(SDL_HINT_PREFERRED_LOCALES);
    if (hint) {
        SDL_strlcpy(locbuf, hint, sizeof (locbuf));
    } else {
        SDL_zeroa(locbuf);
        SDL_SYS_GetPreferredLocales(locbuf, sizeof (locbuf));
    }
    return build_locales_from_csv_string(locbuf);
}

References build_locales_from_csv_string(), SDL_GetHint, SDL_HINT_PREFERRED_LOCALES, SDL_strlcpy, SDL_SYS_GetPreferredLocales(), and SDL_zeroa.