Asserter.h

Go to the documentation of this file.

#ifndef CPPUNIT_ASSERTER_H
#define CPPUNIT_ASSERTER_H
 
#include <cppunit/AdditionalMessage.h>
#include <cppunit/SourceLine.h>
#include <string>
 
CPPUNIT_NS_BEGIN
 
 
class Message;
 
 
struct Asserter
{
  [[noreturn]] static void CPPUNIT_API fail( const Message &message, 
                                const SourceLine &sourceLine = SourceLine() );
 
  [[noreturn]] static void CPPUNIT_API fail( std::string message, 
                                const SourceLine &sourceLine = SourceLine() );
 
  static void CPPUNIT_API failIf( bool shouldFail, 
                                  const Message &message, 
                                  const SourceLine &sourceLine = SourceLine() );
 
  static void CPPUNIT_API failIf( bool shouldFail, 
                                  std::string message, 
                                  const SourceLine &sourceLine = SourceLine() );
 
  static std::string CPPUNIT_API makeExpected( const std::string &expectedValue );
  static std::string CPPUNIT_API makeExpectedEqual( const std::string &expectedValue );
  static std::string CPPUNIT_API makeExpectedLess( const std::string &expectedValue );
  static std::string CPPUNIT_API makeExpectedLessEqual( const std::string &expectedValue );
  static std::string CPPUNIT_API makeExpectedGreater( const std::string &expectedValue );
  static std::string CPPUNIT_API makeExpectedGreaterEqual( const std::string &expectedValue );
 
  static std::string CPPUNIT_API makeActual( const std::string &actualValue );
 
  static Message CPPUNIT_API makeNotEqualMessage( const std::string &expectedValue,
                                                  const std::string &actualValue,
                                                  const AdditionalMessage &additionalMessage = AdditionalMessage(),
                                                  const std::string &shortDescription = "equality assertion failed");
 
  static Message CPPUNIT_API makeMessage( const std::string &expectedValue,
                                                  const std::string &actualValue,
                                                  const std::string &shortDescription,
                                                  const AdditionalMessage &additionalMessage = AdditionalMessage());
 
  [[noreturn]] static void CPPUNIT_API failNotEqual( std::string expected, 
                                        std::string actual, 
                                        const SourceLine &sourceLine,
                                        const AdditionalMessage &additionalMessage = AdditionalMessage(),
                                        std::string shortDescription = "equality assertion failed" );
 
  static void CPPUNIT_API failNotLess( std::string expected, 
                                        std::string actual, 
                                        const SourceLine &sourceLine,
                                        const AdditionalMessage &additionalMessage = AdditionalMessage(),
                                        std::string shortDescription = "less assertion failed" );
 
  static void CPPUNIT_API failNotGreater( std::string expected, 
                                        std::string actual, 
                                        const SourceLine &sourceLine,
                                        const AdditionalMessage &additionalMessage = AdditionalMessage(),
                                        std::string shortDescription = "greater assertion failed" );
 
  static void CPPUNIT_API failNotLessEqual( std::string expected, 
                                        std::string actual, 
                                        const SourceLine &sourceLine,
                                        const AdditionalMessage &additionalMessage = AdditionalMessage(),
                                        std::string shortDescription = "less equal assertion failed" );
 
  static void CPPUNIT_API failNotGreaterEqual( std::string expected, 
                                        std::string actual, 
                                        const SourceLine &sourceLine,
                                        const AdditionalMessage &additionalMessage = AdditionalMessage(),
                                        std::string shortDescription = "greater equal assertion failed" );  
  static void CPPUNIT_API failNotEqualIf( bool shouldFail,
                                          std::string expected, 
                                          std::string actual, 
                                          const SourceLine &sourceLine,
                                          const AdditionalMessage &additionalMessage = AdditionalMessage(),
                                          std::string shortDescription = "equality assertion failed" );
 
};
 
 
CPPUNIT_NS_END
 
 
#endif  // CPPUNIT_ASSERTER_H