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