Commit 178c3338 authored by Christian Hergert's avatar Christian Hergert

build: add versioning helper macros

We can use this going forward to specify ABI in the headers, although that
is still a very large task ahead of us to do that specification.
parent 62c30a75
/* ide-version-macros.h
*
* Copyright (C) 2017 Christian Hergert <chergert@redhat.com>
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef IDE_VERSION_MACROS_H
#define IDE_VERSION_MACROS_H
#if !defined(IDE_INSIDE) && !defined(IDE_COMPILATION)
# error "Only <ide.h> can be included directly."
#endif
#include "ide-version.h"
#ifndef _IDE_EXTERN
#define _IDE_EXTERN extern
#endif
#ifdef IDE_DISABLE_DEPRECATION_WARNINGS
#define IDE_DEPRECATED _IDE_EXTERN
#define IDE_DEPRECATED_FOR(f) _IDE_EXTERN
#define IDE_UNAVAILABLE(maj,min) _IDE_EXTERN
#else
#define IDE_DEPRECATED G_DEPRECATED _IDE_EXTERN
#define IDE_DEPRECATED_FOR(f) G_DEPRECATED_FOR(f) _IDE_EXTERN
#define IDE_UNAVAILABLE(maj,min) G_UNAVAILABLE(maj,min) _IDE_EXTERN
#endif
#define IDE_VERSION_3_26 (G_ENCODE_VERSION (3, 26))
#define IDE_VERSION_3_28 (G_ENCODE_VERSION (3, 28))
#if (IDE_MINOR_VERSION == 99)
# define IDE_VERSION_CUR_STABLE (G_ENCODE_VERSION (IDE_MAJOR_VERSION + 1, 0))
#elif (IDE_MINOR_VERSION % 2)
# define IDE_VERSION_CUR_STABLE (G_ENCODE_VERSION (IDE_MAJOR_VERSION, IDE_MINOR_VERSION + 1))
#else
# define IDE_VERSION_CUR_STABLE (G_ENCODE_VERSION (IDE_MAJOR_VERSION, IDE_MINOR_VERSION))
#endif
#if (IDE_MINOR_VERSION == 99)
# define IDE_VERSION_PREV_STABLE (G_ENCODE_VERSION (IDE_MAJOR_VERSION + 1, 0))
#elif (IDE_MINOR_VERSION % 2)
# define IDE_VERSION_PREV_STABLE (G_ENCODE_VERSION (IDE_MAJOR_VERSION, IDE_MINOR_VERSION - 1))
#else
# define IDE_VERSION_PREV_STABLE (G_ENCODE_VERSION (IDE_MAJOR_VERSION, IDE_MINOR_VERSION - 2))
#endif
/**
* IDE_VERSION_MIN_REQUIRED:
*
* A macro that should be defined by the user prior to including
* the ide.h header.
*
* The definition should be one of the predefined IDE version
* macros: %IDE_VERSION_3_26, IDE_VERSION_3_28, ...
*
* This macro defines the lower bound for the Builder API to use.
*
* If a function has been deprecated in a newer version of Builder,
* it is possible to use this symbol to avoid the compiler warnings
* without disabling warning for every deprecated function.
*
* Since: 3.28
*/
#ifndef IDE_VERSION_MIN_REQUIRED
# define IDE_VERSION_MIN_REQUIRED (IDE_VERSION_CUR_STABLE)
#endif
/**
* IDE_VERSION_MAX_ALLOWED:
*
* A macro that should be defined by the user prior to including
* the ide.h header.
* The definition should be one of the predefined Builder version
* macros: %IDE_VERSION_1_0, %IDE_VERSION_1_2,...
*
* This macro defines the upper bound for the IDE API to use.
*
* If a function has been introduced in a newer version of Builder,
* it is possible to use this symbol to get compiler warnings when
* trying to use that function.
*
* Since: 3.28
*/
#ifndef IDE_VERSION_MAX_ALLOWED
# if IDE_VERSION_MIN_REQUIRED > IDE_VERSION_PREV_STABLE
# define IDE_VERSION_MAX_ALLOWED (IDE_VERSION_MIN_REQUIRED)
# else
# define IDE_VERSION_MAX_ALLOWED (IDE_VERSION_CUR_STABLE)
# endif
#endif
#if IDE_VERSION_MAX_ALLOWED < IDE_VERSION_MIN_REQUIRED
#error "IDE_VERSION_MAX_ALLOWED must be >= IDE_VERSION_MIN_REQUIRED"
#endif
#if IDE_VERSION_MIN_REQUIRED < IDE_VERSION_3_26
#error "IDE_VERSION_MIN_REQUIRED must be >= IDE_VERSION_3_26"
#endif
#if IDE_VERSION_MIN_REQUIRED >= IDE_VERSION_3_26
# define IDE_DEPRECATED_IN_3_26 IDE_DEPRECATED
# define IDE_DEPRECATED_IN_3_26_FOR(f) IDE_DEPRECATED_FOR(f)
#else
# define IDE_DEPRECATED_IN_3_26 _IDE_EXTERN
# define IDE_DEPRECATED_IN_3_26_FOR(f) _IDE_EXTERN
#endif
#if IDE_VERSION_MAX_ALLOWED < IDE_VERSION_3_26
# define IDE_AVAILABLE_IN_3_26 IDE_UNAVAILABLE(3, 26)
#else
# define IDE_AVAILABLE_IN_3_26 _IDE_EXTERN
#endif
#if IDE_VERSION_MIN_REQUIRED >= IDE_VERSION_3_28
# define IDE_DEPRECATED_IN_3_28 IDE_DEPRECATED
# define IDE_DEPRECATED_IN_3_28_FOR(f) IDE_DEPRECATED_FOR(f)
#else
# define IDE_DEPRECATED_IN_3_28 _IDE_EXTERN
# define IDE_DEPRECATED_IN_3_28_FOR(f) _IDE_EXTERN
#endif
#if IDE_VERSION_MAX_ALLOWED < IDE_VERSION_3_28
# define IDE_AVAILABLE_IN_3_28 IDE_UNAVAILABLE(3, 28)
#else
# define IDE_AVAILABLE_IN_3_28 _IDE_EXTERN
#endif
#endif /* IDE_VERSION_MACROS_H */
......@@ -35,6 +35,7 @@ G_BEGIN_DECLS
#include "ide-pausable.h"
#include "ide-service.h"
#include "ide-version.h"
#include "ide-version-macros.h"
#include "application/ide-application-addin.h"
#include "application/ide-application-tool.h"
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment