SDL 3.0
SDL_locale.h
Go to the documentation of this file.
1/*
2 Simple DirectMedia Layer
3 Copyright (C) 1997-2024 Sam Lantinga <slouken@libsdl.org>
4
5 This software is provided 'as-is', without any express or implied
6 warranty. In no event will the authors be held liable for any damages
7 arising from the use of this software.
8
9 Permission is granted to anyone to use this software for any purpose,
10 including commercial applications, and to alter it and redistribute it
11 freely, subject to the following restrictions:
12
13 1. The origin of this software must not be misrepresented; you must not
14 claim that you wrote the original software. If you use this software
15 in a product, an acknowledgment in the product documentation would be
16 appreciated but is not required.
17 2. Altered source versions must be plainly marked as such, and must not be
18 misrepresented as being the original software.
19 3. This notice may not be removed or altered from any source distribution.
20*/
21
22/**
23 * \file SDL_locale.h
24 *
25 * Include file for SDL locale services
26 */
27
28#ifndef SDL_locale_h
29#define SDL_locale_h
30
31#include <SDL3/SDL_stdinc.h>
32#include <SDL3/SDL_error.h>
33
34#include <SDL3/SDL_begin_code.h>
35/* Set up for C function definitions, even when using C++ */
36#ifdef __cplusplus
37/* *INDENT-OFF* */
38extern "C" {
39/* *INDENT-ON* */
40#endif
41
42/**
43 * A struct to provide locale data.
44 *
45 * Locale data is split into a spoken language, like English, and an optional
46 * country, like Canada. The language will be in ISO-639 format (so English
47 * would be "en"), and the country, if not NULL, will be an ISO-3166 country
48 * code (so Canada would be "CA").
49 *
50 * \since This function is available since SDL 3.0.0.
51 *
52 * \sa SDL_GetPreferredLocales
53 */
54typedef struct SDL_Locale
55{
56 const char *language; /**< A language name, like "en" for English. */
57 const char *country; /**< A country, like "US" for America. Can be NULL. */
59
60/**
61 * Report the user's preferred locale.
62 *
63 * This returns an array of SDL_Locale structs, the final item zeroed out.
64 * When the caller is done with this array, it should call SDL_free() on the
65 * returned value; all the memory involved is allocated in a single block, so
66 * a single SDL_free() will suffice.
67 *
68 * Returned language strings are in the format xx, where 'xx' is an ISO-639
69 * language specifier (such as "en" for English, "de" for German, etc).
70 * Country strings are in the format YY, where "YY" is an ISO-3166 country
71 * code (such as "US" for the United States, "CA" for Canada, etc). Country
72 * might be NULL if there's no specific guidance on them (so you might get {
73 * "en", "US" } for American English, but { "en", NULL } means "English
74 * language, generically"). Language strings are never NULL, except to
75 * terminate the array.
76 *
77 * Please note that not all of these strings are 2 characters; some are three
78 * or more.
79 *
80 * The returned list of locales are in the order of the user's preference. For
81 * example, a German citizen that is fluent in US English and knows enough
82 * Japanese to navigate around Tokyo might have a list like: { "de", "en_US",
83 * "jp", NULL }. Someone from England might prefer British English (where
84 * "color" is spelled "colour", etc), but will settle for anything like it: {
85 * "en_GB", "en", NULL }.
86 *
87 * This function returns NULL on error, including when the platform does not
88 * supply this information at all.
89 *
90 * This might be a "slow" call that has to query the operating system. It's
91 * best to ask for this once and save the results. However, this list can
92 * change, usually because the user has changed a system preference outside of
93 * your program; SDL will send an SDL_EVENT_LOCALE_CHANGED event in this case,
94 * if possible, and you can call this function again to get an updated copy of
95 * preferred locales.
96 *
97 * \returns array of locales, terminated with a locale with a NULL language
98 * field. Will return NULL on error; call SDL_GetError() for more
99 * information.
100 *
101 * \since This function is available since SDL 3.0.0.
102 */
103extern DECLSPEC SDL_Locale * SDLCALL SDL_GetPreferredLocales(void);
104
105/* Ends C function definitions when using C++ */
106#ifdef __cplusplus
107/* *INDENT-OFF* */
108}
109/* *INDENT-ON* */
110#endif
111#include <SDL3/SDL_close_code.h>
112
113#endif /* SDL_locale_h */
SDL_Locale * SDL_GetPreferredLocales(void)
const char * country
Definition SDL_locale.h:57
const char * language
Definition SDL_locale.h:56