Minor doc markup fix.
[glib.git] / glib / gunibreak.c
blobdddca457d9e100de38bcaf3aa78c84b776159274
1 /* gunibreak.c - line break properties
3 * Copyright 2000 Red Hat, Inc.
5 * The Gnome Library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Lesser General Public License as
7 * published by the Free Software Foundation; either version 2 of the
8 * License, or (at your option) any later version.
10 * The Gnome Library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Lesser General Public License for more details.
15 * You should have received a copy of the GNU Lesser General Public
16 * License along with the Gnome Library; see the file COPYING.LIB. If not,
17 * write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 * Boston, MA 02111-1307, USA.
21 #include <config.h>
23 #include "glib.h"
24 #include "gunibreak.h"
26 #include <stdlib.h>
29 #define TPROP(Page, Char) \
30 ((break_property_table[Page] >= G_UNICODE_MAX_TABLE_INDEX) \
31 ? (break_property_table[Page] - G_UNICODE_MAX_TABLE_INDEX) \
32 : (break_property_data[break_property_table[Page]][Char]))
34 #define PROP(Char) (((Char) > (G_UNICODE_LAST_CHAR)) ? G_UNICODE_UNASSIGNED : TPROP ((Char) >> 8, (Char) & 0xff))
36 /**
37 * g_unichar_break_type:
38 * @c: a Unicode character
40 * Determines the break type of @c. @c should be a Unicode character
41 * (to derive a character from UTF-8 encoded text, use
42 * g_utf8_get_char()). The break type is used to find word and line
43 * breaks ("text boundaries"), Pango implements the Unicode boundary
44 * resolution algorithms and normally you would use a function such
45 * as pango_break() instead of caring about break types yourself.
47 * Return value: the break type of @c
48 **/
49 GUnicodeBreakType
50 g_unichar_break_type (gunichar c)
52 return PROP (c);