Skip to content

Add RCUTILS_CAN_SET_ERROR_MSG_AND_RETURN_WITH_ERROR_OF() macro. #284

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
hidmic merged 3 commits into from
Aug 28, 2020
Merged

Add RCUTILS_CAN_SET_ERROR_MSG_AND_RETURN_WITH_ERROR_OF() macro. #284

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
eb8809c
Add RCUTILS_CAN_SET_ERROR_MSG_AND_RETURN_WITH_ERROR_OF() macro.
hidmic Aug 26, 2020
37a3a29
Address peer review comments.
hidmic Aug 27, 2020
a8903ed
Please uncrustify.
hidmic Aug 27, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions include/rcutils/error_handling.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -223,6 +223,24 @@ rcutils_set_error_state(const char * error_string, const char * file, size_t lin
} \
} while (0)

/// Indicate that the function intends to set an error message and return an error value.
Copy link
Contributor

@brawner brawner Aug 26, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would add some comment mentioning that this is part of the fault injection so people understand its intended purpose.

/**
* \def RCUTILS_CAN_SET_MSG_AND_RETURN_WITH_ERROR_OF
* Indicating macro similar to RCUTILS_CAN_RETURN_WITH_ERROR_OF, that also sets an error
* message.
*
* For now, this macro simply relies on `RCUTILS_CAN_FAIL_WITH` to set a generic error
* message and return the given `error_return_value` if fault injection is enabled.
*
* \param error_return_value the value returned as a result of a given error.
*/
#define RCUTILS_CAN_SET_MSG_AND_RETURN_WITH_ERROR_OF(error_return_value) \
RCUTILS_CAN_FAIL_WITH( \
{ \
RCUTILS_SET_ERROR_MSG("Injecting " RCUTILS_STRINGIFY(error_return_value)); \
return error_return_value; \
})

/// Return `true` if the error is set, otherwise `false`.
RCUTILS_PUBLIC
RCUTILS_WARN_UNUSED
Expand Down