*** empty log message ***

[m17n/m17n-lib.git] / src / m17n-core.h

diff --git a/src/m17n-core.h b/src/m17n-core.h
index 0cd111c..0e4f4bf 100644 (file)
--- a/src/m17n-core.h
+++ b/src/m17n-core.h
@@ -49,7 +49,7 @@ extern void m17n_fini_core (void);
 #define M17N_FINI() m17n_fini_core ()
 
 /***en @defgroup m17nCore CORE API  */
-/***ja @defgroup m17nCore CORE API */
+/***ja @defgroup m17nCore ¥³¥¢ API */
 /*=*/
 /*** @ingroup m17nCore */
 /***en @defgroup m17nObject Managed Object */
@@ -64,6 +64,14 @@ extern void m17n_fini_core (void);
     objects, its first member must be of the type @c struct
     #M17NObjectHead.  Its contents are used by the m17n library, and
     application programs should never touch them.  */
+/***ja
+    @brief ´ÉÍý²¼¥ª¥Ö¥¸¥§¥¯¥È¤ÎºÇ½é¤Î¥á¥ó¥Ð.
+
+    ¥¢¥×¥ê¥±¡¼¥·¥ç¥ó¥×¥í¥°¥é¥à¤¬¿·¤·¤¤¹½Â¤ÂΤò´ÉÍý²¼¥ª¥Ö¥¸¥§¥¯¥È¤È¤·¤Æ
+     ÄêµÁ¤¹¤ëºÝ¤Ë¤Ï¡¢ºÇ½é¤Î¥á¥ó¥Ð¤Ï @c #M17NObjectHead ¹½Â¤Âη¿¤Ç¤Ê¤¯
+     ¤Æ¤Ï¤Ê¤é¤Ê¤¤¡£@c #M17NObjectHead ¤ÎÆâÍÆ¤Ï m17n ¥é¥¤¥Ö¥é¥ê¤¬»ÈÍѤ¹
+     ¤ë¤Î¤Ç¡¢¥¢¥×¥ê¥±¡¼¥·¥ç¥ó¥×¥í¥°¥é¥à¤Ï¿¨¤ì¤Æ¤Ï¤Ê¤é¤Ê¤¤¡£
+     */
 
 typedef struct
 {
@@ -99,9 +107,10 @@ extern int m17n_object_unref (void *object);
     structure is concealed from application programs.  */
 
 /***ja
-    @brief ¥·¥ó¥Ü¥ë¤Î·¿
+    @brief ¥·¥ó¥Ü¥ë¤Î·¿Àë¸À
 
-    #MSymbol ¤Ï¥·¥ó¥Ü¥ë¥ª¥Ö¥¸¥§¥¯¥È¤Î·¿¤Ø¤Î¥Ý¥¤¥ó¥¿¤Ç¤¢¤ë¡£ */
+    #MSymbol ¤Ï¥·¥ó¥Ü¥ë¥ª¥Ö¥¸¥§¥¯¥È¤Î·¿¤Ç¤¢¤ë¡£ÆâÉô¹½Â¤¤Ï¥¢¥×¥ê¥±¡¼¥·¥ç
+    ¥ó¥×¥í¥°¥é¥à¤«¤é¤Ï¸«¤¨¤Ê¤¤¡£  */
 
 typedef struct MSymbol *MSymbol;
 
@@ -135,10 +144,10 @@ extern void *msymbol_get (MSymbol symbol, MSymbol key);
 /* 
  *  (2-1) Property List
  */
-
+/*=*/
 /*** @ingroup m17nCore */
 /***en @defgroup m17nPlist Property List */
-/***ja @defgroup m17nPlist ¥×¥í¥Ñ¥Æ¥£¥ê¥¹¥È¡¦¥ª¥Ö¥¸¥§¥¯¥È */
+/***ja @defgroup m17nPlist ¥×¥í¥Ñ¥Æ¥£¥ê¥¹¥È */
 /*=*/
 
 /***
@@ -146,9 +155,15 @@ extern void *msymbol_get (MSymbol symbol, MSymbol key);
 /***en
     @brief Type of property list objects.
 
-    The type #MPlist is for a property list object.  Its internal
+    The type #MPlist is for a @e property @e list object.  Its internal
     structure is concealed from application programs.  */
 
+/***ja
+    @brief ¥×¥í¥Ñ¥Æ¥£¥ê¥¹¥È¡¦¥ª¥Ö¥¸¥§¥¯¥È¤Î·¿Àë¸À.
+
+    #MPlist ¤Ï @e ¥×¥í¥Ñ¥Æ¥£¥ê¥¹¥È (Property list) ¥ª¥Ö¥¸¥§¥¯¥È¤Î·¿¤Ç¤¢¤ë¡£
+    ÆâÉô¹½Â¤¤Ï¥¢¥×¥ê¥±¡¼¥·¥ç¥ó¥×¥í¥°¥é¥à¤«¤é¤Ï¸«¤¨¤Ê¤¤¡£  */
+
 typedef struct MPlist MPlist;
 
 /*=*/
@@ -225,9 +240,9 @@ extern MSymbol Mchar_table;
     internal structure is concealed from application programs.  */
 
 /***ja
-    @brief ʸ»ú¥Æ¡¼¥Ö¥ë¤Î·¿
+    @brief ʸ»ú¥Æ¡¼¥Ö¥ë¤Î·¿Àë¸À
 
-    #MCharTable ·¿¤Ï @e ʸ»ú¥Æ¡¼¥Ö¥ë ¥ª¥Ö¥¸¥§¥¯¥ÈÍѤι½Â¤ÂΤǤ¢¤ë¡£
+    #MCharTable ¤Ï @e ʸ»ú¥Æ¡¼¥Ö¥ë (chartable) ¥ª¥Ö¥¸¥§¥¯¥È¤Î·¿¤Ç¤¢¤ë¡£
     ÆâÉô¹½Â¤¤Ï¥¢¥×¥ê¥±¡¼¥·¥ç¥ó¥×¥í¥°¥é¥à¤«¤é¤Ï¸«¤¨¤Ê¤¤¡£  */
 
 typedef struct MCharTable MCharTable;
@@ -265,7 +280,7 @@ extern void mchartable_range (MCharTable *table, int *from, int *to);
 /*
  * (5-1) M-text basics
  */
-
+/*=*/
 /*** @ingroup m17nMtext */
 /***en
     @brief Type of @e M-texts.
@@ -274,10 +289,10 @@ extern void mchartable_range (MCharTable *table, int *from, int *to);
     structure is concealed from application programs.  */
 
 /***ja
-    @brief @e MText Íѹ½Â¤ÂÎ 
+    @brief @e MText ¤Î·¿Àë¸À
 
-    #Mtext ¹½Â¤ÂÎ¤Ï @e M-text ¥ª¥Ö¥¸¥§¥¯¥È¤ËÍѤ¤¤é¤ì¤ë¡£ÆâÉô¹½Â¤¤Ï¥¢
-    ¥×¥ê¥±¡¼¥·¥ç¥ó¥×¥í¥°¥é¥à¤«¤é¤Ï¸«¤¨¤Ê¤¤¡£
+    #Mtext ¤Ï @e M-text ¥ª¥Ö¥¸¥§¥¯¥È¤Î·¿¤Ç¤¢¤ë¡£
+    ÆâÉô¹½Â¤¤Ï¥¢¥×¥ê¥±¡¼¥·¥ç¥ó¥×¥í¥°¥é¥à¤«¤é¤Ï¸«¤¨¤Ê¤¤¡£ 
 
     @latexonly \IPAlabel{MText} @endlatexonly
     @latexonly \IPAlabel{MText->MPlist} @endlatexonly  */
@@ -297,6 +312,13 @@ extern MText *mtext ();
     mtext_from_data () function to specify the format of data from
     which an M-text is created.  */
 
+/***ja
+    @brief M-text ¤Î¥Õ¥©¡¼¥Þ¥Ã¥È¤ò»ØÄꤹ¤ëÎóµó·¿.
+
+    Îóµó·¿ #MTextFormat ¤Ï
+    ´Ø¿ô mtext_from_data () ¤Î°ú¿ô¤È¤·¤ÆÍѤ¤¤é¤ì¡¢
+    M-text ¤òÀ¸À®¤¹¤ë¸µ¤È¤Ê¤ë¥Ç¡¼¥¿¤Î¥Õ¥©¡¼¥Þ¥Ã¥È¤ò»ØÄꤹ¤ë¡£  */
+
 enum MTextFormat
   {
     MTEXT_FORMAT_US_ASCII,
@@ -387,7 +409,7 @@ extern MPlist *mplist_deserialize (MText *mt);
 /*
  * (5-3) Text properties
  */
-
+/*=*/
 /*** @ingroup m17nCore */
 /***en @defgroup m17nTextProperty Text Property */
 /***ja @defgroup m17nTextProperty ¥Æ¥­¥¹¥È¥×¥í¥Ñ¥Æ¥£ */
@@ -401,28 +423,48 @@ extern MPlist *mplist_deserialize (MText *mt);
     text property as described in the documentation of each flag
     bit.  */
 
+/***ja
+    @brief ¥Æ¥­¥¹¥È¥×¥í¥Ñ¥Æ¥£¤òÀ©¸æ¤¹¤ë¥Õ¥é¥°¥Ó¥Ã¥È.
+
+    ´Ø¿ô mtext_property () ¤Ï°Ê²¼¤Î¥Õ¥é¥°¥Ó¥Ã¥È¤ÎÏÀÍý OR ¤ò°ú¿ô¤È¤·¤Æ
+    ¤È¤ë¤³¤È¤¬¤Ç¤­¤ë¡£¥Õ¥é¥°¥Ó¥Ã¥È¤ÏÀ¸À®¤µ¤ì¤¿¥Æ¥­¥¹¥È¥×¥í¥Ñ¥Æ¥£¤Î¿¶Éñ
+    ¤¤¤òÀ©¸æ¤¹¤ë¡£¾ÜºÙ¤Ï³Æ¥Õ¥é¥°¥Ó¥Ã¥È¤ÎÀâÌÀ¤ò»²¾È¡£*/
+
 enum MTextPropertyControl
   {
     /***en If this flag bit is on, an M-text inserted at the start
        position or at the middle of the text property inherits the
        text property.  */
+    /***ja ¤³¤Î¥Ó¥Ã¥È¤¬ on ¤Ê¤é¤Ð¡¢¤³¤Î¥Æ¥­¥¹¥È¥×¥í¥Ñ¥Æ¥£¤Î»Ï¤Þ¤ëÅÀ¤¢
+       ¤ë¤¤¤ÏÃæ´Ö¤ËÁÞÆþ¤µ¤ì¤¿ M-text ¤Ï¤³¤Î¥Æ¥­¥¹¥È¥×¥í¥Ñ¥Æ¥£¤ò·Ñ¾µ¤¹¤ë¡£
+       */
     MTEXTPROP_FRONT_STICKY = 0x01,
 
     /***en If this flag bit is on, an M-text inserted at the end
        position or at the middle of the text property inherits the
        text property.  */
+    /***ja ¤³¤Î¥Ó¥Ã¥È¤¬ on ¤Ê¤é¤Ð¡¢¤³¤Î¥Æ¥­¥¹¥È¥×¥í¥Ñ¥Æ¥£¤Î½ª¤ï¤ëÅÀ¤¢
+       ¤ë¤¤¤ÏÃæ´Ö¤ËÁÞÆþ¤µ¤ì¤¿ M-text ¤Ï¤³¤Î¥Æ¥­¥¹¥È¥×¥í¥Ñ¥Æ¥£¤ò·Ñ¾µ¤¹¤ë¡£
+       */
     MTEXTPROP_REAR_STICKY = 0x02,
 
     /***en If this flag bit is on, the text property is removed if a
        text in its region is modified.  */
+    /***ja ¤³¤Î¥Ó¥Ã¥È¤¬ on ¤Ê¤é¤Ð¡¢¤³¤Î¥Æ¥­¥¹¥È¥×¥í¥Ñ¥Æ¥£¤ÎÈÏ°ÏÆâ¤Î
+       ¥Æ¥­¥¹¥È¤¬Êѹ¹¤µ¤ì¤¿¾ì¹ç¥Æ¥­¥¹¥È¥×¥í¥Ñ¥Æ¥£¤Ï¼è¤ê½ü¤«¤ì¤ë¡£  */
     MTEXTPROP_VOLATILE_WEAK = 0x04,
 
     /***en If this flag bit is on, the text property is removed if a
        text or the other text property in its region is modified.  */
+    /***ja ¤³¤Î¥Ó¥Ã¥È¤¬ on ¤Ê¤é¤Ð¡¢¤³¤Î¥Æ¥­¥¹¥È¥×¥í¥Ñ¥Æ¥£¤ÎÈÏ°ÏÆâ¤Î
+       ¥Æ¥­¥¹¥È¤¢¤ë¤¤¤ÏÊ̤Υƥ­¥¹¥È¥×¥í¥Ñ¥Æ¥£¤¬Êѹ¹¤µ¤ì¤¿¾ì¹ç¤³¤Î¥Æ¥­
+       ¥¹¥È¥×¥í¥Ñ¥Æ¥£¤Ï¼è¤ê½ü¤«¤ì¤ë¡£*/
     MTEXTPROP_VOLATILE_STRONG = 0x08,
 
     /***en If this flag bit is on, the text property is not
        automatically merged with the others.  */
+    /***ja ¤³¤Î¥Ó¥Ã¥È¤¬ on ¤Ê¤é¤Ð¡¢¤³¤Î¥Æ¥­¥¹¥È¥×¥í¥Ñ¥Æ¥£¤Ï¾¤Î¥×¥í¥Ñ
+       ¥Æ¥£¤È¼«Æ°Åª¤Ë¤Ï¥Þ¡¼¥¸¤µ¤ì¤Ê¤¤¡£ */
     MTEXTPROP_NO_MERGE = 0x10,
 
     MTEXTPROP_CONTROL_MAX = 0x1F
@@ -443,6 +485,14 @@ extern MSymbol Mtext_prop_deserializer;
 
     @seealso Mtext_prop_serialize (), Mtext_prop_serializer
 */
+/***ja
+    @brief ¥·¥ê¥¢¥é¥¤¥¶´Ø¿ô¤Î·¿Àë¸À.
+
+    ¥·¥ê¥¢¥é¥¤¥¶´Ø¿ô¤Î·¿¤Ç¤¢¤ë¡£ ¤¢¤ë¥·¥ó¥Ü¥ë¤Î¥×¥í¥Ñ¥Æ¥£¤Î¥­¡¼¤¬ @c
+    #Msymbol_prop_serializer ¤Ç¤¢¤ë¤È¤­¡¢ ÃͤϤ³¤Î·¿¤Ç¤Ê¤¯¤Æ¤Ï¤Ê¤é¤Ê¤¤¡£
+
+    @seealso Mtext_prop_serialize (), Mtext_prop_serializer
+*/
 
 typedef MPlist *(*MTextPropSerializeFunc) (void *val);
 
@@ -456,6 +506,14 @@ typedef MPlist *(*MTextPropSerializeFunc) (void *val);
 
     @seealso Mtext_prop_deserialize (), Mtext_prop_deserializer
 */
+/***ja
+    @brief ¥Ç¥·¥ê¥¢¥é¥¤¥¶´Ø¿ô¤Î·¿Àë¸À.
+
+    ¥Ç¥·¥ê¥¢¥é¥¤¥¶´Ø¿ô¤Î·¿¤Ç¤¢¤ë¡£ ¤¢¤ë¥·¥ó¥Ü¥ë¤Î¥×¥í¥Ñ¥Æ¥£¤Î¥­¡¼¤¬ @c
+    #Msymbol_prop_deserializer ¤Ç¤¢¤ë¤È¤­¡¢ ÃͤϤ³¤Î·¿¤Ç¤Ê¤¯¤Æ¤Ï¤Ê¤é¤Ê¤¤¡£
+
+    @seealso Mtext_prop_deserialize (), Mtext_prop_deserializer
+*/
 typedef void *(*MTextPropDeserializeFunc) (MPlist *plist);
 
 extern void *mtext_get_prop (MText *mt, int pos, MSymbol key);