1 /* m17n-core.h -- header file for the CORE API of the m17n library.
2 Copyright (C) 2003, 2004, 2005, 2006
3 National Institute of Advanced Industrial Science and Technology (AIST)
4 Registration Number H15PRO112
6 This file is part of the m17n library.
8 The m17n library is free software; you can redistribute it and/or
9 modify it under the terms of the GNU Lesser General Public License
10 as published by the Free Software Foundation; either version 2.1 of
11 the License, or (at your option) any later version.
13 The m17n library is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 Lesser General Public License for more details.
18 You should have received a copy of the GNU Lesser General Public
19 License along with the m17n library; if not, write to the Free
20 Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
32 * Header file for m17n library.
35 /* (C1) Introduction */
37 /***en @defgroup m17nIntro Introduction */
38 /***ja @defgroup m17nIntro ¤Ï¤¸¤á¤Ë */
41 #if !defined (FOR_DOXYGEN) || defined (DOXYGEN_INTERNAL_MODULE)
43 #define M17NLIB_MAJOR_VERSION 1
44 #define M17NLIB_MINOR_VERSION 3
45 #define M17NLIB_PATCH_LEVEL 3
46 #define M17NLIB_VERSION_NAME "1.3.3"
48 extern void m17n_init_core (void);
49 #define M17N_INIT() m17n_init_core ()
50 extern void m17n_fini_core (void);
51 #define M17N_FINI() m17n_fini_core ()
57 /*** @ingroup m17nIntro */
59 @brief Enumeration for the status of the m17n library.
61 The enum #M17NStatus is used as a return value of the function
65 @brief m17n ¥é¥¤¥Ö¥é¥ê¤Î¾õÂÖ¤ò¼¨¤¹Îóµó·¿.
67 Îóµó·¿ #M17NStatus ¤Ï´Ø¿ô m17n_status () ¤ÎÌá¤êÃͤȤ·¤ÆÍѤ¤¤é¤ì¤ë¡£ */
71 /***en No modules is initialized, and all modules are finalized. */
73 /***en Only the modules in CORE API are initialized. */
74 M17N_CORE_INITIALIZED,
75 /***en Only the modules in CORE and SHELL APIs are initialized. */
76 M17N_SHELL_INITIALIZED,
77 /***en All modules are initialized. */
83 extern enum M17NStatus m17n_status (void);
85 /***en @defgroup m17nCore CORE API */
86 /***ja @defgroup m17nCore ¥³¥¢ API */
88 /*** @ingroup m17nCore */
89 /***en @defgroup m17nObject Managed Object */
90 /***ja @defgroup m17nObject ´ÉÍý²¼¥ª¥Ö¥¸¥§¥¯¥È */
93 /*** @ingroup m17nObject */
95 @brief The first member of a managed object.
97 When an application program defines a new structure for managed
98 objects, its first member must be of the type @c struct
99 #M17NObjectHead. Its contents are used by the m17n library, and
100 application programs should never touch them. */
102 @brief ´ÉÍý²¼¥ª¥Ö¥¸¥§¥¯¥È¤ÎºÇ½é¤Î¥á¥ó¥Ð.
104 ¥¢¥×¥ê¥±¡¼¥·¥ç¥ó¥×¥í¥°¥é¥à¤¬¿·¤·¤¤¹½Â¤ÂΤò´ÉÍý²¼¥ª¥Ö¥¸¥§¥¯¥È¤È¤·¤ÆÄêµÁ¤¹¤ëºÝ¤Ë¤Ï¡¢ºÇ½é¤Î¥á¥ó¥Ð¤Ï
105 @c #M17NObjectHead ¹½Â¤Âη¿¤Ç¤Ê¤¯¤Æ¤Ï¤Ê¤é¤Ê¤¤¡£
106 @c #M17NObjectHead ¤ÎÆâÍÆ¤Ï m17n
107 ¥é¥¤¥Ö¥é¥ê¤¬»ÈÍѤ¹¤ë¤Î¤Ç¡¢¥¢¥×¥ê¥±¡¼¥·¥ç¥ó¥×¥í¥°¥é¥à¤Ï¿¨¤ì¤Æ¤Ï¤Ê¤é¤Ê¤¤¡£ */
116 /* Return a newly allocated managed object. */
117 extern void *m17n_object (int size, void (*freer) (void *));
119 /* Increment the reference count of managed object OBJECT. */
120 extern int m17n_object_ref (void *object);
122 /* Decrement the reference count of managed object OBJECT. */
123 extern int m17n_object_unref (void *object);
127 /* (C2) Symbol handling */
129 /*** @ingroup m17nCore */
130 /***en @defgroup m17nSymbol Symbol */
131 /***ja @defgroup m17nSymbol ¥·¥ó¥Ü¥ë */
135 @ingroup m17nSymbol */
137 @brief Type of symbols.
139 The type #MSymbol is for a @e symbol object. Its internal
140 structure is concealed from application programs. */
143 @brief ¥·¥ó¥Ü¥ë¤Î·¿Àë¸À.
145 #MSymbol ¤Ï @e ¥·¥ó¥Ü¥ë (symbol) ¥ª¥Ö¥¸¥§¥¯¥È¤Î·¿¤Ç¤¢¤ë¡£
146 ÆâÉô¹½Â¤¤Ï¥¢¥×¥ê¥±¡¼¥·¥ç¥ó¥×¥í¥°¥é¥à¤«¤é¤Ï¸«¤¨¤Ê¤¤¡£ */
148 typedef struct MSymbolStruct *MSymbol;
152 /* Predefined symbols. */
155 extern MSymbol Mstring;
156 extern MSymbol Msymbol;
157 extern MSymbol Mtext;
159 /* Return a symbol of name NAME. */
160 extern MSymbol msymbol (const char *name);
162 /* Return a managing key of name NAME. */
163 extern MSymbol msymbol_as_managing_key (const char *name);
165 /* Check if SYMBOL is a managing key. */
166 extern int msymbol_is_managing_key (MSymbol symbol);
168 /* Return a symbol of name NAME if it already exists. */
169 extern MSymbol msymbol_exist (const char *name);
171 /* Return the name of SYMBOL. */
172 extern char *msymbol_name (MSymbol symbol);
174 /* Give SYMBOL KEY property with value VALUE. */
175 extern int msymbol_put (MSymbol symbol, MSymbol key, void *val);
177 /*** Return KEY property value of SYMBOL. */
178 extern void *msymbol_get (MSymbol symbol, MSymbol key);
181 * (2-1) Property List
184 /*** @ingroup m17nCore */
185 /***en @defgroup m17nPlist Property List */
186 /***ja @defgroup m17nPlist ¥×¥í¥Ñ¥Æ¥£¥ê¥¹¥È */
190 @ingroup m17nPlist */
192 @brief Type of property list objects.
194 The type #MPlist is for a @e property @e list object. Its internal
195 structure is concealed from application programs. */
198 @brief ¥×¥í¥Ñ¥Æ¥£¥ê¥¹¥È¡¦¥ª¥Ö¥¸¥§¥¯¥È¤Î·¿Àë¸À.
200 #MPlist ¤Ï @e ¥×¥í¥Ñ¥Æ¥£¥ê¥¹¥È (Property list) ¥ª¥Ö¥¸¥§¥¯¥È¤Î·¿¤Ç¤¢¤ë¡£
201 ÆâÉô¹½Â¤¤Ï¥¢¥×¥ê¥±¡¼¥·¥ç¥ó¥×¥í¥°¥é¥à¤«¤é¤Ï¸«¤¨¤Ê¤¤¡£ */
203 typedef struct MPlist MPlist;
207 extern MSymbol Mplist, Minteger;
209 extern MPlist *mplist ();
211 extern MPlist *mplist_copy (MPlist *plist);
213 extern MPlist *mplist_add (MPlist *plist, MSymbol key, void *val);
215 extern MPlist *mplist_push (MPlist *plist, MSymbol key, void *val);
217 extern void *mplist_pop (MPlist *plist);
219 extern MPlist *mplist_put (MPlist *plist, MSymbol key, void *val);
221 extern void *mplist_get (MPlist *plist, MSymbol key);
223 extern MPlist *mplist_find_by_key (MPlist *plist, MSymbol key);
225 extern MPlist *mplist_find_by_value (MPlist *plist, void *val);
227 extern MPlist *mplist_next (MPlist *plist);
229 extern MPlist *mplist_set (MPlist *plist, MSymbol key, void *val);
231 extern int mplist_length (MPlist *plist);
233 extern MSymbol mplist_key (MPlist *plist);
235 extern void *mplist_value (MPlist *plist);
237 /* (S1) Characters */
240 /*** @ingroup m17nCore */
241 /***en @defgroup m17nCharacter Character */
242 /***ja @defgroup m17nCharacter ʸ»ú */
245 #if !defined (FOR_DOXYGEN) || defined (DOXYGEN_INTERNAL_MODULE)
246 #define MCHAR_MAX 0x3FFFFF
247 /*#define MCHAR_MAX 0x7FFFFFFF*/
250 extern MSymbol Mscript;
251 extern MSymbol Mname;
252 extern MSymbol Mcategory;
253 extern MSymbol Mcombining_class;
254 extern MSymbol Mbidi_category;
255 extern MSymbol Msimple_case_folding;
256 extern MSymbol Mcomplicated_case_folding;
258 extern MSymbol mchar_define_property (const char *name, MSymbol type);
260 extern void *mchar_get_prop (int c, MSymbol key);
262 extern int mchar_put_prop (int c, MSymbol key, void *val);
264 /* (C3) Handling chartable */
266 /*** @ingroup m17nCore */
267 /***en @defgroup m17nChartable Chartable */
268 /***ja @defgroup m17nChartable ʸ»ú¥Æ¡¼¥Ö¥ë */
270 extern MSymbol Mchar_table;
273 @ingroup m17nChartable */
275 @brief Type of chartables.
277 The type #MCharTable is for a @e chartable objects. Its
278 internal structure is concealed from application programs. */
281 @brief ʸ»ú¥Æ¡¼¥Ö¥ë¤Î·¿Àë¸À.
283 #MCharTable ¤Ï @e ʸ»ú¥Æ¡¼¥Ö¥ë (chartable) ¥ª¥Ö¥¸¥§¥¯¥È¤Î·¿¤Ç¤¢¤ë¡£
284 ÆâÉô¹½Â¤¤Ï¥¢¥×¥ê¥±¡¼¥·¥ç¥ó¥×¥í¥°¥é¥à¤«¤é¤Ï¸«¤¨¤Ê¤¤¡£ */
286 typedef struct MCharTable MCharTable;
289 extern MCharTable *mchartable (MSymbol key, void *default_value);
291 extern void *mchartable_lookup (MCharTable *table, int c);
293 extern int mchartable_set (MCharTable *table, int c, void *val);
295 extern int mchartable_set_range (MCharTable *table, int from, int to,
298 extern int mchartable_map (MCharTable *table, void *ignore,
299 void (*func) (int, int, void *, void *),
302 extern void mchartable_range (MCharTable *table, int *from, int *to);
304 extern MCharTable *mchar_get_prop_table (MSymbol key, MSymbol *type);
307 * (5) Handling M-text.
308 * "M" of M-text stands for:
314 /*** @ingroup m17nCore */
315 /***en @defgroup m17nMtext M-text */
316 /***ja @defgroup m17nMtext M-text */
320 * (5-1) M-text basics
323 /*** @ingroup m17nMtext */
325 @brief Type of @e M-texts.
327 The type #MText is for an @e M-text object. Its internal
328 structure is concealed from application programs. */
331 @brief @e MText ¤Î·¿Àë¸À.
333 #Mtext ¤Ï @e M-text ¥ª¥Ö¥¸¥§¥¯¥È¤Î·¿¤Ç¤¢¤ë¡£
334 ÆâÉô¹½Â¤¤Ï¥¢¥×¥ê¥±¡¼¥·¥ç¥ó¥×¥í¥°¥é¥à¤«¤é¤Ï¸«¤¨¤Ê¤¤¡£
336 @latexonly \IPAlabel{MText} @endlatexonly
337 @latexonly \IPAlabel{MText->MPlist} @endlatexonly */
339 typedef struct MText MText;
343 /*** @ingroup m17nMtext */
345 @brief Enumeration for specifying the format of an M-text.
347 The enum #MTextFormat is used as an argument of the
348 mtext_from_data () function to specify the format of data from
349 which an M-text is created. */
352 @brief M-text ¤Î¥Õ¥©¡¼¥Þ¥Ã¥È¤ò»ØÄꤹ¤ëÎóµó·¿.
354 Îóµó·¿ #MTextFormat ¤Ï´Ø¿ô
355 mtext_from_data () ¤Î°ú¿ô¤È¤·¤ÆÍѤ¤¤é¤ì¡¢
356 M-text ¤òÀ¸À®¤¹¤ë¸µ¤È¤Ê¤ë¥Ç¡¼¥¿¤Î¥Õ¥©¡¼¥Þ¥Ã¥È¤ò»ØÄꤹ¤ë¡£ */
360 MTEXT_FORMAT_US_ASCII,
362 MTEXT_FORMAT_UTF_16LE,
363 MTEXT_FORMAT_UTF_16BE,
364 MTEXT_FORMAT_UTF_32LE,
365 MTEXT_FORMAT_UTF_32BE,
370 extern MText *mtext ();
372 extern void *mtext_data (MText *mt, enum MTextFormat *fmt, int *nunits,
373 int *pos_idx, int *unit_idx);
377 /***en @name Variables: Default Endian of UTF-16 and UTF-32 */
378 /***ja @name ÊÑ¿ô: UTF-16 ¤È UTF-32 ¤Î¥Ç¥Õ¥©¥ë¥È¤Î¥¨¥ó¥Ç¥£¥¢¥ó */
382 /*** @ingroup m17nMtext */
384 @brief Variable of value MTEXT_FORMAT_UTF_16LE or MTEXT_FORMAT_UTF_16BE.
386 The global variable #MTEXT_FORMAT_UTF_16 is initialized to
387 #MTEXT_FORMAT_UTF_16LE on a "Little Endian" system (storing words
388 with the least significant byte first), and to
389 #MTEXT_FORMAT_UTF_16BE on a "Big Endian" system (storing words
390 with the most significant byte first). */
393 @brief Ãͤ¬ MTEXT_FORMAT_UTF_16LE ¤« MTEXT_FORMAT_UTF_16BE ¤Ç¤¢¤ëÊÑ¿ô
395 Âç°èÊÑ¿ô #MTEXT_FORMAT_UTF_16 ¤Ï¥ê¥È¥ë¡¦¥¨¥ó¥Ç¥£¥¢¥ó¡¦¥·¥¹¥Æ¥à
396 ¡Ê¥ï¡¼¥É¤ò LSB (Least Significant Byte) ¤òÀè¤Ë¤·¤Æ³ÊǼ¡Ë¾å¤Ç¤Ï
397 #MTEXT_FORMAT_UTF_16LE ¤Ë½é´ü²½¤µ¤ì¡¢¥Ó¥Ã¥°¡¦¥¨¥ó¥Ç¥£¥¢¥ó¡¦¥·¥¹¥Æ¥à
398 ¡Ê¥ï¡¼¥É¤ò MSB (Most Significant Byte) ¤òÀè¤Ë¤·¤Æ³ÊǼ¡Ë¾å¤Ç¤Ï
399 #MTEXT_FORMAT_UTF_16BE ¤Ë½é´ü²½¤µ¤ì¤ë¡£ */
403 mtext_from_data () */
405 extern const enum MTextFormat MTEXT_FORMAT_UTF_16;
408 /*** @ingroup m17nMtext */
410 @brief Variable of value MTEXT_FORMAT_UTF_32LE or MTEXT_FORMAT_UTF_32BE.
412 The global variable #MTEXT_FORMAT_UTF_32 is initialized to
413 #MTEXT_FORMAT_UTF_32LE on a "Little Endian" system (storing words
414 with the least significant byte first), and to
415 #MTEXT_FORMAT_UTF_32BE on a "Big Endian" system (storing
416 words with the most significant byte first). */
419 @brief Ãͤ¬ MTEXT_FORMAT_UTF_32LE ¤« MTEXT_FORMAT_UTF_32BE ¤Ç¤¢¤ëÊÑ¿ô
421 Âç°èÊÑ¿ô #MTEXT_FORMAT_UTF_32 ¤Ï¥ê¥È¥ë¡¦¥¨¥ó¥Ç¥£¥¢¥ó¡¦¥·¥¹¥Æ¥à
422 ¡Ê¥ï¡¼¥É¤ò LSB (Least Significant Byte) ¤òÀè¤Ë¤·¤Æ³ÊǼ¡Ë¾å¤Ç¤Ï
423 #MTEXT_FORMAT_UTF_32LE ¤Ë½é´ü²½¤µ¤ì¡¢¥Ó¥Ã¥°¡¦¥¨¥ó¥Ç¥£¥¢¥ó¡¦¥·¥¹¥Æ¥à
424 ¡Ê¥ï¡¼¥É¤ò MSB (Most Significant Byte) ¤òÀè¤Ë¤·¤Æ³ÊǼ¡Ë¾å¤Ç¤Ï
425 #MTEXT_FORMAT_UTF_32BE ¤Ë½é´ü²½¤µ¤ì¤ë¡£ */
429 mtext_from_data () */
431 extern const int MTEXT_FORMAT_UTF_32;
437 extern MText *mtext_from_data (const void *data, int nitems,
438 enum MTextFormat format);
444 * (5-2) Functions to manipulate M-texts. They correspond to string
445 * manipulating functions in libc.
446 * In the following functions, mtext_XXX() corresponds to strXXX().
449 extern int mtext_len (MText *mt);
451 extern int mtext_ref_char (MText *mt, int pos);
453 extern int mtext_set_char (MText *mt, int pos, int c);
455 extern MText *mtext_copy (MText *mt1, int pos, MText *mt2, int from, int to);
457 extern int mtext_compare (MText *mt1, int from1, int to1,
458 MText *mt2, int from2, int to2);
460 extern int mtext_case_compare (MText *mt1, int from1, int to1,
461 MText *mt2, int from2, int to2);
463 extern int mtext_character (MText *mt, int from, int to, int c);
465 extern int mtext_del (MText *mt, int from, int to);
467 extern int mtext_ins (MText *mt1, int pos, MText *mt2);
469 extern int mtext_insert (MText *mt1, int pos, MText *mt2, int from, int to);
471 extern int mtext_ins_char (MText *mt, int pos, int c, int n);
473 extern int mtext_replace (MText *mt1, int from1, int to1,
474 MText *mt2, int from2, int to2);
476 extern MText *mtext_cat_char (MText *mt, int c);
478 extern MText *mtext_duplicate (MText *mt, int from, int to);
480 extern MText *mtext_dup (MText *mt);
482 extern MText *mtext_cat (MText *mt1, MText *mt2);
484 extern MText *mtext_ncat (MText *mt1, MText *mt2, int n);
486 extern MText *mtext_cpy (MText *mt1, MText *mt2);
488 extern MText *mtext_ncpy (MText *mt1, MText *mt2, int n);
490 extern int mtext_chr (MText *mt, int c);
492 extern int mtext_rchr (MText *mt, int c);
494 extern int mtext_cmp (MText *mt1, MText *mt2);
496 extern int mtext_ncmp (MText *mt1, MText *mt2, int n);
498 extern int mtext_spn (MText *mt1, MText *mt2);
500 extern int mtext_cspn (MText *mt1, MText *mt2);
502 extern int mtext_pbrk (MText *mt1, MText *mt2);
504 extern int mtext_text (MText *mt1, int pos, MText *mt2);
506 extern int mtext_search (MText *mt1, int from, int to, MText *mt2);
508 extern MText *mtext_tok (MText *mt, MText *delim, int *pos);
510 extern int mtext_casecmp (MText *mt1, MText *mt2);
512 extern int mtext_ncasecmp (MText *mt1, MText *mt2, int n);
514 extern int mtext_lowercase (MText *mt);
516 extern int mtext_titlecase (MText *mt);
518 extern int mtext_uppercase (MText *mt);
521 @brief Enumeration for specifying a set of line breaking option.
523 The enum #MTextLineBreakOption is to control the line breaking
524 algorithm of the function mtext_line_break () by specifying
525 logical-or of the members in the arg @e option. */
527 enum MTextLineBreakOption
529 /***en Specify the legacy support for space character as base for
530 combining marks. See the section 8.3 of UAX#14. */
532 /***en Specify to use space characters for line breaking Korean
534 MTEXT_LBO_KOREAN_SP = 2,
535 /***en Specify to treat characters of ambiguous line-breaking
536 class as of ideographic line-breaking class. */
537 MTEXT_LBO_AI_AS_ID = 4,
541 extern int mtext_line_break (MText *mt, int pos, int option, int *after);
543 /*** @ingroup m17nPlist */
544 extern MPlist *mplist_deserialize (MText *mt);
547 * (5-3) Text properties
550 /*** @ingroup m17nCore */
551 /***en @defgroup m17nTextProperty Text Property */
552 /***ja @defgroup m17nTextProperty ¥Æ¥¥¹¥È¥×¥í¥Ñ¥Æ¥£ */
554 /*** @ingroup m17nTextProperty */
556 @brief Flag bits to control text property.
558 The mtext_property () function accepts logical OR of these flag
559 bits as an argument. They control the behaviour of the created
560 text property as described in the documentation of each flag
564 @brief ¥Æ¥¥¹¥È¥×¥í¥Ñ¥Æ¥£¤òÀ©¸æ¤¹¤ë¥Õ¥é¥°¥Ó¥Ã¥È.
566 ´Ø¿ô mtext_property () ¤Ï°Ê²¼¤Î¥Õ¥é¥°¥Ó¥Ã¥È¤ÎÏÀÍý
567 OR ¤ò°ú¿ô¤È¤·¤Æ¤È¤ë¤³¤È¤¬¤Ç¤¤ë¡£
568 ¥Õ¥é¥°¥Ó¥Ã¥È¤ÏÀ¸À®¤µ¤ì¤¿¥Æ¥¥¹¥È¥×¥í¥Ñ¥Æ¥£¤Î¿¶Éñ¤¤¤òÀ©¸æ¤¹¤ë¡£
569 ¾ÜºÙ¤Ï³Æ¥Õ¥é¥°¥Ó¥Ã¥È¤ÎÀâÌÀ¤ò»²¾È¡£*/
571 enum MTextPropertyControl
573 /***en If this flag bit is on, an M-text inserted at the start
574 position or at the middle of the text property inherits the
576 /***ja ¤³¤Î¥Ó¥Ã¥È¤¬ on ¤Ê¤é¤Ð¡¢¤³¤Î¥Æ¥¥¹¥È¥×¥í¥Ñ¥Æ¥£¤Î»Ï¤Þ¤ëÅÀ¤¢¤ë¤¤¤ÏÃæ´Ö¤ËÁÞÆþ¤µ¤ì¤¿
577 M-text ¤Ï¤³¤Î¥Æ¥¥¹¥È¥×¥í¥Ñ¥Æ¥£¤ò·Ñ¾µ¤¹¤ë¡£
579 MTEXTPROP_FRONT_STICKY = 0x01,
581 /***en If this flag bit is on, an M-text inserted at the end
582 position or at the middle of the text property inherits the
584 /***ja ¤³¤Î¥Ó¥Ã¥È¤¬ on ¤Ê¤é¤Ð¡¢¤³¤Î¥Æ¥¥¹¥È¥×¥í¥Ñ¥Æ¥£¤Î½ª¤ï¤ëÅÀ¤¢¤ë¤¤¤ÏÃæ´Ö¤ËÁÞÆþ¤µ¤ì¤¿
585 M-text ¤Ï¤³¤Î¥Æ¥¥¹¥È¥×¥í¥Ñ¥Æ¥£¤ò·Ñ¾µ¤¹¤ë¡£
587 MTEXTPROP_REAR_STICKY = 0x02,
589 /***en If this flag bit is on, the text property is removed if a
590 text in its region is modified. */
591 /***ja ¤³¤Î¥Ó¥Ã¥È¤¬ on ¤Ê¤é¤Ð¡¢¤³¤Î¥Æ¥¥¹¥È¥×¥í¥Ñ¥Æ¥£¤ÎÈÏ°ÏÆâ¤Î¥Æ¥¥¹¥È¤¬Êѹ¹¤µ¤ì¤¿¾ì¹ç¥Æ¥¥¹¥È¥×¥í¥Ñ¥Æ¥£¤Ï¼è¤ê½ü¤«¤ì¤ë¡£ */
592 MTEXTPROP_VOLATILE_WEAK = 0x04,
594 /***en If this flag bit is on, the text property is removed if a
595 text or the other text property in its region is modified. */
596 /***ja ¤³¤Î¥Ó¥Ã¥È¤¬ on ¤Ê¤é¤Ð¡¢¤³¤Î¥Æ¥¥¹¥È¥×¥í¥Ñ¥Æ¥£¤ÎÈÏ°ÏÆâ¤Î¥Æ¥¥¹¥È¤¢¤ë¤¤¤ÏÊ̤Υƥ¥¹¥È¥×¥í¥Ñ¥Æ¥£¤¬Êѹ¹¤µ¤ì¤¿¾ì¹ç¤³¤Î¥Æ¥
597 ¥¹¥È¥×¥í¥Ñ¥Æ¥£¤Ï¼è¤ê½ü¤«¤ì¤ë¡£*/
598 MTEXTPROP_VOLATILE_STRONG = 0x08,
600 /***en If this flag bit is on, the text property is not
601 automatically merged with the others. */
602 /***ja ¤³¤Î¥Ó¥Ã¥È¤¬ on ¤Ê¤é¤Ð¡¢¤³¤Î¥Æ¥¥¹¥È¥×¥í¥Ñ¥Æ¥£¤Ï¾¤Î¥×¥í¥Ñ¥Æ¥£¤È¼«Æ°Åª¤Ë¤Ï¥Þ¡¼¥¸¤µ¤ì¤Ê¤¤¡£ */
603 MTEXTPROP_NO_MERGE = 0x10,
605 MTEXTPROP_CONTROL_MAX = 0x1F
609 extern MSymbol Mtext_prop_serializer;
610 extern MSymbol Mtext_prop_deserializer;
613 /*** @ingroup m17nTextProperty */
615 @brief Type of serializer functions.
617 This is the type of serializer functions. If the key of a symbol
618 property is #Mtext_prop_serializer, the value must be of this
622 mtext_serialize (), #Mtext_prop_serializer
625 @brief ¥·¥ê¥¢¥é¥¤¥¶´Ø¿ô¤Î·¿Àë¸À.
627 ¥·¥ê¥¢¥é¥¤¥¶´Ø¿ô¤Î·¿¤Ç¤¢¤ë¡£ ¤¢¤ë¥·¥ó¥Ü¥ë¤Î¥×¥í¥Ñ¥Æ¥£¤Î¥¡¼¤¬ @c
628 #Mtext_prop_serializer ¤Ç¤¢¤ë¤È¤¡¢ ÃͤϤ³¤Î·¿¤Ç¤Ê¤¯¤Æ¤Ï¤Ê¤é¤Ê¤¤¡£
631 mtext_serialize (), #Mtext_prop_serializer
634 typedef MPlist *(*MTextPropSerializeFunc) (void *val);
636 /*** @ingroup m17nTextProperty */
638 @brief Type of deserializer functions.
640 This is the type of deserializer functions. If the key of a
641 symbol property is #Mtext_prop_deserializer, the value must be of
645 mtext_deserialize (), #Mtext_prop_deserializer
648 @brief ¥Ç¥·¥ê¥¢¥é¥¤¥¶´Ø¿ô¤Î·¿Àë¸À.
650 ¥Ç¥·¥ê¥¢¥é¥¤¥¶´Ø¿ô¤Î·¿¤Ç¤¢¤ë¡£ ¤¢¤ë¥·¥ó¥Ü¥ë¤Î¥×¥í¥Ñ¥Æ¥£¤Î¥¡¼¤¬ @c
651 #Msymbol_prop_deserializer ¤Ç¤¢¤ë¤È¤¡¢ ÃͤϤ³¤Î·¿¤Ç¤Ê¤¯¤Æ¤Ï¤Ê¤é¤Ê¤¤¡£
654 Mtext_prop_deserialize (), Mtext_prop_deserializer
656 typedef void *(*MTextPropDeserializeFunc) (MPlist *plist);
658 extern void *mtext_get_prop (MText *mt, int pos, MSymbol key);
660 extern int mtext_get_prop_values (MText *mt, int pos, MSymbol key,
661 void **values, int num);
663 extern int mtext_get_prop_keys (MText *mt, int pos, MSymbol **keys);
665 extern int mtext_put_prop (MText *mt, int from, int to,
666 MSymbol key, void *val);
668 extern int mtext_put_prop_values (MText *mt, int from, int to,
669 MSymbol key, void **values, int num);
671 extern int mtext_push_prop (MText *mt, int from, int to,
672 MSymbol key, void *val);
674 extern int mtext_pop_prop (MText *mt, int from, int to,
677 extern int mtext_prop_range (MText *mt, MSymbol key, int pos,
678 int *from, int *to, int deeper);
682 @ingroup m17nTextProperty */
684 @brief Type of text properties.
686 The type #MTextProperty is for a @e text @e property objects. Its
687 internal structure is concealed from application programs. */
689 @brief @c ¥Æ¥¥¹¥È¥×¥í¥Ñ¥Æ¥£¤Î·¿Àë¸À.
691 #MTextProperty ¤Ï @e ¥Æ¥¥¹¥È¥×¥í¥Ñ¥Æ¥£ ¥ª¥Ö¥¸¥§¥¯¥È¤Î·¿¤Ç¤¢¤ë¡£
692 ÆâÉô¹½Â¤¤Ï¥¢¥×¥ê¥±¡¼¥·¥ç¥ó¥×¥í¥°¥é¥à¤«¤é¤Ï¸«¤¨¤Ê¤¤¡£ */
694 typedef struct MTextProperty MTextProperty;
698 extern MTextProperty *mtext_property (MSymbol key, void *val,
701 extern MText *mtext_property_mtext (MTextProperty *prop);
703 extern MSymbol mtext_property_key (MTextProperty *prop);
705 extern void *mtext_property_value (MTextProperty *prop);
707 extern int mtext_property_start (MTextProperty *prop);
709 extern int mtext_property_end (MTextProperty *prop);
711 extern MTextProperty *mtext_get_property (MText *mt, int pos, MSymbol key);
713 extern int mtext_get_properties (MText *mt, int pos, MSymbol key,
714 MTextProperty **props, int num);
716 extern int mtext_attach_property (MText *mt, int from, int to,
717 MTextProperty *prop);
719 extern int mtext_detach_property (MTextProperty *prop);
721 extern int mtext_push_property (MText *mt, int from, int to,
722 MTextProperty *prop);
724 extern MText *mtext_serialize (MText *mt, int from, int to,
725 MPlist *property_list);
727 extern MText *mtext_deserialize (MText *mt);
733 #endif /* _M17N_CORE_H_ */