docs/reference/glib/glib-docs.sgml

   1 <?xml version="1.0"?>
   2 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
   3                "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
   4 <!ENTITY glib-Basic-Types SYSTEM "xml/types.xml">
   5 <!ENTITY glib-Limits-of-Basic-Types SYSTEM "xml/limits.xml">
   6 <!ENTITY glib-Standard-Macros SYSTEM "xml/macros.xml">
   7 <!ENTITY glib-Type-Conversion-Macros SYSTEM "xml/type_conversion.xml">
   8 <!ENTITY glib-Byte-Order-Macros SYSTEM "xml/byte_order.xml">
   9 <!ENTITY glib-Numerical-Definitions SYSTEM "xml/numerical.xml">
  10 <!ENTITY glib-Miscellaneous-Macros SYSTEM "xml/macros_misc.xml">
  11 <!ENTITY glib-Memory-Allocation SYSTEM "xml/memory.xml">
  12 <!ENTITY glib-Error-Reporting SYSTEM "xml/error_reporting.xml">
  13 <!ENTITY glib-Warnings-and-Assertions SYSTEM "xml/warnings.xml">
  14 <!ENTITY glib-Message-Logging SYSTEM "xml/messages.xml">
  15 <!ENTITY glib-Pattern-Matching SYSTEM "xml/patterns.xml">
  16 <!ENTITY glib-Timers SYSTEM "xml/timers.xml">
  17 <!ENTITY glib-String-Utility-Functions SYSTEM "xml/string_utils.xml">
  18 <!ENTITY glib-Character-Set-Conversion SYSTEM "xml/conversions.xml">
  19 <!ENTITY glib-Unicode-Manipulation SYSTEM "xml/unicode.xml">
  20 <!ENTITY glib-Random-Numbers SYSTEM "xml/random_numbers.xml">
  21 <!ENTITY glib-Miscellaneous-Utility-Functions SYSTEM "xml/misc_utils.xml">
  22 <!ENTITY glib-Date-and-Time-Functions SYSTEM "xml/date.xml">
  23 <!ENTITY glib-The-Main-Event-Loop SYSTEM "xml/main.xml">
  24 <!ENTITY glib-Threads SYSTEM "xml/threads.xml">
  25 <!ENTITY glib-Thread-Pools SYSTEM "xml/thread_pools.xml">
  26 <!ENTITY glib-Async-Queues SYSTEM "xml/async_queues.xml">
  27 <!ENTITY glib-IO-Channels SYSTEM "xml/iochannels.xml">
  28 <!ENTITY glib-Hook-Functions SYSTEM "xml/hooks.xml">
  29 <!ENTITY glib-Lexical-Scanner SYSTEM "xml/scanner.xml">
  30 <!ENTITY glib-Dynamic-Loading-of-Modules SYSTEM "xml/modules.xml">
  31 <!ENTITY glib-Automatic-String-Completion SYSTEM "xml/completion.xml">
  32 <!ENTITY glib-Windows-Compatability-Functions SYSTEM "xml/windows.xml">
  33 <!ENTITY glib-Memory-Chunks SYSTEM "xml/memory_chunks.xml">
  34 <!ENTITY glib-Doubly-Linked-Lists SYSTEM "xml/linked_lists_double.xml">
  35 <!ENTITY glib-Singly-Linked-Lists SYSTEM "xml/linked_lists_single.xml">
  36 <!ENTITY glib-Double-ended-Queues SYSTEM "xml/queue.xml">
  37 <!ENTITY glib-Trash-Stacks SYSTEM "xml/trash_stack.xml">
  38 <!ENTITY glib-Hash-Tables SYSTEM "xml/hash_tables.xml">
  39 <!ENTITY glib-Strings SYSTEM "xml/strings.xml">
  40 <!ENTITY glib-String-Chunks SYSTEM "xml/string_chunks.xml">
  41 <!ENTITY glib-Arrays SYSTEM "xml/arrays.xml">
  42 <!ENTITY glib-Pointer-Arrays SYSTEM "xml/arrays_pointer.xml">
  43 <!ENTITY glib-Byte-Arrays SYSTEM "xml/arrays_byte.xml">
  44 <!ENTITY glib-Balanced-Binary-Trees SYSTEM "xml/trees-binary.xml">
  45 <!ENTITY glib-N-ary-Trees SYSTEM "xml/trees-nary.xml">
  46 <!ENTITY glib-Quarks SYSTEM "xml/quarks.xml">
  47 <!ENTITY glib-Keyed-Data-Lists SYSTEM "xml/datalist.xml">
  48 <!ENTITY glib-Datasets SYSTEM "xml/datasets.xml">
  49 <!ENTITY glib-Relations-and-Tuples SYSTEM "xml/relations.xml">
  50 <!ENTITY glib-Caches SYSTEM "xml/caches.xml">
  51 <!ENTITY glib-Memory-Allocators SYSTEM "xml/allocators.xml">
  52 <!ENTITY glib-Spawn SYSTEM "xml/spawn.xml">
  53 <!ENTITY glib-Fileutils SYSTEM "xml/fileutils.xml">
  54 <!ENTITY glib-Shell SYSTEM "xml/shell.xml">
  55 <!ENTITY glib-Markup SYSTEM "xml/markup.xml">
  56
  57 <!ENTITY glib-Compiling SYSTEM "compiling.sgml">
  58 <!ENTITY glib-Building SYSTEM "building.sgml">
  59 <!ENTITY glib-Cross SYSTEM "cross.sgml">
  60 <!ENTITY glib-Running SYSTEM "running.sgml">
  61 <!ENTITY glib-Resources SYSTEM "resources.sgml">
  62 <!ENTITY glib-Changes SYSTEM "changes.sgml">
  63
  64 <!ENTITY version SYSTEM "version.xml">
  65 ]>
  66 <book id="index">
  67   <bookinfo>
  68     <title>GLib Reference Manual</title>
  69     <releaseinfo>for GLib &version;</releaseinfo>
  70   </bookinfo>
  71
  72   <chapter id="glib">
  73     <title>GLib Overview</title>
  74     <para>
  75 GLib is a general-purpose utility library, which provides many useful data
  76 types, macros, type conversions, string utilities, file utilities, a main
  77 loop abstraction, and so on. It works on many UNIX-like platforms, Windows,
  78 OS/2 and BeOS. GLib is released under the GNU Library General Public License
  79 (GNU LGPL).
  80     </para>
  81     <para>
  82 GLib depends on the following:
  83 <variablelist>
  84
  85 <varlistentry>
  86 <term><function>iconv()</function></term>
  87 <listitem><para>
  88 In order to implement conversions between character sets,
  89 GLib requires an implementation of the standard <function>iconv()</function>
  90 routine. Most modern systems will have a suitable implementation, however
  91 many older systems lack an <function>iconv()</function> implementation. On
  92 such systems, you must install the
  93 <ulink url="http://clisp.cons.org/~haible/packages-libiconv.html">libiconv</ulink> library.
  94 </para></listitem>
  95 </varlistentry>
  96
  97 <varlistentry>
  98 <term>a thread implementation</term>
  99 <listitem><para>
 100 The thread support in GLib can be based upon several native thread
 101 implementations, e.g. POSIX threads, DCE threads or Solaris threads.
 102 </para></listitem>
 103 </varlistentry>
 104
 105 </variablelist>
 106     </para>
 107
 108     &glib-Building;
 109     &glib-Cross;
 110     &glib-Compiling;
 111     &glib-Running;
 112     &glib-Changes;
 113     &glib-Resources;
 114
 115   </chapter>
 116
 117   <chapter id="glib-fundamentals">
 118     <title>GLib Fundamentals</title>
 119     &glib-Basic-Types;
 120     &glib-Limits-of-Basic-Types;
 121     &glib-Standard-Macros;
 122     &glib-Type-Conversion-Macros;
 123     &glib-Byte-Order-Macros;
 124     &glib-Numerical-Definitions;
 125     &glib-Miscellaneous-Macros;
 126   </chapter>
 127
 128   <chapter id="glib-core">
 129     <title>GLib Core Application Support</title>
 130     &glib-The-Main-Event-Loop;
 131     &glib-Threads;
 132     &glib-Thread-Pools;
 133     &glib-Async-Queues;
 134     &glib-Dynamic-Loading-of-Modules;
 135     &glib-Memory-Allocation;
 136     &glib-IO-Channels;
 137     &glib-Error-Reporting;
 138     &glib-Warnings-and-Assertions;
 139     &glib-Message-Logging;
 140   </chapter>
 141
 142   <chapter id="glib-utilities">
 143     <title>GLib Utilities</title>
 144     &glib-String-Utility-Functions;
 145     &glib-Character-Set-Conversion;
 146     &glib-Unicode-Manipulation;
 147     &glib-Date-and-Time-Functions;
 148     &glib-Random-Numbers;
 149     &glib-Hook-Functions;
 150     &glib-Miscellaneous-Utility-Functions;
 151     &glib-Lexical-Scanner;
 152     &glib-Automatic-String-Completion;
 153     &glib-Timers;
 154     &glib-Spawn;
 155     &glib-Fileutils;
 156     &glib-Shell;
 157     &glib-Pattern-Matching;
 158     &glib-Markup;
 159     &glib-Windows-Compatability-Functions;
 160   </chapter>
 161
 162   <chapter id="glib-data-types">
 163     <title>GLib Data Types</title>
 164     &glib-Memory-Chunks;
 165     &glib-Doubly-Linked-Lists;
 166     &glib-Singly-Linked-Lists;
 167     &glib-Double-ended-Queues;
 168     &glib-Trash-Stacks;
 169     &glib-Hash-Tables;
 170     &glib-Strings;
 171     &glib-String-Chunks;
 172     &glib-Arrays;
 173     &glib-Pointer-Arrays;
 174     &glib-Byte-Arrays;
 175     &glib-Balanced-Binary-Trees;
 176     &glib-N-ary-Trees;
 177     &glib-Quarks;
 178     &glib-Keyed-Data-Lists;
 179     &glib-Datasets;
 180     &glib-Relations-and-Tuples;
 181     &glib-Caches;
 182     &glib-Memory-Allocators;
 183   </chapter>
 184 </book>