"SfR Fresh" - the SfR Freeware/Shareware Archive

Member "pango-1.20.5/docs/tmpl/engines.sgml" of archive pango-1.20.5.tar.gz:

As a special service "SfR Fresh" has tried to format the requested source page into HTML format using (guessed) XML source code syntax highlighting with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file. That can be also achieved for any archive member file by clicking within an archive contents listing on the first character of the file(path) respectively on the according byte size field. 
    1 <!-- ##### SECTION Title ##### -->
    2 Engines
    3 
    4 <!-- ##### SECTION Short_Description ##### -->
    5 Language-specific and rendering-system-specific processing
    6 
    7 <!-- ##### SECTION Long_Description ##### -->
    8 <para>
    9 Pango utilizes a module architecture in which the language-specific
   10 and render-system-specific components are provided by loadable
   11 modules. Each loadable module supplies one or more
   12 <firstterm>engines</firstterm>.  Each <firstterm>engine</firstterm>
   13 has an associated <firstterm>engine type</firstterm> and
   14 <firstterm>render type</firstterm>. These two types are represented by
   15 strings.
   16 </para>
   17 <para>
   18 Each dynamically-loaded module exports several functions which provide
   19 the public API. These functions are script_engine_list(),
   20 script_engine_init() and script_engine_exit, and
   21 script_engine_create(). The latter three functions are used when
   22 creating engines from the module at run time, while the first
   23 function is used when building a catalog of all available modules.
   24 </para>
   25 
   26 <!-- ##### SECTION See_Also ##### -->
   27 <para>
   28 
   29 </para>
   30 
   31 <!-- ##### SECTION Stability_Level ##### -->
   32 
   33 
   34 <!-- ##### STRUCT PangoEngineInfo ##### -->
   35 <para>
   36 The #PangoEngineInfo structure contains information about a particular
   37 engine. It contains the following fields:
   38 </para>
   39 
   40 @id: a unique string ID for the engine.
   41 @engine_type: a string identifying the engine type.
   42 @render_type: a string identifying the render type.
   43 @scripts: array of scripts this engine supports.
   44 @n_scripts: number of items in @scripts.
   45 
   46 <!-- ##### STRUCT PangoEngineScriptInfo ##### -->
   47 <para>
   48 The #PangoEngineScriptInfo structure contains
   49 information about how the shaper covers a particular
   50 script.
   51 </para>
   52 
   53 @script: a #PangoScript. The value %PANGO_SCRIPT_COMMON has
   54         the special meaning here of "all scripts"
   55 @langs: a semicolon separated list of languages that this
   56         engine handles for this script. This may be empty,
   57         in which case the engine is saying that it is a
   58         fallback choice for all languages for this range,
   59         but should not be used if another engine
   60         indicates that it is specific for the language for
   61         a given code point. An entry in this list of "*"
   62         indicates that this engine is specific to all
   63         languages for this range.
   64 
   65 <!-- ##### STRUCT PangoEngine ##### -->
   66 <para>
   67 </para>
   68 
   69 
   70 <!-- ##### STRUCT PangoEngineClass ##### -->
   71 <para>
   72 
   73 </para>
   74 
   75 
   76 <!-- ##### MACRO PANGO_RENDER_TYPE_NONE ##### -->
   77 <para>
   78 A string constant defining the render type
   79 for engines that are not rendering-system
   80 specific.
   81 </para>
   82 
   83 
   84 
   85 <!-- ##### FUNCTION script_engine_list ##### -->
   86 <para>
   87 </para>
   88 
   89 @engines: location to store a pointer to an array of engines.
   90 @n_engines: location to store the number of elements in @engines.
   91 
   92 
   93 <!-- ##### FUNCTION script_engine_init ##### -->
   94 <para>
   95 
   96 </para>
   97 
   98 @module:
   99 
  100 
  101 <!-- ##### FUNCTION script_engine_exit ##### -->
  102 <para>
  103 
  104 </para>
  105 
  106 
  107 
  108 <!-- ##### FUNCTION script_engine_create ##### -->
  109 <para>
  110 
  111 </para>
  112 
  113 @id:
  114 @Returns:
  115 
  116