<?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-Version-Information">
<refmeta>
<refentrytitle role="top_of_page" id="cutter-Version-Information.top_of_page">Version Information</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>CUTTER Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>Version Information</refname>
<refpurpose>Variables and macros to check the Cutter version</refpurpose>
</refnamediv>

<refsect1 id="cutter-Version-Information.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="define_keyword">#define</entry><entry role="function_name"><link linkend="CUTTER-CHECK-VERSION:CAPS">CUTTER_CHECK_VERSION</link><phrase role="c_punctuation">()</phrase></entry></row>

</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="cutter-Version-Information.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="define_keyword">#define</entry><entry role="function_name"><link linkend="CUTTER-VERSION-MAJOR:CAPS">CUTTER_VERSION_MAJOR</link></entry></row>
<row><entry role="define_keyword">#define</entry><entry role="function_name"><link linkend="CUTTER-VERSION-MINOR:CAPS">CUTTER_VERSION_MINOR</link></entry></row>
<row><entry role="define_keyword">#define</entry><entry role="function_name"><link linkend="CUTTER-VERSION-MICRO:CAPS">CUTTER_VERSION_MICRO</link></entry></row>
<row><entry role="define_keyword">#define</entry><entry role="function_name"><link linkend="CUTTER-VERSION-STRING:CAPS">CUTTER_VERSION_STRING</link></entry></row>

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


<refsect1 id="cutter-Version-Information.description" role="desc">
<title role="desc.title">Description</title>
<para>Cutter provides version information, primarily useful in
configure checks for builds that have a configure
script. Tests will not typically use the features
described here.</para>

</refsect1>
<refsect1 id="cutter-Version-Information.functions_details" role="details">
<title role="details.title">Functions</title>
<refsect2 id="CUTTER-CHECK-VERSION:CAPS" role="macro" condition="since:1.0.7">
<title>CUTTER_CHECK_VERSION()</title>
<indexterm zone="CUTTER-CHECK-VERSION:CAPS" role="1.0.7"><primary>CUTTER_CHECK_VERSION</primary></indexterm>
<programlisting language="C">#define             CUTTER_CHECK_VERSION(major, minor, micro)</programlisting>
<para>Checks the version of the Cutter. Returns true if the
version of the Cutter header files is the same as or
newer than the passed-in version.</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>major</para></entry>
<entry role="parameter_description"><para>the major version number.</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>minor</para></entry>
<entry role="parameter_description"><para>the minor version number.</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>micro</para></entry>
<entry role="parameter_description"><para>the micro version number.</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><para role="since">Since: <link linkend="api-index-1.0.7">1.0.7</link></para></refsect2>

</refsect1>
<refsect1 id="cutter-Version-Information.other_details" role="details">
<title role="details.title">Types and Values</title>
<refsect2 id="CUTTER-VERSION-MAJOR:CAPS" role="macro">
<title>CUTTER_VERSION_MAJOR</title>
<indexterm zone="CUTTER-VERSION-MAJOR:CAPS"><primary>CUTTER_VERSION_MAJOR</primary></indexterm>
<programlisting language="C">#define CUTTER_VERSION_MAJOR 1
</programlisting>
<para>The major version number of the Cutter.</para>
</refsect2>
<refsect2 id="CUTTER-VERSION-MINOR:CAPS" role="macro">
<title>CUTTER_VERSION_MINOR</title>
<indexterm zone="CUTTER-VERSION-MINOR:CAPS"><primary>CUTTER_VERSION_MINOR</primary></indexterm>
<programlisting language="C">#define CUTTER_VERSION_MINOR 2
</programlisting>
<para>The minor version number of the Cutter.</para>
</refsect2>
<refsect2 id="CUTTER-VERSION-MICRO:CAPS" role="macro">
<title>CUTTER_VERSION_MICRO</title>
<indexterm zone="CUTTER-VERSION-MICRO:CAPS"><primary>CUTTER_VERSION_MICRO</primary></indexterm>
<programlisting language="C">#define CUTTER_VERSION_MICRO 5
</programlisting>
<para>The micro version number of the Cutter.</para>
</refsect2>
<refsect2 id="CUTTER-VERSION-STRING:CAPS" role="macro">
<title>CUTTER_VERSION_STRING</title>
<indexterm zone="CUTTER-VERSION-STRING:CAPS"><primary>CUTTER_VERSION_STRING</primary></indexterm>
<programlisting language="C">#define CUTTER_VERSION_STRING "1.2.5"
</programlisting>
<para>The version number string of the Cutter with
"#{MAJOR}.#{MINOR}.#{MICRO}" format.</para>
</refsect2>

</refsect1>

</refentry>
