ed/Odin
1
0
Fork 0
mirror of https://github.com/Ed94/Odin.git synced 2026-08-06 15:48:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

Spell check i18n.odin.

Browse Source
This commit is contained in:
Jeroen van Rijn
2024-06-19 11:41:58 +02:00
parent e0de52efa1
commit 322b7f1f2f
1 changed files with 38 additions and 74 deletions
Download Patch File Download Diff File Expand all files Collapse all files
core/text/i18n/i18n.odin
+34 -70
View File
@@ -10,23 +10,13 @@ package i18n
*/ */
import "core:strings" import "core:strings"
/* // Currently active catalog.
TODO:
- Support for more translation catalog file formats.
*/
/*
Currently active catalog.
*/
ACTIVE: ^Translation ACTIVE: ^Translation
// Allow between 1 and 255 plural forms. Default: 10. // Allow between 1 and 255 plural forms. Default: 10.
MAX_PLURALS :: min(max(#config(ODIN_i18N_MAX_PLURAL_FORMS, 10), 1), 255) MAX_PLURALS :: min(max(#config(ODIN_i18N_MAX_PLURAL_FORMS, 10), 1), 255)
/* // The main data structure. This can be generated from various different file formats, as long as we have a parser for them.
The main data structure. This can be generated from various different file formats, as long as we have a parser for them.
*/
Section :: map[string][]string Section :: map[string][]string
Translation :: struct { Translation :: struct {
@@ -37,34 +27,24 @@ Translation :: struct {
} }
Error :: enum { Error :: enum {
/* // General return values.
General return values.
*/
None = 0, None = 0,
Empty_Translation_Catalog, Empty_Translation_Catalog,
Duplicate_Key, Duplicate_Key,
/* // Couldn't find, open or read file.
Couldn't find, open or read file.
*/
File_Error, File_Error,
/* // File too short.
File too short.
*/
Premature_EOF, Premature_EOF,
/* // GNU Gettext *.MO file errors.
GNU Gettext *.MO file errors.
*/
MO_File_Invalid_Signature, MO_File_Invalid_Signature,
MO_File_Unsupported_Version, MO_File_Unsupported_Version,
MO_File_Invalid, MO_File_Invalid,
MO_File_Incorrect_Plural_Count, MO_File_Incorrect_Plural_Count,
/* // Qt Linguist *.TS file errors.
Qt Linguist *.TS file errors.
*/
TS_File_Parse_Error, TS_File_Parse_Error,
TS_File_Expected_Context, TS_File_Expected_Context,
TS_File_Expected_Context_Name, TS_File_Expected_Context_Name,
@@ -84,23 +64,19 @@ DEFAULT_PARSE_OPTIONS :: Parse_Options{
merge_sections = false, merge_sections = false,
} }
// *****************
// get() PROC GROUP
// *****************
/* /*
Returns the first translation string for the passed `key`. Returns the first translation string for the passed `key`.
It is also aliases with `get( )`. It is also aliased with `get()`.
Two ways to use it: Two ways to use it:
- get(key), which defaults to the `i18n.ACTIVE`` catalogue, or - get(key), which defaults to the `i18n.ACTIVE` catalogue, or
- get(key, catalog) to grab text from a specific loaded catalogue. - get(key, catalog) to grab text from a specific loaded catalogue
Inputs: Inputs:
- key: the string to translate. - key: the string to translate
- catalog: the catalogue to use for the translation (defaults to i18n.ACTIVE) - catalog: the catalogue to use for the translation (defaults to i18n.ACTIVE)
Returns: the translated string or the original `key` if no translation was found. Returns: the translated string, or the original `key` if no translation was found.
*/ */
get_single_section :: proc(key: string, catalog: ^Translation = ACTIVE) -> (value: string) { get_single_section :: proc(key: string, catalog: ^Translation = ACTIVE) -> (value: string) {
return get_by_slot(key, 0, catalog) return get_by_slot(key, 0, catalog)
@@ -111,15 +87,15 @@ get_single_section :: proc(key: string, catalog: ^Translation = ACTIVE) -> (valu
It is also aliases with `get()`. It is also aliases with `get()`.
Two ways to use it: Two ways to use it:
- get(section, key), which defaults to the `i18n.ACTIVE`` catalogue, or - get(section, key), which defaults to the `i18n.ACTIVE` catalogue, or
- get(section, key, catalog) to grab text from a specific loaded catalogue. - get(section, key, catalog) to grab text from a specific loaded catalogue
Inputs: Inputs:
- section: the catalogue section (sometime also called 'context') from which to lookup the translation - section: the catalogue section (sometimes also called 'context') in which to look up the translation
- key: the string to translate. - key: the string to translate
- catalog: the catalogue to use for the translation (defaults to i18n.ACTIVE) - catalog: the catalogue to use for the translation (defaults to i18n.ACTIVE)
Returns: the translated string or the original `key` if no translation was found. Returns: the translated string, or the original `key` if no translation was found.
*/ */
get_by_section :: proc(section, key: string, catalog: ^Translation = ACTIVE) -> (value: string) { get_by_section :: proc(section, key: string, catalog: ^Translation = ACTIVE) -> (value: string) {
return get_by_slot(section, key, 0, catalog) return get_by_slot(section, key, 0, catalog)
@@ -127,26 +103,22 @@ get_by_section :: proc(section, key: string, catalog: ^Translation = ACTIVE) ->
get :: proc{get_single_section, get_by_section} get :: proc{get_single_section, get_by_section}
// *****************
// get_n() PROC GROUP
// *****************
/* /*
Returns the translation string for the passed `key` in a specific plural form (if present in the catalogue). Returns the translation string for the passed `key` in a specific plural form (if present in the catalogue).
It is also aliases with `get_n( )`. It is also aliased with `get_n()`.
Two ways to use it: Two ways to use it:
- get_n(key, quantity), which returns the appropriate plural from the active catalogue, or - get_n(key, quantity), which returns the appropriate plural from the active catalogue, or
- get_n(key, quantity, catalog) to grab text from a specific loaded catalogue. - get_n(key, quantity, catalog) to grab text from a specific loaded catalogue
Inputs: Inputs:
- key: the string to translate. - key: the string to translate
- qantity: the quantity of item to be used to select the correct plural form. - quantity: the quantity of item to be used to select the correct plural form
- catalog: the catalogue to use for the translation (defaults to i18n.ACTIVE) - catalog: the catalogue to use for the translation (defaults to i18n.ACTIVE)
Returns: the translated string or the original `key` if no translation was found. Returns: the translated string, or the original `key` if no translation was found.
*/ */
get_single_section_w_plural :: proc(key: string, quantity: int, catalog: ^Translation = ACTIVE) -> (value: string) { get_single_section_with_quantity :: proc(key: string, quantity: int, catalog: ^Translation = ACTIVE) -> (value: string) {
/* /*
A lot of languages use singular for 1 item and plural for 0 or more than 1 items. This is our default pluralize rule. A lot of languages use singular for 1 item and plural for 0 or more than 1 items. This is our default pluralize rule.
*/ */
@@ -165,17 +137,17 @@ get_single_section_w_plural :: proc(key: string, quantity: int, catalog: ^Transl
Two ways to use it: Two ways to use it:
- get(section, key, quantity), which returns the appropriate plural from the active catalogue, or - get(section, key, quantity), which returns the appropriate plural from the active catalogue, or
- get(section, key, quantity, catalog) to grab text from a specific loaded catalogue. - get(section, key, quantity, catalog) to grab text from a specific loaded catalogue
Inputs: Inputs:
- section: the catalogue section (sometime also called 'context') from which to lookup the translation - section: the catalogue section (sometime also called 'context') from which to lookup the translation
- key: the string to translate. - key: the string to translate
- qantity: the quantity of item to be used to select the correct plural form. - qantity: the quantity of item to be used to select the correct plural form
- catalog: the catalogue to use for the translation (defaults to i18n.ACTIVE) - catalog: the catalogue to use for the translation (defaults to i18n.ACTIVE)
Returns: the translated string or the original `key` if no translation was found. Returns: the translated string, or the original `key` if no translation was found
*/ */
get_by_section_w_plural :: proc(section, key: string, quantity: int, catalog: ^Translation = ACTIVE) -> (value: string) { get_by_section_with_quantity :: proc(section, key: string, quantity: int, catalog: ^Translation = ACTIVE) -> (value: string) {
/* /*
A lot of languages use singular for 1 item and plural for 0 or more than 1 items. This is our default pluralize rule. A lot of languages use singular for 1 item and plural for 0 or more than 1 items. This is our default pluralize rule.
*/ */
@@ -186,11 +158,7 @@ get_by_section_w_plural :: proc(section, key: string, quantity: int, catalog: ^T
} }
return get_by_slot(section, key, slot, catalog) return get_by_slot(section, key, slot, catalog)
} }
get_n :: proc{get_single_section_w_plural, get_by_section_w_plural} get_n :: proc{get_single_section_with_quantity, get_by_section_with_quantity}
// *****************
// get_by_slot() PROC GROUP
// *****************
/* /*
Two ways to use: Two ways to use:
@@ -202,10 +170,10 @@ get_n :: proc{get_single_section_w_plural, get_by_section_w_plural}
Inputs: Inputs:
- key: the string to translate. - key: the string to translate.
- qantity: the translation slot to choose (slots refer to plural forms specific for each language and their meaning changes from catalogue to catalogue). - slot: the translation slot to choose (slots refer to plural forms specific for each language and their meaning changes from catalogue to catalogue).
- catalog: the catalogue to use for the translation (defaults to i18n.ACTIVE) - catalog: the catalogue to use for the translation (defaults to i18n.ACTIVE)
Returns: the translated string or the original `key` if no translation was found. Returns: the translated string, or the original `key` if no translation was found.
*/ */
get_by_slot_single_section :: proc(key: string, slot: int, catalog: ^Translation = ACTIVE) -> (value: string) { get_by_slot_single_section :: proc(key: string, slot: int, catalog: ^Translation = ACTIVE) -> (value: string) {
return get_by_slot_by_section("", key, slot, catalog) return get_by_slot_by_section("", key, slot, catalog)
@@ -221,22 +189,18 @@ get_by_slot_single_section :: proc(key: string, slot: int, catalog: ^Translation
Inputs: Inputs:
- section: the catalogue section (sometime also called 'context') from which to lookup the translation - section: the catalogue section (sometime also called 'context') from which to lookup the translation
- key: the string to translate. - key: the string to translate.
- qantity: the translation slot to choose (slots refer to plural forms specific for each language and their meaning changes from catalogue to catalogue). - slot: the translation slot to choose (slots refer to plural forms specific for each language and their meaning changes from catalogue to catalogue).
- catalog: the catalogue to use for the translation (defaults to i18n.ACTIVE) - catalog: the catalogue to use for the translation (defaults to i18n.ACTIVE)
Returns: the translated string or the original `key` if no translation was found. Returns: the translated string or the original `key` if no translation was found.
*/ */
get_by_slot_by_section :: proc(section, key: string, slot: int, catalog: ^Translation = ACTIVE) -> (value: string) { get_by_slot_by_section :: proc(section, key: string, slot: int, catalog: ^Translation = ACTIVE) -> (value: string) {
if catalog == nil || section not_in catalog.k_v { if catalog == nil || section not_in catalog.k_v {
/* // Return the key if the catalog catalog hasn't been initialized yet, or the section is not present.
Return the key if the catalog catalog hasn't been initialized yet, or the section is not present.
*/
return key return key
} }
/* // Return the translation from the requested slot if this key is known, else return the key.
Return the translation from the requested slot if this key is known, else return the key.
*/
if translations, ok := catalog.k_v[section][key]; ok { if translations, ok := catalog.k_v[section][key]; ok {
plural := min(max(0, slot), len(catalog.k_v[section][key]) - 1) plural := min(max(0, slot), len(catalog.k_v[section][key]) - 1)
return translations[plural] return translations[plural]