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