-- (c) Copyright - See License.txt

--****

-- == Locale Routines

--

-- <>

namespace locale

include std/dll.e

include std/machine.e

include std/error.e

include std/datetime.e as dt

include std/text.e

include std/io.e

include std/map.e

include std/localeconv.e as lcc

include std/lcid.e as lcid

include std/convert.e

include std/filesys.e

include std/mathcons.e

include std/search.e

------------------------------------------------------------------------------------------

--

-- Local Constants

--

------------------------------------------------------------------------------------------

------------------------------------------------------------------------------------------

--

-- Local Variables

--

------------------------------------------------------------------------------------------

--****

-- === Message translation functions

--

--**

-- Set the language path.

--

-- Parameters:

-- # ##pp## : an object, either an actual path or an atom.

--

-- Comments:

-- When the language path is not set, and it is unset by default, [[:set]]() does not load any language file.

--

-- See Also:

-- [[:set]]

--**

-- Get the language path.

--

-- Returns:

-- An **object**, the current language path.

--

-- See Also:

-- [[:get_lang_path]]

end function

--**

-- Load a language file.

--

-- Parameters:

-- # ##filename## : a sequence, the name of the file to load. If no file

-- extension is supplied, then ".lng" is used.

--

-- Returns:

-- A language **map**, if successful. This is to be used when calling [[:translate]]().

--

-- If the load fails it returns a zero.

--

-- Comments:

-- The language file must be made of lines which are either comments, empty lines

-- or translations. Note that leading whitespace is ignored on all lines except

-- continuation lines.

--

-- * **Comments** are lines that begin with a ~# character and extend to the end of the line.

-- * **Empty Lines** are ignored.

-- * **Translations** have two forms ...

--

-- {{{

-- keyword translation_text

-- }}}

-- In which the 'keyword' is a word that must not have any spaces in it.

-- {{{

-- keyphrase = translation_text

-- }}}

-- In which the 'keyphrase' is anything up to the first '=' symbol.

--

-- It is possible to have the translation text span multiple lines. You do this by

-- having '&' as the last character of the line. These are placed by newline characters

-- when loading.

--

-- Example:

--{{{

--# Example translation file

--#

--

--

--hello Hola

--world Mundo

--greeting %s, %s!

--

--help text = &

--This is an example of some &

--translation text that spans &

--multiple lines.

--

-- # End of example PO #2

--}}}

--

-- See Also:

-- [[:translate]]

object lines

sequence line, key, msg

integer delim

integer cont -- continuation

map:map keylang

map:map altlang

else

end if

else

end if

end if

else

end if

else

end if

end if

end if

-- Ignore lines with missing translation text

end if

end if

else

end if

end if

end function

--**

-- Sets the default language (translation) map

--

-- Parameters:

-- # ##langmap## : A value returned by [[:lang_load]](), or zero to remove any default map.

--

-- Example:

--

-- set_def_lang( lang_load("appmsgs") )

--

end if

--**

-- Gets the default language (translation) map

--

-- Parameters:

-- none.

--

-- Returns:

-- An **object**, a language map, or zero if there is no default language map yet.

--

-- Example:

--

-- object langmap = get_def_lang()

--

end function

--**

-- Translates a word, using the current language file.

--

-- Parameters:

-- # ##word## : a sequence, the word to translate.

-- # ##langmap## : Either a value returned by [[:lang_load]]() or zero to use the default language map

-- # ##defval## : a object. The value to return if the word cannot be translated.

-- Default is "". If ##defval## is ##PINF## then the ##word## is returned

-- if it can't be translated.

-- # ##mode## : an integer. If zero (the default) it uses ##word## as the keyword and returns

-- the translation text. If not zero it uses ##word##

-- as the translation and returns the keyword.

--

-- Returns:

-- A **sequence**, the value associated with ##word##, or ##defval## if there

-- is no association.

--

-- Example 1:

--

-- sequence newword

-- newword = translate(msgtext)

-- if length(msgtext) = 0 then

-- error_message(msgtext)

-- else

-- error_message(newword)

-- end if

--

--

-- Example 2:

--

-- error_message(translate(msgtext, , PINF))

--

--

-- See Also:

-- [[:set]], [[:lang_load]]

end if

-- No default language map loaded yet.

else

end if

end if

-- Not a valid language map passed.

end if

else

end if

end function

--**

-- Returns a formatted string with automatic translation performed on the parameters.

--

-- Parameters:

-- # ##fmt## : A sequence. Contains the formatting string. see [[:printf]]() for details.

-- # ##data## : A sequence. Contains the data that goes into the formatted result. see [[:printf]] for details.

-- # ##langmap## : An object. Either 0 (the default) to use the default language maps, or

-- the result returned from [[:lang_load]]() to specify a particular

-- language map.

--

-- Returns:

-- A **sequence**, the formatted result.

--

-- Comments:

-- This works very much like the [[:sprintf]]() function. The difference is that the ##fmt## sequence

-- and sequences contained in the ##data## parameter are [[:translate | translated ]] before

-- passing them to [[:sprintf]]. If an item has no translation, it remains unchanged.

--

-- Further more, after the translation pass, if the result text begins with {{{"__"}}},

-- the {{{"__"}}} is removed.

-- This method can be used when you do not want an item to be translated.

--

-- Examples:

--

-- -- Assuming a language has been loaded and

-- -- "greeting" translates as '%s %s, %s'

-- -- "hello" translates as "G'day"

-- -- "how are you today" translates as "How's the family?"

-- sequence UserName = "Bob"

-- sequence result = trsprintf( "greeting", {"hello", "__" & UserName, "how are you today"})

-- --> "G'day Bob, How's the family?"

--

--

end if

end if

end if

end function

------------------------------------------------------------------------------------------

--

-- Library Open/Checking

--

------------------------------------------------------------------------------------------

constant

lib = open_dll("MSVCRT.DLL"),

lib2 = open_dll("KERNEL32.DLL"),

f_strfmon = define_c_func(lib2, "GetCurrencyFormatA", {I, I, P, P, P, I}, I),

f_strfnum = define_c_func(lib2, "GetNumberFormatA", {I, I, P, P, P, I}, I),

f_setlocale = define_c_func(lib, "setlocale", {I, P}, P),

f_strftime = define_c_func(lib, "strftime", {P, I, P, P}, I),

LC_ALL = 0,

-- LC_COLLATE = 1,

-- LC_CTYPE = 2,

LC_MONETARY = 3,

LC_NUMERIC = 4,

-- LC_TIME = 5,

-- LC_MESSAGES = 6,

$

/* constant

FORMAT_SIZE = 6 * 4,

NUM_DIGITS = 0,

LEADING_ZERO = 4,

GROUPING = 8,

DECIMAL_SEP = 12,

THOUSANDS_SEP = 16,

NEGATIVE_ORDER = 20

*/

sequence current_locale = ""

elsifdef LINUX then

constant

-- LC_CTYPE = 0,

-- LC_TIME = 2,

-- LC_COLLATE = 3,

-- LC_MESSAGES = 5,

$

elsifdef FREEBSD or SUNOS then

constant

lib = open_dll("libc.so"),

f_strfmon = define_c_func(lib, "strfmon", {P, I, P, C_DOUBLE}, I),

f_strfnum = -1,

f_setlocale = define_c_func(lib, "setlocale", {I, P}, P),

f_strftime = define_c_func(lib, "strftime", {P, I, P, P}, I),

LC_ALL = 0,

-- LC_COLLATE = 1,

-- LC_CTYPE = 2,

LC_MONETARY = 3,

LC_NUMERIC = 4,

-- LC_TIME = 5,

-- LC_MESSAGES = 6,

$

elsifdef OSX then

constant

lib = open_dll("libc.dylib"),

f_strfmon = define_c_func(lib, "strfmon", {P, I, P, C_DOUBLE}, I),

f_strfnum = -1,

f_setlocale = define_c_func(lib, "setlocale", {I, P}, P),

f_strftime = define_c_func(lib, "strftime", {P, I, P, P}, I),

LC_ALL = 0,

-- LC_COLLATE = 1,

-- LC_CTYPE = 2,

LC_MONETARY = 3,

LC_NUMERIC = 4,

-- LC_TIME = 5,

-- LC_MESSAGES = 6,

$

elsedef

constant

lib = -1

lib2 = -1

f_strfmon = -1

f_strfnum = -1

f_setlocale = -1

f_strftime = -1

LC_ALL = -1,

-- LC_COLLATE = -1,

-- LC_CTYPE = -1,

LC_MONETARY = -1,

LC_NUMERIC = -1,

-- LC_TIME = -1,

-- LC_MESSAGES = -1,

$

end ifdef

--****

-- === Time/Number Translation

--**

-- Set the computer locale, and possibly load appropriate translation file.

--

-- Parameters:

-- # ##new_locale## : a sequence representing a new locale.

--

-- Returns:

-- An **integer**, either 0 on failure or 1 on success.

--

-- Comments:

-- Locale strings have the following format: xx_YY or xx_YY.xyz .

-- The xx part refers to a culture, or main language/script. For instance, "en" refers to

-- English, "de" refers to German, and so on. For some language, a script may be specified,

-- like in "mn_Cyrl_MN" (mongolian in cyrillic transcription).

--

-- The YY part refers to a subculture, or variant, of the main language. For instance, "fr_FR"

-- refers to metropolitan France, while "fr_BE" refers to the variant spoken in Wallonie, the

-- French speaking region of Belgium.

--

-- The optional .xyz part specifies an encoding, like .utf8 or .1252 . This is required in some cases.

atom lAddr_localename

atom ign

sequence nlocale

-- Note: Failure to update language map does not fail this function.

end if

if ign then

current_locale = new_locale

end if

end ifdef

end function

--**

-- Get current locale string

--

-- Returns:

-- A **sequence**, a locale string.

--

-- See Also:

-- [[:set]]

sequence r

atom p

end if

if equal(lcc:decanonical(r), lcc:decanonical(current_locale)) then

return current_locale

end if

end ifdef

end function

--**

-- Converts an amount of currency into a string representing that amount.

--

-- Parameters:

-- # ##amount## : an atom, the value to write out.

--

-- Returns:

-- A **sequence**, a string that writes out ##amount## of current currency.

--

-- Example 1:

--

-- -- Assuming an en_US locale

-- ? money(1020.5) -- returns"$1,020.50"

--

--

-- See Also:

-- [[:set]], [[:number]]

sequence result

integer size

atom pResult, pTmp

elsifdef WIN32 then

pResult = allocate(4 * 160)

pTmp = allocate_string(sprintf("%.8f", {amount}))

size = c_func(f_strfmon, {lcid:get_lcid(get()), 0, pTmp, NULL, pResult, 4 * 160})

end ifdef

else

end if

end function

--**

-- Converts a number into a string representing that number.

--

-- Parameters:

-- # ##num## : an atom, the value to write out.

--

-- Returns:

-- A **sequence**, a string that writes out ##num##.

--

-- Example 1:

--

-- -- Assuming an en_US locale

-- ? number(1020.5) -- returns "1,020.50"

--

--

-- See Also:

-- [[:set]], [[:money]]

sequence result

integer size

atom pResult, pTmp

else

end if

else

end if

elsifdef WIN32 then

atom lpFormat

if f_strfnum != -1 then

pResult = allocate(4 * 160)

if integer(num) then

pTmp = allocate_string(sprintf("%d", {num}))

-- lpFormat must not only be allocated but completely populated

-- with values from the current locale.

lpFormat = NULL

else

lpFormat = NULL

pTmp = allocate_string(sprintf("%.15f", {num}))

end if

size = c_func(f_strfnum, {lcid:get_lcid(get()), 0, pTmp, lpFormat, pResult, 4 * 160})

else

return text:format("[,,]", num)

end if

elsedef

return text:format("[,,]", num)

end ifdef

-- Assumption: All locales remove trailing zeros and decimal point from integers

end if

end if

end if

-- remove all trailing zeros and decimal point, but not any trailing symbols --

-- Step 1. Locate rightmost digit.

end if

-- Step 2. From rightmost digit, stop when we get to a non-zero

-- Step 3. Remove decimal point and all zeros, preserving any trailing symbols.

end if

end if

end if

end function

atom pDtm

end function

--**

-- Formats a date according to current locale.

--

-- Parameters:

-- # ##fmt## : A format string, as described in datetime:[[:format]]

-- # ##dtm## : the datetime to write out.

--

-- Returns:

-- A **sequence**, representing the formatted date.

--

-- Example 1:

--

-- ? datetime("Today is a %A",dt:now())

--

--

-- See Also:

-- datetime:[[:format]]

atom pFmt, pRes, pDtm

integer size

sequence res

else

end if

end function