niklas/rcl
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

[rcl action] Addresses peer review comments (#329)

Browse source
This commit is contained in:
Michel Hidalgo 2018-11-14 19:33:21 -03:00
parent d77c9b6965
commit 276aed1dff
3 changed files with 48 additions and 23 deletions
Download patch file Download diff file Expand all files Collapse all files

58
rcl_action/include/rcl_action/names.h
View file

@ -21,6 +21,7 @@ extern "C"
#endif #endif
#include "rcl_action/visibility_control.h" #include "rcl_action/visibility_control.h"
#include "rcl_action/types.h"
#include "rcl/allocator.h" #include "rcl/allocator.h"
#include "rcl/macros.h" #include "rcl/macros.h"
@ -41,14 +42,19 @@ extern "C"
* Uses Atomics | No * Uses Atomics | No
* Lock-Free | Yes * Lock-Free | Yes
* *
* \param[in] action_name The non-empty name of the action whose goal * \param[in] action_name The name of the action whose goal service name is
* service name is being returned. * being returned.
* \param[in] allocator A valid allocator to be used. * \param[in] allocator A valid allocator to be used.
* \param[out] goal_service_name Either an allocated string with the action * \param[out] goal_service_name Either an allocated string with the action
* goal service name, or `NULL` if the function failed to allocate memory * goal service name, or `NULL` if the function failed to allocate memory
* for it. Must refer to a `NULL` pointer upon call. * for it. Must refer to a `NULL` pointer upon call.
* \return `RCL_RET_OK` if the action goal service name was returned, or * \return `RCL_RET_OK` if the action goal service name was returned, or
* \return `RCL_RET_INVALID_ARGUMENT` if any arguments are invalid, or * \return `RCL_RET_ACTION_NAME_INVALID` if the action name is not valid
* (i.e. empty), or
* \return `RCL_RET_INVALID_ARGUMENT` if the action name is `NULL`, or
* \return `RCL_RET_INVALID_ARGUMENT` if the allocator is invalid, or
* \return `RCL_RET_INVALID_ARGUMENT` if the goal service name pointer is
* `NULL` or points to a non-`NULL` pointer, or
* \return `RCL_RET_BAD_ALLOC` if allocating memory failed. * \return `RCL_RET_BAD_ALLOC` if allocating memory failed.
*/ */
RCL_ACTION_PUBLIC RCL_ACTION_PUBLIC
@ -73,14 +79,19 @@ rcl_action_get_goal_service_name(
* Uses Atomics | No * Uses Atomics | No
* Lock-Free | Yes * Lock-Free | Yes
* *
* \param[in] action_name The non-empty name of the action whose cancel * \param[in] action_name The name of the action whose cancel service name
* service name is being returned. * is being returned.
* \param[in] allocator A valid allocator to be used. * \param[in] allocator A valid allocator to be used.
* \param[out] cancel_service_name Either an allocated string with the action * \param[out] cancel_service_name Either an allocated string with the action
* cancel service name, or `NULL` if the function failed to allocate memory * cancel service name, or `NULL` if the function failed to allocate memory
* for it. Must refer to a `NULL` pointer upon call. * for it. Must refer to a `NULL` pointer upon call.
* \return `RCL_RET_OK` if the action cancel service name was returned, or * \return `RCL_RET_OK` if the action cancel service name was returned, or
* \return `RCL_RET_INVALID_ARGUMENT` if any arguments are invalid, or * \return `RCL_RET_ACTION_NAME_INVALID` if the action name is not valid
* (i.e. empty), or
* \return `RCL_RET_INVALID_ARGUMENT` if the action name is `NULL`, or
* \return `RCL_RET_INVALID_ARGUMENT` if the allocator is invalid, or
* \return `RCL_RET_INVALID_ARGUMENT` if the cancel service name is `NULL` or
* points to a non-`NULL` pointer, or
* \return `RCL_RET_BAD_ALLOC` if allocating memory failed. * \return `RCL_RET_BAD_ALLOC` if allocating memory failed.
*/ */
RCL_ACTION_PUBLIC RCL_ACTION_PUBLIC
@ -105,14 +116,19 @@ rcl_action_get_cancel_service_name(
* Uses Atomics | No * Uses Atomics | No
* Lock-Free | Yes * Lock-Free | Yes
* *
* \param[in] action_name The non-empty name of the action whose result service * \param[in] action_name The name of the action whose result service name
* name is being returned. * is being returned.
* \param[in] allocator A valid allocator to be used. * \param[in] allocator A valid allocator to be used.
* \param[out] result_service_name Either an allocated string with the action * \param[out] result_service_name Either an allocated string with the action
* result service name, or `NULL` if the function failed to allocate memory * result service name, or `NULL` if the function failed to allocate memory
* for it. Must refer to a `NULL` pointer upon call. * for it. Must refer to a `NULL` pointer upon call.
* \return `RCL_RET_OK` if the action result service name was returned, or * \return `RCL_RET_OK` if the action result service name was returned, or
* \return `RCL_RET_INVALID_ARGUMENT` if any arguments are invalid, or * \return `RCL_RET_ACTION_NAME_INVALID` if the action name is not valid
* (i.e. empty), or
* \return `RCL_RET_INVALID_ARGUMENT` if the action name is `NULL`, or
* \return `RCL_RET_INVALID_ARGUMENT` if the allocator is invalid, or
* \return `RCL_RET_INVALID_ARGUMENT` if the result service name pointer is
* `NULL` or points to a non-`NULL` pointer, or
* \return `RCL_RET_BAD_ALLOC` if allocating memory failed. * \return `RCL_RET_BAD_ALLOC` if allocating memory failed.
*/ */
RCL_ACTION_PUBLIC RCL_ACTION_PUBLIC
@ -137,14 +153,19 @@ rcl_action_get_result_service_name(
* Uses Atomics | No * Uses Atomics | No
* Lock-Free | Yes * Lock-Free | Yes
* *
* \param[in] action_name The non-empty name of the action whose feedback * \param[in] action_name The name of the action whose feedback topic name
* topic name is being returned. * is being returned.
* \param[in] allocator A valid allocator to be used. * \param[in] allocator A valid allocator to be used.
* \param[out] result_service_name Either an allocated string with the action * \param[out] feedback_topic_name Either an allocated string with the action
* feedback topic name, or `NULL` if the function failed to allocate memory * feedback topic name, or `NULL` if the function failed to allocate memory
* for it. Must refer to a `NULL` pointer upon call. * for it. Must refer to a `NULL` pointer upon call.
* \return `RCL_RET_OK` if the action feedback topic name was returned, or * \return `RCL_RET_OK` if the action feedback topic name was returned, or
* \return `RCL_RET_INVALID_ARGUMENT` if any arguments are invalid, or * \return `RCL_RET_ACTION_NAME_INVALID` if the action name is not valid
* (i.e. empty), or
* \return `RCL_RET_INVALID_ARGUMENT` if the action name is `NULL`, or
* \return `RCL_RET_INVALID_ARGUMENT` if the allocator is invalid, or
* \return `RCL_RET_INVALID_ARGUMENT` if the feedback topic name pointer is
* `NULL` or points to a non-`NULL` pointer, or
* \return `RCL_RET_BAD_ALLOC` if allocating memory failed. * \return `RCL_RET_BAD_ALLOC` if allocating memory failed.
*/ */
RCL_ACTION_PUBLIC RCL_ACTION_PUBLIC
@ -169,14 +190,19 @@ rcl_action_get_feedback_topic_name(
* Uses Atomics | No * Uses Atomics | No
* Lock-Free | Yes * Lock-Free | Yes
* *
* \param[in] action_name The non-empty name of the action whose status topic * \param[in] action_name The name of the action whose status topic
* name is being returned. * name is being returned.
* \param[in] allocator A valid allocator to be used. * \param[in] allocator A valid allocator to be used.
* \param[out] result_service_name Either an allocated string with the action * \param[out] status_topic_name Either an allocated string with the action
* status topic name, or `NULL` if the function failed to allocate memory * status topic name, or `NULL` if the function failed to allocate memory
* for it. Must refer to a `NULL` pointer upon call. * for it. Must refer to a `NULL` pointer upon call.
* \return `RCL_RET_OK` if the action status topic name was returned, or * \return `RCL_RET_OK` if the action status topic name was returned, or
* \return `RCL_RET_INVALID_ARGUMENT` if any arguments are invalid, or * \return `RCL_RET_ACTION_NAME_INVALID` if the action name is not valid
* (i.e. empty), or
* \return `RCL_RET_INVALID_ARGUMENT` if the action name is `NULL`, or
* \return `RCL_RET_INVALID_ARGUMENT` if the allocator is invalid, or
* \return `RCL_RET_INVALID_ARGUMENT` if the status topic name pointer is
* `NULL` or points to a non-`NULL` pointer, or
* \return `RCL_RET_BAD_ALLOC` if allocating memory failed. * \return `RCL_RET_BAD_ALLOC` if allocating memory failed.
*/ */
RCL_ACTION_PUBLIC RCL_ACTION_PUBLIC

11
rcl_action/src/rcl_action/names.c
View file

@ -34,7 +34,7 @@ rcl_action_get_goal_service_name(
RCL_CHECK_ARGUMENT_FOR_NULL(action_name, RCL_RET_INVALID_ARGUMENT); RCL_CHECK_ARGUMENT_FOR_NULL(action_name, RCL_RET_INVALID_ARGUMENT);
if (0 == strlen(action_name)) { if (0 == strlen(action_name)) {
RCL_SET_ERROR_MSG("invalid empty action name"); RCL_SET_ERROR_MSG("invalid empty action name");
return RCL_RET_INVALID_ARGUMENT; return RCL_RET_ACTION_NAME_INVALID;
} }
RCL_CHECK_ARGUMENT_FOR_NULL(goal_service_name, RCL_RET_INVALID_ARGUMENT); RCL_CHECK_ARGUMENT_FOR_NULL(goal_service_name, RCL_RET_INVALID_ARGUMENT);
if (NULL != *goal_service_name) { if (NULL != *goal_service_name) {
@ -57,10 +57,9 @@ rcl_action_get_cancel_service_name(
{ {
RCL_CHECK_ALLOCATOR_WITH_MSG(&allocator, "allocator is invalid", return RCL_RET_INVALID_ARGUMENT); RCL_CHECK_ALLOCATOR_WITH_MSG(&allocator, "allocator is invalid", return RCL_RET_INVALID_ARGUMENT);
RCL_CHECK_ARGUMENT_FOR_NULL(action_name, RCL_RET_INVALID_ARGUMENT); RCL_CHECK_ARGUMENT_FOR_NULL(action_name, RCL_RET_INVALID_ARGUMENT);
RCL_CHECK_ARGUMENT_FOR_NULL(action_name, RCL_RET_INVALID_ARGUMENT);
if (0 == strlen(action_name)) { if (0 == strlen(action_name)) {
RCL_SET_ERROR_MSG("invalid empty action name"); RCL_SET_ERROR_MSG("invalid empty action name");
return RCL_RET_INVALID_ARGUMENT; return RCL_RET_ACTION_NAME_INVALID;
} }
RCL_CHECK_ARGUMENT_FOR_NULL(cancel_service_name, RCL_RET_INVALID_ARGUMENT); RCL_CHECK_ARGUMENT_FOR_NULL(cancel_service_name, RCL_RET_INVALID_ARGUMENT);
if (NULL != *cancel_service_name) { if (NULL != *cancel_service_name) {
@ -85,7 +84,7 @@ rcl_action_get_result_service_name(
RCL_CHECK_ARGUMENT_FOR_NULL(action_name, RCL_RET_INVALID_ARGUMENT); RCL_CHECK_ARGUMENT_FOR_NULL(action_name, RCL_RET_INVALID_ARGUMENT);
if (0 == strlen(action_name)) { if (0 == strlen(action_name)) {
RCL_SET_ERROR_MSG("invalid empty action name"); RCL_SET_ERROR_MSG("invalid empty action name");
return RCL_RET_INVALID_ARGUMENT; return RCL_RET_ACTION_NAME_INVALID;
} }
RCL_CHECK_ARGUMENT_FOR_NULL(result_service_name, RCL_RET_INVALID_ARGUMENT); RCL_CHECK_ARGUMENT_FOR_NULL(result_service_name, RCL_RET_INVALID_ARGUMENT);
if (NULL != *result_service_name) { if (NULL != *result_service_name) {
@ -110,7 +109,7 @@ rcl_action_get_feedback_topic_name(
RCL_CHECK_ARGUMENT_FOR_NULL(action_name, RCL_RET_INVALID_ARGUMENT); RCL_CHECK_ARGUMENT_FOR_NULL(action_name, RCL_RET_INVALID_ARGUMENT);
if (0 == strlen(action_name)) { if (0 == strlen(action_name)) {
RCL_SET_ERROR_MSG("invalid empty action name"); RCL_SET_ERROR_MSG("invalid empty action name");
return RCL_RET_INVALID_ARGUMENT; return RCL_RET_ACTION_NAME_INVALID;
} }
RCL_CHECK_ARGUMENT_FOR_NULL(feedback_topic_name, RCL_RET_INVALID_ARGUMENT); RCL_CHECK_ARGUMENT_FOR_NULL(feedback_topic_name, RCL_RET_INVALID_ARGUMENT);
if (NULL != *feedback_topic_name) { if (NULL != *feedback_topic_name) {
@ -135,7 +134,7 @@ rcl_action_get_status_topic_name(
RCL_CHECK_ARGUMENT_FOR_NULL(action_name, RCL_RET_INVALID_ARGUMENT); RCL_CHECK_ARGUMENT_FOR_NULL(action_name, RCL_RET_INVALID_ARGUMENT);
if (0 == strlen(action_name)) { if (0 == strlen(action_name)) {
RCL_SET_ERROR_MSG("invalid empty action name"); RCL_SET_ERROR_MSG("invalid empty action name");
return RCL_RET_INVALID_ARGUMENT; return RCL_RET_ACTION_NAME_INVALID;
} }
RCL_CHECK_ARGUMENT_FOR_NULL(status_topic_name, RCL_RET_INVALID_ARGUMENT); RCL_CHECK_ARGUMENT_FOR_NULL(status_topic_name, RCL_RET_INVALID_ARGUMENT);
if (NULL != *status_topic_name) { if (NULL != *status_topic_name) {

2
rcl_action/test/rcl_action/test_names.cpp
View file

@ -62,7 +62,7 @@ TEST_P(TestActionDerivedName, validate_action_derived_getter)
ret = test_subject.get_action_derived_name( ret = test_subject.get_action_derived_name(
invalid_action_name, default_allocator, invalid_action_name, default_allocator,
&action_derived_name); &action_derived_name);
EXPECT_EQ(RCL_RET_INVALID_ARGUMENT, ret); EXPECT_EQ(RCL_RET_ACTION_NAME_INVALID, ret);
action_derived_name = NULL; action_derived_name = NULL;
rcl_allocator_t invalid_allocator = rcl_allocator_t invalid_allocator =