Version Information

Version Information — Variables and functions to check the CTK+ version

Functions

Types and Values

Includes

#include <ctk/ctk.h>

Description

CTK+ provides version information, primarily useful in configure checks for builds that have a configure script. Applications will not typically use the features described here.

Functions

ctk_get_major_version ()

guint
ctk_get_major_version (void);

Returns the major version number of the CTK+ library. (e.g. in CTK+ version 3.1.5 this is 3.)

This function is in the library, so it represents the CTK+ library your code is running against. Contrast with the CTK_MAJOR_VERSION macro, which represents the major version of the CTK+ headers you have included when compiling your code.

Returns

the major version number of the CTK+ library

Since: 3.0


ctk_get_minor_version ()

guint
ctk_get_minor_version (void);

Returns the minor version number of the CTK+ library. (e.g. in CTK+ version 3.1.5 this is 1.)

This function is in the library, so it represents the CTK+ library your code is are running against. Contrast with the CTK_MINOR_VERSION macro, which represents the minor version of the CTK+ headers you have included when compiling your code.

Returns

the minor version number of the CTK+ library

Since: 3.0


ctk_get_micro_version ()

guint
ctk_get_micro_version (void);

Returns the micro version number of the CTK+ library. (e.g. in CTK+ version 3.1.5 this is 5.)

This function is in the library, so it represents the CTK+ library your code is are running against. Contrast with the CTK_MICRO_VERSION macro, which represents the micro version of the CTK+ headers you have included when compiling your code.

Returns

the micro version number of the CTK+ library

Since: 3.0


ctk_get_binary_age ()

guint
ctk_get_binary_age (void);

Returns the binary age as passed to libtool when building the CTK+ library the process is running against. If libtool means nothing to you, don't worry about it.

Returns

the binary age of the CTK+ library

Since: 3.0


ctk_get_interface_age ()

guint
ctk_get_interface_age (void);

Returns the interface age as passed to libtool when building the CTK+ library the process is running against. If libtool means nothing to you, don't worry about it.

Returns

the interface age of the CTK+ library

Since: 3.0


ctk_check_version ()

const gchar *
ctk_check_version (guint required_major,
                   guint required_minor,
                   guint required_micro);

Checks that the CTK+ library in use is compatible with the given version. Generally you would pass in the constants CTK_MAJOR_VERSION, CTK_MINOR_VERSION, CTK_MICRO_VERSION as the three arguments to this function; that produces a check that the library in use is compatible with the version of CTK+ the application or module was compiled against.

Compatibility is defined by two things: first the version of the running library is newer than the version required_major.required_minor .required_micro . Second the running library must be binary compatible with the version required_major.required_minor .required_micro (same major version.)

This function is primarily for CTK+ modules; the module can call this function to check that it wasn’t loaded into an incompatible version of CTK+. However, such a check isn’t completely reliable, since the module may be linked against an old version of CTK+ and calling the old version of ctk_check_version(), but still get loaded into an application using a newer version of CTK+.

Parameters

required_major

the required major version

 

required_minor

the required minor version

 

required_micro

the required micro version

 

Returns

NULL if the CTK+ library is compatible with the given version, or a string describing the version mismatch. The returned string is owned by CTK+ and should not be modified or freed.

[nullable]


CTK_CHECK_VERSION()

#define             CTK_CHECK_VERSION(major,minor,micro)

Returns TRUE if the version of the CTK+ header files is the same as or newer than the passed-in version.

Parameters

major

major version (e.g. 1 for version 1.2.5)

 

minor

minor version (e.g. 2 for version 1.2.5)

 

micro

micro version (e.g. 5 for version 1.2.5)

 

Returns

TRUE if CTK+ headers are new enough

Types and Values

ctk_major_version

#define ctk_major_version ctk_get_major_version ()

ctk_minor_version

#define ctk_minor_version ctk_get_minor_version ()

ctk_micro_version

#define ctk_micro_version ctk_get_micro_version ()

ctk_binary_age

#define ctk_binary_age ctk_get_binary_age ()

ctk_interface_age

#define ctk_interface_age ctk_get_interface_age ()

CTK_MAJOR_VERSION

#define CTK_MAJOR_VERSION (3)

Like ctk_get_major_version(), but from the headers used at application compile time, rather than from the library linked against at application run time.


CTK_MINOR_VERSION

#define CTK_MINOR_VERSION (25)

Like ctk_get_minor_version(), but from the headers used at application compile time, rather than from the library linked against at application run time.


CTK_MICRO_VERSION

#define CTK_MICRO_VERSION (7)

Like ctk_get_micro_version(), but from the headers used at application compile time, rather than from the library linked against at application run time.


CTK_BINARY_AGE

#define CTK_BINARY_AGE    (2507)

Like ctk_get_binary_age(), but from the headers used at application compile time, rather than from the library linked against at application run time.


CTK_INTERFACE_AGE

#define CTK_INTERFACE_AGE (5)

Like ctk_get_interface_age(), but from the headers used at application compile time, rather than from the library linked against at application run time.