Subversion Repositories SvarDOS

Rev

Rev 1277 | Rev 1279 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
597 mateuszvis 1
/* This file is part of the svarlang project and is published under the terms
2
 * of the MIT license.
3
 *
1247 mateusz.vi 4
 * Copyright (C) 2021-2023 Mateusz Viste
597 mateuszvis 5
 *
6
 * Permission is hereby granted, free of charge, to any person obtaining a
7
 * copy of this software and associated documentation files (the "Software"),
8
 * to deal in the Software without restriction, including without limitation
9
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
10
 * and/or sell copies of the Software, and to permit persons to whom the
11
 * Software is furnished to do so, subject to the following conditions:
12
 *
13
 * The above copyright notice and this permission notice shall be included in
14
 * all copies or substantial portions of the Software.
15
 *
16
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
22
 * DEALINGS IN THE SOFTWARE.
23
 */
24
 
25
#ifndef SVARLANG_H
26
#define SVARLANG_H
27
 
1247 mateusz.vi 28
/* library version */
1277 mateusz.vi 29
#define SVARLANGVER "20230709"
1247 mateusz.vi 30
 
31
/* returns a pointer to a string with the SvarLANG's library version,
32
 * independently of the SVARLANGVER string above. */
33
const char *svarlang_getver(void);
34
 
1277 mateusz.vi 35
/* loads lang translations from file fname.
814 mateusz.vi 36
 *
37
 * only the two first letters of the lang strings are meaningful and they are
38
 * case insensitive.
39
 *
1277 mateusz.vi 40
 * a typical call would be: svarlang_load("myprog.lng", "PL");
814 mateusz.vi 41
 *
42
 * this function returns 0 on success, non-zero otherwise. It is still possible
43
 * to call svarlang_strid() after a load failure, the previously loaded
44
 * language will be used then, or the default language if no loading has been
45
 * done yet. */
1277 mateusz.vi 46
int svarlang_load(const char *fname, const char *lang);
597 mateuszvis 47
 
1278 mateusz.vi 48
/* tries loading lang strings from a file located in the executable's
49
 * directory that is named like the executable but with an *.LNG extension */
50
int svarlang_autoload_exepath(const char *lang);
1247 mateusz.vi 51
 
1277 mateusz.vi 52
/* this relies on getenv() to pull LANG and NLSPATH variables and looks
53
 * for a translation file named "%NLSPATH%\progname.lng".
814 mateusz.vi 54
 * this call should be used only by "CORE" SvarDOS programs. */
1277 mateusz.vi 55
int svarlang_autoload_nlspath(const char *progname);
56
 
599 mateuszvis 57
/* Returns a pointer to the string "id". Does not require svalang_load() to be
58
 * executed, but then it will only return the reference language strings.
59
 * a string id is the concatenation of the CATS-style identifiers, for example
623 mateuszvis 60
 * string 1,0 becomes 0x0100, string 2.10 is 0x020A, etc.
61
 * It NEVER returns NULL, if id not found then an empty string is returned */
597 mateuszvis 62
const char *svarlang_strid(unsigned short id);
63
 
1247 mateusz.vi 64
 
599 mateuszvis 65
/* a convenience definition to fetch strings by their CATS-style pairs instead
66
 * of the 16-bit id. */
597 mateuszvis 67
#define svarlang_str(x, y) svarlang_strid((x << 8) | y)
68
 
1247 mateusz.vi 69
 
597 mateuszvis 70
#endif