Provided by: m17n-docs_1.6.2-1_all bug

NAME

       FLT_API - API provided by libm17n-flt.so.

   Data Structures
       struct MFLTGlyph
           Type of information about a glyph.
       struct MFLTGlyphAdjustment
           Type of information about a glyph position adjustment.
       struct MFLTGlyphString
           Type of information about a glyph sequence.
       struct MFLTOtfSpec
           Type of specification of GSUB and GPOS OpenType tables.
       struct MFLTFont
           Type of font to be used by the FLT driver.

   Typedefs
       typedef struct _MFLT MFLT
           Type of FLT (Font Layout Table).

   Functions
       MFLT * mflt_get (MSymbol name)
           Return an FLT object that has a specified name.
       MFLT * mflt_find (int c, MFLTFont *font)
           Find an FLT suitable for the specified character and font.
       const char * mflt_name (MFLT *flt)
           Return the name of an FLT.
       MCharTable * mflt_coverage (MFLT *flt)
           Return a coverage of a FLT.
       int mflt_run (MFLTGlyphString *gstring, int from, int to, MFLTFont *font, MFLT *flt)
           Layout characters with an FLT.
       MFLT * mdebug_dump_flt (MFLT *flt, int indent)
           Dump a Font Layout Table.
       void mflt_dump_gstring (MFLTGlyphString *gstring)
           Dump an MFLTGlyphString.

   Variables
       int mflt_enable_new_feature
           Flag to control several new OTF handling commands.
       int(* mflt_iterate_otf_feature )(struct _MFLTFont *font, MFLTOtfSpec *spec, int from, int
           to, unsigned char *table)
       MSymbol(* mflt_font_id )(struct _MFLTFont *font)
       int(* mflt_try_otf )(struct _MFLTFont *font, MFLTOtfSpec *spec, MFLTGlyphString *gstring,
           int from, int to)

Detailed Description

       API provided by libm17n-flt.so.

       FLT support for a window system.

       This section defines the m17n FLT API concerning character layouting facility using FLT
       (Font Layout Table). The format of FLT is described in mdbFLT.

Data Structure Documentation

   MFLTGlyph
       FIELD DOCUMENTATION:

       int MFLTGlyph::c

       unsigned int MFLTGlyph::code

       int MFLTGlyph::from

       int MFLTGlyph::to

       int MFLTGlyph::xadv

       int MFLTGlyph::yadv

       int MFLTGlyph::ascent

       int MFLTGlyph::descent

       int MFLTGlyph::lbearing

       int MFLTGlyph::rbearing

       int MFLTGlyph::xoff

       int MFLTGlyph::yoff

       unsigned MFLTGlyph::encoded

       unsigned MFLTGlyph::measured

       unsigned MFLTGlyph::adjusted

       unsigned MFLTGlyph::internal

   MFLTGlyphAdjustment
       FIELD DOCUMENTATION:

       int MFLTGlyphAdjustment::xadv

       int MFLTGlyphAdjustment::yadv

       int MFLTGlyphAdjustment::xoff

       int MFLTGlyphAdjustment::yoff

       short MFLTGlyphAdjustment::back

       unsigned MFLTGlyphAdjustment::advance_is_absolute

       unsigned MFLTGlyphAdjustment::set

   MFLTGlyphString
       FIELD DOCUMENTATION:

       int MFLTGlyphString::glyph_size
             (MFLTGlyph)'.

       MFLTGlyph* MFLTGlyphString::glyphs

       int MFLTGlyphString::allocated

       int MFLTGlyphString::used

       unsigned int MFLTGlyphString::r2l

   MFLTOtfSpec
       FIELD DOCUMENTATION:

       MSymbol MFLTOtfSpec::sym

       unsigned int MFLTOtfSpec::script

       unsigned int MFLTOtfSpec::langsys

       unsigned int* MFLTOtfSpec::features[2]

       (1) The case of using this information for selecting which features to apply to a glyph
       string. If the array is NULL, apply no feature. If the first element is 0xFFFFFFFF, apply
       all available features except for what appear in the second and following elements (if
       any). Otherwise, apply all listed features.

       (2) The case of using this information for checking if a a font can be drived by a
       specific FLT. If the array is NULL, the font should not have any features. Otherwize, the
       font should have all features before 0xFFFFFFFF element (if any) and should not have any
       features after that element.

   MFLTFont
       FIELD DOCUMENTATION:

       MSymbol MFLTFont::family

       int MFLTFont::x_ppem

       int MFLTFont::y_ppem

       int(* MFLTFont::get_glyph_id)(struct _MFLTFont *font, MFLTGlyphString *gstring, int from,
       int to)

       int(* MFLTFont::get_metrics)(struct _MFLTFont *font, MFLTGlyphString *gstring, int from,
       int to)

       int(* MFLTFont::check_otf)(struct _MFLTFont *font, MFLTOtfSpec *spec)

       int(* MFLTFont::drive_otf)(struct _MFLTFont *font, MFLTOtfSpec *spec, MFLTGlyphString *in,
       int from, int to, MFLTGlyphString *out, MFLTGlyphAdjustment *adjustment)

       void* MFLTFont::internal

Typedef Documentation

   typedef struct _MFLT MFLT
       Type of FLT (Font Layout Table). The type MFLT is for an FLT object. Its internal
       structure is concealed from application programs.

Variable Documentation

   int mflt_enable_new_feature
       Flag to control several new OTF handling commands. If the variable mflt_enable_new_feature
       is nonzero, the function mflt_run() can drive a Font Layout Table that contains the new
       OTF-related commands ':otf?' and/or OTF feature specification in a category table.

   int(* mflt_iterate_otf_feature)(struct _MFLTFont *font, MFLTOtfSpec *spec, int from, int to,
       unsigned char *table)
   MSymbol(* mflt_font_id)(struct _MFLTFont *font)
   int(* mflt_try_otf)(struct _MFLTFont *font, MFLTOtfSpec *spec, MFLTGlyphString *gstring, int
       from, int to)

Author

       Generated automatically by Doxygen for The m17n Library from the source code.

COPYRIGHT

       Copyright (C) 2001 Information-technology Promotion Agency (IPA)
       Copyright (C) 2001-2011 National Institute of Advanced Industrial Science and Technology
       (AIST)
       Permission is granted to copy, distribute and/or modify this document under the terms of
       the GNU Free Documentation License <http://www.gnu.org/licenses/fdl.html>.