libpurple/version.h.in

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