Message-ID: <3f2a117fd346c19bdb388e0fc3925873a1728bf6.camel@j-davis.com>
Subject: [18] clarify the difference between pg_wchar, wchar_t, and Unicode
 code points
From: Jeff Davis <pgsql@j-davis.com>
To: pgsql-hackers@postgresql.org
Date: Mon, 15 Apr 2024 16:40:23 -0700
Content-Type: text/plain; charset="UTF-8"
Content-Transfer-Encoding: quoted-printable
User-Agent: Evolution 3.44.4-0ubuntu2 
MIME-Version: 1.0
Archived-At: <https://www.postgresql.org/message-id/3f2a117fd346c19bdb388e0fc3925873a1728bf6.camel%40j-davis.com>
Precedence: bulk

I'm not sure I understand all of the history behind pg_wchar, but it
seems to be some blend of:

  (a) Postgres's own internal representation of a decoded character
  (b) libc's wchar_t
  (c) Unicode code point

For example, Postgres has its own encoding/decoding routines, so (a) is
the most obvious definition. When the server encoding is UTF-8, the
internal representation is a Unicode code point, which is convenient
for the builtin and ICU providers, as well as some (most? all?) libc
implementations. Other encodings have different represenations which
seem to favor the libc provider.

pg_wchar is also passed directly to libc routines like iswalpha_l()
(see pg_wc_isalpha()), which is depending on definition (b). We guard
it with:

  if (sizeof(wchar_t) >=3D 4 || c <=3D (pg_wchar) 0xFFFF)

to ensure that the pg_wchar is representable in the libc's wchar_t
type. As far as I can tell this is still no guarantee of correctness;
it's just a sanity check. I didn't find an obviously better way of
doing it, however.

When using ICU, we also pass a pg_wchar directly to ICU routines, which
depends on definition (c), and can lead to problems like:

https://www.postgresql.org/message-id/e7b67d24288f811aebada7c33f9ae629dde0d=
ef5.camel@j-davis.com


The comment at the top of pg_regc_locale.c explains some of the above,
but not all. I'd like to organize this a bit better:

  * a new typedef for a Unicode code point ("codepoint"? "uchar"?)
  * a no-op conversion routine from pg_wchar to a codepoint that would
assert that the server encoding is UTF-8 (#ifndef FRONTEND, of course)
  * a no-op conversion routine from pg_wchar to wchar_t that would be a
good place for a comment describing that it's a "best effort" and may
not be correct in all cases

We could even go so far as to make the pg_wchar type not implicitly-
castable, so that callers would be forced to convert it to either a
wchar_t or a code point.

Tom also suggested here:

https://www.postgresql.org/message-id/360857.1701302164%40sss.pgh.pa.us

that we don't necessarily need to use libc at all, and I like that
idea. Perhaps the suggestions above are a step in that direction, or
perhaps we can skip ahead?

I intend to submit a patch for the July CF. Thoughts?

Regards,
	Jeff Davis