libpurple/version.h.in

   1 /**
   2  * @file version.h Purple Versioning
   3  *
   4  * purple
   5  *
   6  * Purple is the legal property of its developers, whose names are too numerous
   7  * to list here.  Please refer to the COPYRIGHT file distributed with this
   8  * source distribution.
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02111-1301  USA
  23  */
  24 #ifndef _PURPLE_VERSION_H_
  25 #define _PURPLE_VERSION_H_
  26
  27 /** The major version of the running libpurple. */
  28 #define PURPLE_MAJOR_VERSION (@PURPLE_MAJOR_VERSION@)
  29 /** The minor version of the running libpurple. */
  30 #define PURPLE_MINOR_VERSION (@PURPLE_MINOR_VERSION@)
  31 /** The micro version of the running libpurple. */
  32 #define PURPLE_MICRO_VERSION (@PURPLE_MICRO_VERSION@)
  33
  34 #define PURPLE_VERSION_CHECK(x,y,z) ((x) == PURPLE_MAJOR_VERSION && \
  35                                                                          ((y) < PURPLE_MINOR_VERSION || \
  36                                                                           ((y) == PURPLE_MINOR_VERSION && (z) <= PURPLE_MICRO_VERSION)))
  37
  38 #ifdef __cplusplus
  39 extern "C" {
  40 #endif
  41
  42 /**
  43  * Checks that the libpurple version is compatible with the requested
  44  * version
  45  *
  46  * @param required_major: the required major version.
  47  * @param required_minor: the required minor version.
  48  * @param required_micro: the required micro version.
  49  *
  50  * @return NULL if the versions are compatible, or a string describing
  51  *         the version mismatch if not compatible.
  52  */
  53 const char *purple_version_check(guint required_major, guint required_minor, guint required_micro);
  54
  55 /**
  56  * The major version of the running libpurple.  Contrast with
  57  * #PURPLE_MAJOR_VERSION, which expands at compile time to the major version of
  58  * libpurple being compiled against.
  59  *
  60  * @since 2.4.0
  61  */
  62 extern const guint purple_major_version;
  63
  64 /**
  65  * The minor version of the running libpurple.  Contrast with
  66  * #PURPLE_MINOR_VERSION, which expands at compile time to the minor version of
  67  * libpurple being compiled against.
  68  *
  69  * @since 2.4.0
  70  */
  71 extern const guint purple_minor_version;
  72
  73 /**
  74  *
  75  * The micro version of the running libpurple.  Contrast with
  76  * #PURPLE_MICRO_VERSION, which expands at compile time to the micro version of
  77  * libpurple being compiled against.
  78  *
  79  * @since 2.4.0
  80  */
  81 extern const guint purple_micro_version;
  82
  83 #ifdef __cplusplus
  84 }
  85 #endif
  86
  87 #endif /* _PURPLE_VERSION_H_ */
  88