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-Atomic-Operations SYSTEM "xml/atomic_operations.xml">
  12 <!ENTITY glib-Memory-Allocation SYSTEM "xml/memory.xml">
  13 <!ENTITY glib-Error-Reporting SYSTEM "xml/error_reporting.xml">
  14 <!ENTITY glib-Warnings-and-Assertions SYSTEM "xml/warnings.xml">
  15 <!ENTITY glib-Message-Logging SYSTEM "xml/messages.xml">
  16 <!ENTITY glib-Pattern-Matching SYSTEM "xml/patterns.xml">
  17 <!ENTITY glib-Timers SYSTEM "xml/timers.xml">
  18 <!ENTITY glib-String-Utility-Functions SYSTEM "xml/string_utils.xml">
  19 <!ENTITY glib-Character-Set-Conversion SYSTEM "xml/conversions.xml">
  20 <!ENTITY glib-Unicode-Manipulation SYSTEM "xml/unicode.xml">
  21 <!ENTITY glib-Random-Numbers SYSTEM "xml/random_numbers.xml">
  22 <!ENTITY glib-Miscellaneous-Utility-Functions SYSTEM "xml/misc_utils.xml">
  23 <!ENTITY glib-Date-and-Time-Functions SYSTEM "xml/date.xml">
  24 <!ENTITY glib-The-Main-Event-Loop SYSTEM "xml/main.xml">
  25 <!ENTITY glib-Threads SYSTEM "xml/threads.xml">
  26 <!ENTITY glib-Thread-Pools SYSTEM "xml/thread_pools.xml">
  27 <!ENTITY glib-Async-Queues SYSTEM "xml/async_queues.xml">
  28 <!ENTITY glib-IO-Channels SYSTEM "xml/iochannels.xml">
  29 <!ENTITY glib-Hook-Functions SYSTEM "xml/hooks.xml">
  30 <!ENTITY glib-Lexical-Scanner SYSTEM "xml/scanner.xml">
  31 <!ENTITY glib-Dynamic-Loading-of-Modules SYSTEM "xml/modules.xml">
  32 <!ENTITY glib-Automatic-String-Completion SYSTEM "xml/completion.xml">
  33 <!ENTITY glib-Windows-Compatibility-Functions SYSTEM "xml/windows.xml">
  34 <!ENTITY glib-Memory-Chunks SYSTEM "xml/memory_chunks.xml">
  35 <!ENTITY glib-Memory-Slices SYSTEM "xml/memory_slices.xml">
  36 <!ENTITY glib-Doubly-Linked-Lists SYSTEM "xml/linked_lists_double.xml">
  37 <!ENTITY glib-Singly-Linked-Lists SYSTEM "xml/linked_lists_single.xml">
  38 <!ENTITY glib-Double-ended-Queues SYSTEM "xml/queue.xml">
  39 <!ENTITY glib-Sequences SYSTEM "xml/sequence.xml">
  40 <!ENTITY glib-Trash-Stacks SYSTEM "xml/trash_stack.xml">
  41 <!ENTITY glib-Hash-Tables SYSTEM "xml/hash_tables.xml">
  42 <!ENTITY glib-Strings SYSTEM "xml/strings.xml">
  43 <!ENTITY glib-String-Chunks SYSTEM "xml/string_chunks.xml">
  44 <!ENTITY glib-Arrays SYSTEM "xml/arrays.xml">
  45 <!ENTITY glib-Pointer-Arrays SYSTEM "xml/arrays_pointer.xml">
  46 <!ENTITY glib-Byte-Arrays SYSTEM "xml/arrays_byte.xml">
  47 <!ENTITY glib-Balanced-Binary-Trees SYSTEM "xml/trees-binary.xml">
  48 <!ENTITY glib-N-ary-Trees SYSTEM "xml/trees-nary.xml">
  49 <!ENTITY glib-Quarks SYSTEM "xml/quarks.xml">
  50 <!ENTITY glib-Keyed-Data-Lists SYSTEM "xml/datalist.xml">
  51 <!ENTITY glib-Datasets SYSTEM "xml/datasets.xml">
  52 <!ENTITY glib-Relations-and-Tuples SYSTEM "xml/relations.xml">
  53 <!ENTITY glib-Caches SYSTEM "xml/caches.xml">
  54 <!ENTITY glib-Memory-Allocators SYSTEM "xml/allocators.xml">
  55 <!ENTITY glib-Spawn SYSTEM "xml/spawn.xml">
  56 <!ENTITY glib-Fileutils SYSTEM "xml/fileutils.xml">
  57 <!ENTITY glib-Shell SYSTEM "xml/shell.xml">
  58 <!ENTITY glib-Option SYSTEM "xml/option.xml">
  59 <!ENTITY glib-Markup SYSTEM "xml/markup.xml">
  60 <!ENTITY glib-Keyfile SYSTEM "xml/keyfile.xml">
  61 <!ENTITY glib-Bookmarkfile SYSTEM "xml/bookmarkfile.xml">
  62 <!ENTITY glib-Base64 SYSTEM "xml/base64.xml">
  63 <!ENTITY glib-Checksum SYSTEM "xml/checksum.xml">
  64 <!ENTITY glib-i18n SYSTEM "xml/i18n.xml">
  65 <!ENTITY glib-Regex SYSTEM "xml/gregex.xml">
  66 <!ENTITY glib-Version SYSTEM "xml/version.xml">
  67 <!ENTITY glib-Uri SYSTEM "xml/gurifuncs.xml">
  68 <!ENTITY glib-Testing SYSTEM "xml/testing.xml">
  69
  70 <!ENTITY glib-Compiling SYSTEM "compiling.sgml">
  71 <!ENTITY glib-Building SYSTEM "building.sgml">
  72 <!ENTITY glib-Cross SYSTEM "cross.sgml">
  73 <!ENTITY glib-Running SYSTEM "running.sgml">
  74 <!ENTITY glib-Resources SYSTEM "resources.sgml">
  75 <!ENTITY glib-Changes SYSTEM "changes.sgml">
  76 <!ENTITY glib-RegexSyntax SYSTEM "regex-syntax.sgml">
  77
  78 <!ENTITY glib-gettextize SYSTEM "glib-gettextize.xml">
  79
  80 <!ENTITY version SYSTEM "version.xml">
  81 ]>
  82 <book id="index">
  83   <bookinfo>
  84     <title>GLib Reference Manual</title>
  85     <releaseinfo>for GLib &version;</releaseinfo>
  86   </bookinfo>
  87
  88   <chapter id="glib">
  89     <title>GLib Overview</title>
  90     <para>
  91 GLib is a general-purpose utility library, which provides many useful data
  92 types, macros, type conversions, string utilities, file utilities, a main
  93 loop abstraction, and so on. It works on many UNIX-like platforms, Windows,
  94 OS/2 and BeOS. GLib is released under the GNU Library General Public License
  95 (GNU LGPL).
  96     </para>
  97     <para>
  98 The general policy of GLib is that all functions are invisibly threadsafe with the
  99 exception of data structure manipulation functions, where, if you have two threads
 100 manipulating the <emphasis>same</emphasis> data structure, they must use a lock to
 101 synchronize their operation.
 102     </para>
 103
 104     &glib-Building;
 105     &glib-Cross;
 106     &glib-Compiling;
 107     &glib-Running;
 108     &glib-Changes;
 109     &glib-RegexSyntax;
 110     &glib-Resources;
 111
 112   </chapter>
 113
 114   <chapter id="glib-fundamentals">
 115     <title>GLib Fundamentals</title>
 116     &glib-Version;
 117     &glib-Basic-Types;
 118     &glib-Limits-of-Basic-Types;
 119     &glib-Standard-Macros;
 120     &glib-Type-Conversion-Macros;
 121     &glib-Byte-Order-Macros;
 122     &glib-Numerical-Definitions;
 123     &glib-Miscellaneous-Macros;
 124     &glib-Atomic-Operations;
 125   </chapter>
 126
 127   <chapter id="glib-core">
 128     <title>GLib Core Application Support</title>
 129     &glib-The-Main-Event-Loop;
 130     &glib-Threads;
 131     &glib-Thread-Pools;
 132     &glib-Async-Queues;
 133     &glib-Dynamic-Loading-of-Modules;
 134     &glib-Memory-Allocation;
 135     &glib-IO-Channels;
 136     &glib-Error-Reporting;
 137     &glib-Warnings-and-Assertions;
 138     &glib-Message-Logging;
 139   </chapter>
 140
 141   <chapter id="glib-utilities">
 142     <title>GLib Utilities</title>
 143     &glib-String-Utility-Functions;
 144     &glib-Character-Set-Conversion;
 145     &glib-Unicode-Manipulation;
 146     &glib-Base64;
 147     &glib-Checksum;
 148     &glib-i18n;
 149     &glib-Date-and-Time-Functions;
 150     &glib-Random-Numbers;
 151     &glib-Hook-Functions;
 152     &glib-Miscellaneous-Utility-Functions;
 153     &glib-Lexical-Scanner;
 154     &glib-Automatic-String-Completion;
 155     &glib-Timers;
 156     &glib-Spawn;
 157     &glib-Fileutils;
 158     &glib-Uri;
 159     &glib-Shell;
 160     &glib-Option;
 161     &glib-Pattern-Matching;
 162     &glib-Regex;
 163     &glib-Markup;
 164     &glib-Keyfile;
 165     &glib-Bookmarkfile;
 166     &glib-Testing;
 167     &glib-Windows-Compatibility-Functions;
 168   </chapter>
 169
 170   <chapter id="glib-data-types">
 171     <title>GLib Data Types</title>
 172     &glib-Memory-Slices;
 173     &glib-Memory-Chunks;
 174     &glib-Doubly-Linked-Lists;
 175     &glib-Singly-Linked-Lists;
 176     &glib-Double-ended-Queues;
 177     &glib-Sequences;
 178     &glib-Trash-Stacks;
 179     &glib-Hash-Tables;
 180     &glib-Strings;
 181     &glib-String-Chunks;
 182     &glib-Arrays;
 183     &glib-Pointer-Arrays;
 184     &glib-Byte-Arrays;
 185     &glib-Balanced-Binary-Trees;
 186     &glib-N-ary-Trees;
 187     &glib-Quarks;
 188     &glib-Keyed-Data-Lists;
 189     &glib-Datasets;
 190     &glib-Relations-and-Tuples;
 191     &glib-Caches;
 192     &glib-Memory-Allocators;
 193   </chapter>
 194
 195   <chapter id="tools">
 196     <title>GLib Tools</title>
 197
 198     &glib-gettextize;
 199   </chapter>
 200
 201   <index>
 202     <title>Index</title>
 203   </index>
 204   <index role="deprecated">
 205     <title>Index of deprecated symbols</title>
 206   </index>
 207   <index role="2.2">
 208     <title>Index of new symbols in 2.2</title>
 209   </index>
 210   <index role="2.4">
 211     <title>Index of new symbols in 2.4</title>
 212   </index>
 213   <index role="2.6">
 214     <title>Index of new symbols in 2.6</title>
 215   </index>
 216   <index role="2.8">
 217     <title>Index of new symbols in 2.8</title>
 218   </index>
 219   <index role="2.10">
 220     <title>Index of new symbols in 2.10</title>
 221   </index>
 222   <index role="2.12">
 223     <title>Index of new symbols in 2.12</title>
 224   </index>
 225   <index role="2.14">
 226     <title>Index of new symbols in 2.14</title>
 227   </index>
 228   <index role="2.16">
 229     <title>Index of new symbols in 2.16</title>
 230   </index>
 231   <index role="2.18">
 232     <title>Index of new symbols in 2.18</title>
 233   </index>
 234
 235 </book>