src/core/fatal-error.h
author Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
Wed, 03 Sep 2008 17:42:28 +0100
changeset 3591 f548d13ffd4e
parent 3492 7e1c5827504f
child 6370 0a0b6bf5fdfd
permissions -rw-r--r--
Fix build when ns3_module_*__local.py files are used.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
278
fc1133fee95d add fatal-error.h header
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
     1
/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
fc1133fee95d add fatal-error.h header
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
     2
/*
fc1133fee95d add fatal-error.h header
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
     3
 * Copyright (c) 2006 INRIA
fc1133fee95d add fatal-error.h header
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
     4
 *
fc1133fee95d add fatal-error.h header
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
     5
 * This program is free software; you can redistribute it and/or modify
fc1133fee95d add fatal-error.h header
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
     6
 * it under the terms of the GNU General Public License version 2 as
fc1133fee95d add fatal-error.h header
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
     7
 * published by the Free Software Foundation;
fc1133fee95d add fatal-error.h header
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
     8
 *
fc1133fee95d add fatal-error.h header
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
     9
 * This program is distributed in the hope that it will be useful,
fc1133fee95d add fatal-error.h header
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    10
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
fc1133fee95d add fatal-error.h header
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    11
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
fc1133fee95d add fatal-error.h header
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    12
 * GNU General Public License for more details.
fc1133fee95d add fatal-error.h header
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    13
 *
fc1133fee95d add fatal-error.h header
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    14
 * You should have received a copy of the GNU General Public License
fc1133fee95d add fatal-error.h header
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    15
 * along with this program; if not, write to the Free Software
fc1133fee95d add fatal-error.h header
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    16
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
fc1133fee95d add fatal-error.h header
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    17
 *
fc1133fee95d add fatal-error.h header
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    18
 * Author: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
fc1133fee95d add fatal-error.h header
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    19
 */
fc1133fee95d add fatal-error.h header
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    20
#ifndef FATAL_ERROR_H
fc1133fee95d add fatal-error.h header
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    21
#define FATAL_ERROR_H
fc1133fee95d add fatal-error.h header
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    22
391
0b920298da18 make sure we include std::cout definition even in optimized builds
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 345
diff changeset
    23
#include <iostream>
278
fc1133fee95d add fatal-error.h header
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    24
fc1133fee95d add fatal-error.h header
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    25
/**
3182
61fe7fe81ebd Doxygen organization
Tom Henderson <tomh@tomh.org>
parents: 2834
diff changeset
    26
 * \ingroup debugging
278
fc1133fee95d add fatal-error.h header
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    27
 * \brief fatal error handling
fc1133fee95d add fatal-error.h header
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    28
 *
fc1133fee95d add fatal-error.h header
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    29
 * \param msg message to output when this macro is hit.
fc1133fee95d add fatal-error.h header
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    30
 *
fc1133fee95d add fatal-error.h header
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    31
 * When this macro is hit at runtime, the user-specified 
3492
7e1c5827504f bug 264: NS_BREAKPOINT never stops the debugger at the right location.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 3182
diff changeset
    32
 * error message is output and the program is halted by
7e1c5827504f bug 264: NS_BREAKPOINT never stops the debugger at the right location.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 3182
diff changeset
    33
 * dereferencing a null pointer. This macro is enabled 
7e1c5827504f bug 264: NS_BREAKPOINT never stops the debugger at the right location.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 3182
diff changeset
    34
 * unconditionally in all builds, including debug and 
7e1c5827504f bug 264: NS_BREAKPOINT never stops the debugger at the right location.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 3182
diff changeset
    35
 * optimized builds.
278
fc1133fee95d add fatal-error.h header
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    36
 */
fc1133fee95d add fatal-error.h header
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    37
#define NS_FATAL_ERROR(msg)				\
324
7571b28edc22 make trailing ';' mandatory for NS_ASSERT* and NS_FATAL_ERROR macros. fix uses.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 278
diff changeset
    38
  do                                                    \
7571b28edc22 make trailing ';' mandatory for NS_ASSERT* and NS_FATAL_ERROR macros. fix uses.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 278
diff changeset
    39
    {                                                   \
1020
ebcb38b7ff7d In some places, print debug messages / errors to stderr, not stdout.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 1018
diff changeset
    40
      std::cerr << msg << std::endl;			\
3492
7e1c5827504f bug 264: NS_BREAKPOINT never stops the debugger at the right location.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 3182
diff changeset
    41
      int *a = 0;                                       \
7e1c5827504f bug 264: NS_BREAKPOINT never stops the debugger at the right location.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 3182
diff changeset
    42
      *a = 0;                                           \
324
7571b28edc22 make trailing ';' mandatory for NS_ASSERT* and NS_FATAL_ERROR macros. fix uses.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 278
diff changeset
    43
    }                                                   \
7571b28edc22 make trailing ';' mandatory for NS_ASSERT* and NS_FATAL_ERROR macros. fix uses.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 278
diff changeset
    44
  while (false)
278
fc1133fee95d add fatal-error.h header
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    45
fc1133fee95d add fatal-error.h header
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    46
fc1133fee95d add fatal-error.h header
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    47
#endif /* FATAL_ERROR_H */