core/version.hpp.in

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2014-2022,  Regents of the University of California,
 *                           Arizona Board of Regents,
 *                           Colorado State University,
 *                           University Pierre & Marie Curie, Sorbonne University,
 *                           Washington University in St. Louis,
 *                           Beijing Institute of Technology,
 *                           The University of Memphis.
 *
 * This file is part of NFD (Named Data Networking Forwarding Daemon).
 * See AUTHORS.md for complete list of NFD authors and contributors.
 *
 * NFD is free software: you can redistribute it and/or modify it under the terms
 * of the GNU General Public License as published by the Free Software Foundation,
 * either version 3 of the License, or (at your option) any later version.
 *
 * NFD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
 * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
 * PURPOSE.  See the GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along with
 * NFD, e.g., in COPYING.md file.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef NFD_CORE_VERSION_HPP
#define NFD_CORE_VERSION_HPP

// The NFD version follows the approach of Calendar Versioning (https://calver.org/)
// based on the year and month of the release, followed by an optional "patch" number,
// i.e., `YY.0M[.MICRO]` using CalVer notation.
//
// To change version number, modify the VERSION variable in the top-level wscript.

/**
 * \brief NFD version represented as an integer.
 *
 * Equivalent to: #NFD_VERSION_MAJOR*1000000 + #NFD_VERSION_MINOR*1000 + #NFD_VERSION_PATCH
 */
#define NFD_VERSION @VERSION@

/// The major version of NFD
#define NFD_VERSION_MAJOR @VERSION_MAJOR@
/// The minor version of NFD
#define NFD_VERSION_MINOR @VERSION_MINOR@
/// The patch version of NFD
#define NFD_VERSION_PATCH @VERSION_PATCH@

/**
 * \brief NFD version represented as a string.
 *
 * Format:
 * @code
 * MAJOR.MINOR.PATCH
 * @endcode
 */
extern const char NFD_VERSION_STRING[];

/**
 * \brief NFD version string, including git commit information if NFD is build from a
 *        specific git commit.
 *
 * #NFD_VERSION_BUILD_STRING is obtained using the following command (`NFD-` prefix is
 * afterwards removed): ``git describe --match 'NFD-*'``
 *
 * When NFD is not built from git, #NFD_VERSION_BUILD_STRING equals #NFD_VERSION_STRING.
 *
 * Format:
 * @code
 * MAJOR.MINOR(.PATCH)(-release-candidate-tag)(-(number-of-commits-since-tag)-COMMIT-HASH)
 * @endcode
 *
 * Example: 2022.02-1-g5c86570
 */
extern const char NFD_VERSION_BUILD_STRING[];

#endif // NFD_CORE_VERSION_HPP