fzi_icl_core: Deprecate.h Source File

Go to the documentation of this file.
00001 // this is for emacs file handling -*- mode: c++; indent-tabs-mode: nil -*-
00002 
00003 // -- BEGIN LICENSE BLOCK ----------------------------------------------
00004 // This file is part of FZIs ic_workspace.
00005 //
00006 // This program is free software licensed under the LGPL
00007 // (GNU LESSER GENERAL PUBLIC LICENSE Version 3).
00008 // You can find a copy of this license in LICENSE folder in the top
00009 // directory of the source code.
00010 //
00011 // © Copyright 2016 FZI Forschungszentrum Informatik, Karlsruhe, Germany
00012 //
00013 // -- END LICENSE BLOCK ------------------------------------------------
00014 
00015 //----------------------------------------------------------------------
00026 //----------------------------------------------------------------------
00027 #ifndef ICL_CORE_DEPRECATE_H_INCLUDED
00028 #define ICL_CORE_DEPRECATE_H_INCLUDED
00029 
00030 // Define deprecation macros for Visual Studio.
00031 #if defined(_MSC_VER) && !defined(ICL_CORE_NO_DEPRECATION)
00032 # define ICL_CORE_VC_DEPRECATE __declspec(deprecated)
00033 # define ICL_CORE_VC_DEPRECATE_COMMENT(arg) __declspec(deprecated(arg))
00034 #else
00035 # define ICL_CORE_VC_DEPRECATE
00036 # define ICL_CORE_VC_DEPRECATE_COMMENT(arg)
00037 #endif
00038 
00039 // Define deprecation macros for GCC.
00040 #if defined(__GNUC__) && (__GNUC__ > 3 || (__GNUC__ == 3 && __GNUC_MINOR__ >= 1)) && !defined(ICL_CORE_NO_DEPRECATION)
00041 # define ICL_CORE_GCC_DEPRECATE __attribute__((deprecated))
00042 # if (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 5))
00043 #  define ICL_CORE_GCC_DEPRECATE_COMMENT(arg) __attribute__((deprecated(arg)))
00044 # else
00045 #  define ICL_CORE_GCC_DEPRECATE_COMMENT(arg) __attribute__((deprecated))
00046 # endif
00047 #else
00048 # define ICL_CORE_GCC_DEPRECATE
00049 # define ICL_CORE_GCC_DEPRECATE_COMMENT(arg)
00050 #endif
00051 
00052 // Special comment for deprecation due to obsolete style.
00053 #define ICL_CORE_VC_DEPRECATE_STYLE ICL_CORE_VC_DEPRECATE_COMMENT("Please follow the new Coding Style Guidelines.")
00054 #define ICL_CORE_GCC_DEPRECATE_STYLE ICL_CORE_GCC_DEPRECATE_COMMENT("Please follow the new Coding Style Guidelines.")
00055 
00056 // Special comment for changing to new source sink pattern.
00057 #define ICL_CORE_VC_DEPRECATE_SOURCESINK ICL_CORE_VC_DEPRECATE_COMMENT("Please follow the new Source Sink Pattern.")
00058 #define ICL_CORE_GCC_DEPRECATE_SOURCESINK ICL_CORE_GCC_DEPRECATE_COMMENT("Please follow the new Source Sink Pattern.")
00059 
00060 // Special comment for moving to ROS workspace.
00061 #define ICL_CORE_VC_DEPRECATE_MOVE_ROS ICL_CORE_VC_DEPRECATE_COMMENT("This was moved to a ROS package. Please use the implementation in ros_icl or ros_sourcesink instead.")
00062 #define ICL_CORE_GCC_DEPRECATE_MOVE_ROS ICL_CORE_GCC_DEPRECATE_COMMENT("This was moved to a ROS package. Please use the implementation in ros_icl or ros_sourcesink instead.")
00063 
00064 // Special comment for deprecation due to obsolete style which
00065 // provides the name of the function that superseded the obsolete one.
00066 #define ICL_CORE_VC_DEPRECATE_STYLE_USE(arg) ICL_CORE_VC_DEPRECATE_COMMENT("Please follow the new Coding Style Guidelines and use " #arg " instead.")
00067 #define ICL_CORE_GCC_DEPRECATE_STYLE_USE(arg) ICL_CORE_GCC_DEPRECATE_COMMENT("Please follow the new Coding Style Guidelines and use " #arg " instead.")
00068 
00069 #endif