// ==========================================================================
//                 SeqAn - The Library for Sequence Analysis
// ==========================================================================
// Copyright (c) 2006-2024, Knut Reinert, FU Berlin
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
//     * Redistributions of source code must retain the above copyright
//       notice, this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above copyright
//       notice, this list of conditions and the following disclaimer in the
//       documentation and/or other materials provided with the distribution.
//     * Neither the name of Knut Reinert or the FU Berlin nor the names of
//       its contributors may be used to endorse or promote products derived
//       from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL KNUT REINERT OR THE FU BERLIN BE LIABLE
// FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
// DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
// SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
// CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
// LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
// OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
// DAMAGE.
//
// ==========================================================================
// Author: Manuel Holtgrewe <manuel.holtgrewe@fu-berlin.de>
// ==========================================================================
// Macro for deprecating code.
// ==========================================================================

#ifndef INCLUDE_SEQAN_BASIC_MACRO_DEPRECATED_H_
#define INCLUDE_SEQAN_BASIC_MACRO_DEPRECATED_H_

namespace seqan2 {

// ============================================================================
// Macros
// ============================================================================

// Macros SEQAN_DEPRECATED_PRE SEQAN_DEPRECATED_POST
//
// For internal use only.
//
// For cross-platform compatibility, you can use this in declarations only.
// We need a version that comes before and one that comes after the symbol
// because of cross-compiler compatibility.
//
// Example:
//
// void
// SEQAN_DEPRECATED_PRE("Use bar instead.")
// f()
// SEQAN_DEPRECATED_POST("Use bar instead.");

#if defined(__clang__)
#define SEQAN_DEPRECATED_PRE(msg)
#define SEQAN_DEPRECATED_POST(msg) __attribute__((deprecated(msg)))
#elif defined(__GNUC__)
#define SEQAN_DEPRECATED_PRE(msg)
#define SEQAN_DEPRECATED_POST(msg) __attribute__((__deprecated__))
#elif defined(_MSC_VER)
#define SEQAN_DEPRECATED_PRE(msg) __declspec(deprecated(msg))
#define SEQAN_DEPRECATED_POST(msg)
#else
#pragma message("WARNING: You need to implement DEPRECATED_PRE and DEPRECATED_POST for this compiler")
#define SEQAN_DEPRECATED_PRE(func)
#define SEQAN_DEPRECATED_POST(func)
#endif

}  // namespace seqan2

#endif  // #ifndef INCLUDE_SEQAN_BASIC_MACRO_DEPRECATED_H_
