<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
<!ENTITY version SYSTEM "version.xml">
]>
<refentry id="cutter-Assertion-Utilities-for-GValue">
<refmeta>
<refentrytitle role="top_of_page" id="cutter-Assertion-Utilities-for-GValue.top_of_page">Assertion Utilities for GValue</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>CUTTER Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>Assertion Utilities for GValue</refname>
<refpurpose>Utilities to write assertions related
to <link linkend="GValue"><type>GValue</type></link> more easily.</refpurpose>
</refnamediv>

<refsect1 id="cutter-Assertion-Utilities-for-GValue.functions" role="functions_proto">
<title role="functions_proto.title">Functions</title>
<informaltable pgwide="1" frame="none">
<tgroup cols="2">
<colspec colname="functions_return" colwidth="150px"/>
<colspec colname="functions_name"/>
<tbody>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="gcut-value-equal">gcut_value_equal</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="gcut-value-register-equal-func">gcut_value_register_equal_func</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>

</tbody>
</tgroup>
</informaltable>
</refsect1>


<refsect1 id="cutter-Assertion-Utilities-for-GValue.description" role="desc">
<title role="desc.title">Description</title>
<para>To write assertions, you need to check equality and show
expected and actual values.</para>
<para>The utilities help you to write assertions that are
related to <link linkend="GValue"><type>GValue</type></link>.</para>

</refsect1>
<refsect1 id="cutter-Assertion-Utilities-for-GValue.functions_details" role="details">
<title role="details.title">Functions</title>
<refsect2 id="gcut-value-equal" role="function" condition="since:1.0.5">
<title>gcut_value_equal&#160;()</title>
<indexterm zone="gcut-value-equal" role="1.0.5"><primary>gcut_value_equal</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
gcut_value_equal (<parameter>const <link linkend="GValue"><type>GValue</type></link> *value1</parameter>,
                  <parameter>const <link linkend="GValue"><type>GValue</type></link> *value2</parameter>);</programlisting>
<para>Compares two <link linkend="GValue"><type>GValue</type></link>, <parameter>value1</parameter>
 and <parameter>value2</parameter>
 by registered
equal function. (See <link linkend="gcut-value-register-equal-func"><function>gcut_value_register_equal_func()</function></link> for
detail of how to register equal function of <link linkend="GValue"><type>GValue</type></link>)</para>
<refsect3 id="gcut-value-equal.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>value1</para></entry>
<entry role="parameter_description"><para>a <link linkend="GValue"><type>GValue</type></link> to be compared.</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>value2</para></entry>
<entry role="parameter_description"><para>a <link linkend="GValue"><type>GValue</type></link> to be compared.</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gcut-value-equal.returns" role="returns">
<title>Returns</title>
<para> TRUE if <parameter>value1</parameter>
equals to <parameter>value2</parameter>
, FALSE
otherwise.</para>
</refsect3><para role="since">Since: <link linkend="api-index-1.0.5">1.0.5</link></para></refsect2>
<refsect2 id="gcut-value-register-equal-func" role="function" condition="since:1.0.5">
<title>gcut_value_register_equal_func&#160;()</title>
<indexterm zone="gcut-value-register-equal-func" role="1.0.5"><primary>gcut_value_register_equal_func</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
gcut_value_register_equal_func (<parameter><link linkend="GType"><type>GType</type></link> type1</parameter>,
                                <parameter><link linkend="GType"><type>GType</type></link> type2</parameter>,
                                <parameter><link linkend="GEqualFunc"><type>GEqualFunc</type></link> equal_func</parameter>);</programlisting>
<para>e.g.:</para>
<informalexample><programlisting><![CDATA[
TODO
]]></programlisting></informalexample>
<para></para>
<para>Registers equality check function between <link linkend="GValue"><type>GValue</type></link> of
<parameter>type1</parameter>
 and <link linkend="GValue"><type>GValue</type></link> of <parameter>type2</parameter>
.</para>
<refsect3 id="gcut-value-register-equal-func.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>type1</para></entry>
<entry role="parameter_description"><para>a <link linkend="GType"><type>GType</type></link> of compared <link linkend="GValue"><type>GValue</type></link>.</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>type2</para></entry>
<entry role="parameter_description"><para>a <link linkend="GType"><type>GType</type></link> of compared <link linkend="GValue"><type>GValue</type></link>.</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>equal_func</para></entry>
<entry role="parameter_description"><para>a function that compares <parameter>type1</parameter>
's <link linkend="GValue"><type>GValue</type></link>
with <parameter>type2</parameter>
's <link linkend="GValue"><type>GValue</type></link>.</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><para role="since">Since: <link linkend="api-index-1.0.5">1.0.5</link></para></refsect2>

</refsect1>
<refsect1 id="cutter-Assertion-Utilities-for-GValue.other_details" role="details">
<title role="details.title">Types and Values</title>

</refsect1>

</refentry>
