glib-docs.sgml 8.67 KB
Newer Older
1 2 3 4 5 6 7 8 9 10
<?xml version="1.0"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
<!ENTITY glib-Basic-Types SYSTEM "xml/types.xml">
<!ENTITY glib-Limits-of-Basic-Types SYSTEM "xml/limits.xml">
<!ENTITY glib-Standard-Macros SYSTEM "xml/macros.xml">
<!ENTITY glib-Type-Conversion-Macros SYSTEM "xml/type_conversion.xml">
<!ENTITY glib-Byte-Order-Macros SYSTEM "xml/byte_order.xml">
<!ENTITY glib-Numerical-Definitions SYSTEM "xml/numerical.xml">
<!ENTITY glib-Miscellaneous-Macros SYSTEM "xml/macros_misc.xml">
11
<!ENTITY glib-Atomic-Operations SYSTEM "xml/atomic_operations.xml">
12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32
<!ENTITY glib-Memory-Allocation SYSTEM "xml/memory.xml">
<!ENTITY glib-Error-Reporting SYSTEM "xml/error_reporting.xml">
<!ENTITY glib-Warnings-and-Assertions SYSTEM "xml/warnings.xml">
<!ENTITY glib-Message-Logging SYSTEM "xml/messages.xml">
<!ENTITY glib-Pattern-Matching SYSTEM "xml/patterns.xml">
<!ENTITY glib-Timers SYSTEM "xml/timers.xml">
<!ENTITY glib-String-Utility-Functions SYSTEM "xml/string_utils.xml">
<!ENTITY glib-Character-Set-Conversion SYSTEM "xml/conversions.xml">
<!ENTITY glib-Unicode-Manipulation SYSTEM "xml/unicode.xml">
<!ENTITY glib-Random-Numbers SYSTEM "xml/random_numbers.xml">
<!ENTITY glib-Miscellaneous-Utility-Functions SYSTEM "xml/misc_utils.xml">
<!ENTITY glib-Date-and-Time-Functions SYSTEM "xml/date.xml">
<!ENTITY glib-The-Main-Event-Loop SYSTEM "xml/main.xml">
<!ENTITY glib-Threads SYSTEM "xml/threads.xml">
<!ENTITY glib-Thread-Pools SYSTEM "xml/thread_pools.xml">
<!ENTITY glib-Async-Queues SYSTEM "xml/async_queues.xml">
<!ENTITY glib-IO-Channels SYSTEM "xml/iochannels.xml">
<!ENTITY glib-Hook-Functions SYSTEM "xml/hooks.xml">
<!ENTITY glib-Lexical-Scanner SYSTEM "xml/scanner.xml">
<!ENTITY glib-Dynamic-Loading-of-Modules SYSTEM "xml/modules.xml">
<!ENTITY glib-Automatic-String-Completion SYSTEM "xml/completion.xml">
Stepan Kasal's avatar
typo  
Stepan Kasal committed
33
<!ENTITY glib-Windows-Compatibility-Functions SYSTEM "xml/windows.xml">
34
<!ENTITY glib-Memory-Chunks SYSTEM "xml/memory_chunks.xml">
Matthias Clasen's avatar
Matthias Clasen committed
35
<!ENTITY glib-Memory-Slices SYSTEM "xml/memory_slices.xml">
36 37 38
<!ENTITY glib-Doubly-Linked-Lists SYSTEM "xml/linked_lists_double.xml">
<!ENTITY glib-Singly-Linked-Lists SYSTEM "xml/linked_lists_single.xml">
<!ENTITY glib-Double-ended-Queues SYSTEM "xml/queue.xml">
39
<!ENTITY glib-Sequences SYSTEM "xml/sequence.xml">
40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57
<!ENTITY glib-Trash-Stacks SYSTEM "xml/trash_stack.xml">
<!ENTITY glib-Hash-Tables SYSTEM "xml/hash_tables.xml">
<!ENTITY glib-Strings SYSTEM "xml/strings.xml">
<!ENTITY glib-String-Chunks SYSTEM "xml/string_chunks.xml">
<!ENTITY glib-Arrays SYSTEM "xml/arrays.xml">
<!ENTITY glib-Pointer-Arrays SYSTEM "xml/arrays_pointer.xml">
<!ENTITY glib-Byte-Arrays SYSTEM "xml/arrays_byte.xml">
<!ENTITY glib-Balanced-Binary-Trees SYSTEM "xml/trees-binary.xml">
<!ENTITY glib-N-ary-Trees SYSTEM "xml/trees-nary.xml">
<!ENTITY glib-Quarks SYSTEM "xml/quarks.xml">
<!ENTITY glib-Keyed-Data-Lists SYSTEM "xml/datalist.xml">
<!ENTITY glib-Datasets SYSTEM "xml/datasets.xml">
<!ENTITY glib-Relations-and-Tuples SYSTEM "xml/relations.xml">
<!ENTITY glib-Caches SYSTEM "xml/caches.xml">
<!ENTITY glib-Memory-Allocators SYSTEM "xml/allocators.xml">
<!ENTITY glib-Spawn SYSTEM "xml/spawn.xml">
<!ENTITY glib-Fileutils SYSTEM "xml/fileutils.xml">
<!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">
Matthias Clasen's avatar
Matthias Clasen committed
62
<!ENTITY glib-Base64 SYSTEM "xml/base64.xml">
Emmanuele Bassi's avatar
Emmanuele Bassi committed
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">
Matthias Clasen's avatar
Matthias Clasen committed
67
<!ENTITY glib-Uri SYSTEM "xml/gurifuncs.xml">
Matthias Clasen's avatar
Matthias Clasen committed
68
<!ENTITY glib-Testing SYSTEM "xml/testing.xml">
69
<!ENTITY glib-Hostutils SYSTEM "xml/ghostutils.xml">
70

71 72
<!ENTITY glib-Compiling SYSTEM "compiling.sgml">
<!ENTITY glib-Building SYSTEM "building.sgml">
73
<!ENTITY glib-Cross SYSTEM "cross.sgml">
74 75
<!ENTITY glib-Running SYSTEM "running.sgml">
<!ENTITY glib-Resources SYSTEM "resources.sgml">
76
<!ENTITY glib-Changes SYSTEM "changes.sgml">
77
<!ENTITY glib-RegexSyntax SYSTEM "regex-syntax.sgml">
Matthias Clasen's avatar
Matthias Clasen committed
78

79
<!ENTITY glib-gettextize SYSTEM "glib-gettextize.xml">
Matthias Clasen's avatar
Matthias Clasen committed
80 81
<!ENTITY gtester SYSTEM "gtester.xml">
<!ENTITY gtester-report SYSTEM "gtester-report.xml">
82

83
<!ENTITY version SYSTEM "version.xml">
Owen Taylor's avatar
Owen Taylor committed
84 85 86 87
]>
<book id="index">
  <bookinfo>
    <title>GLib Reference Manual</title>
88 89 90 91 92
    <releaseinfo>
      for GLib &version;
      The latest version of this documentation can be found on-line at
      <ulink role="online-location" url="http://library.gnome.org/devel/glib/unstable/">http://library.gnome.org/devel/glib/unstable/</ulink>.
    </releaseinfo>
Owen Taylor's avatar
Owen Taylor committed
93 94
  </bookinfo>

Matthias Clasen's avatar
Matthias Clasen committed
95 96 97 98 99 100 101 102 103
  <chapter id="glib">
    <title>GLib Overview</title>
    <para>
GLib is a general-purpose utility library, which provides many useful data 
types, macros, type conversions, string utilities, file utilities, a main 
loop abstraction, and so on. It works on many UNIX-like platforms, Windows,
OS/2 and BeOS. GLib is released under the GNU Library General Public License 
(GNU LGPL). 
    </para>
104 105 106 107 108 109
    <para>
The general policy of GLib is that all functions are invisibly threadsafe with the 
exception of data structure manipulation functions, where, if you have two threads
manipulating the <emphasis>same</emphasis> data structure, they must use a lock to
synchronize their operation.
    </para>
Matthias Clasen's avatar
Matthias Clasen committed
110 111

    &glib-Building;
112
    &glib-Cross;
Matthias Clasen's avatar
Matthias Clasen committed
113 114
    &glib-Compiling;
    &glib-Running;
115
    &glib-Changes;
116
    &glib-RegexSyntax;
Matthias Clasen's avatar
Matthias Clasen committed
117 118 119 120
    &glib-Resources;
 
  </chapter> 

Owen Taylor's avatar
Owen Taylor committed
121 122
  <chapter id="glib-fundamentals">
    <title>GLib Fundamentals</title>
123
    &glib-Version;
Owen Taylor's avatar
Owen Taylor committed
124 125 126 127 128
    &glib-Basic-Types;
    &glib-Limits-of-Basic-Types;
    &glib-Standard-Macros;
    &glib-Type-Conversion-Macros;
    &glib-Byte-Order-Macros;
129
    &glib-Numerical-Definitions;
Owen Taylor's avatar
Owen Taylor committed
130
    &glib-Miscellaneous-Macros;
131
    &glib-Atomic-Operations;
Owen Taylor's avatar
Owen Taylor committed
132 133 134 135 136 137
  </chapter>

  <chapter id="glib-core">
    <title>GLib Core Application Support</title>
    &glib-The-Main-Event-Loop;
    &glib-Threads;
138 139
    &glib-Thread-Pools;
    &glib-Async-Queues;
Owen Taylor's avatar
Owen Taylor committed
140 141 142
    &glib-Dynamic-Loading-of-Modules;
    &glib-Memory-Allocation;
    &glib-IO-Channels;
143
    &glib-Error-Reporting;
Owen Taylor's avatar
Owen Taylor committed
144 145 146 147 148 149 150
    &glib-Warnings-and-Assertions;
    &glib-Message-Logging;
  </chapter>

  <chapter id="glib-utilities">
    <title>GLib Utilities</title>
    &glib-String-Utility-Functions;
151
    &glib-Character-Set-Conversion;
152
    &glib-Unicode-Manipulation;
Matthias Clasen's avatar
Matthias Clasen committed
153
    &glib-Base64;
Emmanuele Bassi's avatar
Emmanuele Bassi committed
154
    &glib-Checksum;
155
    &glib-i18n;
Owen Taylor's avatar
Owen Taylor committed
156
    &glib-Date-and-Time-Functions;
157
    &glib-Random-Numbers;   
Owen Taylor's avatar
Owen Taylor committed
158 159 160 161 162
    &glib-Hook-Functions;
    &glib-Miscellaneous-Utility-Functions;
    &glib-Lexical-Scanner;
    &glib-Automatic-String-Completion;
    &glib-Timers;
163 164
    &glib-Spawn;
    &glib-Fileutils;
Matthias Clasen's avatar
Matthias Clasen committed
165
    &glib-Uri;
166
    &glib-Hostutils;
167
    &glib-Shell;
168
    &glib-Option;
169
    &glib-Pattern-Matching;
170
    &glib-Regex;
171
    &glib-Markup;
172
    &glib-Keyfile;
173
    &glib-Bookmarkfile;
Matthias Clasen's avatar
Matthias Clasen committed
174
    &glib-Testing;
Stepan Kasal's avatar
typo  
Stepan Kasal committed
175
    &glib-Windows-Compatibility-Functions;
Owen Taylor's avatar
Owen Taylor committed
176 177 178 179
  </chapter>

  <chapter id="glib-data-types">
    <title>GLib Data Types</title>
Matthias Clasen's avatar
Matthias Clasen committed
180
    &glib-Memory-Slices;
Owen Taylor's avatar
Owen Taylor committed
181 182 183
    &glib-Memory-Chunks;
    &glib-Doubly-Linked-Lists;
    &glib-Singly-Linked-Lists;
184
    &glib-Double-ended-Queues;
185
    &glib-Sequences;
186
    &glib-Trash-Stacks;
Owen Taylor's avatar
Owen Taylor committed
187 188 189 190 191 192 193 194 195 196 197 198 199 200 201
    &glib-Hash-Tables;
    &glib-Strings;
    &glib-String-Chunks;
    &glib-Arrays;
    &glib-Pointer-Arrays;
    &glib-Byte-Arrays;
    &glib-Balanced-Binary-Trees;
    &glib-N-ary-Trees;
    &glib-Quarks;
    &glib-Keyed-Data-Lists;
    &glib-Datasets;
    &glib-Relations-and-Tuples;
    &glib-Caches;
    &glib-Memory-Allocators;
  </chapter>
202 203 204 205 206

  <chapter id="tools">
    <title>GLib Tools</title>

    &glib-gettextize;
Matthias Clasen's avatar
Matthias Clasen committed
207 208
    &gtester;
    &gtester-report;
209 210
  </chapter>

Matthias Clasen's avatar
Matthias Clasen committed
211 212 213 214 215 216 217 218 219 220 221 222
  <index>
    <title>Index</title>
  </index>
  <index role="deprecated">
    <title>Index of deprecated symbols</title>
  </index>
  <index role="2.2">
    <title>Index of new symbols in 2.2</title>
  </index>
  <index role="2.4">
    <title>Index of new symbols in 2.4</title>
  </index>  
223 224 225
  <index role="2.6">
    <title>Index of new symbols in 2.6</title>
  </index>  
Matthias Clasen's avatar
Matthias Clasen committed
226 227 228
  <index role="2.8">
    <title>Index of new symbols in 2.8</title>
  </index>  
Matthias Clasen's avatar
Matthias Clasen committed
229 230 231
  <index role="2.10">
    <title>Index of new symbols in 2.10</title>
  </index>  
Matthias Clasen's avatar
Matthias Clasen committed
232 233 234
  <index role="2.12">
    <title>Index of new symbols in 2.12</title>
  </index>  
Matthias Clasen's avatar
Matthias Clasen committed
235 236 237
  <index role="2.14">
    <title>Index of new symbols in 2.14</title>
  </index>  
Matthias Clasen's avatar
Matthias Clasen committed
238 239 240
  <index role="2.16">
    <title>Index of new symbols in 2.16</title>
  </index>  
Matthias Clasen's avatar
Matthias Clasen committed
241 242 243
  <index role="2.18">
    <title>Index of new symbols in 2.18</title>
  </index>  
Matthias Clasen's avatar
2.19.0  
Matthias Clasen committed
244 245 246
  <index role="2.20">
    <title>Index of new symbols in 2.20</title>
  </index>  
Matthias Clasen's avatar
Matthias Clasen committed
247 248 249
  <index role="2.22">
    <title>Index of new symbols in 2.22</title>
  </index>  
Matthias Clasen's avatar
Matthias Clasen committed
250

Matthias Clasen's avatar
Matthias Clasen committed
251
</book>