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 <!ENTITY gtester SYSTEM "gtester.xml">
  80 <!ENTITY gtester-report SYSTEM "gtester-report.xml">
  81
  82 <!ENTITY version SYSTEM "version.xml">
  83 ]>
  84 <book id="index">
  85   <bookinfo>
  86     <title>GLib Reference Manual</title>
  87     <releaseinfo>
  88       for GLib &version;
  89       The latest version of this documentation can be found on-line at
  90       <ulink role="online-location" url="http://library.gnome.org/devel/glib/unstable/">http://library.gnome.org/devel/glib/unstable/</ulink>.
  91     </releaseinfo>
  92   </bookinfo>
  93
  94   <chapter id="glib">
  95     <title>GLib Overview</title>
  96     <para>
  97 GLib is a general-purpose utility library, which provides many useful data
  98 types, macros, type conversions, string utilities, file utilities, a main
  99 loop abstraction, and so on. It works on many UNIX-like platforms, Windows,
 100 OS/2 and BeOS. GLib is released under the GNU Library General Public License
 101 (GNU LGPL).
 102     </para>
 103     <para>
 104 The general policy of GLib is that all functions are invisibly threadsafe with the
 105 exception of data structure manipulation functions, where, if you have two threads
 106 manipulating the <emphasis>same</emphasis> data structure, they must use a lock to
 107 synchronize their operation.
 108     </para>
 109
 110     &glib-Building;
 111     &glib-Cross;
 112     &glib-Compiling;
 113     &glib-Running;
 114     &glib-Changes;
 115     &glib-RegexSyntax;
 116     &glib-Resources;
 117
 118   </chapter>
 119
 120   <chapter id="glib-fundamentals">
 121     <title>GLib Fundamentals</title>
 122     &glib-Version;
 123     &glib-Basic-Types;
 124     &glib-Limits-of-Basic-Types;
 125     &glib-Standard-Macros;
 126     &glib-Type-Conversion-Macros;
 127     &glib-Byte-Order-Macros;
 128     &glib-Numerical-Definitions;
 129     &glib-Miscellaneous-Macros;
 130     &glib-Atomic-Operations;
 131   </chapter>
 132
 133   <chapter id="glib-core">
 134     <title>GLib Core Application Support</title>
 135     &glib-The-Main-Event-Loop;
 136     &glib-Threads;
 137     &glib-Thread-Pools;
 138     &glib-Async-Queues;
 139     &glib-Dynamic-Loading-of-Modules;
 140     &glib-Memory-Allocation;
 141     &glib-IO-Channels;
 142     &glib-Error-Reporting;
 143     &glib-Warnings-and-Assertions;
 144     &glib-Message-Logging;
 145   </chapter>
 146
 147   <chapter id="glib-utilities">
 148     <title>GLib Utilities</title>
 149     &glib-String-Utility-Functions;
 150     &glib-Character-Set-Conversion;
 151     &glib-Unicode-Manipulation;
 152     &glib-Base64;
 153     &glib-Checksum;
 154     &glib-i18n;
 155     &glib-Date-and-Time-Functions;
 156     &glib-Random-Numbers;
 157     &glib-Hook-Functions;
 158     &glib-Miscellaneous-Utility-Functions;
 159     &glib-Lexical-Scanner;
 160     &glib-Automatic-String-Completion;
 161     &glib-Timers;
 162     &glib-Spawn;
 163     &glib-Fileutils;
 164     &glib-Uri;
 165     &glib-Shell;
 166     &glib-Option;
 167     &glib-Pattern-Matching;
 168     &glib-Regex;
 169     &glib-Markup;
 170     &glib-Keyfile;
 171     &glib-Bookmarkfile;
 172     &glib-Testing;
 173     &glib-Windows-Compatibility-Functions;
 174   </chapter>
 175
 176   <chapter id="glib-data-types">
 177     <title>GLib Data Types</title>
 178     &glib-Memory-Slices;
 179     &glib-Memory-Chunks;
 180     &glib-Doubly-Linked-Lists;
 181     &glib-Singly-Linked-Lists;
 182     &glib-Double-ended-Queues;
 183     &glib-Sequences;
 184     &glib-Trash-Stacks;
 185     &glib-Hash-Tables;
 186     &glib-Strings;
 187     &glib-String-Chunks;
 188     &glib-Arrays;
 189     &glib-Pointer-Arrays;
 190     &glib-Byte-Arrays;
 191     &glib-Balanced-Binary-Trees;
 192     &glib-N-ary-Trees;
 193     &glib-Quarks;
 194     &glib-Keyed-Data-Lists;
 195     &glib-Datasets;
 196     &glib-Relations-and-Tuples;
 197     &glib-Caches;
 198     &glib-Memory-Allocators;
 199   </chapter>
 200
 201   <chapter id="tools">
 202     <title>GLib Tools</title>
 203
 204     &glib-gettextize;
 205     &gtester;
 206     &gtester-report;
 207   </chapter>
 208
 209   <index>
 210     <title>Index</title>
 211   </index>
 212   <index role="deprecated">
 213     <title>Index of deprecated symbols</title>
 214   </index>
 215   <index role="2.2">
 216     <title>Index of new symbols in 2.2</title>
 217   </index>
 218   <index role="2.4">
 219     <title>Index of new symbols in 2.4</title>
 220   </index>
 221   <index role="2.6">
 222     <title>Index of new symbols in 2.6</title>
 223   </index>
 224   <index role="2.8">
 225     <title>Index of new symbols in 2.8</title>
 226   </index>
 227   <index role="2.10">
 228     <title>Index of new symbols in 2.10</title>
 229   </index>
 230   <index role="2.12">
 231     <title>Index of new symbols in 2.12</title>
 232   </index>
 233   <index role="2.14">
 234     <title>Index of new symbols in 2.14</title>
 235   </index>
 236   <index role="2.16">
 237     <title>Index of new symbols in 2.16</title>
 238   </index>
 239   <index role="2.18">
 240     <title>Index of new symbols in 2.18</title>
 241   </index>
 242   <index role="2.20">
 243     <title>Index of new symbols in 2.20</title>
 244   </index>
 245
 246 </book>