glib-docs.sgml 6.28 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55
<?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">
<!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">
<!ENTITY glib-Windows-Compatability-Functions SYSTEM "xml/windows.xml">
<!ENTITY glib-Memory-Chunks SYSTEM "xml/memory_chunks.xml">
<!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">
<!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">
<!ENTITY glib-Markup SYSTEM "xml/markup.xml">
56

57 58
<!ENTITY glib-Compiling SYSTEM "compiling.sgml">
<!ENTITY glib-Building SYSTEM "building.sgml">
59
<!ENTITY glib-Cross SYSTEM "cross.sgml">
60 61
<!ENTITY glib-Running SYSTEM "running.sgml">
<!ENTITY glib-Resources SYSTEM "resources.sgml">
62
<!ENTITY glib-Changes SYSTEM "changes.sgml">
Matthias Clasen's avatar
Matthias Clasen committed
63

64 65
<!ENTITY glib-gettextize SYSTEM "glib-gettextize.xml">

66
<!ENTITY version SYSTEM "version.xml">
Owen Taylor's avatar
Owen Taylor committed
67 68 69 70
]>
<book id="index">
  <bookinfo>
    <title>GLib Reference Manual</title>
71
    <releaseinfo>for GLib &version;</releaseinfo>
Owen Taylor's avatar
Owen Taylor committed
72 73
  </bookinfo>

Matthias Clasen's avatar
Matthias Clasen committed
74 75 76 77 78 79 80 81 82
  <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>
83 84 85 86 87 88
    <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
89 90

    &glib-Building;
91
    &glib-Cross;
Matthias Clasen's avatar
Matthias Clasen committed
92 93
    &glib-Compiling;
    &glib-Running;
94
    &glib-Changes;
Matthias Clasen's avatar
Matthias Clasen committed
95 96 97 98
    &glib-Resources;
 
  </chapter> 

Owen Taylor's avatar
Owen Taylor committed
99 100 101 102 103 104 105
  <chapter id="glib-fundamentals">
    <title>GLib Fundamentals</title>
    &glib-Basic-Types;
    &glib-Limits-of-Basic-Types;
    &glib-Standard-Macros;
    &glib-Type-Conversion-Macros;
    &glib-Byte-Order-Macros;
106
    &glib-Numerical-Definitions;
Owen Taylor's avatar
Owen Taylor committed
107 108 109 110 111 112 113
    &glib-Miscellaneous-Macros;
  </chapter>

  <chapter id="glib-core">
    <title>GLib Core Application Support</title>
    &glib-The-Main-Event-Loop;
    &glib-Threads;
114 115
    &glib-Thread-Pools;
    &glib-Async-Queues;
Owen Taylor's avatar
Owen Taylor committed
116 117 118
    &glib-Dynamic-Loading-of-Modules;
    &glib-Memory-Allocation;
    &glib-IO-Channels;
119
    &glib-Error-Reporting;
Owen Taylor's avatar
Owen Taylor committed
120 121 122 123 124 125 126
    &glib-Warnings-and-Assertions;
    &glib-Message-Logging;
  </chapter>

  <chapter id="glib-utilities">
    <title>GLib Utilities</title>
    &glib-String-Utility-Functions;
127
    &glib-Character-Set-Conversion;
128
    &glib-Unicode-Manipulation;
Owen Taylor's avatar
Owen Taylor committed
129
    &glib-Date-and-Time-Functions;
130
    &glib-Random-Numbers;   
Owen Taylor's avatar
Owen Taylor committed
131 132 133 134 135
    &glib-Hook-Functions;
    &glib-Miscellaneous-Utility-Functions;
    &glib-Lexical-Scanner;
    &glib-Automatic-String-Completion;
    &glib-Timers;
136 137 138
    &glib-Spawn;
    &glib-Fileutils;
    &glib-Shell;
139
    &glib-Pattern-Matching;
140
    &glib-Markup;
Owen Taylor's avatar
Owen Taylor committed
141 142 143 144 145 146 147 148
    &glib-Windows-Compatability-Functions;
  </chapter>

  <chapter id="glib-data-types">
    <title>GLib Data Types</title>
    &glib-Memory-Chunks;
    &glib-Doubly-Linked-Lists;
    &glib-Singly-Linked-Lists;
149 150
    &glib-Double-ended-Queues;
    &glib-Trash-Stacks;
Owen Taylor's avatar
Owen Taylor committed
151 152 153 154 155 156 157 158 159 160 161 162 163 164 165
    &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>
166 167 168 169 170 171 172

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

    &glib-gettextize;
  </chapter>

Matthias Clasen's avatar
Matthias Clasen committed
173 174
  <index/>

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