Use C++20 source_location feature in exceptions #473
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
IAmNotHanni
added
cat:enhancement
|
Oh it looks like clang isn't ready for source_location yet. |
IAmNotHanni
changed the title
IceflowRE
requested changes
Jun 30, 2022
| class InexorException : public std::runtime_error { | ||
| public: | ||
| // No need to define own constructors. | ||
| // There is no need to define our own constructors |
There was a problem hiding this comment.
Suggested change
| // There is no need to define our own constructors | |
| // There is no need to define our own constructors. |
| #include <stdexcept> | ||
| #include <string> | ||
|
|
||
| namespace inexor::vulkan_renderer { | ||
|
|
||
| /// @brief A custom base class for exceptions | ||
| /// A custom base class for exceptions |
There was a problem hiding this comment.
Suggested change
| /// A custom base class for exceptions | |
| /// A custom base class for exceptions. |
Comment on lines
+21
to
+27
| /// Default constructor | ||
| /// Here we are using `C++20 source location feature <https://en.cppreference.com/w/cpp/utility/source_location>`__ | ||
| /// @param message The exception message | ||
| /// @param result The VkResult value of the Vulkan API call which failed | ||
| /// @param location The source location | ||
| VulkanException(std::string message, VkResult result, | ||
| std::source_location location = std::source_location::current()); |
There was a problem hiding this comment.
Suggested change
| /// Default constructor | |
| /// Here we are using `C++20 source location feature <https://en.cppreference.com/w/cpp/utility/source_location>`__ | |
| /// @param message The exception message | |
| /// @param result The VkResult value of the Vulkan API call which failed | |
| /// @param location The source location | |
| VulkanException(std::string message, VkResult result, | |
| std::source_location location = std::source_location::current()); | |
| /// Default constructor. | |
| /// @param message The exception message. | |
| /// @param result The VkResult value of the Vulkan API call which failed. | |
| /// @param location The source location. | |
| VulkanException(std::string message, VkResult result, | |
| std::source_location location = std::source_location::current()); |
I would not especially point out the new C++20 feature.
Comment on lines
+7
to
+20
| VulkanException::VulkanException(std::string message, const VkResult result, const std::source_location location) | ||
| : InexorException(message.append(" (") | ||
| .append(vk_tools::as_string(result)) | ||
| .append(": ") | ||
| .append(vk_tools::result_to_description(result)) | ||
| .append(") (") | ||
| .append("file: ") | ||
| .append(location.file_name()) | ||
| .append(", line: ") | ||
| .append(std::to_string(location.line())) | ||
| .append(", column: ") | ||
| .append(std::to_string(location.column())) | ||
| .append(", function name: ") | ||
| .append(location.function_name()) |
There was a problem hiding this comment.
Since we are using C++20 we could use std::format here.
|
Clang 15 now supports |
|
Note for myself: The exception class can be made |
IAmNotHanni
added
prio:low
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #468
Source locations!
C++20 gives us a very nice new feature, std::source_location!
VulkanException(std::string message, VkResult result, std::source_location location = std::source_location::current());Throwing an example exception from rendergraph:
Results in:
(Note that I didn't add a catch block, so the exception will not be caught properly. However this was only a proof of concept)
This will make debugging a lot easier!