csver.h File Reference (Crystal Space 2.0 Public API Reference)

| ## Public API Reference

- Main Page
- Related Pages
- Modules
- Namespaces
- Classes
- Files

- File List
- File Members

Defines
csver.h File Reference

Crystal Space Version Information. More...

Go to the source code of this file.

## Defines
#define | CS_COMPILER_NAME "MysteryCompiler"
| Name of the compiler CS is compiled with (i.e. GCC)
#define | CS_PLATFORM_NAME "MysteryPlatform"
| Name of the platform CS is compiled for (i.e. Win32)
#define | CS_PROCESSOR_NAME "MysteryProcessor"
| Name of the processor CS is compiled for (i.e. X86)
#define | CS_VERSION
| A complete version string, including platform, processor and compiler.
#define | CS_VERSION_NUMBER
| A complete version number.
#define | CS_VERSION_NUMBER_COMPATIBLE CS_VERSION_MAJOR "." CS_VERSION_MINOR
| A string identifying mutually (binarily) compatible versions.
#define | CS_VERSION_RCSREV 0
| Build version based off SVN revision.
Version number definitions (numeric)
#define | CS_VERSION_NUM_MAJOR 2
| Major version.
#define | CS_VERSION_NUM_MINOR 0
| Minor version (even are stable versions, odd are development versions)
#define | CS_VERSION_NUM_RELEASE 0
| Maintenance release.
#define | CS_VERSION_NUM_BUILD CS_VERSION_RCSREV
| Build number.
#define | CS_VERSION_NUM_COMPARABLE(Major, Minor, Release, Build) ((Major)*10000000 + (Minor)*100000 + (Release)*1000 + (Build))
| Encode a version into a single number comparable using <, > etc.
#define | CS_VERSION_NUM_COMPARABLE_CURRENT
| Current version, encode into a single number comparable using <, > etc.
Version number definitions (strings)
#define | CS_VERSION_MAJOR CS_VER_QUOTE(CS_VERSION_NUM_MAJOR)
| Major version.
#define | CS_VERSION_MINOR CS_VER_QUOTE(CS_VERSION_NUM_MINOR)
| Minor version (even are stable versions, odd are development versions)
#define | CS_VERSION_RELEASE CS_VER_QUOTE(CS_VERSION_NUM_RELEASE)
| Maintenance release.
#define | CS_VERSION_BUILD CS_VER_QUOTE(CS_VERSION_NUM_BUILD)
| Build number.
#define | CS_RELEASE_DATE CS_VER_QUOTE_(Tue 03-July-2012)
| Date of release.

## Detailed Description

Crystal Space Version Information.

Definition in file csver.h.

## Define Documentation

#define CS_COMPILER_NAME "MysteryCompiler"

Name of the compiler CS is compiled with (i.e. GCC)

Definition at line 124 of file csver.h.

#define CS_PLATFORM_NAME "MysteryPlatform"

Name of the platform CS is compiled for (i.e. Win32)

Definition at line 106 of file csver.h.

#define CS_PROCESSOR_NAME "MysteryProcessor"

Name of the processor CS is compiled for (i.e. X86)

Definition at line 115 of file csver.h.

#define CS_RELEASE_DATE CS_VER_QUOTE_(Tue 03-July-2012)

Date of release.

Definition at line 98 of file csver.h.

#define CS_VERSION

Value:

    CS_VERSION_NUMBER \
      " [" CS_PLATFORM_NAME "-" \
      CS_PROCESSOR_NAME "(" CS_VER_QUOTE(CS_PROCESSOR_SIZE) ")-" \
      CS_COMPILER_NAME "]"

A complete version string, including platform, processor and compiler.

Definition at line 149 of file csver.h.

#define CS_VERSION_BUILD CS_VER_QUOTE(CS_VERSION_NUM_BUILD)

Build number.

Definition at line 96 of file csver.h.

#define CS_VERSION_MAJOR CS_VER_QUOTE(CS_VERSION_NUM_MAJOR)

Major version.

Definition at line 90 of file csver.h.

#define CS_VERSION_MINOR CS_VER_QUOTE(CS_VERSION_NUM_MINOR)

Minor version (even are stable versions, odd are development versions)

Definition at line 92 of file csver.h.

#define CS_VERSION_NUM_BUILD CS_VERSION_RCSREV

Build number.

(Actually, a version number dependent on the SVN revision this version was built off.)

Definition at line 76 of file csver.h.

#define CS_VERSION_NUM_COMPARABLE | ( |  | Major,
|  |  | Minor,
|  |  | Release,
|  |  | Build
| ) |  | ((Major)*10000000 + (Minor)*100000 + (Release)*1000 + (Build))

Encode a version into a single number comparable using <, > etc.

Definition at line 79 of file csver.h.

#define CS_VERSION_NUM_COMPARABLE_CURRENT

Value:

    CS_VERSION_NUM_COMPARABLE(CS_VERSION_NUM_MAJOR, CS_VERSION_NUM_MINOR, \
        CS_VERSION_NUM_RELEASE, CS_VERSION_NUM_BUILD)

Current version, encode into a single number comparable using <, > etc.

Definition at line 82 of file csver.h.

#define CS_VERSION_NUM_MAJOR 2

Major version.

Definition at line 66 of file csver.h.

#define CS_VERSION_NUM_MINOR 0

Minor version (even are stable versions, odd are development versions)

Definition at line 68 of file csver.h.

#define CS_VERSION_NUM_RELEASE 0

Maintenance release.

Definition at line 70 of file csver.h.

#define CS_VERSION_NUMBER

Value:

    CS_VERSION_MAJOR "." CS_VERSION_MINOR "." \
      CS_VERSION_RELEASE "." CS_VERSION_BUILD

A complete version number.

Definition at line 133 of file csver.h.

#define CS_VERSION_NUMBER_COMPATIBLE CS_VERSION_MAJOR "." CS_VERSION_MINOR

A string identifying mutually (binarily) compatible versions.

Stable versions with the same major and minor version are binary compatible between each other. Unstable versions are generally not binary compatible, hence builds from different SVN revisions are treated as incompatible.

Definition at line 145 of file csver.h.

#define CS_VERSION_RCSREV 0

Build version based off SVN revision.

This is not the straight SVN revision - instead it's the difference between the "last changed" SVN revision and the revision of csver.h.template. This is done to keep the number in a relatively small range (e.g. Win32 version number components usually only hold 16 bit numbers). When a version bump happens, csver.h.template is edited to reflect the new major and minor versions. This will also 'reset' the relative SVN revision number.

However, in case csver.h.template is edited for a reason other than a version bump, CS_RCSREV_OFFSET is provided to allow adjustment of the relative SVN revision to avoid having it go backwards. Set the offset to the value reported by `rcsrev print` (BEFORE committing).

CS_RCSREV_OFFSET should be set to 0 again when bumping the version.

The relative SVN revision is computed by the script `rcsrev`.

Definition at line 60 of file csver.h.

#define CS_VERSION_RELEASE CS_VER_QUOTE(CS_VERSION_NUM_RELEASE)

Maintenance release.

Definition at line 94 of file csver.h.