src/m17n-core.h

   1 /* m17n-core.h -- header file for the CORE API of the m17n library.
   2    Copyright (C) 2003, 2004
   3      National Institute of Advanced Industrial Science and Technology (AIST)
   4      Registration Number H15PRO112
   5
   6    This file is part of the m17n library.
   7
   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.
  12
  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.
  17
  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
  21    02111-1307, USA.  */
  22
  23 #ifndef _M17N_CORE_H_
  24 #define _M17N_CORE_H_
  25
  26 #ifdef __cplusplus
  27 extern "C"
  28 {
  29 #endif
  30
  31 /*
  32  * Header file for m17n library.
  33  */
  34
  35 /* (C1) Introduction */
  36
  37 /***en @defgroup m17nIntro Introduction  */
  38 /***ja @defgroup m17nIntro ¤Ï¤¸¤á¤Ë  */
  39 /*=*/
  40
  41 #define M17NLIB_MAJOR_VERSION 1
  42 #define M17NLIB_MINOR_VERSION 1
  43 #define M17NLIB_PATCH_LEVEL 0
  44 #define M17NLIB_VERSION_NAME "1.1.0"
  45
  46 extern void m17n_init_core (void);
  47 #define M17N_INIT() m17n_init_core ()
  48 extern void m17n_fini_core (void);
  49 #define M17N_FINI() m17n_fini_core ()
  50
  51 /*=*/
  52
  53 /*** @ingroup m17nIntro */
  54 /***en
  55     @brief Enumeration for the status of the m17n library.
  56
  57     The enum #MTextStatus is used as a return value of the function
  58     m17n_status ().  */
  59
  60 /***ja
  61     @brief  m17n ¥é¥¤¥Ö¥é¥ê¤Î¾õÂÖ¤ò¼¨¤¹Îóµó·¿.
  62
  63     Îóµó·¿ #MTextStatus ¤Ï´Ø¿ô m17n_status () ¤ÎÌá¤êÃÍ¤È¤·¤ÆÍÑ¤¤¤é¤ì¤ë¡£ */
  64
  65 enum M17NStatus
  66   {
  67     /***en No modules is initialized, and all modules are finalized.  */
  68     M17N_NOT_INITIALIZED,
  69     /***en Only the modules in CORE API are initialized.  */
  70     M17N_CORE_INITIALIZED,
  71     /***en Only the modules in CORE and SHELL APIs are initialized.  */
  72     M17N_SHELL_INITIALIZED,
  73     /***en All modules are initialized.  */
  74     M17N_GUI_INITIALIZED
  75   };
  76
  77 /*=*/
  78
  79 extern enum M17NStatus m17n_status (void);
  80
  81 /***en @defgroup m17nCore CORE API  */
  82 /***ja @defgroup m17nCore ¥³¥¢ API */
  83 /*=*/
  84 /*** @ingroup m17nCore */
  85 /***en @defgroup m17nObject Managed Object */
  86 /***ja @defgroup m17nObject ´ÉÍý²¼¥ª¥Ö¥¸¥§¥¯¥È */
  87 /*=*/
  88
  89 /*** @ingroup m17nObject  */
  90 /***en
  91     @brief The first member of a managed object.
  92
  93     When an application program defines a new structure for managed
  94     objects, its first member must be of the type @c struct
  95     #M17NObjectHead.  Its contents are used by the m17n library, and
  96     application programs should never touch them.  */
  97 /***ja
  98     @brief ´ÉÍý²¼¥ª¥Ö¥¸¥§¥¯¥È¤ÎºÇ½é¤Î¥á¥ó¥Ð.
  99
 100     ¥¢¥×¥ê¥±¡¼¥·¥ç¥ó¥×¥í¥°¥é¥à¤¬¿·¤·¤¤¹½Â¤ÂÎ¤ò´ÉÍý²¼¥ª¥Ö¥¸¥§¥¯¥È¤È¤·¤Æ
 101      ÄêµÁ¤¹¤ëºÝ¤Ë¤Ï¡¢ºÇ½é¤Î¥á¥ó¥Ð¤Ï @c #M17NObjectHead ¹½Â¤ÂÎ·¿¤Ç¤Ê¤¯
 102      ¤Æ¤Ï¤Ê¤é¤Ê¤¤¡£@c #M17NObjectHead ¤ÎÆâÍÆ¤Ï m17n ¥é¥¤¥Ö¥é¥ê¤¬»ÈÍÑ¤¹
 103      ¤ë¤Î¤Ç¡¢¥¢¥×¥ê¥±¡¼¥·¥ç¥ó¥×¥í¥°¥é¥à¤Ï¿¨¤ì¤Æ¤Ï¤Ê¤é¤Ê¤¤¡£
 104      */
 105
 106 typedef struct
 107 {
 108   void *filler[2];
 109 } M17NObjectHead;
 110
 111 /*=*/
 112
 113 /* Return a newly allocated managed object.  */
 114 extern void *m17n_object_setup (int size, void (*freer) (void *));
 115
 116 /* Increment the reference count of managed object OBJECT.  */
 117 extern int m17n_object_ref (void *object);
 118
 119 /* Decrement the reference count of managed object OBJECT.  */
 120 extern int m17n_object_unref (void *object);
 121
 122 /*=*/
 123
 124 /* (C2) Symbol handling */
 125
 126 /*** @ingroup m17nCore */
 127 /***en @defgroup m17nSymbol Symbol  */
 128 /***ja @defgroup m17nSymbol ¥·¥ó¥Ü¥ë */
 129 /*=*/
 130
 131 /***
 132     @ingroup m17nSymbol */
 133 /***en
 134     @brief Type of symbols.
 135
 136     The type #MSymbol is for a @e symbol object.  Its internal
 137     structure is concealed from application programs.  */
 138
 139 /***ja
 140     @brief ¥·¥ó¥Ü¥ë¤Î·¿Àë¸À.
 141
 142     #MSymbol ¤Ï¥·¥ó¥Ü¥ë¥ª¥Ö¥¸¥§¥¯¥È¤Î·¿¤Ç¤¢¤ë¡£ÆâÉô¹½Â¤¤Ï¥¢¥×¥ê¥±¡¼¥·¥ç
 143     ¥ó¥×¥í¥°¥é¥à¤«¤é¤Ï¸«¤¨¤Ê¤¤¡£  */
 144
 145 typedef struct MSymbolStruct *MSymbol;
 146
 147 /*=*/
 148
 149 /* Predefined symbols. */
 150 extern MSymbol Mnil;
 151 extern MSymbol Mt;
 152 extern MSymbol Mstring;
 153 extern MSymbol Msymbol;
 154 extern MSymbol Mtext;
 155
 156 /* Return a symbol of name NAME.  */
 157 extern MSymbol msymbol (const char *name);
 158
 159 /* Return a managing key of name NAME.  */
 160 extern MSymbol msymbol_as_managing_key (const char *name);
 161
 162 /* Return a symbol of name NAME if it already exists.  */
 163 extern MSymbol msymbol_exist (const char *name);
 164
 165 /* Return the name of SYMBOL.  */
 166 extern char *msymbol_name (MSymbol symbol);
 167
 168 /* Give SYMBOL KEY property with value VALUE.  */
 169 extern int msymbol_put (MSymbol symbol, MSymbol key, void *val);
 170
 171 /*** Return KEY property value of SYMBOL.  */
 172 extern void *msymbol_get (MSymbol symbol, MSymbol key);
 173
 174 /*
 175  *  (2-1) Property List
 176  */
 177 /*=*/
 178 /*** @ingroup m17nCore */
 179 /***en @defgroup m17nPlist Property List */
 180 /***ja @defgroup m17nPlist ¥×¥í¥Ñ¥Æ¥£¥ê¥¹¥È */
 181 /*=*/
 182
 183 /***
 184     @ingroup m17nPlist */
 185 /***en
 186     @brief Type of property list objects.
 187
 188     The type #MPlist is for a @e property @e list object.  Its internal
 189     structure is concealed from application programs.  */
 190
 191 /***ja
 192     @brief ¥×¥í¥Ñ¥Æ¥£¥ê¥¹¥È¡¦¥ª¥Ö¥¸¥§¥¯¥È¤Î·¿Àë¸À.
 193
 194     #MPlist ¤Ï @e ¥×¥í¥Ñ¥Æ¥£¥ê¥¹¥È (Property list) ¥ª¥Ö¥¸¥§¥¯¥È¤Î·¿¤Ç¤¢¤ë¡£
 195     ÆâÉô¹½Â¤¤Ï¥¢¥×¥ê¥±¡¼¥·¥ç¥ó¥×¥í¥°¥é¥à¤«¤é¤Ï¸«¤¨¤Ê¤¤¡£  */
 196
 197 typedef struct MPlist MPlist;
 198
 199 /*=*/
 200
 201 extern MSymbol Mplist, Minteger;
 202
 203 extern MPlist *mplist ();
 204
 205 extern MPlist *mplist_copy (MPlist *plist);
 206
 207 extern MPlist *mplist_add (MPlist *plist, MSymbol key, void *val);
 208
 209 extern MPlist *mplist_push (MPlist *plist, MSymbol key, void *val);
 210
 211 extern void *mplist_pop (MPlist *plist);
 212
 213 extern MPlist *mplist_put (MPlist *plist, MSymbol key, void *val);
 214
 215 extern void *mplist_get (MPlist *plist, MSymbol key);
 216
 217 extern MPlist *mplist_find_by_key (MPlist *plist, MSymbol key);
 218
 219 extern MPlist *mplist_find_by_value (MPlist *plist, void *val);
 220
 221 extern MPlist *mplist_next (MPlist *plist);
 222
 223 extern MPlist *mplist_set (MPlist *plist, MSymbol key, void *val);
 224
 225 extern int mplist_length (MPlist *plist);
 226
 227 extern MSymbol mplist_key (MPlist *plist);
 228
 229 extern void *mplist_value (MPlist *plist);
 230
 231 /* (S1) Characters */
 232
 233 /*=*/
 234 /*** @ingroup m17nCore */
 235 /***en @defgroup m17nCharacter Character */
 236 /***ja @defgroup m17nCharacter Ê¸»ú */
 237 /*=*/
 238
 239 #define MCHAR_MAX 0x3FFFFF
 240 /*#define MCHAR_MAX 0x7FFFFFFF*/
 241
 242 extern MSymbol Mscript;
 243 extern MSymbol Mname;
 244 extern MSymbol Mcategory;
 245 extern MSymbol Mcombining_class;
 246 extern MSymbol Mbidi_category;
 247 extern MSymbol Msimple_case_folding;
 248 extern MSymbol Mcomplicated_case_folding;
 249
 250 extern MSymbol mchar_define_property (const char *name, MSymbol type);
 251
 252 extern void *mchar_get_prop (int c, MSymbol key);
 253
 254 extern int mchar_put_prop (int c, MSymbol key, void *val);
 255
 256 /* (C3) Handling chartable */
 257
 258 /*** @ingroup m17nCore */
 259 /***en @defgroup m17nChartable Chartable */
 260 /***ja @defgroup m17nChartable Ê¸»ú¥Æ¡¼¥Ö¥ë */
 261 /*=*/
 262 extern MSymbol Mchar_table;
 263
 264 /***
 265     @ingroup m17nChartable */
 266 /***en
 267     @brief Type of chartables.
 268
 269     The type #MCharTable is for a @e chartable objects.  Its
 270     internal structure is concealed from application programs.  */
 271
 272 /***ja
 273     @brief Ê¸»ú¥Æ¡¼¥Ö¥ë¤Î·¿Àë¸À.
 274
 275     #MCharTable ¤Ï @e Ê¸»ú¥Æ¡¼¥Ö¥ë (chartable) ¥ª¥Ö¥¸¥§¥¯¥È¤Î·¿¤Ç¤¢¤ë¡£
 276     ÆâÉô¹½Â¤¤Ï¥¢¥×¥ê¥±¡¼¥·¥ç¥ó¥×¥í¥°¥é¥à¤«¤é¤Ï¸«¤¨¤Ê¤¤¡£  */
 277
 278 typedef struct MCharTable MCharTable;
 279 /*=*/
 280
 281 extern MCharTable *mchartable (MSymbol key, void *default_value);
 282
 283 extern void *mchartable_lookup (MCharTable *table, int c);
 284
 285 extern int mchartable_set (MCharTable *table, int c, void *val);
 286
 287 extern int mchartable_set_range (MCharTable *table, int from, int to,
 288                                  void *val);
 289
 290 extern int mchartable_map (MCharTable *table, void *ignore,
 291                            void (*func) (int from, int to,
 292                                          void *val, void *arg),
 293                            void *func_arg);
 294
 295 extern void mchartable_range (MCharTable *table, int *from, int *to);
 296
 297 /*
 298  *  (5) Handling M-text.
 299  *      "M" of M-text stands for:
 300  *      o Multilingual
 301  *      o Metamorphic
 302  *      o More than string
 303  */
 304
 305 /*** @ingroup m17nCore */
 306 /***en @defgroup m17nMtext M-text */
 307 /***ja @defgroup m17nMtext M-text */
 308 /*=*/
 309
 310 /*
 311  * (5-1) M-text basics
 312  */
 313 /*=*/
 314 /*** @ingroup m17nMtext */
 315 /***en
 316     @brief Type of @e M-texts.
 317
 318     The type #MText is for an @e M-text object.  Its internal
 319     structure is concealed from application programs.  */
 320
 321 /***ja
 322     @brief @e MText ¤Î·¿Àë¸À.
 323
 324     #Mtext ¤Ï @e M-text ¥ª¥Ö¥¸¥§¥¯¥È¤Î·¿¤Ç¤¢¤ë¡£
 325     ÆâÉô¹½Â¤¤Ï¥¢¥×¥ê¥±¡¼¥·¥ç¥ó¥×¥í¥°¥é¥à¤«¤é¤Ï¸«¤¨¤Ê¤¤¡£
 326
 327     @latexonly \IPAlabel{MText} @endlatexonly
 328     @latexonly \IPAlabel{MText->MPlist} @endlatexonly  */
 329
 330 typedef struct MText MText;
 331
 332 /*=*/
 333
 334 extern MText *mtext ();
 335
 336 /*=*/
 337
 338 /***en
 339     @brief Enumeration for specifying the format of an M-text.
 340
 341     The enum #MTextFormat is used as an argument of the
 342     mtext_from_data () function to specify the format of data from
 343     which an M-text is created.  */
 344
 345 /***ja
 346     @brief M-text ¤Î¥Õ¥©¡¼¥Þ¥Ã¥È¤ò»ØÄê¤¹¤ëÎóµó·¿.
 347
 348     Îóµó·¿ #MTextFormat ¤Ï
 349     ´Ø¿ô mtext_from_data () ¤Î°ú¿ô¤È¤·¤ÆÍÑ¤¤¤é¤ì¡¢
 350     M-text ¤òÀ¸À®¤¹¤ë¸µ¤È¤Ê¤ë¥Ç¡¼¥¿¤Î¥Õ¥©¡¼¥Þ¥Ã¥È¤ò»ØÄê¤¹¤ë¡£  */
 351
 352 enum MTextFormat
 353   {
 354     MTEXT_FORMAT_US_ASCII,
 355     MTEXT_FORMAT_UTF_8,
 356     MTEXT_FORMAT_UTF_16LE,
 357     MTEXT_FORMAT_UTF_16BE,
 358     MTEXT_FORMAT_UTF_32LE,
 359     MTEXT_FORMAT_UTF_32BE,
 360     MTEXT_FORMAT_MAX
 361   };
 362 /*=*/
 363
 364 extern const enum MTextFormat MTEXT_FORMAT_UTF_16;
 365 extern const enum MTextFormat MTEXT_FORMAT_UTF_32;
 366
 367 /*=*/
 368
 369 extern MText *mtext_from_data (const void *data, int nitems,
 370                                enum MTextFormat format);
 371
 372
 373 /*=*/
 374
 375 /*
 376  *  (5-2) Functions to manipulate M-texts.  They correspond to string
 377  *   manipulating functions in libc.
 378  *   In the following functions, mtext_XXX() corresponds to strXXX().
 379  */
 380
 381 extern int mtext_len (MText *mt);
 382
 383 extern int mtext_ref_char (MText *mt, int pos);
 384
 385 extern int mtext_set_char (MText *mt, int pos, int c);
 386
 387 extern MText *mtext_copy (MText *mt1, int pos, MText *mt2, int from, int to);
 388
 389 extern int mtext_compare (MText *mt1, int from1, int to1,
 390                           MText *mt2, int from2, int to2);
 391
 392 extern int mtext_case_compare (MText *mt1, int from1, int to1,
 393                                MText *mt2, int from2, int to2);
 394
 395 extern int mtext_character (MText *mt, int from, int to, int c);
 396
 397 extern int mtext_del (MText *mt, int from, int to);
 398
 399 extern int mtext_ins (MText *mt1, int pos, MText *mt2);
 400
 401 extern int mtext_ins_char (MText *mt, int pos, int c, int n);
 402
 403 extern MText *mtext_cat_char (MText *mt, int c);
 404
 405 extern MText *mtext_duplicate (MText *mt, int from, int to);
 406
 407 extern MText *mtext_dup (MText *mt);
 408
 409 extern MText *mtext_cat (MText *mt1, MText *mt2);
 410
 411 extern MText *mtext_ncat (MText *mt1, MText *mt2, int n);
 412
 413 extern MText *mtext_cpy (MText *mt1, MText *mt2);
 414
 415 extern MText *mtext_ncpy (MText *mt1, MText *mt2, int n);
 416
 417 extern int mtext_chr (MText *mt, int c);
 418
 419 extern int mtext_rchr (MText *mt, int c);
 420
 421 extern int mtext_cmp (MText *mt1, MText *mt2);
 422
 423 extern int mtext_ncmp (MText *mt1, MText *mt2, int n);
 424
 425 extern int mtext_spn (MText *mt1, MText *mt2);
 426
 427 extern int mtext_cspn (MText *mt1, MText *mt2);
 428
 429 extern int mtext_pbrk (MText *mt1, MText *mt2);
 430
 431 extern int mtext_text (MText *mt1, int pos, MText *mt2);
 432
 433 extern int mtext_search (MText *mt1, int from, int to, MText *mt2);
 434
 435 extern MText *mtext_tok (MText *mt, MText *delim, int *pos);
 436
 437 extern int mtext_casecmp (MText *mt1, MText *mt2);
 438
 439 extern int mtext_ncasecmp (MText *mt1, MText *mt2, int n);
 440
 441 /*** @ingroup m17nPlist */
 442 extern MPlist *mplist_deserialize (MText *mt);
 443
 444 /*
 445  * (5-3) Text properties
 446  */
 447 /*=*/
 448 /*** @ingroup m17nCore */
 449 /***en @defgroup m17nTextProperty Text Property */
 450 /***ja @defgroup m17nTextProperty ¥Æ¥¥¹¥È¥×¥í¥Ñ¥Æ¥£ */
 451 /*=*/
 452 /*** @ingroup m17nTextProperty */
 453 /***en
 454     @brief Flag bits to control text property.
 455
 456     The mtext_property () funciton accepts logical OR of these flag
 457     bits as an argument.  They control the behaviour of the created
 458     text property as described in the documentation of each flag
 459     bit.  */
 460
 461 /***ja
 462     @brief ¥Æ¥¥¹¥È¥×¥í¥Ñ¥Æ¥£¤òÀ©¸æ¤¹¤ë¥Õ¥é¥°¥Ó¥Ã¥È.
 463
 464     ´Ø¿ô mtext_property () ¤Ï°Ê²¼¤Î¥Õ¥é¥°¥Ó¥Ã¥È¤ÎÏÀÍý OR ¤ò°ú¿ô¤È¤·¤Æ
 465     ¤È¤ë¤³¤È¤¬¤Ç¤¤ë¡£¥Õ¥é¥°¥Ó¥Ã¥È¤ÏÀ¸À®¤µ¤ì¤¿¥Æ¥¥¹¥È¥×¥í¥Ñ¥Æ¥£¤Î¿¶Éñ
 466     ¤¤¤òÀ©¸æ¤¹¤ë¡£¾ÜºÙ¤Ï³Æ¥Õ¥é¥°¥Ó¥Ã¥È¤ÎÀâÌÀ¤ò»²¾È¡£*/
 467
 468 enum MTextPropertyControl
 469   {
 470     /***en If this flag bit is on, an M-text inserted at the start
 471         position or at the middle of the text property inherits the
 472         text property.  */
 473     /***ja ¤³¤Î¥Ó¥Ã¥È¤¬ on ¤Ê¤é¤Ð¡¢¤³¤Î¥Æ¥¥¹¥È¥×¥í¥Ñ¥Æ¥£¤Î»Ï¤Þ¤ëÅÀ¤¢
 474         ¤ë¤¤¤ÏÃæ´Ö¤ËÁÞÆþ¤µ¤ì¤¿ M-text ¤Ï¤³¤Î¥Æ¥¥¹¥È¥×¥í¥Ñ¥Æ¥£¤ò·Ñ¾µ¤¹¤ë¡£
 475         */
 476     MTEXTPROP_FRONT_STICKY = 0x01,
 477
 478     /***en If this flag bit is on, an M-text inserted at the end
 479         position or at the middle of the text property inherits the
 480         text property.  */
 481     /***ja ¤³¤Î¥Ó¥Ã¥È¤¬ on ¤Ê¤é¤Ð¡¢¤³¤Î¥Æ¥¥¹¥È¥×¥í¥Ñ¥Æ¥£¤Î½ª¤ï¤ëÅÀ¤¢
 482         ¤ë¤¤¤ÏÃæ´Ö¤ËÁÞÆþ¤µ¤ì¤¿ M-text ¤Ï¤³¤Î¥Æ¥¥¹¥È¥×¥í¥Ñ¥Æ¥£¤ò·Ñ¾µ¤¹¤ë¡£
 483         */
 484     MTEXTPROP_REAR_STICKY = 0x02,
 485
 486     /***en If this flag bit is on, the text property is removed if a
 487         text in its region is modified.  */
 488     /***ja ¤³¤Î¥Ó¥Ã¥È¤¬ on ¤Ê¤é¤Ð¡¢¤³¤Î¥Æ¥¥¹¥È¥×¥í¥Ñ¥Æ¥£¤ÎÈÏ°ÏÆâ¤Î
 489         ¥Æ¥¥¹¥È¤¬ÊÑ¹¹¤µ¤ì¤¿¾ì¹ç¥Æ¥¥¹¥È¥×¥í¥Ñ¥Æ¥£¤Ï¼è¤ê½ü¤«¤ì¤ë¡£  */
 490     MTEXTPROP_VOLATILE_WEAK = 0x04,
 491
 492     /***en If this flag bit is on, the text property is removed if a
 493         text or the other text property in its region is modified.  */
 494     /***ja ¤³¤Î¥Ó¥Ã¥È¤¬ on ¤Ê¤é¤Ð¡¢¤³¤Î¥Æ¥¥¹¥È¥×¥í¥Ñ¥Æ¥£¤ÎÈÏ°ÏÆâ¤Î
 495         ¥Æ¥¥¹¥È¤¢¤ë¤¤¤ÏÊÌ¤Î¥Æ¥¥¹¥È¥×¥í¥Ñ¥Æ¥£¤¬ÊÑ¹¹¤µ¤ì¤¿¾ì¹ç¤³¤Î¥Æ¥
 496         ¥¹¥È¥×¥í¥Ñ¥Æ¥£¤Ï¼è¤ê½ü¤«¤ì¤ë¡£*/
 497     MTEXTPROP_VOLATILE_STRONG = 0x08,
 498
 499     /***en If this flag bit is on, the text property is not
 500         automatically merged with the others.  */
 501     /***ja ¤³¤Î¥Ó¥Ã¥È¤¬ on ¤Ê¤é¤Ð¡¢¤³¤Î¥Æ¥¥¹¥È¥×¥í¥Ñ¥Æ¥£¤ÏÂ¾¤Î¥×¥í¥Ñ
 502         ¥Æ¥£¤È¼«Æ°Åª¤Ë¤Ï¥Þ¡¼¥¸¤µ¤ì¤Ê¤¤¡£ */
 503     MTEXTPROP_NO_MERGE = 0x10,
 504
 505     MTEXTPROP_CONTROL_MAX = 0x1F
 506   };
 507
 508 /*=*/
 509 extern MSymbol Mtext_prop_serializer;
 510 extern MSymbol Mtext_prop_deserializer;
 511
 512
 513 /*** @ingroup m17nTextProperty */
 514 /***en
 515     @brief Type of serializer functions.
 516
 517     This is the type of serializer functions.  If the key of a symbol
 518     property is #Msymbol_prop_serializer, the value must be of this
 519     type.
 520
 521     @seealso Mtext_prop_serialize (), Mtext_prop_serializer
 522 */
 523 /***ja
 524     @brief ¥·¥ê¥¢¥é¥¤¥¶´Ø¿ô¤Î·¿Àë¸À.
 525
 526     ¥·¥ê¥¢¥é¥¤¥¶´Ø¿ô¤Î·¿¤Ç¤¢¤ë¡£ ¤¢¤ë¥·¥ó¥Ü¥ë¤Î¥×¥í¥Ñ¥Æ¥£¤Î¥¡¼¤¬ @c
 527     #Msymbol_prop_serializer ¤Ç¤¢¤ë¤È¤¡¢ ÃÍ¤Ï¤³¤Î·¿¤Ç¤Ê¤¯¤Æ¤Ï¤Ê¤é¤Ê¤¤¡£
 528
 529     @seealso Mtext_prop_serialize (), Mtext_prop_serializer
 530 */
 531
 532 typedef MPlist *(*MTextPropSerializeFunc) (void *val);
 533
 534 /*** @ingroup m17nTextProperty */
 535 /***en
 536     @brief Type of deserializer functions.
 537
 538     This is the type of deserializer functions.  If the key of a
 539     symbol property is #Msymbol_prop_deserializer, the value must be
 540     of this type.
 541
 542     @seealso Mtext_prop_deserialize (), Mtext_prop_deserializer
 543 */
 544 /***ja
 545     @brief ¥Ç¥·¥ê¥¢¥é¥¤¥¶´Ø¿ô¤Î·¿Àë¸À.
 546
 547     ¥Ç¥·¥ê¥¢¥é¥¤¥¶´Ø¿ô¤Î·¿¤Ç¤¢¤ë¡£ ¤¢¤ë¥·¥ó¥Ü¥ë¤Î¥×¥í¥Ñ¥Æ¥£¤Î¥¡¼¤¬ @c
 548     #Msymbol_prop_deserializer ¤Ç¤¢¤ë¤È¤¡¢ ÃÍ¤Ï¤³¤Î·¿¤Ç¤Ê¤¯¤Æ¤Ï¤Ê¤é¤Ê¤¤¡£
 549
 550     @seealso Mtext_prop_deserialize (), Mtext_prop_deserializer
 551 */
 552 typedef void *(*MTextPropDeserializeFunc) (MPlist *plist);
 553
 554 extern void *mtext_get_prop (MText *mt, int pos, MSymbol key);
 555
 556 extern int mtext_get_prop_values (MText *mt, int pos, MSymbol key,
 557                                   void **values, int num);
 558
 559 extern int mtext_get_prop_keys (MText *mt, int pos, MSymbol **keys);
 560
 561 extern int mtext_put_prop (MText *mt, int from, int to,
 562                            MSymbol key, void *val);
 563
 564 extern int mtext_put_prop_values (MText *mt, int from, int to,
 565                                   MSymbol key, void **values, int num);
 566
 567 extern int mtext_push_prop (MText *mt, int from, int to,
 568                             MSymbol key, void *val);
 569
 570 extern int mtext_pop_prop (MText *mt, int from, int to,
 571                            MSymbol key);
 572
 573 extern int mtext_change_prop (MText *mt, int from, int to,
 574                               MSymbol key,
 575                               int (*func) (int, void ***, int *));
 576
 577 extern int mtext_prop_range (MText *mt, MSymbol key, int pos,
 578                              int *from, int *to, int deeper);
 579
 580 /*=*/
 581 typedef struct MTextProperty MTextProperty;
 582
 583 /*=*/
 584
 585 extern MTextProperty *mtext_property (MSymbol key, void *val,
 586                                       int control_bits);
 587
 588 extern MText *mtext_property_mtext (MTextProperty *prop);
 589
 590 extern MSymbol mtext_property_key (MTextProperty *prop);
 591
 592 extern void *mtext_property_value (MTextProperty *prop);
 593
 594 extern int mtext_property_start (MTextProperty *prop);
 595
 596 extern int mtext_property_end (MTextProperty *prop);
 597
 598 extern MTextProperty *mtext_get_property (MText *mt, int pos, MSymbol key);
 599
 600 extern int mtext_get_properties (MText *mt, int pos, MSymbol key,
 601                                  MTextProperty **props, int num);
 602
 603 extern int mtext_attach_property (MText *mt, int from, int to,
 604                                   MTextProperty *prop);
 605
 606 extern int mtext_detach_property (MTextProperty *prop);
 607
 608 extern int mtext_push_property (MText *mt, int from, int to,
 609                                 MTextProperty *prop);
 610
 611 extern MText *mtext_serialize (MText *mt, int from, int to,
 612                                MPlist *property_list);
 613
 614 extern MText *mtext_deserialize (MText *mt);
 615
 616 #ifdef __cplusplus
 617 }
 618 #endif
 619
 620 #endif /* _M17N_CORE_H_ */
 621
 622 /*
 623   Local Variables:
 624   coding: euc-japan
 625   End:
 626 */