mutter/clutter/clutter-version.h.in
Emmanuele Bassi 21a24c862e Allow checking the backend type at run-time
Portable code should be allowed to check type backend currently being
used, so that it can use platform-specific API (not just Clutter's).

We don't want to go down the GDK route, with public types for
ClutterBackend and ClutterStageWindow implementations, and use the type
system, e.g.:

  #ifdef GDK_WINDOWING_X11
    if (GDK_IS_WINDOW_X11 (window))
      use_x11_api (window);
    else
  #endif
  #ifdef GDK_WINDOWING_WIN32
    if (GDK_IS_WINDOW_WIN32 (window))
      use_win32_api (window);
    else
  #endif
    g_critical ("Unsupported backend");

This system would make us expose the backend system, and we want to
still reserve us the option to change the backend system to increase its
granularity — e.g. choosing different input event systems regardless of
the windowing system.

This commit adds a simple function that checks the backend type against
a symbolic constant — the same constant string that can be used to
select the backend at run-time through the CLUTTER_BACKEND environment
variable.
2011-11-03 13:45:19 +00:00

203 lines
5.3 KiB
C

/*
* Clutter.
*
* An OpenGL based 'interactive canvas' library.
*
* Authored By Matthew Allum <mallum@openedhand.com>
*
* Copyright (C) 2006 OpenedHand
*
* 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/>.
*
*
*/
/**
* SECTION:clutter-version
* @short_description: Versioning utility macros
*
* Clutter offers a set of macros for checking the version of the library
* an application was linked to.
*/
#ifndef __CLUTTER_VERSION_H__
#define __CLUTTER_VERSION_H__
#include <glib.h>
G_BEGIN_DECLS
/**
* CLUTTER_MAJOR_VERSION:
*
* The major version of the Clutter library (1, if %CLUTTER_VERSION is 1.2.3)
*/
#define CLUTTER_MAJOR_VERSION (@CLUTTER_MAJOR_VERSION@)
/**
* CLUTTER_MINOR_VERSION:
*
* The minor version of the Clutter library (2, if %CLUTTER_VERSION is 1.2.3)
*/
#define CLUTTER_MINOR_VERSION (@CLUTTER_MINOR_VERSION@)
/**
* CLUTTER_MICRO_VERSION:
*
* The micro version of the Clutter library (3, if %CLUTTER_VERSION is 1.2.3)
*/
#define CLUTTER_MICRO_VERSION (@CLUTTER_MICRO_VERSION@)
/**
* CLUTTER_VERSION:
*
* The full version of the Clutter library, like 1.2.3
*/
#define CLUTTER_VERSION @CLUTTER_VERSION@
/**
* CLUTTER_VERSION_S:
*
* The full version of the Clutter library, in string form (suited for
* string concatenation)
*/
#define CLUTTER_VERSION_S "@CLUTTER_VERSION@"
/**
* CLUTTER_VERSION_HEX:
*
* Numerically encoded version of the Clutter library, like 0x010203
*/
#define CLUTTER_VERSION_HEX ((CLUTTER_MAJOR_VERSION << 24) | \
(CLUTTER_MINOR_VERSION << 16) | \
(CLUTTER_MICRO_VERSION << 8))
/**
* CLUTTER_CHECK_VERSION:
* @major: major version, like 1 in 1.2.3
* @minor: minor version, like 2 in 1.2.3
* @micro: micro version, like 3 in 1.2.3
*
* Evaluates to %TRUE if the version of the Clutter library is greater
* than @major, @minor and @micro
*/
#define CLUTTER_CHECK_VERSION(major,minor,micro) \
(CLUTTER_MAJOR_VERSION > (major) || \
(CLUTTER_MAJOR_VERSION == (major) && CLUTTER_MINOR_VERSION > (minor)) || \
(CLUTTER_MAJOR_VERSION == (major) && CLUTTER_MINOR_VERSION == (minor) && CLUTTER_MICRO_VERSION >= (micro)))
/**
* 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 "@CLUTTER_FLAVOUR@"
/**
* CLUTTER_COGL
*
* 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 "@CLUTTER_COGL@"
/**
* 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 @CLUTTER_STAGE_TYPE@
/**
* CLUTTER_NO_FPU:
*
* Set to 1 if Clutter was built without FPU (i.e fixed math), 0 otherwise
*
* @Deprecated: 0.6: This macro is no longer defined (identical code is used
* regardless the presence of FPU).
*/
#define CLUTTER_NO_FPU CLUTTER_NO_FPU_MACRO_WAS_REMOVED
/**
* clutter_major_version:
*
* The major component of the Clutter library version, e.g. 1 if the version
* is 1.2.3
*
* This value can be used for run-time version checks
*
* For a compile-time check, use %CLUTTER_MAJOR_VERSION
*
* Since: 1.2
*/
extern const guint clutter_major_version;
/**
* clutter_minor_version:
*
* The minor component of the Clutter library version, e.g. 2 if the version
* is 1.2.3
*
* This value can be used for run-time version checks
*
* For a compile-time check, use %CLUTTER_MINOR_VERSION
*
* Since: 1.2
*/
extern const guint clutter_minor_version;
/**
* clutter_micro_version:
*
* The micro component of the Clutter library version, e.g. 3 if the version
* is 1.2.3
*
* This value can be used for run-time version checks
*
* For a compile-time check, use %CLUTTER_MICRO_VERSION
*
* Since: 1.2
*/
extern const guint clutter_micro_version;
gboolean clutter_check_version (guint major,
guint minor,
guint micro);
gboolean clutter_check_backend (const char *backend_type);
G_END_DECLS
#endif /* __CLUTTER_VERSION_H__ */