GNOME.org
 

[gtk+] Add versioned deprecation macros

commit e580c79ae05a10fb33313b9ae36d95905cfc7b89
Author: Matthias Clasen <mclasen redhat com>
Date:   Mon Feb 27 07:04:30 2012 -0500

    Add versioned deprecation macros
    
    These macros follow the recent changes in GLibs deprecation
    setup. We now annotate deprecated functions with the version
    they were deprecated in, and you can define the macro
    GDK_VERSION_MIN_REQUIRED to cut off deprecation warnings for
    'recent' deprecations.
    
    At the same time, we introduce version annotations for new API
    and allow you to avoid 'recent' API additions by defining
    GDK_VERSION_MAX_ALLOWED.

 configure.ac              |   15 +----
 gdk/Makefile.am           |    4 +-
 gdk/gdk.h                 |    1 +
 gdk/gdkversionmacros.h.in |  188 +++++++++++++++++++++++++++++++++++++++++++++
 4 files changed, 193 insertions(+), 15 deletions(-)
---
diff --git a/configure.ac b/configure.ac
index 6f6769f..a74cb82 100644
--- a/configure.ac
+++ b/configure.ac
@@ -1672,20 +1672,6 @@ AC_CONFIG_COMMANDS([gdk/gdkconfig.h], [
 
 G_BEGIN_DECLS
 
-/* These macros are used to mark deprecated functions in GDK and
- * GTK+ headers, and thus have to be exposed in installed headers.
- * But please do *not* use them in other projects. Instead, use
- * G_DEPRECATED or define your own wrappers around it.
- */
-
-#ifdef GDK_DISABLE_DEPRECATION_WARNINGS
-#define GDK_DEPRECATED
-#define GDK_DEPRECATED_FOR(f)
-#else
-#define GDK_DEPRECATED G_DEPRECATED
-#define GDK_DEPRECATED_FOR(f) G_DEPRECATED_FOR(f)
-#endif
-
 _______EOF
 
 	cat >>$outfile <<_______EOF
@@ -1778,6 +1764,7 @@ gdk/win32/rc/gdk.rc
 gdk/quartz/Makefile
 gdk/wayland/Makefile
 gdk/tests/Makefile
+gdk/gdkversionmacros.h
 gtk/Makefile
 gtk/makefile.msc
 gtk/gtkversion.h
diff --git a/gdk/Makefile.am b/gdk/Makefile.am
index 0c38d9a..2557bda 100644
--- a/gdk/Makefile.am
+++ b/gdk/Makefile.am
@@ -30,6 +30,7 @@ EXTRA_DIST += 			\
 	gdk.symbols		\
 	gdkenumtypes.c.template	\
 	gdkenumtypes.h.template	\
+	gdkversionmacros.h.in	\
 	abicheck.sh
 
 AM_CPPFLAGS = 				\
@@ -89,6 +90,7 @@ gdk_public_h_sources = 				\
 	gdktestutils.h				\
 	gdkthreads.h				\
 	gdktypes.h				\
+	gdkversionmacros.h			\
 	gdkvisual.h				\
 	gdkwindow.h
 
@@ -145,7 +147,7 @@ gdk_built_sources = 				\
 #
 
 gdkincludedir = $(includedir)/gtk-3.0/gdk
-gdkinclude_HEADERS = $(gdk_public_h_sources) gdkenumtypes.h
+gdkinclude_HEADERS = $(gdk_public_h_sources) gdkenumtypes.h gdkversionmacros.h
 nodist_gdkinclude_HEADERS = gdkconfig.h
 
 common_sources = 		\
diff --git a/gdk/gdk.h b/gdk/gdk.h
index 2b84969..e651fd0 100644
--- a/gdk/gdk.h
+++ b/gdk/gdk.h
@@ -30,6 +30,7 @@
 #define __GDK_H_INSIDE__
 
 #include <gdk/gdkconfig.h>
+#include <gdk/gdkversionmacros.h>
 #include <gdk/gdkapplaunchcontext.h>
 #include <gdk/gdkcairo.h>
 #include <gdk/gdkcolor.h>
diff --git a/gdk/gdkversionmacros.h.in b/gdk/gdkversionmacros.h.in
new file mode 100644
index 0000000..1871455
--- /dev/null
+++ b/gdk/gdkversionmacros.h.in
@@ -0,0 +1,188 @@
+/* gdkversionmacros.h - version boundaries checks
+ * Copyright (C) 2012 Red Hat, Inc.
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser 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
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the
+ * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
+ * Boston, MA 02111-1307, USA.
+ */
+
+#if !defined (__GDK_H_INSIDE__) && !defined (GDK_COMPILATION)
+#error "Only <gdk/gdk.h> can be included directly."
+#endif
+
+#ifndef __GDK_VERSION_MACROS_H__
+#define __GDK_VERSION_MACROS_H__
+
+#include <glib.h>
+
+#define GDK_MAJOR_VERSION (@GTK_MAJOR_VERSION@)
+#define GDK_MINOR_VERSION (@GTK_MINOR_VERSION@)
+#define GDK_MICRO_VERSION (@GTK_MICRO_VERSION@)
+
+#ifdef GDK_DISABLE_DEPRECATION_WARNINGS
+#define GDK_DEPRECATED
+#define GDK_DEPRECATED_FOR(f)
+#define GDK_UNAVAILABLE(maj,min)
+#else
+#define GDK_DEPRECATED G_DEPRECATED
+#define GDK_DEPRECATED_FOR(f) G_DEPRECATED_FOR(f)
+#define GDK_UNAVAILABLE(maj,min) G_UNAVAILABLE(maj,min)
+#endif
+
+/* XXX: Every new stable minor release bump should add a macro here */
+
+/**
+ * GDK_VERSION_3_0:
+ *
+ * A macro that evaluates to the 3.0 version of GDK, in a format
+ * that can be used by the C pre-processor.
+ *
+ * Since: 3.4
+ */
+#define GDK_VERSION_3_0         (G_ENCODE_VERSION (3, 0))
+
+/**
+ * GDK_VERSION_3_2:
+ *
+ * A macro that evaluates to the 3.2 version of GDK, in a format
+ * that can be used by the C pre-processor.
+ *
+ * Since: 3.4
+ */
+#define GDK_VERSION_3_2         (G_ENCODE_VERSION (3, 2))
+
+/**
+ * GDK_VERSION_3_4:
+ *
+ * A macro that evaluates to the 3.4 version of GDK, in a format
+ * that can be used by the C pre-processor.
+ *
+ * Since: 3.4
+ */
+#define GDK_VERSION_3_4         (G_ENCODE_VERSION (3, 4))
+
+
+/* evaluates to the current stable version; for development cycles,
+ * this means the next stable target
+ */
+#if (GDK_MINOR_VERSION % 2)
+#define GDK_VERSION_CUR_STABLE         (G_ENCODE_VERSION (GDK_MAJOR_VERSION, GDK_MINOR_VERSION + 1))
+#else
+#define GDK_VERSION_CUR_STABLE         (G_ENCODE_VERSION (GDK_MAJOR_VERSION, GDK_MINOR_VERSION))
+#endif
+
+/* evaluates to the previous stable version */
+#if (GDK_MINOR_VERSION % 2)
+#define GDK_VERSION_PREV_STABLE        (G_ENCODE_VERSION (GDK_MAJOR_VERSION, GDK_MINOR_VERSION - 1))
+#else
+#define GDK_VERSION_PREV_STABLE        (G_ENCODE_VERSION (GDK_MAJOR_VERSION, GDK_MINOR_VERSION - 2))
+#endif
+
+/**
+ * GDK_VERSION_MIN_REQUIRED:
+ *
+ * A macro that should be defined by the user prior to including
+ * the gdk.h header.
+ * The definition should be one of the predefined GDK version
+ * macros: %GDK_VERSION_3_0, %GDK_VERSION_3_2,...
+ *
+ * This macro defines the lower bound for the GLib API to use.
+ *
+ * If a function has been deprecated in a newer version of GDK,
+ * it is possible to use this symbol to avoid the compiler warnings
+ * without disabling warning for every deprecated function.
+ *
+ * Since: 3.4
+ */
+#ifndef GDK_VERSION_MIN_REQUIRED
+# define GDK_VERSION_MIN_REQUIRED      (GDK_VERSION_PREV_STABLE)
+#endif
+
+/**
+ * GDK_VERSION_MAX_ALLOWED:
+ *
+ * A macro that should be defined by the user prior to including
+ * the gdk.h header.
+ * The definition should be one of the predefined GDK version
+ * macros: %GDK_VERSION_3_0, %GDK_VERSION_3_2,...
+ *
+ * This macro defines the upper bound for the GDK API to use.
+ *
+ * If a function has been introduced in a newer version of GDK,
+ * it is possible to use this symbol to get compiler warnings when
+ * trying to use that function.
+ *
+ * Since: 3.4
+ */
+#ifndef GDK_VERSION_MAX_ALLOWED
+# if GDK_VERSION_MIN_REQUIRED > GDK_VERSION_PREV_STABLE
+#  define GDK_VERSION_MAX_ALLOWED      GDK_VERSION_MIN_REQUIRED
+# else
+#  define GDK_VERSION_MAX_ALLOWED      GDK_VERSION_CUR_STABLE
+# endif
+#endif
+
+/* sanity checks */
+#if GDK_VERSION_MAX_ALLOWED < GDK_VERSION_MIN_REQUIRED
+#error "GDK_VERSION_MAX_ALLOWED must be >= GDK_VERSION_MIN_REQUIRED"
+#endif
+#if GDK_VERSION_MIN_REQUIRED < GDK_VERSION_3_0
+#error "GDK_VERSION_MIN_REQUIRED must be >= GDK_VERSION_3_0"
+#endif
+
+/* XXX: Every new stable minor release should add a set of macros here */
+
+#if GDK_VERSION_MIN_REQUIRED >= GDK_VERSION_3_0
+# define GDK_DEPRECATED_IN_3_0                GDK_DEPRECATED
+# define GDK_DEPRECATED_IN_3_0_FOR(f)         GDK_DEPRECATED_FOR(f)
+#else
+# define GDK_DEPRECATED_IN_3_0
+# define GDK_DEPRECATED_IN_3_0_FOR(f)
+#endif
+
+#if GDK_VERSION_MAX_ALLOWED < GDK_VERSION_3_0
+# define GDK_AVAILABLE_IN_3_0                 GDK_UNAVAILABLE(3, 0)
+#else
+# define GDK_AVAILABLE_IN_3_0
+#endif
+
+#if GDK_VERSION_MIN_REQUIRED >= GDK_VERSION_3_2
+# define GDK_DEPRECATED_IN_3_2                GDK_DEPRECATED
+# define GDK_DEPRECATED_IN_3_2_FOR(f)         GDK_DEPRECATED_FOR(f)
+#else
+# define GDK_DEPRECATED_IN_3_2
+# define GDK_DEPRECATED_IN_3_2_FOR(f)
+#endif
+
+#if GDK_VERSION_MAX_ALLOWED < GDK_VERSION_3_2
+# define GDK_AVAILABLE_IN_3_2                 GDK_UNAVAILABLE(3, 2)
+#else
+# define GDK_AVAILABLE_IN_3_2
+#endif
+
+#if GDK_VERSION_MIN_REQUIRED >= GDK_VERSION_3_4
+# define GDK_DEPRECATED_IN_3_4                GDK_DEPRECATED
+# define GDK_DEPRECATED_IN_3_4_FOR(f)         GDK_DEPRECATED_FOR(f)
+#else
+# define GDK_DEPRECATED_IN_3_4
+# define GDK_DEPRECATED_IN_3_4_FOR(f)
+#endif
+
+#if GDK_VERSION_MAX_ALLOWED < GDK_VERSION_3_4
+# define GDK_AVAILABLE_IN_3_4                 GDK_UNAVAILABLE(3, 4)
+#else
+# define GDK_AVAILABLE_IN_3_4
+#endif
+
+#endif  /* __GDK_VERSION_MACROS_H__ */
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]