blob: 987f069312cdb95bff088462d707e1988a928191 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>FunctionSignature class: Gandiva GLib Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="Gandiva GLib Reference Manual">
<link rel="up" href="function-signature.html" title="Signature">
<link rel="prev" href="function-signature.html" title="Signature">
<link rel="next" href="native-function.html" title="Native function">
<meta name="generator" content="GTK-Doc V1.32 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
<a href="#GGandivaFunctionSignature.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
<a href="#GGandivaFunctionSignature.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties">  <span class="dim">|</span> 
<a href="#GGandivaFunctionSignature.properties" class="shortcut">Properties</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="function-signature.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="function-signature.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="native-function.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GGandivaFunctionSignature"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GGandivaFunctionSignature.top_of_page"></a>FunctionSignature class</span></h2>
<p>FunctionSignature class — FunctionSignature class</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="GGandivaFunctionSignature.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_proto_type">
<col class="functions_proto_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="GGandivaFunctionSignature.html" title="FunctionSignature class"><span class="returnvalue">GGandivaFunctionSignature</span></a> *
</td>
<td class="function_name">
<a class="link" href="GGandivaFunctionSignature.html#ggandiva-function-signature-new" title="ggandiva_function_signature_new ()">ggandiva_function_signature_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="GGandivaFunctionSignature.html#ggandiva-function-signature-equal" title="ggandiva_function_signature_equal ()">ggandiva_function_signature_equal</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="GGandivaFunctionSignature.html#ggandiva-function-signature-to-string" title="ggandiva_function_signature_to_string ()">ggandiva_function_signature_to_string</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../arrow-glib/basic-data-type-classes.html#GArrowDataType-struct"><span class="returnvalue">GArrowDataType</span></a> *
</td>
<td class="function_name">
<a class="link" href="GGandivaFunctionSignature.html#ggandiva-function-signature-get-return-type" title="ggandiva_function_signature_get_return_type ()">ggandiva_function_signature_get_return_type</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="GGandivaFunctionSignature.html#ggandiva-function-signature-get-base-name" title="ggandiva_function_signature_get_base_name ()">ggandiva_function_signature_get_base_name</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
</td>
<td class="function_name">
<a class="link" href="GGandivaFunctionSignature.html#ggandiva-function-signature-get-param-types" title="ggandiva_function_signature_get_param_types ()">ggandiva_function_signature_get_param_types</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GGandivaFunctionSignature.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody><tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a></td>
<td class="property_name"><a class="link" href="GGandivaFunctionSignature.html#GGandivaFunctionSignature--function-signature" title="The “function-signature” property">function-signature</a></td>
<td class="property_flags">Write / Construct Only</td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GGandivaFunctionSignature.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="other_proto_type">
<col class="other_proto_name">
</colgroup>
<tbody>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="GGandivaFunctionSignature.html#GGANDIVA-TYPE-FUNCTION-SIGNATURE:CAPS" title="GGANDIVA_TYPE_FUNCTION_SIGNATURE">GGANDIVA_TYPE_FUNCTION_SIGNATURE</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="GGandivaFunctionSignature.html#GGandivaFunctionSignatureClass" title="struct GGandivaFunctionSignatureClass">GGandivaFunctionSignatureClass</a></td>
</tr>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="GGandivaFunctionSignature.html#GGandivaFunctionSignature-struct" title="GGandivaFunctionSignature">GGandivaFunctionSignature</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GGandivaFunctionSignature.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
<span class="lineart">╰──</span> GGandivaFunctionSignature
</pre>
</div>
<div class="refsect1">
<a name="GGandivaFunctionSignature.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;gandiva-glib/gandiva-glib.h&gt;
</pre>
</div>
<div class="refsect1">
<a name="GGandivaFunctionSignature.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="GGandivaFunctionSignature.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="ggandiva-function-signature-new"></a><h3>ggandiva_function_signature_new ()</h3>
<pre class="programlisting"><a class="link" href="GGandivaFunctionSignature.html" title="FunctionSignature class"><span class="returnvalue">GGandivaFunctionSignature</span></a> *
ggandiva_function_signature_new (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *base_name</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> *parameter_types</code></em>,
<em class="parameter"><code><a href="../arrow-glib/basic-data-type-classes.html#GArrowDataType-struct"><span class="type">GArrowDataType</span></a> *return_type</code></em>);</pre>
<div class="refsect3">
<a name="ggandiva-function-signature-new.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>base_name</p></td>
<td class="parameter_description"><p>A base name of a function.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>parameter_types</p></td>
<td class="parameter_description"><p>(element-type GArrowDataType)
A list of parameter data types.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>return_type</p></td>
<td class="parameter_description"><p>A return data type.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="ggandiva-function-signature-new.returns"></a><h4>Returns</h4>
<p> A <a class="link" href="GGandivaFunctionSignature.html" title="FunctionSignature class"><span class="type">GGandivaFunctionSignature</span></a>.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-0-14-0.html#api-index-0.14.0">0.14.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ggandiva-function-signature-equal"></a><h3>ggandiva_function_signature_equal ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
ggandiva_function_signature_equal (<em class="parameter"><code><a class="link" href="GGandivaFunctionSignature.html" title="FunctionSignature class"><span class="type">GGandivaFunctionSignature</span></a> *function_signature</code></em>,
<em class="parameter"><code><a class="link" href="GGandivaFunctionSignature.html" title="FunctionSignature class"><span class="type">GGandivaFunctionSignature</span></a> *other_function_signature</code></em>);</pre>
<div class="refsect3">
<a name="ggandiva-function-signature-equal.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>function_signature</p></td>
<td class="parameter_description"><p>A <a class="link" href="GGandivaFunctionSignature.html" title="FunctionSignature class"><span class="type">GGandivaFunctionSignature</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>other_function_signature</p></td>
<td class="parameter_description"><p>A <a class="link" href="GGandivaFunctionSignature.html" title="FunctionSignature class"><span class="type">GGandivaFunctionSignature</span></a> to be compared.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="ggandiva-function-signature-equal.returns"></a><h4>Returns</h4>
<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if both of them have the same data, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-0-14-0.html#api-index-0.14.0">0.14.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ggandiva-function-signature-to-string"></a><h3>ggandiva_function_signature_to_string ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
ggandiva_function_signature_to_string (<em class="parameter"><code><a class="link" href="GGandivaFunctionSignature.html" title="FunctionSignature class"><span class="type">GGandivaFunctionSignature</span></a> *function_signature</code></em>);</pre>
<div class="refsect3">
<a name="ggandiva-function-signature-to-string.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>function_signature</p></td>
<td class="parameter_description"><p>A <a class="link" href="GGandivaFunctionSignature.html" title="FunctionSignature class"><span class="type">GGandivaFunctionSignature</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="ggandiva-function-signature-to-string.returns"></a><h4>Returns</h4>
<p>The string representation of the function signature.</p>
<p> It should be freed with <a href="/usr/share/gtk-doc/html/glib/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a> when no longer needed. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
<p class="since">Since: <a class="link" href="api-index-0-14-0.html#api-index-0.14.0">0.14.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ggandiva-function-signature-get-return-type"></a><h3>ggandiva_function_signature_get_return_type ()</h3>
<pre class="programlisting"><a href="../arrow-glib/basic-data-type-classes.html#GArrowDataType-struct"><span class="returnvalue">GArrowDataType</span></a> *
ggandiva_function_signature_get_return_type
(<em class="parameter"><code><a class="link" href="GGandivaFunctionSignature.html" title="FunctionSignature class"><span class="type">GGandivaFunctionSignature</span></a> *function_signature</code></em>);</pre>
<div class="refsect3">
<a name="ggandiva-function-signature-get-return-type.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>function_signature</p></td>
<td class="parameter_description"><p>A <a class="link" href="GGandivaFunctionSignature.html" title="FunctionSignature class"><span class="type">GGandivaFunctionSignature</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="ggandiva-function-signature-get-return-type.returns"></a><h4>Returns</h4>
<p>A <a href="../arrow-glib/basic-data-type-classes.html#GArrowDataType-struct"><span class="type">GArrowDataType</span></a> of the return value of the function signature. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
<p class="since">Since: <a class="link" href="api-index-0-14-0.html#api-index-0.14.0">0.14.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ggandiva-function-signature-get-base-name"></a><h3>ggandiva_function_signature_get_base_name ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
ggandiva_function_signature_get_base_name
(<em class="parameter"><code><a class="link" href="GGandivaFunctionSignature.html" title="FunctionSignature class"><span class="type">GGandivaFunctionSignature</span></a> *function_signature</code></em>);</pre>
<div class="refsect3">
<a name="ggandiva-function-signature-get-base-name.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>function_signature</p></td>
<td class="parameter_description"><p>A <a class="link" href="GGandivaFunctionSignature.html" title="FunctionSignature class"><span class="type">GGandivaFunctionSignature</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="ggandiva-function-signature-get-base-name.returns"></a><h4>Returns</h4>
<p>A base name of the function signature.</p>
<p> It should be freed with <a href="/usr/share/gtk-doc/html/glib/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a> when no longer needed. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
<p class="since">Since: <a class="link" href="api-index-0-14-0.html#api-index-0.14.0">0.14.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ggandiva-function-signature-get-param-types"></a><h3>ggandiva_function_signature_get_param_types ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
ggandiva_function_signature_get_param_types
(<em class="parameter"><code><a class="link" href="GGandivaFunctionSignature.html" title="FunctionSignature class"><span class="type">GGandivaFunctionSignature</span></a> *function_signature</code></em>);</pre>
<div class="refsect3">
<a name="ggandiva-function-signature-get-param-types.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>function_signature</p></td>
<td class="parameter_description"><p>A <a class="link" href="GGandivaFunctionSignature.html" title="FunctionSignature class"><span class="type">GGandivaFunctionSignature</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="ggandiva-function-signature-get-param-types.returns"></a><h4>Returns</h4>
<p>A list of parameter data types of the function signature. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> GArrowDataType]</span></p>
</div>
<p class="since">Since: <a class="link" href="api-index-0-14-0.html#api-index-0.14.0">0.14.0</a></p>
</div>
</div>
<div class="refsect1">
<a name="GGandivaFunctionSignature.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GGANDIVA-TYPE-FUNCTION-SIGNATURE:CAPS"></a><h3>GGANDIVA_TYPE_FUNCTION_SIGNATURE</h3>
<pre class="programlisting">#define GGANDIVA_TYPE_FUNCTION_SIGNATURE (ggandiva_function_signature_get_type())
</pre>
</div>
<hr>
<div class="refsect2">
<a name="GGandivaFunctionSignatureClass"></a><h3>struct GGandivaFunctionSignatureClass</h3>
<pre class="programlisting">struct GGandivaFunctionSignatureClass {
GObjectClass parent_class;
};
</pre>
</div>
<hr>
<div class="refsect2">
<a name="GGandivaFunctionSignature-struct"></a><h3>GGandivaFunctionSignature</h3>
<pre class="programlisting">typedef struct _GGandivaFunctionSignature GGandivaFunctionSignature;</pre>
</div>
</div>
<div class="refsect1">
<a name="GGandivaFunctionSignature.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GGandivaFunctionSignature--function-signature"></a><h3>The <code class="literal">“function-signature”</code> property</h3>
<pre class="programlisting"> “function-signature” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a></pre>
<p>The raw gandiva::FunctionSignature *.</p>
<p>Owner: GGandivaFunctionSignature</p>
<p>Flags: Write / Construct Only</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.32</div>
</body>
</html>