locale.h

Go to the documentation of this file.

/*
 * This file is part of the Ultibo project, https://ultibo.org/
 *
 * The MIT License (MIT)
 *
 * Copyright (c) 2026 Garry Wood <garry@softoz.com.au>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
#ifndef _ULTIBO_LOCALE_H
#define _ULTIBO_LOCALE_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include "ultibo/globaltypes.h"
#include "ultibo/globalconst.h"
#include "ultibo/sysutils.h"


#define CP_ACP  0 
#define CP_OEMCP    1 
#define CP_MACCP    2 
#define CP_THREAD_ACP   3 
#define CP_SYMBOL   42 
#define CP_UTF16    1200 
#define CP_UNICODE  1200 
#define CP_UTF16_BE 1201 
#define CP_UTF7 65000 
#define CP_UTF8 65001 
//#define CP_ASCII  20127 {US-ASCII}
//#define CP_NONE   0xFFFF {FPC RawByteString}

#define CP_OEM_437  437 
#define CP_OEM_720  720 
#define CP_OEM_737  737 
#define CP_OEM_775  775 
#define CP_OEM_850  850 
#define CP_OEM_852  852 
#define CP_OEM_857  857 
#define CP_OEM_862  862 
#define CP_OEM_866  866 
#define CP_OEM_874  874 
#define CP_OEM_1258 1258 
 
#define CP_ANSI_1250    1250 
#define CP_ANSI_1251    1251 
#define CP_ANSI_1252    1252 
#define CP_ANSI_1253    1253 
#define CP_ANSI_1254    1254 
#define CP_ANSI_1255    1255 
#define CP_ANSI_1256    1256 
#define CP_ANSI_1257    1257 
#define CP_ANSI_1258    1258 
#define CP_ANSI_874 874 

#define LOCALE_SYSTEM_DEFAULT   0x800
#define LOCALE_USER_DEFAULT 0x400

#define MAX_LEADBYTES   12 
#define MAX_DEFAULTCHAR 2 

#define MB_PRECOMPOSED  0x00000001 
#define MB_COMPOSITE    0x00000002 
#define MB_USEGLYPHCHARS    0x00000004 
#define MB_ERR_INVALID_CHARS    0x00000008 
 
#define WC_COMPOSITECHECK   0x00000200 
#define WC_DISCARDNS    0x00000010 
#define WC_SEPCHARS 0x00000020 
#define WC_DEFAULTCHAR  0x00000040 
 
#define WC_NO_BEST_FIT_CHARS    0x00000400 

#define CT_CTYPE1   0x00000001 
#define CT_CTYPE2   0x00000002 
#define CT_CTYPE3   0x00000004 

#define C1_UPPER    0x0001 
#define C1_LOWER    0x0002 
#define C1_DIGIT    0x0004 
#define C1_SPACE    0x0008 
#define C1_PUNCT    0x0010 
#define C1_CNTRL    0x0020 
#define C1_BLANK    0x0040 
#define C1_XDIGIT   0x0080 
#define C1_ALPHA    0x0100 
#define C1_DEFINED  0x0200 

#define C2_LEFTTORIGHT  0x0001 
#define C2_RIGHTTOLEFT  0x0002 
 
#define C2_EUROPENUMBER 0x0003 
#define C2_EUROPESEPARATOR  0x0004 
#define C2_EUROPETERMINATOR 0x0005 
#define C2_ARABICNUMBER 0x0006 
#define C2_COMMONSEPARATOR  0x0007 
 
#define C2_BLOCKSEPARATOR   0x0008 
#define C2_SEGMENTSEPARATOR 0x0009 
#define C2_WHITESPACE   0x000A 
#define C2_OTHERNEUTRAL 0x000B 
 
#define C2_NOTAPPLICABLE    0x0000 

#define C3_NONSPACING   0x0001 
#define C3_DIACRITIC    0x0002 
#define C3_VOWELMARK    0x0004 
#define C3_SYMBOL   0x0008 
 
#define C3_KATAKANA 0x0010 
#define C3_HIRAGANA 0x0020 
#define C3_HALFWIDTH    0x0040 
#define C3_FULLWIDTH    0x0080 
#define C3_IDEOGRAPH    0x0100 
#define C3_KASHIDA  0x0200 
#define C3_LEXICAL  0x0400 
 
#define C3_ALPHA    0x8000 
 
#define C3_NOTAPPLICABLE    0x0000 

#define NORM_IGNORECASE 0x00000001 
#define NORM_IGNORENONSPACE 0x00000002 
#define NORM_IGNORESYMBOLS  0x00000004 
 
#define NORM_IGNOREKANATYPE 0x00010000 
#define NORM_IGNOREWIDTH    0x00020000 

#define MAP_FOLDCZONE   0x00000010 
#define MAP_PRECOMPOSED 0x00000020 
#define MAP_COMPOSITE   0x00000040 
#define MAP_FOLDDIGITS  0x00000080 
 
#define MAP_EXPAND_LIGATURES    0x00002000 

#define LCMAP_LOWERCASE 0x00000100 
#define LCMAP_UPPERCASE 0x00000200 
#define LCMAP_SORTKEY   0x00000400 
#define LCMAP_BYTEREV   0x00000800 
 
#define LCMAP_HIRAGANA  0x00100000 
#define LCMAP_KATAKANA  0x00200000 
#define LCMAP_HALFWIDTH 0x00400000 
#define LCMAP_FULLWIDTH 0x00800000 
 
#define LCMAP_LINGUISTIC_CASING 0x01000000 
 
#define LCMAP_SIMPLIFIED_CHINESE    0x02000000 
#define LCMAP_TRADITIONAL_CHINESE   0x04000000 

#define LGRPID_INSTALLED    0x00000001 
#define LGRPID_SUPPORTED    0x00000002 

#define LCID_INSTALLED  0x00000001 
#define LCID_SUPPORTED  0x00000002 
#define LCID_ALTERNATE_SORTS    0x00000004 

#define CP_INSTALLED    0x00000001 
#define CP_SUPPORTED    0x00000002 

//
//
//
//
//
#define SORT_STRINGSORT 0x00001000 

#define CSTR_LESS_THAN  1 
#define CSTR_EQUAL  2 
#define CSTR_GREATER_THAN   3 

#define CTRY_DEFAULT    0
 
#define CTRY_ALBANIA    355 
#define CTRY_ALGERIA    213 
#define CTRY_ARGENTINA  54 
#define CTRY_ARMENIA    374 
#define CTRY_AUSTRALIA  61 
#define CTRY_AUSTRIA    43 
#define CTRY_AZERBAIJAN 994 
#define CTRY_BAHRAIN    973 
#define CTRY_BELARUS    375 
#define CTRY_BELGIUM    32 
#define CTRY_BELIZE 501 
#define CTRY_BOLIVIA    591 
#define CTRY_BRAZIL 55 
#define CTRY_BRUNEI_DARUSSALAM  673 
#define CTRY_BULGARIA   359 
#define CTRY_CANADA 2 
#define CTRY_CARIBBEAN  1 
#define CTRY_CHILE  56 
#define CTRY_COLOMBIA   57 
#define CTRY_COSTA_RICA 506 
#define CTRY_CROATIA    385 
#define CTRY_CZECH  420 
#define CTRY_DENMARK    45 
#define CTRY_DOMINICAN_REPUBLIC 1 
#define CTRY_ECUADOR    593 
#define CTRY_EGYPT  20 
#define CTRY_EL_SALVADOR    503 
#define CTRY_ESTONIA    372 
#define CTRY_FAEROE_ISLANDS 298 
#define CTRY_FINLAND    358 
#define CTRY_FRANCE 33 
#define CTRY_GEORGIA    995 
#define CTRY_GERMANY    49 
#define CTRY_GREECE 30 
#define CTRY_GUATEMALA  502 
#define CTRY_HONDURAS   504 
#define CTRY_HONG_KONG  852 
#define CTRY_HUNGARY    36 
#define CTRY_ICELAND    354 
#define CTRY_INDIA  91 
#define CTRY_INDONESIA  62 
#define CTRY_IRAN   981 
#define CTRY_IRAQ   964 
#define CTRY_IRELAND    353 
#define CTRY_ISRAEL 972 
#define CTRY_ITALY  39 
#define CTRY_JAMAICA    1 
#define CTRY_JAPAN  81 
#define CTRY_JORDAN 962 
#define CTRY_KAZAKSTAN  7 
#define CTRY_KENYA  254 
#define CTRY_KUWAIT 965 
#define CTRY_KYRGYZSTAN 996 
#define CTRY_LATVIA 371 
#define CTRY_LEBANON    961 
#define CTRY_LIBYA  218 
#define CTRY_LIECHTENSTEIN  41 
#define CTRY_LITHUANIA  370 
#define CTRY_LUXEMBOURG 352 
#define CTRY_MACAU  853 
#define CTRY_MACEDONIA  389 
#define CTRY_MALAYSIA   60 
#define CTRY_MALDIVES   960 
#define CTRY_MEXICO 52 
#define CTRY_MONACO 33 
#define CTRY_MONGOLIA   976 
#define CTRY_MOROCCO    212 
#define CTRY_NETHERLANDS    31 
#define CTRY_NEW_ZEALAND    64 
#define CTRY_NICARAGUA  505 
#define CTRY_NORWAY 47 
#define CTRY_OMAN   968 
#define CTRY_PAKISTAN   92 
#define CTRY_PANAMA 507 
#define CTRY_PARAGUAY   595 
#define CTRY_PERU   51 
#define CTRY_PHILIPPINES    63 
#define CTRY_POLAND 48 
#define CTRY_PORTUGAL   351 
#define CTRY_PRCHINA    86 
#define CTRY_PUERTO_RICO    1 
#define CTRY_QATAR  974 
#define CTRY_ROMANIA    40 
#define CTRY_RUSSIA 7 
#define CTRY_SAUDI_ARABIA   966 
#define CTRY_SERBIA 381 
#define CTRY_SINGAPORE  65 
#define CTRY_SLOVAK 421 
#define CTRY_SLOVENIA   386 
#define CTRY_SOUTH_AFRICA   27 
#define CTRY_SOUTH_KOREA    82 
#define CTRY_SPAIN  34 
#define CTRY_SWEDEN 46 
#define CTRY_SWITZERLAND    41 
#define CTRY_SYRIA  963 
#define CTRY_TAIWAN 886 
#define CTRY_TATARSTAN  7 
#define CTRY_THAILAND   66 
#define CTRY_TRINIDAD_Y_TOBAGO  1 
#define CTRY_TUNISIA    216 
#define CTRY_TURKEY 90 
#define CTRY_UAE    971 
#define CTRY_UKRAINE    380 
#define CTRY_UNITED_KINGDOM 44 
#define CTRY_UNITED_STATES  1 
#define CTRY_URUGUAY    598 
#define CTRY_UZBEKISTAN 7 
#define CTRY_VENEZUELA  58 
#define CTRY_VIET_NAM   84 
#define CTRY_YEMEN  967 
#define CTRY_ZIMBABWE   263 








#define LANG_NEUTRAL    0x00
#define LANG_ENGLISH    0x09

#define SUBLANG_NEUTRAL 0x00 
#define SUBLANG_DEFAULT 0x01 
#define SUBLANG_SYS_DEFAULT 0x02 
#define SUBLANG_ENGLISH_US  0x01 


typedef uint32_t LCID;
typedef uint16_t LANGID;

typedef uint32_t LGRPID;
typedef uint32_t LCTYPE;
typedef uint32_t CALTYPE;
typedef uint32_t CALID;

typedef struct _CPINFO CPINFO;
struct _CPINFO
{
    unsigned int maxcharsize; 
    uint8_t defaultchar[MAX_DEFAULTCHAR]; 
    uint8_t leadbyte[MAX_LEADBYTES]; 
};
 
typedef CPINFO _cpinfo;
 
typedef struct _CPINFOEXA CPINFOEXA;
struct _CPINFOEXA
{
    unsigned int maxcharsize; 
    uint8_t defaultchar[MAX_DEFAULTCHAR]; 
    uint8_t leadbyte[MAX_LEADBYTES]; 
    WCHAR unicodedefaultchar; 
    unsigned int codepage; 
    char codepagename[MAX_PATH]; 
};
 
typedef CPINFOEXA _cpinfoexA;
 
typedef struct _CPINFOEXW CPINFOEXW;
struct _CPINFOEXW
{
    unsigned int maxcharsize; 
    uint8_t defaultchar[MAX_DEFAULTCHAR]; 
    uint8_t leadbyte[MAX_LEADBYTES]; 
    WCHAR unicodedefaultchar; 
    unsigned int codepage; 
    WCHAR codepagename[MAX_PATH]; 
};
 
typedef CPINFOEXW _cpinfoexW;
 
typedef CPINFOEXA CPINFOEX;

typedef struct _CODE_TABLE CODE_TABLE;
struct _CODE_TABLE
{
    unsigned int maxcharsize; 
    uint8_t defaultchar[MAX_DEFAULTCHAR]; 
    uint8_t leadbyte[MAX_LEADBYTES]; 
    uint16_t values[0xFF];
};

typedef struct _TRANS_TABLE TRANS_TABLE;
struct _TRANS_TABLE
{
    uint16_t transid; 
    uint16_t values[0xFF]; 
};

typedef struct _LOWER_TABLE LOWER_TABLE;
struct _LOWER_TABLE
{
    uint16_t lowerid; 
    uint16_t values[0xFF]; 
};

typedef struct _UPPER_TABLE UPPER_TABLE;
struct _UPPER_TABLE
{
    uint16_t upperid; 
    uint16_t values[0xFF]; 
};

typedef struct _UNICODE_TABLE UNICODE_TABLE;
struct _UNICODE_TABLE
{
    uint16_t values[0xFFFF]; 
};

typedef struct _LEAD_BYTES LEAD_BYTES;
struct _LEAD_BYTES
{
    CODE_TABLE* tables[0xFF]; //To Do //Test
};


typedef struct _CODE_PAGE CODE_PAGE;
struct _CODE_PAGE
{
    uint16_t pageid; 
    HANDLE handle; 
    CODE_TABLE *codetable; 
    LEAD_BYTES *leadbytes; 
    TRANS_TABLE *transtable; 
    LOWER_TABLE *lowertable; 
    UPPER_TABLE *uppertable; 
    UNICODE_TABLE *unicodetable; 
    CODE_PAGE *prevpage; 
    CODE_PAGE *nextpage; 
};


BOOL STDCALL IsValidCodePage(unsigned int codepage);

unsigned int STDCALL GetACP(void);

unsigned int STDCALL GetOEMCP(void);

BOOL STDCALL SetACP(unsigned int codepage);

BOOL STDCALL SetOEMCP(unsigned int codepage);

unsigned int STDCALL GetConsoleCP(void);

BOOL STDCALL SetConsoleCP(unsigned int wcodepageid);

unsigned int STDCALL GetConsoleOutputCP(void);

BOOL STDCALL SetConsoleOutputCP(unsigned int wcodepageid);

BOOL STDCALL GetCPInfo(unsigned int codepage, CPINFO *lpcpinfo);

BOOL STDCALL GetCPInfoEx(unsigned int codepage, uint32_t dwflags, CPINFOEXA *lpcpinfoex);

BOOL STDCALL GetCPInfoExA(unsigned int codepage, uint32_t dwflags, CPINFOEXA *lpcpinfoex);

BOOL STDCALL GetCPInfoExW(unsigned int codepage, uint32_t dwflags, CPINFOEXW *lpcpinfoex);

BOOL STDCALL IsValidLocale(LCID locale, uint32_t dwflags);

LCID STDCALL GetSystemDefaultLCID(void);

LCID STDCALL GetUserDefaultLCID(void);

BOOL STDCALL SetSystemDefaultLCID(LCID locale);

LANGID STDCALL GetSystemDefaultLangID(void);

LANGID STDCALL GetUserDefaultLangID(void);


uint16_t STDCALL map_page(unsigned int codepage);

CODE_PAGE * STDCALL get_page(uint16_t pageid);

BOOL STDCALL check_page(CODE_PAGE *page);

BOOL STDCALL link_page(CODE_PAGE *page);

BOOL STDCALL unlink_page(CODE_PAGE *page);

BOOL STDCALL load_page(uint16_t pageid, CODE_TABLE *table, LOWER_TABLE *lower, UPPER_TABLE *upper);

BOOL STDCALL unload_page(uint16_t pageid, CODE_PAGE *page);
 
BOOL STDCALL default_trans(uint16_t pageid, uint16_t transid);
BOOL STDCALL install_trans(uint16_t pageid, TRANS_TABLE *table);
 
#ifdef __cplusplus
}
#endif
 
#endif // _ULTIBO_LOCALE_H