test/test_tools.h
author Peter Kovacs <kpeter@inf.elte.hu>
Tue, 05 Feb 2008 11:24:57 +0100
changeset 73 c56b7389dc78
parent 4 3f411aa35bd7
child 100 4f754b4cf82b
permissions -rw-r--r--
Several fixes and improvements in list_graph.h.

- Fix incorrect or misleading renamings in the code and in the documentation.
- Improve the documentation.
alpar@4
     1
/* -*- C++ -*-
alpar@4
     2
 *
alpar@4
     3
 * This file is a part of LEMON, a generic C++ optimization library
alpar@4
     4
 *
alpar@39
     5
 * Copyright (C) 2003-2008
alpar@4
     6
 * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
alpar@4
     7
 * (Egervary Research Group on Combinatorial Optimization, EGRES).
alpar@4
     8
 *
alpar@4
     9
 * Permission to use, modify and distribute this software is granted
alpar@4
    10
 * provided that this copyright notice appears in all copies. For
alpar@4
    11
 * precise terms see the accompanying LICENSE file.
alpar@4
    12
 *
alpar@4
    13
 * This software is provided "AS IS" with no warranty of any kind,
alpar@4
    14
 * express or implied, and with no claim as to its suitability for any
alpar@4
    15
 * purpose.
alpar@4
    16
 *
alpar@4
    17
 */
alpar@4
    18
alpar@4
    19
#ifndef LEMON_TEST_TEST_TOOLS_H
alpar@4
    20
#define LEMON_TEST_TEST_TOOLS_H
alpar@4
    21
alpar@4
    22
#include <iostream>
alpar@4
    23
alpar@4
    24
//! \ingroup misc
alpar@4
    25
//! \file
alpar@4
    26
//! \brief Some utilities to write test programs.
alpar@4
    27
alpar@4
    28
alpar@4
    29
///If \c rc is fail, writes an error message end exit.
alpar@4
    30
alpar@4
    31
///If \c rc is fail, writes an error message end exit.
alpar@4
    32
///The error message contains the file name and the line number of the
alpar@4
    33
///source code in a standard from, which makes it possible to go there
alpar@4
    34
///using good source browsers like e.g. \c emacs.
alpar@4
    35
///
alpar@4
    36
///For example
alpar@4
    37
///\code check(0==1,"This is obviously false.");\endcode will
alpar@4
    38
///print this (and then exits).
alpar@4
    39
///\verbatim graph_test.cc:123: error: This is obviously false. \endverbatim
alpar@4
    40
///
alpar@4
    41
///\todo It should be in \c error.h
alpar@4
    42
#define check(rc, msg) \
alpar@4
    43
  if(!(rc)) { \
alpar@4
    44
    std::cerr << __FILE__ ":" << __LINE__ << ": error: " << msg << std::endl; \
alpar@4
    45
    abort(); \
alpar@4
    46
  } else { } \
alpar@4
    47
alpar@4
    48
#endif