<?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>

<refsynopsisdiv id="cutter-Types.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>

<synopsis><link linkend="void"><returnvalue>void</returnvalue></link>                (<link linkend="CutDestroyFunction">*CutDestroyFunction</link>)               (<parameter><link linkend="void"><type>void</type></link> *data</parameter>);
<link linkend="void"><returnvalue>void</returnvalue></link>                (<link linkend="CutCallbackFunction">*CutCallbackFunction</link>)              (<parameter><type>void</type></parameter>);
typedef             <link linkend="cut-boolean">cut_boolean</link>;
#define             <link linkend="CUT-TRUE:CAPS">CUT_TRUE</link>
#define             <link linkend="CUT-FALSE:CAPS">CUT_FALSE</link>
</synopsis>
</refsynopsisdiv>

<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.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="CutDestroyFunction" role="function">
<title>CutDestroyFunction ()</title>
<indexterm zone="CutDestroyFunction"><primary>CutDestroyFunction</primary></indexterm>
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                (*CutDestroyFunction)               (<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><variablelist role="params">
<varlistentry><term><parameter>data</parameter>&#160;:</term>
<listitem><simpara>the data element to be destroyed.</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="CutCallbackFunction" role="function">
<title>CutCallbackFunction ()</title>
<indexterm zone="CutCallbackFunction"><primary>CutCallbackFunction</primary></indexterm>
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                (*CutCallbackFunction)              (<parameter><type>void</type></parameter>);</programlisting>
<para>
</para></refsect2>
<refsect2 id="cut-boolean" role="typedef">
<title>cut_boolean</title>
<indexterm zone="cut-boolean"><primary>cut_boolean</primary></indexterm>
<programlisting>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>#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>#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>
