mirror of https://github.com/mosra/magnum.git
Browse Source
Similarly to Corrade Assert.h, so it's possible to include this header without having to worry about irrelevant overhead when asserts are disabled. Also test it properly, as it should have been from the start.pull/234/head
Vladimír Vondruš
6 years ago
17 changed files with 306 additions and 85 deletions
@ -0,0 +1,83 @@
|
||||
#ifndef Magnum_Vk_Assert_h |
||||
#define Magnum_Vk_Assert_h |
||||
/*
|
||||
This file is part of Magnum. |
||||
|
||||
Copyright © 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, |
||||
2020 Vladimír Vondruš <mosra@centrum.cz> |
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a |
||||
copy of this software and associated documentation files (the "Software"), |
||||
to deal in the Software without restriction, including without limitation |
||||
the rights to use, copy, modify, merge, publish, distribute, sublicense, |
||||
and/or sell copies of the Software, and to permit persons to whom the |
||||
Software is furnished to do so, subject to the following conditions: |
||||
|
||||
The above copyright notice and this permission notice shall be included |
||||
in all copies or substantial portions of the Software. |
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL |
||||
THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING |
||||
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER |
||||
DEALINGS IN THE SOFTWARE. |
||||
*/ |
||||
|
||||
/** @file
|
||||
* @brief Macro @ref MAGNUM_VK_INTERNAL_ASSERT_RESULT() |
||||
* @m_since_latest |
||||
*/ |
||||
|
||||
#include <Corrade/Containers/EnumSet.h> |
||||
#include <Corrade/Utility/Assert.h> |
||||
|
||||
#include "Magnum/configure.h" |
||||
|
||||
#if !defined(CORRADE_NO_ASSERT) && !defined(MAGNUM_VK_INTERNAL_ASSERT_RESULT) |
||||
#ifndef CORRADE_STANDARD_ASSERT |
||||
#include <cstdlib> |
||||
#include <Corrade/Utility/Debug.h> |
||||
|
||||
#include "Magnum/Vk/Result.h" |
||||
#elif !defined(NDEBUG) |
||||
#include <cassert> |
||||
#endif |
||||
#endif |
||||
|
||||
/**
|
||||
@brief Assert that a Vulkan function call succeeds |
||||
@m_since_latest |
||||
|
||||
Compared to using @ref CORRADE_INTERNAL_ASSERT_OUTPUT() to verify that |
||||
@cpp call == VK_SUCCESS @ce, this macro also prints the result value. Otherwise |
||||
the behavior is the same, including interactions with |
||||
@ref CORRADE_STANDARD_ASSERT and @ref CORRADE_NO_ASSERT. Works with both plain |
||||
Vulkan functions returning @type_vk{Result} and APIs returning |
||||
@ref Magnum::Vk::Result "Vk::Result". |
||||
|
||||
You can override this implementation by placing your own |
||||
@cpp #define MAGNUM_VK_INTERNAL_ASSERT_RESULT @ce before including the |
||||
@ref Magnum/Vk/Assert.h header. |
||||
*/ |
||||
#ifndef MAGNUM_VK_INTERNAL_ASSERT_RESULT |
||||
#if defined(CORRADE_NO_ASSERT) || (defined(CORRADE_STANDARD_ASSERT) && defined(NDEBUG)) |
||||
#define MAGNUM_VK_INTERNAL_ASSERT_RESULT(call) \ |
||||
static_cast<void>(call) |
||||
#elif defined(CORRADE_STANDARD_ASSERT) |
||||
#define MAGNUM_VK_INTERNAL_ASSERT_RESULT(call) \ |
||||
assert(Magnum::Vk::Result(call) == Magnum::Vk::Result::Success) |
||||
#else |
||||
#define MAGNUM_VK_INTERNAL_ASSERT_RESULT(call) \ |
||||
do { \
|
||||
const Magnum::Vk::Result _CORRADE_HELPER_PASTE(magnumVkResult, __LINE__) = Magnum::Vk::Result(call); \
|
||||
if(_CORRADE_HELPER_PASTE(magnumVkResult, __LINE__) != Magnum::Vk::Result::Success) { \
|
||||
Corrade::Utility::Error{Corrade::Utility::Error::defaultOutput()} << "Call " #call " failed with" << _CORRADE_HELPER_PASTE(magnumVkResult, __LINE__) << "at " __FILE__ ":" CORRADE_LINE_STRING; \
|
||||
std::abort(); \
|
||||
} \
|
||||
} while(false) |
||||
#endif |
||||
#endif |
||||
|
||||
#endif |
||||
@ -0,0 +1,82 @@
|
||||
/*
|
||||
This file is part of Magnum. |
||||
|
||||
Copyright © 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, |
||||
2020 Vladimír Vondruš <mosra@centrum.cz> |
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a |
||||
copy of this software and associated documentation files (the "Software"), |
||||
to deal in the Software without restriction, including without limitation |
||||
the rights to use, copy, modify, merge, publish, distribute, sublicense, |
||||
and/or sell copies of the Software, and to permit persons to whom the |
||||
Software is furnished to do so, subject to the following conditions: |
||||
|
||||
The above copyright notice and this permission notice shall be included |
||||
in all copies or substantial portions of the Software. |
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL |
||||
THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING |
||||
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER |
||||
DEALINGS IN THE SOFTWARE. |
||||
*/ |
||||
|
||||
#include <sstream> |
||||
|
||||
#ifndef CORRADE_STANDARD_ASSERT |
||||
#define CORRADE_NO_ASSERT |
||||
#endif |
||||
|
||||
#include <Corrade/TestSuite/Tester.h> |
||||
#include <Corrade/Utility/DebugStl.h> |
||||
|
||||
#include "Magnum/Vk/Assert.h" |
||||
#include "Magnum/Vk/Result.h" |
||||
|
||||
namespace Magnum { namespace Vk { namespace Test { namespace { |
||||
|
||||
struct AssertDisabledTest: TestSuite::Tester { |
||||
explicit AssertDisabledTest(); |
||||
|
||||
void result(); |
||||
void vkResult(); |
||||
}; |
||||
|
||||
AssertDisabledTest::AssertDisabledTest() { |
||||
addTests({&AssertDisabledTest::result, |
||||
&AssertDisabledTest::vkResult}); |
||||
|
||||
#ifdef CORRADE_STANDARD_ASSERT |
||||
setTestName("Magum::Vk::Test::AssertStandardDisabledTest"); |
||||
#endif |
||||
} |
||||
|
||||
void AssertDisabledTest::result() { |
||||
std::ostringstream out; |
||||
Error redirectError{&out}; |
||||
|
||||
Result a = Result::ErrorUnknown; |
||||
Result r = Result::ErrorFragmentedPool; |
||||
MAGNUM_VK_INTERNAL_ASSERT_RESULT(a = r); |
||||
|
||||
CORRADE_COMPARE(a, Result::ErrorFragmentedPool); |
||||
CORRADE_COMPARE(out.str(), ""); |
||||
} |
||||
|
||||
void AssertDisabledTest::vkResult() { |
||||
std::ostringstream out; |
||||
Error redirectError{&out}; |
||||
|
||||
VkResult a = VK_ERROR_UNKNOWN; |
||||
VkResult r = VK_ERROR_FRAGMENTED_POOL; |
||||
MAGNUM_VK_INTERNAL_ASSERT_RESULT(a = r); |
||||
|
||||
CORRADE_COMPARE(Result(a), Result::ErrorFragmentedPool); |
||||
CORRADE_COMPARE(out.str(), ""); |
||||
} |
||||
|
||||
}}}} |
||||
|
||||
CORRADE_TEST_MAIN(Magnum::Vk::Test::AssertDisabledTest) |
||||
@ -0,0 +1,84 @@
|
||||
/*
|
||||
This file is part of Magnum. |
||||
|
||||
Copyright © 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, |
||||
2020 Vladimír Vondruš <mosra@centrum.cz> |
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a |
||||
copy of this software and associated documentation files (the "Software"), |
||||
to deal in the Software without restriction, including without limitation |
||||
the rights to use, copy, modify, merge, publish, distribute, sublicense, |
||||
and/or sell copies of the Software, and to permit persons to whom the |
||||
Software is furnished to do so, subject to the following conditions: |
||||
|
||||
The above copyright notice and this permission notice shall be included |
||||
in all copies or substantial portions of the Software. |
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL |
||||
THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING |
||||
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER |
||||
DEALINGS IN THE SOFTWARE. |
||||
*/ |
||||
|
||||
#ifdef CORRADE_STANDARD_ASSERT |
||||
#undef NDEBUG /* So we can test them */ |
||||
#endif |
||||
|
||||
#include <Corrade/TestSuite/Tester.h> |
||||
#include <Corrade/Utility/Arguments.h> |
||||
|
||||
#include "Magnum/Vk/Assert.h" |
||||
#include "Magnum/Vk/Result.h" |
||||
|
||||
namespace Magnum { namespace Vk { namespace Test { namespace { |
||||
|
||||
struct AssertTest: TestSuite::Tester { |
||||
explicit AssertTest(); |
||||
|
||||
void result(); |
||||
void vkResult(); |
||||
|
||||
bool _failAssertResult, _failAssertVkResult; |
||||
}; |
||||
|
||||
AssertTest::AssertTest(): TestSuite::Tester{TesterConfiguration{}.setSkippedArgumentPrefixes({"fail-on"})} { |
||||
addTests({&AssertTest::result, |
||||
&AssertTest::vkResult}); |
||||
|
||||
Utility::Arguments args{"fail-on"}; |
||||
args.addOption("assert-result", "false").setHelp("assert-result", "fail on MAGNUM_VK_INTERNAL_ASSERT_RESULT() with Vk::Result", "BOOL") |
||||
.addOption("assert-vk-result", "false").setHelp("assert-vk-result", "fail on MAGNUM_VK_INTERNAL_ASSERT_RESULT() with VkResult", "BOOL") |
||||
.parse(arguments().first, arguments().second); |
||||
|
||||
_failAssertResult = args.value<bool>("assert-result"); |
||||
_failAssertVkResult = args.value<bool>("assert-vk-result"); |
||||
|
||||
#ifdef CORRADE_STANDARD_ASSERT |
||||
setTestName("Magum::Vk::Test::AssertStandardTest"); |
||||
#endif |
||||
} |
||||
|
||||
void AssertTest::result() { |
||||
Result a = Result::ErrorUnknown; |
||||
|
||||
Result r = _failAssertResult ? Result::ErrorFragmentedPool : Result::Success; |
||||
MAGNUM_VK_INTERNAL_ASSERT_RESULT(a = r); |
||||
|
||||
CORRADE_COMPARE(a, Result::Success); |
||||
} |
||||
|
||||
void AssertTest::vkResult() { |
||||
VkResult a = VK_ERROR_UNKNOWN; |
||||
|
||||
VkResult s = _failAssertVkResult ? VK_ERROR_FRAGMENTED_POOL : VK_SUCCESS; |
||||
MAGNUM_VK_INTERNAL_ASSERT_RESULT(a = s); |
||||
|
||||
CORRADE_COMPARE(Result(a), Result::Success); |
||||
} |
||||
|
||||
}}}} |
||||
|
||||
CORRADE_TEST_MAIN(Magnum::Vk::Test::AssertTest) |
||||
Loading…
Reference in new issue