<?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-Types">
<refmeta>
<refentrytitle role="top_of_page" id="cutter-Types.top_of_page">Types</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>CUTTER Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>Types</refname>
<refpurpose>Types that is used in test.</refpurpose>
</refnamediv>

<refsect1 id="cutter-Types.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="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><phrase role="c_punctuation">(</phrase><link linkend="CutDestroyFunction">*CutDestroyFunction</link><phrase role="c_punctuation">)</phrase>&#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"><phrase role="c_punctuation">(</phrase><link linkend="CutCallbackFunction">*CutCallbackFunction</link><phrase role="c_punctuation">)</phrase>&#160;<phrase role="c_punctuation">()</phrase></entry></row>

</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="cutter-Types.other" role="other_proto">
<title role="other_proto.title">Types and Values</title>
<informaltable role="enum_members_table" pgwide="1" frame="none">
<tgroup cols="2">
<colspec colname="name" colwidth="150px"/>
<colspec colname="description"/>
<tbody>
<row><entry role="typedef_keyword">typedef</entry><entry role="function_name"><link linkend="cut-boolean">cut_boolean</link></entry></row>
<row><entry role="define_keyword">#define</entry><entry role="function_name"><link linkend="CUT-TRUE:CAPS">CUT_TRUE</link></entry></row>
<row><entry role="define_keyword">#define</entry><entry role="function_name"><link linkend="CUT-FALSE:CAPS">CUT_FALSE</link></entry></row>

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


<refsect1 id="cutter-Types.description" role="desc">
<title role="desc.title">Description</title>
<para>There are some types to be used in test.</para>

</refsect1>
<refsect1 id="cutter-Types.functions_details" role="details">
<title role="details.title">Functions</title>
<refsect2 id="CutDestroyFunction" role="function">
<title>CutDestroyFunction&#160;()</title>
<indexterm zone="CutDestroyFunction"><primary>CutDestroyFunction</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
<phrase role="c_punctuation">(</phrase>*CutDestroyFunction<phrase role="c_punctuation">)</phrase> (<parameter><link linkend="void"><type>void</type></link> *data</parameter>);</programlisting>
<para>Specifies the type of function which is called when a
data element is destroyed. It is passed the pointer to
the data element and should free any memory and resources
allocated for it.</para>
<refsect3 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>data</para></entry>
<entry role="parameter_description"><para>the data element to be destroyed.</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="CutCallbackFunction" role="function">
<title>CutCallbackFunction&#160;()</title>
<indexterm zone="CutCallbackFunction"><primary>CutCallbackFunction</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
<phrase role="c_punctuation">(</phrase>*CutCallbackFunction<phrase role="c_punctuation">)</phrase> (<parameter><type>void</type></parameter>);</programlisting>
<para>
</para>
</refsect2>

</refsect1>
<refsect1 id="cutter-Types.other_details" role="details">
<title role="details.title">Types and Values</title>
<refsect2 id="cut-boolean" role="typedef">
<title>cut_boolean</title>
<indexterm zone="cut-boolean"><primary>cut_boolean</primary></indexterm>
<programlisting language="C">typedef int cut_boolean;
</programlisting>
<para>A standard boolean type. Variables of this type should
only contain the value <link linkend="CUT-TRUE:CAPS"><literal>CUT_TRUE</literal></link> or <link linkend="CUT-FALSE:CAPS"><literal>CUT_FALSE</literal></link>.</para>
</refsect2>
<refsect2 id="CUT-TRUE:CAPS" role="macro">
<title>CUT_TRUE</title>
<indexterm zone="CUT-TRUE:CAPS"><primary>CUT_TRUE</primary></indexterm>
<programlisting language="C">#define CUT_TRUE
</programlisting>
<para>Defines the <link linkend="CUT-TRUE:CAPS"><literal>CUT_TRUE</literal></link> value for the <link linkend="cut-boolean"><type>cut_boolean</type></link> type.</para>
</refsect2>
<refsect2 id="CUT-FALSE:CAPS" role="macro">
<title>CUT_FALSE</title>
<indexterm zone="CUT-FALSE:CAPS"><primary>CUT_FALSE</primary></indexterm>
<programlisting language="C">#define CUT_FALSE
</programlisting>
<para>Defines the <link linkend="CUT-FALSE:CAPS"><literal>CUT_FALSE</literal></link> value for the <link linkend="cut-boolean"><type>cut_boolean</type></link> type.</para>
</refsect2>

</refsect1>

</refentry>
