layouting facility using FLT (Font Layout Table). The format of
FLT is described in @ref mdbFLT. */
+/***ja
+ @addtogroup m17nFLT
+ @brief ¥¦¥£¥ó¥É¥¦¥·¥¹¥Æ¥à¤Î¤¿¤á¤Î FLT ¥µ¥Ý¡¼¥È.
+
+ ¤³¤Î¥»¥¯¥·¥ç¥ó¤Ç¤Ï¡¢FLT (Font Layout Table)
+ ¤òÍѤ¤¤¿Ê¸»ú¥ì¥¤¥¢¥¦¥Èµ¡Ç½¤Ë´Ø¤¹¤ë m17n FLT API ¤òÄêµÁ¤¹¤ë¡£
+ FLT ¤Î·Á¼°¤Ï @ref mdbFLT ¤Ëµ½Ò¤µ¤ì¤Æ¤¤¤ë¡£ */
+
/*=*/
#if !defined (FOR_DOXYGEN) || defined (DOXYGEN_INTERNAL_MODULE)
/*=*/
/***en
- @brief Return a FLT object whose name is NAME.
+ @brief Return an FLT object that has a specified name.
+
+ The mflt_get () function returns an FLT object whose name is $NAME.
+
+ @return
+ If the operation was successful, mflt_get () returns a pointer
+ to the found FLT object. Otherwise, it returns @c NULL. */
- The mflt_get () function returns a FLT object whose name is $NAME.
+/***ja
+ @brief »ØÄꤵ¤ì¤¿Ì¾Á°¤ò»ý¤Ä FLT ¥ª¥Ö¥¸¥§¥¯¥È¤òÊÖ¤¹.
+
+ ´Ø¿ô mflt_get () ¤Ï¡¢$NAME ¤È¤¤¤¦Ì¾Á°¤ò»ý¤Ä FLT ¥ª¥Ö¥¸¥§¥¯¥È¤òÊÖ¤¹¡£
@return
- If the operation was successfully, mflt_get () returns a pointer
- to a FLT object. Otherwise, it returns @c NULL. */
+ ¤â¤·À®¸ù¤¹¤ì¤Ð¡¢mflt_get () ¤Ï¸«¤Ä¤«¤Ã¤¿ FLT
+ ¥ª¥Ö¥¸¥§¥¯¥È¤Ø¤Î¥Ý¥¤¥ó¥¿¤òÊÖ¤¹¡£¼ºÇÔ¤·¤¿¾ì¹ç¤Ï @c NULL ¤òÊÖ¤¹¡£ */
MFLT *
mflt_get (MSymbol name)
/*=*/
/***en
- @brief Find a FLT suitable for a specified character and font.
+ @brief Find an FLT suitable for the specified character and font.
The mflt_find () function returns the most appropriate FLT for
- rendering the character $C by font $FONT.
+ layouting character $C with font $FONT.
+
+ @return
+ If the operation was successful, mflt_find () returns a pointer
+ to the found FLT object. Otherwise, it returns @c NULL. */
+
+/***ja
+ @brief »ØÄꤵ¤ì¤¿Ê¸»ú¤È¥Õ¥©¥ó¥È¤Ë¹ç¤Ã¤¿ FLT ¤òõ¤¹.
+
+ ´Ø¿ô mflt_find () ¤Ï¡¢Ê¸»ú $C ¤ò¥Õ¥©¥ó¥È $FONT
+ ¤Ç¥ì¥¤¥¢¥¦¥È¤¹¤ë¤¿¤á¤ËºÇ¤âŬÀÚ¤Ê FLT ¤òÊÖ¤¹¡£
@return
- If the operation was successfully, mflt_find () returns a pointer
- to a FLT object. Otherwise, it returns @c NULL. */
+ ¤â¤·À®¸ù¤¹¤ì¤Ð¡¢mflt_find () ¤Ï¸«¤Ä¤«¤Ã¤¿ FLT
+ ¥ª¥Ö¥¸¥§¥¯¥È¤Ø¤Î¥Ý¥¤¥ó¥¿¤òÊÖ¤¹¡£¼ºÇÔ¤·¤¿¾ì¹ç¤Ï @c NULL ¤òÊÖ¤¹¡£ */
MFLT *
mflt_find (int c, MFLTFont *font)
/*=*/
/***en
- @brief Return a name of a FLT.
+ @brief Return the name of an FLT.
The mflt_name () function returns the name of $FLT. */
+/***ja
+ @brief FLT ¤Î̾Á°¤òÊÖ¤¹.
+
+ ´Ø¿ô mflt_name () ¤Ï $FLT ¤Î̾Á°¤òÊÖ¤¹¡£ */
+
const char *
mflt_name (MFLT *flt)
{
@brief Return a coverage of a FLT.
The mflt_coverage () function returns a char-table that contains
- nonzero value for characters supported by $FLT. */
+ nonzero values for characters supported by $FLT. */
+
+/***
+ @brief FLT ¤ÎÈϰϤòÊÖ¤¹.
+
+ ´Ø¿ô mflt_coverage () ¤Ï¡¢$FLT ¤¬¥µ¥Ý¡¼¥È¤¹¤ëʸ»ú¤ËÂФ·¤Æ
+ 0 ¤Ç¤Ê¤¤Ãͤò´Þ¤àʸ»ú¥Æ¡¼¥Ö¥ë¤òÊÖ¤¹¡£ */
MCharTable *
mflt_coverage (MFLT *flt)
/*=*/
/***en
- @brief Layout characters by Font Layout Table.
+ @brief Layout characters with an FLT.
- The mflt_run () function layout characters in $GSTRING between
- $FROM (inclusive) and $TO (exclusive) by $FONT. If $FLT is
+ The mflt_run () function layouts characters in $GSTRING between
+ $FROM (inclusive) and $TO (exclusive) with $FONT. If $FLT is
nonzero, it is used for all the charaters. Otherwise, appropriate
FLTs are automatically chosen.
@retval >=0
- The operation was successful. The value is an index to the
- $GSTRING->glyphs which was previously indexed by $TO.
+ The operation was successful. The value is the index to the
+ glyph, which was previously indexed by $TO, in $GSTRING->glyphs.
@retval -2
- $GSTRING->glyphs is too short to store the result. A caller can
- call this fucntion again with the larger $GSTRING->glyphs.
+ $GSTRING->glyphs is too short to store the result. The caller can
+ call this fucntion again with a longer $GSTRING->glyphs.
@retval -1
Some other error occurred. */
+/***ja
+ @brief FLT ¤ò»È¤Ã¤Æʸ»ú¤ò¥ì¥¤¥¢¥¦¥È¤¹¤ë.
+
+ ´Ø¿ô mflt_run () ¤Ï¡¢$GSTRING Ãæ¤Î $FROM ¤«¤é $TO ľÁ°¤Þ¤Ç¤Îʸ»ú¤ò
+ $FONT ¤òÍѤ¤¤Æ¥ì¥¤¥¢¥¦¥È¤¹¤ë¡£¤â¤· $FLT
+ ¤¬¥¼¥í¤Ç¤Ê¤±¤ì¤Ð¡¢¤½¤ÎÃͤò¤¹¤Ù¤Æ¤Îʸ»ú¤ËÂФ·¤ÆÍѤ¤¤ë¡£
+ ¤½¤¦¤Ç¤Ê¤±¤ì¤ÐŬÀÚ¤Ê FLT ¤ò¼«Æ°Åª¤ËÁªÂò¤¹¤ë¡£
+
+ @retval >=0
+ ¼Â¹ÔÀ®¸ù¤ò¼¨¤¹¡£ÊÖ¤µ¤ì¤ëÃͤϡ¢$GSTRING->glyphs Ãæ¤Ç°ÊÁ° $TO
+ ¤Ë¤è¤Ã¤Æ¼¨¤µ¤ì¤Æ¤¤¤¿¥°¥ê¥Õ¤Ø¤Î¥¤¥ó¥Ç¥¯¥¹¤Ç¤¢¤ë¡£
+
+ @retval -2
+ ·ë²Ì¤ò³ÊǼ¤¹¤ë¤Ë¤Ï $GSTRING->glyphs ¤¬Ã»¤¹¤®¤ë¤³¤È¤ò¼¨¤¹¡£
+ ¸Æ¤Ó½Ð¤·Â¦¤Ï¡¢¤è¤êŤ¤ $GSTRING->glyphs
+ ¤òÍѤ¤¤ÆºÆÅÙ¤³¤Î´Ø¿ô¤ò¸Æ¤Ö¤³¤È¤¬¤Ç¤¤ë¡£
+
+ @retval -1
+ ¤½¤Î¾¤Î¥¨¥é¡¼¤¬µ¯¤¤¿¤³¤È¤ò¼¨¤¹¡£ */
+
int
mflt_run (MFLTGlyphString *gstring, int from, int to,
MFLTFont *font, MFLT *flt)