bdlscm_versiontag

Detailed Description

Provide versioning information for the bdl package group.

Outline

• Purpose
• Description
  • Usage
    • Example 1: Basic Usage

Purpose

Provide versioning information for the bdl package group.

See also

bdlscm_version

Description

This component provides versioning information for the bdl package group. The BDL_VERSION macro that is supplied can be used for conditional-compilation based on bdl version information. The following usage example illustrates this basic capability.

Note that since bdl is always released in lock-step with bsl, they share common versioning, and the BDL_VERSION will always equal the BSL_VERSION.

Usage

This section illustrates intended use of this component.

Example 1: Basic Usage

At compile time, the version of BDL can be used to select an older or newer way to accomplish a task, to enable new functionality, or to accommodate an interface change. For example, if the name of a function changes (a rare occurrence, but potentially disruptive when it does happen), the impact on affected code can be minimized by conditionally calling the function by its old or new name using conditional compilation. In the following, the #if preprocessor directive compares BDL_VERSION (i.e., the latest BDL version, excluding the patch version) to a specified major and minor version composed using the BSL_MAKE_VERSION macro:

#if BDL_VERSION > BSL_MAKE_VERSION(1, 3)
    // Call 'newFunction' for BDL versions later than 1.3.
    int result = newFunction();
#else
    // Call 'oldFunction' for BDL version 1.3 or earlier.
    int result = oldFunction();
#endif

Macro Definition Documentation

BDL_VERSION

#define BDL_VERSION

Value:

                                     BSL_MAKE_VERSION(BDL_VERSION_MAJOR, \
                                     BDL_VERSION_MINOR)

Construct an integer (unique to the specified BDL_VERSION_MAJOR and BDL_VERSION_MINOR numbers) corresponding to the major and minor version numbers, respectively, of the current (latest) BDL release.

Note

Note that the patch version number is intentionally not included. The exact format of the result is an implementation detail of bslscm_versiontag . The major and minor parts of the resulting version can be extracted with BSL_GET_VERSION_MAJOR and BSL_GET_VERSION_MINOR respectively.

BDL_VERSION_DEPRECATION_THRESHOLD

#define BDL_VERSION_DEPRECATION_THRESHOLD   BSLS_DEPRECATE_MAKE_VER(3, 1)

Declare that deprecations for this UOR introduced in the specified version or earlier will be "active" by default – i.e., BSLS_DEPRECATE_IS_ACTIVE will be true (which typically enables deprecation warnings).

Note

Note that we define this macro in the version component, so that it is available at the lowest level in the component hierarchy of this UOR.

BDL_VERSION_MAJOR

#define BDL_VERSION_MAJOR   4

Provide the major version number of the current (latest) BDL release.

BDL_VERSION_MINOR

#define BDL_VERSION_MINOR   39

Provide the minor version number of the current (latest) BDL release.