libpurple/version.h.in

Wed, 03 Jul 2019 00:21:33 -0400

author
Elliott Sales de Andrade <qulogic@pidgin.im>
date
Wed, 03 Jul 2019 00:21:33 -0400
changeset 39659
e4dfb99b0cef
parent 39383
0f9d49617abc
child 40206
566c210f7003
permissions
-rw-r--r--

Fix libpurple header guards using reserved names.

35429
a69e118387f8 Add section block for *.h.in
Ankit Vani <a@nevitus.org>
parents: 35397
diff changeset
1 /*
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
2 * purple
9943
b54a762f60fa [gaim-migrate @ 10835]
Nathan Walp <nwalp@pidgin.im>
parents:
diff changeset
3 *
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
4 * Purple is the legal property of its developers, whose names are too numerous
9943
b54a762f60fa [gaim-migrate @ 10835]
Nathan Walp <nwalp@pidgin.im>
parents:
diff changeset
5 * to list here. Please refer to the COPYRIGHT file distributed with this
b54a762f60fa [gaim-migrate @ 10835]
Nathan Walp <nwalp@pidgin.im>
parents:
diff changeset
6 * source distribution.
b54a762f60fa [gaim-migrate @ 10835]
Nathan Walp <nwalp@pidgin.im>
parents:
diff changeset
7 *
b54a762f60fa [gaim-migrate @ 10835]
Nathan Walp <nwalp@pidgin.im>
parents:
diff changeset
8 * This program is free software; you can redistribute it and/or modify
b54a762f60fa [gaim-migrate @ 10835]
Nathan Walp <nwalp@pidgin.im>
parents:
diff changeset
9 * it under the terms of the GNU General Public License as published by
b54a762f60fa [gaim-migrate @ 10835]
Nathan Walp <nwalp@pidgin.im>
parents:
diff changeset
10 * the Free Software Foundation; either version 2 of the License, or
b54a762f60fa [gaim-migrate @ 10835]
Nathan Walp <nwalp@pidgin.im>
parents:
diff changeset
11 * (at your option) any later version.
b54a762f60fa [gaim-migrate @ 10835]
Nathan Walp <nwalp@pidgin.im>
parents:
diff changeset
12 *
b54a762f60fa [gaim-migrate @ 10835]
Nathan Walp <nwalp@pidgin.im>
parents:
diff changeset
13 * This program is distributed in the hope that it will be useful,
b54a762f60fa [gaim-migrate @ 10835]
Nathan Walp <nwalp@pidgin.im>
parents:
diff changeset
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
b54a762f60fa [gaim-migrate @ 10835]
Nathan Walp <nwalp@pidgin.im>
parents:
diff changeset
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
b54a762f60fa [gaim-migrate @ 10835]
Nathan Walp <nwalp@pidgin.im>
parents:
diff changeset
16 * GNU General Public License for more details.
b54a762f60fa [gaim-migrate @ 10835]
Nathan Walp <nwalp@pidgin.im>
parents:
diff changeset
17 *
b54a762f60fa [gaim-migrate @ 10835]
Nathan Walp <nwalp@pidgin.im>
parents:
diff changeset
18 * You should have received a copy of the GNU General Public License
b54a762f60fa [gaim-migrate @ 10835]
Nathan Walp <nwalp@pidgin.im>
parents:
diff changeset
19 * along with this program; if not, write to the Free Software
19859
71d37b57eff2 The FSF changed its address a while ago; our files were out of date.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 16872
diff changeset
20 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
9943
b54a762f60fa [gaim-migrate @ 10835]
Nathan Walp <nwalp@pidgin.im>
parents:
diff changeset
21 */
35487
494f09f7f331 Move section blocks inside inclusion guards -- otherwise g-ir-scanner yells
Ankit Vani <a@nevitus.org>
parents: 35436
diff changeset
22
39659
e4dfb99b0cef Fix libpurple header guards using reserved names.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents: 39383
diff changeset
23 #ifndef PURPLE_VERSION_H
e4dfb99b0cef Fix libpurple header guards using reserved names.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents: 39383
diff changeset
24 #define PURPLE_VERSION_H
35429
a69e118387f8 Add section block for *.h.in
Ankit Vani <a@nevitus.org>
parents: 35397
diff changeset
25 /**
a69e118387f8 Add section block for *.h.in
Ankit Vani <a@nevitus.org>
parents: 35397
diff changeset
26 * SECTION:version
a69e118387f8 Add section block for *.h.in
Ankit Vani <a@nevitus.org>
parents: 35397
diff changeset
27 * @section_id: libpurple-version
35436
a69d2e5604c5 Swap @title and @short_description roles
Ankit Vani <a@nevitus.org>
parents: 35429
diff changeset
28 * @short_description: <filename>version.h</filename>
a69d2e5604c5 Swap @title and @short_description roles
Ankit Vani <a@nevitus.org>
parents: 35429
diff changeset
29 * @title: Purple Versioning
35429
a69e118387f8 Add section block for *.h.in
Ankit Vani <a@nevitus.org>
parents: 35397
diff changeset
30 */
a69e118387f8 Add section block for *.h.in
Ankit Vani <a@nevitus.org>
parents: 35397
diff changeset
31
35397
31fa3a1aeff5 Move changes from soc.2013.gobjectification.gtkdoc to this branch
Ankit Vani <a@nevitus.org>
parents: 35393
diff changeset
32 /**
31fa3a1aeff5 Move changes from soc.2013.gobjectification.gtkdoc to this branch
Ankit Vani <a@nevitus.org>
parents: 35393
diff changeset
33 * PURPLE_MAJOR_VERSION:
31fa3a1aeff5 Move changes from soc.2013.gobjectification.gtkdoc to this branch
Ankit Vani <a@nevitus.org>
parents: 35393
diff changeset
34 *
31fa3a1aeff5 Move changes from soc.2013.gobjectification.gtkdoc to this branch
Ankit Vani <a@nevitus.org>
parents: 35393
diff changeset
35 * The major version of the running libpurple.
31fa3a1aeff5 Move changes from soc.2013.gobjectification.gtkdoc to this branch
Ankit Vani <a@nevitus.org>
parents: 35393
diff changeset
36 */
16651
218fe51ae7b7 soname versioning of libpurple. Should help resolve debian bug 421282
Stu Tomlinson <nosnilmot@pidgin.im>
parents: 15884
diff changeset
37 #define PURPLE_MAJOR_VERSION (@PURPLE_MAJOR_VERSION@)
35397
31fa3a1aeff5 Move changes from soc.2013.gobjectification.gtkdoc to this branch
Ankit Vani <a@nevitus.org>
parents: 35393
diff changeset
38
31fa3a1aeff5 Move changes from soc.2013.gobjectification.gtkdoc to this branch
Ankit Vani <a@nevitus.org>
parents: 35393
diff changeset
39 /**
31fa3a1aeff5 Move changes from soc.2013.gobjectification.gtkdoc to this branch
Ankit Vani <a@nevitus.org>
parents: 35393
diff changeset
40 * PURPLE_MINOR_VERSION:
31fa3a1aeff5 Move changes from soc.2013.gobjectification.gtkdoc to this branch
Ankit Vani <a@nevitus.org>
parents: 35393
diff changeset
41 *
31fa3a1aeff5 Move changes from soc.2013.gobjectification.gtkdoc to this branch
Ankit Vani <a@nevitus.org>
parents: 35393
diff changeset
42 * The minor version of the running libpurple.
31fa3a1aeff5 Move changes from soc.2013.gobjectification.gtkdoc to this branch
Ankit Vani <a@nevitus.org>
parents: 35393
diff changeset
43 */
16651
218fe51ae7b7 soname versioning of libpurple. Should help resolve debian bug 421282
Stu Tomlinson <nosnilmot@pidgin.im>
parents: 15884
diff changeset
44 #define PURPLE_MINOR_VERSION (@PURPLE_MINOR_VERSION@)
35397
31fa3a1aeff5 Move changes from soc.2013.gobjectification.gtkdoc to this branch
Ankit Vani <a@nevitus.org>
parents: 35393
diff changeset
45
31fa3a1aeff5 Move changes from soc.2013.gobjectification.gtkdoc to this branch
Ankit Vani <a@nevitus.org>
parents: 35393
diff changeset
46 /**
31fa3a1aeff5 Move changes from soc.2013.gobjectification.gtkdoc to this branch
Ankit Vani <a@nevitus.org>
parents: 35393
diff changeset
47 * PURPLE_MICRO_VERSION:
31fa3a1aeff5 Move changes from soc.2013.gobjectification.gtkdoc to this branch
Ankit Vani <a@nevitus.org>
parents: 35393
diff changeset
48 *
31fa3a1aeff5 Move changes from soc.2013.gobjectification.gtkdoc to this branch
Ankit Vani <a@nevitus.org>
parents: 35393
diff changeset
49 * The micro version of the running libpurple.
31fa3a1aeff5 Move changes from soc.2013.gobjectification.gtkdoc to this branch
Ankit Vani <a@nevitus.org>
parents: 35393
diff changeset
50 */
16651
218fe51ae7b7 soname versioning of libpurple. Should help resolve debian bug 421282
Stu Tomlinson <nosnilmot@pidgin.im>
parents: 15884
diff changeset
51 #define PURPLE_MICRO_VERSION (@PURPLE_MICRO_VERSION@)
9943
b54a762f60fa [gaim-migrate @ 10835]
Nathan Walp <nwalp@pidgin.im>
parents:
diff changeset
52
16651
218fe51ae7b7 soname versioning of libpurple. Should help resolve debian bug 421282
Stu Tomlinson <nosnilmot@pidgin.im>
parents: 15884
diff changeset
53 #define PURPLE_VERSION_CHECK(x,y,z) ((x) == PURPLE_MAJOR_VERSION && \
218fe51ae7b7 soname versioning of libpurple. Should help resolve debian bug 421282
Stu Tomlinson <nosnilmot@pidgin.im>
parents: 15884
diff changeset
54 ((y) < PURPLE_MINOR_VERSION || \
218fe51ae7b7 soname versioning of libpurple. Should help resolve debian bug 421282
Stu Tomlinson <nosnilmot@pidgin.im>
parents: 15884
diff changeset
55 ((y) == PURPLE_MINOR_VERSION && (z) <= PURPLE_MICRO_VERSION)))
9943
b54a762f60fa [gaim-migrate @ 10835]
Nathan Walp <nwalp@pidgin.im>
parents:
diff changeset
56
39383
0f9d49617abc Use G_BEGIN_DECLS and G_END_DECLS instead of raw extern "C"
Mike Ruprecht <cmaiku@gmail.com>
parents: 37094
diff changeset
57 G_BEGIN_DECLS
9943
b54a762f60fa [gaim-migrate @ 10835]
Nathan Walp <nwalp@pidgin.im>
parents:
diff changeset
58
16651
218fe51ae7b7 soname versioning of libpurple. Should help resolve debian bug 421282
Stu Tomlinson <nosnilmot@pidgin.im>
parents: 15884
diff changeset
59 /**
35397
31fa3a1aeff5 Move changes from soc.2013.gobjectification.gtkdoc to this branch
Ankit Vani <a@nevitus.org>
parents: 35393
diff changeset
60 * purple_version_check:
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 32438
diff changeset
61 * @required_major: the required major version.
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 32438
diff changeset
62 * @required_minor: the required minor version.
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 32438
diff changeset
63 * @required_micro: the required micro version.
16651
218fe51ae7b7 soname versioning of libpurple. Should help resolve debian bug 421282
Stu Tomlinson <nosnilmot@pidgin.im>
parents: 15884
diff changeset
64 *
35397
31fa3a1aeff5 Move changes from soc.2013.gobjectification.gtkdoc to this branch
Ankit Vani <a@nevitus.org>
parents: 35393
diff changeset
65 * Checks that the libpurple version is compatible with the requested
31fa3a1aeff5 Move changes from soc.2013.gobjectification.gtkdoc to this branch
Ankit Vani <a@nevitus.org>
parents: 35393
diff changeset
66 * version
31fa3a1aeff5 Move changes from soc.2013.gobjectification.gtkdoc to this branch
Ankit Vani <a@nevitus.org>
parents: 35393
diff changeset
67 *
31fa3a1aeff5 Move changes from soc.2013.gobjectification.gtkdoc to this branch
Ankit Vani <a@nevitus.org>
parents: 35393
diff changeset
68 * Returns: %NULL if the versions are compatible, or a string describing
31fa3a1aeff5 Move changes from soc.2013.gobjectification.gtkdoc to this branch
Ankit Vani <a@nevitus.org>
parents: 35393
diff changeset
69 * the version mismatch if not compatible.
16651
218fe51ae7b7 soname versioning of libpurple. Should help resolve debian bug 421282
Stu Tomlinson <nosnilmot@pidgin.im>
parents: 15884
diff changeset
70 */
218fe51ae7b7 soname versioning of libpurple. Should help resolve debian bug 421282
Stu Tomlinson <nosnilmot@pidgin.im>
parents: 15884
diff changeset
71 const char *purple_version_check(guint required_major, guint required_minor, guint required_micro);
218fe51ae7b7 soname versioning of libpurple. Should help resolve debian bug 421282
Stu Tomlinson <nosnilmot@pidgin.im>
parents: 15884
diff changeset
72
22039
f2aa47f387a6 Export purple_*_version in version.h.
Will Thompson <resiak@pidgin.im>
parents: 22030
diff changeset
73 /**
35397
31fa3a1aeff5 Move changes from soc.2013.gobjectification.gtkdoc to this branch
Ankit Vani <a@nevitus.org>
parents: 35393
diff changeset
74 * purple_major_version:
31fa3a1aeff5 Move changes from soc.2013.gobjectification.gtkdoc to this branch
Ankit Vani <a@nevitus.org>
parents: 35393
diff changeset
75 *
22039
f2aa47f387a6 Export purple_*_version in version.h.
Will Thompson <resiak@pidgin.im>
parents: 22030
diff changeset
76 * The major version of the running libpurple. Contrast with
f2aa47f387a6 Export purple_*_version in version.h.
Will Thompson <resiak@pidgin.im>
parents: 22030
diff changeset
77 * #PURPLE_MAJOR_VERSION, which expands at compile time to the major version of
f2aa47f387a6 Export purple_*_version in version.h.
Will Thompson <resiak@pidgin.im>
parents: 22030
diff changeset
78 * libpurple being compiled against.
f2aa47f387a6 Export purple_*_version in version.h.
Will Thompson <resiak@pidgin.im>
parents: 22030
diff changeset
79 */
f2aa47f387a6 Export purple_*_version in version.h.
Will Thompson <resiak@pidgin.im>
parents: 22030
diff changeset
80 extern const guint purple_major_version;
f2aa47f387a6 Export purple_*_version in version.h.
Will Thompson <resiak@pidgin.im>
parents: 22030
diff changeset
81
f2aa47f387a6 Export purple_*_version in version.h.
Will Thompson <resiak@pidgin.im>
parents: 22030
diff changeset
82 /**
35397
31fa3a1aeff5 Move changes from soc.2013.gobjectification.gtkdoc to this branch
Ankit Vani <a@nevitus.org>
parents: 35393
diff changeset
83 * purple_minor_version:
31fa3a1aeff5 Move changes from soc.2013.gobjectification.gtkdoc to this branch
Ankit Vani <a@nevitus.org>
parents: 35393
diff changeset
84 *
22039
f2aa47f387a6 Export purple_*_version in version.h.
Will Thompson <resiak@pidgin.im>
parents: 22030
diff changeset
85 * The minor version of the running libpurple. Contrast with
f2aa47f387a6 Export purple_*_version in version.h.
Will Thompson <resiak@pidgin.im>
parents: 22030
diff changeset
86 * #PURPLE_MINOR_VERSION, which expands at compile time to the minor version of
f2aa47f387a6 Export purple_*_version in version.h.
Will Thompson <resiak@pidgin.im>
parents: 22030
diff changeset
87 * libpurple being compiled against.
f2aa47f387a6 Export purple_*_version in version.h.
Will Thompson <resiak@pidgin.im>
parents: 22030
diff changeset
88 */
f2aa47f387a6 Export purple_*_version in version.h.
Will Thompson <resiak@pidgin.im>
parents: 22030
diff changeset
89 extern const guint purple_minor_version;
f2aa47f387a6 Export purple_*_version in version.h.
Will Thompson <resiak@pidgin.im>
parents: 22030
diff changeset
90
f2aa47f387a6 Export purple_*_version in version.h.
Will Thompson <resiak@pidgin.im>
parents: 22030
diff changeset
91 /**
35397
31fa3a1aeff5 Move changes from soc.2013.gobjectification.gtkdoc to this branch
Ankit Vani <a@nevitus.org>
parents: 35393
diff changeset
92 * purple_micro_version:
22039
f2aa47f387a6 Export purple_*_version in version.h.
Will Thompson <resiak@pidgin.im>
parents: 22030
diff changeset
93 *
f2aa47f387a6 Export purple_*_version in version.h.
Will Thompson <resiak@pidgin.im>
parents: 22030
diff changeset
94 * The micro version of the running libpurple. Contrast with
f2aa47f387a6 Export purple_*_version in version.h.
Will Thompson <resiak@pidgin.im>
parents: 22030
diff changeset
95 * #PURPLE_MICRO_VERSION, which expands at compile time to the micro version of
f2aa47f387a6 Export purple_*_version in version.h.
Will Thompson <resiak@pidgin.im>
parents: 22030
diff changeset
96 * libpurple being compiled against.
f2aa47f387a6 Export purple_*_version in version.h.
Will Thompson <resiak@pidgin.im>
parents: 22030
diff changeset
97 */
f2aa47f387a6 Export purple_*_version in version.h.
Will Thompson <resiak@pidgin.im>
parents: 22030
diff changeset
98 extern const guint purple_micro_version;
f2aa47f387a6 Export purple_*_version in version.h.
Will Thompson <resiak@pidgin.im>
parents: 22030
diff changeset
99
39383
0f9d49617abc Use G_BEGIN_DECLS and G_END_DECLS instead of raw extern "C"
Mike Ruprecht <cmaiku@gmail.com>
parents: 37094
diff changeset
100 G_END_DECLS
9943
b54a762f60fa [gaim-migrate @ 10835]
Nathan Walp <nwalp@pidgin.im>
parents:
diff changeset
101
39659
e4dfb99b0cef Fix libpurple header guards using reserved names.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents: 39383
diff changeset
102 #endif /* PURPLE_VERSION_H */

mercurial