*
* You should have received a copy of the GNU Lesser General Public
* License along with the Gnome Library; see the file COPYING.LIB. If not,
- * write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- * Boston, MA 02111-1307, USA.
+ * see <http://www.gnu.org/licenses/>.
+ */
+
+/**
+ * SECTION:unicode
+ * @Title: Unicode Manipulation
+ * @Short_description: functions operating on Unicode characters and
+ * UTF-8 strings
+ * @See_also: g_locale_to_utf8(), g_locale_from_utf8()
+ *
+ * This section describes a number of functions for dealing with
+ * Unicode characters and strings. There are analogues of the
+ * traditional `ctype.h` character classification and case conversion
+ * functions, UTF-8 analogues of some string utility functions,
+ * functions to perform normalization, case conversion and collation
+ * on UTF-8 strings and finally functions to convert between the UTF-8,
+ * UTF-16 and UCS-4 encodings of Unicode.
+ *
+ * The implementations of the Unicode functions in GLib are based
+ * on the Unicode Character Data tables, which are available from
+ * [www.unicode.org](http://www.unicode.org/).
+ * GLib 2.8 supports Unicode 4.0, GLib 2.10 supports Unicode 4.1,
+ * GLib 2.12 supports Unicode 5.0, GLib 2.16.3 supports Unicode 5.1,
+ * GLib 2.30 supports Unicode 6.0.
*/
#include "config.h"
#include <stdlib.h>
-#include "glib.h"
+#include "gunicode.h"
#include "gunidecomp.h"
+#include "gmem.h"
#include "gunicomp.h"
#include "gunicodeprivate.h"
? CC_PART2 (((Char) - 0xe0000) >> 8, (Char) & 0xff) \
: 0))
+/**
+ * g_unichar_combining_class:
+ * @uc: a Unicode character
+ *
+ * Determines the canonical combining class of a Unicode character.
+ *
+ * Returns: the combining class of the character
+ *
+ * Since: 2.14
+ **/
gint
-_g_unichar_combining_class (gunichar uc)
+g_unichar_combining_class (gunichar uc)
{
return COMBINING_CLASS (uc);
}
* only calculate the result_len; however, a buffer with space for three
* characters will always be big enough. */
static void
-decompose_hangul (gunichar s,
+decompose_hangul (gunichar s,
gunichar *r,
gsize *result_len)
{
gint SIndex = s - SBase;
+ gint TIndex = SIndex % TCount;
- /* not a hangul syllable */
- if (SIndex < 0 || SIndex >= SCount)
+ if (r)
{
- if (r)
- r[0] = s;
- *result_len = 1;
+ r[0] = LBase + SIndex / NCount;
+ r[1] = VBase + (SIndex % NCount) / TCount;
}
- else
- {
- gunichar L = LBase + SIndex / NCount;
- gunichar V = VBase + (SIndex % NCount) / TCount;
- gunichar T = TBase + SIndex % TCount;
+ if (TIndex)
+ {
if (r)
- {
- r[0] = L;
- r[1] = V;
- }
-
- if (T != TBase)
- {
- if (r)
- r[2] = T;
- *result_len = 3;
- }
- else
- *result_len = 2;
+ r[2] = TBase + TIndex;
+ *result_len = 3;
}
+ else
+ *result_len = 2;
}
/* returns a pointer to a null-terminated UTF-8 string */
*
* Computes the canonical decomposition of a Unicode character.
*
- * Return value: a newly allocated string of Unicode characters.
+ * Returns: a newly allocated string of Unicode characters.
* @result_len is set to the resulting length of the string.
+ *
+ * Deprecated: 2.30: Use the more flexible g_unichar_fully_decompose()
+ * instead.
**/
gunichar *
g_unicode_canonical_decomposition (gunichar ch,
gunichar *r;
/* Hangul syllable */
- if (ch >= 0xac00 && ch <= 0xd7af)
+ if (ch >= SBase && ch < SBase + SCount)
{
decompose_hangul (ch, NULL, result_len);
r = g_malloc (*result_len * sizeof (gunichar));
*result_len = 1;
}
- /* Supposedly following the Unicode 2.1.9 table means that the
- decompositions come out in canonical order. I haven't tested
- this, but we rely on it here. */
return r;
}
return TRUE;
}
else if (0 <= SIndex && SIndex < SCount && (SIndex % TCount) == 0
- && 0 <= TIndex && TIndex <= TCount)
+ && 0 < TIndex && TIndex < TCount)
{
*result = a + TIndex;
return TRUE;
: (compose_data[compose_table[Page]][Char]))
#define COMPOSE_INDEX(Char) \
- (((Char) > (G_UNICODE_LAST_CHAR)) ? 0 : CI((Char) >> 8, (Char) & 0xff))
+ (((Char >> 8) > (COMPOSE_TABLE_LAST)) ? 0 : CI((Char) >> 8, (Char) & 0xff))
static gboolean
combine (gunichar a,
const gchar *decomp;
gunichar wc = g_utf8_get_char (p);
- if (wc >= 0xac00 && wc <= 0xd7af)
+ if (wc >= SBase && wc < SBase + SCount)
{
gsize result_len;
decompose_hangul (wc, NULL, &result_len);
int cc;
gsize old_n_wc = n_wc;
- if (wc >= 0xac00 && wc <= 0xd7af)
+ if (wc >= SBase && wc < SBase + SCount)
{
gsize result_len;
decompose_hangul (wc, wc_buffer + n_wc, &result_len);
int cc = COMBINING_CLASS (wc_buffer[i]);
if (i > 0 &&
- (last_cc == 0 || last_cc != cc) &&
+ (last_cc == 0 || last_cc < cc) &&
combine (wc_buffer[last_start], wc_buffer[i],
&wc_buffer[last_start]))
{
* @str: a UTF-8 encoded string.
* @len: length of @str, in bytes, or -1 if @str is nul-terminated.
* @mode: the type of normalization to perform.
- *
+ *
* Converts a string into canonical form, standardizing
* such issues as whether a character with an accent
* is represented as a base character and combining
- * accent or as a single precomposed character. You
- * should generally call g_utf8_normalize() before
- * comparing two Unicode strings.
+ * accent or as a single precomposed character. The
+ * string has to be valid UTF-8, otherwise %NULL is
+ * returned. You should generally call g_utf8_normalize()
+ * before comparing two Unicode strings.
*
* The normalization mode %G_NORMALIZE_DEFAULT only
* standardizes differences that do not affect the
* (in this case DIGIT THREE). Formatting information
* may be lost but for most text operations such
* characters should be considered the same.
- * For example, g_utf8_collate() normalizes
- * with %G_NORMALIZE_ALL as its first step.
*
* %G_NORMALIZE_DEFAULT_COMPOSE and %G_NORMALIZE_ALL_COMPOSE
* are like %G_NORMALIZE_DEFAULT and %G_NORMALIZE_ALL,
* useful if you intend to convert the string to
* a legacy encoding or pass it to a system with
* less capable Unicode handling.
- *
- * Return value: a newly allocated string, that is the
- * normalized form of @str.
+ *
+ * Returns: a newly allocated string, that is the
+ * normalized form of @str, or %NULL if @str is not
+ * valid UTF-8.
**/
gchar *
g_utf8_normalize (const gchar *str,
return result;
}
+
+static gboolean
+decompose_hangul_step (gunichar ch,
+ gunichar *a,
+ gunichar *b)
+{
+ gint SIndex, TIndex;
+
+ if (ch < SBase || ch >= SBase + SCount)
+ return FALSE; /* not a hangul syllable */
+
+ SIndex = ch - SBase;
+ TIndex = SIndex % TCount;
+
+ if (TIndex)
+ {
+ /* split LVT -> LV,T */
+ *a = ch - TIndex;
+ *b = TBase + TIndex;
+ }
+ else
+ {
+ /* split LV -> L,V */
+ *a = LBase + SIndex / NCount;
+ *b = VBase + (SIndex % NCount) / TCount;
+ }
+
+ return TRUE;
+}
+
+/**
+ * g_unichar_decompose:
+ * @ch: a Unicode character
+ * @a: return location for the first component of @ch
+ * @b: return location for the second component of @ch
+ *
+ * Performs a single decomposition step of the
+ * Unicode canonical decomposition algorithm.
+ *
+ * This function does not include compatibility
+ * decompositions. It does, however, include algorithmic
+ * Hangul Jamo decomposition, as well as 'singleton'
+ * decompositions which replace a character by a single
+ * other character. In the case of singletons *@b will
+ * be set to zero.
+ *
+ * If @ch is not decomposable, *@a is set to @ch and *@b
+ * is set to zero.
+ *
+ * Note that the way Unicode decomposition pairs are
+ * defined, it is guaranteed that @b would not decompose
+ * further, but @a may itself decompose. To get the full
+ * canonical decomposition for @ch, one would need to
+ * recursively call this function on @a. Or use
+ * g_unichar_fully_decompose().
+ *
+ * See
+ * [UAX#15](http://unicode.org/reports/tr15/)
+ * for details.
+ *
+ * Returns: %TRUE if the character could be decomposed
+ *
+ * Since: 2.30
+ */
+gboolean
+g_unichar_decompose (gunichar ch,
+ gunichar *a,
+ gunichar *b)
+{
+ gint start = 0;
+ gint end = G_N_ELEMENTS (decomp_step_table);
+
+ if (decompose_hangul_step (ch, a, b))
+ return TRUE;
+
+ /* TODO use bsearch() */
+ if (ch >= decomp_step_table[start].ch &&
+ ch <= decomp_step_table[end - 1].ch)
+ {
+ while (TRUE)
+ {
+ gint half = (start + end) / 2;
+ const decomposition_step *p = &(decomp_step_table[half]);
+ if (ch == p->ch)
+ {
+ *a = p->a;
+ *b = p->b;
+ return TRUE;
+ }
+ else if (half == start)
+ break;
+ else if (ch > p->ch)
+ start = half;
+ else
+ end = half;
+ }
+ }
+
+ *a = ch;
+ *b = 0;
+
+ return FALSE;
+}
+
+/**
+ * g_unichar_compose:
+ * @a: a Unicode character
+ * @b: a Unicode character
+ * @ch: return location for the composed character
+ *
+ * Performs a single composition step of the
+ * Unicode canonical composition algorithm.
+ *
+ * This function includes algorithmic Hangul Jamo composition,
+ * but it is not exactly the inverse of g_unichar_decompose().
+ * No composition can have either of @a or @b equal to zero.
+ * To be precise, this function composes if and only if
+ * there exists a Primary Composite P which is canonically
+ * equivalent to the sequence <@a,@b>. See the Unicode
+ * Standard for the definition of Primary Composite.
+ *
+ * If @a and @b do not compose a new character, @ch is set to zero.
+ *
+ * See
+ * [UAX#15](http://unicode.org/reports/tr15/)
+ * for details.
+ *
+ * Returns: %TRUE if the characters could be composed
+ *
+ * Since: 2.30
+ */
+gboolean
+g_unichar_compose (gunichar a,
+ gunichar b,
+ gunichar *ch)
+{
+ if (combine (a, b, ch))
+ return TRUE;
+
+ *ch = 0;
+ return FALSE;
+}
+
+/**
+ * g_unichar_fully_decompose:
+ * @ch: a Unicode character.
+ * @compat: whether perform canonical or compatibility decomposition
+ * @result: (allow-none): location to store decomposed result, or %NULL
+ * @result_len: length of @result
+ *
+ * Computes the canonical or compatibility decomposition of a
+ * Unicode character. For compatibility decomposition,
+ * pass %TRUE for @compat; for canonical decomposition
+ * pass %FALSE for @compat.
+ *
+ * The decomposed sequence is placed in @result. Only up to
+ * @result_len characters are written into @result. The length
+ * of the full decomposition (irrespective of @result_len) is
+ * returned by the function. For canonical decomposition,
+ * currently all decompositions are of length at most 4, but
+ * this may change in the future (very unlikely though).
+ * At any rate, Unicode does guarantee that a buffer of length
+ * 18 is always enough for both compatibility and canonical
+ * decompositions, so that is the size recommended. This is provided
+ * as %G_UNICHAR_MAX_DECOMPOSITION_LENGTH.
+ *
+ * See
+ * [UAX#15](http://unicode.org/reports/tr15/)
+ * for details.
+ *
+ * Returns: the length of the full decomposition.
+ *
+ * Since: 2.30
+ **/
+gsize
+g_unichar_fully_decompose (gunichar ch,
+ gboolean compat,
+ gunichar *result,
+ gsize result_len)
+{
+ const gchar *decomp;
+ const gchar *p;
+
+ /* Hangul syllable */
+ if (ch >= SBase && ch < SBase + SCount)
+ {
+ gsize len, i;
+ gunichar buffer[3];
+ decompose_hangul (ch, result ? buffer : NULL, &len);
+ if (result)
+ for (i = 0; i < len && i < result_len; i++)
+ result[i] = buffer[i];
+ return len;
+ }
+ else if ((decomp = find_decomposition (ch, compat)) != NULL)
+ {
+ /* Found it. */
+ gsize len, i;
+
+ len = g_utf8_strlen (decomp, -1);
+
+ for (p = decomp, i = 0; i < len && i < result_len; p = g_utf8_next_char (p), i++)
+ result[i] = g_utf8_get_char (p);
+
+ return len;
+ }
+
+ /* Does not decompose */
+ if (result && result_len >= 1)
+ *result = ch;
+ return 1;
+}
projects / platform / upstream / glib.git / blobdiff