FLTK 1.4.4: fl_utf8.h Source File

FLTK 1.4.4

Loading...
Searching...
No Matches
fl_utf8.h
Go to the documentation of this file.
1/*
2 * Author: Jean-Marc Lienher ( http://oksid.ch )
3 * Copyright 2000-2010 by O'ksi'D.
4 * Copyright 2016-2021 by Bill Spitzak and others.
5 *
6 * This library is free software. Distribution and use rights are outlined in
7 * the file "COPYING" which should have been included with this file. If this
8 * file is missing or damaged, see the license at:
9 *
10 * https://www.fltk.org/COPYING.php
11 *
12 * Please see the following page on how to report bugs and issues:
13 *
14 * https://www.fltk.org/bugs.php
15 */
16
17/* Merged in some functionality from the fltk-2 version. IMM.
18 * The following code is an attempt to merge the functions incorporated in FLTK2
19 * with the functions provided in OksiD's fltk-1.1.6-utf8 port
20 */
21
26
27#ifndef _HAVE_FL_UTF8_HDR_
28#define _HAVE_FL_UTF8_HDR_
29
30#include "Fl_Export.H"
31#include "fl_types.h"
32#include <stdio.h> // FILE *fl_fopen()
33#include <sys/stat.h> // struct stat
34
35#ifdef __cplusplus
36extern "C" {
37#endif
38
42
43/* F2: comes from FLTK2 */
44/* OD: comes from OksiD */
45
51FL_EXPORT int fl_utf8bytes(unsigned ucs);
52
53/* OD: returns the byte length of the first UTF-8 char sequence (returns -1 if not valid) */
54FL_EXPORT int fl_utf8len(char c);
55
56/* OD: returns the byte length of the first UTF-8 char sequence (returns +1 if not valid) */
57FL_EXPORT int fl_utf8len1(char c);
58
59/* OD: returns the byte length of a UTF-8 text */
60FL_EXPORT int fl_utf8strlen(const char *text, int len);
61
62/* OD: returns the number of Unicode chars in the UTF-8 string */
63FL_EXPORT int fl_utf_nb_char(const unsigned char *buf, int len);
64
65/* F2: Convert the next UTF-8 char-sequence into a Unicode value (and say how many bytes were used) */
66FL_EXPORT unsigned fl_utf8decode(const char* p, const char* end, int* len);
67
68/* F2: Encode a Unicode value into a UTF-8 sequence, return the number of bytes used */
69FL_EXPORT int fl_utf8encode(unsigned ucs, char* buf);
70
71/* F2: Move forward to the next valid UTF-8 sequence start betwen start and end */
72FL_EXPORT const char* fl_utf8fwd(const char* p, const char* start, const char* end);
73
74/* F2: Move backward to the previous valid UTF-8 sequence start */
75FL_EXPORT const char* fl_utf8back(const char* p, const char* start, const char* end);
76
77/* XX: Convert a single 32-bit Unicode value into UTF16 */
78FL_EXPORT unsigned fl_ucs_to_Utf16(const unsigned ucs, unsigned short *dst, const unsigned dstlen);
79
80/* F2: Convert a UTF-8 string into UTF16 */
81FL_EXPORT unsigned fl_utf8toUtf16(const char* src, unsigned srclen, unsigned short* dst, unsigned dstlen);
82
83/* F2: Convert a UTF-8 string into a wide character string - makes UTF16 on win32, "UCS4" elsewhere */
84FL_EXPORT unsigned fl_utf8towc(const char *src, unsigned srclen, wchar_t *dst, unsigned dstlen);
85
86/* F2: Convert a wide character string to UTF-8 - takes in UTF16 on win32, "UCS4" elsewhere */
87FL_EXPORT unsigned fl_utf8fromwc(char *dst, unsigned dstlen, const wchar_t *src, unsigned srclen);
88
89/* F2: Convert a UTF-8 string into ASCII, eliding untranslatable glyphs */
90FL_EXPORT unsigned fl_utf8toa (const char *src, unsigned srclen, char *dst, unsigned dstlen);
91
92/* F2: Convert 8859-1 string to UTF-8 */
93FL_EXPORT unsigned fl_utf8froma (char *dst, unsigned dstlen, const char *src, unsigned srclen);
94
95/* F2: Returns true if the current O/S locale is UTF-8 */
96FL_EXPORT int fl_utf8locale(void);
97
98/* F2: Examine the first len characters of src, to determine if the input text is UTF-8 or not
99 * NOTE: The value returned is not simply boolean - it contains information about the probable
100 * type of the src text. */
101FL_EXPORT int fl_utf8test(const char *src, unsigned len);
102
103/* XX: return width of "raw" ucs character in columns.
104 * for internal use only */
105FL_EXPORT int fl_wcwidth_(unsigned int ucs);
106
107/* XX: return width of UTF-8 character string in columns.
108 * NOTE: this may also do C1 control character (0x80 to 0x9f) to CP1252 mapping,
109 * depending on original build options */
110FL_EXPORT int fl_wcwidth(const char *src);
111
112/* OD: Return true if the character is non-spacing */
113FL_EXPORT unsigned int fl_nonspacing(unsigned int ucs);
114
115/* F2: Convert UTF-8 to a local multi-byte encoding - mainly for win32? */
116FL_EXPORT unsigned fl_utf8to_mb(const char *src, unsigned srclen, char *dst, unsigned dstlen);
117/* OD: Convert UTF-8 to a local multi-byte encoding */
118FL_EXPORT char* fl_utf2mbcs(const char *src);
119
120/* F2: Convert a local multi-byte encoding to UTF-8 - mainly for win32? */
121FL_EXPORT unsigned fl_utf8from_mb(char *dst, unsigned dstlen, const char *src, unsigned srclen);
122
123/*****************************************************************************/
124#ifdef _WIN32
125/* these two Windows-only functions are kept for API compatibility */
126/* OD: Attempt to convert the UTF-8 string to the current locale */
127FL_EXPORT char *fl_utf8_to_locale(const char *s, int len, unsigned int codepage);
128
129/* OD: Attempt to convert a string in the current locale to UTF-8 */
130FL_EXPORT char *fl_locale_to_utf8(const char *s, int len, unsigned int codepage);
131#endif /* _WIN32 */
132
133/*****************************************************************************
134 * The following functions are intended to provide portable, UTF-8 aware
135 * versions of standard functions
136 */
137
138/* OD: UTF-8 aware strncasecmp - converts to lower case Unicode and tests */
139FL_EXPORT int fl_utf_strncasecmp(const char *s1, const char *s2, int n);
140
141/* OD: UTF-8 aware strcasecmp - converts to Unicode and tests */
142FL_EXPORT int fl_utf_strcasecmp(const char *s1, const char *s2);
143
144/* OD: return the Unicode lower case value of ucs */
145FL_EXPORT int fl_tolower(unsigned int ucs);
146
147/* OD: return the Unicode upper case value of ucs */
148FL_EXPORT int fl_toupper(unsigned int ucs);
149
150/* OD: converts the UTF-8 string to the lower case equivalent */
151FL_EXPORT int fl_utf_tolower(const unsigned char *str, int len, char *buf);
152
153/* OD: converts the UTF-8 string to the upper case equivalent */
154FL_EXPORT int fl_utf_toupper(const unsigned char *str, int len, char *buf);
155
156/* OD: Portable UTF-8 aware chmod wrapper */
157FL_EXPORT int fl_chmod(const char* f, int mode);
158
159/* OD: Portable UTF-8 aware access wrapper */
160FL_EXPORT int fl_access(const char* f, int mode);
161
162/* OD: Portable UTF-8 aware stat wrapper */
163FL_EXPORT int fl_stat(const char *path, struct stat *buffer);
164
165/* OD: Portable UTF-8 aware getcwd wrapper */
166FL_EXPORT char *fl_getcwd(char *buf, int len);
167
168/* Portable UTF-8 aware chdir wrapper */
169FL_EXPORT int fl_chdir(const char *path);
170
171/* OD: Portable UTF-8 aware fopen wrapper */
172FL_EXPORT FILE *fl_fopen(const char *f, const char *mode);
173
174/* OD: Portable UTF-8 aware system wrapper */
175FL_EXPORT int fl_system(const char* f);
176
177/* OD: Portable UTF-8 aware execvp wrapper */
178FL_EXPORT int fl_execvp(const char *file, char *const *argv);
179
180/* OD: Portable UTF-8 aware open wrapper */
181FL_EXPORT int fl_open(const char *fname, int oflags, ...);
182
183FL_EXPORT int fl_open_ext(const char *fname, int binary, int oflags, ...);
184
185/* Portable wrapper around unix-style close() function */
186FL_EXPORT int fl_close_fd(int fd);
187
188/* OD: Portable UTF-8 aware unlink wrapper */
189FL_EXPORT int fl_unlink(const char *fname);
190
191/* OD: Portable UTF-8 aware rmdir wrapper */
192FL_EXPORT int fl_rmdir(const char *f);
193
194/* OD: Portable UTF-8 aware getenv wrapper */
195FL_EXPORT char* fl_getenv(const char *name);
196
197/* Portable UTF-8 aware putenv wrapper */
198FL_EXPORT int fl_putenv(const char *var);
199
200/* OD: Portable UTF-8 aware mkdir wrapper */
201FL_EXPORT int fl_mkdir(const char* f, int mode);
202
203/* OD: Portable UTF-8 aware rename wrapper */
204FL_EXPORT int fl_rename(const char* f, const char *t);
205
206
207/* OD: Given a full pathname, this will create the directory path needed to hold the file named */
208FL_EXPORT void fl_make_path_for_file( const char *path );
209
210/* OD: recursively create a path in the file system */
211FL_EXPORT char fl_make_path( const char *path );
212
213
215
216/*****************************************************************************/
217
218#ifdef __cplusplus
219}
220#endif /* __cplusplus */
221
222
223#endif /* _HAVE_FL_UTF8_HDR_ */
fl_types.h
This file contains simple "C"-style type definitions.
fl_getenv
char * fl_getenv(const char *name)
Cross-platform function to get environment variables with a UTF-8 encoded name or value.
Definition fl_utf8.cxx:333
fl_open
int fl_open(const char *fname, int oflags,...)
Cross-platform function to open files with a UTF-8 encoded name.
Definition fl_utf8.cxx:381
fl_utf8toa
unsigned fl_utf8toa(const char *src, unsigned srclen, char *dst, unsigned dstlen)
Convert a UTF-8 sequence into an array of 1-byte characters.
Definition fl_utf8.cxx:1078
fl_chmod
int fl_chmod(const char *f, int mode)
Cross-platform function to set a files mode() with a UTF-8 encoded name or value.
Definition fl_utf8.cxx:467
fl_utf8strlen
int fl_utf8strlen(const char *text, int len)
Return the length in bytes of a UTF-8 string.
Definition fl_utf8.cxx:128
fl_utf_strncasecmp
int fl_utf_strncasecmp(const char *s1, const char *s2, int n)
UTF-8 aware strncasecmp - converts to lower case Unicode and tests.
Definition fl_utf8.cxx:173
fl_utf8bytes
int fl_utf8bytes(unsigned ucs)
Return the number of bytes needed to encode the given UCS4 character in UTF-8.
Definition fl_utf8.cxx:867
fl_utf8len
int fl_utf8len(char c)
Returns the byte length of the UTF-8 sequence with first byte c, or -1 if c is not valid.
Definition fl_utf8.cxx:69
fl_wcwidth
int fl_wcwidth(const char *src)
extended wrapper around fl_wcwidth_(unsigned int ucs) function.
Definition fl_utf8.cxx:1239
fl_utf_toupper
int fl_utf_toupper(const unsigned char *str, int len, char *buf)
Converts the string str to its upper case equivalent into buf.
Definition fl_utf8.cxx:255
fl_utf8fromwc
unsigned fl_utf8fromwc(char *dst, unsigned dstlen, const wchar_t *src, unsigned srclen)
Turn "wide characters" as returned by some system calls (especially on Windows) into UTF-8.
Definition fl_utf8.cxx:1311
fl_chdir
int fl_chdir(const char *path)
Cross-platform function to change the current working directory, given as a UTF-8 encoded string.
Definition fl_utf8.cxx:530
fl_system
int fl_system(const char *f)
Cross-platform function to run a system command with a UTF-8 encoded string.
Definition fl_utf8.cxx:447
fl_stat
int fl_stat(const char *path, struct stat *buffer)
Cross-platform function to stat() a file using a UTF-8 encoded name or value.
Definition fl_utf8.cxx:501
fl_utf8toUtf16
unsigned fl_utf8toUtf16(const char *src, unsigned srclen, unsigned short *dst, unsigned dstlen)
Convert a UTF-8 sequence into an array of 16-bit characters.
Definition fl_utf8.cxx:1020
fl_close_fd
int fl_close_fd(int fd)
Cross-platform function to close a file descriptor.
Definition fl_utf8.cxx:394
fl_rename
int fl_rename(const char *f, const char *t)
Cross-platform function to rename a filesystem object using UTF-8 encoded names.
Definition fl_utf8.cxx:606
fl_utf8to_mb
unsigned fl_utf8to_mb(const char *src, unsigned srclen, char *dst, unsigned dstlen)
Convert the UTF-8 used by FLTK to the locale-specific encoding used for filenames (and sometimes used...
Definition fl_utf8.cxx:1350
fl_tolower
int fl_tolower(unsigned int ucs)
Returns the Unicode lower case value of ucs.
Definition fl_utf8.cxx:209
fl_putenv
int fl_putenv(const char *var)
Cross-platform function to write environment variables with a UTF-8 encoded name or value.
Definition fl_utf8.cxx:365
fl_nonspacing
unsigned int fl_nonspacing(unsigned int ucs)
Returns true if the Unicode character ucs is non-spacing.
Definition fl_utf8.cxx:293
fl_mkdir
int fl_mkdir(const char *f, int mode)
Cross-platform function to create a directory with a UTF-8 encoded name.
Definition fl_utf8.cxx:579
fl_access
int fl_access(const char *f, int mode)
Cross-platform function to test a files access() with a UTF-8 encoded name or value.
Definition fl_utf8.cxx:487
fl_wcwidth_
int fl_wcwidth_(unsigned int ucs)
Wrapper to adapt Markus Kuhn's implementation of wcwidth() for FLTK.
Definition fl_utf8.cxx:1222
fl_utf8fwd
const char * fl_utf8fwd(const char *p, const char *start, const char *end)
Move p forward until it points to the start of a UTF-8 character.
Definition fl_utf8.cxx:816
fl_getcwd
char * fl_getcwd(char *buf, int len)
Cross-platform function to get the current working directory as a UTF-8 encoded value.
Definition fl_utf8.cxx:550
fl_fopen
FILE * fl_fopen(const char *f, const char *mode)
Cross-platform function to open files with a UTF-8 encoded name.
Definition fl_utf8.cxx:432
fl_utf2mbcs
char * fl_utf2mbcs(const char *src)
Converts UTF-8 string s to a local multi-byte character string.
Definition fl_utf8.cxx:302
fl_make_path
char fl_make_path(const char *path)
Cross-platform function to recursively create a path in the file system.
Definition fl_utf8.cxx:618
fl_unlink
int fl_unlink(const char *fname)
Cross-platform function to unlink() (that is, delete) a file using a UTF-8 encoded filename.
Definition fl_utf8.cxx:566
fl_open_ext
int fl_open_ext(const char *fname, int binary, int oflags,...)
Cross-platform function to open files with a UTF-8 encoded name.
Definition fl_utf8.cxx:413
fl_toupper
int fl_toupper(unsigned int ucs)
Returns the Unicode upper case value of ucs.
Definition fl_utf8.cxx:217
fl_utf8towc
unsigned fl_utf8towc(const char *src, unsigned srclen, wchar_t *dst, unsigned dstlen)
Converts a UTF-8 string into a wide character string.
Definition fl_utf8.cxx:1277
fl_utf_tolower
int fl_utf_tolower(const unsigned char *str, int len, char *buf)
Converts the string str to its lower case equivalent into buf.
Definition fl_utf8.cxx:226
fl_utf8locale
int fl_utf8locale(void)
Return true if the "locale" seems to indicate that UTF-8 encoding is used.
Definition fl_utf8.cxx:1329
fl_rmdir
int fl_rmdir(const char *f)
Cross-platform function to remove a directory with a UTF-8 encoded name.
Definition fl_utf8.cxx:592
fl_utf8back
const char * fl_utf8back(const char *p, const char *start, const char *end)
Move p backward until it points to the start of a UTF-8 character.
Definition fl_utf8.cxx:847
fl_utf_strcasecmp
int fl_utf_strcasecmp(const char *s1, const char *s2)
UTF-8 aware strcasecmp - converts to Unicode and tests.
Definition fl_utf8.cxx:201
fl_utf8decode
unsigned fl_utf8decode(const char *p, const char *end, int *len)
Decode a single UTF-8 encoded character starting at p.
Definition fl_utf8.cxx:724
fl_ucs_to_Utf16
unsigned fl_ucs_to_Utf16(const unsigned ucs, unsigned short *dst, const unsigned dstlen)
Convert a single 32-bit Unicode codepoint into an array of 16-bit characters.
Definition fl_utf8.cxx:951
fl_utf8from_mb
unsigned fl_utf8from_mb(char *dst, unsigned dstlen, const char *src, unsigned srclen)
Convert a filename from the locale-specific multibyte encoding used by Windows to UTF-8 as used by FL...
Definition fl_utf8.cxx:1382
fl_utf8encode
int fl_utf8encode(unsigned ucs, char *buf)
Write the UTF-8 encoding of ucs into buf and return the number of bytes written.
Definition fl_utf8.cxx:897
fl_utf8froma
unsigned fl_utf8froma(char *dst, unsigned dstlen, const char *src, unsigned srclen)
Convert an ISO-8859-1 (ie normal c-string) byte stream to UTF-8.
Definition fl_utf8.cxx:1133
fl_make_path_for_file
void fl_make_path_for_file(const char *path)
Cross-platform function to create a path for the file in the file system.
Definition fl_utf8.cxx:638
fl_utf8len1
int fl_utf8len1(char c)
Returns the byte length of the UTF-8 sequence with first byte c, or 1 if c is not valid.
Definition fl_utf8.cxx:99
fl_utf8test
int fl_utf8test(const char *src, unsigned len)
Examines the first srclen bytes in src and returns a verdict on whether it is UTF-8 or not.
Definition fl_utf8.cxx:1184
fl_utf_nb_char
int fl_utf_nb_char(const unsigned char *buf, int len)
Returns the number of Unicode chars in the UTF-8 string.
Definition fl_utf8.cxx:147