mirror of
https://gitlab.gnome.org/GNOME/glib.git
synced 2025-01-13 15:56:23 +01:00
24273ca743
Wed Nov 11 18:11:24 EST 1998 Gregory McLean <gregm@comstar.net>
* docs/*.sgml : Batch of new documentation that should be easier
to maintain and extend. Plus generate whatever sort of doc file
you would like. I didn't change the Makefile stuff as I'm not sure
what default doc type people want. Oh and this is all DocBook format.
Enjoy!
109 lines
3.5 KiB
Plaintext
109 lines
3.5 KiB
Plaintext
<!doctype chapter PUBLIC "-//Davenport//DTD DocBook V3.0//EN" []>
|
|
<chapter id="glib-definitions">
|
|
<docinfo>
|
|
<title>GLIB Definitions and types</title>
|
|
</docinfo>
|
|
<title>GLIB Definitions and types</title>
|
|
<sect1 id="definitions-introduction">
|
|
<title>Introduction</title>
|
|
<para>GLIB provides many abstract defintions to ease the cross platform
|
|
programming tasks. All of these types and definitions have system
|
|
specific values that glib, compiled on the native machine will be
|
|
adjusted to the system specific types.</para>
|
|
<para>By using the following types and defintions in your program, it will
|
|
function in the way you designed on more hardware and operating systems
|
|
combinations.</para>
|
|
<para>We also are provided with definitions for some commonly used macros.
|
|
Some of them are only provided if they haven't already been defined. It
|
|
is assumed that if they are already defined then the current definition
|
|
is correct.</para>
|
|
</sect1>
|
|
<sect1 id="limit-defines">
|
|
<title>Limits</title>
|
|
<para>GLIB provides standard definitions for the extremes of many of the
|
|
standard types. They are as follows.</para>
|
|
<itemizedlist>
|
|
<listitem>
|
|
<para><type>G_MINFLOAT</type></para>
|
|
<para>This is the minimum floating point number that the machine
|
|
that your application is running on can handle.</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para><type>G_MAXFLOAT</type></para>
|
|
<para>This is the maximum floating point number that the machine
|
|
that your application is running on can handle.</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para><type>G_MINDOUBLE</type></para>
|
|
<para>FIXME</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para><type>G_MAXDOUBLE</type></para>
|
|
<para>FIXME</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para><type>G_MINSHORT</type></para>
|
|
<para>FIXME</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para><type>G_MAXSHORT</type></para>
|
|
<para>FIXME</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para><type>G_MININT</type></para>
|
|
<para>FIXME</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para><type>G_MAXINT</type></para>
|
|
<para>FIXME</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para><type>G_MINLONG</type></para>
|
|
<para>FIXME</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para><type>G_MAXLONG</type></para>
|
|
<para>FIXME</para>
|
|
</listitem>
|
|
</itemizedlist>
|
|
</sect1>
|
|
<sect1 id="common-macros">
|
|
<title>Commonly used macros</title>
|
|
<para>This section details out the commonly used macros that the library
|
|
will provide. These definitions will only be provided if they haven't
|
|
been defined before.</para>
|
|
<itemizedlist>
|
|
<listitem>
|
|
<para><type>NULL</type></para>
|
|
<para>A nothing value.</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para><type>FALSE</type></para>
|
|
<para>This macro is used to indicate a non truth.</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para><type>TRUE</type></para>
|
|
<para>This macro represents a true value.</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para><type>MAX</type></para>
|
|
<para>This macro will return the maximum of two variables.</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para><type>MIN</type></para>
|
|
<para>This macro will return the minmum of two variables.</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para><type>ABS</type></para>
|
|
<para>This macros will return the absolute value of a signed integer
|
|
</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para><type>CLAMP</type></para>
|
|
<para>FIXME</para>
|
|
</listitem>
|
|
</itemizedlist>
|
|
</sect1>
|
|
</chapter>
|
|
|