Blame include/cppunit/SourceLine.h

Packit 8c9aa0
#ifndef CPPUNIT_SOURCELINE_H
Packit 8c9aa0
#define CPPUNIT_SOURCELINE_H
Packit 8c9aa0
Packit 8c9aa0
#include <cppunit/Portability.h>
Packit 8c9aa0
#include <string>
Packit 8c9aa0
Packit 8c9aa0
/*! \brief Constructs a SourceLine object initialized with the location where the macro is expanded.
Packit 8c9aa0
 * \ingroup CreatingNewAssertions
Packit 8c9aa0
 * \relates CppUnit::SourceLine
Packit 8c9aa0
 * Used to write your own assertion macros.
Packit 8c9aa0
 * \see Asserter for example of usage.
Packit 8c9aa0
 */
Packit 8c9aa0
#define CPPUNIT_SOURCELINE() CPPUNIT_NS::SourceLine( __FILE__, __LINE__ )
Packit 8c9aa0
Packit 8c9aa0
Packit 8c9aa0
CPPUNIT_NS_BEGIN
Packit 8c9aa0
Packit 8c9aa0
Packit 8c9aa0
/*! \brief Represents a source line location.
Packit 8c9aa0
 * \ingroup CreatingNewAssertions
Packit 8c9aa0
 * \ingroup BrowsingCollectedTestResult
Packit 8c9aa0
 *
Packit 8c9aa0
 * Used to capture the failure location in assertion.
Packit 8c9aa0
 * 
Packit 8c9aa0
 * Use the CPPUNIT_SOURCELINE() macro to construct that object. Typically used when
Packit 8c9aa0
 * writing an assertion macro in association with Asserter.
Packit 8c9aa0
 *
Packit 8c9aa0
 * \see Asserter.
Packit 8c9aa0
 */
Packit 8c9aa0
class CPPUNIT_API SourceLine
Packit 8c9aa0
{
Packit 8c9aa0
public:
Packit 8c9aa0
  SourceLine();
Packit 8c9aa0
Packit 8c9aa0
  // Ensure thread-safe copy by detaching the string buffer.
Packit 8c9aa0
  SourceLine( const SourceLine &other );
Packit 8c9aa0
Packit 8c9aa0
  SourceLine( const std::string &fileName,
Packit 8c9aa0
              int lineNumber );
Packit 8c9aa0
Packit 8c9aa0
  SourceLine &operator =( const SourceLine &other );
Packit 8c9aa0
Packit 8c9aa0
  /// Destructor.
Packit 8c9aa0
  virtual ~SourceLine();
Packit 8c9aa0
Packit 8c9aa0
  bool isValid() const;
Packit 8c9aa0
Packit 8c9aa0
  int lineNumber() const;
Packit 8c9aa0
Packit 8c9aa0
  std::string fileName() const;
Packit 8c9aa0
Packit 8c9aa0
  bool operator ==( const SourceLine &other ) const;
Packit 8c9aa0
  bool operator !=( const SourceLine &other ) const;
Packit 8c9aa0
Packit 8c9aa0
private:
Packit 8c9aa0
  std::string m_fileName;
Packit 8c9aa0
  int m_lineNumber;
Packit 8c9aa0
};
Packit 8c9aa0
Packit 8c9aa0
Packit 8c9aa0
CPPUNIT_NS_END
Packit 8c9aa0
Packit 8c9aa0
#endif  // CPPUNIT_SOURCELINE_H