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

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

<synopsis>#define             <link linkend="CUTTER-CHECK-VERSION:CAPS">CUTTER_CHECK_VERSION</link>                (major,
                                                         minor,
                                                         micro)
#define             <link linkend="CUTTER-VERSION-MAJOR:CAPS">CUTTER_VERSION_MAJOR</link>
#define             <link linkend="CUTTER-VERSION-MICRO:CAPS">CUTTER_VERSION_MICRO</link>
#define             <link linkend="CUTTER-VERSION-MINOR:CAPS">CUTTER_VERSION_MINOR</link>
#define             <link linkend="CUTTER-VERSION-STRING:CAPS">CUTTER_VERSION_STRING</link>
</synopsis>
</refsynopsisdiv>

<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.details" role="details">
<title role="details.title">Details</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>#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><variablelist role="params">
<varlistentry><term><parameter>major</parameter>&#160;:</term>
<listitem><simpara>the major version number.</simpara></listitem></varlistentry>
<varlistentry><term><parameter>minor</parameter>&#160;:</term>
<listitem><simpara>the minor version number.</simpara></listitem></varlistentry>
<varlistentry><term><parameter>micro</parameter>&#160;:</term>
<listitem><simpara>the micro version number.</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 1.0.7</para></refsect2>
<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>#define CUTTER_VERSION_MAJOR 1
</programlisting>
<para>
The major 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>#define CUTTER_VERSION_MICRO 1
</programlisting>
<para>
The micro 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>#define CUTTER_VERSION_MINOR 2
</programlisting>
<para>
The minor 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>#define CUTTER_VERSION_STRING "1.2.1"
</programlisting>
<para>
The version number string of the Cutter with
"#{MAJOR}.#{MINOR}.#{MICRO}" format.
</para></refsect2>

</refsect1>

</refentry>
