RubyGems - glib2 - Versions diffs - 2.2.5-x86-mingw32 → 3.0.0-x86-mingw32 - Mend

glib2 2.2.5-x86-mingw32 → 3.0.0-x86-mingw32

Files changed (1979) hide show

data/vendor/local/share/gtk-doc/html/glib/glib-Hook-Functions.html CHANGED Viewed

@@ -2,7 +2,7 @@
 <html>
 <head>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<title>GLib Reference Manual: Hook Functions</title>
+<title>Hook Functions: GLib Reference Manual</title>
 <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
 <link rel="home" href="index.html" title="GLib Reference Manual">
 <link rel="up" href="glib-utilities.html" title="GLib Utilities">

data/vendor/local/share/gtk-doc/html/glib/glib-Hostname-Utilities.html CHANGED Viewed

@@ -2,7 +2,7 @@
 <html>
 <head>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<title>GLib Reference Manual: Hostname Utilities</title>
+<title>Hostname Utilities: GLib Reference Manual</title>
 <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
 <link rel="home" href="index.html" title="GLib Reference Manual">
 <link rel="up" href="glib-utilities.html" title="GLib Utilities">

data/vendor/local/share/gtk-doc/html/glib/glib-I18N.html CHANGED Viewed

@@ -2,7 +2,7 @@
 <html>
 <head>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<title>GLib Reference Manual: Internationalization</title>
+<title>Internationalization: GLib Reference Manual</title>
 <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
 <link rel="home" href="index.html" title="GLib Reference Manual">
 <link rel="up" href="glib-utilities.html" title="GLib Utilities">
@@ -161,13 +161,52 @@ after defining the <code class="literal">GETTEXT_PACKAGE</code> macro suitably f
 <p>
 For an application, note that you also have to call <code class="function">bindtextdomain()</code>,
 <code class="function">bind_textdomain_codeset()</code>, <code class="function">textdomain()</code> and <a class="link" href="glib-running.html#setlocale" title="Locale"><code class="function">setlocale()</code></a> early on in your
-<code class="function">main()</code> to make <code class="function">gettext()</code> work.</p>
+<code class="function">main()</code> to make <code class="function">gettext()</code> work. For example:</p>
+<div class="informalexample">
+  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
+    <tbody>
+      <tr>
+        <td class="listing_lines" align="right"><pre>1
+2
+3
+4
+5
+6
+7
+8
+9
+10
+11
+12
+13</pre></td>
+        <td class="listing_code"><pre class="programlisting"><span class="preproc">#include</span><span class="normal"> </span><span class="string">&lt;glib/gi18n.h&gt;</span>
+<span class="preproc">#include</span><span class="normal"> </span><span class="string">&lt;locale.h&gt;</span>
+<span class="type">int</span>
+<span class="function">main</span><span class="normal"> </span><span class="symbol">(</span><span class="type">int</span><span class="normal"> argc</span><span class="symbol">,</span><span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">**</span><span class="normal">argv</span><span class="symbol">)</span>
+<span class="cbracket">{</span>
+<span class="normal">  </span><span class="function"><a href="glib-running.html#setlocale">setlocale</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">LC_ALL</span><span class="symbol">,</span><span class="normal"> </span><span class="string">""</span><span class="symbol">);</span>
+<span class="normal">  </span><span class="function">bindtextdomain</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">GETTEXT_PACKAGE</span><span class="symbol">,</span><span class="normal"> DATADIR </span><span class="string">"/locale"</span><span class="symbol">);</span>
+<span class="normal">  </span><span class="function">bind_textdomain_codeset</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">GETTEXT_PACKAGE</span><span class="symbol">,</span><span class="normal"> </span><span class="string">"UTF-8"</span><span class="symbol">);</span>
+<span class="normal">  </span><span class="function">textdomain</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">GETTEXT_PACKAGE</span><span class="symbol">);</span>
+<span class="normal">  </span><span class="comment">// Rest of your application.</span>
+<span class="cbracket">}</span></pre></td>
+      </tr>
+    </tbody>
+  </table>
+</div>
+<p>
+where <code class="literal">DATADIR</code> is as typically provided by automake.</p>
 <p>For a library, you only have to call <code class="function">bindtextdomain()</code> and
 <code class="function">bind_textdomain_codeset()</code> in your initialization function. If your library
 doesn't have an initialization function, you can call the functions before
 the first translated message.</p>
-<p>The gettext manual covers details of how to set up message extraction
-with xgettext.</p>
+<p>The
+<a class="ulink" href="http://www.gnu.org/software/gettext/manual/gettext.html#Maintainers" target="_top">gettext manual</a>
+covers details of how to integrate gettext into a project’s build system and
+workflow.</p>
 </div>
 <div class="refsect1">
 <a name="glib-I18N.functions_details"></a><h2>Functions</h2>

data/vendor/local/share/gtk-doc/html/glib/glib-IO-Channels.html CHANGED Viewed

@@ -2,7 +2,7 @@
 <html>
 <head>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<title>GLib Reference Manual: IO Channels</title>
+<title>IO Channels: GLib Reference Manual</title>
 <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
 <link rel="home" href="index.html" title="GLib Reference Manual">
 <link rel="up" href="glib-core.html" title="GLib Core Application Support">
@@ -1446,8 +1446,7 @@ You can do these steps manually if you need greater control.</p>
 </div>
 <div class="refsect3">
 <a name="id-1.4.9.7.24.7"></a><h4>Returns</h4>
-<p> the event source id
-Rename to: g_io_add_watch</p>
+<p> the event source id</p>
 <p></p>
 </div>
 </div>

data/vendor/local/share/gtk-doc/html/glib/glib-Key-value-file-parser.html CHANGED Viewed

@@ -2,7 +2,7 @@
 <html>
 <head>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<title>GLib Reference Manual: Key-value file parser</title>
+<title>Key-value file parser: GLib Reference Manual</title>
 <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
 <link rel="home" href="index.html" title="GLib Reference Manual">
 <link rel="up" href="glib-utilities.html" title="GLib Utilities">
@@ -524,6 +524,14 @@
 </tr>
 <tr>
 <td class="define_keyword">#define</td>
+<td class="function_name"><a class="link" href="glib-Key-value-file-parser.html#G-KEY-FILE-DESKTOP-KEY-ACTIONS:CAPS" title="G_KEY_FILE_DESKTOP_KEY_ACTIONS">G_KEY_FILE_DESKTOP_KEY_ACTIONS</a></td>
+</tr>
+<tr>
+<td class="define_keyword">#define</td>
+<td class="function_name"><a class="link" href="glib-Key-value-file-parser.html#G-KEY-FILE-DESKTOP-KEY-DBUS-ACTIVATABLE:CAPS" title="G_KEY_FILE_DESKTOP_KEY_DBUS_ACTIVATABLE">G_KEY_FILE_DESKTOP_KEY_DBUS_ACTIVATABLE</a></td>
+</tr>
+<tr>
+<td class="define_keyword">#define</td>
 <td class="function_name"><a class="link" href="glib-Key-value-file-parser.html#G-KEY-FILE-DESKTOP-TYPE-APPLICATION:CAPS" title="G_KEY_FILE_DESKTOP_TYPE_APPLICATION">G_KEY_FILE_DESKTOP_TYPE_APPLICATION</a></td>
 </tr>
 <tr>
@@ -3423,6 +3431,24 @@ with the <code class="literal">Link</code> type.</p>
 </div>
 <hr>
 <div class="refsect2">
+<a name="G-KEY-FILE-DESKTOP-KEY-ACTIONS:CAPS"></a><h3>G_KEY_FILE_DESKTOP_KEY_ACTIONS</h3>
+<pre class="programlisting">#define G_KEY_FILE_DESKTOP_KEY_ACTIONS          "Actions"
+</pre>
+<p>A key under <a class="link" href="glib-Key-value-file-parser.html#G-KEY-FILE-DESKTOP-GROUP:CAPS" title="G_KEY_FILE_DESKTOP_GROUP"><span class="type">G_KEY_FILE_DESKTOP_GROUP</span></a>, whose value is a string list
+giving the available application actions.</p>
+<p class="since">Since 2.38</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="G-KEY-FILE-DESKTOP-KEY-DBUS-ACTIVATABLE:CAPS"></a><h3>G_KEY_FILE_DESKTOP_KEY_DBUS_ACTIVATABLE</h3>
+<pre class="programlisting">#define G_KEY_FILE_DESKTOP_KEY_DBUS_ACTIVATABLE "DBusActivatable"
+</pre>
+<p>A key under <a class="link" href="glib-Key-value-file-parser.html#G-KEY-FILE-DESKTOP-GROUP:CAPS" title="G_KEY_FILE_DESKTOP_GROUP"><span class="type">G_KEY_FILE_DESKTOP_GROUP</span></a>, whose value is a boolean set to true
+if the application is D-Bus activatable.</p>
+<p class="since">Since 2.38</p>
+</div>
+<hr>
+<div class="refsect2">
 <a name="G-KEY-FILE-DESKTOP-TYPE-APPLICATION:CAPS"></a><h3>G_KEY_FILE_DESKTOP_TYPE_APPLICATION</h3>
 <pre class="programlisting">#define G_KEY_FILE_DESKTOP_TYPE_APPLICATION     "Application"
 </pre>

data/vendor/local/share/gtk-doc/html/glib/glib-Keyed-Data-Lists.html CHANGED Viewed

@@ -2,7 +2,7 @@
 <html>
 <head>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<title>GLib Reference Manual: Keyed Data Lists</title>
+<title>Keyed Data Lists: GLib Reference Manual</title>
 <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
 <link rel="home" href="index.html" title="GLib Reference Manual">
 <link rel="up" href="glib-data-types.html" title="GLib Data Types">

data/vendor/local/share/gtk-doc/html/glib/glib-Lexical-Scanner.html CHANGED Viewed

@@ -2,7 +2,7 @@
 <html>
 <head>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<title>GLib Reference Manual: Lexical Scanner</title>
+<title>Lexical Scanner: GLib Reference Manual</title>
 <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
 <link rel="home" href="index.html" title="GLib Reference Manual">
 <link rel="up" href="glib-utilities.html" title="GLib Utilities">
@@ -1189,8 +1189,8 @@ to construct part of the message.</p>
 <td class="parameter_description"><p>a string describing how the scanner's user
 refers to identifiers (<a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a> defaults to "identifier").
 This is used if <em class="parameter"><code>expected_token</code></em>
-is <code class="literal">G_TOKEN_IDENTIFIER</code> or
-<code class="literal">G_TOKEN_IDENTIFIER_NULL</code>.</p></td>
+is <a class="link" href="glib-Lexical-Scanner.html#G-TOKEN-IDENTIFIER:CAPS"><code class="literal">G_TOKEN_IDENTIFIER</code></a> or
+<a class="link" href="glib-Lexical-Scanner.html#G-TOKEN-IDENTIFIER-NULL:CAPS"><code class="literal">G_TOKEN_IDENTIFIER_NULL</code></a>.</p></td>
 <td class="parameter_annotations"> </td>
 </tr>
 <tr>
@@ -1198,7 +1198,7 @@ is <code class="literal">G_TOKEN_IDENTIFIER</code> or
 <td class="parameter_description"><p>a string describing how the scanner's user refers
 to symbols (<a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a> defaults to "symbol"). This is used if
 <em class="parameter"><code>expected_token</code></em>
-is <code class="literal">G_TOKEN_SYMBOL</code> or any token value greater
+is <a class="link" href="glib-Lexical-Scanner.html#G-TOKEN-SYMBOL:CAPS"><code class="literal">G_TOKEN_SYMBOL</code></a> or any token value greater
 than <code class="literal">G_TOKEN_LAST</code>.</p></td>
 <td class="parameter_annotations"> </td>
 </tr>
@@ -1523,7 +1523,7 @@ identifiers are recognized (the default is <a class="link" href="glib-Standard-M
 <tr>
 <td class="struct_member_name"><p><a class="link" href="glib-Basic-Types.html#guint" title="guint"><span class="type">guint</span></a> <em class="structfield"><code><a name="GScannerConfig.scan-identifier-NULL"></a>scan_identifier_NULL</code></em> : 1;</p></td>
 <td class="struct_member_description"><p>specifies if <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a> is reported as
-<code class="literal">G_TOKEN_IDENTIFIER_NULL</code> (the default is <a class="link" href="glib-Standard-Macros.html#FALSE:CAPS" title="FALSE"><code class="literal">FALSE</code></a>).</p></td>
+<a class="link" href="glib-Lexical-Scanner.html#G-TOKEN-IDENTIFIER-NULL:CAPS"><code class="literal">G_TOKEN_IDENTIFIER_NULL</code></a> (the default is <a class="link" href="glib-Standard-Macros.html#FALSE:CAPS" title="FALSE"><code class="literal">FALSE</code></a>).</p></td>
 <td class="struct_member_annotations"> </td>
 </tr>
 <tr>
@@ -1577,12 +1577,12 @@ quotes (the default is <a class="link" href="glib-Standard-Macros.html#TRUE:CAPS
 <tr>
 <td class="struct_member_name"><p><a class="link" href="glib-Basic-Types.html#guint" title="guint"><span class="type">guint</span></a> <em class="structfield"><code><a name="GScannerConfig.numbers-2-int"></a>numbers_2_int</code></em> : 1;</p></td>
 <td class="struct_member_description"><p>specifies if binary, octal and hexadecimal numbers
-are reported as <span class="type">G_TOKEN_INT</span> (the default is <a class="link" href="glib-Standard-Macros.html#TRUE:CAPS" title="TRUE"><code class="literal">TRUE</code></a>).</p></td>
+are reported as <a class="link" href="glib-Lexical-Scanner.html#G-TOKEN-INT:CAPS"><span class="type">G_TOKEN_INT</span></a> (the default is <a class="link" href="glib-Standard-Macros.html#TRUE:CAPS" title="TRUE"><code class="literal">TRUE</code></a>).</p></td>
 <td class="struct_member_annotations"> </td>
 </tr>
 <tr>
 <td class="struct_member_name"><p><a class="link" href="glib-Basic-Types.html#guint" title="guint"><span class="type">guint</span></a> <em class="structfield"><code><a name="GScannerConfig.int-2-float"></a>int_2_float</code></em> : 1;</p></td>
-<td class="struct_member_description"><p>specifies if all numbers are reported as <code class="literal">G_TOKEN_FLOAT</code>
+<td class="struct_member_description"><p>specifies if all numbers are reported as <a class="link" href="glib-Lexical-Scanner.html#G-TOKEN-FLOAT:CAPS"><code class="literal">G_TOKEN_FLOAT</code></a>
 (the default is <a class="link" href="glib-Standard-Macros.html#FALSE:CAPS" title="FALSE"><code class="literal">FALSE</code></a>).</p></td>
 <td class="struct_member_annotations"> </td>
 </tr>
@@ -1595,13 +1595,13 @@ are reported as <span class="type">G_TOKEN_INT</span> (the default is <a class="
 <tr>
 <td class="struct_member_name"><p><a class="link" href="glib-Basic-Types.html#guint" title="guint"><span class="type">guint</span></a> <em class="structfield"><code><a name="GScannerConfig.char-2-token"></a>char_2_token</code></em> : 1;</p></td>
 <td class="struct_member_description"><p>specifies if characters are reported by setting
-<code class="literal">token = ch</code> or as <code class="literal">G_TOKEN_CHAR</code> (the default is <a class="link" href="glib-Standard-Macros.html#TRUE:CAPS" title="TRUE"><code class="literal">TRUE</code></a>).</p></td>
+<code class="literal">token = ch</code> or as <a class="link" href="glib-Lexical-Scanner.html#G-TOKEN-CHAR:CAPS"><code class="literal">G_TOKEN_CHAR</code></a> (the default is <a class="link" href="glib-Standard-Macros.html#TRUE:CAPS" title="TRUE"><code class="literal">TRUE</code></a>).</p></td>
 <td class="struct_member_annotations"> </td>
 </tr>
 <tr>
 <td class="struct_member_name"><p><a class="link" href="glib-Basic-Types.html#guint" title="guint"><span class="type">guint</span></a> <em class="structfield"><code><a name="GScannerConfig.symbol-2-token"></a>symbol_2_token</code></em> : 1;</p></td>
 <td class="struct_member_description"><p>specifies if symbols are reported by setting
-<code class="literal">token = v_symbol</code> or as <code class="literal">G_TOKEN_SYMBOL</code> (the default is <a class="link" href="glib-Standard-Macros.html#FALSE:CAPS" title="FALSE"><code class="literal">FALSE</code></a>).</p></td>
+<code class="literal">token = v_symbol</code> or as <a class="link" href="glib-Lexical-Scanner.html#G-TOKEN-SYMBOL:CAPS"><code class="literal">G_TOKEN_SYMBOL</code></a> (the default is <a class="link" href="glib-Standard-Macros.html#FALSE:CAPS" title="FALSE"><code class="literal">FALSE</code></a>).</p></td>
 <td class="struct_member_annotations"> </td>
 </tr>
 <tr>
@@ -1713,6 +1713,132 @@ in <a class="link" href="glib-Lexical-Scanner.html#GScannerConfig" title="struct
 </td>
 <td class="enum_member_annotations"> </td>
 </tr>
+<tr>
+<td class="enum_member_name"><p><a name="G-TOKEN-LEFT-BRACE:CAPS"></a>G_TOKEN_LEFT_BRACE</p></td>
+<td class="enum_member_description">
+<p>a '[' character</p>
+</td>
+<td class="enum_member_annotations"> </td>
+</tr>
+<tr>
+<td class="enum_member_name"><p><a name="G-TOKEN-RIGHT-BRACE:CAPS"></a>G_TOKEN_RIGHT_BRACE</p></td>
+<td class="enum_member_description">
+<p>a ']' character</p>
+</td>
+<td class="enum_member_annotations"> </td>
+</tr>
+<tr>
+<td class="enum_member_name"><p><a name="G-TOKEN-EQUAL-SIGN:CAPS"></a>G_TOKEN_EQUAL_SIGN</p></td>
+<td class="enum_member_description">
+<p>a '=' character</p>
+</td>
+<td class="enum_member_annotations"> </td>
+</tr>
+<tr>
+<td class="enum_member_name"><p><a name="G-TOKEN-COMMA:CAPS"></a>G_TOKEN_COMMA</p></td>
+<td class="enum_member_description">
+<p>a ',' character</p>
+</td>
+<td class="enum_member_annotations"> </td>
+</tr>
+<tr>
+<td class="enum_member_name"><p><a name="G-TOKEN-NONE:CAPS"></a>G_TOKEN_NONE</p></td>
+<td class="enum_member_description">
+<p>not a token</p>
+</td>
+<td class="enum_member_annotations"> </td>
+</tr>
+<tr>
+<td class="enum_member_name"><p><a name="G-TOKEN-ERROR:CAPS"></a>G_TOKEN_ERROR</p></td>
+<td class="enum_member_description">
+<p>an error occurred</p>
+</td>
+<td class="enum_member_annotations"> </td>
+</tr>
+<tr>
+<td class="enum_member_name"><p><a name="G-TOKEN-CHAR:CAPS"></a>G_TOKEN_CHAR</p></td>
+<td class="enum_member_description">
+<p>a character</p>
+</td>
+<td class="enum_member_annotations"> </td>
+</tr>
+<tr>
+<td class="enum_member_name"><p><a name="G-TOKEN-BINARY:CAPS"></a>G_TOKEN_BINARY</p></td>
+<td class="enum_member_description">
+<p>a binary integer</p>
+</td>
+<td class="enum_member_annotations"> </td>
+</tr>
+<tr>
+<td class="enum_member_name"><p><a name="G-TOKEN-OCTAL:CAPS"></a>G_TOKEN_OCTAL</p></td>
+<td class="enum_member_description">
+<p>an octal integer</p>
+</td>
+<td class="enum_member_annotations"> </td>
+</tr>
+<tr>
+<td class="enum_member_name"><p><a name="G-TOKEN-INT:CAPS"></a>G_TOKEN_INT</p></td>
+<td class="enum_member_description">
+<p>an integer</p>
+</td>
+<td class="enum_member_annotations"> </td>
+</tr>
+<tr>
+<td class="enum_member_name"><p><a name="G-TOKEN-HEX:CAPS"></a>G_TOKEN_HEX</p></td>
+<td class="enum_member_description">
+<p>a hex integer</p>
+</td>
+<td class="enum_member_annotations"> </td>
+</tr>
+<tr>
+<td class="enum_member_name"><p><a name="G-TOKEN-FLOAT:CAPS"></a>G_TOKEN_FLOAT</p></td>
+<td class="enum_member_description">
+<p>a floating point number</p>
+</td>
+<td class="enum_member_annotations"> </td>
+</tr>
+<tr>
+<td class="enum_member_name"><p><a name="G-TOKEN-STRING:CAPS"></a>G_TOKEN_STRING</p></td>
+<td class="enum_member_description">
+<p>a string</p>
+</td>
+<td class="enum_member_annotations"> </td>
+</tr>
+<tr>
+<td class="enum_member_name"><p><a name="G-TOKEN-SYMBOL:CAPS"></a>G_TOKEN_SYMBOL</p></td>
+<td class="enum_member_description">
+<p>a symbol</p>
+</td>
+<td class="enum_member_annotations"> </td>
+</tr>
+<tr>
+<td class="enum_member_name"><p><a name="G-TOKEN-IDENTIFIER:CAPS"></a>G_TOKEN_IDENTIFIER</p></td>
+<td class="enum_member_description">
+<p>an identifier</p>
+</td>
+<td class="enum_member_annotations"> </td>
+</tr>
+<tr>
+<td class="enum_member_name"><p><a name="G-TOKEN-IDENTIFIER-NULL:CAPS"></a>G_TOKEN_IDENTIFIER_NULL</p></td>
+<td class="enum_member_description">
+<p>a null identifier</p>
+</td>
+<td class="enum_member_annotations"> </td>
+</tr>
+<tr>
+<td class="enum_member_name"><p><a name="G-TOKEN-COMMENT-SINGLE:CAPS"></a>G_TOKEN_COMMENT_SINGLE</p></td>
+<td class="enum_member_description">
+<p>one line comment</p>
+</td>
+<td class="enum_member_annotations"> </td>
+</tr>
+<tr>
+<td class="enum_member_name"><p><a name="G-TOKEN-COMMENT-MULTI:CAPS"></a>G_TOKEN_COMMENT_MULTI</p></td>
+<td class="enum_member_description">
+<p>multi line comment</p>
+</td>
+<td class="enum_member_annotations"> </td>
+</tr>
 </tbody>
 </table></div>
 </div>
@@ -1799,7 +1925,7 @@ in <a class="link" href="glib-Lexical-Scanner.html#GScannerConfig" title="struct
 <a name="GErrorType"></a><h3>enum GErrorType</h3>
 <p>The possible errors, used in the <em class="parameter"><code>v_error</code></em>
  field
-of <a class="link" href="glib-Lexical-Scanner.html#GTokenValue" title="union GTokenValue"><span class="type">GTokenValue</span></a>, when the token is a <code class="literal">G_TOKEN_ERROR</code>.</p>
+of <a class="link" href="glib-Lexical-Scanner.html#GTokenValue" title="union GTokenValue"><span class="type">GTokenValue</span></a>, when the token is a <a class="link" href="glib-Lexical-Scanner.html#G-TOKEN-ERROR:CAPS"><code class="literal">G_TOKEN_ERROR</code></a>.</p>
 <div class="refsect3">
 <a name="id-1.5.15.8.11.4"></a><h4>Members</h4>
 <div class="informaltable"><table width="100%" border="0">

data/vendor/local/share/gtk-doc/html/glib/glib-Memory-Allocation.html CHANGED Viewed

@@ -2,7 +2,7 @@
 <html>
 <head>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<title>GLib Reference Manual: Memory Allocation</title>
+<title>Memory Allocation: GLib Reference Manual</title>
 <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
 <link rel="home" href="index.html" title="GLib Reference Manual">
 <link rel="up" href="glib-core.html" title="GLib Core Application Support">
@@ -188,6 +188,14 @@
 </td>
 </tr>
 <tr>
+<td class="function_type">
+<a class="link" href="glib-Basic-Types.html#gpointer" title="gpointer"><span class="returnvalue">gpointer</span></a>
+</td>
+<td class="function_name">
+<a class="link" href="glib-Memory-Allocation.html#g-steal-pointer" title="g_steal_pointer ()">g_steal_pointer</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
 <td class="define_keyword">#define</td>
 <td class="function_name">
 <a class="link" href="glib-Memory-Allocation.html#g-alloca" title="g_alloca()">g_alloca</a><span class="c_punctuation">()</span>
@@ -274,7 +282,7 @@
 <p>If any call to allocate memory fails, the application is terminated.
 This also means that there is no need to check if the call succeeded.</p>
 <p>It's important to match <a class="link" href="glib-Memory-Allocation.html#g-malloc" title="g_malloc ()"><code class="function">g_malloc()</code></a> (and wrappers such as <a class="link" href="glib-Memory-Allocation.html#g-new" title="g_new()"><code class="function">g_new()</code></a>) with
-<a class="link" href="glib-Memory-Allocation.html#g-free" title="g_free ()"><code class="function">g_free()</code></a>, <a class="link" href="glib-Memory-Slices.html#g-slice-alloc" title="g_slice_alloc ()"><code class="function">g_slice_alloc()</code></a> and wrappers such as <a class="link" href="glib-Memory-Slices.html#g-slice-new" title="g_slice_new()"><code class="function">g_slice_new()</code></a>) with
+<a class="link" href="glib-Memory-Allocation.html#g-free" title="g_free ()"><code class="function">g_free()</code></a>, <a class="link" href="glib-Memory-Slices.html#g-slice-alloc" title="g_slice_alloc ()"><code class="function">g_slice_alloc()</code></a> (and wrappers such as <a class="link" href="glib-Memory-Slices.html#g-slice-new" title="g_slice_new()"><code class="function">g_slice_new()</code></a>) with
 <a class="link" href="glib-Memory-Slices.html#g-slice-free" title="g_slice_free()"><code class="function">g_slice_free()</code></a>, plain <code class="function">malloc()</code> with <code class="function">free()</code>, and (if you're using C++)
 new with delete and new[] with delete[]. Otherwise bad things can happen,
 since these allocators may use different memory pools (and new/delete call
@@ -715,10 +723,11 @@ g_try_realloc (<em class="parameter"><code><a class="link" href="glib-Basic-Type
  to a new size, <em class="parameter"><code>n_bytes</code></em>
 , and returns <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>
 on failure. Contrast with <a class="link" href="glib-Memory-Allocation.html#g-realloc" title="g_realloc ()"><code class="function">g_realloc()</code></a>, which aborts the program
-on failure. If <em class="parameter"><code>mem</code></em>
+on failure.</p>
+<p>If <em class="parameter"><code>mem</code></em>
  is <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>, behaves the same as <a class="link" href="glib-Memory-Allocation.html#g-try-malloc" title="g_try_malloc ()"><code class="function">g_try_malloc()</code></a>.</p>
 <div class="refsect3">
-<a name="id-1.4.7.7.13.5"></a><h4>Parameters</h4>
+<a name="id-1.4.7.7.13.6"></a><h4>Parameters</h4>
 <div class="informaltable"><table width="100%" border="0">
 <colgroup>
 <col width="150px" class="parameters_name">
@@ -740,7 +749,7 @@ on failure. If <em class="parameter"><code>mem</code></em>
 </table></div>
 </div>
 <div class="refsect3">
-<a name="id-1.4.7.7.13.6"></a><h4>Returns</h4>
+<a name="id-1.4.7.7.13.7"></a><h4>Returns</h4>
 <p> the allocated memory, or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>.</p>
 <p></p>
 </div>
@@ -997,11 +1006,13 @@ but care is taken to detect possible overflow during multiplication.</p>
 <pre class="programlisting"><span class="returnvalue">void</span>
 g_free (<em class="parameter"><code><a class="link" href="glib-Basic-Types.html#gpointer" title="gpointer"><span class="type">gpointer</span></a> mem</code></em>);</pre>
 <p>Frees the memory pointed to by <em class="parameter"><code>mem</code></em>
-.
-If <em class="parameter"><code>mem</code></em>
- is <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a> it simply returns.</p>
+.</p>
+<p>If <em class="parameter"><code>mem</code></em>
+ is <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a> it simply returns, so there is no need to check <em class="parameter"><code>mem</code></em>
+against <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a> before calling this function.</p>
 <div class="refsect3">
-<a name="id-1.4.7.7.20.5"></a><h4>Parameters</h4>
+<a name="id-1.4.7.7.20.6"></a><h4>Parameters</h4>
 <div class="informaltable"><table width="100%" border="0">
 <colgroup>
 <col width="150px" class="parameters_name">
@@ -1058,6 +1069,111 @@ pointer casts.</p>
 </div>
 <hr>
 <div class="refsect2">
+<a name="g-steal-pointer"></a><h3>g_steal_pointer ()</h3>
+<pre class="programlisting"><a class="link" href="glib-Basic-Types.html#gpointer" title="gpointer"><span class="returnvalue">gpointer</span></a>
+g_steal_pointer (<em class="parameter"><code><a class="link" href="glib-Basic-Types.html#gpointer" title="gpointer"><span class="type">gpointer</span></a> pp</code></em>);</pre>
+<p>Sets <em class="parameter"><code>pp</code></em>
+ to <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>, returning the value that was there before.</p>
+<p>Conceptually, this transfers the ownership of the pointer from the
+referenced variable to the "caller" of the macro (ie: "steals" the
+reference).</p>
+<p>The return value will be properly typed, according to the type of
+<em class="parameter"><code>pp</code></em>
+.</p>
+<p>This can be very useful when combined with <a class="link" href="glib-Miscellaneous-Macros.html#g-autoptr" title="g_autoptr()"><code class="function">g_autoptr()</code></a> to prevent the
+return value of a function from being automatically freed.  Consider
+the following example (which only works on GCC and clang):</p>
+<div class="informalexample">
+  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
+    <tbody>
+      <tr>
+        <td class="listing_lines" align="right"><pre>1
+2
+3
+4
+5
+6
+7
+8
+9
+10</pre></td>
+        <td class="listing_code"><pre class="programlisting"><span class="normal"><a href="https://developer.gnome.org/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a> </span><span class="symbol">*</span>
+<span class="function">create_object</span><span class="normal"> </span><span class="symbol">(</span><span class="type">void</span><span class="symbol">)</span>
+<span class="cbracket">{</span>
+<span class="normal">  </span><span class="function"><a href="glib-Miscellaneous-Macros.html#g-autoptr">g_autoptr</a></span><span class="symbol">(</span><span class="normal"><a href="https://developer.gnome.org/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a></span><span class="symbol">)</span><span class="normal"> obj </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="https://developer.gnome.org/gobject/unstable/gobject-The-Base-Object-Type.html#g-object-new">g_object_new</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal"><a href="https://developer.gnome.org/gobject/unstable/gobject-Type-Information.html#G-TYPE-OBJECT:CAPS">G_TYPE_OBJECT</a></span><span class="symbol">,</span><span class="normal"> <a href="glib-Standard-Macros.html#NULL:CAPS">NULL</a></span><span class="symbol">);</span>
+<span class="normal">  </span><span class="keyword">if</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">early_error_case</span><span class="symbol">)</span>
+<span class="normal">    </span><span class="keyword">return</span><span class="normal"> <a href="glib-Standard-Macros.html#NULL:CAPS">NULL</a></span><span class="symbol">;</span>
+<span class="normal">  </span><span class="keyword">return</span><span class="normal"> </span><span class="function"><a href="glib-Memory-Allocation.html#g-steal-pointer">g_steal_pointer</a></span><span class="normal"> </span><span class="symbol">(&amp;</span><span class="normal">obj</span><span class="symbol">);</span>
+<span class="cbracket">}</span></pre></td>
+      </tr>
+    </tbody>
+  </table>
+</div>
+<p></p>
+<p>It can also be used in similar ways for 'out' parameters and is
+particularly useful for dealing with optional out parameters:</p>
+<div class="informalexample">
+  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
+    <tbody>
+      <tr>
+        <td class="listing_lines" align="right"><pre>1
+2
+3
+4
+5
+6
+7
+8
+9
+10
+11
+12
+13</pre></td>
+        <td class="listing_code"><pre class="programlisting"><span class="normal"><a href="glib-Basic-Types.html#gboolean">gboolean</a></span>
+<span class="function">get_object</span><span class="normal"> </span><span class="symbol">(</span><span class="usertype">GObject</span><span class="normal"> </span><span class="symbol">**</span><span class="normal">obj_out</span><span class="symbol">)</span>
+<span class="cbracket">{</span>
+<span class="normal">  </span><span class="function"><a href="glib-Miscellaneous-Macros.html#g-autoptr">g_autoptr</a></span><span class="symbol">(</span><span class="normal"><a href="https://developer.gnome.org/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a></span><span class="symbol">)</span><span class="normal"> obj </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="https://developer.gnome.org/gobject/unstable/gobject-The-Base-Object-Type.html#g-object-new">g_object_new</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal"><a href="https://developer.gnome.org/gobject/unstable/gobject-Type-Information.html#G-TYPE-OBJECT:CAPS">G_TYPE_OBJECT</a></span><span class="symbol">,</span><span class="normal"> <a href="glib-Standard-Macros.html#NULL:CAPS">NULL</a></span><span class="symbol">);</span>
+<span class="normal">  </span><span class="keyword">if</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">early_error_case</span><span class="symbol">)</span>
+<span class="normal">    </span><span class="keyword">return</span><span class="normal"> <a href="glib-Standard-Macros.html#FALSE:CAPS">FALSE</a></span><span class="symbol">;</span>
+<span class="normal">  </span><span class="keyword">if</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">obj_out</span><span class="symbol">)</span>
+<span class="normal">    </span><span class="symbol">*</span><span class="normal">obj_out </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="glib-Memory-Allocation.html#g-steal-pointer">g_steal_pointer</a></span><span class="normal"> </span><span class="symbol">(&amp;</span><span class="normal">obj</span><span class="symbol">);</span>
+<span class="normal">  </span><span class="keyword">return</span><span class="normal"> <a href="glib-Standard-Macros.html#TRUE:CAPS">TRUE</a></span><span class="symbol">;</span>
+<span class="cbracket">}</span></pre></td>
+      </tr>
+    </tbody>
+  </table>
+</div>
+<p></p>
+<p>In the above example, the object will be automatically freed in the
+early error case and also in the case that <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a> was given for
+<em class="parameter"><code>obj_out</code></em>
+.</p>
+<div class="refsect3">
+<a name="id-1.4.7.7.22.14"></a><h4>Parameters</h4>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody><tr>
+<td class="parameter_name"><p>pp</p></td>
+<td class="parameter_description"><p>a pointer to a pointer</p></td>
+<td class="parameter_annotations"> </td>
+</tr></tbody>
+</table></div>
+</div>
+<p class="since">Since 2.44</p>
+</div>
+<hr>
+<div class="refsect2">
 <a name="g-alloca"></a><h3>g_alloca()</h3>
 <pre class="programlisting">#define             g_alloca(size)</pre>
 <p>Allocates <em class="parameter"><code>size</code></em>
@@ -1083,7 +1199,7 @@ will be freed together with the variable sized array upon exit of that scope, an
 not upon exit of the enclosing function scope.</p></li>
 </ul></div>
 <div class="refsect3">
-<a name="id-1.4.7.7.22.6"></a><h4>Parameters</h4>
+<a name="id-1.4.7.7.23.6"></a><h4>Parameters</h4>
 <div class="informaltable"><table width="100%" border="0">
 <colgroup>
 <col width="150px" class="parameters_name">
@@ -1098,7 +1214,7 @@ not upon exit of the enclosing function scope.</p></li>
 </table></div>
 </div>
 <div class="refsect3">
-<a name="id-1.4.7.7.22.7"></a><h4>Returns</h4>
+<a name="id-1.4.7.7.23.7"></a><h4>Returns</h4>
 <p> space for <em class="parameter"><code>size</code></em>
 bytes, allocated on the stack</p>
 <p></p>
@@ -1110,7 +1226,7 @@ bytes, allocated on the stack</p>
 <pre class="programlisting">#define             g_newa(struct_type, n_structs)</pre>
 <p>Wraps <a class="link" href="glib-Memory-Allocation.html#g-alloca" title="g_alloca()"><code class="function">g_alloca()</code></a> in a more typesafe manner.</p>
 <div class="refsect3">
-<a name="id-1.4.7.7.23.5"></a><h4>Parameters</h4>
+<a name="id-1.4.7.7.24.5"></a><h4>Parameters</h4>
 <div class="informaltable"><table width="100%" border="0">
 <colgroup>
 <col width="150px" class="parameters_name">
@@ -1132,7 +1248,7 @@ bytes, allocated on the stack</p>
 </table></div>
 </div>
 <div class="refsect3">
-<a name="id-1.4.7.7.23.6"></a><h4>Returns</h4>
+<a name="id-1.4.7.7.24.6"></a><h4>Returns</h4>
 <p> Pointer to stack space for <em class="parameter"><code>n_structs</code></em>
 chunks of type <em class="parameter"><code>struct_type</code></em>
 </p>
@@ -1153,7 +1269,7 @@ chunks of type <em class="parameter"><code>struct_type</code></em>
 .
 The source and destination areas may overlap.</p>
 <div class="refsect3">
-<a name="id-1.4.7.7.24.6"></a><h4>Parameters</h4>
+<a name="id-1.4.7.7.25.6"></a><h4>Parameters</h4>
 <div class="informaltable"><table width="100%" border="0">
 <colgroup>
 <col width="150px" class="parameters_name">
@@ -1193,7 +1309,7 @@ from <em class="parameter"><code>mem</code></em>
 . If <em class="parameter"><code>mem</code></em>
  is <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a> it returns <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>.</p>
 <div class="refsect3">
-<a name="id-1.4.7.7.25.5"></a><h4>Parameters</h4>
+<a name="id-1.4.7.7.26.5"></a><h4>Parameters</h4>
 <div class="informaltable"><table width="100%" border="0">
 <colgroup>
 <col width="150px" class="parameters_name">
@@ -1215,7 +1331,7 @@ from <em class="parameter"><code>mem</code></em>
 </table></div>
 </div>
 <div class="refsect3">
-<a name="id-1.4.7.7.25.6"></a><h4>Returns</h4>
+<a name="id-1.4.7.7.26.6"></a><h4>Returns</h4>
 <p> a pointer to the newly-allocated copy of the memory, or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a> if <em class="parameter"><code>mem</code></em>
 is <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>.</p>
 <p></p>
@@ -1238,7 +1354,7 @@ so need not persist after this function has been called.</p>
 <p>Note that this function must be called before using any other GLib
 functions.</p>
 <div class="refsect3">
-<a name="id-1.4.7.7.26.7"></a><h4>Parameters</h4>
+<a name="id-1.4.7.7.27.7"></a><h4>Parameters</h4>
 <div class="informaltable"><table width="100%" border="0">
 <colgroup>
 <col width="150px" class="parameters_name">
@@ -1265,7 +1381,7 @@ This function is useful for avoiding an extra copy of allocated memory returned
 by a non-GLib-based API.</p>
 <p>A different allocator can be set using <a class="link" href="glib-Memory-Allocation.html#g-mem-set-vtable" title="g_mem_set_vtable ()"><code class="function">g_mem_set_vtable()</code></a>.</p>
 <div class="refsect3">
-<a name="id-1.4.7.7.27.6"></a><h4>Returns</h4>
+<a name="id-1.4.7.7.28.6"></a><h4>Returns</h4>
 <p> if <a class="link" href="glib-Standard-Macros.html#TRUE:CAPS" title="TRUE"><code class="literal">TRUE</code></a>, <code class="function">malloc()</code> and <a class="link" href="glib-Memory-Allocation.html#g-malloc" title="g_malloc ()"><code class="function">g_malloc()</code></a> can be mixed.</p>
 <p></p>
 </div>