forked from mirror/trompeloeil
You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
2348 lines
71 KiB
C++
2348 lines
71 KiB
C++
/*
|
|
* Trompeloeil C++ mocking framework
|
|
*
|
|
* Copyright Björn Fahller 2014,2015
|
|
*
|
|
* Use, modification and distribution is subject to 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)
|
|
*
|
|
* Project home: https://github.com/rollbear/trompeloeil
|
|
*/
|
|
|
|
#ifndef TROMPELOEIL_HPP_
|
|
#define TROMPELOEIL_HPP_
|
|
|
|
|
|
// trompe l'oeil noun (Concise Encyclopedia)
|
|
// Style of representation in which a painted object is intended
|
|
// to deceive the viewer into believing it is the object itself...
|
|
|
|
// project home: https://github.com/rollbear/trompeloeil
|
|
|
|
|
|
// Deficiencies and missing features
|
|
// * Mocking function templates is not supported
|
|
// * If a macro kills a kitten, this threatens extinction of all felines!
|
|
|
|
#if defined(_MSC_VER)
|
|
# define TROMPELOEIL_NORETURN
|
|
# if (!defined(__cplusplus) || _MSC_VER < 1900)
|
|
# error requires C++ in Visual Studio 2015 RC or later
|
|
# endif
|
|
#else
|
|
# define TROMPELOEIL_NORETURN [[noreturn]]
|
|
# if (!defined(__cplusplus) || __cplusplus <= 201103)
|
|
# error requires C++14 or higher
|
|
# endif
|
|
#endif
|
|
#include <tuple>
|
|
#include <iomanip>
|
|
#include <sstream>
|
|
#include <exception>
|
|
#include <functional>
|
|
#include <memory>
|
|
#include <cstring>
|
|
|
|
#ifdef TROMPELOEIL_SANITY_CHECKS
|
|
#include <cassert>
|
|
#define TROMPELOEIL_ASSERT(x) assert(x)
|
|
#else
|
|
#define TROMPELOEIL_ASSERT(x) do {} while (false)
|
|
#endif
|
|
|
|
#define TROMPELOEIL_IDENTITY(...) __VA_ARGS__ // work around stupid MS VS2015 RC bug
|
|
|
|
#define TROMPELOEIL_ARG16(_0,_1,_2,_3,_4,_5,_6,_7,_8,_9,_10,_11,_12,_13,_14,_15, ...) _15
|
|
|
|
#define TROMPELOEIL_COUNT(...) TROMPELOEIL_IDENTITY(TROMPELOEIL_ARG16(__VA_ARGS__, 15,14,13,12,11,10,9,8,7,6,5,4,3,2,1,0))
|
|
|
|
|
|
#define TROMPELOEIL_CONCAT_(x, y) x ## y
|
|
#define TROMPELOEIL_CONCAT(x, y) TROMPELOEIL_CONCAT_(x, y)
|
|
|
|
#define TROMPELOEIL_INIT_WITH_STR15(base, x, ...) base{#x, x}, TROMPELOEIL_INIT_WITH_STR14(base, __VA_ARGS__)
|
|
#define TROMPELOEIL_INIT_WITH_STR14(base, x, ...) base{#x, x}, TROMPELOEIL_INIT_WITH_STR13(base, __VA_ARGS__)
|
|
#define TROMPELOEIL_INIT_WITH_STR13(base, x, ...) base{#x, x}, TROMPELOEIL_INIT_WITH_STR12(base, __VA_ARGS__)
|
|
#define TROMPELOEIL_INIT_WITH_STR12(base, x, ...) base{#x, x}, TROMPELOEIL_INIT_WITH_STR11(base, __VA_ARGS__)
|
|
#define TROMPELOEIL_INIT_WITH_STR11(base, x, ...) base{#x, x}, TROMPELOEIL_INIT_WITH_STR10(base, __VA_ARGS__)
|
|
#define TROMPELOEIL_INIT_WITH_STR10(base, x, ...) base{#x, x}, TROMPELOEIL_INIT_WITH_STR9(base, __VA_ARGS__)
|
|
#define TROMPELOEIL_INIT_WITH_STR9(base, x, ...) base{#x, x}, TROMPELOEIL_INIT_WITH_STR8(base, __VA_ARGS__)
|
|
#define TROMPELOEIL_INIT_WITH_STR8(base, x, ...) base{#x, x}, TROMPELOEIL_INIT_WITH_STR7(base, __VA_ARGS__)
|
|
#define TROMPELOEIL_INIT_WITH_STR7(base, x, ...) base{#x, x}, TROMPELOEIL_INIT_WITH_STR6(base, __VA_ARGS__)
|
|
#define TROMPELOEIL_INIT_WITH_STR6(base, x, ...) base{#x, x}, TROMPELOEIL_INIT_WITH_STR5(base, __VA_ARGS__)
|
|
#define TROMPELOEIL_INIT_WITH_STR5(base, x, ...) base{#x, x}, TROMPELOEIL_INIT_WITH_STR4(base, __VA_ARGS__)
|
|
#define TROMPELOEIL_INIT_WITH_STR4(base, x, ...) base{#x, x}, TROMPELOEIL_INIT_WITH_STR3(base, __VA_ARGS__)
|
|
#define TROMPELOEIL_INIT_WITH_STR3(base, x, ...) base{#x, x}, TROMPELOEIL_INIT_WITH_STR2(base, __VA_ARGS__)
|
|
#define TROMPELOEIL_INIT_WITH_STR2(base, x, ...) base{#x, x}, TROMPELOEIL_INIT_WITH_STR1(base, __VA_ARGS__)
|
|
#define TROMPELOEIL_INIT_WITH_STR1(base, x) base{#x, x}
|
|
#define TROMPELOEIL_INIT_WITH_STR0(base)
|
|
#define TROMPELOEIL_INIT_WITH_STR(base, ...) TROMPELOEIL_CONCAT(TROMPELOEIL_INIT_WITH_STR, TROMPELOEIL_COUNT(__VA_ARGS__))(base, __VA_ARGS__)
|
|
|
|
#define TROMPELOEIL_PARAM_LIST15(func_type) \
|
|
TROMPELOEIL_PARAM_LIST14(func_type), \
|
|
::trompeloeil::param_list_t<func_type, 14> p15
|
|
|
|
#define TROMPELOEIL_PARAM_LIST14(func_type) \
|
|
TROMPELOEIL_PARAM_LIST13(func_type), \
|
|
::trompeloeil::param_list_t<func_type, 13> p14
|
|
|
|
#define TROMPELOEIL_PARAM_LIST13(func_type) \
|
|
TROMPELOEIL_PARAM_LIST12(func_type), \
|
|
::trompeloeil::param_list_t<func_type, 12> p13
|
|
|
|
#define TROMPELOEIL_PARAM_LIST12(func_type) \
|
|
TROMPELOEIL_PARAM_LIST11(func_type), \
|
|
::trompeloeil::param_list_t<func_type, 11> p12
|
|
|
|
#define TROMPELOEIL_PARAM_LIST11(func_type) \
|
|
TROMPELOEIL_PARAM_LIST10(func_type), \
|
|
::trompeloeil::param_list_t<func_type, 10> p11
|
|
|
|
#define TROMPELOEIL_PARAM_LIST10(func_type) \
|
|
TROMPELOEIL_PARAM_LIST9(func_type), \
|
|
::trompeloeil::param_list_t<func_type, 9> p10
|
|
|
|
#define TROMPELOEIL_PARAM_LIST9(func_type) \
|
|
TROMPELOEIL_PARAM_LIST8(func_type), \
|
|
::trompeloeil::param_list_t<func_type, 8> p9
|
|
|
|
#define TROMPELOEIL_PARAM_LIST8(func_type) \
|
|
TROMPELOEIL_PARAM_LIST7(func_type), \
|
|
::trompeloeil::param_list_t<func_type, 7> p8
|
|
|
|
#define TROMPELOEIL_PARAM_LIST7(func_type) \
|
|
TROMPELOEIL_PARAM_LIST6(func_type), \
|
|
::trompeloeil::param_list_t<func_type, 6> p7
|
|
|
|
#define TROMPELOEIL_PARAM_LIST6(func_type) \
|
|
TROMPELOEIL_PARAM_LIST5(func_type), \
|
|
::trompeloeil::param_list_t<func_type, 5> p6
|
|
|
|
#define TROMPELOEIL_PARAM_LIST5(func_type) \
|
|
TROMPELOEIL_PARAM_LIST4(func_type), \
|
|
::trompeloeil::param_list_t<func_type, 4> p5
|
|
|
|
|
|
#define TROMPELOEIL_PARAM_LIST4(func_type) \
|
|
TROMPELOEIL_PARAM_LIST3(func_type), \
|
|
::trompeloeil::param_list_t<func_type, 3> p4
|
|
|
|
#define TROMPELOEIL_PARAM_LIST3(func_type) \
|
|
TROMPELOEIL_PARAM_LIST2(func_type), \
|
|
::trompeloeil::param_list_t<func_type, 2> p3
|
|
|
|
#define TROMPELOEIL_PARAM_LIST2(func_type) \
|
|
TROMPELOEIL_PARAM_LIST1(func_type), \
|
|
::trompeloeil::param_list_t<func_type, 1> p2
|
|
|
|
#define TROMPELOEIL_PARAM_LIST1(func_type) \
|
|
::trompeloeil::param_list_t<func_type, 0> p1
|
|
|
|
#define TROMPELOEIL_PARAM_LIST0(func_type)
|
|
|
|
#define TROMPELOEIL_PARAM_LIST(num, func_type) \
|
|
TROMPELOEIL_CONCAT(TROMPELOEIL_PARAM_LIST, num)(func_type)
|
|
|
|
|
|
#define TROMPELOEIL_PARAMS15 TROMPELOEIL_PARAMS14, p15
|
|
#define TROMPELOEIL_PARAMS14 TROMPELOEIL_PARAMS13, p14
|
|
#define TROMPELOEIL_PARAMS13 TROMPELOEIL_PARAMS12, p13
|
|
#define TROMPELOEIL_PARAMS12 TROMPELOEIL_PARAMS11, p12
|
|
#define TROMPELOEIL_PARAMS11 TROMPELOEIL_PARAMS10, p11
|
|
#define TROMPELOEIL_PARAMS10 TROMPELOEIL_PARAMS9, p10
|
|
#define TROMPELOEIL_PARAMS9 TROMPELOEIL_PARAMS8, p9
|
|
#define TROMPELOEIL_PARAMS8 TROMPELOEIL_PARAMS7, p8
|
|
#define TROMPELOEIL_PARAMS7 TROMPELOEIL_PARAMS6, p7
|
|
#define TROMPELOEIL_PARAMS6 TROMPELOEIL_PARAMS5, p6
|
|
#define TROMPELOEIL_PARAMS5 TROMPELOEIL_PARAMS4, p5
|
|
#define TROMPELOEIL_PARAMS4 TROMPELOEIL_PARAMS3, p4
|
|
#define TROMPELOEIL_PARAMS3 TROMPELOEIL_PARAMS2, p3
|
|
#define TROMPELOEIL_PARAMS2 TROMPELOEIL_PARAMS1, p2
|
|
#define TROMPELOEIL_PARAMS1 p1
|
|
#define TROMPELOEIL_PARAMS0
|
|
|
|
#define TROMPELOEIL_PARAMS(num) \
|
|
TROMPELOEIL_CONCAT(TROMPELOEIL_PARAMS, num)
|
|
|
|
namespace trompeloeil
|
|
{
|
|
template <size_t N, typename T, bool legal = (N < std::tuple_size<T>::value)>
|
|
struct conditional_tuple_element
|
|
{
|
|
using type = typename std::tuple_element<N, T>::type;
|
|
};
|
|
template <size_t N, typename T>
|
|
struct conditional_tuple_element<N, T, false>
|
|
{
|
|
using type = int;
|
|
};
|
|
template <typename T>
|
|
struct param_list;
|
|
|
|
template <typename R, typename ... P>
|
|
struct param_list<R(P...)>
|
|
{
|
|
using param_tuple = std::tuple<P...>;
|
|
static size_t const size = std::tuple_size<param_tuple>::value;
|
|
template <size_t N>
|
|
using type = typename conditional_tuple_element<N, param_tuple>::type;
|
|
};
|
|
|
|
template <typename Sig, size_t N>
|
|
using param_list_t = typename param_list<Sig>::template type<N>;
|
|
|
|
class expectation_violation : public std::logic_error
|
|
{
|
|
public:
|
|
using std::logic_error::logic_error;
|
|
};
|
|
|
|
struct location
|
|
{
|
|
location() = default;
|
|
location(char const* file_, unsigned long line_) : file{file_}, line{line_}{}
|
|
char const *file = "";
|
|
unsigned long line = 0U;
|
|
};
|
|
|
|
inline
|
|
std::ostream& operator<<(std::ostream& os, const location& loc)
|
|
{
|
|
if (loc.line != 0U) os << loc.file << ':' << loc.line;
|
|
return os;
|
|
}
|
|
|
|
enum class severity { fatal, nonfatal };
|
|
|
|
using reporter_func = std::function<void(severity,
|
|
char const *file,
|
|
unsigned long line,
|
|
std::string const &msg)>;
|
|
|
|
|
|
inline
|
|
void default_reporter(severity, char const *file, unsigned long line, std::string const &msg)
|
|
{
|
|
if (!std::current_exception())
|
|
{
|
|
std::stringstream os;
|
|
os << location{ file, line } << "\n" << msg;
|
|
throw expectation_violation(os.str());
|
|
}
|
|
}
|
|
|
|
inline
|
|
reporter_func&
|
|
reporter_obj()
|
|
{
|
|
static reporter_func obj = default_reporter;
|
|
return obj;
|
|
}
|
|
|
|
inline
|
|
void set_reporter(reporter_func f)
|
|
{
|
|
reporter_obj() = std::move(f);
|
|
}
|
|
|
|
class tracer;
|
|
|
|
inline
|
|
tracer*&
|
|
tracer_obj()
|
|
{
|
|
static tracer* ptr = nullptr;
|
|
return ptr;
|
|
}
|
|
|
|
inline
|
|
tracer*
|
|
set_tracer(tracer* obj)
|
|
{
|
|
auto& ptr = tracer_obj();
|
|
auto rv = ptr;
|
|
ptr = obj;
|
|
return rv;
|
|
}
|
|
|
|
class tracer
|
|
{
|
|
public:
|
|
virtual void trace(char const *file, unsigned long line, std::string const &call) = 0;
|
|
protected:
|
|
tracer() : previous(set_tracer(this)) {}
|
|
tracer(tracer const&) = delete;
|
|
tracer& operator=(tracer const&) = delete;
|
|
virtual ~tracer() { set_tracer(previous); }
|
|
private:
|
|
tracer* previous = nullptr;
|
|
};
|
|
|
|
class stream_tracer : public tracer
|
|
{
|
|
public:
|
|
stream_tracer(std::ostream& stream_) : stream(stream_) {}
|
|
void trace(char const *file, unsigned long line, std::string const &call) override
|
|
{
|
|
stream << location{file, line} << '\n' << call << '\n';
|
|
}
|
|
private:
|
|
std::ostream& stream;
|
|
};
|
|
|
|
inline
|
|
void send_report(severity s, location loc, std::string const &msg)
|
|
{
|
|
reporter_obj()(s, loc.file, loc.line, msg);
|
|
}
|
|
|
|
|
|
template <typename T>
|
|
struct is_value_type :
|
|
std::integral_constant<bool,
|
|
std::is_same<T,
|
|
typename std::decay<T>::type
|
|
>::value
|
|
>
|
|
{
|
|
};
|
|
|
|
struct matcher { };
|
|
|
|
template <typename T>
|
|
class is_matcher
|
|
{
|
|
static std::false_type func(...);
|
|
static std::true_type func(matcher const*);
|
|
public:
|
|
using type = decltype(func(std::declval<T*>()));
|
|
static const bool value = type::value;
|
|
};
|
|
|
|
template <typename T>
|
|
struct typed_matcher : matcher
|
|
{
|
|
operator T() const;
|
|
};
|
|
|
|
template <>
|
|
struct typed_matcher<std::nullptr_t> : matcher
|
|
{
|
|
template <typename U>
|
|
operator U*() const;
|
|
|
|
template <typename T, typename C>
|
|
operator T C::*() const;
|
|
};
|
|
|
|
template <typename T>
|
|
class is_output_streamable
|
|
{
|
|
static std::false_type func(...);
|
|
template <typename U>
|
|
static auto func(U const* u) -> std::is_same<std::ostream&, decltype(std::declval<std::ostream&>() << *u)>;
|
|
public:
|
|
using type = decltype(func(std::declval<T*>()));
|
|
static bool const value = type::value;
|
|
};
|
|
|
|
struct stream_sentry
|
|
{
|
|
stream_sentry(std::ostream& os_)
|
|
: os(os_)
|
|
, width(os.width(0))
|
|
, flags(os.flags(std::ios_base::dec | std::ios_base::left))
|
|
, fill(os.fill(' '))
|
|
{ }
|
|
~stream_sentry() { os.flags(flags); os.fill(fill); os.width(width);}
|
|
private:
|
|
std::ostream& os;
|
|
std::streamsize width;
|
|
std::ios_base::fmtflags flags;
|
|
char fill;
|
|
};
|
|
|
|
template <typename T, bool b = is_output_streamable<T>::value>
|
|
struct streamer
|
|
{
|
|
static void print(std::ostream& os, T const &t)
|
|
{
|
|
stream_sentry s(os);
|
|
os << t;
|
|
}
|
|
};
|
|
|
|
|
|
template <typename T>
|
|
struct streamer<T, false>
|
|
{
|
|
static void print(std::ostream& os, T const &t)
|
|
{
|
|
stream_sentry s(os);
|
|
|
|
os << sizeof(T) << "-byte object={";
|
|
if (sizeof(T) > 8) os << '\n';
|
|
os << std::setfill('0') << std::hex;
|
|
auto p = reinterpret_cast<uint8_t const*>(&t);
|
|
for (size_t i = 0; i < sizeof(T); ++i)
|
|
{
|
|
os << " 0x" << std::setw(2) << unsigned(p[i]);
|
|
if ((i & 0xf) == 0xf) os << '\n';
|
|
}
|
|
os << " }";
|
|
}
|
|
};
|
|
template <typename T>
|
|
void print(std::ostream& os, T const &t)
|
|
{
|
|
streamer<T>::print(os, t);
|
|
}
|
|
|
|
template <typename T>
|
|
void
|
|
print_expectation(std::ostream& os, T const& t)
|
|
{
|
|
static const char* const description[] = { " = ", "" };
|
|
os << description[is_matcher<T>::value];
|
|
print(os, t);
|
|
os << '\n';
|
|
}
|
|
|
|
template <typename T>
|
|
class list_elem
|
|
{
|
|
public:
|
|
list_elem(list_elem const&) = delete;
|
|
list_elem& operator=(list_elem const&) = delete;
|
|
list_elem(list_elem &&r) noexcept : next(r.next), prev(&r)
|
|
{
|
|
r.invariant_check();
|
|
|
|
next->prev = this;
|
|
r.next = this;
|
|
|
|
TROMPELOEIL_ASSERT(next->prev == this);
|
|
TROMPELOEIL_ASSERT(prev->next == this);
|
|
|
|
r.unlink();
|
|
|
|
TROMPELOEIL_ASSERT(!r.is_linked());
|
|
invariant_check();
|
|
}
|
|
virtual ~list_elem() { unlink(); }
|
|
void unlink() noexcept
|
|
{
|
|
invariant_check();
|
|
auto n = next;
|
|
auto p = prev;
|
|
n->prev = p;
|
|
p->next = n;
|
|
next = this;
|
|
prev = this;
|
|
invariant_check();
|
|
}
|
|
void invariant_check() const noexcept
|
|
{
|
|
#ifdef TROMPELOEIL_SANITY_CHECKS
|
|
TROMPELOEIL_ASSERT(next->prev == this);
|
|
TROMPELOEIL_ASSERT(prev->next == this);
|
|
TROMPELOEIL_ASSERT((next == this) == (prev == this));
|
|
TROMPELOEIL_ASSERT((prev->next == next) == (next == this));
|
|
TROMPELOEIL_ASSERT((next->prev == prev) == (prev == this));
|
|
auto pp = prev;
|
|
auto nn = next;
|
|
do {
|
|
TROMPELOEIL_ASSERT((nn == this) == (pp == this));
|
|
TROMPELOEIL_ASSERT(nn->next->prev == nn);
|
|
TROMPELOEIL_ASSERT(nn->prev->next == nn);
|
|
TROMPELOEIL_ASSERT(pp->next->prev == pp);
|
|
TROMPELOEIL_ASSERT(pp->prev->next == pp);
|
|
TROMPELOEIL_ASSERT((nn->next == nn) == (nn == this));
|
|
TROMPELOEIL_ASSERT((pp->prev == pp) == (pp == this));
|
|
nn = nn->next;
|
|
pp = pp->prev;
|
|
} while (nn != this);
|
|
#endif
|
|
}
|
|
bool is_linked() const noexcept
|
|
{
|
|
invariant_check();
|
|
return next != this;
|
|
}
|
|
protected:
|
|
list_elem() noexcept = default;
|
|
public:
|
|
list_elem* next = this;
|
|
list_elem* prev = this;
|
|
};
|
|
|
|
class ignore_disposer
|
|
{
|
|
protected:
|
|
template <typename T>
|
|
TROMPELOEIL_NORETURN void dispose(T*) const noexcept {
|
|
std::abort(); // must never be called
|
|
}
|
|
};
|
|
|
|
class delete_disposer
|
|
{
|
|
protected:
|
|
template <typename T>
|
|
void dispose(T* t) const { delete t; }
|
|
};
|
|
|
|
template <typename T, typename Disposer = ignore_disposer>
|
|
class list : private list_elem<T>, private Disposer
|
|
{
|
|
public:
|
|
~list();
|
|
class iterator;
|
|
iterator begin() const noexcept;
|
|
iterator end() const noexcept;
|
|
iterator push_front(T* t) noexcept;
|
|
iterator push_back(T* t) noexcept;
|
|
bool empty() const noexcept { return begin() == end(); }
|
|
private:
|
|
using list_elem<T>::invariant_check;
|
|
using list_elem<T>::next;
|
|
using list_elem<T>::prev;
|
|
};
|
|
|
|
template <typename T, typename Disposer>
|
|
class list<T, Disposer>::iterator
|
|
: public std::iterator<std::bidirectional_iterator_tag, T>
|
|
{
|
|
friend class list<T, Disposer>;
|
|
public:
|
|
iterator() noexcept : p{nullptr} {}
|
|
friend
|
|
bool operator==(iterator const &lh, iterator const &rh) noexcept
|
|
{
|
|
return lh.p == rh.p;
|
|
}
|
|
friend
|
|
bool operator!=(iterator const &lh, iterator const &rh) noexcept
|
|
{
|
|
return !(lh == rh);
|
|
}
|
|
|
|
iterator& operator++() noexcept
|
|
{
|
|
p = p->next;
|
|
return *this;
|
|
}
|
|
|
|
iterator operator++(int) noexcept
|
|
{
|
|
auto rv = *this;
|
|
operator++();
|
|
return rv;
|
|
}
|
|
T& operator*() noexcept
|
|
{
|
|
return static_cast<T&>(*p);
|
|
}
|
|
private:
|
|
iterator(list_elem<T> const *t) noexcept
|
|
: p{const_cast<list_elem<T>*>(t)}
|
|
{}
|
|
|
|
list_elem<T>* p;
|
|
};
|
|
|
|
template <typename T, typename Disposer>
|
|
list<T, Disposer>::~list()
|
|
{
|
|
auto i = this->begin();
|
|
while (i != this->end())
|
|
{
|
|
auto p = i++;
|
|
Disposer::dispose(&*p);
|
|
}
|
|
}
|
|
template <typename T, typename Disposer>
|
|
auto list<T, Disposer>::begin() const noexcept -> iterator
|
|
{
|
|
return {next};
|
|
}
|
|
|
|
template <typename T, typename Disposer>
|
|
auto list<T, Disposer>::end() const noexcept -> iterator
|
|
{
|
|
return {this};
|
|
}
|
|
|
|
template <typename T, typename Disposer>
|
|
auto list<T, Disposer>::push_front(T* t) noexcept -> iterator
|
|
{
|
|
invariant_check();
|
|
t->next = next;
|
|
t->prev = this;
|
|
next->prev = t;
|
|
next = t;
|
|
invariant_check();
|
|
return {t};
|
|
}
|
|
|
|
template <typename T, typename Disposer>
|
|
auto list<T, Disposer>::push_back(T* t) noexcept -> iterator
|
|
{
|
|
invariant_check();
|
|
t->prev = prev;
|
|
t->next = this;
|
|
prev->next = t;
|
|
prev = t;
|
|
invariant_check();
|
|
return {t};
|
|
}
|
|
|
|
class sequence_matcher;
|
|
|
|
class sequence
|
|
{
|
|
public:
|
|
sequence() noexcept = default;
|
|
sequence(sequence&&) = delete;
|
|
~sequence() = default;
|
|
bool is_first(sequence_matcher const *m) const noexcept
|
|
{
|
|
return !matchers.empty() && &*matchers.begin() == m;
|
|
}
|
|
void add_last(sequence_matcher *m) noexcept;
|
|
|
|
void validate_match(
|
|
sequence_matcher const *matcher,
|
|
char const *seq_name,
|
|
char const *match_name,
|
|
location loc)
|
|
const;
|
|
|
|
private:
|
|
list<sequence_matcher> matchers;
|
|
};
|
|
|
|
class sequence_matcher : public list_elem<sequence_matcher>
|
|
{
|
|
public:
|
|
using init_type = std::pair<char const*, sequence&>;
|
|
sequence_matcher(
|
|
char const *exp,
|
|
location loc,
|
|
init_type i)
|
|
noexcept
|
|
: seq_name(i.first)
|
|
, exp_name(exp)
|
|
, exp_loc(loc)
|
|
, seq(i.second)
|
|
{
|
|
seq.add_last(this);
|
|
}
|
|
void
|
|
validate_match(
|
|
char const *match_name,
|
|
location loc)
|
|
const
|
|
{
|
|
seq.validate_match(this, seq_name, match_name, loc);
|
|
}
|
|
bool
|
|
is_first()
|
|
const noexcept
|
|
{
|
|
return seq.is_first(this);
|
|
}
|
|
void
|
|
retire()
|
|
noexcept
|
|
{
|
|
this->unlink();
|
|
}
|
|
void
|
|
print_expectation(std::ostream& os)
|
|
const
|
|
{
|
|
os << exp_name << " at " << exp_loc;
|
|
}
|
|
private:
|
|
char const *seq_name;
|
|
char const *exp_name;
|
|
location exp_loc;
|
|
sequence& seq;
|
|
};
|
|
|
|
inline
|
|
void
|
|
sequence::validate_match(
|
|
sequence_matcher const *matcher,
|
|
char const* seq_name,
|
|
char const* match_name,
|
|
location loc)
|
|
const
|
|
{
|
|
if (is_first(matcher)) return;
|
|
for (auto& m : matchers)
|
|
{
|
|
std::ostringstream os;
|
|
os << "Sequence mismatch for sequence \"" << seq_name
|
|
<< "\" with matching call of " << match_name
|
|
<< " at " << loc
|
|
<< ". Sequence \"" << seq_name << "\" has ";
|
|
m.print_expectation(os);
|
|
os << " first in line\n";
|
|
send_report(severity::fatal, loc, os.str());
|
|
}
|
|
}
|
|
|
|
inline
|
|
void
|
|
sequence::add_last(
|
|
sequence_matcher *m)
|
|
noexcept
|
|
{
|
|
matchers.push_back(m);
|
|
}
|
|
|
|
struct wildcard : public matcher
|
|
{
|
|
template<typename T>
|
|
operator T&&() const;
|
|
template<typename T>
|
|
operator T&() const;
|
|
template <typename T>
|
|
bool matches(T const&) const noexcept { return true; }
|
|
friend std::ostream& operator<<(std::ostream& os, wildcard const&)
|
|
{
|
|
return os;
|
|
}
|
|
};
|
|
|
|
|
|
static constexpr wildcard const _{};
|
|
|
|
template <typename T>
|
|
struct typed_wildcard : public typed_matcher<T>
|
|
{
|
|
template <typename U>
|
|
typename std::enable_if<std::is_same<typename std::decay<T>::type,
|
|
typename std::decay<U>::type>::value, bool>::type
|
|
matches(U const &) const noexcept { return true; }
|
|
friend std::ostream& operator<<(std::ostream& os, typed_wildcard<T> const&)
|
|
{
|
|
return os;
|
|
}
|
|
};
|
|
|
|
template <typename T>
|
|
class ne_t : public typed_matcher<T>
|
|
{
|
|
public:
|
|
ne_t(T t_) : t{t_} {}
|
|
bool matches(T const& v) const noexcept(noexcept(v != std::declval<T>()))
|
|
{
|
|
return v != t;
|
|
}
|
|
friend std::ostream& operator<<(std::ostream& os, ne_t<T> const& m)
|
|
{
|
|
os << " != ";
|
|
print(os, m.t);
|
|
return os;
|
|
}
|
|
private:
|
|
T t;
|
|
};
|
|
|
|
template <>
|
|
class ne_t<std::nullptr_t> : public typed_matcher<std::nullptr_t>
|
|
{
|
|
public:
|
|
ne_t(std::nullptr_t) {}
|
|
template <typename U>
|
|
bool matches(U* u) const noexcept
|
|
{
|
|
return u != nullptr;
|
|
}
|
|
template <typename C, typename T>
|
|
bool matches(T C::*p) const noexcept
|
|
{
|
|
return p != nullptr;
|
|
}
|
|
friend std::ostream& operator<<(std::ostream& os, ne_t<std::nullptr_t> const&)
|
|
{
|
|
return os << " != nullptr";
|
|
}
|
|
};
|
|
|
|
template <typename T>
|
|
ne_t<T> ne(T t)
|
|
{
|
|
return {t};
|
|
}
|
|
|
|
template <typename T>
|
|
class ge_t : public typed_matcher<T>
|
|
{
|
|
public:
|
|
ge_t(T t_) : t{t_} {}
|
|
bool matches(T const& v) const noexcept(noexcept(v >= std::declval<T>()))
|
|
{
|
|
return v >= t;
|
|
}
|
|
friend std::ostream& operator<<(std::ostream& os, ge_t<T> const& m)
|
|
{
|
|
os << " >= ";
|
|
print(os, m.t);
|
|
return os;
|
|
}
|
|
private:
|
|
T t;
|
|
};
|
|
|
|
template <typename T>
|
|
ge_t<T> ge(T t)
|
|
{
|
|
return {t};
|
|
}
|
|
|
|
template <typename T>
|
|
class gt_t : public typed_matcher<T>
|
|
{
|
|
public:
|
|
gt_t(T t_) : t{t_} {}
|
|
bool matches(T const& v) const noexcept(noexcept(v > std::declval<T>()))
|
|
{
|
|
return v > t;
|
|
}
|
|
friend std::ostream& operator<<(std::ostream& os, gt_t<T> const& m)
|
|
{
|
|
os << " > ";
|
|
print(os, m.t);
|
|
return os;
|
|
}
|
|
private:
|
|
T t;
|
|
};
|
|
|
|
template <typename T>
|
|
gt_t<T> gt(T t)
|
|
{
|
|
return {t};
|
|
}
|
|
|
|
template <typename T>
|
|
class lt_t : public typed_matcher<T>
|
|
{
|
|
public:
|
|
lt_t(T t_) : t{t_} {}
|
|
bool matches(T const& v) const noexcept(noexcept(v < std::declval<T>()))
|
|
{
|
|
return v < t;
|
|
}
|
|
friend std::ostream& operator<<(std::ostream& os, lt_t<T> const& m)
|
|
{
|
|
os << " < ";
|
|
print(os, m.t);
|
|
return os;
|
|
}
|
|
private:
|
|
T t;
|
|
};
|
|
|
|
template <typename T>
|
|
lt_t<T> lt(T t)
|
|
{
|
|
return {t};
|
|
}
|
|
|
|
template <typename T>
|
|
class le_t : public typed_matcher<T>
|
|
{
|
|
public:
|
|
le_t(T t_) : t{t_} {}
|
|
bool matches(T const& v) const noexcept(noexcept(v <= std::declval<T>()))
|
|
{
|
|
return v <= t;
|
|
}
|
|
friend std::ostream& operator<<(std::ostream& os, le_t<T> const& m)
|
|
{
|
|
os << " <= ";
|
|
print(os, m.t);
|
|
return os;
|
|
}
|
|
private:
|
|
T t;
|
|
};
|
|
|
|
template <typename T>
|
|
le_t<T> le(T t)
|
|
{
|
|
return {t};
|
|
}
|
|
|
|
struct lifetime_monitor;
|
|
|
|
template <typename T>
|
|
struct null_on_move
|
|
{
|
|
public:
|
|
null_on_move() : p{nullptr} {}
|
|
null_on_move(T* p_) noexcept : p{p_} {}
|
|
null_on_move(null_on_move&&) noexcept : p{nullptr} {}
|
|
null_on_move(null_on_move const&) noexcept : p{nullptr} {}
|
|
null_on_move& operator=(const null_on_move&) noexcept { p = nullptr; return *this;}
|
|
null_on_move& operator=(null_on_move&&) noexcept { p = nullptr; return *this;}
|
|
null_on_move& operator=(T* t) noexcept { p = t; return *this; }
|
|
T*& leak() { return p; }
|
|
T& operator*() const noexcept { return *p; }
|
|
T* operator->() const noexcept { return p; }
|
|
explicit operator bool() const noexcept { return p != nullptr; }
|
|
private:
|
|
T* p;
|
|
};
|
|
template <typename T>
|
|
class deathwatched : public T
|
|
{
|
|
static_assert(std::has_virtual_destructor<T>::value,
|
|
"virtual destructor is a necessity for deathwatched to work");
|
|
public:
|
|
template <typename ... U, typename = typename std::enable_if<std::is_constructible<T, U...>::value>::type>
|
|
deathwatched(U&& ...u) : T(std::forward<U>(u)...) {}
|
|
~deathwatched();
|
|
trompeloeil::lifetime_monitor*&
|
|
trompeloeil_expect_death(trompeloeil::lifetime_monitor* monitor)
|
|
const noexcept
|
|
{
|
|
trompeloeil_lifetime_monitor = monitor;
|
|
return trompeloeil_lifetime_monitor.leak();
|
|
}
|
|
private:
|
|
mutable null_on_move<trompeloeil::lifetime_monitor> trompeloeil_lifetime_monitor;
|
|
};
|
|
|
|
struct lifetime_monitor
|
|
{
|
|
template <typename T>
|
|
lifetime_monitor(
|
|
::trompeloeil::deathwatched<T> const &obj,
|
|
char const* obj_name_,
|
|
location loc_)
|
|
noexcept
|
|
: object_monitor(obj.trompeloeil_expect_death(this))
|
|
, loc(loc_)
|
|
, object_name(obj_name_)
|
|
{
|
|
}
|
|
lifetime_monitor(lifetime_monitor const&) = delete;
|
|
~lifetime_monitor() noexcept(false)
|
|
{
|
|
if (!died)
|
|
{
|
|
std::ostringstream os;
|
|
os << "Object " << object_name << " is still alive";
|
|
send_report(severity::nonfatal, loc, os.str());
|
|
object_monitor = nullptr; // prevent its death poking this cadaver
|
|
}
|
|
}
|
|
void notify() noexcept { died = true; }
|
|
|
|
bool died = false;
|
|
lifetime_monitor *&object_monitor;
|
|
location loc;
|
|
char const *object_name;
|
|
};
|
|
|
|
template <typename T>
|
|
deathwatched<T>::~deathwatched()
|
|
{
|
|
if (trompeloeil_lifetime_monitor)
|
|
{
|
|
trompeloeil_lifetime_monitor->notify();
|
|
return;
|
|
}
|
|
std::ostringstream os;
|
|
os << "Unexpected destruction of "
|
|
<< typeid(T).name() << "@" << this << '\n';
|
|
trompeloeil::send_report(trompeloeil::severity::nonfatal,
|
|
location{},
|
|
os.str());
|
|
}
|
|
|
|
template<typename T>
|
|
struct return_of;
|
|
|
|
template<typename R, typename ... A>
|
|
struct return_of<R(A...)>
|
|
{
|
|
using type = R;
|
|
};
|
|
|
|
template<typename T>
|
|
using return_of_t = typename return_of<T>::type;
|
|
|
|
template<typename T>
|
|
struct call_params_type;
|
|
|
|
template<typename R, typename ... T>
|
|
struct call_params_type<R(T...)>
|
|
{
|
|
using type = std::tuple<typename std::add_lvalue_reference<T>::type...>;
|
|
};
|
|
|
|
template<typename T>
|
|
using call_params_type_t = typename call_params_type<T>::type;
|
|
|
|
template <typename Sig>
|
|
struct default_return_t
|
|
{
|
|
TROMPELOEIL_NORETURN static return_of_t<Sig> value()
|
|
{
|
|
std::abort(); // must never be called
|
|
}
|
|
};
|
|
|
|
template <typename ... A>
|
|
struct default_return_t<void(A...)>
|
|
{
|
|
static void value() {}
|
|
};
|
|
|
|
template <typename Sig>
|
|
return_of_t<Sig> default_return(call_params_type_t<Sig>&)
|
|
{
|
|
return default_return_t<Sig>::value();
|
|
}
|
|
|
|
|
|
template<typename Sig>
|
|
struct call_matcher_base;
|
|
|
|
template <typename Sig>
|
|
struct call_matcher_list : public list<call_matcher_base<Sig>>
|
|
{
|
|
~call_matcher_list()
|
|
{
|
|
auto iter = this->begin();
|
|
auto const end = this->end();
|
|
while (iter != end)
|
|
{
|
|
auto i = iter++;
|
|
auto &m = *i;
|
|
m.mock_destroyed();
|
|
m.unlink();
|
|
}
|
|
}
|
|
};
|
|
template<typename Sig>
|
|
struct call_matcher_base : public list_elem<call_matcher_base<Sig> >
|
|
{
|
|
call_matcher_base() = default;
|
|
call_matcher_base(call_matcher_base&&) = delete;
|
|
virtual
|
|
~call_matcher_base() = default;
|
|
|
|
virtual
|
|
void
|
|
mock_destroyed() = 0;
|
|
|
|
virtual
|
|
bool
|
|
matches(call_params_type_t<Sig> const&) const = 0;
|
|
|
|
virtual
|
|
bool
|
|
first_in_sequence() const noexcept = 0;
|
|
|
|
virtual
|
|
void
|
|
log_call(tracer* obj, call_params_type_t<Sig>& p) const = 0;
|
|
|
|
template <typename ... T> // never called. Used to
|
|
void log_call(std::false_type, T&& ...) const;// limit errmsg length
|
|
// with MAKE_MOCKn
|
|
// and wrong sig
|
|
void
|
|
log_call(std::true_type, tracer* obj, call_params_type_t<Sig>& p) const
|
|
{
|
|
log_call(obj, p);
|
|
}
|
|
|
|
virtual
|
|
void
|
|
run_actions(
|
|
call_params_type_t<Sig> &,
|
|
call_matcher_list<Sig> &saturated_list
|
|
) = 0;
|
|
|
|
template <typename ... T> // Never called. Used to limit
|
|
void // errmsg length with MAKE_MOCKn
|
|
run_actions(std::false_type, const T& ...);// and wrong sig
|
|
|
|
void
|
|
run_actions(
|
|
std::true_type,
|
|
call_params_type_t<Sig> ¶ms,
|
|
call_matcher_list<Sig>& saturated_list
|
|
)
|
|
{
|
|
run_actions(params, saturated_list);
|
|
}
|
|
|
|
virtual
|
|
std::ostream&
|
|
report_signature(std::ostream&) const = 0;
|
|
|
|
TROMPELOEIL_NORETURN
|
|
virtual
|
|
std::ostream&
|
|
report_mismatch(std::ostream&, call_params_type_t<Sig> const &) = 0;
|
|
|
|
virtual
|
|
return_of_t<Sig>
|
|
return_value(call_params_type_t<Sig>& p) = 0;
|
|
|
|
template<typename T> // Never called. Used to limit
|
|
return_of_t<Sig> // errmsg length with MAKE_MOCKn
|
|
return_value(std::false_type, const T&);// and wrong sig.
|
|
|
|
return_of_t<Sig>
|
|
return_value(std::true_type, call_params_type_t<Sig>& p)
|
|
{
|
|
return return_value(p);
|
|
}
|
|
|
|
virtual
|
|
void
|
|
report_missed(char const *reason) = 0;
|
|
};
|
|
|
|
template <typename T, typename U>
|
|
bool
|
|
param_matches_impl(T const& t, U const& u, matcher const*) noexcept(noexcept(t.matches(u)))
|
|
{
|
|
return t.matches(u);
|
|
}
|
|
|
|
template <typename T, typename U>
|
|
bool
|
|
param_matches_impl(T const& t, U const& u, ...) noexcept(noexcept(t == u))
|
|
{
|
|
return t == u;
|
|
}
|
|
|
|
template <typename T, typename U>
|
|
bool
|
|
param_matches(T const& t, U const& u) noexcept(noexcept(param_matches_impl(t, u, &t)))
|
|
{
|
|
return param_matches_impl(t, u, &t);
|
|
}
|
|
template<typename T, size_t N = 0, bool b = N == std::tuple_size<T>::value>
|
|
struct parameters
|
|
{
|
|
template <typename U>
|
|
static bool matches(T const& expected, U const& actual)
|
|
{
|
|
return param_matches(std::get<N>(expected), std::get<N>(actual))
|
|
&& parameters<T, N + 1>::matches(expected, actual);
|
|
}
|
|
template <typename stream, typename U>
|
|
static stream &print_mismatch(stream &os, T const &t1, U const &t2)
|
|
{
|
|
if (!(param_matches(std::get<N>(t1), std::get<N>(t2))))
|
|
{
|
|
os << " Expected " << std::setw((N<9)+1) << '_' << N+1;
|
|
print_expectation(os, std::get<N>(t1));
|
|
}
|
|
return parameters<T, N + 1>::print_mismatch(os, t1, t2);
|
|
}
|
|
|
|
template <typename stream, typename U>
|
|
static stream &print_missed(stream &os, U const &t)
|
|
{
|
|
os << " param " << std::setw((N<9)+1) << "_" << N+1 << " = ";
|
|
print(os, std::get<N>(t));
|
|
os << '\n';
|
|
return parameters<T, N + 1>::print_missed(os, t);
|
|
}
|
|
};
|
|
|
|
template<typename T, size_t N>
|
|
struct parameters<T, N, true>
|
|
{
|
|
template <typename U>
|
|
static bool matches(T const&, U const&)
|
|
{
|
|
return true;
|
|
}
|
|
template <typename stream, typename U>
|
|
static stream &print_mismatch(stream &os, T const &, U const &)
|
|
{
|
|
return os;
|
|
}
|
|
|
|
template <typename stream, typename U>
|
|
static stream& print_missed(stream &os, U const &)
|
|
{
|
|
return os;
|
|
}
|
|
};
|
|
|
|
template <typename T, typename U>
|
|
bool match_parameters(T const& t, U const& u)
|
|
{
|
|
return parameters<T>::matches(t, u);
|
|
}
|
|
|
|
template <typename T>
|
|
std::string missed_values(T const &t)
|
|
{
|
|
std::ostringstream os;
|
|
parameters<T>::print_missed(os, t);
|
|
return os.str();
|
|
}
|
|
|
|
template <typename Sig, typename T> // Never called. Used to
|
|
call_matcher_base<Sig>* // limit errmsg length
|
|
find(std::false_type, T&, call_matcher_list<Sig>&) // with MAKE_MOCKn and
|
|
noexcept; // wrong sig
|
|
|
|
template <typename Sig>
|
|
call_matcher_base<Sig>*
|
|
find(std::true_type,
|
|
call_params_type_t<Sig> const &p,
|
|
call_matcher_list<Sig> &list)
|
|
noexcept
|
|
{
|
|
call_matcher_base<Sig>* first_match = nullptr;
|
|
for (auto& i : list)
|
|
{
|
|
if (i.matches(p))
|
|
{
|
|
if (i.first_in_sequence())
|
|
{
|
|
return &i;
|
|
}
|
|
if (!first_match)
|
|
{
|
|
first_match = &i;
|
|
}
|
|
}
|
|
}
|
|
return first_match;
|
|
}
|
|
|
|
template <typename ... T> // Never called. Used to limit
|
|
void // errmsg length with MAKE_MOCKn
|
|
report_mismatch(std::false_type, T&& ...); // and wrong sig.
|
|
|
|
template <typename Sig>
|
|
TROMPELOEIL_NORETURN
|
|
void
|
|
report_mismatch(std::true_type,
|
|
char const *name,
|
|
call_params_type_t<Sig> const &p,
|
|
call_matcher_list<Sig> &matcher_list,
|
|
call_matcher_list<Sig> &saturated_list)
|
|
{
|
|
std::ostringstream os;
|
|
os << "No match for call of " << name << " with.\n" << missed_values(p);
|
|
bool saturated_match = false;
|
|
for (auto& m : saturated_list)
|
|
{
|
|
if (m.matches(p))
|
|
{
|
|
if (!saturated_match)
|
|
{
|
|
os << "\nMatches saturated call requirement\n";
|
|
saturated_match = true;
|
|
}
|
|
os << " ";
|
|
m.report_signature(os) << '\n';
|
|
}
|
|
}
|
|
if (!saturated_match)
|
|
{
|
|
for (auto& m : matcher_list)
|
|
{
|
|
os << "\nTried ";
|
|
m.report_mismatch(os, p);
|
|
}
|
|
}
|
|
trompeloeil::send_report(severity::fatal, location{}, os.str());
|
|
std::abort(); // must never get here.
|
|
}
|
|
|
|
template <typename Sig>
|
|
class return_handler
|
|
{
|
|
public:
|
|
virtual ~return_handler() = default;
|
|
virtual return_of_t<Sig> call(call_params_type_t<Sig>& params) = 0;
|
|
};
|
|
|
|
template <typename Sig, typename T>
|
|
class return_handler_t : public return_handler<Sig>
|
|
{
|
|
public:
|
|
template <typename U>
|
|
return_handler_t(U&& u) : func(std::forward<U>(u)) {}
|
|
return_of_t<Sig> call(call_params_type_t<Sig>& params) override
|
|
{
|
|
return func(params);
|
|
}
|
|
private:
|
|
T func;
|
|
};
|
|
template<typename Sig>
|
|
class condition_base : public list_elem<condition_base<Sig> >
|
|
{
|
|
public:
|
|
condition_base(char const *n) : id(n) {}
|
|
virtual ~condition_base() = default;
|
|
virtual bool check(call_params_type_t<Sig> const&) const = 0;
|
|
virtual char const* name() const noexcept { return id; }
|
|
private:
|
|
char const *id;
|
|
};
|
|
|
|
template <typename Sig>
|
|
using condition_list = list<condition_base<Sig>, delete_disposer >;
|
|
|
|
template<typename Sig, typename Cond>
|
|
struct condition : public condition_base<Sig>
|
|
{
|
|
condition(char const *str_, Cond c_) : condition_base<Sig>(str_), c(c_) {}
|
|
|
|
bool check(call_params_type_t<Sig> const & t) const override
|
|
{
|
|
return c(t);
|
|
}
|
|
|
|
private:
|
|
Cond c;
|
|
};
|
|
|
|
|
|
template<typename Sig>
|
|
struct side_effect_base : public list_elem<side_effect_base<Sig> >
|
|
{
|
|
virtual ~side_effect_base() = default;
|
|
virtual void action(call_params_type_t<Sig> &) const = 0;
|
|
};
|
|
|
|
template<typename Sig>
|
|
using side_effect_list = list<side_effect_base<Sig>, delete_disposer>;
|
|
|
|
template<typename Sig, typename Action>
|
|
struct side_effect : public side_effect_base<Sig>
|
|
{
|
|
template <typename A>
|
|
side_effect(A&& a_) : a(std::forward<A>(a_)) {}
|
|
|
|
void action(call_params_type_t<Sig> &t) const { a(t); }
|
|
private:
|
|
Action a;
|
|
};
|
|
|
|
template <typename Sig>
|
|
using return_handler_sig = return_of_t<Sig>(call_params_type_t<Sig>&);
|
|
|
|
struct sequence_handler_base
|
|
{
|
|
virtual ~sequence_handler_base() noexcept = default;
|
|
virtual void validate(char const*, location) = 0;
|
|
virtual bool is_first() const noexcept = 0;
|
|
virtual void retire() noexcept = 0;
|
|
};
|
|
|
|
template <size_t N>
|
|
struct sequence_handler : public sequence_handler_base
|
|
{
|
|
public:
|
|
template <typename ... S>
|
|
sequence_handler(
|
|
char const *name,
|
|
location loc,
|
|
S&& ... s)
|
|
noexcept
|
|
: matchers{{name, loc, std::forward<S>(s)}...}
|
|
{
|
|
}
|
|
void validate(char const *match_name, location loc)
|
|
{
|
|
for (auto& e : matchers)
|
|
{
|
|
e.validate_match(match_name, loc);
|
|
}
|
|
}
|
|
bool is_first() const noexcept
|
|
{
|
|
// std::all_of() is almost always preferable. The only reason
|
|
// for using a hand rolled loop is because it cuts compilation
|
|
// times quite noticeably (almost 10% with g++5.1)
|
|
for (auto& m : matchers)
|
|
{
|
|
if (!m.is_first()) return false;
|
|
}
|
|
return true;
|
|
}
|
|
void retire() noexcept
|
|
{
|
|
for (auto& e : matchers)
|
|
{
|
|
e.retire();
|
|
}
|
|
}
|
|
private:
|
|
sequence_matcher matchers[N];
|
|
};
|
|
|
|
template <unsigned long long L, unsigned long long H = L>
|
|
struct multiplicity
|
|
{
|
|
};
|
|
|
|
template<typename R, typename Parent>
|
|
struct return_injector : Parent
|
|
{
|
|
using return_type = R;
|
|
};
|
|
|
|
template <typename Parent>
|
|
struct throw_injector : Parent
|
|
{
|
|
static bool const throws = true;
|
|
};
|
|
|
|
template <typename Parent>
|
|
struct sideeffect_injector : Parent
|
|
{
|
|
static bool const side_effects = true;
|
|
};
|
|
|
|
template <typename Parent, unsigned long long H>
|
|
struct call_limit_injector : Parent
|
|
{
|
|
static bool const call_limit_set = true;
|
|
static unsigned long long const upper_call_limit = H;
|
|
};
|
|
|
|
template <typename Parent>
|
|
struct sequence_injector : Parent
|
|
{
|
|
static bool const sequence_set = true;
|
|
};
|
|
|
|
template <typename Matcher, typename Parent = std::tuple<>>
|
|
struct call_modifier : public Parent
|
|
{
|
|
using typename Parent::signature;
|
|
using typename Parent::return_type;
|
|
using Parent::call_limit_set;
|
|
using Parent::upper_call_limit;
|
|
using Parent::sequence_set;
|
|
using Parent::throws;
|
|
using Parent::side_effects;
|
|
|
|
call_modifier(Matcher& m) : matcher(m) {}
|
|
|
|
template <typename D>
|
|
call_modifier&
|
|
with(char const* str, D&& d)
|
|
{
|
|
matcher.add_condition(str, std::forward<D>(d));
|
|
return *this;
|
|
}
|
|
|
|
template <typename A>
|
|
call_modifier<Matcher, sideeffect_injector<Parent>>
|
|
sideeffect(A&& a)
|
|
{
|
|
constexpr bool forbidden = upper_call_limit == 0U;
|
|
static_assert(!forbidden,
|
|
"SIDE_EFFECT for forbidden call does not make sense");
|
|
using tag = std::integral_constant<bool, !forbidden>;
|
|
matcher.add_side_effect(tag{}, &a);
|
|
return {matcher};
|
|
}
|
|
|
|
template <typename H,
|
|
typename = typename std::enable_if<is_value_type<H>::value>::type>
|
|
call_modifier<Matcher, return_injector<return_of_t<signature>, Parent > >
|
|
handle_return(H&& h)
|
|
{
|
|
using params_type = call_params_type_t<signature>&;
|
|
using sigret = return_of_t<signature>;
|
|
using ret = decltype(std::declval<H>()(std::declval<params_type>()));
|
|
// don't know why MS VS 2015 RC doesn't like std::result_of
|
|
|
|
constexpr bool is_first_return = std::is_same<return_type, void>::value;
|
|
constexpr bool void_signature = std::is_same<sigret, void>::value;
|
|
constexpr bool matching_ret_type = std::is_constructible<sigret, ret>::value;
|
|
|
|
static_assert(matching_ret_type || !void_signature,
|
|
"RETURN does not make sense for void-function");
|
|
static_assert(matching_ret_type || void_signature,
|
|
"RETURN value is not convertible to the return type of the function");
|
|
static_assert(is_first_return,
|
|
"Multiple RETURN does not make sense");
|
|
static_assert(!throws || upper_call_limit == 0,
|
|
"THROW and RETURN does not make sense");
|
|
static_assert(upper_call_limit > 0ULL,
|
|
"RETURN for forbidden call does not make sense");
|
|
|
|
constexpr bool valid = matching_ret_type && is_first_return && !throws && upper_call_limit > 0ULL;
|
|
using tag = std::integral_constant<bool, valid>;
|
|
matcher.set_return(tag{}, &h);
|
|
return {matcher};
|
|
}
|
|
|
|
template <typename H>
|
|
call_modifier<Matcher, throw_injector<Parent> >
|
|
handle_throw(H&& h)
|
|
{
|
|
static_assert(!throws,
|
|
"Multiple THROW does not make sense");
|
|
constexpr bool has_return = !std::is_same<return_type, void>::value;
|
|
static_assert(!has_return,
|
|
"THROW and RETURN does not make sense");
|
|
|
|
constexpr bool valid = !throws && !has_return;
|
|
using tag = std::integral_constant<bool, valid>;
|
|
auto handler = [=](auto& p)
|
|
{
|
|
h(p);
|
|
return default_return<signature>(p);
|
|
};
|
|
matcher.set_return(tag{}, &handler);
|
|
return {matcher};
|
|
}
|
|
template <unsigned long long L,
|
|
unsigned long long H,
|
|
bool times_set = call_limit_set>
|
|
call_modifier<Matcher, call_limit_injector<Parent, H> >
|
|
times(multiplicity<L, H>)
|
|
{
|
|
static_assert(!times_set,
|
|
"Only one TIMES call limit is allowed, but it can express an interval");
|
|
|
|
static_assert(H >= L,
|
|
"In TIMES the first value must not exceed the second");
|
|
|
|
static_assert(H > 0 || !throws,
|
|
"THROW and TIMES(0) does not make sense");
|
|
|
|
static_assert(H > 0 || std::is_same<return_type, void>::value,
|
|
"RETURN and TIMES(0) does not make sense");
|
|
|
|
static_assert(H > 0 || !side_effects,
|
|
"SIDE_EFFECT and TIMES(0) does not make sense");
|
|
|
|
matcher.min_calls = L;
|
|
matcher.max_calls = H;
|
|
return {matcher};
|
|
}
|
|
|
|
template <typename ... T,
|
|
bool b = sequence_set>
|
|
call_modifier<Matcher, sequence_injector<Parent> >
|
|
in_sequence(T&& ... t)
|
|
{
|
|
static_assert(!b,
|
|
"Multiple IN_SEQUENCE does not make sense."
|
|
" You can list several sequence objects at once");
|
|
|
|
matcher.set_sequence(std::forward<T>(t)...);
|
|
return {matcher};
|
|
}
|
|
Matcher& matcher;
|
|
};
|
|
|
|
struct expectation {
|
|
virtual ~expectation() = default;
|
|
};
|
|
|
|
inline
|
|
void
|
|
report_unfulfilled(const char* reason,
|
|
char const *name,
|
|
std::string const &values,
|
|
unsigned long long min_calls,
|
|
unsigned long long call_count,
|
|
location loc)
|
|
{
|
|
std::ostringstream os;
|
|
os << reason
|
|
<< ":\nExpected " << name << " to be called ";
|
|
if (min_calls == 1)
|
|
os << "once";
|
|
else
|
|
os << min_calls << " times";
|
|
os << ", actually ";
|
|
switch (call_count)
|
|
{
|
|
case 0:
|
|
os << "never called\n"; break;
|
|
case 1:
|
|
os << "called once\n"; break;
|
|
default:
|
|
os << "called " << call_count << " times\n";
|
|
}
|
|
os << values;
|
|
send_report(severity::nonfatal, loc, os.str());
|
|
}
|
|
|
|
inline
|
|
void
|
|
report_forbidden_call(
|
|
char const *name,
|
|
location loc,
|
|
std::string const& values)
|
|
{
|
|
std::ostringstream os;
|
|
os << "Match of forbidden call of " << name
|
|
<< " at " << loc << '\n' << values;
|
|
send_report(severity::fatal, loc, os.str());
|
|
}
|
|
|
|
template <typename Sig>
|
|
struct matcher_info
|
|
{
|
|
using signature = Sig;
|
|
using return_type = void;
|
|
static unsigned long long const upper_call_limit = 1;
|
|
static bool const throws = false;
|
|
static bool const call_limit_set = false;
|
|
static bool const sequence_set = false;
|
|
static bool const side_effects = false;
|
|
};
|
|
|
|
|
|
template<typename Sig, typename Value>
|
|
struct call_matcher : public call_matcher_base<Sig>, expectation
|
|
{
|
|
template<typename ... U>
|
|
call_matcher(U &&... u) : val(std::forward<U>(u)...) {}
|
|
|
|
call_matcher(call_matcher &&r) = delete;
|
|
|
|
~call_matcher()
|
|
{
|
|
if (is_unfulfilled())
|
|
{
|
|
report_missed("Unfulfilled expectation");
|
|
}
|
|
}
|
|
bool is_unfulfilled() const noexcept
|
|
{
|
|
return !reported && this->is_linked() && call_count < min_calls;
|
|
}
|
|
|
|
void
|
|
mock_destroyed()
|
|
override
|
|
{
|
|
if (is_unfulfilled())
|
|
{
|
|
report_missed("Pending expectation on destroyed mock object");
|
|
}
|
|
}
|
|
|
|
call_matcher& hook_last(call_matcher_list<Sig> &list) noexcept
|
|
{
|
|
list.push_front(this);
|
|
return *this;
|
|
}
|
|
|
|
bool
|
|
matches(call_params_type_t<Sig> const& params)
|
|
const override
|
|
{
|
|
return match_parameters(val, params) && match_conditions(params);
|
|
}
|
|
|
|
bool
|
|
match_conditions(call_params_type_t<Sig> const & params)
|
|
const
|
|
{
|
|
// std::all_of() is almost always preferable. The only reason
|
|
// for using a hand rolled loop is because it cuts compilation
|
|
// times quite noticeably (almost 10% with g++5.1)
|
|
for (auto& c : conditions)
|
|
{
|
|
if (!c.check(params)) return false;
|
|
}
|
|
return true;
|
|
}
|
|
|
|
bool
|
|
first_in_sequence()
|
|
const noexcept override
|
|
{
|
|
auto saturated = call_count >= min_calls;
|
|
return saturated || !sequences || sequences->is_first();
|
|
}
|
|
|
|
return_of_t<Sig>
|
|
return_value(call_params_type_t<Sig>& params)
|
|
override
|
|
{
|
|
if (!return_handler_obj) return default_return<Sig>(params);
|
|
return return_handler_obj->call(params);
|
|
}
|
|
|
|
void
|
|
log_call(
|
|
tracer* obj,
|
|
call_params_type_t<Sig>& params
|
|
)
|
|
const override
|
|
{
|
|
std::ostringstream os;
|
|
os << name << " with.\n" << missed_values(params);
|
|
obj->trace(loc.file, loc.line, os.str());
|
|
}
|
|
void
|
|
run_actions(
|
|
call_params_type_t<Sig>& params,
|
|
call_matcher_list<Sig> &saturated_list)
|
|
override
|
|
{
|
|
if (call_count < min_calls && sequences)
|
|
{
|
|
sequences->validate(name, loc);
|
|
}
|
|
if (max_calls == 0)
|
|
{
|
|
reported = true;
|
|
report_forbidden_call(name, loc, missed_values(params));
|
|
}
|
|
if (++call_count == min_calls && sequences)
|
|
{
|
|
sequences->retire();
|
|
}
|
|
if (call_count == max_calls)
|
|
{
|
|
this->unlink();
|
|
saturated_list.push_back(this);
|
|
}
|
|
for (auto& a : actions) a.action(params);
|
|
}
|
|
|
|
std::ostream&
|
|
report_signature(std::ostream& os)
|
|
const override
|
|
{
|
|
return os << name << " at " << loc;
|
|
}
|
|
|
|
std::ostream&
|
|
report_mismatch(
|
|
std::ostream& os,
|
|
call_params_type_t<Sig> const & params)
|
|
override
|
|
{
|
|
reported = true;
|
|
report_signature(os);
|
|
if (match_parameters(val, params))
|
|
{
|
|
for (auto& cond : conditions)
|
|
{
|
|
if (!cond.check(params))
|
|
{
|
|
os << "\n Failed WITH(" << cond.name() << ')';
|
|
}
|
|
}
|
|
}
|
|
else
|
|
{
|
|
os << '\n';
|
|
parameters<Value>::print_mismatch(os, val, params);
|
|
}
|
|
return os;
|
|
}
|
|
|
|
void
|
|
report_missed(char const *reason)
|
|
override
|
|
{
|
|
reported = true;
|
|
report_unfulfilled(reason,
|
|
name,
|
|
missed_values(val),
|
|
min_calls,
|
|
call_count,
|
|
loc);
|
|
}
|
|
|
|
call_matcher
|
|
&set_location(char const *file_, unsigned line_)
|
|
noexcept
|
|
{
|
|
loc.file = file_;
|
|
loc.line = line_;
|
|
return *this;
|
|
}
|
|
|
|
call_matcher&
|
|
set_name(char const *func_name)
|
|
noexcept
|
|
{
|
|
name = func_name;
|
|
return *this;
|
|
}
|
|
|
|
template <typename C>
|
|
void
|
|
add_condition(char const *str, C&& c)
|
|
{
|
|
auto cond = new condition<Sig, C>(str, std::forward<C>(c));
|
|
conditions.push_back(cond);
|
|
}
|
|
template <typename S>
|
|
void
|
|
add_side_effect(std::true_type, S* s)
|
|
{
|
|
auto effect = new side_effect<Sig, S>(std::move(*s));
|
|
actions.push_back(effect);
|
|
}
|
|
|
|
static // Never called. Used to
|
|
inline // limit errmsg with
|
|
void // SIDE_EFFECT on
|
|
add_side_effect(std::false_type, ...) noexcept; // forbidden call
|
|
|
|
template <typename ... T>
|
|
void
|
|
set_sequence(T&& ... t)
|
|
{
|
|
auto seq = new sequence_handler<sizeof...(T)>(name, loc, std::forward<T>(t)...);
|
|
sequences.reset(seq);
|
|
}
|
|
|
|
template <typename T>
|
|
inline
|
|
void
|
|
set_return(std::true_type, T* h)
|
|
{
|
|
using basic_t = typename std::remove_reference<T>::type;
|
|
using handler = return_handler_t<Sig, basic_t>;
|
|
return_handler_obj.reset(new handler(std::move(*h)));
|
|
}
|
|
inline // Never called. Used to limit errmsg
|
|
static // with RETURN of wring type and after:
|
|
void // FORBIDDEN_CALL
|
|
set_return(std::false_type, ...)// RETURN
|
|
noexcept; // THROW
|
|
|
|
condition_list<Sig> conditions;
|
|
side_effect_list<Sig> actions;
|
|
std::unique_ptr<return_handler<Sig>> return_handler_obj;
|
|
std::unique_ptr<sequence_handler_base> sequences;
|
|
location loc;
|
|
char const *name;
|
|
unsigned long long call_count = 0;
|
|
unsigned long long min_calls = 1;
|
|
unsigned long long max_calls = 1;
|
|
Value val;
|
|
bool reported = false;
|
|
};
|
|
|
|
|
|
template <typename T, int N, bool b = N <= std::tuple_size<T>::value>
|
|
struct arg
|
|
{
|
|
static typename std::tuple_element<N - 1,T>::type value(T& t)
|
|
{
|
|
return std::get<N - 1>(t);
|
|
}
|
|
};
|
|
|
|
template <int N>
|
|
struct illegal_argument {
|
|
illegal_argument(illegal_argument&&) = delete;
|
|
illegal_argument operator&() const = delete;
|
|
template <typename T>
|
|
operator T() const = delete;
|
|
};
|
|
|
|
template <typename T, int N>
|
|
struct arg<T, N, false>
|
|
{
|
|
static illegal_argument<N> const & value(T&) noexcept
|
|
{
|
|
static illegal_argument<N> constexpr v{};
|
|
return v;
|
|
}
|
|
};
|
|
|
|
template <int N, typename T>
|
|
auto mkarg(T& t) noexcept -> decltype(arg<T, N>::value(t))
|
|
{
|
|
return arg<T, N>::value(t);
|
|
}
|
|
|
|
template <typename ... T>
|
|
void ignore(T const& ...) noexcept {}
|
|
|
|
template <typename ... T>
|
|
call_params_type_t<void(T...)> make_params_type_obj(T&& ... t)
|
|
{
|
|
return call_params_type_t<void(T...)>(std::forward<T>(t)...);
|
|
}
|
|
|
|
struct call_validator
|
|
{
|
|
template <typename T>
|
|
static
|
|
auto
|
|
assert_return_type(T&)
|
|
noexcept
|
|
{
|
|
using sigret = return_of_t<typename T::signature>;
|
|
using ret = typename T::return_type;
|
|
constexpr bool retmatch = std::is_same<ret, sigret>::value;
|
|
constexpr bool legal = T::throws || retmatch;
|
|
static_assert(legal, "RETURN missing for non-void function");
|
|
return std::integral_constant<bool, legal>{};
|
|
}
|
|
|
|
template <typename T>
|
|
static
|
|
auto
|
|
make_expectation(std::true_type, T* t) noexcept
|
|
{
|
|
return std::unique_ptr<expectation>(t);
|
|
}
|
|
|
|
static // Never called. Used to
|
|
std::unique_ptr<expectation> // limit errmsg when RETURN
|
|
make_expectation(std::false_type, ...) noexcept; // is missing in non-void
|
|
// function
|
|
|
|
template <typename M, typename Info>
|
|
std::unique_ptr<expectation>
|
|
operator+(call_modifier<M, Info>& t)
|
|
const
|
|
{
|
|
return make_expectation(assert_return_type(t), &t.matcher);
|
|
}
|
|
|
|
template <typename M, typename Info>
|
|
std::unique_ptr<expectation>
|
|
operator+(call_modifier<M, Info>&& t)
|
|
const
|
|
{
|
|
return make_expectation(assert_return_type(t), &t.matcher);
|
|
}
|
|
};
|
|
|
|
template <typename U, typename Sig, typename Value>
|
|
auto make_call_modifier(call_matcher<Sig, Value>& m)
|
|
-> trompeloeil::call_modifier<call_matcher<Sig, Value>, matcher_info<Sig> >
|
|
{
|
|
return {m};
|
|
}
|
|
|
|
template <typename sig, typename ... U>
|
|
auto make_call_matcher(U&& ... u)
|
|
-> ::trompeloeil::call_matcher<sig, decltype(std::make_tuple(std::forward<U>(u)...))>&
|
|
{
|
|
return * new ::trompeloeil::call_matcher<sig, decltype(std::make_tuple(std::forward<U>(u)...))>( std::forward<U>(u)... );
|
|
}
|
|
|
|
}
|
|
|
|
#define TROMPELOEIL_ID(name) \
|
|
TROMPELOEIL_CONCAT(trompeloeil_ ## name ## _, __LINE__)
|
|
|
|
#define TROMPELOEIL_MAKE_MOCK1(name, sig) \
|
|
TROMPELOEIL_MAKE_MOCK_(name,,1, sig, #name, #sig)
|
|
#define TROMPELOEIL_MAKE_MOCK2(name, sig) \
|
|
TROMPELOEIL_MAKE_MOCK_(name,,2, sig, #name, #sig)
|
|
#define TROMPELOEIL_MAKE_MOCK3(name, sig) \
|
|
TROMPELOEIL_MAKE_MOCK_(name,,3, sig, #name, #sig)
|
|
#define TROMPELOEIL_MAKE_MOCK4(name, sig) \
|
|
TROMPELOEIL_MAKE_MOCK_(name,,4, sig, #name, #sig)
|
|
#define TROMPELOEIL_MAKE_MOCK5(name, sig) \
|
|
TROMPELOEIL_MAKE_MOCK_(name,,5, sig, #name, #sig)
|
|
#define TROMPELOEIL_MAKE_MOCK6(name, sig) \
|
|
TROMPELOEIL_MAKE_MOCK_(name,,6, sig, #name, #sig)
|
|
#define TROMPELOEIL_MAKE_MOCK7(name, sig) \
|
|
TROMPELOEIL_MAKE_MOCK_(name,,7, sig, #name, #sig)
|
|
#define TROMPELOEIL_MAKE_MOCK8(name, sig) \
|
|
TROMPELOEIL_MAKE_MOCK_(name,,8, sig, #name, #sig)
|
|
#define TROMPELOEIL_MAKE_MOCK9(name, sig) \
|
|
TROMPELOEIL_MAKE_MOCK_(name,,9, sig, #name, #sig)
|
|
#define TROMPELOEIL_MAKE_MOCK10(name, sig) \
|
|
TROMPELOEIL_MAKE_MOCK_(name,,10, sig, #name, #sig)
|
|
#define TROMPELOEIL_MAKE_MOCK11(name, sig) \
|
|
TROMPELOEIL_MAKE_MOCK_(name,,11, sig, #name, #sig)
|
|
#define TROMPELOEIL_MAKE_MOCK12(name, sig) \
|
|
TROMPELOEIL_MAKE_MOCK_(name,,12, sig, #name, #sig)
|
|
#define TROMPELOEIL_MAKE_MOCK13(name, sig) \
|
|
TROMPELOEIL_MAKE_MOCK_(name,,13, sig, #name, #sig)
|
|
#define TROMPELOEIL_MAKE_MOCK14(name, sig) \
|
|
TROMPELOEIL_MAKE_MOCK_(name,,14, sig, #name, #sig)
|
|
#define TROMPELOEIL_MAKE_MOCK15(name, sig) \
|
|
TROMPELOEIL_MAKE_MOCK_(name,,15, sig, #name, #sig)
|
|
|
|
#define TROMPELOEIL_MAKE_CONST_MOCK1(name, sig) \
|
|
TROMPELOEIL_MAKE_MOCK_(name, const, 1, sig, #name, #sig)
|
|
#define TROMPELOEIL_MAKE_CONST_MOCK2(name, sig) \
|
|
TROMPELOEIL_MAKE_MOCK_(name,const,2, sig, #name, #sig)
|
|
#define TROMPELOEIL_MAKE_CONST_MOCK3(name, sig) \
|
|
TROMPELOEIL_MAKE_MOCK_(name,const,3, sig, #name, #sig)
|
|
#define TROMPELOEIL_MAKE_CONST_MOCK4(name, sig) \
|
|
TROMPELOEIL_MAKE_MOCK_(name,const,4, sig, #name, #sig)
|
|
#define TROMPELOEIL_MAKE_CONST_MOCK5(name, sig) \
|
|
TROMPELOEIL_MAKE_MOCK_(name,const,5, sig, #name, #sig)
|
|
#define TROMPELOEIL_MAKE_CONST_MOCK6(name, sig) \
|
|
TROMPELOEIL_MAKE_MOCK_(name,const,6, sig, #name, #sig)
|
|
#define TROMPELOEIL_MAKE_CONST_MOCK7(name, sig) \
|
|
TROMPELOEIL_MAKE_MOCK_(name,const,7, sig, #name, #sig)
|
|
#define TROMPELOEIL_MAKE_CONST_MOCK8(name, sig) \
|
|
TROMPELOEIL_MAKE_MOCK_(name,const,8, sig, #name, #sig)
|
|
#define TROMPELOEIL_MAKE_CONST_MOCK9(name, sig) \
|
|
TROMPELOEIL_MAKE_MOCK_(name,const,9, sig, #name, #sig)
|
|
#define TROMPELOEIL_MAKE_CONST_MOCK10(name, sig) \
|
|
TROMPELOEIL_MAKE_MOCK_(name,const,10, sig, #name, #sig)
|
|
#define TROMPELOEIL_MAKE_CONST_MOCK11(name, sig) \
|
|
TROMPELOEIL_MAKE_MOCK_(name,const,11, sig, #name, #sig)
|
|
#define TROMPELOEIL_MAKE_CONST_MOCK12(name, sig) \
|
|
TROMPELOEIL_MAKE_MOCK_(name,const,12, sig, #name, #sig)
|
|
#define TROMPELOEIL_MAKE_CONST_MOCK13(name, sig) \
|
|
TROMPELOEIL_MAKE_MOCK_(name,const,13, sig, #name, #sig)
|
|
#define TROMPELOEIL_MAKE_CONST_MOCK14(name, sig) \
|
|
TROMPELOEIL_MAKE_MOCK_(name,const,14, sig, #name, #sig)
|
|
#define TROMPELOEIL_MAKE_CONST_MOCK15(name, sig) \
|
|
TROMPELOEIL_MAKE_MOCK_(name,const,15, sig, #name, #sig)
|
|
|
|
|
|
#define TROMPELOEIL_MAKE_MOCK_(name, constness, num, sig, name_s, sig_s) \
|
|
using TROMPELOEIL_ID(cardinality_match) = std::integral_constant<bool, num == ::trompeloeil::param_list<sig>::size>; \
|
|
static_assert(TROMPELOEIL_ID(cardinality_match)::value, \
|
|
"Function signature does not have " #num " parameters"); \
|
|
using TROMPELOEIL_ID(matcher_list_type) = ::trompeloeil::call_matcher_list<sig>; \
|
|
mutable TROMPELOEIL_ID(matcher_list_type) TROMPELOEIL_ID(matcher_list); \
|
|
mutable TROMPELOEIL_ID(matcher_list_type) TROMPELOEIL_ID(saturated_matcher_list); \
|
|
struct TROMPELOEIL_ID(tag_type_trompeloeil) \
|
|
{ \
|
|
template <typename Mock> \
|
|
struct maker_obj { \
|
|
Mock& obj; \
|
|
const char* file; \
|
|
unsigned long line; \
|
|
const char* call_string; \
|
|
template <typename ... U> \
|
|
auto name(U&& ... u) -> decltype(::trompeloeil::make_call_matcher<sig>(std::forward<U>(u)...)) \
|
|
{ \
|
|
auto& m = ::trompeloeil::make_call_matcher<sig>(std::forward<U>(u)...); \
|
|
m.set_location(file, line); \
|
|
m.set_name(call_string); \
|
|
m.hook_last(obj.trompeloeil_matcher_list(TROMPELOEIL_ID(tag_type_trompeloeil){})); \
|
|
return m; \
|
|
} \
|
|
}; \
|
|
template <typename Mock> \
|
|
static maker_obj<Mock> maker(Mock& obj, const char* file, unsigned long line, const char* name) { return { obj, file, line, name }; } \
|
|
}; \
|
|
TROMPELOEIL_ID(tag_type_trompeloeil) trompeloeil_tag_ ## name(TROMPELOEIL_PARAM_LIST(num, sig)) constness; \
|
|
TROMPELOEIL_ID(matcher_list_type)& \
|
|
trompeloeil_matcher_list(TROMPELOEIL_ID(tag_type_trompeloeil)) constness noexcept \
|
|
{ \
|
|
return TROMPELOEIL_ID(matcher_list); \
|
|
} \
|
|
auto name(TROMPELOEIL_PARAM_LIST(num, sig)) constness -> ::trompeloeil::return_of_t<sig> \
|
|
{ \
|
|
auto param_value = ::trompeloeil::make_params_type_obj(TROMPELOEIL_PARAMS(num)); \
|
|
auto i = ::trompeloeil::find(TROMPELOEIL_ID(cardinality_match){}, \
|
|
param_value, \
|
|
TROMPELOEIL_ID(matcher_list)); \
|
|
if (!i) \
|
|
{ \
|
|
::trompeloeil::report_mismatch(TROMPELOEIL_ID(cardinality_match){},\
|
|
name_s " with signature " sig_s, \
|
|
param_value, \
|
|
TROMPELOEIL_ID(matcher_list), \
|
|
TROMPELOEIL_ID(saturated_matcher_list)); \
|
|
} \
|
|
if (auto obj = ::trompeloeil::tracer_obj()) \
|
|
{ \
|
|
i->log_call(TROMPELOEIL_ID(cardinality_match){}, obj, param_value); \
|
|
} \
|
|
i->run_actions(TROMPELOEIL_ID(cardinality_match){}, \
|
|
param_value, \
|
|
TROMPELOEIL_ID(saturated_matcher_list)); \
|
|
return i->return_value(TROMPELOEIL_ID(cardinality_match){}, \
|
|
param_value); \
|
|
} \
|
|
using TROMPELOEIL_ID(signature_trompeloeil_ ## name) = sig
|
|
|
|
|
|
|
|
#define TROMPELOEIL_REQUIRE_CALL(obj, func) \
|
|
TROMPELOEIL_REQUIRE_CALL_(obj, func, #obj, #func)
|
|
|
|
#define TROMPELOEIL_REQUIRE_CALL_(obj, func, obj_s, func_s) \
|
|
auto TROMPELOEIL_ID(call_obj) = TROMPELOEIL_REQUIRE_CALL_OBJ(obj, func, obj_s, func_s)
|
|
|
|
|
|
#define TROMPELOEIL_NAMED_REQUIRE_CALL(obj, func) \
|
|
TROMPELOEIL_NAMED_REQUIRE_CALL(obj, func, #obj, #func)
|
|
|
|
#define TROMPELOEIL_NAMED_REQUIRE_CALL_(obj, func, obj_s, func_s) \
|
|
TROMPELOEIL_REQUIRE_CALL_OBJ(obj, func, obj_s, func_s)
|
|
|
|
#define TROMPELOEIL_REQUIRE_CALL_OBJ(obj, func, obj_s, func_s) \
|
|
::trompeloeil::call_validator{} + \
|
|
::trompeloeil::make_call_modifier<decltype((obj).func)>(decltype((obj).TROMPELOEIL_CONCAT(trompeloeil_tag_, func) )::maker(obj, __FILE__, __LINE__, obj_s "." func_s).func)
|
|
|
|
|
|
#define TROMPELOEIL_ALLOW_CALL(obj, func) \
|
|
TROMPELOEIL_ALLOW_CALL_(obj, func, #obj, #func)
|
|
|
|
#define TROMPELOEIL_ALLOW_CALL_(obj, func, obj_s, func_s) \
|
|
TROMPELOEIL_REQUIRE_CALL_(obj, func, obj_s, func_s).TROMPELOEIL_TIMES(0, ~0ULL)
|
|
|
|
|
|
#define TROMPELOEIL_NAMED_ALLOW_CALL(obj, func) \
|
|
TROMPELOEIL_NAMED_ALLOW_CALL(obj, func, #obj, #func)
|
|
|
|
#define TROMPELOEIL_NAMED_ALLOW_CALL_(obj, func, obj_s, func_s) \
|
|
TROMPELOEIL_NAMED_REQUIRE_CALL_(obj, func, obj_s, func_s).TROMPELOEIL_TIMES(0, ~0ULL)
|
|
|
|
#define TROMPELOEIL_FORBID_CALL(obj, func) \
|
|
TROMPELOEIL_FORBID_CALL_(obj, func, #obj, #func)
|
|
|
|
#define TROMPELOEIL_FORBID_CALL_(obj, func, obj_s, func_s) \
|
|
TROMPELOEIL_REQUIRE_CALL_(obj, func, obj_s, func_s).TROMPELOEIL_TIMES(0).THROW(false)
|
|
|
|
#define TROMPELOEIL_NAMED_FORBID_CALL(obj, func) \
|
|
TROMPELOEIL_NAMED_FORBID_CALL_(obj, func, #obj, #func)
|
|
|
|
#define TROMPELOEIL_NAMED_FORBID_CALL_(obj, func, obj_s, func_s) \
|
|
TROMPELOEIL_NAMED_REQUIRE_CALL_(obj, func, obj_s, func_s).TROMPELOEIL_TIMES(0).THROW(false)
|
|
|
|
|
|
|
|
#define TROMPELOEIL_WITH(...) \
|
|
TROMPELOEIL_WITH(=,#__VA_ARGS__, __VA_ARGS__)
|
|
#define TROMPELOEIL_LR_WITH(...) \
|
|
TROMPELOEIL_WITH(&,#__VA_ARGS__, __VA_ARGS__)
|
|
|
|
#define TROMPELOEIL_WITH_(capture, arg_s, ...) \
|
|
with(arg_s, [capture](auto const& trompeloeil_x) { \
|
|
auto& _1 = ::trompeloeil::mkarg<1>(trompeloeil_x); \
|
|
auto& _2 = ::trompeloeil::mkarg<2>(trompeloeil_x); \
|
|
auto& _3 = ::trompeloeil::mkarg<3>(trompeloeil_x); \
|
|
auto& _4 = ::trompeloeil::mkarg<4>(trompeloeil_x); \
|
|
auto& _5 = ::trompeloeil::mkarg<5>(trompeloeil_x); \
|
|
auto& _6 = ::trompeloeil::mkarg<6>(trompeloeil_x); \
|
|
auto& _7 = ::trompeloeil::mkarg<7>(trompeloeil_x); \
|
|
auto& _8 = ::trompeloeil::mkarg<8>(trompeloeil_x); \
|
|
auto& _9 = ::trompeloeil::mkarg<9>(trompeloeil_x); \
|
|
auto&_10 = ::trompeloeil::mkarg<10>(trompeloeil_x); \
|
|
auto&_11 = ::trompeloeil::mkarg<11>(trompeloeil_x); \
|
|
auto&_12 = ::trompeloeil::mkarg<12>(trompeloeil_x); \
|
|
auto&_13 = ::trompeloeil::mkarg<13>(trompeloeil_x); \
|
|
auto&_14 = ::trompeloeil::mkarg<14>(trompeloeil_x); \
|
|
auto&_15 = ::trompeloeil::mkarg<15>(trompeloeil_x); \
|
|
::trompeloeil::ignore(_1,_2,_3,_4,_5,_6,_7,_8,_9,_10,_11,_12,_13,_14,_15); \
|
|
return __VA_ARGS__; \
|
|
})
|
|
|
|
#define TROMPELOEIL_SIDE_EFFECT(...) \
|
|
TROMPELOEIL_SIDE_EFFECT_(=, __VA_ARGS__)
|
|
#define TROMPELOEIL_LR_SIDE_EFFECT(...) \
|
|
TROMPELOEIL_SIDE_EFFECT_(&, __VA_ARGS__)
|
|
|
|
#define TROMPELOEIL_SIDE_EFFECT_(capture, ...) \
|
|
sideeffect([capture](auto& trompeloeil_x) { \
|
|
auto& _1 = ::trompeloeil::mkarg<1>(trompeloeil_x); \
|
|
auto& _2 = ::trompeloeil::mkarg<2>(trompeloeil_x); \
|
|
auto& _3 = ::trompeloeil::mkarg<3>(trompeloeil_x); \
|
|
auto& _4 = ::trompeloeil::mkarg<4>(trompeloeil_x); \
|
|
auto& _5 = ::trompeloeil::mkarg<5>(trompeloeil_x); \
|
|
auto& _6 = ::trompeloeil::mkarg<6>(trompeloeil_x); \
|
|
auto& _7 = ::trompeloeil::mkarg<7>(trompeloeil_x); \
|
|
auto& _8 = ::trompeloeil::mkarg<8>(trompeloeil_x); \
|
|
auto& _9 = ::trompeloeil::mkarg<9>(trompeloeil_x); \
|
|
auto&_10 = ::trompeloeil::mkarg<10>(trompeloeil_x); \
|
|
auto&_11 = ::trompeloeil::mkarg<11>(trompeloeil_x); \
|
|
auto&_12 = ::trompeloeil::mkarg<12>(trompeloeil_x); \
|
|
auto&_13 = ::trompeloeil::mkarg<13>(trompeloeil_x); \
|
|
auto&_14 = ::trompeloeil::mkarg<14>(trompeloeil_x); \
|
|
auto&_15 = ::trompeloeil::mkarg<15>(trompeloeil_x); \
|
|
::trompeloeil::ignore(_1,_2,_3,_4,_5,_6,_7,_8,_9,_10,_11,_12,_13,_14,_15); \
|
|
__VA_ARGS__; \
|
|
})
|
|
|
|
#define TROMPELOEIL_RETURN(...) \
|
|
TROMPELOEIL_RETURN_(=, __VA_ARGS__)
|
|
#define TROMPELOEIL_LR_RETURN(...) \
|
|
TROMPELOEIL_RETURN_(&, __VA_ARGS__)
|
|
|
|
#define TROMPELOEIL_RETURN_(capture, ...) \
|
|
handle_return([capture](auto& trompeloeil_x) { \
|
|
auto& _1 = ::trompeloeil::mkarg<1>(trompeloeil_x); \
|
|
auto& _2 = ::trompeloeil::mkarg<2>(trompeloeil_x); \
|
|
auto& _3 = ::trompeloeil::mkarg<3>(trompeloeil_x); \
|
|
auto& _4 = ::trompeloeil::mkarg<4>(trompeloeil_x); \
|
|
auto& _5 = ::trompeloeil::mkarg<5>(trompeloeil_x); \
|
|
auto& _6 = ::trompeloeil::mkarg<6>(trompeloeil_x); \
|
|
auto& _7 = ::trompeloeil::mkarg<7>(trompeloeil_x); \
|
|
auto& _8 = ::trompeloeil::mkarg<8>(trompeloeil_x); \
|
|
auto& _9 = ::trompeloeil::mkarg<9>(trompeloeil_x); \
|
|
auto&_10 = ::trompeloeil::mkarg<10>(trompeloeil_x); \
|
|
auto&_11 = ::trompeloeil::mkarg<11>(trompeloeil_x); \
|
|
auto&_12 = ::trompeloeil::mkarg<12>(trompeloeil_x); \
|
|
auto&_13 = ::trompeloeil::mkarg<13>(trompeloeil_x); \
|
|
auto&_14 = ::trompeloeil::mkarg<14>(trompeloeil_x); \
|
|
auto&_15 = ::trompeloeil::mkarg<15>(trompeloeil_x); \
|
|
::trompeloeil::ignore(_1,_2,_3,_4,_5,_6,_7,_8,_9,_10,_11,_12,_13,_14,_15); \
|
|
return __VA_ARGS__; \
|
|
})
|
|
|
|
#define TROMPELOEIL_THROW(...) \
|
|
TROMPELOEIL_THROW_(=, __VA_ARGS__)
|
|
#define TROMPELOEIL_LR_THROW(...) \
|
|
TROMPELOEIL_THROW_(&, __VA_ARGS__)
|
|
|
|
#define TROMPELOEIL_THROW_(capture, ...) \
|
|
handle_throw([capture](auto& trompeloeil_x) { \
|
|
auto& _1 = ::trompeloeil::mkarg<1>(trompeloeil_x); \
|
|
auto& _2 = ::trompeloeil::mkarg<2>(trompeloeil_x); \
|
|
auto& _3 = ::trompeloeil::mkarg<3>(trompeloeil_x); \
|
|
auto& _4 = ::trompeloeil::mkarg<4>(trompeloeil_x); \
|
|
auto& _5 = ::trompeloeil::mkarg<5>(trompeloeil_x); \
|
|
auto& _6 = ::trompeloeil::mkarg<6>(trompeloeil_x); \
|
|
auto& _7 = ::trompeloeil::mkarg<7>(trompeloeil_x); \
|
|
auto& _8 = ::trompeloeil::mkarg<8>(trompeloeil_x); \
|
|
auto& _9 = ::trompeloeil::mkarg<9>(trompeloeil_x); \
|
|
auto&_10 = ::trompeloeil::mkarg<10>(trompeloeil_x); \
|
|
auto&_11 = ::trompeloeil::mkarg<11>(trompeloeil_x); \
|
|
auto&_12 = ::trompeloeil::mkarg<12>(trompeloeil_x); \
|
|
auto&_13 = ::trompeloeil::mkarg<13>(trompeloeil_x); \
|
|
auto&_14 = ::trompeloeil::mkarg<14>(trompeloeil_x); \
|
|
auto&_15 = ::trompeloeil::mkarg<15>(trompeloeil_x); \
|
|
::trompeloeil::ignore(_1,_2,_3,_4,_5,_6,_7,_8,_9,_10,_11,_12,_13,_14,_15); \
|
|
throw __VA_ARGS__; \
|
|
})
|
|
|
|
|
|
#define TROMPELOEIL_TIMES(...) times(::trompeloeil::multiplicity<__VA_ARGS__>{})
|
|
|
|
#define TROMPELOEIL_IN_SEQUENCE(...) \
|
|
in_sequence(TROMPELOEIL_INIT_WITH_STR(::trompeloeil::sequence_matcher::init_type, __VA_ARGS__))
|
|
|
|
#define TROMPELOEIL_ANY(type) ::trompeloeil::typed_wildcard<type>()
|
|
|
|
#define TROMPELOEIL_AT_LEAST(num) num, ~0ULL
|
|
#define TROMPELOEIL_AT_MOST(num) 0, num
|
|
|
|
#define TROMPELOEIL_REQUIRE_DESTRUCTION(obj) \
|
|
TROMPELOEIL_REQUIRE_DESTRUCTION_(obj, #obj)
|
|
|
|
#define TROMPELOEIL_REQUIRE_DESTRUCTION_(obj, obj_s) \
|
|
::trompeloeil::lifetime_monitor TROMPELOEIL_CONCAT(trompeloeil_death_monitor_, __LINE__)(obj, obj_s, ::trompeloeil::location(__FILE__, __LINE__))
|
|
|
|
#define TROMPELOEIL_NAMED_REQUIRE_DESTRUCTION(obj) \
|
|
TROMPELOEIL_NAMED_REQUIRE_DESTRUCTION(obj, #obj)
|
|
|
|
#define TROMPELOEIL_NAMED_REQUIRE_DESTRUCTION_(obj, obj_s) \
|
|
std::unique_ptr<::trompeloeil::lifetime_monitor>(new ::trompeloeil::lifetime_monitor(obj, obj_s, ::trompeloeil::location(__FILE__, __LINE__)))
|
|
|
|
#ifndef TROMPELOEIL_LONG_MACROS
|
|
#define MAKE_MOCK0(name, sig) \
|
|
TROMPELOEIL_MAKE_MOCK_(name,,0, sig, #name, #sig)
|
|
#define MAKE_MOCK1(name, sig) \
|
|
TROMPELOEIL_MAKE_MOCK_(name,,1, sig, #name, #sig)
|
|
#define MAKE_MOCK2(name, sig) \
|
|
TROMPELOEIL_MAKE_MOCK_(name,,2, sig, #name, #sig)
|
|
#define MAKE_MOCK3(name, sig) \
|
|
TROMPELOEIL_MAKE_MOCK_(name,,3, sig, #name, #sig)
|
|
#define MAKE_MOCK4(name, sig) \
|
|
TROMPELOEIL_MAKE_MOCK_(name,,4, sig, #name, #sig)
|
|
#define MAKE_MOCK5(name, sig) \
|
|
TROMPELOEIL_MAKE_MOCK_(name,,5, sig, #name, #sig)
|
|
#define MAKE_MOCK6(name, sig) \
|
|
TROMPELOEIL_MAKE_MOCK_(name,,6, sig, #name, #sig)
|
|
#define MAKE_MOCK7(name, sig) \
|
|
TROMPELOEIL_MAKE_MOCK_(name,,7, sig, #name, #sig)
|
|
#define MAKE_MOCK8(name, sig) \
|
|
TROMPELOEIL_MAKE_MOCK_(name,,8, sig, #name, #sig)
|
|
#define MAKE_MOCK9(name, sig) \
|
|
TROMPELOEIL_MAKE_MOCK_(name,,9, sig, #name, #sig)
|
|
#define MAKE_MOCK10(name, sig) \
|
|
TROMPELOEIL_MAKE_MOCK_(name,,10, sig, #name, #sig)
|
|
#define MAKE_MOCK11(name, sig) \
|
|
TROMPELOEIL_MAKE_MOCK_(name,,11, sig, #name, #sig)
|
|
#define MAKE_MOCK12(name, sig) \
|
|
TROMPELOEIL_MAKE_MOCK_(name,,12, sig, #name, #sig)
|
|
#define MAKE_MOCK13(name, sig) \
|
|
TROMPELOEIL_MAKE_MOCK_(name,,13, sig, #name, #sig)
|
|
#define MAKE_MOCK14(name, sig) \
|
|
TROMPELOEIL_MAKE_MOCK_(name,,14, sig, #name, #sig)
|
|
#define MAKE_MOCK15(name, sig) \
|
|
TROMPELOEIL_MAKE_MOCK_(name,,15, sig, #name, #sig)
|
|
|
|
#define MAKE_CONST_MOCK0(name, sig) \
|
|
TROMPELOEIL_MAKE_MOCK_(name, const, 0, sig, #name, #sig)
|
|
#define MAKE_CONST_MOCK1(name, sig) \
|
|
TROMPELOEIL_MAKE_MOCK_(name, const, 1, sig, #name, #sig)
|
|
#define MAKE_CONST_MOCK2(name, sig) \
|
|
TROMPELOEIL_MAKE_MOCK_(name,const,2, sig, #name, #sig)
|
|
#define MAKE_CONST_MOCK3(name, sig) \
|
|
TROMPELOEIL_MAKE_MOCK_(name,const,3, sig, #name, #sig)
|
|
#define MAKE_CONST_MOCK4(name, sig) \
|
|
TROMPELOEIL_MAKE_MOCK_(name,const,4, sig, #name, #sig)
|
|
#define MAKE_CONST_MOCK5(name, sig) \
|
|
TROMPELOEIL_MAKE_MOCK_(name,const,5, sig, #name, #sig)
|
|
#define MAKE_CONST_MOCK6(name, sig) \
|
|
TROMPELOEIL_MAKE_MOCK_(name,const,6, sig, #name, #sig)
|
|
#define MAKE_CONST_MOCK7(name, sig) \
|
|
TROMPELOEIL_MAKE_MOCK_(name,const,7, sig, #name, #sig)
|
|
#define MAKE_CONST_MOCK8(name, sig) \
|
|
TROMPELOEIL_MAKE_MOCK_(name,const,8, sig, #name, #sig)
|
|
#define MAKE_CONST_MOCK9(name, sig) \
|
|
TROMPELOEIL_MAKE_MOCK_(name,const,9, sig, #name, #sig)
|
|
#define MAKE_CONST_MOCK10(name, sig) \
|
|
TROMPELOEIL_MAKE_MOCK_(name,const,10, sig, #name, #sig)
|
|
#define MAKE_CONST_MOCK11(name, sig) \
|
|
TROMPELOEIL_MAKE_MOCK_(name,const,11, sig, #name, #sig)
|
|
#define MAKE_CONST_MOCK12(name, sig) \
|
|
TROMPELOEIL_MAKE_MOCK_(name,const,12, sig, #name, #sig)
|
|
#define MAKE_CONST_MOCK13(name, sig) \
|
|
TROMPELOEIL_MAKE_MOCK_(name,const,13, sig, #name, #sig)
|
|
#define MAKE_CONST_MOCK14(name, sig) \
|
|
TROMPELOEIL_MAKE_MOCK_(name,const,14, sig, #name, #sig)
|
|
#define MAKE_CONST_MOCK15(name, sig) \
|
|
TROMPELOEIL_MAKE_MOCK_(name,const,15, sig, #name, #sig)
|
|
|
|
#define REQUIRE_CALL(obj, func) TROMPELOEIL_REQUIRE_CALL_(obj, func, #obj, #func)
|
|
#define NAMED_REQUIRE_CALL(obj, func) TROMPELOEIL_NAMED_REQUIRE_CALL_(obj, func, #obj, #func)
|
|
#define ALLOW_CALL(obj, func) TROMPELOEIL_ALLOW_CALL_(obj, func, #obj, #func)
|
|
#define NAMED_ALLOW_CALL(obj, func) TROMPELOEIL_NAMED_ALLOW_CALL_(obj, func, #obj, #func)
|
|
#define FORBID_CALL(obj, func) TROMPELOEIL_FORBID_CALL_(obj, func, #obj, #func)
|
|
#define NAMED_FORBID_CALL(obj, func) TROMPELOEIL_NAMED_FORBID_CALL_(obj, func, #obj, #func)
|
|
#define WITH(...) TROMPELOEIL_WITH_(=,#__VA_ARGS__, __VA_ARGS__)
|
|
#define LR_WITH(...) TROMPELOEIL_WITH_(&,#__VA_ARGS__, __VA_ARGS__)
|
|
#define SIDE_EFFECT(...) TROMPELOEIL_SIDE_EFFECT_(=, __VA_ARGS__)
|
|
#define LR_SIDE_EFFECT(...) TROMPELOEIL_SIDE_EFFECT_(&, __VA_ARGS__)
|
|
#define RETURN(...) TROMPELOEIL_RETURN_(=,__VA_ARGS__)
|
|
#define LR_RETURN(...) TROMPELOEIL_RETURN_(&, __VA_ARGS__)
|
|
#define THROW(...) TROMPELOEIL_THROW_(=, __VA_ARGS__)
|
|
#define LR_THROW(...) TROMPELOEIL_THROW_(&, __VA_ARGS__)
|
|
#define TIMES(...) TROMPELOEIL_TIMES(__VA_ARGS__)
|
|
#define IN_SEQUENCE(...) TROMPELOEIL_IN_SEQUENCE(__VA_ARGS__)
|
|
#define ANY(type) TROMPELOEIL_ANY(type)
|
|
#define AT_LEAST(num) TROMPELOEIL_AT_LEAST(num)
|
|
#define AT_MOST(num) TROMPELOEIL_AT_MOST(num)
|
|
#define REQUIRE_DESTRUCTION(obj) TROMPELOEIL_REQUIRE_DESTRUCTION_(obj, #obj)
|
|
#define NAMED_REQUIRE_DESTRUCTION(obj)TROMPELOEIL_NAMED_REQUIRE_DESTRUCTION_(obj, #obj)
|
|
#endif
|
|
|
|
#endif // include guard
|