RubyGems - glib2 - Versions diffs - 3.2.1-x86-mingw32 → 3.2.2-x86-mingw32 - Mend

glib2 3.2.1-x86-mingw32 → 3.2.2-x86-mingw32

Files changed (927) hide show

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

@@ -8,7 +8,7 @@
 <link rel="up" href="glib-utilities.html" title="GLib Utilities">
 <link rel="prev" href="glib-Spawning-Processes.html" title="Spawning Processes">
 <link rel="next" href="glib-URI-Functions.html" title="URI Functions">
-<meta name="generator" content="GTK-Doc V1.25.1 (XML mode)">
+<meta name="generator" content="GTK-Doc V1.27 (XML mode)">
 <link rel="stylesheet" href="style.css" type="text/css">
 </head>
 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
@@ -400,16 +400,26 @@
 <a name="glib-File-Utilities.includes"></a><h2>Includes</h2>
 <pre class="synopsis">#include &lt;glib.h&gt;
 #include &lt;glib/gstdio.h&gt;
+#include &lt;fcntl.h&gt;
+#include &lt;sys/types.h&gt;
+#include &lt;sys/stat.h&gt;
 </pre>
 </div>
 <div class="refsect1">
 <a name="glib-File-Utilities.description"></a><h2>Description</h2>
+<p>Do not use these APIs unless you are porting a POSIX application to Windows.
+A more high-level file access API is provided as GIO — see the documentation
+for <a href="../GFile.html#GFile-struct"><span class="type">GFile</span></a>.</p>
 <p>There is a group of functions which wrap the common POSIX functions
 dealing with filenames (<a class="link" href="glib-File-Utilities.html#g-open" title="g_open ()"><code class="function">g_open()</code></a>, <a class="link" href="glib-File-Utilities.html#g-rename" title="g_rename ()"><code class="function">g_rename()</code></a>, <a class="link" href="glib-File-Utilities.html#g-mkdir" title="g_mkdir ()"><code class="function">g_mkdir()</code></a>, <a class="link" href="glib-File-Utilities.html#g-stat" title="g_stat ()"><code class="function">g_stat()</code></a>,
 <a class="link" href="glib-File-Utilities.html#g-unlink" title="g_unlink ()"><code class="function">g_unlink()</code></a>, <a class="link" href="glib-File-Utilities.html#g-remove" title="g_remove ()"><code class="function">g_remove()</code></a>, <a class="link" href="glib-File-Utilities.html#g-fopen" title="g_fopen ()"><code class="function">g_fopen()</code></a>, <a class="link" href="glib-File-Utilities.html#g-freopen" title="g_freopen ()"><code class="function">g_freopen()</code></a>). The point of these
 wrappers is to make it possible to handle file names with any Unicode
 characters in them on Windows without having to use ifdefs and the
 wide character API in the application code.</p>
+<p>On some Unix systems, these APIs may be defined as identical to their POSIX
+counterparts. For this reason, you must check for and include the necessary
+header files (such as <code class="literal">fcntl.h</code>) before using functions like <a class="link" href="glib-File-Utilities.html#g-creat" title="g_creat ()"><code class="function">g_creat()</code></a>. You
+must also define the relevant feature test macros.</p>
 <p>The pathname argument should be in the GLib file name encoding.
 On POSIX this is the actual on-disk encoding which might correspond
 to the locale settings of the process (or the <code class="literal">G_FILENAME_ENCODING</code>
@@ -493,18 +503,18 @@ codes are those in the <a class="link" href="glib-File-Utilities.html#GFileError
 <tbody>
 <tr>
 <td class="parameter_name"><p>filename</p></td>
-<td class="parameter_description"><p> name of a file to read contents from, in the GLib file name encoding. </p></td>
+<td class="parameter_description"><p>name of a file to read contents from, in the GLib file name encoding. </p></td>
 <td class="parameter_annotations"><span class="annotation">[<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> filename]</span></td>
 </tr>
 <tr>
 <td class="parameter_name"><p>contents</p></td>
-<td class="parameter_description"><p> location to store an allocated string, use <a class="link" href="glib-Memory-Allocation.html#g-free" title="g_free ()"><code class="function">g_free()</code></a> to free
+<td class="parameter_description"><p>location to store an allocated string, use <a class="link" href="glib-Memory-Allocation.html#g-free" title="g_free ()"><code class="function">g_free()</code></a> to free
 the returned string. </p></td>
 <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=length][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> guint8]</span></td>
 </tr>
 <tr>
 <td class="parameter_name"><p>length</p></td>
-<td class="parameter_description"><p> location to store length in bytes of the contents, or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>. </p></td>
+<td class="parameter_description"><p>location to store length in bytes of the contents, or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>. </p></td>
 <td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td>
 </tr>
 <tr>
@@ -569,14 +579,14 @@ to 7 characters to <em class="parameter"><code>filename</code></em>
 <tbody>
 <tr>
 <td class="parameter_name"><p>filename</p></td>
-<td class="parameter_description"><p> name of a file to write <em class="parameter"><code>contents</code></em>
+<td class="parameter_description"><p>name of a file to write <em class="parameter"><code>contents</code></em>
 to, in the GLib file name
 encoding. </p></td>
 <td class="parameter_annotations"><span class="annotation">[<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> filename]</span></td>
 </tr>
 <tr>
 <td class="parameter_name"><p>contents</p></td>
-<td class="parameter_description"><p> string to write to the file. </p></td>
+<td class="parameter_description"><p>string to write to the file. </p></td>
 <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=length][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> guint8]</span></td>
 </tr>
 <tr>
@@ -634,12 +644,12 @@ tricked into writing into a different location. It doesn't work!</p>
 4
 5
 6</pre></td>
-        <td class="listing_code"><pre class="programlisting"><span class="gtkdoc slc">// DON&apos;T DO THIS</span>
-<span class="keyword">if</span> <span class="gtkdoc opt">(!</span><span class="function"><a href="glib-File-Utilities.html#g-file-test">g_file_test</a></span> <span class="gtkdoc opt">(</span>filename<span class="gtkdoc opt">,</span> G_FILE_TEST_IS_SYMLINK<span class="gtkdoc opt">))</span>
-  <span class="gtkdoc opt">{</span>
-    fd <span class="gtkdoc opt">=</span> <span class="function"><a href="glib-File-Utilities.html#g-open">g_open</a></span> <span class="gtkdoc opt">(</span>filename<span class="gtkdoc opt">,</span> O_WRONLY<span class="gtkdoc opt">);</span>
-    <span class="gtkdoc slc">// write to fd</span>
-  <span class="gtkdoc opt">}</span></pre></td>
+        <td class="listing_code"><pre class="programlisting"><span class="comment">// DON'T DO THIS</span>
+<span class="keyword">if</span><span class="normal"> </span><span class="symbol">(!</span><span class="function"><a href="glib-File-Utilities.html#g-file-test">g_file_test</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">filename</span><span class="symbol">,</span><span class="normal"> <a href="glib-File-Utilities.html#G-FILE-TEST-IS-SYMLINK:CAPS">G_FILE_TEST_IS_SYMLINK</a></span><span class="symbol">))</span><span class="normal"> </span>
+<span class="normal">  </span><span class="cbracket">{</span>
+<span class="normal">    fd </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="glib-File-Utilities.html#g-open">g_open</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">filename</span><span class="symbol">,</span><span class="normal"> O_WRONLY</span><span class="symbol">);</span>
+<span class="normal">    </span><span class="comment">// write to fd</span>
+<span class="normal">  </span><span class="cbracket">}</span></pre></td>
       </tr>
     </tbody>
   </table>
@@ -668,7 +678,7 @@ extensions and those listed in the <code class="literal">PATHEXT</code> environm
 <tbody>
 <tr>
 <td class="parameter_name"><p>filename</p></td>
-<td class="parameter_description"><p> a filename to test in the
+<td class="parameter_description"><p>a filename to test in the
 GLib file name encoding. </p></td>
 <td class="parameter_annotations"><span class="annotation">[<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> filename]</span></td>
 </tr>
@@ -710,7 +720,7 @@ Most importantly, on Windows it should be in UTF-8.</p>
 </colgroup>
 <tbody><tr>
 <td class="parameter_name"><p>tmpl</p></td>
-<td class="parameter_description"><p> template filename. </p></td>
+<td class="parameter_description"><p>template filename. </p></td>
 <td class="parameter_annotations"><span class="annotation">[<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> filename]</span></td>
 </tr></tbody>
 </table></div>
@@ -755,7 +765,7 @@ on Windows it should be in UTF-8.</p>
 <tbody>
 <tr>
 <td class="parameter_name"><p>tmpl</p></td>
-<td class="parameter_description"><p> template filename. </p></td>
+<td class="parameter_description"><p>template filename. </p></td>
 <td class="parameter_annotations"><span class="annotation">[<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> filename]</span></td>
 </tr>
 <tr>
@@ -816,13 +826,13 @@ name encoding.</p>
 <tbody>
 <tr>
 <td class="parameter_name"><p>tmpl</p></td>
-<td class="parameter_description"><p> Template for file name, as in
+<td class="parameter_description"><p>Template for file name, as in
 <a class="link" href="glib-File-Utilities.html#g-mkstemp" title="g_mkstemp ()"><code class="function">g_mkstemp()</code></a>, basename only, or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a> for a default template. </p></td>
 <td class="parameter_annotations"><span class="annotation">[<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> filename][<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td>
 </tr>
 <tr>
 <td class="parameter_name"><p>name_used</p></td>
-<td class="parameter_description"><p> location to store actual name used,
+<td class="parameter_description"><p>location to store actual name used,
 or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>. </p></td>
 <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> filename]</span></td>
 </tr>
@@ -864,7 +874,7 @@ for filenames. Use <a class="link" href="glib-Character-Set-Conversion.html#g-fi
 <tbody>
 <tr>
 <td class="parameter_name"><p>filename</p></td>
-<td class="parameter_description"><p> the symbolic link. </p></td>
+<td class="parameter_description"><p>the symbolic link. </p></td>
 <td class="parameter_annotations"><span class="annotation">[<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> filename]</span></td>
 </tr>
 <tr>
@@ -877,7 +887,7 @@ for filenames. Use <a class="link" href="glib-Character-Set-Conversion.html#g-fi
 </div>
 <div class="refsect3">
 <a name="g-file-read-link.returns"></a><h4>Returns</h4>
-<p> A newly-allocated string with the contents of
+<p>A newly-allocated string with the contents of
 the symbolic link, or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a> if an error occurred. </p>
 <p><span class="annotation">[<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> filename]</span></p>
 </div>
@@ -902,7 +912,7 @@ parent directories as needed, too.</p>
 <tbody>
 <tr>
 <td class="parameter_name"><p>pathname</p></td>
-<td class="parameter_description"><p> a pathname in the GLib file name encoding. </p></td>
+<td class="parameter_description"><p>a pathname in the GLib file name encoding. </p></td>
 <td class="parameter_annotations"><span class="annotation">[<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> filename]</span></td>
 </tr>
 <tr>
@@ -949,14 +959,14 @@ directory returned by <a class="link" href="glib-Miscellaneous-Utility-Functions
 </colgroup>
 <tbody><tr>
 <td class="parameter_name"><p>tmpl</p></td>
-<td class="parameter_description"><p> template directory name. </p></td>
+<td class="parameter_description"><p>template directory name. </p></td>
 <td class="parameter_annotations"><span class="annotation">[<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> filename]</span></td>
 </tr></tbody>
 </table></div>
 </div>
 <div class="refsect3">
 <a name="g-mkdtemp.returns"></a><h4>Returns</h4>
-<p> A pointer to <em class="parameter"><code>tmpl</code></em>
+<p>A pointer to <em class="parameter"><code>tmpl</code></em>
 , which has been
 modified to hold the directory name.  In case of errors, <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a> is
 returned and <code class="literal">errno</code> will be set. </p>
@@ -996,7 +1006,7 @@ directory returned by <a class="link" href="glib-Miscellaneous-Utility-Functions
 <tbody>
 <tr>
 <td class="parameter_name"><p>tmpl</p></td>
-<td class="parameter_description"><p> template directory name. </p></td>
+<td class="parameter_description"><p>template directory name. </p></td>
 <td class="parameter_annotations"><span class="annotation">[<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> filename]</span></td>
 </tr>
 <tr>
@@ -1009,7 +1019,7 @@ directory returned by <a class="link" href="glib-Miscellaneous-Utility-Functions
 </div>
 <div class="refsect3">
 <a name="g-mkdtemp-full.returns"></a><h4>Returns</h4>
-<p> A pointer to <em class="parameter"><code>tmpl</code></em>
+<p>A pointer to <em class="parameter"><code>tmpl</code></em>
 , which has been
 modified to hold the directory name. In case of errors, <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a> is
 returned, and <code class="literal">errno</code> will be set. </p>
@@ -1045,7 +1055,7 @@ modified, and might thus be a read-only literal string.</p>
 <tbody>
 <tr>
 <td class="parameter_name"><p>tmpl</p></td>
-<td class="parameter_description"><p> Template for directory name,
+<td class="parameter_description"><p>Template for directory name,
 as in <a class="link" href="glib-File-Utilities.html#g-mkdtemp" title="g_mkdtemp ()"><code class="function">g_mkdtemp()</code></a>, basename only, or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a> for a default template. </p></td>
 <td class="parameter_annotations"><span class="annotation">[<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> filename][<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td>
 </tr>
@@ -1059,7 +1069,7 @@ as in <a class="link" href="glib-File-Utilities.html#g-mkdtemp" title="g_mkdtemp
 </div>
 <div class="refsect3">
 <a name="g-dir-make-tmp.returns"></a><h4>Returns</h4>
-<p> The actual name used. This string
+<p>The actual name used. This string
 should be freed with <a class="link" href="glib-Memory-Allocation.html#g-free" title="g_free ()"><code class="function">g_free()</code></a> when not needed any longer and is
 is in the GLib file name encoding. In case of errors, <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a> is
 returned and <em class="parameter"><code>error</code></em>
@@ -1147,7 +1157,7 @@ filenames, the returned name is in UTF-8.</p>
 </div>
 <div class="refsect3">
 <a name="g-dir-read-name.returns"></a><h4>Returns</h4>
-<p> The entry's name or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a> if there are no
+<p>The entry's name or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a> if there are no
 more entries. The return value is owned by GLib and
 must not be modified or freed. </p>
 <p><span class="annotation">[<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> filename]</span></p>
@@ -1232,7 +1242,7 @@ to the <a class="link" href="glib-File-Utilities.html#GFileError" title="enum GF
 <tbody>
 <tr>
 <td class="parameter_name"><p>filename</p></td>
-<td class="parameter_description"><p> The path of the file to load, in the GLib
+<td class="parameter_description"><p>The path of the file to load, in the GLib
 filename encoding. </p></td>
 <td class="parameter_annotations"><span class="annotation">[<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> filename]</span></td>
 </tr>
@@ -1476,7 +1486,7 @@ bytes object, because a <a class="link" href="glib-Byte-Arrays.html#GBytes" titl
 </div>
 <div class="refsect3">
 <a name="g-mapped-file-get-bytes.returns"></a><h4>Returns</h4>
-<p> A newly allocated <a class="link" href="glib-Byte-Arrays.html#GBytes" title="GBytes"><span class="type">GBytes</span></a> referencing data
+<p>A newly allocated <a class="link" href="glib-Byte-Arrays.html#GBytes" title="GBytes"><span class="type">GBytes</span></a> referencing data
 from <em class="parameter"><code>file</code></em>
 . </p>
 <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
@@ -1516,7 +1526,7 @@ or <code class="function">read()</code>.</p>
 <tbody>
 <tr>
 <td class="parameter_name"><p>filename</p></td>
-<td class="parameter_description"><p> a pathname in the GLib file name encoding
+<td class="parameter_description"><p>a pathname in the GLib file name encoding
 (UTF-8 on Windows). </p></td>
 <td class="parameter_annotations"><span class="annotation">[<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> filename]</span></td>
 </tr>
@@ -1563,13 +1573,13 @@ a file that is open to some process.</p>
 <tbody>
 <tr>
 <td class="parameter_name"><p>oldfilename</p></td>
-<td class="parameter_description"><p> a pathname in the GLib file name encoding
+<td class="parameter_description"><p>a pathname in the GLib file name encoding
 (UTF-8 on Windows). </p></td>
 <td class="parameter_annotations"><span class="annotation">[<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> filename]</span></td>
 </tr>
 <tr>
 <td class="parameter_name"><p>newfilename</p></td>
-<td class="parameter_description"><p> a pathname in the GLib file name encoding. </p></td>
+<td class="parameter_description"><p>a pathname in the GLib file name encoding. </p></td>
 <td class="parameter_annotations"><span class="annotation">[<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> filename]</span></td>
 </tr>
 </tbody>
@@ -1602,7 +1612,7 @@ The mode argument is ignored on Windows.</p>
 <tbody>
 <tr>
 <td class="parameter_name"><p>filename</p></td>
-<td class="parameter_description"><p> a pathname in the GLib file name encoding
+<td class="parameter_description"><p>a pathname in the GLib file name encoding
 (UTF-8 on Windows). </p></td>
 <td class="parameter_annotations"><span class="annotation">[<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> filename]</span></td>
 </tr>
@@ -1656,7 +1666,7 @@ might be a macro.</p>
 <tbody>
 <tr>
 <td class="parameter_name"><p>filename</p></td>
-<td class="parameter_description"><p> a pathname in the GLib file name encoding
+<td class="parameter_description"><p>a pathname in the GLib file name encoding
 (UTF-8 on Windows). </p></td>
 <td class="parameter_annotations"><span class="annotation">[<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> filename]</span></td>
 </tr>
@@ -1699,7 +1709,7 @@ is identical to <a class="link" href="glib-File-Utilities.html#g-stat" title="g_
 <tbody>
 <tr>
 <td class="parameter_name"><p>filename</p></td>
-<td class="parameter_description"><p> a pathname in the GLib file name encoding
+<td class="parameter_description"><p>a pathname in the GLib file name encoding
 (UTF-8 on Windows). </p></td>
 <td class="parameter_annotations"><span class="annotation">[<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> filename]</span></td>
 </tr>
@@ -1741,7 +1751,7 @@ are open to some process, or mapped into memory.</p>
 </colgroup>
 <tbody><tr>
 <td class="parameter_name"><p>filename</p></td>
-<td class="parameter_description"><p> a pathname in the GLib file name encoding
+<td class="parameter_description"><p>a pathname in the GLib file name encoding
 (UTF-8 on Windows). </p></td>
 <td class="parameter_annotations"><span class="annotation">[<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> filename]</span></td>
 </tr></tbody>
@@ -1783,7 +1793,7 @@ set by <code class="function">rmdir()</code>.</p>
 </colgroup>
 <tbody><tr>
 <td class="parameter_name"><p>filename</p></td>
-<td class="parameter_description"><p> a pathname in the GLib file name encoding
+<td class="parameter_description"><p>a pathname in the GLib file name encoding
 (UTF-8 on Windows). </p></td>
 <td class="parameter_annotations"><span class="annotation">[<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> filename]</span></td>
 </tr></tbody>
@@ -1815,7 +1825,7 @@ on your system.</p>
 </colgroup>
 <tbody><tr>
 <td class="parameter_name"><p>filename</p></td>
-<td class="parameter_description"><p> a pathname in the GLib file name encoding
+<td class="parameter_description"><p>a pathname in the GLib file name encoding
 (UTF-8 on Windows). </p></td>
 <td class="parameter_annotations"><span class="annotation">[<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> filename]</span></td>
 </tr></tbody>
@@ -1854,7 +1864,7 @@ functions like <code class="function">fprintf()</code> or <code class="function"
 <tbody>
 <tr>
 <td class="parameter_name"><p>filename</p></td>
-<td class="parameter_description"><p> a pathname in the GLib file name encoding
+<td class="parameter_description"><p>a pathname in the GLib file name encoding
 (UTF-8 on Windows). </p></td>
 <td class="parameter_annotations"><span class="annotation">[<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> filename]</span></td>
 </tr>
@@ -1894,7 +1904,7 @@ opens a file and associates it with an existing stream.</p>
 <tbody>
 <tr>
 <td class="parameter_name"><p>filename</p></td>
-<td class="parameter_description"><p> a pathname in the GLib file name encoding
+<td class="parameter_description"><p>a pathname in the GLib file name encoding
 (UTF-8 on Windows). </p></td>
 <td class="parameter_annotations"><span class="annotation">[<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> filename]</span></td>
 </tr>
@@ -1905,7 +1915,7 @@ opens a file and associates it with an existing stream.</p>
 </tr>
 <tr>
 <td class="parameter_name"><p>stream</p></td>
-<td class="parameter_description"><p> an existing stream which will be reused, or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>. </p></td>
+<td class="parameter_description"><p>an existing stream which will be reused, or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>. </p></td>
 <td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td>
 </tr>
 </tbody>
@@ -1943,7 +1953,7 @@ exactly should use the Win32 API.</p>
 <tbody>
 <tr>
 <td class="parameter_name"><p>filename</p></td>
-<td class="parameter_description"><p> a pathname in the GLib file name encoding
+<td class="parameter_description"><p>a pathname in the GLib file name encoding
 (UTF-8 on Windows). </p></td>
 <td class="parameter_annotations"><span class="annotation">[<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> filename]</span></td>
 </tr>
@@ -1988,7 +1998,7 @@ more exactly should use the Win32 API.</p>
 <tbody>
 <tr>
 <td class="parameter_name"><p>filename</p></td>
-<td class="parameter_description"><p> a pathname in the GLib file name encoding
+<td class="parameter_description"><p>a pathname in the GLib file name encoding
 (UTF-8 on Windows). </p></td>
 <td class="parameter_annotations"><span class="annotation">[<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> filename]</span></td>
 </tr>
@@ -2041,7 +2051,7 @@ or <code class="function">read()</code>.</p>
 <tbody>
 <tr>
 <td class="parameter_name"><p>filename</p></td>
-<td class="parameter_description"><p> a pathname in the GLib file name encoding
+<td class="parameter_description"><p>a pathname in the GLib file name encoding
 (UTF-8 on Windows). </p></td>
 <td class="parameter_annotations"><span class="annotation">[<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> filename]</span></td>
 </tr>
@@ -2080,7 +2090,7 @@ current directory of the process to <em class="parameter"><code>path</code></em>
 </colgroup>
 <tbody><tr>
 <td class="parameter_name"><p>path</p></td>
-<td class="parameter_description"><p> a pathname in the GLib file name encoding
+<td class="parameter_description"><p>a pathname in the GLib file name encoding
 (UTF-8 on Windows). </p></td>
 <td class="parameter_annotations"><span class="annotation">[<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> filename]</span></td>
 </tr></tbody>
@@ -2113,7 +2123,7 @@ on your system.</p>
 <tbody>
 <tr>
 <td class="parameter_name"><p>filename</p></td>
-<td class="parameter_description"><p> a pathname in the GLib file name encoding
+<td class="parameter_description"><p>a pathname in the GLib file name encoding
 (UTF-8 on Windows). </p></td>
 <td class="parameter_annotations"><span class="annotation">[<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> filename]</span></td>
 </tr>
@@ -2510,6 +2520,6 @@ system call, depending on the platform and/or compiler being used.</p>
 </div>
 </div>
 <div class="footer">
-<hr>Generated by GTK-Doc V1.25.1</div>
+<hr>Generated by GTK-Doc V1.27</div>
 </body>
 </html>

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

@@ -8,7 +8,7 @@
 <link rel="up" href="glib-utilities.html" title="GLib Utilities">
 <link rel="prev" href="glib-GTimeZone.html" title="GTimeZone">
 <link rel="next" href="glib-Random-Numbers.html" title="Random Numbers">
-<meta name="generator" content="GTK-Doc V1.25.1 (XML mode)">
+<meta name="generator" content="GTK-Doc V1.27 (XML mode)">
 <link rel="stylesheet" href="style.css" type="text/css">
 </head>
 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
@@ -116,6 +116,14 @@
 <a class="link" href="glib-GDateTime.html#GDateTime" title="GDateTime"><span class="returnvalue">GDateTime</span></a> *
 </td>
 <td class="function_name">
+<a class="link" href="glib-GDateTime.html#g-date-time-new-from-iso8601" title="g_date_time_new_from_iso8601 ()">g_date_time_new_from_iso8601</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<a class="link" href="glib-GDateTime.html#GDateTime" title="GDateTime"><span class="returnvalue">GDateTime</span></a> *
+</td>
+<td class="function_name">
 <a class="link" href="glib-GDateTime.html#g-date-time-new" title="g_date_time_new ()">g_date_time_new</a> <span class="c_punctuation">()</span>
 </td>
 </tr>
@@ -459,6 +467,7 @@
 <div class="refsect1">
 <a name="glib-GDateTime.includes"></a><h2>Includes</h2>
 <pre class="synopsis">#include &lt;glib.h&gt;
+#include &lt;glib/gprintf.h&gt;
 </pre>
 </div>
 <div class="refsect1">
@@ -750,6 +759,77 @@ when you are done with it.</p>
 </div>
 <hr>
 <div class="refsect2">
+<a name="g-date-time-new-from-iso8601"></a><h3>g_date_time_new_from_iso8601 ()</h3>
+<pre class="programlisting"><a class="link" href="glib-GDateTime.html#GDateTime" title="GDateTime"><span class="returnvalue">GDateTime</span></a> *
+g_date_time_new_from_iso8601 (<em class="parameter"><code>const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="type">gchar</span></a> *text</code></em>,
+                              <em class="parameter"><code><a class="link" href="glib-GTimeZone.html#GTimeZone" title="GTimeZone"><span class="type">GTimeZone</span></a> *default_tz</code></em>);</pre>
+<p>Creates a <a class="link" href="glib-GDateTime.html#GDateTime" title="GDateTime"><span class="type">GDateTime</span></a> corresponding to the given
+<a class="ulink" href="https://en.wikipedia.org/wiki/ISO_8601" target="_top">ISO 8601 formatted string</a>
+<em class="parameter"><code>text</code></em>
+. ISO 8601 strings of the form &lt;date&gt;&lt;sep&gt;&lt;time&gt;&lt;tz&gt; are supported.</p>
+<p>&lt;sep&gt; is the separator and can be either 'T', 't' or ' '.</p>
+<p>&lt;date&gt; is in the form:</p>
+<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
+<li class="listitem"><p><code class="literal">YYYY-MM-DD</code> - Year/month/day, e.g. 2016-08-24.</p></li>
+<li class="listitem"><p><code class="literal">YYYYMMDD</code> - Same as above without dividers.</p></li>
+<li class="listitem"><p><code class="literal">YYYY-DDD</code> - Ordinal day where DDD is from 001 to 366, e.g. 2016-237.</p></li>
+<li class="listitem"><p><code class="literal">YYYYDDD</code> - Same as above without dividers.</p></li>
+<li class="listitem"><p><code class="literal">YYYY-Www-D</code> - Week day where ww is from 01 to 52 and D from 1-7,
+e.g. 2016-W34-3.</p></li>
+<li class="listitem"><p><code class="literal">YYYYWwwD</code> - Same as above without dividers.</p></li>
+</ul></div>
+<p>&lt;time&gt; is in the form:</p>
+<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
+<li class="listitem"><p><code class="literal">hh:mm:ss(.sss)</code> - Hours, minutes, seconds (subseconds), e.g. 22:10:42.123.</p></li>
+<li class="listitem"><p><code class="literal">hhmmss(.sss)</code> - Same as above without dividers.</p></li>
+</ul></div>
+<p>&lt;tz&gt; is an optional timezone suffix of the form:</p>
+<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
+<li class="listitem"><p><code class="literal">Z</code> - UTC.</p></li>
+<li class="listitem"><p><code class="literal">+hh:mm</code> or <code class="literal">-hh:mm</code> - Offset from UTC in hours and minutes, e.g. +12:00.</p></li>
+<li class="listitem"><p><code class="literal">+hh</code> or <code class="literal">-hh</code> - Offset from UTC in hours, e.g. +12.</p></li>
+</ul></div>
+<p>If the timezone is not provided in <em class="parameter"><code>text</code></em>
+ it must be provided in <em class="parameter"><code>default_tz</code></em>
+(this field is otherwise ignored).</p>
+<p>This call can fail (returning <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>) if <em class="parameter"><code>text</code></em>
+ is not a valid ISO 8601
+formatted string.</p>
+<p>You should release the return value by calling <a class="link" href="glib-GDateTime.html#g-date-time-unref" title="g_date_time_unref ()"><code class="function">g_date_time_unref()</code></a>
+when you are done with it.</p>
+<div class="refsect3">
+<a name="g-date-time-new-from-iso8601.parameters"></a><h4>Parameters</h4>
+<div class="informaltable"><table class="informaltable" 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>text</p></td>
+<td class="parameter_description"><p>an ISO 8601 formatted time string.</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>default_tz</p></td>
+<td class="parameter_description"><p>a <a class="link" href="glib-GTimeZone.html#GTimeZone" title="GTimeZone"><span class="type">GTimeZone</span></a> to use if the text doesn't contain a
+timezone, or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>. </p></td>
+<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="g-date-time-new-from-iso8601.returns"></a><h4>Returns</h4>
+<p>a new <a class="link" href="glib-GDateTime.html#GDateTime" title="GDateTime"><span class="type">GDateTime</span></a>, or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>. </p>
+<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>][<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></p>
+</div>
+<p class="since">Since: <a class="link" href="api-index-2-56.html#api-index-2.56">2.56</a></p>
+</div>
+<hr>
+<div class="refsect2">
 <a name="g-date-time-new"></a><h3>g_date_time_new ()</h3>
 <pre class="programlisting"><a class="link" href="glib-GDateTime.html#GDateTime" title="GDateTime"><span class="returnvalue">GDateTime</span></a> *
 g_date_time_new (<em class="parameter"><code><a class="link" href="glib-GTimeZone.html#GTimeZone" title="GTimeZone"><span class="type">GTimeZone</span></a> *tz</code></em>,
@@ -1010,6 +1090,8 @@ g_date_time_add_years (<em class="parameter"><code><a class="link" href="glib-GD
 <p>Creates a copy of <em class="parameter"><code>datetime</code></em>
  and adds the specified number of years to the
 copy. Add negative values to subtract years.</p>
+<p>As with <a class="link" href="glib-GDateTime.html#g-date-time-add-months" title="g_date_time_add_months ()"><code class="function">g_date_time_add_months()</code></a>, if the resulting date would be 29th
+February on a non-leap year, the day will be clamped to 28th February.</p>
 <div class="refsect3">
 <a name="g-date-time-add-years.parameters"></a><h4>Parameters</h4>
 <div class="informaltable"><table class="informaltable" width="100%" border="0">
@@ -1048,6 +1130,10 @@ g_date_time_add_months (<em class="parameter"><code><a class="link" href="glib-G
 <p>Creates a copy of <em class="parameter"><code>datetime</code></em>
  and adds the specified number of months to the
 copy. Add negative values to subtract months.</p>
+<p>The day of the month of the resulting <a class="link" href="glib-GDateTime.html#GDateTime" title="GDateTime"><span class="type">GDateTime</span></a> is clamped to the number
+of days in the updated calendar month. For example, if adding 1 month to
+31st January 2018, the result would be 28th February 2018. In 2020 (a leap
+year), the result would be 29th February.</p>
 <div class="refsect3">
 <a name="g-date-time-add-months.parameters"></a><h4>Parameters</h4>
 <div class="informaltable"><table class="informaltable" width="100%" border="0">
@@ -1354,12 +1440,12 @@ as a <a class="link" href="glib-Doubly-Linked-Lists.html#GCompareFunc" title="GC
 <tbody>
 <tr>
 <td class="parameter_name"><p>dt1</p></td>
-<td class="parameter_description"><p> first <a class="link" href="glib-GDateTime.html#GDateTime" title="GDateTime"><span class="type">GDateTime</span></a> to compare. </p></td>
+<td class="parameter_description"><p>first <a class="link" href="glib-GDateTime.html#GDateTime" title="GDateTime"><span class="type">GDateTime</span></a> to compare. </p></td>
 <td class="parameter_annotations"><span class="annotation">[<acronym title="NULL must not be passed as the value in, out, in-out; or as a return value."><span class="acronym">not nullable</span></acronym>]</span></td>
 </tr>
 <tr>
 <td class="parameter_name"><p>dt2</p></td>
-<td class="parameter_description"><p> second <a class="link" href="glib-GDateTime.html#GDateTime" title="GDateTime"><span class="type">GDateTime</span></a> to compare. </p></td>
+<td class="parameter_description"><p>second <a class="link" href="glib-GDateTime.html#GDateTime" title="GDateTime"><span class="type">GDateTime</span></a> to compare. </p></td>
 <td class="parameter_annotations"><span class="annotation">[<acronym title="NULL must not be passed as the value in, out, in-out; or as a return value."><span class="acronym">not nullable</span></acronym>]</span></td>
 </tr>
 </tbody>
@@ -1433,7 +1519,7 @@ g_date_time_hash (<em class="parameter"><code><a class="link" href="glib-Basic-T
 </colgroup>
 <tbody><tr>
 <td class="parameter_name"><p>datetime</p></td>
-<td class="parameter_description"><p> a <a class="link" href="glib-GDateTime.html#GDateTime" title="GDateTime"><span class="type">GDateTime</span></a>. </p></td>
+<td class="parameter_description"><p>a <a class="link" href="glib-GDateTime.html#GDateTime" title="GDateTime"><span class="type">GDateTime</span></a>. </p></td>
 <td class="parameter_annotations"><span class="annotation">[<acronym title="NULL must not be passed as the value in, out, in-out; or as a return value."><span class="acronym">not nullable</span></acronym>]</span></td>
 </tr></tbody>
 </table></div>
@@ -1466,12 +1552,12 @@ them to the same time zone.</p>
 <tbody>
 <tr>
 <td class="parameter_name"><p>dt1</p></td>
-<td class="parameter_description"><p> a <a class="link" href="glib-GDateTime.html#GDateTime" title="GDateTime"><span class="type">GDateTime</span></a>. </p></td>
+<td class="parameter_description"><p>a <a class="link" href="glib-GDateTime.html#GDateTime" title="GDateTime"><span class="type">GDateTime</span></a>. </p></td>
 <td class="parameter_annotations"><span class="annotation">[<acronym title="NULL must not be passed as the value in, out, in-out; or as a return value."><span class="acronym">not nullable</span></acronym>]</span></td>
 </tr>
 <tr>
 <td class="parameter_name"><p>dt2</p></td>
-<td class="parameter_description"><p> a <a class="link" href="glib-GDateTime.html#GDateTime" title="GDateTime"><span class="type">GDateTime</span></a>. </p></td>
+<td class="parameter_description"><p>a <a class="link" href="glib-GDateTime.html#GDateTime" title="GDateTime"><span class="type">GDateTime</span></a>. </p></td>
 <td class="parameter_annotations"><span class="annotation">[<acronym title="NULL must not be passed as the value in, out, in-out; or as a return value."><span class="acronym">not nullable</span></acronym>]</span></td>
 </tr>
 </tbody>
@@ -1510,17 +1596,17 @@ g_date_time_get_ymd (<em class="parameter"><code><a class="link" href="glib-GDat
 </tr>
 <tr>
 <td class="parameter_name"><p>year</p></td>
-<td class="parameter_description"><p> the return location for the gregorian year, or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>. </p></td>
+<td class="parameter_description"><p>the return location for the gregorian year, or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>. </p></td>
 <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL may be passed instead of a pointer to a location."><span class="acronym">optional</span></acronym>]</span></td>
 </tr>
 <tr>
 <td class="parameter_name"><p>month</p></td>
-<td class="parameter_description"><p> the return location for the month of the year, or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>. </p></td>
+<td class="parameter_description"><p>the return location for the month of the year, or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>. </p></td>
 <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL may be passed instead of a pointer to a location."><span class="acronym">optional</span></acronym>]</span></td>
 </tr>
 <tr>
 <td class="parameter_name"><p>day</p></td>
-<td class="parameter_description"><p> the return location for the day of the month, or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>. </p></td>
+<td class="parameter_description"><p>the return location for the day of the month, or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>. </p></td>
 <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL may be passed instead of a pointer to a location."><span class="acronym">optional</span></acronym>]</span></td>
 </tr>
 </tbody>
@@ -2052,7 +2138,7 @@ time is in effect.</p>
 </div>
 <div class="refsect3">
 <a name="g-date-time-get-timezone-abbreviation.returns"></a><h4>Returns</h4>
-<p> the time zone abbreviation. The returned
+<p>the time zone abbreviation. The returned
 string is owned by the <a class="link" href="glib-GDateTime.html#GDateTime" title="GDateTime"><span class="type">GDateTime</span></a> and it should not be
 modified or freed. </p>
 <p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
@@ -2284,6 +2370,13 @@ for the specifier.</p></li>
 <li class="listitem"><p>0: Pad a numeric result with zeros. This overrides the default padding
 for the specifier.</p></li>
 </ul></div>
+<p>Additionally, when O is used with B, b, or h, it produces the alternative
+form of a month name. The alternative form should be used when the month
+name is used without a day number (e.g., standalone). It is required in
+some languages (Baltic, Slavic, Greek, and more) due to their grammatical
+rules. For other languages there is no difference. %OB is a GNU and BSD
+<code class="function">strftime()</code> extension expected to be added to the future POSIX specification,
+%Ob and %Oh are GNU <code class="function">strftime()</code> extensions. Since: 2.56</p>
 <div class="refsect3">
 <a name="g-date-time-format.parameters"></a><h4>Parameters</h4>
 <div class="informaltable"><table class="informaltable" width="100%" border="0">
@@ -2310,7 +2403,8 @@ for the specifier.</p></li>
 <div class="refsect3">
 <a name="g-date-time-format.returns"></a><h4>Returns</h4>
 <p> a newly allocated string formatted to the requested format
-or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a> in the case that there was an error. The string
+or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a> in the case that there was an error (such as a format specifier
+not being supported in the current locale). The string
 should be freed with <a class="link" href="glib-Memory-Allocation.html#g-free" title="g_free ()"><code class="function">g_free()</code></a>.</p>
 </div>
 <p class="since">Since: <a class="link" href="api-index-2-26.html#api-index-2.26">2.26</a></p>
@@ -2380,6 +2474,6 @@ cannot be accessed directly.</p>
 </div>
 </div>
 <div class="footer">
-<hr>Generated by GTK-Doc V1.25.1</div>
+<hr>Generated by GTK-Doc V1.27</div>
 </body>
 </html>