3rd-party/catch2
1
0
Fork 0
mirror of https://github.com/catchorg/Catch2.git synced 2024-11-05 05:39:53 +01:00
Code Issues Packages Projects Releases Wiki Activity
2d172dc688
catch2/include/internal/catch_interfaces_capture.h

101 lines
3.5 KiB
C
Raw Normal View History

Refactored more into Hub
2011-01-11 10:13:31 +01:00
/*
* Created by Phil on 07/01/2011.
* Copyright 2011 Two Blue Cubes Ltd. All rights reserved.
*
* Distributed under the Boost Software License, Version 1.0. (See accompanying
* file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
*/
#ifndef TWOBLUECUBES_CATCH_INTERFACES_CAPTURE_H_INCLUDED
#define TWOBLUECUBES_CATCH_INTERFACES_CAPTURE_H_INCLUDED
#include <string>
Integrate Nonius benchmark into Catch2 Changes done to Nonius: * Moved things into "Catch::Benchmark" namespace * Benchmarks were integrated with `TEST_CASE`/`SECTION`/`GENERATE` macros * Removed Nonius's parameters for benchmarks, Generators should be used instead * Added relevant methods to the reporter interface (default-implemented, to avoid breaking existing 3rd party reporters) * Async processing is guarded with `_REENTRANT` macro for GCC/Clang, used by default on MSVC * Added a macro `CATCH_CONFIG_DISABLE_BENCHMARKING` that removes all traces of benchmarking from Catch
2019-04-23 23:41:13 +02:00
#include <chrono>
Refactored more into Hub
2011-01-11 10:13:31 +01:00
Use StringRef on fatal error path So far the fatal error path only uses string literals, so this removes an allocation from that context
2017-09-14 20:05:25 +02:00
#include "catch_stringref.h"
Revirtualised IResultCapture methods Didn't really impact runtime anyway, but will need to use interface for threading support.
2017-12-05 17:18:53 +01:00
#include "catch_result_type.h"
Use StringRef on fatal error path So far the fatal error path only uses string literals, so this removes an allocation from that context
2017-09-14 20:05:25 +02:00
More reformatting
2012-05-15 09:02:36 +02:00
namespace Catch {
Renamed ResultInfo -> AssertionResult
2012-10-16 09:27:21 +02:00
class AssertionResult;
Collect assertion info up front
2012-10-17 09:14:22 +02:00
struct AssertionInfo;
SectionInfo now goes via new streaming reporter interface
2012-11-30 09:58:46 +01:00
struct SectionInfo;
Do uncaught_exception checking before calling sectionEnded - split the uncaught handling (adding to unfinishedSections) into separate method
2015-09-27 03:12:21 +02:00
struct SectionEndInfo;
INFO and CAPTURE are now scoped - SCOPED_INFO and SCOPED_CAPTURE are now just aliases
2013-06-28 18:09:57 +02:00
struct MessageInfo;
Add unscoped info functionality This adds UNSCOPED_INFO macro, creating a log message that is stored until the end of next assertion or the end of test case, whichever comes first. These messages are not scoped locally, unlike messages created by INFO macro.
2019-02-01 16:11:30 +01:00
struct MessageBuilder;
Refactored a lot of code from headers into impl headers only compiled into one TU - also added noimpl option to single header script - which only generates the non impl code
2013-12-03 19:52:41 +01:00
struct Counts;
Revirtualised IResultCapture methods Didn't really impact runtime anyway, but will need to use interface for threading support.
2017-12-05 17:18:53 +01:00
struct AssertionReaction;
First attempt at data generator support The support is to be considered experimental, that is, the interfaces, the first party generators and helper functions can change or be removed at any point in time. Related to #850
2018-06-12 18:50:39 +02:00
struct SourceLineInfo;
Revirtualised IResultCapture methods Didn't really impact runtime anyway, but will need to use interface for threading support.
2017-12-05 17:18:53 +01:00
struct ITransientExpression;
First attempt at data generator support The support is to be considered experimental, that is, the interfaces, the first party generators and helper functions can change or be removed at any point in time. Related to #850
2018-06-12 18:50:39 +02:00
struct IGeneratorTracker;
Refactored more into Hub
2011-01-11 10:13:31 +01:00
Various improvements to the benchmarking support * Units from <ratio> are no longer redeclared in our own namespace * The default clock is `steady_clock`, not `high_resolution_clock`, because, as HH says "high_resolution_clock is useless. If you want measure the passing of time, use steady_clock. If you want user friendly time, use system_clock". * Benchmarking support is opt-in, not opt-out, to avoid the large (~10%) compile time penalty. * Benchmarking-related options in CLI are always present, to decrease the amount of code that is only compiled conditionally and making the whole shebang more maintainble.
2019-05-19 20:54:44 +02:00
#if defined(CATCH_CONFIG_ENABLE_BENCHMARKING)
Integrate Nonius benchmark into Catch2 Changes done to Nonius: * Moved things into "Catch::Benchmark" namespace * Benchmarks were integrated with `TEST_CASE`/`SECTION`/`GENERATE` macros * Removed Nonius's parameters for benchmarks, Generators should be used instead * Added relevant methods to the reporter interface (default-implemented, to avoid breaking existing 3rd party reporters) * Async processing is guarded with `_REENTRANT` macro for GCC/Clang, used by default on MSVC * Added a macro `CATCH_CONFIG_DISABLE_BENCHMARKING` that removes all traces of benchmarking from Catch
2019-04-23 23:41:13 +02:00
struct BenchmarkInfo;
template <typename Duration = std::chrono::duration<double, std::nano>>
struct BenchmarkStats;
Various improvements to the benchmarking support * Units from <ratio> are no longer redeclared in our own namespace * The default clock is `steady_clock`, not `high_resolution_clock`, because, as HH says "high_resolution_clock is useless. If you want measure the passing of time, use steady_clock. If you want user friendly time, use system_clock". * Benchmarking support is opt-in, not opt-out, to avoid the large (~10%) compile time penalty. * Benchmarking-related options in CLI are always present, to decrease the amount of code that is only compiled conditionally and making the whole shebang more maintainble.
2019-05-19 20:54:44 +02:00
#endif // CATCH_CONFIG_ENABLE_BENCHMARKING
Integrate Nonius benchmark into Catch2 Changes done to Nonius: * Moved things into "Catch::Benchmark" namespace * Benchmarks were integrated with `TEST_CASE`/`SECTION`/`GENERATE` macros * Removed Nonius's parameters for benchmarks, Generators should be used instead * Added relevant methods to the reporter interface (default-implemented, to avoid breaking existing 3rd party reporters) * Async processing is guarded with `_REENTRANT` macro for GCC/Clang, used by default on MSVC * Added a macro `CATCH_CONFIG_DISABLE_BENCHMARKING` that removes all traces of benchmarking from Catch
2019-04-23 23:41:13 +02:00
More reformatting
2012-05-15 09:02:36 +02:00
struct IResultCapture {
Removed all trailing whitespace - addresses #105
2013-07-03 20:14:59 +02:00
Builds almost completely cleanly with -WEverything in LLVM
2012-08-13 08:46:10 +02:00
virtual ~IResultCapture();
Removed all trailing whitespace - addresses #105
2013-07-03 20:14:59 +02:00
SectionInfo now goes via new streaming reporter interface
2012-11-30 09:58:46 +01:00
virtual bool sectionStarted( SectionInfo const& sectionInfo,
More reformatting
2012-05-15 09:02:36 +02:00
Counts& assertions ) = 0;
Do uncaught_exception checking before calling sectionEnded - split the uncaught handling (adding to unfinishedSections) into separate method
2015-09-27 03:12:21 +02:00
virtual void sectionEnded( SectionEndInfo const& endInfo ) = 0;
virtual void sectionEndedEarly( SectionEndInfo const& endInfo ) = 0;
First draft of (experimental) benchmarking support
2017-08-04 20:23:30 +02:00
First attempt at data generator support The support is to be considered experimental, that is, the interfaces, the first party generators and helper functions can change or be removed at any point in time. Related to #850
2018-06-12 18:50:39 +02:00
virtual auto acquireGeneratorTracker( SourceLineInfo const& lineInfo ) -> IGeneratorTracker& = 0;
Various improvements to the benchmarking support * Units from <ratio> are no longer redeclared in our own namespace * The default clock is `steady_clock`, not `high_resolution_clock`, because, as HH says "high_resolution_clock is useless. If you want measure the passing of time, use steady_clock. If you want user friendly time, use system_clock". * Benchmarking support is opt-in, not opt-out, to avoid the large (~10%) compile time penalty. * Benchmarking-related options in CLI are always present, to decrease the amount of code that is only compiled conditionally and making the whole shebang more maintainble.
2019-05-19 20:54:44 +02:00
#if defined(CATCH_CONFIG_ENABLE_BENCHMARKING)
Integrate Nonius benchmark into Catch2 Changes done to Nonius: * Moved things into "Catch::Benchmark" namespace * Benchmarks were integrated with `TEST_CASE`/`SECTION`/`GENERATE` macros * Removed Nonius's parameters for benchmarks, Generators should be used instead * Added relevant methods to the reporter interface (default-implemented, to avoid breaking existing 3rd party reporters) * Async processing is guarded with `_REENTRANT` macro for GCC/Clang, used by default on MSVC * Added a macro `CATCH_CONFIG_DISABLE_BENCHMARKING` that removes all traces of benchmarking from Catch
2019-04-23 23:41:13 +02:00
virtual void benchmarkPreparing( std::string const& name ) = 0;
First draft of (experimental) benchmarking support
2017-08-04 20:23:30 +02:00
virtual void benchmarkStarting( BenchmarkInfo const& info ) = 0;
Integrate Nonius benchmark into Catch2 Changes done to Nonius: * Moved things into "Catch::Benchmark" namespace * Benchmarks were integrated with `TEST_CASE`/`SECTION`/`GENERATE` macros * Removed Nonius's parameters for benchmarks, Generators should be used instead * Added relevant methods to the reporter interface (default-implemented, to avoid breaking existing 3rd party reporters) * Async processing is guarded with `_REENTRANT` macro for GCC/Clang, used by default on MSVC * Added a macro `CATCH_CONFIG_DISABLE_BENCHMARKING` that removes all traces of benchmarking from Catch
2019-04-23 23:41:13 +02:00
virtual void benchmarkEnded( BenchmarkStats<> const& stats ) = 0;
virtual void benchmarkFailed( std::string const& error ) = 0;
Various improvements to the benchmarking support * Units from <ratio> are no longer redeclared in our own namespace * The default clock is `steady_clock`, not `high_resolution_clock`, because, as HH says "high_resolution_clock is useless. If you want measure the passing of time, use steady_clock. If you want user friendly time, use system_clock". * Benchmarking support is opt-in, not opt-out, to avoid the large (~10%) compile time penalty. * Benchmarking-related options in CLI are always present, to decrease the amount of code that is only compiled conditionally and making the whole shebang more maintainble.
2019-05-19 20:54:44 +02:00
#endif // CATCH_CONFIG_ENABLE_BENCHMARKING
First draft of (experimental) benchmarking support
2017-08-04 20:23:30 +02:00
INFO and CAPTURE are now scoped - SCOPED_INFO and SCOPED_CAPTURE are now just aliases
2013-06-28 18:09:57 +02:00
virtual void pushScopedMessage( MessageInfo const& message ) = 0;
virtual void popScopedMessage( MessageInfo const& message ) = 0;
Removed all trailing whitespace - addresses #105
2013-07-03 20:14:59 +02:00
Add unscoped info functionality This adds UNSCOPED_INFO macro, creating a log message that is stored until the end of next assertion or the end of test case, whichever comes first. These messages are not scoped locally, unlike messages created by INFO macro.
2019-02-01 16:11:30 +01:00
virtual void emplaceUnscopedMessage( MessageBuilder const& builder ) = 0;
Use StringRef on fatal error path So far the fatal error path only uses string literals, so this removes an allocation from that context
2017-09-14 20:05:25 +02:00
virtual void handleFatalErrorCondition( StringRef message ) = 0;
Eliminate some work when results won't be reported.
2017-06-26 21:30:23 +02:00
Revirtualised IResultCapture methods Didn't really impact runtime anyway, but will need to use interface for threading support.
2017-12-05 17:18:53 +01:00
virtual void handleExpr
( AssertionInfo const& info,
ITransientExpression const& expr,
AssertionReaction& reaction ) = 0;
virtual void handleMessage
( AssertionInfo const& info,
ResultWas::OfType resultType,
StringRef const& message,
AssertionReaction& reaction ) = 0;
virtual void handleUnexpectedExceptionNotThrown
( AssertionInfo const& info,
AssertionReaction& reaction ) = 0;
virtual void handleUnexpectedInflightException
( AssertionInfo const& info,
std::string const& message,
AssertionReaction& reaction ) = 0;
virtual void handleIncomplete
( AssertionInfo const& info ) = 0;
virtual void handleNonExpr
( AssertionInfo const &info,
ResultWas::OfType resultType,
AssertionReaction &reaction ) = 0;
Eliminate some work when results won't be reported.
2017-06-26 21:30:23 +02:00
virtual bool lastAssertionPassed() = 0;
virtual void assertionPassed() = 0;
Removed assertionRun() and rolled its logic into assertionPassed() and assertionEnded()
2017-12-02 17:32:02 +01:00
// Deprecated, do not use:
virtual std::string getCurrentTestName() const = 0;
virtual const AssertionResult* getLastResult() const = 0;
virtual void exceptionEarlyReported() = 0;
Refactored more into Hub
2011-01-11 10:13:31 +01:00
};
Big assertion capture refactoring. - moved as much logic out of the macros as possible - moved most logic into new ResultBuilder class, which wraps ExpressionResultBuilder (may take it over next), subsumes ResultAction and also takes place of ExpressionDecomposer. This introduces many SRP violations - but all in the name of minimising macro logic!
2014-05-28 19:53:01 +02:00
IResultCapture& getResultCapture();
Refactored more into Hub
2011-01-11 10:13:31 +01:00
}
#endif // TWOBLUECUBES_CATCH_INTERFACES_CAPTURE_H_INCLUDED
Reference in New Issue Copy Permalink