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