FLTK 1.3.3

- Main Page
- Related Pages
- Modules
- Classes
- Files

- File List
- File Members

fl_utf8.h
Go to the documentation of this file.
1 /* "$Id: fl_utf8.h 10259 2014-08-28 09:34:07Z ianmacarthur $"
2 *
3 * Author: Jean-Marc Lienher ( http://oksid.ch )
4 * Copyright 2000-2010 by O'ksi'D.
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 * http://www.fltk.org/COPYING.php
11 *
12 * Please report all bugs and problems on the following page:
13 *
14 * http://www.fltk.org/str.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
27 #ifndef _HAVE_FL_UTF8_HDR_
28 #define _HAVE_FL_UTF8_HDR_
29
30 #include "Fl_Export.H"
31 #include "fl_types.h"
32
33 #include <stdio.h>
34 #include <string.h>
35 #include <stdlib.h>
36
37 #ifdef WIN32
38 # include <sys/types.h>
39 # include <sys/stat.h>
40 # include <locale.h>
41 # include <ctype.h>
42 # define xchar wchar_t
43 # if !defined(FL_DLL) && !defined(__CYGWIN__)
44 # undef strdup
45 # define strdup _strdup
46 # undef putenv
47 # define putenv _putenv
48 # undef stricmp
49 # define stricmp _stricmp
50 # undef strnicmp
51 # define strnicmp _strnicmp
52 # undef chdir
53 # define chdir _chdir
54 # endif
55 #elif defined(__APPLE__)
56 # include <wchar.h>
57 # include <sys/stat.h>
58 # define xchar wchar_t
59 #else /* X11 */
60 # include <sys/types.h>
61 # include <sys/stat.h>
62 # include <X11/Xlocale.h>
63 # include <X11/Xlib.h>
64 # include <locale.h>
65 # define xchar unsigned short
66 #endif
67
68 # ifdef __cplusplus
69 extern "C" {
70 # endif
71
76 /* F2: comes from FLTK2 */
77 /* OD: comes from OksiD */
78
84 FL_EXPORT int fl_utf8bytes(unsigned ucs);
85
86 /* OD: returns the byte length of the first UTF-8 char sequence (returns -1 if not valid) */
87 FL_EXPORT int fl_utf8len(char c);
88
89 /* OD: returns the byte length of the first UTF-8 char sequence (returns +1 if not valid) */
90 FL_EXPORT int fl_utf8len1(char c);
91
92 /* OD: returns the number of Unicode chars in the UTF-8 string */
93 FL_EXPORT int fl_utf_nb_char(const unsigned char *buf, int len);
94
95 /* F2: Convert the next UTF8 char-sequence into a Unicode value (and say how many bytes were used) */
96 FL_EXPORT unsigned fl_utf8decode(const char* p, const char* end, int* len);
97
98 /* F2: Encode a Unicode value into a UTF8 sequence, return the number of bytes used */
99 FL_EXPORT int fl_utf8encode(unsigned ucs, char* buf);
100
101 /* F2: Move forward to the next valid UTF8 sequence start betwen start and end */
102 FL_EXPORT const char* fl_utf8fwd(const char* p, const char* start, const char* end);
103
104 /* F2: Move backward to the previous valid UTF8 sequence start */
105 FL_EXPORT const char* fl_utf8back(const char* p, const char* start, const char* end);
106
107 /* XX: Convert a single 32-bit Unicode value into UTF16 */
108 FL_EXPORT unsigned fl_ucs_to_Utf16(const unsigned ucs, unsigned short *dst, const unsigned dstlen);
109
110 /* F2: Convert a UTF8 string into UTF16 */
111 FL_EXPORT unsigned fl_utf8toUtf16(const char* src, unsigned srclen, unsigned short* dst, unsigned dstlen);
112
113 /* F2: Convert a UTF8 string into a wide character string - makes UTF16 on win32, "UCS4" elsewhere */
114 FL_EXPORT unsigned fl_utf8towc(const char *src, unsigned srclen, wchar_t *dst, unsigned dstlen);
115
116 /* F2: Convert a wide character string to UTF8 - takes in UTF16 on win32, "UCS4" elsewhere */
117 FL_EXPORT unsigned fl_utf8fromwc(char *dst, unsigned dstlen, const wchar_t *src, unsigned srclen);
118
119 /* F2: Convert a UTF8 string into ASCII, eliding untranslatable glyphs */
120 FL_EXPORT unsigned fl_utf8toa (const char *src, unsigned srclen, char *dst, unsigned dstlen);
121 /* OD: convert UTF-8 string to latin1 */
122 /* FL_EXPORT int fl_utf2latin1(const unsigned char *src, int srclen, char *dst); */
123
124 /* F2: Convert 8859-1 string to UTF8 */
125 FL_EXPORT unsigned fl_utf8froma (char *dst, unsigned dstlen, const char *src, unsigned srclen);
126 /* OD: convert latin1 str to UTF-8 */
127 /* FL_EXPORT int fl_latin12utf(const unsigned char *src, int srclen, char *dst); */
128
129 /* F2: Returns true if the current O/S locale is UTF8 */
130 FL_EXPORT int fl_utf8locale();
131
132 /* F2: Examine the first len characters of src, to determine if the input text is UTF8 or not
133 * NOTE: The value returned is not simply boolean - it contains information about the probable
134 * type of the src text. */
135 FL_EXPORT int fl_utf8test(const char *src, unsigned len);
136
137 /* XX: return width of "raw" ucs character in columns.
138 * for internal use only */
139 FL_EXPORT int fl_wcwidth_(unsigned int ucs);
140
141 /* XX: return width of utf-8 character string in columns.
142 * NOTE: this may also do C1 control character (0x80 to 0x9f) to CP1252 mapping,
143 * depending on original build options */
144 FL_EXPORT int fl_wcwidth(const char *src);
145
146 /* OD: Return true if the character is non-spacing */
147 FL_EXPORT unsigned int fl_nonspacing(unsigned int ucs);
148
149 /* F2: Convert UTF8 to a local multi-byte encoding - mainly for win32? */
150 FL_EXPORT unsigned fl_utf8to_mb(const char *src, unsigned srclen, char *dst, unsigned dstlen);
151 /* OD: Convert UTF8 to a local multi-byte encoding */
152 FL_EXPORT char* fl_utf2mbcs(const char *src);
153
154 /* F2: Convert a local multi-byte encoding to UTF8 - mainly for win32? */
155 FL_EXPORT unsigned fl_utf8from_mb(char *dst, unsigned dstlen, const char *src, unsigned srclen);
156 /* OD: Convert a local multi-byte encoding to UTF8 */
157 /* FL_EXPORT char* fl_mbcs2utf(const char *src); */
158
159 /*****************************************************************************/
160 #ifdef WIN32
161 /* OD: Attempt to convert the UTF8 string to the current locale */
162 FL_EXPORT char *fl_utf8_to_locale(const char *s, int len, unsigned int codepage);
163
164 /* OD: Attempt to convert a string in the current locale to UTF8 */
165 FL_EXPORT char *fl_locale_to_utf8(const char *s, int len, unsigned int codepage);
166 #endif
167
168 /*****************************************************************************
169 * The following functions are intended to provide portable, UTF8 aware
170 * versions of standard functions
171 */
172
173 /* OD: UTF8 aware strncasecmp - converts to lower case Unicode and tests */
174 FL_EXPORT int fl_utf_strncasecmp(const char *s1, const char *s2, int n);
175
176 /* OD: UTF8 aware strcasecmp - converts to Unicode and tests */
177 FL_EXPORT int fl_utf_strcasecmp(const char *s1, const char *s2);
178
179 /* OD: return the Unicode lower case value of ucs */
180 FL_EXPORT int fl_tolower(unsigned int ucs);
181
182 /* OD: return the Unicode upper case value of ucs */
183 FL_EXPORT int fl_toupper(unsigned int ucs);
184
185 /* OD: converts the UTF8 string to the lower case equivalent */
186 FL_EXPORT int fl_utf_tolower(const unsigned char *str, int len, char *buf);
187
188 /* OD: converts the UTF8 string to the upper case equivalent */
189 FL_EXPORT int fl_utf_toupper(const unsigned char *str, int len, char *buf);
190
191 /* OD: Portable UTF8 aware chmod wrapper */
192 FL_EXPORT int fl_chmod(const char* f, int mode);
193
194 /* OD: Portable UTF8 aware access wrapper */
195 FL_EXPORT int fl_access(const char* f, int mode);
196
197 /* OD: Portable UTF8 aware stat wrapper */
198 FL_EXPORT int fl_stat( const char *path, struct stat *buffer );
199
200 /* OD: Portable UTF8 aware getcwd wrapper */
201 FL_EXPORT char* fl_getcwd( char *buf, int maxlen);
202
203 /* OD: Portable UTF8 aware fopen wrapper */
204 FL_EXPORT FILE *fl_fopen(const char *f, const char *mode);
205
206 /* OD: Portable UTF8 aware system wrapper */
207 FL_EXPORT int fl_system(const char* f);
208
209 /* OD: Portable UTF8 aware execvp wrapper */
210 FL_EXPORT int fl_execvp(const char *file, char *const *argv);
211
212 /* OD: Portable UTF8 aware open wrapper */
213 FL_EXPORT int fl_open(const char* f, int o, ...);
214
215 /* OD: Portable UTF8 aware unlink wrapper */
216 FL_EXPORT int fl_unlink(const char *f);
217
218 /* OD: Portable UTF8 aware rmdir wrapper */
219 FL_EXPORT int fl_rmdir(const char *f);
220
221 /* OD: Portable UTF8 aware getenv wrapper */
222 FL_EXPORT char* fl_getenv(const char *name);
223
224 /* OD: Portable UTF8 aware execvp wrapper */
225 FL_EXPORT int fl_mkdir(const char* f, int mode);
226
227 /* OD: Portable UTF8 aware rename wrapper */
228 FL_EXPORT int fl_rename(const char* f, const char *t);
229
230
231 /* OD: Given a full pathname, this will create the directory path needed to hold the file named */
232 FL_EXPORT void fl_make_path_for_file( const char *path );
233
234 /* OD: recursively create a path in the file system */
235 FL_EXPORT char fl_make_path( const char *path );
236
237
240 /*****************************************************************************/
241
242 #ifdef __cplusplus
243 }
244 #endif /* __cplusplus */
245
246
247 #endif /* _HAVE_FL_UTF8_HDR_ */
248
249 /*
250 * End of "$Id: fl_utf8.h 10259 2014-08-28 09:34:07Z ianmacarthur $".
251 */
fl_utf8test
FL_EXPORT int fl_utf8test(const char *src, unsigned len)
Definition: fl_utf.c:919
fl_wcwidth
FL_EXPORT int fl_wcwidth(const char *src)
extended wrapper around fl_wcwidth_(unsigned int ucs) function.
Definition: fl_utf.c:974
fl_utf8len
FL_EXPORT int fl_utf8len(char c)
return the byte length of the UTF-8 sequence with first byte c, or -1 if c is not valid...
Definition: fl_utf8.cxx:114
fl_utf8to_mb
FL_EXPORT unsigned fl_utf8to_mb(const char *src, unsigned srclen, char *dst, unsigned dstlen)
Definition: fl_utf.c:778
fl_utf8toUtf16
FL_EXPORT unsigned fl_utf8toUtf16(const char *src, unsigned srclen, unsigned short *dst, unsigned dstlen)
Definition: fl_utf.c:426
fl_fopen
FL_EXPORT 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:562
fl_nonspacing
FL_EXPORT unsigned int fl_nonspacing(unsigned int ucs)
returns true if the character is non-spacing.
Definition: fl_utf8.cxx:361
fl_utf8fromwc
FL_EXPORT unsigned fl_utf8fromwc(char *dst, unsigned dstlen, const wchar_t *src, unsigned srclen)
Definition: fl_utf.c:611
fl_utf_tolower
FL_EXPORT int fl_utf_tolower(const unsigned char *str, int len, char *buf)
converts the str string to the lower case equivalent into buf.
Definition: fl_utf8.cxx:246
fl_utf8locale
FL_EXPORT int fl_utf8locale()
Definition: fl_utf.c:745
fl_wcwidth_
FL_EXPORT int fl_wcwidth_(unsigned int ucs)
wrapper to adapt Markus Kuhn's implementation of wcwidth() for FLTK
Definition: fl_utf.c:957
fl_utf8towc
FL_EXPORT 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_utf.c:494
fl_utf_nb_char
FL_EXPORT 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:169
fl_open
FL_EXPORT int fl_open(const char *f, int o,...)
Cross-platform function to open files with a UTF-8 encoded name.
Definition: fl_utf8.cxx:530
fl_utf8toa
FL_EXPORT unsigned fl_utf8toa(const char *src, unsigned srclen, char *dst, unsigned dstlen)
Definition: fl_utf.c:550
fl_utf_strncasecmp
FL_EXPORT 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:194
fl_utf8bytes
FL_EXPORT int fl_utf8bytes(unsigned ucs)
Return the number of bytes needed to encode the given UCS4 character in UTF8.
Definition: fl_utf.c:273
fl_utf8len1
FL_EXPORT int fl_utf8len1(char c)
Return the byte length of the UTF-8 sequence with first byte c, or 1 if c is not valid.
Definition: fl_utf8.cxx:143
fl_toupper
FL_EXPORT int fl_toupper(unsigned int ucs)
return the Unicode upper case value of ucs
Definition: fl_utf8.cxx:237
fl_utf8froma
FL_EXPORT unsigned fl_utf8froma(char *dst, unsigned dstlen, const char *src, unsigned srclen)
Definition: fl_utf.c:699
fl_utf8back
FL_EXPORT const char * fl_utf8back(const char *p, const char *start, const char *end)
Definition: fl_utf.c:254
fl_utf8fwd
FL_EXPORT const char * fl_utf8fwd(const char *p, const char *start, const char *end)
Definition: fl_utf.c:223
fl_utf8decode
FL_EXPORT unsigned fl_utf8decode(const char *p, const char *end, int *len)
Definition: fl_utf.c:131
fl_utf_strcasecmp
FL_EXPORT int fl_utf_strcasecmp(const char *s1, const char *s2)
UTF-8 aware strcasecmp - converts to Unicode and tests.
Definition: fl_utf8.cxx:221
fl_utf2mbcs
FL_EXPORT char * fl_utf2mbcs(const char *src)
converts UTF8 to a local multi-byte character string.
Definition: fl_utf8.cxx:438
fl_types.h
This file contains simple "C"-style type definitions.
fl_utf8encode
FL_EXPORT int fl_utf8encode(unsigned ucs, char *buf)
Definition: fl_utf.c:303
fl_tolower
FL_EXPORT int fl_tolower(unsigned int ucs)
return the Unicode lower case value of ucs
Definition: fl_utf8.cxx:229
fl_ucs_to_Utf16
FL_EXPORT unsigned fl_ucs_to_Utf16(const unsigned ucs, unsigned short *dst, const unsigned dstlen)
Definition: fl_utf.c:357
fl_utf8from_mb
FL_EXPORT unsigned fl_utf8from_mb(char *dst, unsigned dstlen, const char *src, unsigned srclen)
Definition: fl_utf.c:852
fl_utf_toupper
FL_EXPORT int fl_utf_toupper(const unsigned char *str, int len, char *buf)
converts the str string to the upper case equivalent into buf.
Definition: fl_utf8.cxx:277
- © 1998-2014 by Bill Spitzak and others.