Remove declarations of unimplemented functions

* docs/pango-sections.txt, pango/pango-ot.h: Remove declarations
        of unimplemented functions pango_ot_ruleset_set_glyph_loader and
        pango_ot_ruleset_set_alternate_func and the related typedefs
        PangoOTGlyphLoader and PangoOTAlternateFunc.

        * pango/opentype/pango-ot-info.c,
        pango/opentype/pango-ot-ruleset.c: Documentation updates.
This commit is contained in:
Matthias Clasen 2001-10-30 22:09:20 +00:00
parent 87a475c09f
commit 6926ca9425
2 changed files with 103 additions and 0 deletions

View File

@ -94,6 +94,13 @@ pango_ot_info_finalize (GObject *object)
}
}
/**
* pango_ot_info_new:
* @face: a #FT_Face.
* @returns: a new #PangoOTInfo for @face.
*
* Creates a new #PangoOTInfo structure for the given FreeType font.
**/
PangoOTInfo *
pango_ot_info_new (FT_Face face)
{
@ -223,6 +230,16 @@ get_tables (PangoOTInfo *info,
}
}
/**
* pango_ot_info_find_script:
* @info: a #PangoOTInfo.
* @table_type: the table type to obtain information about.
* @script_tag: the tag of the script to find.
* @script_index: location to store the index of the script, or %NULL.
* @returns: %TRUE if the script was found.
*
* Finds the index of a script.
**/
gboolean
pango_ot_info_find_script (PangoOTInfo *info,
PangoOTTableType table_type,
@ -251,6 +268,19 @@ pango_ot_info_find_script (PangoOTInfo *info,
return FALSE;
}
/**
* pango_ot_info_find_language:
* @info: a #PangoOTInfo.
* @table_type: the table type to obtain information about.
* @script_index: the index of the script whose languages are searched.
* @language_tag: the tag of the language to find.
* @language_index: location to store the index of the language, or %NULL.
* @required_feature_index: location to store the required feature index of
* the language, or %NULL.
* @returns: %TRUE if the language was found.
*
* Finds the index of a language and its required feature index.
**/
gboolean
pango_ot_info_find_language (PangoOTInfo *info,
PangoOTTableType table_type,
@ -287,6 +317,19 @@ pango_ot_info_find_language (PangoOTInfo *info,
return FALSE;
}
/**
* pango_ot_info_find_feature:
* @info: a #PangoOTInfo.
* @table_type: the table type to obtain information about.
* @feature_tag: the tag of the feature to find.
* @script_index: the index of the script.
* @language_index: the index of the language whose features are searched,
* or 0xffff to use the default language of the script.
* @feature_index: location to store the index of the feature, or %NULL.
* @returns: %TRUE if the feature was found.
*
* Finds the index of a feature.
**/
gboolean
pango_ot_info_find_feature (PangoOTInfo *info,
PangoOTTableType table_type,
@ -335,6 +378,15 @@ pango_ot_info_find_feature (PangoOTInfo *info,
return FALSE;
}
/**
* pango_ot_info_list_scripts:
* @info: a #PangoOTInfo.
* @table_type: the table type to obtain information about.
* @returns: a newly-allocated array containing the tags of the
* available scripts.
*
* Obtains the list of available scripts.
**/
PangoOTTag *
pango_ot_info_list_scripts (PangoOTInfo *info,
PangoOTTableType table_type)
@ -358,6 +410,17 @@ pango_ot_info_list_scripts (PangoOTInfo *info,
return result;
}
/**
* pango_ot_info_list_languages:
* @info: a #PangoOTInfo.
* @table_type: the table type to obtain information about.
* @script_index: the index of the script to list languages for.
* @language_tag: unused parameter.
* @returns: a newly-allocated array containing the tags of the
* available languages.
*
* Obtains the list of available languages for a given script.
**/
PangoOTTag *
pango_ot_info_list_languages (PangoOTInfo *info,
PangoOTTableType table_type,
@ -388,6 +451,19 @@ pango_ot_info_list_languages (PangoOTInfo *info,
return result;
}
/**
* pango_ot_info_list_features:
* @info: a #PangoOTInfo.
* @table_type: the table type to obtain information about.
* @tag: unused parameter.
* @script_index: the index of the script to obtain information about.
* @language_index: the indes of the language to list features for, or
* 0xffff, to list features for the default language of the script.
* @returns: a newly-allocated array containing the tags of the available
* features.
*
* Obtains the list of features for the given language of the given script.
**/
PangoOTTag *
pango_ot_info_list_features (PangoOTInfo *info,
PangoOTTableType table_type,

View File

@ -90,6 +90,13 @@ pango_ot_ruleset_finalize (GObject *object)
g_object_unref (G_OBJECT (ruleset->info));
}
/**
* pango_ot_ruleset_new:
* @info: a #PangoOTInfo.
* @returns: a new #PangoOTRuleset.
*
* Creates a new #PangoOTRuleset for the given OpenType info.
**/
PangoOTRuleset *
pango_ot_ruleset_new (PangoOTInfo *info)
{
@ -102,6 +109,16 @@ pango_ot_ruleset_new (PangoOTInfo *info)
return ruleset;
}
/**
* pango_ot_ruleset_add_feature:
* @ruleset: a #PangoOTRuleset.
* @table_type: the table type to add a feature to.
* @feature_index: the index of the feature to add.
* @property_bit: the property bit to use for this feature.
*
* Adds a feature to the ruleset. See pango_ot_ruleset_shape()
* for an explanation of @property_bit.
**/
void
pango_ot_ruleset_add_feature (PangoOTRuleset *ruleset,
PangoOTTableType table_type,
@ -119,6 +136,16 @@ pango_ot_ruleset_add_feature (PangoOTRuleset *ruleset,
g_array_append_val (ruleset->rules, tmp_rule);
}
/**
* pango_ot_ruleset_shape:
* @ruleset: a #PangoOTRuleset.
* @glyphs: a pointer to a #PangoGlyphString.
* @properties: an array containing one #gulong bitfield for each glyph,
* which gives the glyph's properties: If a certain bit is set for a glyph,
* the feature which has the same bit set in its property value is applied.
*
* Shapes a string of glyphs with the given properties according to @ruleset.
**/
void
pango_ot_ruleset_shape (PangoOTRuleset *ruleset,
PangoGlyphString *glyphs,