summaryrefslogtreecommitdiff
path: root/docs/tmpl/engines.sgml
diff options
context:
space:
mode:
authorOwen Taylor <otaylor@redhat.com>2003-08-03 21:57:35 +0000
committerOwen Taylor <otaylor@src.gnome.org>2003-08-03 21:57:35 +0000
commit2584212cd0976f5f95d9381e829917e7d2a10d28 (patch)
tree5773e9f6802f8316c5c7463aa55677babe67343c /docs/tmpl/engines.sgml
parent95a8d1788e884b7d8d29d4171a1adc51c61e880e (diff)
downloadpango-2584212cd0976f5f95d9381e829917e7d2a10d28.tar.gz
Make PangoEngine{,Lang,Shape} GObjects, and use a GTypeModule-based
Sat Aug 2 23:19:16 2003 Owen Taylor <otaylor@redhat.com> * pango/pango-engine.[ch] modules/*/*-{fc,win32,x}.c pango/modules.c pango/break.c pango/pango-context.c pango/pango-layout.c pango/pango-modules.h pango/querymodules.c pango/shape.c: Make PangoEngine{,Lang,Shape} GObjects, and use a GTypeModule-based module-loading system closely based on the one used for GtkIMContext and GtkThemeEngine. * pango/pango-impl-utils.h: OK, I'm tired of typing in get_type() functions. * pango/pango-script.[ch] pango/pango-script-table.h tests/testscript.c tools/gen-script-table.pl: Add port of script-range code from ICU in preparation for future use. (#91542) * tools/gen-script-for-lang.c: Utility program to determine the script for each fontconfig .orth file. * docs/tmpl/{scripts.sgml,pango-engine-lang.sgml, pango-engine-shape.sgml} docs/pango-sections.txt docs/pango-docs.sgml: Redo to go along with the above changes. * configure.in: chmod +x tests/runtests.sh
Diffstat (limited to 'docs/tmpl/engines.sgml')
-rw-r--r--docs/tmpl/engines.sgml81
1 files changed, 16 insertions, 65 deletions
diff --git a/docs/tmpl/engines.sgml b/docs/tmpl/engines.sgml
index 4b88affd..754540ce 100644
--- a/docs/tmpl/engines.sgml
+++ b/docs/tmpl/engines.sgml
@@ -17,8 +17,9 @@ strings.
<para>
Each dynamically-loaded module exports several functions which provide
the public API. These functions are script_engine_list(),
-script_engine_load() and script_engine_unload(). The latter two
-functions are used for loading and unloading modules, while the first
+script_engine_init() and script_engine_exit, and
+script_engine_create(). The latter three functions are used when
+creating engines from the module at run time, while the first
function is used when building a catalog of all available modules.
</para>
@@ -63,61 +64,15 @@ points. It contains the following fields:
<!-- ##### STRUCT PangoEngine ##### -->
<para>
-The #PangoEngine structure contains basic
-information common to all script engines. It
-contains the following fields:
</para>
-@id: a unique string ID for this language engine.
-@type: the "type" of the engine. (Is this engine type or render type??).
-@length: the length of the entire structure in bytes. This is
- provided so that new functions can be added at the
- end of subtypes of #PangoEngine without breaking
- older modules.
-<!-- ##### STRUCT PangoEngineLang ##### -->
+<!-- ##### STRUCT PangoEngineClass ##### -->
<para>
-The #PangoEngineLang structure extends the
-basic #PangoEngine structure to engines that
-deal with the rendering-system independent part
-of of the rendering pipeline. It contains the following fields:
-</para>
-
-@engine: a nested structure containing basic engine data.
-@script_break: a function that provides an implementation for pango_break().
-
-<!-- ##### STRUCT PangoEngineShape ##### -->
-<para>
-The #PangoEngineShape structure extends the
-basic #PangoEngine structure to engines that
-deal with the rendering-system dependent part
-of of the rendering pipeline. It contains the following fields:
-</para>
-@engine: a nested structure containing basic engine data.
-@script_shape: a function that provides an implementation for pango_shape.
-@get_coverage:
-
-<!-- ##### MACRO PANGO_ENGINE_TYPE_LANG ##### -->
-<para>
-A string constant defining the engine type
-for <firstterm>language engines</firstterm>.
-These engines have a engine structure of
-type #PangoEngineLang.
</para>
-
-<!-- ##### MACRO PANGO_ENGINE_TYPE_SHAPE ##### -->
-<para>
-A string constant defining the engine type
-for <firstterm>shaping engines</firstterm>.
-These engines have a engine structure of
-type #PangoEngineShape.
-</para>
-
-
-
<!-- ##### MACRO PANGO_RENDER_TYPE_NONE ##### -->
<para>
A string constant defining the render type
@@ -129,37 +84,33 @@ specific.
<!-- ##### FUNCTION script_engine_list ##### -->
<para>
-Function to be provided by a module to list the engines that the
-module supplies. The function stores a pointer to an array
-of #PangoEngineInfo structures and the length of that array in
-the given location.
</para>
@engines: location to store a pointer to an array of engines.
@n_engines: location to store the number of elements in @engines.
-<!-- ##### FUNCTION script_engine_load ##### -->
+<!-- ##### FUNCTION script_engine_init ##### -->
<para>
-Function to be provided by a module to load a particular engine.
+
</para>
-@id: the ID from the #PangoEngineInfo structure of the
- module to load.
-@Returns: the newly created script engine.
+@module:
-<!-- ##### FUNCTION script_engine_unload ##### -->
+<!-- ##### FUNCTION script_engine_exit ##### -->
<para>
-Function to be provided by a module to unload an engine loaded
-with script_engine_load().
+
</para>
-@engine: the engine to unload.
-<!-- Local Variables: -->
-<!-- sgml-parent-document: ("../pango-docs.sgml" "book" "refsect2") -->
-<!-- End: -->
+<!-- ##### FUNCTION script_engine_create ##### -->
+<para>
+
+</para>
+
+@id:
+@Returns: