/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */

/*

 * Copyright (c) 2008 INRIA, 2010 NICTA

 *

 * This program is free software; you can redistribute it and/or modify

 * it under the terms of the GNU General Public License version 2 as

 * published by the Free Software Foundation;

 *

 * 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, write to the Free Software

 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

 *

 * Author:  Original author unknown

 *          Quincy Tse <quincy.tse@nicta.com.au>

 */

#ifndef NS3_ABORT_H

#define NS3_ABORT_H

#include "fatal-error.h"

/**

 * \ingroup debugging

 * \brief Abnormal program termination

 *

 * \param msg message to output when this macro is hit.

 *

 * This macro is essentially equivalent to NS_FATAL_ERROR,

 * excepts it prepends the error message with the string

 * "aborted. ". When this macro is hit a runtime, the

 * program will be halted using std::terminate, which

 * triggers clean up code regestered by std::set_terminate.

 *

 * This macro is enable unconditionally in all builds,

 * including debug and optimized builds.

 *

 * \see NS_FATAL_ERROR

 */

#define NS_ABORT_MSG(msg)                                       \

  do {                                                          \

/**

 * \ingroup debugging

 * \brief Abnormal program termination if cond is true.

 *

 * \param cond condition to be evaluated.

 *

 * This is similar to NS_ASSERT(!(cond)), except this check

 * is enabled in all builds. If cond is evaluated to true,

 * the espression evaluating to true is printed to stderr,

 * followed by a call to the NS_FATAL_ERROR_NO_MSG() macro

 * which prints the details of filename and line number to

 * stderr. The program will be halted by calling

 * std::terminate(), triggering any clean up code registered

 * by std::set_terminate (NS3 default is a stream-flushing

 * code, but may be overridden).

 *

 * This macro is enable unconditionally in all builds,

 * including debug and optimized builds.

 */

#define NS_ABORT_IF(cond)                                               \

  do {                                                                  \

/**

 * \ingroup debugging

 * \brief Abnormal program termination if cond is true.

 *

 * \param cond condition to be evaluated.

 * \param msg message to output when cond is true.

 *

 * This is similar to NS_ASSERT_MSG(!(cond)), except this

 * check is enabled in all builds. If cond is evaluated to

 * true, the espression evaluating to true is printed to

 * stderr, followed by a call to the NS_FATAL_ERROR() macro

 * which prints the user-specified error message, and details

 * of filename and line number to stderr. The program will

 * be halted by calling std::terminate(), triggering any

 * clean up code registered by std::set_terminate (NS3

 * default is a stream-flushing code, but may be overridden).

 *

 * This macro is enable unconditionally in all builds,

 * including debug and optimized builds.

 */

#define NS_ABORT_MSG_IF(cond, msg)                                      \

  do {                                                                  \

/**

 * \ingroup debugging

 * \brief Abnormal program termination if cond is false.

 *

 * \param cond condition to be evaluated.

 *

 * This is an alias for NS_ABORT_IF(!(cond))

 *

 * \see NS_ABORT_IF

 */

  NS_ABORT_IF(!(cond))

/**

 * \ingroup debugging

 * \brief Abnormal program termination if cond is false.

 *

 * \param cond condition to be evaluated.

 * \param msg message to output if cond is false.

 *

 * This is an alias for NS_ABORT_MSG_IF(!(cond))

 *

 * \see NS_ABORT_MSG_IF

 */

  NS_ABORT_MSG_IF(!(cond),msg)

#endif /* NS3_ABORT_H */