Line data Source code
1 : /*-------------------------------------------------------------------------
2 : *
3 : * Multibyte character printing support for frontend code
4 : *
5 : *
6 : * Portions Copyright (c) 1996-2025, PostgreSQL Global Development Group
7 : * Portions Copyright (c) 1994, Regents of the University of California
8 : *
9 : * src/fe_utils/mbprint.c
10 : *
11 : *-------------------------------------------------------------------------
12 : */
13 : #include "postgres_fe.h"
14 :
15 : #include "fe_utils/mbprint.h"
16 :
17 : #include "libpq-fe.h"
18 :
19 :
20 : /*
21 : * To avoid version-skew problems, this file must not use declarations
22 : * from pg_wchar.h: the encoding IDs we are dealing with are determined
23 : * by the libpq.so we are linked with, and that might not match the
24 : * numbers we see at compile time. (If this file were inside libpq,
25 : * the problem would go away...)
26 : *
27 : * Hence, we have our own definition of pg_wchar, and we get the values
28 : * of any needed encoding IDs on-the-fly.
29 : */
30 :
31 : typedef unsigned int pg_wchar;
32 :
33 : static int
34 4952480 : pg_get_utf8_id(void)
35 : {
36 : static int utf8_id = -1;
37 :
38 4952480 : if (utf8_id < 0)
39 13430 : utf8_id = pg_char_to_encoding("utf8");
40 4952480 : return utf8_id;
41 : }
42 :
43 : #define PG_UTF8 pg_get_utf8_id()
44 :
45 :
46 : /*
47 : * Convert a UTF-8 character to a Unicode code point.
48 : * This is a one-character version of pg_utf2wchar_with_len.
49 : *
50 : * No error checks here, c must point to a long-enough string.
51 : */
52 : static pg_wchar
53 0 : utf8_to_unicode(const unsigned char *c)
54 : {
55 0 : if ((*c & 0x80) == 0)
56 0 : return (pg_wchar) c[0];
57 0 : else if ((*c & 0xe0) == 0xc0)
58 0 : return (pg_wchar) (((c[0] & 0x1f) << 6) |
59 0 : (c[1] & 0x3f));
60 0 : else if ((*c & 0xf0) == 0xe0)
61 0 : return (pg_wchar) (((c[0] & 0x0f) << 12) |
62 0 : ((c[1] & 0x3f) << 6) |
63 0 : (c[2] & 0x3f));
64 0 : else if ((*c & 0xf8) == 0xf0)
65 0 : return (pg_wchar) (((c[0] & 0x07) << 18) |
66 0 : ((c[1] & 0x3f) << 12) |
67 0 : ((c[2] & 0x3f) << 6) |
68 0 : (c[3] & 0x3f));
69 : else
70 : /* that is an invalid code on purpose */
71 0 : return 0xffffffff;
72 : }
73 :
74 :
75 : /*
76 : * Unicode 3.1 compliant validation : for each category, it checks the
77 : * combination of each byte to make sure it maps to a valid range. It also
78 : * returns -1 for the following UCS values: ucs > 0x10ffff ucs & 0xfffe =
79 : * 0xfffe 0xfdd0 < ucs < 0xfdef ucs & 0xdb00 = 0xd800 (surrogates)
80 : */
81 : static int
82 18956808 : utf_charcheck(const unsigned char *c)
83 : {
84 18956808 : if ((*c & 0x80) == 0)
85 18954472 : return 1;
86 2336 : else if ((*c & 0xe0) == 0xc0)
87 : {
88 : /* two-byte char */
89 2054 : if (((c[1] & 0xc0) == 0x80) && ((c[0] & 0x1f) > 0x01))
90 2054 : return 2;
91 0 : return -1;
92 : }
93 282 : else if ((*c & 0xf0) == 0xe0)
94 : {
95 : /* three-byte char */
96 258 : if (((c[1] & 0xc0) == 0x80) &&
97 258 : (((c[0] & 0x0f) != 0x00) || ((c[1] & 0x20) == 0x20)) &&
98 258 : ((c[2] & 0xc0) == 0x80))
99 : {
100 258 : int z = c[0] & 0x0f;
101 258 : int yx = ((c[1] & 0x3f) << 6) | (c[0] & 0x3f);
102 258 : int lx = yx & 0x7f;
103 :
104 : /* check 0xfffe/0xffff, 0xfdd0..0xfedf range, surrogates */
105 258 : if (((z == 0x0f) &&
106 0 : (((yx & 0xffe) == 0xffe) ||
107 258 : (((yx & 0xf80) == 0xd80) && (lx >= 0x30) && (lx <= 0x4f)))) ||
108 0 : ((z == 0x0d) && ((yx & 0xb00) == 0x800)))
109 0 : return -1;
110 258 : return 3;
111 : }
112 0 : return -1;
113 : }
114 24 : else if ((*c & 0xf8) == 0xf0)
115 : {
116 24 : int u = ((c[0] & 0x07) << 2) | ((c[1] & 0x30) >> 4);
117 :
118 : /* four-byte char */
119 24 : if (((c[1] & 0xc0) == 0x80) &&
120 24 : (u > 0x00) && (u <= 0x10) &&
121 24 : ((c[2] & 0xc0) == 0x80) && ((c[3] & 0xc0) == 0x80))
122 : {
123 : /* test for 0xzzzzfffe/0xzzzzfffff */
124 24 : if (((c[1] & 0x0f) == 0x0f) && ((c[2] & 0x3f) == 0x3f) &&
125 0 : ((c[3] & 0x3e) == 0x3e))
126 0 : return -1;
127 24 : return 4;
128 : }
129 0 : return -1;
130 : }
131 0 : return -1;
132 : }
133 :
134 :
135 : static void
136 4949206 : mb_utf_validate(unsigned char *pwcs)
137 : {
138 4949206 : unsigned char *p = pwcs;
139 :
140 23906014 : while (*pwcs)
141 : {
142 : int len;
143 :
144 18956808 : if ((len = utf_charcheck(pwcs)) > 0)
145 : {
146 18956808 : if (p != pwcs)
147 : {
148 : int i;
149 :
150 0 : for (i = 0; i < len; i++)
151 0 : *p++ = *pwcs++;
152 : }
153 : else
154 : {
155 18956808 : pwcs += len;
156 18956808 : p += len;
157 : }
158 : }
159 : else
160 : /* we skip the char */
161 0 : pwcs++;
162 : }
163 4949206 : if (p != pwcs)
164 0 : *p = '\0';
165 4949206 : }
166 :
167 : /*
168 : * public functions : wcswidth and mbvalidate
169 : */
170 :
171 : /*
172 : * pg_wcswidth is the dumb display-width function.
173 : * It assumes that everything will appear on one line.
174 : * OTOH it is easier to use than pg_wcssize if this applies to you.
175 : */
176 : int
177 4378 : pg_wcswidth(const char *pwcs, size_t len, int encoding)
178 : {
179 4378 : int width = 0;
180 :
181 44306 : while (len > 0)
182 : {
183 : int chlen,
184 : chwidth;
185 :
186 39928 : chlen = PQmblen(pwcs, encoding);
187 39928 : if (len < (size_t) chlen)
188 0 : break; /* Invalid string */
189 :
190 39928 : chwidth = PQdsplen(pwcs, encoding);
191 39928 : if (chwidth > 0)
192 39928 : width += chwidth;
193 :
194 39928 : pwcs += chlen;
195 39928 : len -= chlen;
196 : }
197 4378 : return width;
198 : }
199 :
200 : /*
201 : * pg_wcssize takes the given string in the given encoding and returns three
202 : * values:
203 : * result_width: Width in display characters of the longest line in string
204 : * result_height: Number of lines in display output
205 : * result_format_size: Number of bytes required to store formatted
206 : * representation of string
207 : *
208 : * This MUST be kept in sync with pg_wcsformat!
209 : */
210 : void
211 2395276 : pg_wcssize(const unsigned char *pwcs, size_t len, int encoding,
212 : int *result_width, int *result_height, int *result_format_size)
213 : {
214 : int w,
215 2395276 : chlen = 0,
216 2395276 : linewidth = 0;
217 2395276 : int width = 0;
218 2395276 : int height = 1;
219 2395276 : int format_size = 0;
220 :
221 28901128 : for (; *pwcs && len > 0; pwcs += chlen)
222 : {
223 26505852 : chlen = PQmblen((const char *) pwcs, encoding);
224 26505852 : if (len < (size_t) chlen)
225 0 : break;
226 26505852 : w = PQdsplen((const char *) pwcs, encoding);
227 :
228 26505852 : if (chlen == 1) /* single-byte char */
229 : {
230 26501180 : if (*pwcs == '\n') /* Newline */
231 : {
232 38310 : if (linewidth > width)
233 9076 : width = linewidth;
234 38310 : linewidth = 0;
235 38310 : height += 1;
236 38310 : format_size += 1; /* For NUL char */
237 : }
238 26462870 : else if (*pwcs == '\r') /* Linefeed */
239 : {
240 16 : linewidth += 2;
241 16 : format_size += 2;
242 : }
243 26462854 : else if (*pwcs == '\t') /* Tab */
244 : {
245 : do
246 : {
247 3388 : linewidth++;
248 3388 : format_size++;
249 3388 : } while (linewidth % 8 != 0);
250 : }
251 26462422 : else if (w < 0) /* Other control char */
252 : {
253 156 : linewidth += 4;
254 156 : format_size += 4;
255 : }
256 : else /* Output it as-is */
257 : {
258 26462266 : linewidth += w;
259 26462266 : format_size += 1;
260 : }
261 : }
262 4672 : else if (w < 0) /* Non-ascii control char */
263 : {
264 0 : linewidth += 6; /* \u0000 */
265 0 : format_size += 6;
266 : }
267 : else /* All other chars */
268 : {
269 4672 : linewidth += w;
270 4672 : format_size += chlen;
271 : }
272 26505852 : len -= chlen;
273 : }
274 2395276 : if (linewidth > width)
275 2213062 : width = linewidth;
276 2395276 : format_size += 1; /* For NUL char */
277 :
278 : /* Set results */
279 2395276 : if (result_width)
280 2395276 : *result_width = width;
281 2395276 : if (result_height)
282 2395276 : *result_height = height;
283 2395276 : if (result_format_size)
284 2389542 : *result_format_size = format_size;
285 2395276 : }
286 :
287 : /*
288 : * Format a string into one or more "struct lineptr" lines.
289 : * lines[i].ptr == NULL indicates the end of the array.
290 : *
291 : * This MUST be kept in sync with pg_wcssize!
292 : */
293 : void
294 1323114 : pg_wcsformat(const unsigned char *pwcs, size_t len, int encoding,
295 : struct lineptr *lines, int count)
296 : {
297 : int w,
298 1323114 : chlen = 0;
299 1323114 : int linewidth = 0;
300 1323114 : unsigned char *ptr = lines->ptr; /* Pointer to data area */
301 :
302 15452776 : for (; *pwcs && len > 0; pwcs += chlen)
303 : {
304 14129662 : chlen = PQmblen((const char *) pwcs, encoding);
305 14129662 : if (len < (size_t) chlen)
306 0 : break;
307 14129662 : w = PQdsplen((const char *) pwcs, encoding);
308 :
309 14129662 : if (chlen == 1) /* single-byte char */
310 : {
311 14127326 : if (*pwcs == '\n') /* Newline */
312 : {
313 20388 : *ptr++ = '\0';
314 20388 : lines->width = linewidth;
315 20388 : linewidth = 0;
316 20388 : lines++;
317 20388 : count--;
318 20388 : if (count <= 0)
319 0 : exit(1); /* Screwup */
320 :
321 : /* make next line point to remaining memory */
322 20388 : lines->ptr = ptr;
323 : }
324 14106938 : else if (*pwcs == '\r') /* Linefeed */
325 : {
326 8 : strcpy((char *) ptr, "\\r");
327 8 : linewidth += 2;
328 8 : ptr += 2;
329 : }
330 14106930 : else if (*pwcs == '\t') /* Tab */
331 : {
332 : do
333 : {
334 1694 : *ptr++ = ' ';
335 1694 : linewidth++;
336 1694 : } while (linewidth % 8 != 0);
337 : }
338 14106714 : else if (w < 0) /* Other control char */
339 : {
340 78 : sprintf((char *) ptr, "\\x%02X", *pwcs);
341 78 : linewidth += 4;
342 78 : ptr += 4;
343 : }
344 : else /* Output it as-is */
345 : {
346 14106636 : linewidth += w;
347 14106636 : *ptr++ = *pwcs;
348 : }
349 : }
350 2336 : else if (w < 0) /* Non-ascii control char */
351 : {
352 0 : if (encoding == PG_UTF8)
353 0 : sprintf((char *) ptr, "\\u%04X", utf8_to_unicode(pwcs));
354 : else
355 : {
356 : /*
357 : * This case cannot happen in the current code because only
358 : * UTF-8 signals multibyte control characters. But we may need
359 : * to support it at some stage
360 : */
361 0 : sprintf((char *) ptr, "\\u????");
362 : }
363 0 : ptr += 6;
364 0 : linewidth += 6;
365 : }
366 : else /* All other chars */
367 : {
368 : int i;
369 :
370 7314 : for (i = 0; i < chlen; i++)
371 4978 : *ptr++ = pwcs[i];
372 2336 : linewidth += w;
373 : }
374 14129662 : len -= chlen;
375 : }
376 1323114 : lines->width = linewidth;
377 1323114 : *ptr++ = '\0'; /* Terminate formatted string */
378 :
379 1323114 : if (count <= 0)
380 0 : exit(1); /* Screwup */
381 :
382 1323114 : (lines + 1)->ptr = NULL; /* terminate line array */
383 1323114 : }
384 :
385 :
386 : /*
387 : * Encoding validation: delete any unvalidatable characters from the string
388 : *
389 : * This seems redundant with existing functionality elsewhere?
390 : */
391 : unsigned char *
392 4952480 : mbvalidate(unsigned char *pwcs, int encoding)
393 : {
394 4952480 : if (encoding == PG_UTF8)
395 4949206 : mb_utf_validate(pwcs);
396 : else
397 : {
398 : /*
399 : * other encodings needing validation should add their own routines
400 : * here
401 : */
402 : }
403 :
404 4952480 : return pwcs;
405 : }
|
