docs/reference/glib/html/index.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
   5 <title>GLib Reference Manual</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
   7 <link rel="home" href="index.html" title="GLib Reference Manual">
   8 <link rel="next" href="glib.html" title="GLib Overview">
   9 <meta name="generator" content="GTK-Doc V1.18 (XML mode)">
  10 <link rel="stylesheet" href="style.css" type="text/css">
  11 </head>
  12 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  13 <div class="book">
  14 <div class="titlepage">
  15 <div>
  16 <div><table class="navigation" id="top" width="100%" cellpadding="2" cellspacing="0"><tr><th valign="middle"><p class="title">GLib Reference Manual</p></th></tr></table></div>
  17 <div><p class="releaseinfo">
  18       for GLib 2.32.3
  19
  20       The latest version of this documentation can be found on-line at
  21       <a class="ulink" href="http://library.gnome.org/devel/glib/unstable/" target="_top">http://library.gnome.org/devel/glib/unstable/</a>.
  22     </p></div>
  23 </div>
  24 <hr>
  25 </div>
  26 <div class="toc"><dl>
  27 <dt><span class="chapter"><a href="glib.html">GLib Overview</a></span></dt>
  28 <dd><dl>
  29 <dt>
  30 <span class="refentrytitle"><a href="glib-building.html">Compiling the GLib package</a></span><span class="refpurpose"> — How to compile GLib itself</span>
  31 </dt>
  32 <dt>
  33 <span class="refentrytitle"><a href="glib-cross-compiling.html">Cross-compiling the GLib package</a></span><span class="refpurpose"> —
  34 How to cross-compile GLib
  35 </span>
  36 </dt>
  37 <dt>
  38 <span class="refentrytitle"><a href="glib-compiling.html">Compiling GLib Applications</a></span><span class="refpurpose"> —
  39 How to compile your GLib application
  40 </span>
  41 </dt>
  42 <dt>
  43 <span class="refentrytitle"><a href="glib-running.html">Running GLib Applications</a></span><span class="refpurpose"> —
  44 How to run and debug your GLib application
  45 </span>
  46 </dt>
  47 <dt>
  48 <span class="refentrytitle"><a href="glib-changes.html">Changes to GLib</a></span><span class="refpurpose"> —
  49 Incompatible changes made between successing versions of GLib
  50 </span>
  51 </dt>
  52 <dt>
  53 <span class="refentrytitle"><a href="glib-resources.html">Mailing lists and bug reports</a></span><span class="refpurpose"> —
  54 Getting help with GLib
  55 </span>
  56 </dt>
  57 </dl></dd>
  58 <dt><span class="chapter"><a href="glib-fundamentals.html">GLib Fundamentals</a></span></dt>
  59 <dd><dl>
  60 <dt>
  61 <span class="refentrytitle"><a href="glib-Version-Information.html">Version Information</a></span><span class="refpurpose"> — variables and functions to check the GLib version</span>
  62 </dt>
  63 <dt>
  64 <span class="refentrytitle"><a href="glib-Basic-Types.html">Basic Types</a></span><span class="refpurpose"> — standard GLib types, defined for ease-of-use
  65     and portability</span>
  66 </dt>
  67 <dt>
  68 <span class="refentrytitle"><a href="glib-Standard-Macros.html">Standard Macros</a></span><span class="refpurpose"> — commonly-used macros</span>
  69 </dt>
  70 <dt>
  71 <span class="refentrytitle"><a href="glib-Type-Conversion-Macros.html">Type Conversion Macros</a></span><span class="refpurpose"> — portably storing integers in pointer variables</span>
  72 </dt>
  73 <dt>
  74 <span class="refentrytitle"><a href="glib-Byte-Order-Macros.html">Byte Order Macros</a></span><span class="refpurpose"> — a portable way to convert between different byte orders</span>
  75 </dt>
  76 <dt>
  77 <span class="refentrytitle"><a href="glib-Numerical-Definitions.html">Numerical Definitions</a></span><span class="refpurpose"> — mathematical constants, and floating point decomposition</span>
  78 </dt>
  79 <dt>
  80 <span class="refentrytitle"><a href="glib-Miscellaneous-Macros.html">Miscellaneous Macros</a></span><span class="refpurpose"> — specialized macros which are not used often</span>
  81 </dt>
  82 <dt>
  83 <span class="refentrytitle"><a href="glib-Atomic-Operations.html">Atomic Operations</a></span><span class="refpurpose"> — basic atomic integer and pointer operations</span>
  84 </dt>
  85 </dl></dd>
  86 <dt><span class="chapter"><a href="glib-core.html">GLib Core Application Support</a></span></dt>
  87 <dd><dl>
  88 <dt>
  89 <span class="refentrytitle"><a href="glib-The-Main-Event-Loop.html">The Main Event Loop</a></span><span class="refpurpose"> — manages all available sources of events</span>
  90 </dt>
  91 <dt>
  92 <span class="refentrytitle"><a href="glib-Threads.html">Threads</a></span><span class="refpurpose"> — portable support for threads, mutexes, locks,
  93     conditions and thread private data</span>
  94 </dt>
  95 <dt>
  96 <span class="refentrytitle"><a href="glib-Thread-Pools.html">Thread Pools</a></span><span class="refpurpose"> — pools of threads to execute work concurrently</span>
  97 </dt>
  98 <dt>
  99 <span class="refentrytitle"><a href="glib-Asynchronous-Queues.html">Asynchronous Queues</a></span><span class="refpurpose"> — asynchronous communication between threads</span>
 100 </dt>
 101 <dt>
 102 <span class="refentrytitle"><a href="glib-Dynamic-Loading-of-Modules.html">Dynamic Loading of Modules</a></span><span class="refpurpose"> — portable method for dynamically loading 'plug-ins'</span>
 103 </dt>
 104 <dt>
 105 <span class="refentrytitle"><a href="glib-Memory-Allocation.html">Memory Allocation</a></span><span class="refpurpose"> — general memory-handling</span>
 106 </dt>
 107 <dt>
 108 <span class="refentrytitle"><a href="glib-Memory-Slices.html">Memory Slices</a></span><span class="refpurpose"> — efficient way to allocate groups of equal-sized
 109     chunks of memory</span>
 110 </dt>
 111 <dt>
 112 <span class="refentrytitle"><a href="glib-IO-Channels.html">IO Channels</a></span><span class="refpurpose"> — portable support for using files, pipes and
 113                     sockets</span>
 114 </dt>
 115 <dt>
 116 <span class="refentrytitle"><a href="glib-Error-Reporting.html">Error Reporting</a></span><span class="refpurpose"> — a system for reporting errors</span>
 117 </dt>
 118 <dt>
 119 <span class="refentrytitle"><a href="glib-Warnings-and-Assertions.html">Message Output and Debugging Functions</a></span><span class="refpurpose"> — functions to output messages and help debug applications</span>
 120 </dt>
 121 <dt>
 122 <span class="refentrytitle"><a href="glib-Message-Logging.html">Message Logging</a></span><span class="refpurpose"> — versatile support for logging messages
 123     with different levels of importance</span>
 124 </dt>
 125 </dl></dd>
 126 <dt><span class="chapter"><a href="glib-utilities.html">GLib Utilities</a></span></dt>
 127 <dd><dl>
 128 <dt>
 129 <span class="refentrytitle"><a href="glib-String-Utility-Functions.html">String Utility Functions</a></span><span class="refpurpose"> — various string-related functions</span>
 130 </dt>
 131 <dt>
 132 <span class="refentrytitle"><a href="glib-Character-Set-Conversion.html">Character Set Conversion</a></span><span class="refpurpose"> — convert strings between different character sets</span>
 133 </dt>
 134 <dt>
 135 <span class="refentrytitle"><a href="glib-Unicode-Manipulation.html">Unicode Manipulation</a></span><span class="refpurpose"> — functions operating on Unicode characters and
 136     UTF-8 strings</span>
 137 </dt>
 138 <dt>
 139 <span class="refentrytitle"><a href="glib-Base64-Encoding.html">Base64 Encoding</a></span><span class="refpurpose"> — encodes and decodes data in Base64 format</span>
 140 </dt>
 141 <dt>
 142 <span class="refentrytitle"><a href="glib-Data-Checksums.html">Data Checksums</a></span><span class="refpurpose"> — computes the checksum for data</span>
 143 </dt>
 144 <dt>
 145 <span class="refentrytitle"><a href="glib-Data-HMACs.html">Secure HMAC Digests</a></span><span class="refpurpose"> — computes the HMAC for data</span>
 146 </dt>
 147 <dt>
 148 <span class="refentrytitle"><a href="glib-I18N.html">Internationalization</a></span><span class="refpurpose"> — gettext support macros</span>
 149 </dt>
 150 <dt>
 151 <span class="refentrytitle"><a href="glib-Date-and-Time-Functions.html">Date and Time Functions</a></span><span class="refpurpose"> — calendrical calculations and miscellaneous time stuff</span>
 152 </dt>
 153 <dt>
 154 <span class="refentrytitle"><a href="glib-GTimeZone.html">GTimeZone</a></span><span class="refpurpose"> — a structure representing a time zone</span>
 155 </dt>
 156 <dt>
 157 <span class="refentrytitle"><a href="glib-GDateTime.html">GDateTime</a></span><span class="refpurpose"> — a structure representing Date and Time</span>
 158 </dt>
 159 <dt>
 160 <span class="refentrytitle"><a href="glib-Random-Numbers.html">Random Numbers</a></span><span class="refpurpose"> — pseudo-random number generator</span>
 161 </dt>
 162 <dt>
 163 <span class="refentrytitle"><a href="glib-Hook-Functions.html">Hook Functions</a></span><span class="refpurpose"> — support for manipulating lists of hook functions</span>
 164 </dt>
 165 <dt>
 166 <span class="refentrytitle"><a href="glib-Miscellaneous-Utility-Functions.html">Miscellaneous Utility Functions</a></span><span class="refpurpose"> — a selection of portable utility functions</span>
 167 </dt>
 168 <dt>
 169 <span class="refentrytitle"><a href="glib-Lexical-Scanner.html">Lexical Scanner</a></span><span class="refpurpose"> — a general purpose lexical scanner</span>
 170 </dt>
 171 <dt>
 172 <span class="refentrytitle"><a href="glib-Timers.html">Timers</a></span><span class="refpurpose"> — keep track of elapsed time</span>
 173 </dt>
 174 <dt>
 175 <span class="refentrytitle"><a href="glib-Spawning-Processes.html">Spawning Processes</a></span><span class="refpurpose"> — process launching</span>
 176 </dt>
 177 <dt>
 178 <span class="refentrytitle"><a href="glib-File-Utilities.html">File Utilities</a></span><span class="refpurpose"> — various file-related functions</span>
 179 </dt>
 180 <dt>
 181 <span class="refentrytitle"><a href="glib-URI-Functions.html">URI Functions</a></span><span class="refpurpose"> — manipulating URIs</span>
 182 </dt>
 183 <dt>
 184 <span class="refentrytitle"><a href="glib-Hostname-Utilities.html">Hostname Utilities</a></span><span class="refpurpose"> — Internet hostname utilities</span>
 185 </dt>
 186 <dt>
 187 <span class="refentrytitle"><a href="glib-Shell-related-Utilities.html">Shell-related Utilities</a></span><span class="refpurpose"> — shell-like commandline handling</span>
 188 </dt>
 189 <dt>
 190 <span class="refentrytitle"><a href="glib-Commandline-option-parser.html">Commandline option parser</a></span><span class="refpurpose"> — parses commandline options</span>
 191 </dt>
 192 <dt>
 193 <span class="refentrytitle"><a href="glib-Glob-style-pattern-matching.html">Glob-style pattern matching</a></span><span class="refpurpose"> — matches strings against patterns containing '*'
 194                     (wildcard) and '?' (joker)</span>
 195 </dt>
 196 <dt>
 197 <span class="refentrytitle"><a href="glib-Perl-compatible-regular-expressions.html">Perl-compatible regular expressions</a></span><span class="refpurpose"> — matches strings against regular expressions</span>
 198 </dt>
 199 <dt>
 200 <span class="refentrytitle"><a href="glib-regex-syntax.html">Regular expression syntax</a></span><span class="refpurpose"> —
 201 syntax and semantics of regular expressions supported by GRegex
 202 </span>
 203 </dt>
 204 <dt>
 205 <span class="refentrytitle"><a href="glib-Simple-XML-Subset-Parser.html">Simple XML Subset Parser</a></span><span class="refpurpose"> — parses a subset of XML</span>
 206 </dt>
 207 <dt>
 208 <span class="refentrytitle"><a href="glib-Key-value-file-parser.html">Key-value file parser</a></span><span class="refpurpose"> — parses .ini-like config files</span>
 209 </dt>
 210 <dt>
 211 <span class="refentrytitle"><a href="glib-Bookmark-file-parser.html">Bookmark file parser</a></span><span class="refpurpose"> — parses files containing bookmarks</span>
 212 </dt>
 213 <dt>
 214 <span class="refentrytitle"><a href="glib-Testing.html">Testing</a></span><span class="refpurpose"> — a test framework</span>
 215 </dt>
 216 <dt>
 217 <span class="refentrytitle"><a href="glib-UNIX-specific-utilities-and-integration.html">UNIX-specific utilities and integration</a></span><span class="refpurpose"> — pipes, signal handling</span>
 218 </dt>
 219 <dt>
 220 <span class="refentrytitle"><a href="glib-Windows-Compatibility-Functions.html">Windows Compatibility Functions</a></span><span class="refpurpose"> — UNIX emulation on Windows</span>
 221 </dt>
 222 </dl></dd>
 223 <dt><span class="chapter"><a href="glib-data-types.html">GLib Data Types</a></span></dt>
 224 <dd><dl>
 225 <dt>
 226 <span class="refentrytitle"><a href="glib-Doubly-Linked-Lists.html">Doubly-Linked Lists</a></span><span class="refpurpose"> — linked lists that can be iterated over in both directions</span>
 227 </dt>
 228 <dt>
 229 <span class="refentrytitle"><a href="glib-Singly-Linked-Lists.html">Singly-Linked Lists</a></span><span class="refpurpose"> — linked lists that can be iterated in one direction</span>
 230 </dt>
 231 <dt>
 232 <span class="refentrytitle"><a href="glib-Double-ended-Queues.html">Double-ended Queues</a></span><span class="refpurpose"> — double-ended queue data structure</span>
 233 </dt>
 234 <dt>
 235 <span class="refentrytitle"><a href="glib-Sequences.html">Sequences</a></span><span class="refpurpose"> — scalable lists</span>
 236 </dt>
 237 <dt>
 238 <span class="refentrytitle"><a href="glib-Trash-Stacks.html">Trash Stacks</a></span><span class="refpurpose"> — maintain a stack of unused allocated memory chunks</span>
 239 </dt>
 240 <dt>
 241 <span class="refentrytitle"><a href="glib-Hash-Tables.html">Hash Tables</a></span><span class="refpurpose"> — associations between keys and values so that
 242     given a key the value can be found quickly</span>
 243 </dt>
 244 <dt>
 245 <span class="refentrytitle"><a href="glib-Strings.html">Strings</a></span><span class="refpurpose"> — text buffers which grow automatically
 246     as text is added</span>
 247 </dt>
 248 <dt>
 249 <span class="refentrytitle"><a href="glib-String-Chunks.html">String Chunks</a></span><span class="refpurpose"> — efficient storage of groups of strings</span>
 250 </dt>
 251 <dt>
 252 <span class="refentrytitle"><a href="glib-Arrays.html">Arrays</a></span><span class="refpurpose"> — arrays of arbitrary elements which grow
 253                     automatically as elements are added</span>
 254 </dt>
 255 <dt>
 256 <span class="refentrytitle"><a href="glib-Pointer-Arrays.html">Pointer Arrays</a></span><span class="refpurpose"> — arrays of pointers to any type of data, which
 257                     grow automatically as new elements are added</span>
 258 </dt>
 259 <dt>
 260 <span class="refentrytitle"><a href="glib-Byte-Arrays.html">Byte Arrays</a></span><span class="refpurpose"> — arrays of bytes</span>
 261 </dt>
 262 <dt>
 263 <span class="refentrytitle"><a href="glib-Balanced-Binary-Trees.html">Balanced Binary Trees</a></span><span class="refpurpose"> — a sorted collection of key/value pairs optimized
 264                     for searching and traversing in order</span>
 265 </dt>
 266 <dt>
 267 <span class="refentrytitle"><a href="glib-N-ary-Trees.html">N-ary Trees</a></span><span class="refpurpose"> — trees of data with any number of branches</span>
 268 </dt>
 269 <dt>
 270 <span class="refentrytitle"><a href="glib-Quarks.html">Quarks</a></span><span class="refpurpose"> — a 2-way association between a string and a
 271                     unique integer identifier</span>
 272 </dt>
 273 <dt>
 274 <span class="refentrytitle"><a href="glib-Keyed-Data-Lists.html">Keyed Data Lists</a></span><span class="refpurpose"> — lists of data elements which are accessible by a
 275                     string or GQuark identifier</span>
 276 </dt>
 277 <dt>
 278 <span class="refentrytitle"><a href="glib-Datasets.html">Datasets</a></span><span class="refpurpose"> — associate groups of data elements with
 279                     particular memory locations</span>
 280 </dt>
 281 <dt>
 282 <span class="refentrytitle"><a href="glib-GVariantType.html">GVariantType</a></span><span class="refpurpose"> — introduction to the GVariant type system</span>
 283 </dt>
 284 <dt>
 285 <span class="refentrytitle"><a href="glib-GVariant.html">GVariant</a></span><span class="refpurpose"> — strongly typed value datatype</span>
 286 </dt>
 287 <dt>
 288 <span class="refentrytitle"><a href="gvariant-format-strings.html">GVariant Format Strings</a></span><span class="refpurpose"> — varargs conversion of GVariants</span>
 289 </dt>
 290 <dt>
 291 <span class="refentrytitle"><a href="gvariant-text.html">GVariant Text Format</a></span><span class="refpurpose"> — textual representation of GVariants</span>
 292 </dt>
 293 </dl></dd>
 294 <dt><span class="chapter"><a href="deprecated.html">Deprecated APIs</a></span></dt>
 295 <dd><dl>
 296 <dt>
 297 <span class="refentrytitle"><a href="glib-Deprecated-Thread-APIs.html">Deprecated thread API</a></span><span class="refpurpose"> — old thread APIs (for reference only)</span>
 298 </dt>
 299 <dt>
 300 <span class="refentrytitle"><a href="glib-Caches.html">Caches</a></span><span class="refpurpose"> — caches allow sharing of complex data structures
 301                     to save resources</span>
 302 </dt>
 303 <dt>
 304 <span class="refentrytitle"><a href="glib-Relations-and-Tuples.html">Relations and Tuples</a></span><span class="refpurpose"> — tables of data which can be indexed on any
 305                     number of fields</span>
 306 </dt>
 307 <dt>
 308 <span class="refentrytitle"><a href="glib-Automatic-String-Completion.html">Automatic String Completion</a></span><span class="refpurpose"> — support for automatic completion using a group
 309                     of target strings</span>
 310 </dt>
 311 </dl></dd>
 312 <dt><span class="chapter"><a href="tools.html">GLib Tools</a></span></dt>
 313 <dd><dl>
 314 <dt>
 315 <span class="refentrytitle"><a href="glib-gettextize.html">glib-gettextize</a></span><span class="refpurpose"> — gettext internationalization utility</span>
 316 </dt>
 317 <dt>
 318 <span class="refentrytitle"><a href="gtester.html">gtester</a></span><span class="refpurpose"> — test running utility</span>
 319 </dt>
 320 <dt>
 321 <span class="refentrytitle"><a href="gtester-report.html">gtester-report</a></span><span class="refpurpose"> — test report formatting utility</span>
 322 </dt>
 323 </dl></dd>
 324 <dt><span class="index"><a href="api-index-full.html">Index</a></span></dt>
 325 <dt><span class="index"><a href="api-index-deprecated.html">Index of deprecated symbols</a></span></dt>
 326 <dt><span class="index"><a href="api-index-2-2.html">Index of new symbols in 2.2</a></span></dt>
 327 <dt><span class="index"><a href="api-index-2-4.html">Index of new symbols in 2.4</a></span></dt>
 328 <dt><span class="index"><a href="api-index-2-6.html">Index of new symbols in 2.6</a></span></dt>
 329 <dt><span class="index"><a href="api-index-2-8.html">Index of new symbols in 2.8</a></span></dt>
 330 <dt><span class="index"><a href="api-index-2-10.html">Index of new symbols in 2.10</a></span></dt>
 331 <dt><span class="index"><a href="api-index-2-12.html">Index of new symbols in 2.12</a></span></dt>
 332 <dt><span class="index"><a href="api-index-2-14.html">Index of new symbols in 2.14</a></span></dt>
 333 <dt><span class="index"><a href="api-index-2-16.html">Index of new symbols in 2.16</a></span></dt>
 334 <dt><span class="index"><a href="api-index-2-18.html">Index of new symbols in 2.18</a></span></dt>
 335 <dt><span class="index"><a href="api-index-2-20.html">Index of new symbols in 2.20</a></span></dt>
 336 <dt><span class="index"><a href="api-index-2-22.html">Index of new symbols in 2.22</a></span></dt>
 337 <dt><span class="index"><a href="api-index-2-24.html">Index of new symbols in 2.24</a></span></dt>
 338 <dt><span class="index"><a href="api-index-2-26.html">Index of new symbols in 2.26</a></span></dt>
 339 <dt><span class="index"><a href="api-index-2-28.html">Index of new symbols in 2.28</a></span></dt>
 340 <dt><span class="index"><a href="api-index-2-30.html">Index of new symbols in 2.30</a></span></dt>
 341 <dt><span class="index"><a href="api-index-2-32.html">Index of new symbols in 2.32</a></span></dt>
 342 <dt><span class="glossary"><a href="annotation-glossary.html">Annotation Glossary</a></span></dt>
 343 </dl></div>
 344 </div>
 345 <div class="footer">
 346 <hr>
 347           Generated by GTK-Doc V1.18</div>
 348 </body>
 349 </html>