plasma-framework/version.h

92 lines
2.4 KiB
C++

/*
* Copyright 2008 by Aaron Seigo <aseigo@kde.org>
*
* This program 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, or
* (at your option) any later version.
*
* This program 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 Library General Public
* License along with this program; if not, write to the
* Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
#ifndef PLASMA_VERSION_H
#define PLASMA_VERSION_H
#include <plasma/plasma_export.h>
/**
* String version of libplasma version, suitable for use in
* file formats or network protocols
*/
#define PLASMA_VERSION_STRING "3.0.0"
/// @brief Major version of libplasma, at compile time
#define PLASMA_VERSION_MAJOR 3
/// @brief Minor version of libplasma, at compile time
#define PLASMA_VERSION_MINOR 0
/// @brief Release version of libplasma, at compile time
#define PLASMA_VERSION_RELEASE 0
#define PLASMA_MAKE_VERSION(a,b,c) (((a) << 16) | ((b) << 8) | (c))
/**
* Compile time macro for the version number of libplasma
*/
#define PLASMA_VERSION \
PLASMA_MAKE_VERSION(PLASMA_VERSION_MAJOR,PLASMA_VERSION_MINOR,PLASMA_VERSION_RELEASE)
/**
* Compile-time macro for checking the plasma version. Not useful for
* detecting the version of libplasma at runtime.
*/
#define PLASMA_IS_VERSION(a,b,c) (PLASMA_VERSION >= PLASMA_MAKE_VERSION(a,b,c))
/**
* Namespace for everything in libplasma
*/
namespace Plasma
{
/**
* The runtime version of libplasma
*/
PLASMA_EXPORT unsigned int version();
/**
* The runtime major version of libplasma
*/
PLASMA_EXPORT unsigned int versionMajor();
/**
* The runtime major version of libplasma
*/
PLASMA_EXPORT unsigned int versionMinor();
/**
* The runtime major version of libplasma
*/
PLASMA_EXPORT unsigned int versionRelease();
/**
* The runtime version string of libplasma
*/
PLASMA_EXPORT const char *versionString();
/**
* Verifies that a plugin is compatible with plasma
*/
PLASMA_EXPORT bool isPluginVersionCompatible(unsigned int version);
} // Plasma namespace
#endif // multiple inclusion guard