diff options
Diffstat (limited to 'polkittqt1-version.h.cmake')
-rw-r--r-- | polkittqt1-version.h.cmake | 106 |
1 files changed, 106 insertions, 0 deletions
diff --git a/polkittqt1-version.h.cmake b/polkittqt1-version.h.cmake new file mode 100644 index 000000000..3fd1bb6cb --- /dev/null +++ b/polkittqt1-version.h.cmake @@ -0,0 +1,106 @@ +/* + * Copyright (C) 2007 Sebastian Trueg <trueg@kde.org> + * Copyright (C) 2009 Dario Freddi <drf@kde.org> + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Library General Public + * License as published by the Free Software Foundation; either + * version 2 of the License, or (at your option) any later version. + * + * This library 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 + * Library General Public License for more details. + * + * You should have received a copy of the GNU Library General Public License + * along with this library; see the file COPYING.LIB. If not, write to + * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, + * Boston, MA 02110-1301, USA. + */ + +#ifndef _POLKITTQT1_VERSION_H_ +#define _POLKITTQT1_VERSION_H_ + +#include "polkittqt1-export.h" + +/// @brief PolkitTQt-1 version as string at compile time. +#define POLKITTQT1_VERSION_STRING "${POLKITTQT-1_VERSION_STRING}" + +/// @brief The major PolkitTQt-1 version number at compile time +#define POLKITTQT1_VERSION_MAJOR ${POLKITTQT-1_VERSION_MAJOR} + +/// @brief The minor PolkitTQt-1 version number at compile time +#define POLKITTQT1_VERSION_MINOR ${POLKITTQT-1_VERSION_MINOR} + +/// @brief The PolkitTQt-1 patch version number at compile time +#define POLKITTQT1_VERSION_PATCH ${POLKITTQT-1_VERSION_PATCH} + +/** + * \brief Create a unique number from the major, minor and release number of a %PolkitTQt-1 version + * + * This function can be used for preprocessing. For version information at runtime + * use the version methods in the PolkitTQt-1 namespace. + */ +#define POLKITTQT1_MAKE_VERSION( a,b,c ) (((a) << 16) | ((b) << 8) | (c)) + +/** + * \brief %PolkitTQt-1 Version as a unique number at compile time + * + * This macro calculates the %PolkitTQt-1 version into a number. It is mainly used + * through POLKITTQT1_IS_VERSION in preprocessing. For version information at runtime + * use the version methods in the PolkitTQt-1 namespace. + */ +#define POLKITTQT1_VERSION \ + POLKITTQT1_MAKE_VERSION(POLKITTQT1_VERSION_MAJOR,POLKITTQT1_VERSION_MINOR,POLKITTQT1_VERSION_PATCH) + +/** + * \brief Check if the %PolkitTQt-1 version matches a certain version or is higher + * + * This macro is typically used to compile conditionally a part of code: + * \code + * #if POLKITTQT1_IS_VERSION(2,1) + * // Code for PolkitTQt-1 2.1 + * #else + * // Code for PolkitTQt-1 2.0 + * #endif + * \endcode + * + * For version information at runtime + * use the version methods in the PolkitTQt-1 namespace. + */ +#define POLKITTQT1_IS_VERSION(a,b,c) ( POLKITTQT1_VERSION >= POLKITTQT1_MAKE_VERSION(a,b,c) ) + + +namespace PolkitTQt1 { + /** + * @brief Returns the major number of PolkitTQt-1's version, e.g. + * 1 for %PolkitTQt-1 1.0.2. + * @return the major version number at runtime. + */ + POLKITTQT1_EXPORT unsigned int versionMajor(); + + /** + * @brief Returns the minor number of PolkitTQt-1's version, e.g. + * 0 for %PolkitTQt-1 1.0.2. + * @return the minor version number at runtime. + */ + POLKITTQT1_EXPORT unsigned int versionMinor(); + + /** + * @brief Returns the patch number of PolkitTQt-1's version, e.g. + * 2 for %PolkitTQt-1 1.0.2. + * @return the release number at runtime. + */ + POLKITTQT1_EXPORT unsigned int versionPatch(); + + /** + * @brief Returns the %PolkitTQt-1 version as string, e.g. "1.0.2". + * + * On contrary to the macro POLKITTQT1_VERSION_STRING this function returns + * the version number of PolkitTQt-1 at runtime. + * @return the %PolkitTQt-1 version. You can keep the string forever + */ + POLKITTQT1_EXPORT const char* versionString(); +} + +#endif |