contract.hh

Go to the documentation of this file.

// contract.hh: this file is part of the Vaucanson project.
//
// Vaucanson, a generic library for finite state machines.
//
// Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2008 The Vaucanson Group.
//
// This program is free software; you can redistribute it and/or
// modify it under the terms of the GNU General Public License
// as published by the Free Software Foundation; either version 2
// of the License, or (at your option) any later version.
//
// The complete GNU General Public Licence Notice can be found as the
// `COPYING' file in the root directory.
//
// The Vaucanson Group consists of people listed in the `AUTHORS' file.
//
#ifndef VCSN_MISC_CONTRACT_HH
# define VCSN_MISC_CONTRACT_HH

# ifndef VCSN_NDEBUG
#  include <vaucanson/config/system.hh>
#  include <vaucanson/misc/static.hh>

#  include <iostream>
#  include <string>

#  ifdef EXCEPTION_TRAPS
#   include <sstream>
#   include <stdexcept>
#  else // ! EXCEPTION_TRAPS
#   include <cstdlib>
#  endif // EXCEPTION_TRAP

namespace vcsn {
  namespace misc {
    namespace contract {


      inline
      void trap (const char *file, int line,
                 const char *location,
                 const std::string& message)
      {
#  ifdef EXCEPTION_TRAPS
        std::ostringstream os;
        os << file << ':' << line << ':'
           << (location ? location : "")
           << (location ? ": " : " ")
           << message;
        throw std::logic_error (os.str ());
#  else // ! EXCEPTION_TRAPS
        std::cerr << file << ':' << line << ':'
                  << (location ? location : "")
                  << std::endl
                  << '\t' << message
                  << std::endl;
        abort ();
#  endif // EXCEPTION_TRAPS
      }

      template<typename T>
      struct fail;
    }
  }
}

#  define vcsn_trap_(Message, Cond)                                     \
  vcsn::misc::contract::trap (__FILE__, __LINE__, PRETTY_FUNCTION (),   \
                              std::string (Message) + ": " #Cond)
#  define vcsn_trap__(Message, Cond, Explanation)                       \
  vcsn::misc::contract::trap (__FILE__, __LINE__, PRETTY_FUNCTION (),   \
                              std::string (Message) + ": " #Cond " // " + Explanation)
#  define vcsn_trap_2(Message1, Message2)                               \
  vcsn::misc::contract::trap (__FILE__, __LINE__, PRETTY_FUNCTION (),   \
                              std::string (Message1) + ": " + Message2)

#  define assertion(Cond) static_cast<void> ((Cond) ? static_cast<void> (0) : vcsn_trap_ ("Assertion failed", Cond))
#  define precondition(Cond) static_cast<void> ((Cond) ? static_cast<void> (0) : vcsn_trap_ ("Precondition failed", Cond))
#  define postcondition(Cond) static_cast<void> ((Cond) ? static_cast<void> (0) : vcsn_trap_ ("Postcondition failed", Cond))

#  define unreachable(Explanation) vcsn_trap_2 ("Unreachable code reached", Explanation)

#  define assertion_(Cond, Explanation_if_false) static_cast<void> ((Cond) ? static_cast<void> (0) : vcsn_trap__ ("Assertion failed", Cond, Explanation_if_false))
#  define precondition_(Cond, Explanation_if_false) static_cast<void> ((Cond) ? static_cast<void> (0) : vcsn_trap__ ("Precondition failed", Cond, Explanation_if_false))
#  define postcondition_(Cond, Explanation_if_false) static_cast<void> ((Cond) ? static_cast<void> (0) : vcsn_trap__ ("Postcondition failed", Cond, Explanation_if_false))

#  define result_not_computable_if(Cond) static_cast<void> ((Cond) ? vcsn_trap_ ("Result is not computable", Cond) : static_cast<void> (0))
#  define result_not_computable(Message) vcsn_trap_2 ("Result is not computable", Message)

#  define pure_service_call(Service) vcsn_trap_ ("Pure abstract service called", Service)

#  define static_assertion(Cond, Message)                               \
  { vcsn::misc::static_if<Cond, int, vcsn::misc::contract::fail<void> >::t Message; Message = 0; }
#  define static_assertion_(Cond, Message)                              \
  { typename vcsn::misc::static_if<Cond, int, vcsn::misc::contract::fail<void> >::t Message; Message = 0; }

#  define static_error(Message)                 \
  {                                                     \
    struct Message;                                     \
    vcsn::misc::contract::fail<Message> Message;        \
  }

#  ifndef INTERNAL_CHECKS

#   define recommendation(Cond) static_cast<void> (0)
#   define deprecation(Feature) static_cast<void> (0)
#   define weakness(Feature) static_cast<void> (0)
#   define incompletion(Feature) static_cast<void> (0)

#   define WARNING(Message) static_cast<void> (0)

#  else // ! INTERNAL_CHECKS

#   ifdef STRICT
#    define __inconsistency(Message1, Message2) vcsn_trap_2 (Message1, Message2)
#   else // ! STRICT
#    define __inconsistency(Message1, Message2)                 \
  static_cast<void> (std::cerr << __FILE__ << ':' << __LINE__ << ": "   \
                     << Message1 << ": " << Message2 << std::endl)
#   endif // STRICT

#   define recommendation(Cond)                                 \
  static_cast<void> ((Cond) ?                                           \
                     static_cast<void> (0) :                            \
                     __inconsistency ("Recommendation", #Cond " Failed."))
#   define deprecation(Feature) __inconsistency ("Deprecated feature", Feature)
#   define weakness(Feature) __inconsistency ("Weak feature", Feature)
#   define incompletion(Feature) __inconsistency ("Incomplete implementation", Feature)
#   define WARNING(Message) __inconsistency ("Warning", Message)

#  endif // INTERNAL_CHECKS

# else // VCSN_NDEBUG

#  define static_assertion(Cond, Message) typedef void Message
#  define static_assertion_(Cond, Message) typedef void Message
#  define static_error(Message) typedef void Message

#  define assertion(Cond) static_cast<void> (0)
#  define precondition(Cond) static_cast<void> (0)
#  define postcondition(Cond) static_cast<void> (0)
#  define assertion_(Cond, Explanation_if_false) static_cast<void> (0)
#  define precondition_(Cond, Explanation_if_false) static_cast<void> (0)
#  define postcondition_(Cond, Explanation_if_false) static_cast<void> (0)

#  define unreachable(Explanation) static_cast<void> (0)

#  define result_not_computable_if(Cond) static_cast<void> (0)
#  define result_not_computable(Message) static_cast<void> (0)

#  define pure_service_call(Service) static_cast<void> (0)

#  define recommendation(Cond) static_cast<void> (0)
#  define deprecation(Feature) static_cast<void> (0)
#  define weakness(Feature) static_cast<void> (0)
#  define incompletion(Feature) static_cast<void> (0)

#  define WARNING(Message) static_cast<void> (0)

# endif // ! VCSN_NDEBUG

#endif // ! VCSN_MISC_CONTRACT_HH

---