// Copyright 2020 The Marl Authors.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#ifndef marl_deprecated_h
#define marl_deprecated_h

#ifndef MARL_WARN_DEPRECATED
#define MARL_WARN_DEPRECATED 1
#endif  // MARL_WARN_DEPRECATED

#if MARL_WARN_DEPRECATED
#if defined(_WIN32)
#define MARL_DEPRECATED(issue_num, message)                              \
  __declspec(deprecated(                                                 \
      message "\nSee: https://github.com/google/marl/issues/" #issue_num \
              " for more information"))
#else
#define MARL_DEPRECATED(issue_num, message)                              \
  __attribute__((deprecated(                                             \
      message "\nSee: https://github.com/google/marl/issues/" #issue_num \
              " for more information")))
#endif
#else
#define MARL_DEPRECATED(issue_num, message)
#endif

#endif  // marl_deprecated_h