isa/mutter
1
0
Fork 0
mirror of https://github.com/brl/mutter.git synced 2024-11-24 09:00:42 -05:00
Code Issues Packages Projects Releases Wiki Activity
e4da08218a
mutter/clutter/clutter/clutter-macros.h

396 lines
14 KiB
C
Raw Normal View History

Move macros to their own headers
2012-02-27 09:03:57 -05:00
/*
* Clutter.
*
* An OpenGL based 'interactive canvas' library.
*
* Copyright (C) 2012 Intel Corporation
*
* 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, see <http://www.gnu.org/licenses/>.
*/
Move header inclusion guard at the top GCC has some optimization for the inclusion guard, but they only work if the check is the outermost one. We're fairly inconsistent because of historical reasons, so we should ensure that we follow the same pattern in every public header.
2015-07-07 10:51:13 -04:00
#ifndef __CLUTTER_MACROS_H__
#define __CLUTTER_MACROS_H__
Move macros to their own headers
2012-02-27 09:03:57 -05:00
#if !defined(__CLUTTER_H_INSIDE__) && !defined(CLUTTER_COMPILATION)
#error "Only <clutter/clutter.h> can be included directly."
#endif
Add flexible versioning scheme GLib introduced macros that allows defining the lower and upper bounds of the API to be used by application code. The lower bound allows to define the minimum version that will trigger deprecation warnings; the upper bound defines the maximum version that will trigger compiler warnings for unavailable symbols. This scheme allows gradually porting application code to a new version of the API, especially in case of resynchronization after multiple development cycles.
2012-02-27 09:59:00 -05:00
#include <clutter/clutter-version.h>
/**
* CLUTTER_FLAVOUR:
*
* GL Windowing system used
*
* Since: 0.4
*
* Deprecated: 1.10: The macro evaluates to "deprecated" as Clutter can be
* compiled with multiple windowing system backends. Use the various
* CLUTTER_WINDOWING_* macros to detect the windowing system that Clutter
* is being compiled against, and the type check macros for the
* #ClutterBackend for a run-time check.
*/
#define CLUTTER_FLAVOUR "deprecated"
/**
docs: Annotation fixes The introspection scanner has become slightly more annoying, in the hope that people start fixing their annotations. As it turns out, it was the right move.
2012-04-30 12:12:12 -04:00
* CLUTTER_COGL:
Add flexible versioning scheme GLib introduced macros that allows defining the lower and upper bounds of the API to be used by application code. The lower bound allows to define the minimum version that will trigger deprecation warnings; the upper bound defines the maximum version that will trigger compiler warnings for unavailable symbols. This scheme allows gradually porting application code to a new version of the API, especially in case of resynchronization after multiple development cycles.
2012-02-27 09:59:00 -05:00
*
* Cogl (internal GL abstraction utility library) backend. Can be "gl" or
* "gles" currently
*
* Since: 0.4
*
* Deprecated: 1.10: The macro evaluates to "deprecated" as Cogl can be
* compiled against multiple GL implementations.
*/
#define CLUTTER_COGL "deprecated"
/**
* CLUTTER_STAGE_TYPE:
*
* The default GObject type for the Clutter stage.
*
* Since: 0.8
*
* Deprecated: 1.10: The macro evaluates to "deprecated" as Clutter can
* be compiled against multiple windowing systems. You can use the
* CLUTTER_WINDOWING_* macros for compile-time checks, and the type
* check macros for run-time checks.
*/
#define CLUTTER_STAGE_TYPE "deprecated"
/**
* CLUTTER_NO_FPU:
*
* Set to 1 if Clutter was built without FPU (i.e fixed math), 0 otherwise
*
docs: Annotation fixes The introspection scanner has become slightly more annoying, in the hope that people start fixing their annotations. As it turns out, it was the right move.
2012-04-30 12:12:12 -04:00
* Deprecated: 0.6: This macro is no longer defined (identical code is used
Add flexible versioning scheme GLib introduced macros that allows defining the lower and upper bounds of the API to be used by application code. The lower bound allows to define the minimum version that will trigger deprecation warnings; the upper bound defines the maximum version that will trigger compiler warnings for unavailable symbols. This scheme allows gradually porting application code to a new version of the API, especially in case of resynchronization after multiple development cycles.
2012-02-27 09:59:00 -05:00
* regardless the presence of FPU).
*/
#define CLUTTER_NO_FPU (0)
/* some structures are meant to be opaque and still be allocated on the stack;
* in order to avoid people poking at their internals, we use this macro to
* ensure that users don't accidentally access a struct private members.
*
* we use the CLUTTER_COMPILATION define to allow us easier access, though.
*/
#ifdef CLUTTER_COMPILATION
#define CLUTTER_PRIVATE_FIELD(x) x
#else
#define CLUTTER_PRIVATE_FIELD(x) clutter_private_ ## x
#endif
Annotate all public symbols We are going to switch to compiler annotations to determine the visibility of the symbols.
2014-03-17 14:19:52 -04:00
#ifndef _CLUTTER_EXTERN
#define _CLUTTER_EXTERN extern
#endif
macros: Clang 3.4 and later versions can use deprecation macros for GCC https://bugzilla.gnome.org/show_bug.cgi?id=752272
2015-07-12 02:30:05 -04:00
#if __GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 6) || \
__clang_major__ > 3 || (__clang_major__ == 3 && __clang_minor__ >= 4)
Add macros for deprecating macros We want to be able to deprecate macros, but right now the best we can do is to wrap them with things like: #ifndef CLUTTER_DISABLE_DEPRECATED # define A_MACRO_I_WANT_TO_DEPRECATE ... #endif Which requires adding a new symbol to the build, and will cause a build error instead of a compiler/pre-processor warning. Fortunately, we can use the _Pragma() keyword introduced by C99 and supported by GCC to add a warning to the output, while leaving the macro itself intact. GCC does not have a "deprecated" pragma, so we have to use a generic warning; this also means we cannot do nifty things like concatenating strings and the like, as we do for the "deprecated" attribute. The macro deprecation symbol should have the same affordances as the function deprecation one, and evaluate to nothing if the required version is lower than the current version; or if the global toggle for deprecation warnings is in effect.
2015-07-11 05:03:57 -04:00
#define _CLUTTER_GNUC_DO_PRAGMA(x) _Pragma(G_STRINGIFY (x))
#define _CLUTTER_DEPRECATED_MACRO _CLUTTER_GNUC_DO_PRAGMA(GCC warning "Deprecated macro")
#define _CLUTTER_DEPRECATED_MACRO_FOR(f) _CLUTTER_GNUC_DO_PRAGMA(GCC warning #f)
macros: Add fallback defines for non-GCC compilers I forgot to add the fallback definitions in case we're not using GCC; without them, anybody using non-GCC compilers will get a build error. https://bugzilla.gnome.org/show_bug.cgi?id=752272
2015-07-11 18:58:12 -04:00
#else
#define _CLUTTER_DEPRECATED_MACRO
#define _CLUTTER_DEPRECATED_MACRO_FOR(f)
Add macros for deprecating macros We want to be able to deprecate macros, but right now the best we can do is to wrap them with things like: #ifndef CLUTTER_DISABLE_DEPRECATED # define A_MACRO_I_WANT_TO_DEPRECATE ... #endif Which requires adding a new symbol to the build, and will cause a build error instead of a compiler/pre-processor warning. Fortunately, we can use the _Pragma() keyword introduced by C99 and supported by GCC to add a warning to the output, while leaving the macro itself intact. GCC does not have a "deprecated" pragma, so we have to use a generic warning; this also means we cannot do nifty things like concatenating strings and the like, as we do for the "deprecated" attribute. The macro deprecation symbol should have the same affordances as the function deprecation one, and evaluate to nothing if the required version is lower than the current version; or if the global toggle for deprecation warnings is in effect.
2015-07-11 05:03:57 -04:00
#endif
Move macros to their own headers
2012-02-27 09:03:57 -05:00
/* these macros are used to mark deprecated functions, and thus have to be
* exposed in a public header.
*
* do *not* use them in other libraries depending on Clutter: use G_DEPRECATED
* and G_DEPRECATED_FOR, or use your own wrappers around them.
*/
#ifdef CLUTTER_DISABLE_DEPRECATION_WARNINGS
Annotate all public symbols We are going to switch to compiler annotations to determine the visibility of the symbols.
2014-03-17 14:19:52 -04:00
#define CLUTTER_DEPRECATED _CLUTTER_EXTERN
#define CLUTTER_DEPRECATED_FOR(f) _CLUTTER_EXTERN
#define CLUTTER_UNAVAILABLE(maj,min) _CLUTTER_EXTERN
Add macros for deprecating macros We want to be able to deprecate macros, but right now the best we can do is to wrap them with things like: #ifndef CLUTTER_DISABLE_DEPRECATED # define A_MACRO_I_WANT_TO_DEPRECATE ... #endif Which requires adding a new symbol to the build, and will cause a build error instead of a compiler/pre-processor warning. Fortunately, we can use the _Pragma() keyword introduced by C99 and supported by GCC to add a warning to the output, while leaving the macro itself intact. GCC does not have a "deprecated" pragma, so we have to use a generic warning; this also means we cannot do nifty things like concatenating strings and the like, as we do for the "deprecated" attribute. The macro deprecation symbol should have the same affordances as the function deprecation one, and evaluate to nothing if the required version is lower than the current version; or if the global toggle for deprecation warnings is in effect.
2015-07-11 05:03:57 -04:00
#define CLUTTER_DEPRECATED_MACRO
#define CLUTTER_DEPRECATED_MACRO_FOR(f)
Move macros to their own headers
2012-02-27 09:03:57 -05:00
#else
Annotate all public symbols We are going to switch to compiler annotations to determine the visibility of the symbols.
2014-03-17 14:19:52 -04:00
#define CLUTTER_DEPRECATED G_DEPRECATED _CLUTTER_EXTERN
#define CLUTTER_DEPRECATED_FOR(f) G_DEPRECATED_FOR(f) _CLUTTER_EXTERN
#define CLUTTER_UNAVAILABLE(maj,min) G_UNAVAILABLE(maj,min) _CLUTTER_EXTERN
Add macros for deprecating macros We want to be able to deprecate macros, but right now the best we can do is to wrap them with things like: #ifndef CLUTTER_DISABLE_DEPRECATED # define A_MACRO_I_WANT_TO_DEPRECATE ... #endif Which requires adding a new symbol to the build, and will cause a build error instead of a compiler/pre-processor warning. Fortunately, we can use the _Pragma() keyword introduced by C99 and supported by GCC to add a warning to the output, while leaving the macro itself intact. GCC does not have a "deprecated" pragma, so we have to use a generic warning; this also means we cannot do nifty things like concatenating strings and the like, as we do for the "deprecated" attribute. The macro deprecation symbol should have the same affordances as the function deprecation one, and evaluate to nothing if the required version is lower than the current version; or if the global toggle for deprecation warnings is in effect.
2015-07-11 05:03:57 -04:00
#define CLUTTER_DEPRECATED_MACRO _CLUTTER_DEPRECATED_MACRO
#define CLUTTER_DEPRECATED_MACRO_FOR(f) _CLUTTER_DEPRECATED_MACRO_FOR(f)
Move macros to their own headers
2012-02-27 09:03:57 -05:00
#endif
Annotate all public symbols We are going to switch to compiler annotations to determine the visibility of the symbols.
2014-03-17 14:19:52 -04:00
#define CLUTTER_AVAILABLE_IN_ALL _CLUTTER_EXTERN
Make mutter manage its own clutter backends Introduce two new clutter backends: MetaClutterBackendX11 and MetaClutterBackendNative. They are so far only wrap ClutterBackendX11 and ClutterBackendEglNative respectively, but the aim is to move things from the original clutter backends when needed. https://bugzilla.gnome.org/show_bug.cgi?id=768976
2016-05-04 04:19:23 -04:00
#define CLUTTER_AVAILABLE_IN_MUTTER _CLUTTER_EXTERN
Add flexible versioning scheme GLib introduced macros that allows defining the lower and upper bounds of the API to be used by application code. The lower bound allows to define the minimum version that will trigger deprecation warnings; the upper bound defines the maximum version that will trigger compiler warnings for unavailable symbols. This scheme allows gradually porting application code to a new version of the API, especially in case of resynchronization after multiple development cycles.
2012-02-27 09:59:00 -05:00
/**
* CLUTTER_VERSION_MIN_REQUIRED:
Move macros to their own headers
2012-02-27 09:03:57 -05:00
*
Add flexible versioning scheme GLib introduced macros that allows defining the lower and upper bounds of the API to be used by application code. The lower bound allows to define the minimum version that will trigger deprecation warnings; the upper bound defines the maximum version that will trigger compiler warnings for unavailable symbols. This scheme allows gradually porting application code to a new version of the API, especially in case of resynchronization after multiple development cycles.
2012-02-27 09:59:00 -05:00
* A macro that should be defined by the user prior to including the
* clutter.h header.
*
* The definition should be one of the predefined Clutter version macros,
* such as: %CLUTTER_VERSION_1_0, %CLUTTER_VERSION_1_2, ...
*
* This macro defines the lower bound for the Clutter API to be used.
*
* If a function has been deprecated in a newer version of Clutter, it
* is possible to use this symbol to avoid the compiler warnings without
* disabling warnings for every deprecated function.
*
* Since: 1.10
Move macros to their own headers
2012-02-27 09:03:57 -05:00
*/
Add flexible versioning scheme GLib introduced macros that allows defining the lower and upper bounds of the API to be used by application code. The lower bound allows to define the minimum version that will trigger deprecation warnings; the upper bound defines the maximum version that will trigger compiler warnings for unavailable symbols. This scheme allows gradually porting application code to a new version of the API, especially in case of resynchronization after multiple development cycles.
2012-02-27 09:59:00 -05:00
#ifndef CLUTTER_VERSION_MIN_REQUIRED
macros: Define MIN_REQUIRED as the current version Otherwise we'll not warn on deprecations introduced in the current development cycle.
2012-04-26 11:58:23 -04:00
# define CLUTTER_VERSION_MIN_REQUIRED (CLUTTER_VERSION_CUR_STABLE)
Add flexible versioning scheme GLib introduced macros that allows defining the lower and upper bounds of the API to be used by application code. The lower bound allows to define the minimum version that will trigger deprecation warnings; the upper bound defines the maximum version that will trigger compiler warnings for unavailable symbols. This scheme allows gradually porting application code to a new version of the API, especially in case of resynchronization after multiple development cycles.
2012-02-27 09:59:00 -05:00
#endif
/**
* CLUTTER_VERSION_MAX_ALLOWED:
*
* A macro that should be define by the user prior to including the
* clutter.h header.
*
* The definition should be one of the predefined Clutter version macros,
* such as: %CLUTTER_VERSION_1_0, %CLUTTER_VERSION_1_2, ...
*
* This macro defines the upper bound for the Clutter API to be used.
*
* If a function has been introduced in a newer version of Clutter, it
* is possible to use this symbol to get compiler warnings when trying
* to use that function.
*
* Since: 1.10
*/
#ifndef CLUTTER_VERSION_MAX_ALLOWED
# if CLUTTER_VERSION_MIN_REQUIRED > CLUTTER_VERSION_PREV_STABLE
# define CLUTTER_VERSION_MAX_ALLOWED CLUTTER_VERSION_MIN_REQUIRED
# else
# define CLUTTER_VERSION_MAX_ALLOWED CLUTTER_VERSION_CUR_STABLE
# endif
#endif
/* sanity checks */
#if CLUTTER_VERSION_MAX_ALLOWED < CLUTTER_VERSION_MIN_REQUIRED
# error "CLUTTER_VERSION_MAX_ALLOWED must be >= CLUTTER_VERSION_MIN_REQUIRED"
#endif
#if CLUTTER_VERSION_MIN_REQUIRED < CLUTTER_VERSION_1_0
# error "CLUTTER_VERSION_MIN_REQUIRED must be >= CLUTTER_VERSION_1_0"
#endif
/* XXX: Every new stable minor release should add a set of macros here */
#if CLUTTER_VERSION_MIN_REQUIRED >= CLUTTER_VERSION_1_0
# define CLUTTER_DEPRECATED_IN_1_0 CLUTTER_DEPRECATED
# define CLUTTER_DEPRECATED_IN_1_0_FOR(f) CLUTTER_DEPRECATED_FOR(f)
Move macros to their own headers
2012-02-27 09:03:57 -05:00
#else
Annotate all public symbols We are going to switch to compiler annotations to determine the visibility of the symbols.
2014-03-17 14:19:52 -04:00
# define CLUTTER_DEPRECATED_IN_1_0 _CLUTTER_EXTERN
# define CLUTTER_DEPRECATED_IN_1_0_FOR(f) _CLUTTER_EXTERN
Add flexible versioning scheme GLib introduced macros that allows defining the lower and upper bounds of the API to be used by application code. The lower bound allows to define the minimum version that will trigger deprecation warnings; the upper bound defines the maximum version that will trigger compiler warnings for unavailable symbols. This scheme allows gradually porting application code to a new version of the API, especially in case of resynchronization after multiple development cycles.
2012-02-27 09:59:00 -05:00
#endif
#if CLUTTER_VERSION_MAX_ALLOWED < CLUTTER_VERSION_1_0
# define CLUTTER_AVAILABLE_IN_1_0 CLUTTER_UNAVAILABLE(1, 0)
#else
Annotate all public symbols We are going to switch to compiler annotations to determine the visibility of the symbols.
2014-03-17 14:19:52 -04:00
# define CLUTTER_AVAILABLE_IN_1_0 _CLUTTER_EXTERN
Add flexible versioning scheme GLib introduced macros that allows defining the lower and upper bounds of the API to be used by application code. The lower bound allows to define the minimum version that will trigger deprecation warnings; the upper bound defines the maximum version that will trigger compiler warnings for unavailable symbols. This scheme allows gradually porting application code to a new version of the API, especially in case of resynchronization after multiple development cycles.
2012-02-27 09:59:00 -05:00
#endif
#if CLUTTER_VERSION_MIN_REQUIRED >= CLUTTER_VERSION_1_2
# define CLUTTER_DEPRECATED_IN_1_2 CLUTTER_DEPRECATED
# define CLUTTER_DEPRECATED_IN_1_2_FOR(f) CLUTTER_DEPRECATED_FOR(f)
#else
Annotate all public symbols We are going to switch to compiler annotations to determine the visibility of the symbols.
2014-03-17 14:19:52 -04:00
# define CLUTTER_DEPRECATED_IN_1_2 _CLUTTER_EXTERN
# define CLUTTER_DEPRECATED_IN_1_2_FOR(f) _CLUTTER_EXTERN
Add flexible versioning scheme GLib introduced macros that allows defining the lower and upper bounds of the API to be used by application code. The lower bound allows to define the minimum version that will trigger deprecation warnings; the upper bound defines the maximum version that will trigger compiler warnings for unavailable symbols. This scheme allows gradually porting application code to a new version of the API, especially in case of resynchronization after multiple development cycles.
2012-02-27 09:59:00 -05:00
#endif
#if CLUTTER_VERSION_MAX_ALLOWED < CLUTTER_VERSION_1_2
# define CLUTTER_AVAILABLE_IN_1_2 CLUTTER_UNAVAILABLE(1, 2)
#else
Annotate all public symbols We are going to switch to compiler annotations to determine the visibility of the symbols.
2014-03-17 14:19:52 -04:00
# define CLUTTER_AVAILABLE_IN_1_2 _CLUTTER_EXTERN
Add flexible versioning scheme GLib introduced macros that allows defining the lower and upper bounds of the API to be used by application code. The lower bound allows to define the minimum version that will trigger deprecation warnings; the upper bound defines the maximum version that will trigger compiler warnings for unavailable symbols. This scheme allows gradually porting application code to a new version of the API, especially in case of resynchronization after multiple development cycles.
2012-02-27 09:59:00 -05:00
#endif
#if CLUTTER_VERSION_MIN_REQUIRED >= CLUTTER_VERSION_1_4
# define CLUTTER_DEPRECATED_IN_1_4 CLUTTER_DEPRECATED
# define CLUTTER_DEPRECATED_IN_1_4_FOR(f) CLUTTER_DEPRECATED_FOR(f)
#else
Annotate all public symbols We are going to switch to compiler annotations to determine the visibility of the symbols.
2014-03-17 14:19:52 -04:00
# define CLUTTER_DEPRECATED_IN_1_4 _CLUTTER_EXTERN
# define CLUTTER_DEPRECATED_IN_1_4_FOR(f) _CLUTTER_EXTERN
Add flexible versioning scheme GLib introduced macros that allows defining the lower and upper bounds of the API to be used by application code. The lower bound allows to define the minimum version that will trigger deprecation warnings; the upper bound defines the maximum version that will trigger compiler warnings for unavailable symbols. This scheme allows gradually porting application code to a new version of the API, especially in case of resynchronization after multiple development cycles.
2012-02-27 09:59:00 -05:00
#endif
#if CLUTTER_VERSION_MAX_ALLOWED < CLUTTER_VERSION_1_4
# define CLUTTER_AVAILABLE_IN_1_4 CLUTTER_UNAVAILABLE(1, 4)
#else
Annotate all public symbols We are going to switch to compiler annotations to determine the visibility of the symbols.
2014-03-17 14:19:52 -04:00
# define CLUTTER_AVAILABLE_IN_1_4 _CLUTTER_EXTERN
Add flexible versioning scheme GLib introduced macros that allows defining the lower and upper bounds of the API to be used by application code. The lower bound allows to define the minimum version that will trigger deprecation warnings; the upper bound defines the maximum version that will trigger compiler warnings for unavailable symbols. This scheme allows gradually porting application code to a new version of the API, especially in case of resynchronization after multiple development cycles.
2012-02-27 09:59:00 -05:00
#endif
#if CLUTTER_VERSION_MIN_REQUIRED >= CLUTTER_VERSION_1_6
# define CLUTTER_DEPRECATED_IN_1_6 CLUTTER_DEPRECATED
# define CLUTTER_DEPRECATED_IN_1_6_FOR(f) CLUTTER_DEPRECATED_FOR(f)
#else
Annotate all public symbols We are going to switch to compiler annotations to determine the visibility of the symbols.
2014-03-17 14:19:52 -04:00
# define CLUTTER_DEPRECATED_IN_1_6 _CLUTTER_EXTERN
# define CLUTTER_DEPRECATED_IN_1_6_FOR(f) _CLUTTER_EXTERN
Add flexible versioning scheme GLib introduced macros that allows defining the lower and upper bounds of the API to be used by application code. The lower bound allows to define the minimum version that will trigger deprecation warnings; the upper bound defines the maximum version that will trigger compiler warnings for unavailable symbols. This scheme allows gradually porting application code to a new version of the API, especially in case of resynchronization after multiple development cycles.
2012-02-27 09:59:00 -05:00
#endif
#if CLUTTER_VERSION_MAX_ALLOWED < CLUTTER_VERSION_1_6
# define CLUTTER_AVAILABLE_IN_1_6 CLUTTER_UNAVAILABLE(1, 6)
#else
Annotate all public symbols We are going to switch to compiler annotations to determine the visibility of the symbols.
2014-03-17 14:19:52 -04:00
# define CLUTTER_AVAILABLE_IN_1_6 _CLUTTER_EXTERN
Move macros to their own headers
2012-02-27 09:03:57 -05:00
#endif
Add flexible versioning scheme GLib introduced macros that allows defining the lower and upper bounds of the API to be used by application code. The lower bound allows to define the minimum version that will trigger deprecation warnings; the upper bound defines the maximum version that will trigger compiler warnings for unavailable symbols. This scheme allows gradually porting application code to a new version of the API, especially in case of resynchronization after multiple development cycles.
2012-02-27 09:59:00 -05:00
#if CLUTTER_VERSION_MIN_REQUIRED >= CLUTTER_VERSION_1_8
# define CLUTTER_DEPRECATED_IN_1_8 CLUTTER_DEPRECATED
# define CLUTTER_DEPRECATED_IN_1_8_FOR(f) CLUTTER_DEPRECATED_FOR(f)
#else
Annotate all public symbols We are going to switch to compiler annotations to determine the visibility of the symbols.
2014-03-17 14:19:52 -04:00
# define CLUTTER_DEPRECATED_IN_1_8 _CLUTTER_EXTERN
# define CLUTTER_DEPRECATED_IN_1_8_FOR(f) _CLUTTER_EXTERN
Add flexible versioning scheme GLib introduced macros that allows defining the lower and upper bounds of the API to be used by application code. The lower bound allows to define the minimum version that will trigger deprecation warnings; the upper bound defines the maximum version that will trigger compiler warnings for unavailable symbols. This scheme allows gradually porting application code to a new version of the API, especially in case of resynchronization after multiple development cycles.
2012-02-27 09:59:00 -05:00
#endif
#if CLUTTER_VERSION_MAX_ALLOWED < CLUTTER_VERSION_1_8
# define CLUTTER_AVAILABLE_IN_1_8 CLUTTER_UNAVAILABLE(1, 8)
#else
Annotate all public symbols We are going to switch to compiler annotations to determine the visibility of the symbols.
2014-03-17 14:19:52 -04:00
# define CLUTTER_AVAILABLE_IN_1_8 _CLUTTER_EXTERN
Add flexible versioning scheme GLib introduced macros that allows defining the lower and upper bounds of the API to be used by application code. The lower bound allows to define the minimum version that will trigger deprecation warnings; the upper bound defines the maximum version that will trigger compiler warnings for unavailable symbols. This scheme allows gradually porting application code to a new version of the API, especially in case of resynchronization after multiple development cycles.
2012-02-27 09:59:00 -05:00
#endif
#if CLUTTER_VERSION_MIN_REQUIRED >= CLUTTER_VERSION_1_10
# define CLUTTER_DEPRECATED_IN_1_10 CLUTTER_DEPRECATED
# define CLUTTER_DEPRECATED_IN_1_10_FOR(f) CLUTTER_DEPRECATED_FOR(f)
#else
Annotate all public symbols We are going to switch to compiler annotations to determine the visibility of the symbols.
2014-03-17 14:19:52 -04:00
# define CLUTTER_DEPRECATED_IN_1_10 _CLUTTER_EXTERN
# define CLUTTER_DEPRECATED_IN_1_10_FOR(f) _CLUTTER_EXTERN
Add flexible versioning scheme GLib introduced macros that allows defining the lower and upper bounds of the API to be used by application code. The lower bound allows to define the minimum version that will trigger deprecation warnings; the upper bound defines the maximum version that will trigger compiler warnings for unavailable symbols. This scheme allows gradually porting application code to a new version of the API, especially in case of resynchronization after multiple development cycles.
2012-02-27 09:59:00 -05:00
#endif
#if CLUTTER_VERSION_MAX_ALLOWED < CLUTTER_VERSION_1_10
# define CLUTTER_AVAILABLE_IN_1_10 CLUTTER_UNAVAILABLE(1, 10)
#else
Annotate all public symbols We are going to switch to compiler annotations to determine the visibility of the symbols.
2014-03-17 14:19:52 -04:00
# define CLUTTER_AVAILABLE_IN_1_10 _CLUTTER_EXTERN
Add flexible versioning scheme GLib introduced macros that allows defining the lower and upper bounds of the API to be used by application code. The lower bound allows to define the minimum version that will trigger deprecation warnings; the upper bound defines the maximum version that will trigger compiler warnings for unavailable symbols. This scheme allows gradually porting application code to a new version of the API, especially in case of resynchronization after multiple development cycles.
2012-02-27 09:59:00 -05:00
#endif
Move macros to their own headers
2012-02-27 09:03:57 -05:00
version: Add 1.12 version macros
2012-03-22 06:11:11 -04:00
#if CLUTTER_VERSION_MIN_REQUIRED >= CLUTTER_VERSION_1_12
# define CLUTTER_DEPRECATED_IN_1_12 CLUTTER_DEPRECATED
# define CLUTTER_DEPRECATED_IN_1_12_FOR(f) CLUTTER_DEPRECATED_FOR(f)
#else
Annotate all public symbols We are going to switch to compiler annotations to determine the visibility of the symbols.
2014-03-17 14:19:52 -04:00
# define CLUTTER_DEPRECATED_IN_1_12 _CLUTTER_EXTERN
# define CLUTTER_DEPRECATED_IN_1_12_FOR(f) _CLUTTER_EXTERN
version: Add 1.12 version macros
2012-03-22 06:11:11 -04:00
#endif
Introduce regional stage rendering Add support for drawing a stage using multiple framebuffers each making up one part of the stage. This works by the stage backend (ClutterStageWindow) providing a list of views which will be for splitting up the stage in different regions. A view layout, for now, is a set of rectangles. The stage window (i.e. stage "backend" will use this information when drawing a frame, using one framebuffer for each view. The scene graph is adapted to explictly take a view when painting the stage. It will use this view, its assigned framebuffer and layout to offset and clip the drawing accordingly. This effectively removes any notion of "stage framebuffer", since each stage now may consist of multiple framebuffers. Therefore, API involving this has been deprecated and made no-ops; namely clutter_stage_ensure_context(). Callers are now assumed to either always use a framebuffer reference explicitly, or push/pop the framebuffer of a given view where the code has not yet changed to use the explicit-buffer-using cogl API. Currently only the nested X11 backend supports this mode fully, and the per view framebuffers are all offscreen. Upon frame completion, it'll blit each view's framebuffer onto the onscreen framebuffer before swapping. Other backends (X11 CM and native/KMS) are adapted to manage a full-stage view. The X11 CM backend will continue to use this method, while the native/KMS backend will be adopted to use multiple view drawing. https://bugzilla.gnome.org/show_bug.cgi?id=768976
2016-05-26 23:09:24 -04:00
#define CLUTTER_DEPRECATED_IN_MUTTER CLUTTER_DEPRECATED
version: Add 1.12 version macros
2012-03-22 06:11:11 -04:00
#if CLUTTER_VERSION_MAX_ALLOWED < CLUTTER_VERSION_1_12
# define CLUTTER_AVAILABLE_IN_1_12 CLUTTER_UNAVAILABLE(1, 12)
#else
Annotate all public symbols We are going to switch to compiler annotations to determine the visibility of the symbols.
2014-03-17 14:19:52 -04:00
# define CLUTTER_AVAILABLE_IN_1_12 _CLUTTER_EXTERN
version: Add 1.12 version macros
2012-03-22 06:11:11 -04:00
#endif
version: Add 1.14 version macros https://bugzilla.gnome.org/show_bug.cgi?id=685028
2012-09-28 04:20:31 -04:00
#if CLUTTER_VERSION_MIN_REQUIRED >= CLUTTER_VERSION_1_14
# define CLUTTER_DEPRECATED_IN_1_14 CLUTTER_DEPRECATED
# define CLUTTER_DEPRECATED_IN_1_14_FOR(f) CLUTTER_DEPRECATED_FOR(f)
#else
Annotate all public symbols We are going to switch to compiler annotations to determine the visibility of the symbols.
2014-03-17 14:19:52 -04:00
# define CLUTTER_DEPRECATED_IN_1_14 _CLUTTER_EXTERN
# define CLUTTER_DEPRECATED_IN_1_14_FOR(f) _CLUTTER_EXTERN
version: Add 1.14 version macros https://bugzilla.gnome.org/show_bug.cgi?id=685028
2012-09-28 04:20:31 -04:00
#endif
#if CLUTTER_VERSION_MAX_ALLOWED < CLUTTER_VERSION_1_14
# define CLUTTER_AVAILABLE_IN_1_14 CLUTTER_UNAVAILABLE(1, 14)
#else
Annotate all public symbols We are going to switch to compiler annotations to determine the visibility of the symbols.
2014-03-17 14:19:52 -04:00
# define CLUTTER_AVAILABLE_IN_1_14 _CLUTTER_EXTERN
version: Add 1.14 version macros https://bugzilla.gnome.org/show_bug.cgi?id=685028
2012-09-28 04:20:31 -04:00
#endif
Add version-related macros for 1.16
2013-03-20 16:23:02 -04:00
#if CLUTTER_VERSION_MIN_REQUIRED >= CLUTTER_VERSION_1_16
# define CLUTTER_DEPRECATED_IN_1_16 CLUTTER_DEPRECATED
# define CLUTTER_DEPRECATED_IN_1_16_FOR(f) CLUTTER_DEPRECATED_FOR(f)
#else
Annotate all public symbols We are going to switch to compiler annotations to determine the visibility of the symbols.
2014-03-17 14:19:52 -04:00
# define CLUTTER_DEPRECATED_IN_1_16 _CLUTTER_EXTERN
# define CLUTTER_DEPRECATED_IN_1_16_FOR(f) _CLUTTER_EXTERN
Add version-related macros for 1.16
2013-03-20 16:23:02 -04:00
#endif
#if CLUTTER_VERSION_MAX_ALLOWED < CLUTTER_VERSION_1_16
# define CLUTTER_AVAILABLE_IN_1_16 CLUTTER_UNAVAILABLE(1, 16)
#else
Annotate all public symbols We are going to switch to compiler annotations to determine the visibility of the symbols.
2014-03-17 14:19:52 -04:00
# define CLUTTER_AVAILABLE_IN_1_16 _CLUTTER_EXTERN
Add version-related macros for 1.16
2013-03-20 16:23:02 -04:00
#endif
Add 1.18 version macros We're still going to do a 1.x release cycle.
2013-10-10 08:31:28 -04:00
#if CLUTTER_VERSION_MIN_REQUIRED >= CLUTTER_VERSION_1_18
# define CLUTTER_DEPRECATED_IN_1_18 CLUTTER_DEPRECATED
# define CLUTTER_DEPRECATED_IN_1_18_FOR(f) CLUTTER_DEPRECATED_FOR(f)
#else
Annotate all public symbols We are going to switch to compiler annotations to determine the visibility of the symbols.
2014-03-17 14:19:52 -04:00
# define CLUTTER_DEPRECATED_IN_1_18 _CLUTTER_EXTERN
# define CLUTTER_DEPRECATED_IN_1_18_FOR(f) _CLUTTER_EXTERN
Add 1.18 version macros We're still going to do a 1.x release cycle.
2013-10-10 08:31:28 -04:00
#endif
#if CLUTTER_VERSION_MAX_ALLOWED < CLUTTER_VERSION_1_18
# define CLUTTER_AVAILABLE_IN_1_18 CLUTTER_UNAVAILABLE(1, 18)
#else
Annotate all public symbols We are going to switch to compiler annotations to determine the visibility of the symbols.
2014-03-17 14:19:52 -04:00
# define CLUTTER_AVAILABLE_IN_1_18 _CLUTTER_EXTERN
Add 1.18 version macros We're still going to do a 1.x release cycle.
2013-10-10 08:31:28 -04:00
#endif
Provide 1.20 version macros
2014-05-19 12:55:52 -04:00
#if CLUTTER_VERSION_MIN_REQUIRED >= CLUTTER_VERSION_1_20
# define CLUTTER_DEPRECATED_IN_1_20 CLUTTER_DEPRECATED
# define CLUTTER_DEPRECATED_IN_1_20_FOR(f) CLUTTER_DEPRECATED_FOR(f)
#else
# define CLUTTER_DEPRECATED_IN_1_20 _CLUTTER_EXTERN
# define CLUTTER_DEPRECATED_IN_1_20_FOR(f) _CLUTTER_EXTERN
#endif
#if CLUTTER_VERSION_MAX_ALLOWED < CLUTTER_VERSION_1_20
# define CLUTTER_AVAILABLE_IN_1_20 CLUTTER_UNAVAILABLE(1, 20)
#else
# define CLUTTER_AVAILABLE_IN_1_20 _CLUTTER_EXTERN
#endif
Add 1.22 version macros The 1.22 cycle did start a while ago.
2014-12-11 17:32:36 -05:00
#if CLUTTER_VERSION_MIN_REQUIRED >= CLUTTER_VERSION_1_22
# define CLUTTER_DEPRECATED_IN_1_22 CLUTTER_DEPRECATED
# define CLUTTER_DEPRECATED_IN_1_22_FOR(f) CLUTTER_DEPRECATED_FOR(f)
#else
# define CLUTTER_DEPRECATED_IN_1_22 _CLUTTER_EXTERN
# define CLUTTER_DEPRECATED_IN_1_22_FOR(f) _CLUTTER_EXTERN
#endif
#if CLUTTER_VERSION_MAX_ALLOWED < CLUTTER_VERSION_1_22
# define CLUTTER_AVAILABLE_IN_1_22 CLUTTER_UNAVAILABLE(1, 22)
#else
# define CLUTTER_AVAILABLE_IN_1_22 _CLUTTER_EXTERN
#endif
Add version macros for 1.24
2015-04-14 07:29:58 -04:00
#if CLUTTER_VERSION_MIN_REQUIRED >= CLUTTER_VERSION_1_24
# define CLUTTER_DEPRECATED_IN_1_24 CLUTTER_DEPRECATED
# define CLUTTER_DEPRECATED_IN_1_24_FOR(f) CLUTTER_DEPRECATED_FOR(f)
Add macros for deprecating macros We want to be able to deprecate macros, but right now the best we can do is to wrap them with things like: #ifndef CLUTTER_DISABLE_DEPRECATED # define A_MACRO_I_WANT_TO_DEPRECATE ... #endif Which requires adding a new symbol to the build, and will cause a build error instead of a compiler/pre-processor warning. Fortunately, we can use the _Pragma() keyword introduced by C99 and supported by GCC to add a warning to the output, while leaving the macro itself intact. GCC does not have a "deprecated" pragma, so we have to use a generic warning; this also means we cannot do nifty things like concatenating strings and the like, as we do for the "deprecated" attribute. The macro deprecation symbol should have the same affordances as the function deprecation one, and evaluate to nothing if the required version is lower than the current version; or if the global toggle for deprecation warnings is in effect.
2015-07-11 05:03:57 -04:00
# define CLUTTER_MACRO_DEPRECATED_IN_1_24 CLUTTER_DEPRECATED_MACRO
# define CLUTTER_MACRO_DEPRECATED_IN_1_24_FOR(f) CLUTTER_DEPRECATED_MACRO_FOR(f)
Add version macros for 1.24
2015-04-14 07:29:58 -04:00
#else
# define CLUTTER_DEPRECATED_IN_1_24 _CLUTTER_EXTERN
# define CLUTTER_DEPRECATED_IN_1_24_FOR(f) _CLUTTER_EXTERN
Add macros for deprecating macros We want to be able to deprecate macros, but right now the best we can do is to wrap them with things like: #ifndef CLUTTER_DISABLE_DEPRECATED # define A_MACRO_I_WANT_TO_DEPRECATE ... #endif Which requires adding a new symbol to the build, and will cause a build error instead of a compiler/pre-processor warning. Fortunately, we can use the _Pragma() keyword introduced by C99 and supported by GCC to add a warning to the output, while leaving the macro itself intact. GCC does not have a "deprecated" pragma, so we have to use a generic warning; this also means we cannot do nifty things like concatenating strings and the like, as we do for the "deprecated" attribute. The macro deprecation symbol should have the same affordances as the function deprecation one, and evaluate to nothing if the required version is lower than the current version; or if the global toggle for deprecation warnings is in effect.
2015-07-11 05:03:57 -04:00
# define CLUTTER_MACRO_DEPRECATED_IN_1_24
# define CLUTTER_MACRO_DEPRECATED_IN_1_24_FOR(f)
Add version macros for 1.24
2015-04-14 07:29:58 -04:00
#endif
#if CLUTTER_VERSION_MAX_ALLOWED < CLUTTER_VERSION_1_24
# define CLUTTER_AVAILABLE_IN_1_24 CLUTTER_UNAVAILABLE(1, 24)
#else
# define CLUTTER_AVAILABLE_IN_1_24 _CLUTTER_EXTERN
#endif
Add version macros for Clutter 1.26
2015-11-18 06:52:53 -05:00
#if CLUTTER_VERSION_MIN_REQUIRED >= CLUTTER_VERSION_1_26
# define CLUTTER_DEPRECATED_IN_1_26 CLUTTER_DEPRECATED
# define CLUTTER_DEPRECATED_IN_1_26_FOR(f) CLUTTER_DEPRECATED_FOR(f)
# define CLUTTER_MACRO_DEPRECATED_IN_1_26 CLUTTER_DEPRECATED_MACRO
# define CLUTTER_MACRO_DEPRECATED_IN_1_26_FOR(f) CLUTTER_DEPRECATED_MACRO_FOR(f)
#else
# define CLUTTER_DEPRECATED_IN_1_26 _CLUTTER_EXTERN
# define CLUTTER_DEPRECATED_IN_1_26_FOR(f) _CLUTTER_EXTERN
# define CLUTTER_MACRO_DEPRECATED_IN_1_26
# define CLUTTER_MACRO_DEPRECATED_IN_1_26_FOR(f)
#endif
#if CLUTTER_VERSION_MAX_ALLOWED < CLUTTER_VERSION_1_26
# define CLUTTER_AVAILABLE_IN_1_26 CLUTTER_UNAVAILABLE(1, 26)
#else
# define CLUTTER_AVAILABLE_IN_1_26 _CLUTTER_EXTERN
#endif
Move macros to their own headers
2012-02-27 09:03:57 -05:00
#endif /* __CLUTTER_MACROS_H__ */
Reference in New Issue Copy Permalink