From 3e675fe9b2439492f1935629915a1488e669eb92 Mon Sep 17 00:00:00 2001 From: Christian Willner <34183939+vaeng@users.noreply.github.com> Date: Tue, 19 Nov 2024 09:56:34 +0100 Subject: [PATCH] feat: add exercise for pointer concept (#825) --- config.json | 12 + exercises/concept/speedywagon/.docs/hints.md | 46 + .../concept/speedywagon/.docs/instructions.md | 105 + .../concept/speedywagon/.docs/introduction.md | 99 + .../speedywagon/.docs/introduction.md.tpl | 3 + .../concept/speedywagon/.meta/config.json | 20 + exercises/concept/speedywagon/.meta/design.md | 25 + .../concept/speedywagon/.meta/exemplar.cpp | 38 + .../concept/speedywagon/.meta/exemplar.h | 24 + exercises/concept/speedywagon/CMakeLists.txt | 64 + exercises/concept/speedywagon/speedywagon.cpp | 21 + exercises/concept/speedywagon/speedywagon.h | 16 + .../concept/speedywagon/speedywagon_test.cpp | 61 + exercises/concept/speedywagon/test/catch.hpp | 17937 ++++++++++++++++ .../concept/speedywagon/test/tests-main.cpp | 2 + 15 files changed, 18473 insertions(+) create mode 100644 exercises/concept/speedywagon/.docs/hints.md create mode 100644 exercises/concept/speedywagon/.docs/instructions.md create mode 100644 exercises/concept/speedywagon/.docs/introduction.md create mode 100644 exercises/concept/speedywagon/.docs/introduction.md.tpl create mode 100644 exercises/concept/speedywagon/.meta/config.json create mode 100644 exercises/concept/speedywagon/.meta/design.md create mode 100644 exercises/concept/speedywagon/.meta/exemplar.cpp create mode 100644 exercises/concept/speedywagon/.meta/exemplar.h create mode 100644 exercises/concept/speedywagon/CMakeLists.txt create mode 100644 exercises/concept/speedywagon/speedywagon.cpp create mode 100644 exercises/concept/speedywagon/speedywagon.h create mode 100644 exercises/concept/speedywagon/speedywagon_test.cpp create mode 100644 exercises/concept/speedywagon/test/catch.hpp create mode 100644 exercises/concept/speedywagon/test/tests-main.cpp diff --git a/config.json b/config.json index ac68f83b3..caa7c52bd 100644 --- a/config.json +++ b/config.json @@ -196,6 +196,18 @@ "references", "headers" ] + }, + { + "slug": "speedywagon", + "name": "Speedywagon Foundation", + "uuid": "ed2148a5-674c-4660-a050-b11ab240b876", + "concepts": [ + "pointers" + ], + "prerequisites": [ + "classes", + "references" + ] } ], "practice": [ diff --git a/exercises/concept/speedywagon/.docs/hints.md b/exercises/concept/speedywagon/.docs/hints.md new file mode 100644 index 000000000..cdb3033c2 --- /dev/null +++ b/exercises/concept/speedywagon/.docs/hints.md @@ -0,0 +1,46 @@ +# Hints + +## General + +- Pay close attention to pointer syntax. + You will be using `*` (dereference operator) and `->` (member access through pointer). +- Make sure to check for null pointers (`nullptr`) where necessary to avoid accessing invalid memory. +- You can run the tests even if your code isn't complete; a rough structure is enough to see test results. +- All functions used by the tests must be declared in the header file. +- If your program crashes or behaves unexpectedly, it's often due to null pointer dereferencing. + Double-check that you handle `nullptr` properly. +- When using pointer arithmetic, ensure that you stay within the bounds of the sensor array. + Going beyond the array's capacity can lead to memory issues. + +## 1. Check Sensor Connection (`connection_check`) + +- The task is mainly about verifying whether a pointer is null or not. +- Use the comparison operator `!=` to check if a pointer is valid. +- If you're unsure whether you're checking the pointer correctly, think about what `nullptr` represents (the absence of a valid memory address). + + +## 2. Count Activity of Sensors (`activity_counter`) + +- You need to iterate over the array of sensors. + An array in C++ can be treated as a pointer to its first element. +- Use pointer arithmetic (`sensor_array + i`) to access the sensor at index `i`. +- The `->` operator is used to access a member of the struct through a pointer. + +### Example + +```cpp +int sum = (sensor_array + i)->activity; // Access activity using pointer arithmetic +``` + +## 3. Alarm Control (`alarm_control`) + +- First, check if the pointer is null before accessing the sensor. +- Use the `->` operator to access the `activity` member of the `pillar_men_sensor` struct. +- Think carefully about what should happen if the sensor's activity level is `0`. + Should the alarm trigger? + +## 4. Checking the data for anomalies with the `uv_alarm` function + +- Use the `&` operator to pass a pointer to the sensor's data array into the `uv_light_heuristic` function. +- Ensure you correctly check for a null pointer before accessing the sensor's data. +- Compare the result of `uv_light_heuristic` with the sensor's `activity` value to determine if the alarm should trigger. diff --git a/exercises/concept/speedywagon/.docs/instructions.md b/exercises/concept/speedywagon/.docs/instructions.md new file mode 100644 index 000000000..7dc11c23a --- /dev/null +++ b/exercises/concept/speedywagon/.docs/instructions.md @@ -0,0 +1,105 @@ +# Instructions + +Welcome, Engineer! +You are one of the last veterans of the Speedywagon Foundation, a secret organization that, for decades, has been battling ancient threats like the Pillar Men. +In the course of this effort, you've spent years maintaining the Foundation's technological systems, built using a mix of cutting-edge tech and aging libraries. + +However, in recent times, the sensors that track Pillar Men activities are malfunctioning. +The Foundation's systems are old, and the code interacts with a legacy C++ library that cannot be updated. +Your task is to implement four core functions that monitor Pillar Men sensor activity using an old-fashioned pointer-based library. + +The Foundation's operations rely on you. + +## 0. The Sensor Environment (`pillar_men_sensor`) + +As sensor readings can be huge, we supply a mockup _struct_ that is used in the actual library. +The code has already been implemented in the header file for you. + +```cpp +struct pillar_men_sensor { + int activity{}; + std::string location{}; + std::vector data{}; +}; +``` + +## 1. Check Sensor Connection (`connection_check`) + +Your first task is to ensure that the Pillar Men sensor is connected properly. +We can't have false alarms triggered by disconnected sensors. +You will write a function `connection_check`, which tests if the sensor's pointer is valid by checking for `nullptr`. + +### Task + +- Define a function that accepts a pointer a a `pillar_men_sensor` _struct_. +- The function should return `true` if the sensor pointer is not null, and `false` otherwise. + +### Example + +```cpp +pillar_men_sensor* sensor{nullptr}; +bool isConnected = connection_check(sensor); +// isConnected => false +``` + +## 2. Count Activity of Sensors (`activity_counter`) + +Pillar Men are lurking in the shadows, and we need to know if sensors have detected any activity. +You will write the `activity_counter` function, which takes in an array of sensors and a capacity indicating the number of sensors in the array. + +### Task + +- Define a function that accepts a pointer to the first element of an array and the arrays capacity. +- Use pointer arithmetic to loop through the sensor array and accumulate the activity readings. +- Return the accumulated activity. + +### Example + +```cpp +pillar_men_sensor sensor_array[3] = {{0}, {101}, {22}}; +int totalActivity = activity_counter(sensor_array, 3); +// totalActivity => 123 +``` + +## 3. Alarm Control (`alarm_control`) + +Not every sensor should trigger an alarm unless there’s real danger. +The `alarm_control` function ensures that a sensor only triggers an alarm if its activity level is greater than 0. +This function should also check for null sensors to prevent system crashes. + +### Task + +- Define a function that accepts the pointer to a `pillar_men_sensor`. +- The function should first check for a `nullptr` sensor. If the sensor is `nullptr`, return `false`. +- If the sensor is valid and its activity is greater than 0, return `true`; otherwise, return `false`. + +### Example + +```cpp +pillar_men_sensor db{9008, "songokunoie", {7, 7, 7}}; +bool alarm = alarm_control(&db); +// alarm => true +``` + +## 4. Checking the data for anomalies with the `uv_alarm` function + +In this task, you will implement the `uv_alarm` function to determine whether an alarm should be triggered based on UV light exposure levels and sensor activity. +The `uv_alarm` function should use the provided `uv_light_heuristic` function, which operates on a vector of data and returns a value based on certain thresholds. +This is a mockup version of the complex code that will run during production, please don't change the interface. + +### Task + +Define the `uv_alarm` function in the `speedywagon` namespace. It should: + +- Take a pointer to a `pillar_men_sensor` _struct_ as its parameter. +- Return `false` if the sensor pointer is null. +- Call the `uv_light_heuristic` function, passing the address of the sensor's `data` array. +- Return `true` if the value returned by `uv_light_heuristic` is greater than the `sensor->activity` level, otherwise return `false`. + +## Wrapping Up + +You’ve been entrusted with an essential task for the Speedywagon Foundation. +By testing for valid sensor connections, counting activity, and implementing alarm controls, you’ve ensured that the Foundation's battle against the Pillar Men can continue uninterrupted. + +As a modern C++ engineer, you’d prefer using smart pointers, but alas, legacy code demands respect for the old ways. +The fate of humanity may rest on these pointers, so proceed carefully, and may the Hamon energy guide you. diff --git a/exercises/concept/speedywagon/.docs/introduction.md b/exercises/concept/speedywagon/.docs/introduction.md new file mode 100644 index 000000000..bd17955ad --- /dev/null +++ b/exercises/concept/speedywagon/.docs/introduction.md @@ -0,0 +1,99 @@ +# Introduction + +Like many other languages, C++ has _pointers_. +You already know _references_ and _pointers_ are similar, but think of them as a level closer to the inner workings of your computer. +_Pointers_ are variables that hold object addresses. +They are used to directly interact with objects, enabling dynamic memory allocation and efficient data manipulation in C++. + +If you're new to _pointers_, they can feel a little mysterious but once you get used to them, they're quite straight-forward. + +They're a crucial part of C++, so take some time to really understand them. +The bare-bone version in this concept is also called _dumb pointer_ or _raw pointer_. +With modern C++ there are also _smart pointers_, the basic type is not smart at all and you have to handle all the work manually. + +Before digging into the details, it's worth understanding the use of _pointers_. +_Pointers_ are a way to share an object's address with other parts of our program, which is useful for two major reasons: +1. Like _references_, pointers avoid copies and help to reduce the resource-footprint of your program. +2. Unlike _references_, pointers can be reassigned to different objects. +3. Pointers can also point to a null value, to indicate, that they currently do not point to any object. + +## General Syntax + +A pointer declaration in C++ involves specifying the data type to which the the pointer is pointing, followed by an asterisk (`*`) and the pointer's name. +When pointers are declared, they are not automatically initialized. +Without explicit assignment, a pointer typically holds an indeterminate value, often referred to as a "garbage address." +While certain compilers might initialize pointers to `nullptr`, this behavior is not guaranteed across all compilers, so it's essential not to rely on it. +It's best practice to explicitly initialize raw pointers and verify their non-null status before utilization to avoid potential issues. + +```cpp +int* ptr{nullptr}; // Declares a pointer and makes sure it is not invalid +``` + +To assign the address of a variable to a pointer, you use the address-of operator (`&`). +Dereferencing a pointer is done using the _indirection operator_ (`*`) operator. + +```cpp +std::string opponent{"Solomon Lane"}; +// 'ethan' points to the address of the string opponent +std::string* ethan{&opponent}; +// Instead of ethan's, the opponent's name address is given to the passPort +std::string passportName{*ethan}; +``` + +Attention: dereferencing has to be done explicitly, while _references_ just worked like an alias. + +## Pointer Arithmetic + +_Pointer arithmetic_ allows you to perform arithmetic operations on pointers, which is particularly useful when working with arrays. +Adding an integer to a pointer makes it point to a different element. + +```cpp +// Stargate addresses +int gateAddresses[] = {462, 753, 218, 611, 977}; +// 'ptr' points to the first element of 'gateAddresses' +int* ptr{gateAddresses}; +// Accesses the third Stargate address through pointer arithmetic +int dialedAddress{*(ptr + 2)}; +// Chevron encoded! Dialing Stargate address: +openStarGate(dialedAddress); +``` + +~~~~exercism/caution +Pointer arithmetic in C++ can easily lead to __undefined behavior__ if not handled carefully. +Undefined behavior can manifest in unexpected program outcomes, crashes, or even security vulnerabilities. +One infamous example of the consequences of undefined behavior occurred in the [explosion of the Ariane 5 rocket][ariane-flight-v88] in 1996, where a software exception caused by the conversion of a 64-bit floating-point number to a 16-bit signed integer led to a catastrophic failure. +~~~~ + +## Accessing member variables + +In C++, the `->` operator is used to access members of an object through a pointer to that object. +It is a shorthand which simplifies accessing members of objects pointed to by pointers. +For instance, if `ptr` is a pointer to an object with a member variable `x`, instead of using `(*ptr).x`, you can directly use `ptr->x`. +This operator enhances code readability and reduces verbosity when working with pointers to objects. + +Here's a brief example, with a _struct_ `Superhero` that has a member variable `superpower`. +The main function creates a pointer `dianaPrince` to a `Superhero` object (representing Wonder Woman). +The `->` operator is used to access the member variable `superpower`, showcasing Wonder Woman's iconic "Lasso of Truth." + +```cpp +struct Superhero { + std::string superpower; +}; + +Superhero* dianaPrince = new Superhero; +dianaPrince->superpower = "Lasso of Truth"; +// Using the -> operator to access member variable superpower: +std::cout << "Wonder Woman, possesses the mighty " << dianaPrince->superpower; +// Memory cleanup: +delete dianaPrince; +``` + +## Pointers vs. references + +Pointers and references both enable indirect access to objects, but they differ in their capabilities and safety considerations. +Pointers offer the flexibility of changing their target object and can be assigned null. +However, this flexibility introduces risks, such as dereferencing null pointers or creating dangling pointers. +References, on the other hand, cannot be null and are bound to valid objects upon creation, avoiding these risks. +Given their safer nature, references should be preferred over pointers unless the additional functionalities provided by pointers are necessary. + +[ariane-flight-v88]: https://en.wikipedia.org/wiki/Ariane_flight_V88 diff --git a/exercises/concept/speedywagon/.docs/introduction.md.tpl b/exercises/concept/speedywagon/.docs/introduction.md.tpl new file mode 100644 index 000000000..288c8554a --- /dev/null +++ b/exercises/concept/speedywagon/.docs/introduction.md.tpl @@ -0,0 +1,3 @@ +# Introduction + +%{concept:pointers} \ No newline at end of file diff --git a/exercises/concept/speedywagon/.meta/config.json b/exercises/concept/speedywagon/.meta/config.json new file mode 100644 index 000000000..1e5531301 --- /dev/null +++ b/exercises/concept/speedywagon/.meta/config.json @@ -0,0 +1,20 @@ +{ + "authors": [ + "vaeng" + ], + "files": { + "solution": [ + "speedywagon.cpp", + "speedywagon.h" + ], + "test": [ + "speedywagon_test.cpp" + ], + "exemplar": [ + ".meta/exemplar.cpp", + ".meta/exemplar.h" + ] + }, + "forked_from": [], + "blurb": "Learn about pointers by writing wrappers for an old library." +} diff --git a/exercises/concept/speedywagon/.meta/design.md b/exercises/concept/speedywagon/.meta/design.md new file mode 100644 index 000000000..bfdc962ed --- /dev/null +++ b/exercises/concept/speedywagon/.meta/design.md @@ -0,0 +1,25 @@ +# Design + +## Goal + +The goal of this exercise is to teach the basics of pointers and how they work in C++. + +## Learning objectives + +- Know how to create a pointer from a variable +- Know how to work with pointers to structs +- Know how to work with array pointers + +## Out of scope + +- Smart pointers + +## Concepts + +The Concepts this exercise unlocks are: + +- `pointers`: how to work with pointers; + +## Prerequisites + +- `classes` diff --git a/exercises/concept/speedywagon/.meta/exemplar.cpp b/exercises/concept/speedywagon/.meta/exemplar.cpp new file mode 100644 index 000000000..214f39ee8 --- /dev/null +++ b/exercises/concept/speedywagon/.meta/exemplar.cpp @@ -0,0 +1,38 @@ +#include "speedywagon.h" + +namespace speedywagon { + +int uv_light_heuristic(std::vector* data_array) { + double avg{}; + for (auto element : *data_array) { + avg += element; + } + avg /= data_array->size(); + int uv_index{}; + for (auto element : *data_array) { + if (element > avg) ++uv_index; + } + return uv_index; +} + +bool connection_check(pillar_men_sensor* sensor) { return sensor != nullptr; } + +int activity_counter(pillar_men_sensor* sensor_array, int capacity) { + int sum{}; + for (int i{}; i < capacity; ++i) { + sum += (sensor_array + i)->activity; + } + return sum; +} + +bool alarm_control(pillar_men_sensor* sensor) { + if (sensor == nullptr) return false; + return sensor->activity > 0; +} + +bool uv_alarm(pillar_men_sensor* sensor) { + if (sensor == nullptr) return false; + return uv_light_heuristic(&(sensor->data)) > sensor->activity; +} + +} // namespace speedywagon diff --git a/exercises/concept/speedywagon/.meta/exemplar.h b/exercises/concept/speedywagon/.meta/exemplar.h new file mode 100644 index 000000000..8dec041fe --- /dev/null +++ b/exercises/concept/speedywagon/.meta/exemplar.h @@ -0,0 +1,24 @@ +#pragma once + +#include +#include + +namespace speedywagon { + +struct pillar_men_sensor { + int activity{}; + std::string location{}; + std::vector data{}; +}; + +int uv_light_heuristic(std::vector* data_array); + +bool connection_check(pillar_men_sensor* sensor); + +int activity_counter(pillar_men_sensor* sensor_array, int capacity); + +bool alarm_control(pillar_men_sensor* sensor); + +bool uv_alarm(pillar_men_sensor* sensor); + +} // namespace speedywagon diff --git a/exercises/concept/speedywagon/CMakeLists.txt b/exercises/concept/speedywagon/CMakeLists.txt new file mode 100644 index 000000000..3b0589fd0 --- /dev/null +++ b/exercises/concept/speedywagon/CMakeLists.txt @@ -0,0 +1,64 @@ +# Get the exercise name from the current directory +get_filename_component(exercise ${CMAKE_CURRENT_SOURCE_DIR} NAME) + +# Basic CMake project +cmake_minimum_required(VERSION 3.5.1) + +# Name the project after the exercise +project(${exercise} CXX) + +# Get a source filename from the exercise name by replacing -'s with _'s +string(REPLACE "-" "_" file ${exercise}) + +# Implementation could be only a header +if(EXISTS ${CMAKE_CURRENT_SOURCE_DIR}/${file}.cpp) + set(exercise_cpp ${file}.cpp) +else() + set(exercise_cpp "") +endif() + +# Use the common Catch library? +if(EXERCISM_COMMON_CATCH) + # For Exercism track development only + add_executable(${exercise} ${file}_test.cpp ${exercise_cpp} ${file}.h $) +elseif(EXERCISM_TEST_SUITE) + # The Exercism test suite is being run, the Docker image already + # includes a pre-built version of Catch. + find_package(Catch2 REQUIRED) + add_executable(${exercise} ${file}_test.cpp ${exercise_cpp} ${file}.h) + target_link_libraries(${exercise} PRIVATE Catch2::Catch2WithMain) + # When Catch is installed system wide we need to include a different + # header, we need this define to use the correct one. + target_compile_definitions(${exercise} PRIVATE EXERCISM_TEST_SUITE) +else() + # Build executable from sources and headers + add_executable(${exercise} ${file}_test.cpp ${exercise_cpp} ${file}.h test/tests-main.cpp) +endif() + +set_target_properties(${exercise} PROPERTIES + CXX_STANDARD 17 + CXX_STANDARD_REQUIRED OFF + CXX_EXTENSIONS OFF +) + +set(CMAKE_BUILD_TYPE Debug) + +if("${CMAKE_CXX_COMPILER_ID}" MATCHES "(GNU|Clang)") + set_target_properties(${exercise} PROPERTIES + COMPILE_FLAGS "-Wall -Wextra -Wpedantic -Werror" + ) +endif() + +# Configure to run all the tests? +if(${EXERCISM_RUN_ALL_TESTS}) + target_compile_definitions(${exercise} PRIVATE EXERCISM_RUN_ALL_TESTS) +endif() + +# Tell MSVC not to warn us about unchecked iterators in debug builds +if(${MSVC}) + set_target_properties(${exercise} PROPERTIES + COMPILE_DEFINITIONS_DEBUG _SCL_SECURE_NO_WARNINGS) +endif() + +# Run the tests on every build +add_custom_target(test_${exercise} ALL DEPENDS ${exercise} COMMAND ${exercise}) diff --git a/exercises/concept/speedywagon/speedywagon.cpp b/exercises/concept/speedywagon/speedywagon.cpp new file mode 100644 index 000000000..a1cc1f2c4 --- /dev/null +++ b/exercises/concept/speedywagon/speedywagon.cpp @@ -0,0 +1,21 @@ +#include "speedywagon.h" + +namespace speedywagon { + +// Enter your code below: + +// Please don't change the interface of the uv_light_heuristic function +int uv_light_heuristic(std::vector* data_array) { + double avg{}; + for (auto element : *data_array) { + avg += element; + } + avg /= data_array->size(); + int uv_index{}; + for (auto element : *data_array) { + if (element > avg) ++uv_index; + } + return uv_index; +} + +} // namespace speedywagon diff --git a/exercises/concept/speedywagon/speedywagon.h b/exercises/concept/speedywagon/speedywagon.h new file mode 100644 index 000000000..b6909b44d --- /dev/null +++ b/exercises/concept/speedywagon/speedywagon.h @@ -0,0 +1,16 @@ +#pragma once + +#include +#include + +namespace speedywagon { + +struct pillar_men_sensor { + int activity{}; + std::string location{}; + std::vector data{}; +}; + +int uv_light_heuristic(std::vector* data_array); + +} // namespace speedywagon diff --git a/exercises/concept/speedywagon/speedywagon_test.cpp b/exercises/concept/speedywagon/speedywagon_test.cpp new file mode 100644 index 000000000..6d3f1f34a --- /dev/null +++ b/exercises/concept/speedywagon/speedywagon_test.cpp @@ -0,0 +1,61 @@ +#include "speedywagon.h" +#ifdef EXERCISM_TEST_SUITE +#include +#else +#include "test/catch.hpp" +#endif + +TEST_CASE("connection_check: test for nullptr", "[task_1]") { + speedywagon::pillar_men_sensor* nothing_connected{nullptr}; + REQUIRE_FALSE(speedywagon::connection_check(nothing_connected)); +} + +#if defined(EXERCISM_RUN_ALL_TESTS) + +TEST_CASE("connection_check: test for connected sensor", "[task_1]") { + speedywagon::pillar_men_sensor active_sensor{42, "colloseum", {}}; + REQUIRE(speedywagon::connection_check(&active_sensor)); +} + +TEST_CASE("activity_counter: sum for three nullptr", "[task_2]") { + speedywagon::pillar_men_sensor rome[3]{}; + REQUIRE(speedywagon::activity_counter(&rome[0], 3) == 0); +} + +TEST_CASE("activity_counter: sum for two with real data", "[task_2]") { + speedywagon::pillar_men_sensor rome[2]{{4900, "kars", {}}, + {4102, "wham", {}}}; + REQUIRE(speedywagon::activity_counter(&rome[0], 2) == 9002); +} + +TEST_CASE("activity_counter: sum for a nullptr", "[task_2]") { + speedywagon::pillar_men_sensor rome[2]{{4900, "kars", {}}, + {4102, "wham", {}}}; + REQUIRE(speedywagon::activity_counter(nullptr, 0) == 0); +} + +TEST_CASE("alarm_control: works correctly for pointer", "[task_3") { + speedywagon::pillar_men_sensor* kars_in_space{nullptr}; + REQUIRE_FALSE(speedywagon::alarm_control(kars_in_space)); +} + +TEST_CASE("alarm_control: works correctly for nullptr", "[task_3]") { + speedywagon::pillar_men_sensor santana{0, "Mexico", {1981, 1987}}; + REQUIRE_FALSE(speedywagon::alarm_control(&santana)); + santana.activity = 9002; + REQUIRE(speedywagon::alarm_control(&santana)); +} + +TEST_CASE("uv_alarm: works correctly for nullptr", "[task_4]") { + speedywagon::pillar_men_sensor* wham{nullptr}; + REQUIRE_FALSE(speedywagon::uv_alarm(wham)); +} + +TEST_CASE("uv_alarm: works correctly with mock data", "[task_4]") { + speedywagon::pillar_men_sensor wham{0, "Rome", {1, 605, 313, 4000}}; + REQUIRE(speedywagon::uv_alarm(&wham)); + wham.activity = 9001; + REQUIRE_FALSE(speedywagon::uv_alarm(&wham)); +} + +#endif diff --git a/exercises/concept/speedywagon/test/catch.hpp b/exercises/concept/speedywagon/test/catch.hpp new file mode 100644 index 000000000..36eaeb27f --- /dev/null +++ b/exercises/concept/speedywagon/test/catch.hpp @@ -0,0 +1,17937 @@ +/* + * Catch v2.13.6 + * Generated: 2021-04-16 18:23:38.044268 + * ---------------------------------------------------------- + * This file has been merged from multiple headers. Please don't edit it directly + * Copyright (c) 2021 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_SINGLE_INCLUDE_CATCH_HPP_INCLUDED +#define TWOBLUECUBES_SINGLE_INCLUDE_CATCH_HPP_INCLUDED +// start catch.hpp + + +#define CATCH_VERSION_MAJOR 2 +#define CATCH_VERSION_MINOR 13 +#define CATCH_VERSION_PATCH 6 + +#ifdef __clang__ +# pragma clang system_header +#elif defined __GNUC__ +# pragma GCC system_header +#endif + +// start catch_suppress_warnings.h + +#ifdef __clang__ +# ifdef __ICC // icpc defines the __clang__ macro +# pragma warning(push) +# pragma warning(disable: 161 1682) +# else // __ICC +# pragma clang diagnostic push +# pragma clang diagnostic ignored "-Wpadded" +# pragma clang diagnostic ignored "-Wswitch-enum" +# pragma clang diagnostic ignored "-Wcovered-switch-default" +# endif +#elif defined __GNUC__ + // Because REQUIREs trigger GCC's -Wparentheses, and because still + // supported version of g++ have only buggy support for _Pragmas, + // Wparentheses have to be suppressed globally. +# pragma GCC diagnostic ignored "-Wparentheses" // See #674 for details + +# pragma GCC diagnostic push +# pragma GCC diagnostic ignored "-Wunused-variable" +# pragma GCC diagnostic ignored "-Wpadded" +#endif +// end catch_suppress_warnings.h +#if defined(CATCH_CONFIG_MAIN) || defined(CATCH_CONFIG_RUNNER) +# define CATCH_IMPL +# define CATCH_CONFIG_ALL_PARTS +#endif + +// In the impl file, we want to have access to all parts of the headers +// Can also be used to sanely support PCHs +#if defined(CATCH_CONFIG_ALL_PARTS) +# define CATCH_CONFIG_EXTERNAL_INTERFACES +# if defined(CATCH_CONFIG_DISABLE_MATCHERS) +# undef CATCH_CONFIG_DISABLE_MATCHERS +# endif +# if !defined(CATCH_CONFIG_ENABLE_CHRONO_STRINGMAKER) +# define CATCH_CONFIG_ENABLE_CHRONO_STRINGMAKER +# endif +#endif + +#if !defined(CATCH_CONFIG_IMPL_ONLY) +// start catch_platform.h + +// See e.g.: +// https://opensource.apple.com/source/CarbonHeaders/CarbonHeaders-18.1/TargetConditionals.h.auto.html +#ifdef __APPLE__ +# include +# if (defined(TARGET_OS_OSX) && TARGET_OS_OSX == 1) || \ + (defined(TARGET_OS_MAC) && TARGET_OS_MAC == 1) +# define CATCH_PLATFORM_MAC +# elif (defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE == 1) +# define CATCH_PLATFORM_IPHONE +# endif + +#elif defined(linux) || defined(__linux) || defined(__linux__) +# define CATCH_PLATFORM_LINUX + +#elif defined(WIN32) || defined(__WIN32__) || defined(_WIN32) || defined(_MSC_VER) || defined(__MINGW32__) +# define CATCH_PLATFORM_WINDOWS +#endif + +// end catch_platform.h + +#ifdef CATCH_IMPL +# ifndef CLARA_CONFIG_MAIN +# define CLARA_CONFIG_MAIN_NOT_DEFINED +# define CLARA_CONFIG_MAIN +# endif +#endif + +// start catch_user_interfaces.h + +namespace Catch { + unsigned int rngSeed(); +} + +// end catch_user_interfaces.h +// start catch_tag_alias_autoregistrar.h + +// start catch_common.h + +// start catch_compiler_capabilities.h + +// Detect a number of compiler features - by compiler +// The following features are defined: +// +// CATCH_CONFIG_COUNTER : is the __COUNTER__ macro supported? +// CATCH_CONFIG_WINDOWS_SEH : is Windows SEH supported? +// CATCH_CONFIG_POSIX_SIGNALS : are POSIX signals supported? +// CATCH_CONFIG_DISABLE_EXCEPTIONS : Are exceptions enabled? +// **************** +// Note to maintainers: if new toggles are added please document them +// in configuration.md, too +// **************** + +// In general each macro has a _NO_ form +// (e.g. CATCH_CONFIG_NO_POSIX_SIGNALS) which disables the feature. +// Many features, at point of detection, define an _INTERNAL_ macro, so they +// can be combined, en-mass, with the _NO_ forms later. + +#ifdef __cplusplus + +# if (__cplusplus >= 201402L) || (defined(_MSVC_LANG) && _MSVC_LANG >= 201402L) +# define CATCH_CPP14_OR_GREATER +# endif + +# if (__cplusplus >= 201703L) || (defined(_MSVC_LANG) && _MSVC_LANG >= 201703L) +# define CATCH_CPP17_OR_GREATER +# endif + +#endif + +// Only GCC compiler should be used in this block, so other compilers trying to +// mask themselves as GCC should be ignored. +#if defined(__GNUC__) && !defined(__clang__) && !defined(__ICC) && !defined(__CUDACC__) && !defined(__LCC__) +# define CATCH_INTERNAL_START_WARNINGS_SUPPRESSION _Pragma( "GCC diagnostic push" ) +# define CATCH_INTERNAL_STOP_WARNINGS_SUPPRESSION _Pragma( "GCC diagnostic pop" ) + +# define CATCH_INTERNAL_IGNORE_BUT_WARN(...) (void)__builtin_constant_p(__VA_ARGS__) + +#endif + +#if defined(__clang__) + +# define CATCH_INTERNAL_START_WARNINGS_SUPPRESSION _Pragma( "clang diagnostic push" ) +# define CATCH_INTERNAL_STOP_WARNINGS_SUPPRESSION _Pragma( "clang diagnostic pop" ) + +// As of this writing, IBM XL's implementation of __builtin_constant_p has a bug +// which results in calls to destructors being emitted for each temporary, +// without a matching initialization. In practice, this can result in something +// like `std::string::~string` being called on an uninitialized value. +// +// For example, this code will likely segfault under IBM XL: +// ``` +// REQUIRE(std::string("12") + "34" == "1234") +// ``` +// +// Therefore, `CATCH_INTERNAL_IGNORE_BUT_WARN` is not implemented. +# if !defined(__ibmxl__) && !defined(__CUDACC__) +# define CATCH_INTERNAL_IGNORE_BUT_WARN(...) (void)__builtin_constant_p(__VA_ARGS__) /* NOLINT(cppcoreguidelines-pro-type-vararg, hicpp-vararg) */ +# endif + +# define CATCH_INTERNAL_SUPPRESS_GLOBALS_WARNINGS \ + _Pragma( "clang diagnostic ignored \"-Wexit-time-destructors\"" ) \ + _Pragma( "clang diagnostic ignored \"-Wglobal-constructors\"") + +# define CATCH_INTERNAL_SUPPRESS_PARENTHESES_WARNINGS \ + _Pragma( "clang diagnostic ignored \"-Wparentheses\"" ) + +# define CATCH_INTERNAL_SUPPRESS_UNUSED_WARNINGS \ + _Pragma( "clang diagnostic ignored \"-Wunused-variable\"" ) + +# define CATCH_INTERNAL_SUPPRESS_ZERO_VARIADIC_WARNINGS \ + _Pragma( "clang diagnostic ignored \"-Wgnu-zero-variadic-macro-arguments\"" ) + +# define CATCH_INTERNAL_SUPPRESS_UNUSED_TEMPLATE_WARNINGS \ + _Pragma( "clang diagnostic ignored \"-Wunused-template\"" ) + +#endif // __clang__ + +//////////////////////////////////////////////////////////////////////////////// +// Assume that non-Windows platforms support posix signals by default +#if !defined(CATCH_PLATFORM_WINDOWS) + #define CATCH_INTERNAL_CONFIG_POSIX_SIGNALS +#endif + +//////////////////////////////////////////////////////////////////////////////// +// We know some environments not to support full POSIX signals +#if defined(__CYGWIN__) || defined(__QNX__) || defined(__EMSCRIPTEN__) || defined(__DJGPP__) + #define CATCH_INTERNAL_CONFIG_NO_POSIX_SIGNALS +#endif + +#ifdef __OS400__ +# define CATCH_INTERNAL_CONFIG_NO_POSIX_SIGNALS +# define CATCH_CONFIG_COLOUR_NONE +#endif + +//////////////////////////////////////////////////////////////////////////////// +// Android somehow still does not support std::to_string +#if defined(__ANDROID__) +# define CATCH_INTERNAL_CONFIG_NO_CPP11_TO_STRING +# define CATCH_INTERNAL_CONFIG_ANDROID_LOGWRITE +#endif + +//////////////////////////////////////////////////////////////////////////////// +// Not all Windows environments support SEH properly +#if defined(__MINGW32__) +# define CATCH_INTERNAL_CONFIG_NO_WINDOWS_SEH +#endif + +//////////////////////////////////////////////////////////////////////////////// +// PS4 +#if defined(__ORBIS__) +# define CATCH_INTERNAL_CONFIG_NO_NEW_CAPTURE +#endif + +//////////////////////////////////////////////////////////////////////////////// +// Cygwin +#ifdef __CYGWIN__ + +// Required for some versions of Cygwin to declare gettimeofday +// see: http://stackoverflow.com/questions/36901803/gettimeofday-not-declared-in-this-scope-cygwin +# define _BSD_SOURCE +// some versions of cygwin (most) do not support std::to_string. Use the libstd check. +// https://gcc.gnu.org/onlinedocs/gcc-4.8.2/libstdc++/api/a01053_source.html line 2812-2813 +# if !((__cplusplus >= 201103L) && defined(_GLIBCXX_USE_C99) \ + && !defined(_GLIBCXX_HAVE_BROKEN_VSWPRINTF)) + +# define CATCH_INTERNAL_CONFIG_NO_CPP11_TO_STRING + +# endif +#endif // __CYGWIN__ + +//////////////////////////////////////////////////////////////////////////////// +// Visual C++ +#if defined(_MSC_VER) + +# define CATCH_INTERNAL_START_WARNINGS_SUPPRESSION __pragma( warning(push) ) +# define CATCH_INTERNAL_STOP_WARNINGS_SUPPRESSION __pragma( warning(pop) ) + +// Universal Windows platform does not support SEH +// Or console colours (or console at all...) +# if defined(WINAPI_FAMILY) && (WINAPI_FAMILY == WINAPI_FAMILY_APP) +# define CATCH_CONFIG_COLOUR_NONE +# else +# define CATCH_INTERNAL_CONFIG_WINDOWS_SEH +# endif + +// MSVC traditional preprocessor needs some workaround for __VA_ARGS__ +// _MSVC_TRADITIONAL == 0 means new conformant preprocessor +// _MSVC_TRADITIONAL == 1 means old traditional non-conformant preprocessor +# if !defined(__clang__) // Handle Clang masquerading for msvc +# if !defined(_MSVC_TRADITIONAL) || (defined(_MSVC_TRADITIONAL) && _MSVC_TRADITIONAL) +# define CATCH_INTERNAL_CONFIG_TRADITIONAL_MSVC_PREPROCESSOR +# endif // MSVC_TRADITIONAL +# endif // __clang__ + +#endif // _MSC_VER + +#if defined(_REENTRANT) || defined(_MSC_VER) +// Enable async processing, as -pthread is specified or no additional linking is required +# define CATCH_INTERNAL_CONFIG_USE_ASYNC +#endif // _MSC_VER + +//////////////////////////////////////////////////////////////////////////////// +// Check if we are compiled with -fno-exceptions or equivalent +#if defined(__EXCEPTIONS) || defined(__cpp_exceptions) || defined(_CPPUNWIND) +# define CATCH_INTERNAL_CONFIG_EXCEPTIONS_ENABLED +#endif + +//////////////////////////////////////////////////////////////////////////////// +// DJGPP +#ifdef __DJGPP__ +# define CATCH_INTERNAL_CONFIG_NO_WCHAR +#endif // __DJGPP__ + +//////////////////////////////////////////////////////////////////////////////// +// Embarcadero C++Build +#if defined(__BORLANDC__) + #define CATCH_INTERNAL_CONFIG_POLYFILL_ISNAN +#endif + +//////////////////////////////////////////////////////////////////////////////// + +// Use of __COUNTER__ is suppressed during code analysis in +// CLion/AppCode 2017.2.x and former, because __COUNTER__ is not properly +// handled by it. +// Otherwise all supported compilers support COUNTER macro, +// but user still might want to turn it off +#if ( !defined(__JETBRAINS_IDE__) || __JETBRAINS_IDE__ >= 20170300L ) + #define CATCH_INTERNAL_CONFIG_COUNTER +#endif + +//////////////////////////////////////////////////////////////////////////////// + +// RTX is a special version of Windows that is real time. +// This means that it is detected as Windows, but does not provide +// the same set of capabilities as real Windows does. +#if defined(UNDER_RTSS) || defined(RTX64_BUILD) + #define CATCH_INTERNAL_CONFIG_NO_WINDOWS_SEH + #define CATCH_INTERNAL_CONFIG_NO_ASYNC + #define CATCH_CONFIG_COLOUR_NONE +#endif + +#if !defined(_GLIBCXX_USE_C99_MATH_TR1) +#define CATCH_INTERNAL_CONFIG_GLOBAL_NEXTAFTER +#endif + +// Various stdlib support checks that require __has_include +#if defined(__has_include) + // Check if string_view is available and usable + #if __has_include() && defined(CATCH_CPP17_OR_GREATER) + # define CATCH_INTERNAL_CONFIG_CPP17_STRING_VIEW + #endif + + // Check if optional is available and usable + # if __has_include() && defined(CATCH_CPP17_OR_GREATER) + # define CATCH_INTERNAL_CONFIG_CPP17_OPTIONAL + # endif // __has_include() && defined(CATCH_CPP17_OR_GREATER) + + // Check if byte is available and usable + # if __has_include() && defined(CATCH_CPP17_OR_GREATER) + # include + # if __cpp_lib_byte > 0 + # define CATCH_INTERNAL_CONFIG_CPP17_BYTE + # endif + # endif // __has_include() && defined(CATCH_CPP17_OR_GREATER) + + // Check if variant is available and usable + # if __has_include() && defined(CATCH_CPP17_OR_GREATER) + # if defined(__clang__) && (__clang_major__ < 8) + // work around clang bug with libstdc++ https://bugs.llvm.org/show_bug.cgi?id=31852 + // fix should be in clang 8, workaround in libstdc++ 8.2 + # include + # if defined(__GLIBCXX__) && defined(_GLIBCXX_RELEASE) && (_GLIBCXX_RELEASE < 9) + # define CATCH_CONFIG_NO_CPP17_VARIANT + # else + # define CATCH_INTERNAL_CONFIG_CPP17_VARIANT + # endif // defined(__GLIBCXX__) && defined(_GLIBCXX_RELEASE) && (_GLIBCXX_RELEASE < 9) + # else + # define CATCH_INTERNAL_CONFIG_CPP17_VARIANT + # endif // defined(__clang__) && (__clang_major__ < 8) + # endif // __has_include() && defined(CATCH_CPP17_OR_GREATER) +#endif // defined(__has_include) + +#if defined(CATCH_INTERNAL_CONFIG_COUNTER) && !defined(CATCH_CONFIG_NO_COUNTER) && !defined(CATCH_CONFIG_COUNTER) +# define CATCH_CONFIG_COUNTER +#endif +#if defined(CATCH_INTERNAL_CONFIG_WINDOWS_SEH) && !defined(CATCH_CONFIG_NO_WINDOWS_SEH) && !defined(CATCH_CONFIG_WINDOWS_SEH) && !defined(CATCH_INTERNAL_CONFIG_NO_WINDOWS_SEH) +# define CATCH_CONFIG_WINDOWS_SEH +#endif +// This is set by default, because we assume that unix compilers are posix-signal-compatible by default. +#if defined(CATCH_INTERNAL_CONFIG_POSIX_SIGNALS) && !defined(CATCH_INTERNAL_CONFIG_NO_POSIX_SIGNALS) && !defined(CATCH_CONFIG_NO_POSIX_SIGNALS) && !defined(CATCH_CONFIG_POSIX_SIGNALS) +# define CATCH_CONFIG_POSIX_SIGNALS +#endif +// This is set by default, because we assume that compilers with no wchar_t support are just rare exceptions. +#if !defined(CATCH_INTERNAL_CONFIG_NO_WCHAR) && !defined(CATCH_CONFIG_NO_WCHAR) && !defined(CATCH_CONFIG_WCHAR) +# define CATCH_CONFIG_WCHAR +#endif + +#if !defined(CATCH_INTERNAL_CONFIG_NO_CPP11_TO_STRING) && !defined(CATCH_CONFIG_NO_CPP11_TO_STRING) && !defined(CATCH_CONFIG_CPP11_TO_STRING) +# define CATCH_CONFIG_CPP11_TO_STRING +#endif + +#if defined(CATCH_INTERNAL_CONFIG_CPP17_OPTIONAL) && !defined(CATCH_CONFIG_NO_CPP17_OPTIONAL) && !defined(CATCH_CONFIG_CPP17_OPTIONAL) +# define CATCH_CONFIG_CPP17_OPTIONAL +#endif + +#if defined(CATCH_INTERNAL_CONFIG_CPP17_STRING_VIEW) && !defined(CATCH_CONFIG_NO_CPP17_STRING_VIEW) && !defined(CATCH_CONFIG_CPP17_STRING_VIEW) +# define CATCH_CONFIG_CPP17_STRING_VIEW +#endif + +#if defined(CATCH_INTERNAL_CONFIG_CPP17_VARIANT) && !defined(CATCH_CONFIG_NO_CPP17_VARIANT) && !defined(CATCH_CONFIG_CPP17_VARIANT) +# define CATCH_CONFIG_CPP17_VARIANT +#endif + +#if defined(CATCH_INTERNAL_CONFIG_CPP17_BYTE) && !defined(CATCH_CONFIG_NO_CPP17_BYTE) && !defined(CATCH_CONFIG_CPP17_BYTE) +# define CATCH_CONFIG_CPP17_BYTE +#endif + +#if defined(CATCH_CONFIG_EXPERIMENTAL_REDIRECT) +# define CATCH_INTERNAL_CONFIG_NEW_CAPTURE +#endif + +#if defined(CATCH_INTERNAL_CONFIG_NEW_CAPTURE) && !defined(CATCH_INTERNAL_CONFIG_NO_NEW_CAPTURE) && !defined(CATCH_CONFIG_NO_NEW_CAPTURE) && !defined(CATCH_CONFIG_NEW_CAPTURE) +# define CATCH_CONFIG_NEW_CAPTURE +#endif + +#if !defined(CATCH_INTERNAL_CONFIG_EXCEPTIONS_ENABLED) && !defined(CATCH_CONFIG_DISABLE_EXCEPTIONS) +# define CATCH_CONFIG_DISABLE_EXCEPTIONS +#endif + +#if defined(CATCH_INTERNAL_CONFIG_POLYFILL_ISNAN) && !defined(CATCH_CONFIG_NO_POLYFILL_ISNAN) && !defined(CATCH_CONFIG_POLYFILL_ISNAN) +# define CATCH_CONFIG_POLYFILL_ISNAN +#endif + +#if defined(CATCH_INTERNAL_CONFIG_USE_ASYNC) && !defined(CATCH_INTERNAL_CONFIG_NO_ASYNC) && !defined(CATCH_CONFIG_NO_USE_ASYNC) && !defined(CATCH_CONFIG_USE_ASYNC) +# define CATCH_CONFIG_USE_ASYNC +#endif + +#if defined(CATCH_INTERNAL_CONFIG_ANDROID_LOGWRITE) && !defined(CATCH_CONFIG_NO_ANDROID_LOGWRITE) && !defined(CATCH_CONFIG_ANDROID_LOGWRITE) +# define CATCH_CONFIG_ANDROID_LOGWRITE +#endif + +#if defined(CATCH_INTERNAL_CONFIG_GLOBAL_NEXTAFTER) && !defined(CATCH_CONFIG_NO_GLOBAL_NEXTAFTER) && !defined(CATCH_CONFIG_GLOBAL_NEXTAFTER) +# define CATCH_CONFIG_GLOBAL_NEXTAFTER +#endif + +// Even if we do not think the compiler has that warning, we still have +// to provide a macro that can be used by the code. +#if !defined(CATCH_INTERNAL_START_WARNINGS_SUPPRESSION) +# define CATCH_INTERNAL_START_WARNINGS_SUPPRESSION +#endif +#if !defined(CATCH_INTERNAL_STOP_WARNINGS_SUPPRESSION) +# define CATCH_INTERNAL_STOP_WARNINGS_SUPPRESSION +#endif +#if !defined(CATCH_INTERNAL_SUPPRESS_PARENTHESES_WARNINGS) +# define CATCH_INTERNAL_SUPPRESS_PARENTHESES_WARNINGS +#endif +#if !defined(CATCH_INTERNAL_SUPPRESS_GLOBALS_WARNINGS) +# define CATCH_INTERNAL_SUPPRESS_GLOBALS_WARNINGS +#endif +#if !defined(CATCH_INTERNAL_SUPPRESS_UNUSED_WARNINGS) +# define CATCH_INTERNAL_SUPPRESS_UNUSED_WARNINGS +#endif +#if !defined(CATCH_INTERNAL_SUPPRESS_ZERO_VARIADIC_WARNINGS) +# define CATCH_INTERNAL_SUPPRESS_ZERO_VARIADIC_WARNINGS +#endif + +// The goal of this macro is to avoid evaluation of the arguments, but +// still have the compiler warn on problems inside... +#if !defined(CATCH_INTERNAL_IGNORE_BUT_WARN) +# define CATCH_INTERNAL_IGNORE_BUT_WARN(...) +#endif + +#if defined(__APPLE__) && defined(__apple_build_version__) && (__clang_major__ < 10) +# undef CATCH_INTERNAL_SUPPRESS_UNUSED_TEMPLATE_WARNINGS +#elif defined(__clang__) && (__clang_major__ < 5) +# undef CATCH_INTERNAL_SUPPRESS_UNUSED_TEMPLATE_WARNINGS +#endif + +#if !defined(CATCH_INTERNAL_SUPPRESS_UNUSED_TEMPLATE_WARNINGS) +# define CATCH_INTERNAL_SUPPRESS_UNUSED_TEMPLATE_WARNINGS +#endif + +#if defined(CATCH_CONFIG_DISABLE_EXCEPTIONS) +#define CATCH_TRY if ((true)) +#define CATCH_CATCH_ALL if ((false)) +#define CATCH_CATCH_ANON(type) if ((false)) +#else +#define CATCH_TRY try +#define CATCH_CATCH_ALL catch (...) +#define CATCH_CATCH_ANON(type) catch (type) +#endif + +#if defined(CATCH_INTERNAL_CONFIG_TRADITIONAL_MSVC_PREPROCESSOR) && !defined(CATCH_CONFIG_NO_TRADITIONAL_MSVC_PREPROCESSOR) && !defined(CATCH_CONFIG_TRADITIONAL_MSVC_PREPROCESSOR) +#define CATCH_CONFIG_TRADITIONAL_MSVC_PREPROCESSOR +#endif + +// end catch_compiler_capabilities.h +#define INTERNAL_CATCH_UNIQUE_NAME_LINE2( name, line ) name##line +#define INTERNAL_CATCH_UNIQUE_NAME_LINE( name, line ) INTERNAL_CATCH_UNIQUE_NAME_LINE2( name, line ) +#ifdef CATCH_CONFIG_COUNTER +# define INTERNAL_CATCH_UNIQUE_NAME( name ) INTERNAL_CATCH_UNIQUE_NAME_LINE( name, __COUNTER__ ) +#else +# define INTERNAL_CATCH_UNIQUE_NAME( name ) INTERNAL_CATCH_UNIQUE_NAME_LINE( name, __LINE__ ) +#endif + +#include +#include +#include + +// We need a dummy global operator<< so we can bring it into Catch namespace later +struct Catch_global_namespace_dummy {}; +std::ostream& operator<<(std::ostream&, Catch_global_namespace_dummy); + +namespace Catch { + + struct CaseSensitive { enum Choice { + Yes, + No + }; }; + + class NonCopyable { + NonCopyable( NonCopyable const& ) = delete; + NonCopyable( NonCopyable && ) = delete; + NonCopyable& operator = ( NonCopyable const& ) = delete; + NonCopyable& operator = ( NonCopyable && ) = delete; + + protected: + NonCopyable(); + virtual ~NonCopyable(); + }; + + struct SourceLineInfo { + + SourceLineInfo() = delete; + SourceLineInfo( char const* _file, std::size_t _line ) noexcept + : file( _file ), + line( _line ) + {} + + SourceLineInfo( SourceLineInfo const& other ) = default; + SourceLineInfo& operator = ( SourceLineInfo const& ) = default; + SourceLineInfo( SourceLineInfo&& ) noexcept = default; + SourceLineInfo& operator = ( SourceLineInfo&& ) noexcept = default; + + bool empty() const noexcept { return file[0] == '\0'; } + bool operator == ( SourceLineInfo const& other ) const noexcept; + bool operator < ( SourceLineInfo const& other ) const noexcept; + + char const* file; + std::size_t line; + }; + + std::ostream& operator << ( std::ostream& os, SourceLineInfo const& info ); + + // Bring in operator<< from global namespace into Catch namespace + // This is necessary because the overload of operator<< above makes + // lookup stop at namespace Catch + using ::operator<<; + + // Use this in variadic streaming macros to allow + // >> +StreamEndStop + // as well as + // >> stuff +StreamEndStop + struct StreamEndStop { + std::string operator+() const; + }; + template + T const& operator + ( T const& value, StreamEndStop ) { + return value; + } +} + +#define CATCH_INTERNAL_LINEINFO \ + ::Catch::SourceLineInfo( __FILE__, static_cast( __LINE__ ) ) + +// end catch_common.h +namespace Catch { + + struct RegistrarForTagAliases { + RegistrarForTagAliases( char const* alias, char const* tag, SourceLineInfo const& lineInfo ); + }; + +} // end namespace Catch + +#define CATCH_REGISTER_TAG_ALIAS( alias, spec ) \ + CATCH_INTERNAL_START_WARNINGS_SUPPRESSION \ + CATCH_INTERNAL_SUPPRESS_GLOBALS_WARNINGS \ + namespace{ Catch::RegistrarForTagAliases INTERNAL_CATCH_UNIQUE_NAME( AutoRegisterTagAlias )( alias, spec, CATCH_INTERNAL_LINEINFO ); } \ + CATCH_INTERNAL_STOP_WARNINGS_SUPPRESSION + +// end catch_tag_alias_autoregistrar.h +// start catch_test_registry.h + +// start catch_interfaces_testcase.h + +#include + +namespace Catch { + + class TestSpec; + + struct ITestInvoker { + virtual void invoke () const = 0; + virtual ~ITestInvoker(); + }; + + class TestCase; + struct IConfig; + + struct ITestCaseRegistry { + virtual ~ITestCaseRegistry(); + virtual std::vector const& getAllTests() const = 0; + virtual std::vector const& getAllTestsSorted( IConfig const& config ) const = 0; + }; + + bool isThrowSafe( TestCase const& testCase, IConfig const& config ); + bool matchTest( TestCase const& testCase, TestSpec const& testSpec, IConfig const& config ); + std::vector filterTests( std::vector const& testCases, TestSpec const& testSpec, IConfig const& config ); + std::vector const& getAllTestCasesSorted( IConfig const& config ); + +} + +// end catch_interfaces_testcase.h +// start catch_stringref.h + +#include +#include +#include +#include + +namespace Catch { + + /// A non-owning string class (similar to the forthcoming std::string_view) + /// Note that, because a StringRef may be a substring of another string, + /// it may not be null terminated. + class StringRef { + public: + using size_type = std::size_t; + using const_iterator = const char*; + + private: + static constexpr char const* const s_empty = ""; + + char const* m_start = s_empty; + size_type m_size = 0; + + public: // construction + constexpr StringRef() noexcept = default; + + StringRef( char const* rawChars ) noexcept; + + constexpr StringRef( char const* rawChars, size_type size ) noexcept + : m_start( rawChars ), + m_size( size ) + {} + + StringRef( std::string const& stdString ) noexcept + : m_start( stdString.c_str() ), + m_size( stdString.size() ) + {} + + explicit operator std::string() const { + return std::string(m_start, m_size); + } + + public: // operators + auto operator == ( StringRef const& other ) const noexcept -> bool; + auto operator != (StringRef const& other) const noexcept -> bool { + return !(*this == other); + } + + auto operator[] ( size_type index ) const noexcept -> char { + assert(index < m_size); + return m_start[index]; + } + + public: // named queries + constexpr auto empty() const noexcept -> bool { + return m_size == 0; + } + constexpr auto size() const noexcept -> size_type { + return m_size; + } + + // Returns the current start pointer. If the StringRef is not + // null-terminated, throws std::domain_exception + auto c_str() const -> char const*; + + public: // substrings and searches + // Returns a substring of [start, start + length). + // If start + length > size(), then the substring is [start, size()). + // If start > size(), then the substring is empty. + auto substr( size_type start, size_type length ) const noexcept -> StringRef; + + // Returns the current start pointer. May not be null-terminated. + auto data() const noexcept -> char const*; + + constexpr auto isNullTerminated() const noexcept -> bool { + return m_start[m_size] == '\0'; + } + + public: // iterators + constexpr const_iterator begin() const { return m_start; } + constexpr const_iterator end() const { return m_start + m_size; } + }; + + auto operator += ( std::string& lhs, StringRef const& sr ) -> std::string&; + auto operator << ( std::ostream& os, StringRef const& sr ) -> std::ostream&; + + constexpr auto operator "" _sr( char const* rawChars, std::size_t size ) noexcept -> StringRef { + return StringRef( rawChars, size ); + } +} // namespace Catch + +constexpr auto operator "" _catch_sr( char const* rawChars, std::size_t size ) noexcept -> Catch::StringRef { + return Catch::StringRef( rawChars, size ); +} + +// end catch_stringref.h +// start catch_preprocessor.hpp + + +#define CATCH_RECURSION_LEVEL0(...) __VA_ARGS__ +#define CATCH_RECURSION_LEVEL1(...) CATCH_RECURSION_LEVEL0(CATCH_RECURSION_LEVEL0(CATCH_RECURSION_LEVEL0(__VA_ARGS__))) +#define CATCH_RECURSION_LEVEL2(...) CATCH_RECURSION_LEVEL1(CATCH_RECURSION_LEVEL1(CATCH_RECURSION_LEVEL1(__VA_ARGS__))) +#define CATCH_RECURSION_LEVEL3(...) CATCH_RECURSION_LEVEL2(CATCH_RECURSION_LEVEL2(CATCH_RECURSION_LEVEL2(__VA_ARGS__))) +#define CATCH_RECURSION_LEVEL4(...) CATCH_RECURSION_LEVEL3(CATCH_RECURSION_LEVEL3(CATCH_RECURSION_LEVEL3(__VA_ARGS__))) +#define CATCH_RECURSION_LEVEL5(...) CATCH_RECURSION_LEVEL4(CATCH_RECURSION_LEVEL4(CATCH_RECURSION_LEVEL4(__VA_ARGS__))) + +#ifdef CATCH_CONFIG_TRADITIONAL_MSVC_PREPROCESSOR +#define INTERNAL_CATCH_EXPAND_VARGS(...) __VA_ARGS__ +// MSVC needs more evaluations +#define CATCH_RECURSION_LEVEL6(...) CATCH_RECURSION_LEVEL5(CATCH_RECURSION_LEVEL5(CATCH_RECURSION_LEVEL5(__VA_ARGS__))) +#define CATCH_RECURSE(...) CATCH_RECURSION_LEVEL6(CATCH_RECURSION_LEVEL6(__VA_ARGS__)) +#else +#define CATCH_RECURSE(...) CATCH_RECURSION_LEVEL5(__VA_ARGS__) +#endif + +#define CATCH_REC_END(...) +#define CATCH_REC_OUT + +#define CATCH_EMPTY() +#define CATCH_DEFER(id) id CATCH_EMPTY() + +#define CATCH_REC_GET_END2() 0, CATCH_REC_END +#define CATCH_REC_GET_END1(...) CATCH_REC_GET_END2 +#define CATCH_REC_GET_END(...) CATCH_REC_GET_END1 +#define CATCH_REC_NEXT0(test, next, ...) next CATCH_REC_OUT +#define CATCH_REC_NEXT1(test, next) CATCH_DEFER ( CATCH_REC_NEXT0 ) ( test, next, 0) +#define CATCH_REC_NEXT(test, next) CATCH_REC_NEXT1(CATCH_REC_GET_END test, next) + +#define CATCH_REC_LIST0(f, x, peek, ...) , f(x) CATCH_DEFER ( CATCH_REC_NEXT(peek, CATCH_REC_LIST1) ) ( f, peek, __VA_ARGS__ ) +#define CATCH_REC_LIST1(f, x, peek, ...) , f(x) CATCH_DEFER ( CATCH_REC_NEXT(peek, CATCH_REC_LIST0) ) ( f, peek, __VA_ARGS__ ) +#define CATCH_REC_LIST2(f, x, peek, ...) f(x) CATCH_DEFER ( CATCH_REC_NEXT(peek, CATCH_REC_LIST1) ) ( f, peek, __VA_ARGS__ ) + +#define CATCH_REC_LIST0_UD(f, userdata, x, peek, ...) , f(userdata, x) CATCH_DEFER ( CATCH_REC_NEXT(peek, CATCH_REC_LIST1_UD) ) ( f, userdata, peek, __VA_ARGS__ ) +#define CATCH_REC_LIST1_UD(f, userdata, x, peek, ...) , f(userdata, x) CATCH_DEFER ( CATCH_REC_NEXT(peek, CATCH_REC_LIST0_UD) ) ( f, userdata, peek, __VA_ARGS__ ) +#define CATCH_REC_LIST2_UD(f, userdata, x, peek, ...) f(userdata, x) CATCH_DEFER ( CATCH_REC_NEXT(peek, CATCH_REC_LIST1_UD) ) ( f, userdata, peek, __VA_ARGS__ ) + +// Applies the function macro `f` to each of the remaining parameters, inserts commas between the results, +// and passes userdata as the first parameter to each invocation, +// e.g. CATCH_REC_LIST_UD(f, x, a, b, c) evaluates to f(x, a), f(x, b), f(x, c) +#define CATCH_REC_LIST_UD(f, userdata, ...) CATCH_RECURSE(CATCH_REC_LIST2_UD(f, userdata, __VA_ARGS__, ()()(), ()()(), ()()(), 0)) + +#define CATCH_REC_LIST(f, ...) CATCH_RECURSE(CATCH_REC_LIST2(f, __VA_ARGS__, ()()(), ()()(), ()()(), 0)) + +#define INTERNAL_CATCH_EXPAND1(param) INTERNAL_CATCH_EXPAND2(param) +#define INTERNAL_CATCH_EXPAND2(...) INTERNAL_CATCH_NO## __VA_ARGS__ +#define INTERNAL_CATCH_DEF(...) INTERNAL_CATCH_DEF __VA_ARGS__ +#define INTERNAL_CATCH_NOINTERNAL_CATCH_DEF +#define INTERNAL_CATCH_STRINGIZE(...) INTERNAL_CATCH_STRINGIZE2(__VA_ARGS__) +#ifndef CATCH_CONFIG_TRADITIONAL_MSVC_PREPROCESSOR +#define INTERNAL_CATCH_STRINGIZE2(...) #__VA_ARGS__ +#define INTERNAL_CATCH_STRINGIZE_WITHOUT_PARENS(param) INTERNAL_CATCH_STRINGIZE(INTERNAL_CATCH_REMOVE_PARENS(param)) +#else +// MSVC is adding extra space and needs another indirection to expand INTERNAL_CATCH_NOINTERNAL_CATCH_DEF +#define INTERNAL_CATCH_STRINGIZE2(...) INTERNAL_CATCH_STRINGIZE3(__VA_ARGS__) +#define INTERNAL_CATCH_STRINGIZE3(...) #__VA_ARGS__ +#define INTERNAL_CATCH_STRINGIZE_WITHOUT_PARENS(param) (INTERNAL_CATCH_STRINGIZE(INTERNAL_CATCH_REMOVE_PARENS(param)) + 1) +#endif + +#define INTERNAL_CATCH_MAKE_NAMESPACE2(...) ns_##__VA_ARGS__ +#define INTERNAL_CATCH_MAKE_NAMESPACE(name) INTERNAL_CATCH_MAKE_NAMESPACE2(name) + +#define INTERNAL_CATCH_REMOVE_PARENS(...) INTERNAL_CATCH_EXPAND1(INTERNAL_CATCH_DEF __VA_ARGS__) + +#ifndef CATCH_CONFIG_TRADITIONAL_MSVC_PREPROCESSOR +#define INTERNAL_CATCH_MAKE_TYPE_LIST2(...) decltype(get_wrapper()) +#define INTERNAL_CATCH_MAKE_TYPE_LIST(...) INTERNAL_CATCH_MAKE_TYPE_LIST2(INTERNAL_CATCH_REMOVE_PARENS(__VA_ARGS__)) +#else +#define INTERNAL_CATCH_MAKE_TYPE_LIST2(...) INTERNAL_CATCH_EXPAND_VARGS(decltype(get_wrapper())) +#define INTERNAL_CATCH_MAKE_TYPE_LIST(...) INTERNAL_CATCH_EXPAND_VARGS(INTERNAL_CATCH_MAKE_TYPE_LIST2(INTERNAL_CATCH_REMOVE_PARENS(__VA_ARGS__))) +#endif + +#define INTERNAL_CATCH_MAKE_TYPE_LISTS_FROM_TYPES(...)\ + CATCH_REC_LIST(INTERNAL_CATCH_MAKE_TYPE_LIST,__VA_ARGS__) + +#define INTERNAL_CATCH_REMOVE_PARENS_1_ARG(_0) INTERNAL_CATCH_REMOVE_PARENS(_0) +#define INTERNAL_CATCH_REMOVE_PARENS_2_ARG(_0, _1) INTERNAL_CATCH_REMOVE_PARENS(_0), INTERNAL_CATCH_REMOVE_PARENS_1_ARG(_1) +#define INTERNAL_CATCH_REMOVE_PARENS_3_ARG(_0, _1, _2) INTERNAL_CATCH_REMOVE_PARENS(_0), INTERNAL_CATCH_REMOVE_PARENS_2_ARG(_1, _2) +#define INTERNAL_CATCH_REMOVE_PARENS_4_ARG(_0, _1, _2, _3) INTERNAL_CATCH_REMOVE_PARENS(_0), INTERNAL_CATCH_REMOVE_PARENS_3_ARG(_1, _2, _3) +#define INTERNAL_CATCH_REMOVE_PARENS_5_ARG(_0, _1, _2, _3, _4) INTERNAL_CATCH_REMOVE_PARENS(_0), INTERNAL_CATCH_REMOVE_PARENS_4_ARG(_1, _2, _3, _4) +#define INTERNAL_CATCH_REMOVE_PARENS_6_ARG(_0, _1, _2, _3, _4, _5) INTERNAL_CATCH_REMOVE_PARENS(_0), INTERNAL_CATCH_REMOVE_PARENS_5_ARG(_1, _2, _3, _4, _5) +#define INTERNAL_CATCH_REMOVE_PARENS_7_ARG(_0, _1, _2, _3, _4, _5, _6) INTERNAL_CATCH_REMOVE_PARENS(_0), INTERNAL_CATCH_REMOVE_PARENS_6_ARG(_1, _2, _3, _4, _5, _6) +#define INTERNAL_CATCH_REMOVE_PARENS_8_ARG(_0, _1, _2, _3, _4, _5, _6, _7) INTERNAL_CATCH_REMOVE_PARENS(_0), INTERNAL_CATCH_REMOVE_PARENS_7_ARG(_1, _2, _3, _4, _5, _6, _7) +#define INTERNAL_CATCH_REMOVE_PARENS_9_ARG(_0, _1, _2, _3, _4, _5, _6, _7, _8) INTERNAL_CATCH_REMOVE_PARENS(_0), INTERNAL_CATCH_REMOVE_PARENS_8_ARG(_1, _2, _3, _4, _5, _6, _7, _8) +#define INTERNAL_CATCH_REMOVE_PARENS_10_ARG(_0, _1, _2, _3, _4, _5, _6, _7, _8, _9) INTERNAL_CATCH_REMOVE_PARENS(_0), INTERNAL_CATCH_REMOVE_PARENS_9_ARG(_1, _2, _3, _4, _5, _6, _7, _8, _9) +#define INTERNAL_CATCH_REMOVE_PARENS_11_ARG(_0, _1, _2, _3, _4, _5, _6, _7, _8, _9, _10) INTERNAL_CATCH_REMOVE_PARENS(_0), INTERNAL_CATCH_REMOVE_PARENS_10_ARG(_1, _2, _3, _4, _5, _6, _7, _8, _9, _10) + +#define INTERNAL_CATCH_VA_NARGS_IMPL(_0, _1, _2, _3, _4, _5, _6, _7, _8, _9, _10, N, ...) N + +#define INTERNAL_CATCH_TYPE_GEN\ + template struct TypeList {};\ + template\ + constexpr auto get_wrapper() noexcept -> TypeList { return {}; }\ + template class...> struct TemplateTypeList{};\ + template class...Cs>\ + constexpr auto get_wrapper() noexcept -> TemplateTypeList { return {}; }\ + template\ + struct append;\ + template\ + struct rewrap;\ + template class, typename...>\ + struct create;\ + template class, typename>\ + struct convert;\ + \ + template \ + struct append { using type = T; };\ + template< template class L1, typename...E1, template class L2, typename...E2, typename...Rest>\ + struct append, L2, Rest...> { using type = typename append, Rest...>::type; };\ + template< template class L1, typename...E1, typename...Rest>\ + struct append, TypeList, Rest...> { using type = L1; };\ + \ + template< template class Container, template class List, typename...elems>\ + struct rewrap, List> { using type = TypeList>; };\ + template< template class Container, template class List, class...Elems, typename...Elements>\ + struct rewrap, List, Elements...> { using type = typename append>, typename rewrap, Elements...>::type>::type; };\ + \ + template