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