~ubuntu-branches/ubuntu/trusty/glib2.0/trusty-proposed

<th width="100%" align="center">GLib Reference Manual</th>

<td><a accesskey="n" href="glib-Atomic-Operations.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>

</tr>

                  &#160;|&#160;

</table>

<div class="refentry" lang="en">

<a name="glib-Miscellaneous-Macros"></a><div class="titlepage"></div>

<div class="refnamediv"><table width="100%"><tr>

<td valign="top">

<h2>

</h2>

<p>Miscellaneous Macros &#8212; specialized macros which are not used often</p>

</td>

</pre>

</div>

<div class="refsect1" lang="en">

<p>

These macros provide more specialized features which are not needed so often

by application programmers.

</p>

</div>

<div class="refsect1" lang="en">

<div class="refsect2" lang="en">

<a name="G-INLINE-FUNC:CAPS"></a>G_INLINE_FUNC</h3>

<p>

This macro is used to export function prototypes so they can be linked

with an external version when no inlining is performed. The file which

</div>

<hr>

<div class="refsect2" lang="en">

<a name="G-STMT-START:CAPS"></a>G_STMT_START</h3>

<p>

Used within multi-statement macros so that they can be used in places where

only one statement is expected by the compiler.

</div>

<hr>

<div class="refsect2" lang="en">

<a name="G-STMT-END:CAPS"></a>G_STMT_END</h3>

<p>

Used within multi-statement macros so that they can be used in places where

only one statement is expected by the compiler.

</div>

<hr>

<div class="refsect2" lang="en">

<a name="G-BEGIN-DECLS:CAPS"></a>G_BEGIN_DECLS</h3>

<p>

Used (along with <a class="link" href="glib-Miscellaneous-Macros.html#G-END-DECLS:CAPS"><span class="type">G_END_DECLS</span></a>) to bracket header files. If the

compiler in use is a C++ compiler, adds <code class="literal">extern "C"</code> 

</div>

<hr>

<div class="refsect2" lang="en">

<a name="G-END-DECLS:CAPS"></a>G_END_DECLS</h3>

<p>

Used (along with <a class="link" href="glib-Miscellaneous-Macros.html#G-BEGIN-DECLS:CAPS"><span class="type">G_BEGIN_DECLS</span></a>) to bracket header files. If the

compiler in use is a C++ compiler, adds <code class="literal">extern "C"</code> 

</div>

<hr>

<div class="refsect2" lang="en">

<a name="G-N-ELEMENTS:CAPS"></a>G_N_ELEMENTS()</h3>

</pre>

<p>

Determines the number of elements in an array. The array must be

</div>

<hr>

<div class="refsect2" lang="en">

<a name="G-VA-COPY:CAPS"></a>G_VA_COPY()</h3>

<p>

Portable way to copy <span class="type">va_list</span> variables.

</p>

</div>

<hr>

<div class="refsect2" lang="en">

<a name="G-STRINGIFY:CAPS"></a>G_STRINGIFY()</h3>

</pre>

<p>

Accepts a macro or a string and converts it into a string.

</div>

<hr>

<div class="refsect2" lang="en">

<a name="G-GNUC-EXTENSION:CAPS"></a>G_GNUC_EXTENSION</h3>

<p>

Expands to <code class="literal">__extension__</code> when <span class="command"><strong>gcc</strong></span> is 

used as the compiler.

</div>

<hr>

<div class="refsect2" lang="en">

<a name="G-GNUC-CONST:CAPS"></a>G_GNUC_CONST</h3>

<p>

Expands to the GNU C <code class="literal">const</code> function attribute if the compiler is 

<span class="command"><strong>gcc</strong></span>. Declaring a function as const enables better optimization of calls 

</div>

<hr>

<div class="refsect2" lang="en">

<a name="G-GNUC-PURE:CAPS"></a>G_GNUC_PURE</h3>

<p>

Expands to the GNU C <code class="literal">pure</code> function attribute if the compiler is 

<span class="command"><strong>gcc</strong></span>. Declaring a function as pure enables better optimization of 

</div>

<hr>

<div class="refsect2" lang="en">

<a name="G-GNUC-MALLOC:CAPS"></a>G_GNUC_MALLOC</h3>

<p>

Expands to the GNU C <code class="literal">malloc</code> function attribute if the compiler is 

<span class="command"><strong>gcc</strong></span>. Declaring a function as malloc enables better optimization of the 

</div>

<hr>

<div class="refsect2" lang="en">

<a name="G-GNUC-DEPRECATED:CAPS"></a>G_GNUC_DEPRECATED</h3>

<p>

Expands to the GNU C <code class="literal">deprecated</code> attribute if the compiler 

is <span class="command"><strong>gcc</strong></span>.

</div>

<hr>

<div class="refsect2" lang="en">

<a name="G-GNUC-NORETURN:CAPS"></a>G_GNUC_NORETURN</h3>

<p>

Expands to the GNU C <code class="literal">noreturn</code> function attribute if the 

compiler is <span class="command"><strong>gcc</strong></span>. It is used for declaring functions which never return.

</div>

<hr>

<div class="refsect2" lang="en">

<a name="G-GNUC-UNUSED:CAPS"></a>G_GNUC_UNUSED</h3>

<p>

Expands to the GNU C <code class="literal">unused</code> function attribute if the compiler is 

<span class="command"><strong>gcc</strong></span>. It is used for declaring functions which may never be used.

</div>

<hr>

<div class="refsect2" lang="en">

<a name="G-GNUC-PRINTF:CAPS"></a>G_GNUC_PRINTF()</h3>

<p>

Expands to the GNU C <code class="literal">format</code> function attribute if the compiler is 

<span class="command"><strong>gcc</strong></span>. This is used for declaring functions which take a variable number of

</div>

<hr>

<div class="refsect2" lang="en">

<a name="G-GNUC-SCANF:CAPS"></a>G_GNUC_SCANF()</h3>

<p>

Expands to the GNU C <code class="literal">format</code> function attribute if the compiler is <span class="command"><strong>gcc</strong></span>.

This is used for declaring functions which take a variable number of

</div>

<hr>

<div class="refsect2" lang="en">

<a name="G-GNUC-FORMAT:CAPS"></a>G_GNUC_FORMAT()</h3>

<p>

Expands to the GNU C <code class="literal">format_arg</code> function attribute if the compiler is <span class="command"><strong>gcc</strong></span>.

This function attribute specifies that a function takes a format

</div>

<hr>

<div class="refsect2" lang="en">

<a name="G-GNUC-NULL-TERMINATED:CAPS"></a>G_GNUC_NULL_TERMINATED</h3>

<p>

Expands to the GNU C <code class="literal">sentinel</code> function attribute if the 

compiler is <span class="command"><strong>gcc</strong></span>, or "" if it isn't. This function attribute

Since: 2.8</div>

<hr>

<div class="refsect2" lang="en">

<a name="G-GNUC-WARN-UNUSED-RESULT:CAPS"></a>G_GNUC_WARN_UNUSED_RESULT</h3>

<p>

Expands to the GNU C <code class="literal">warn_unused_result</code> function attribute 

if the compiler is <span class="command"><strong>gcc</strong></span>, or "" if it isn't. This function 

</div>

<hr>

<div class="refsect2" lang="en">

<a name="G-GNUC-FUNCTION:CAPS"></a>G_GNUC_FUNCTION</h3>

<p>

Expands to the GNU C <code class="literal">__FUNCTION__</code> variable if the 

compiler is <span class="command"><strong>gcc</strong></span>, or "" if it isn't. The GNU C 

</div>

<hr>

<div class="refsect2" lang="en">

<a name="G-GNUC-PRETTY-FUNCTION:CAPS"></a>G_GNUC_PRETTY_FUNCTION</h3>

<p>

Expands to the GNU C <code class="literal">__PRETTY_FUNCTION__</code> variable 

if the compiler is <span class="command"><strong>gcc</strong></span>, or "" if it isn't.

</div>

<hr>

<div class="refsect2" lang="en">

<a name="G-GNUC-NO-INSTRUMENT:CAPS"></a>G_GNUC_NO_INSTRUMENT</h3>

<p>

Expands to the GNU C <code class="literal">no_instrument_function</code> function 

attribute if the compiler is <span class="command"><strong>gcc</strong></span>. Functions with this 

</div>

<hr>

<div class="refsect2" lang="en">

<a name="G-HAVE-GNUC-VISIBILITY:CAPS"></a>G_HAVE_GNUC_VISIBILITY</h3>

</pre>

<p>

This macro is defined as 1 if the the compiler supports ELF visibility 

Since: 2.6</div>

<hr>

<div class="refsect2" lang="en">

<a name="G-GNUC-INTERNAL:CAPS"></a>G_GNUC_INTERNAL</h3>

<p>

This attribute can be used for marking library functions as being used 

internally to the library only, which may allow the compiler to handle

Since: 2.6</div>

<hr>

<div class="refsect2" lang="en">

<a name="G-GNUC-MAY-ALIAS:CAPS"></a>G_GNUC_MAY_ALIAS</h3>

<p>

 

</p>

</div>

<hr>

<div class="refsect2" lang="en">

<a name="G-LIKELY:CAPS"></a>G_LIKELY ()</h3>

<p>

Hints the compiler that the expression is likely to evaluate to a true

value. The compiler may use this information for optimizations.

</div>

<hr>

<div class="refsect2" lang="en">

<a name="G-UNLIKELY:CAPS"></a>G_UNLIKELY()</h3>

<p>

Hints the compiler that the expression is unlikely to evaluate to a true

value. The compiler may use this information for optimizations.

</div>

<hr>

<div class="refsect2" lang="en">

<a name="G-STRLOC:CAPS"></a>G_STRLOC</h3>

<p>

Expands to a string identifying the current code position. 

</p>

</div>

<hr>

<div class="refsect2" lang="en">

<a name="G-STRFUNC:CAPS"></a>G_STRFUNC</h3>

<p>

Expands to a string identifying the current function. 

</p>

</div>

<hr>

<div class="refsect2" lang="en">

<a name="G-GINT16-MODIFIER:CAPS"></a>G_GINT16_MODIFIER</h3>

</pre>

<p>

The platform dependent length modifier for constructing <code class="function">printf()</code> conversion

</div>

<hr>

<div class="refsect2" lang="en">

<a name="G-GINT16-FORMAT:CAPS"></a>G_GINT16_FORMAT</h3>

</pre>

<p>

This is the platform dependent conversion specifier for scanning and

</div>

<hr>

<div class="refsect2" lang="en">

<a name="G-GUINT16-FORMAT:CAPS"></a>G_GUINT16_FORMAT</h3>

</pre>

<p>

This is the platform dependent conversion specifier for scanning and

</div>

<hr>

<div class="refsect2" lang="en">

<a name="G-GINT32-MODIFIER:CAPS"></a>G_GINT32_MODIFIER</h3>

</pre>

<p>

The platform dependent length modifier for constructing <code class="function">printf()</code> conversion

</div>

<hr>

<div class="refsect2" lang="en">

<a name="G-GINT32-FORMAT:CAPS"></a>G_GINT32_FORMAT</h3>

</pre>

<p>

This is the platform dependent conversion specifier for scanning and

</div>

<hr>

<div class="refsect2" lang="en">

<a name="G-GUINT32-FORMAT:CAPS"></a>G_GUINT32_FORMAT</h3>

</pre>

<p>

This is the platform dependent conversion specifier for scanning and

</div>

<hr>

<div class="refsect2" lang="en">

<a name="G-GINT64-MODIFIER:CAPS"></a>G_GINT64_MODIFIER</h3>

</pre>

<p>

The platform dependent length modifier for constructing <code class="function">printf()</code> conversion

</div>

<hr>

<div class="refsect2" lang="en">

<a name="G-GINT64-FORMAT:CAPS"></a>G_GINT64_FORMAT</h3>

</pre>

<p>

This is the platform dependent conversion specifier for scanning and

</div>

<hr>

<div class="refsect2" lang="en">

<a name="G-GUINT64-FORMAT:CAPS"></a>G_GUINT64_FORMAT</h3>

</pre>

<p>

This is the platform dependent conversion specifier for scanning and

</div>

<hr>

<div class="refsect2" lang="en">

<a name="G-GSIZE-MODIFIER:CAPS"></a>G_GSIZE_MODIFIER</h3>

</pre>

<p>

The platform dependent length modifier for constructing <code class="function">printf()</code> conversion

</div>

<hr>

<div class="refsect2" lang="en">

<a name="G-GSIZE-FORMAT:CAPS"></a>G_GSIZE_FORMAT</h3>

</pre>

<p>

This is the platform dependent conversion specifier for scanning and

</div>

<hr>

<div class="refsect2" lang="en">

<a name="G-GSSIZE-FORMAT:CAPS"></a>G_GSSIZE_FORMAT</h3>

</pre>

<p>

This is the platform dependent conversion specifier for scanning and

</div>

</div>

<div class="refsect1" lang="en">

<hr>

</div>

</div>

</body>