#include "rmw/macros.h"
#include "rmw/types.h"

Include dependency graph for validate_node_name.h:

Macros
#define	RMW_NODE_NAME_VALID 0

#define	RMW_NODE_NAME_INVALID_IS_EMPTY_STRING 1

#define	RMW_NODE_NAME_INVALID_CONTAINS_UNALLOWED_CHARACTERS 2

#define	RMW_NODE_NAME_INVALID_STARTS_WITH_NUMBER 3

#define	RMW_NODE_NAME_INVALID_TOO_LONG 4

#define	RMW_NODE_NAME_MAX_NAME_LENGTH 255 /* arbitrary constraint */

Functions
rmw_ret_t	rmw_validate_node_name (const char node_name, int validation_result, size_t *invalid_index)
	Determine if a node name is valid. More...

rmw_ret_t	rmw_validate_node_name_with_size (const char node_name, size_t node_name_length, int validation_result, size_t *invalid_index)
	Deterimine if a given node name is valid. More...

const char *	rmw_node_name_validation_result_string (int validation_result)
	Return a validation result description, or NULL if unknown or RMW_NODE_NAME_VALID. More...

Macro Definition Documentation

◆ RMW_NODE_NAME_VALID

#define RMW_NODE_NAME_VALID 0

◆ RMW_NODE_NAME_INVALID_IS_EMPTY_STRING

#define RMW_NODE_NAME_INVALID_IS_EMPTY_STRING 1

◆ RMW_NODE_NAME_INVALID_CONTAINS_UNALLOWED_CHARACTERS

#define RMW_NODE_NAME_INVALID_CONTAINS_UNALLOWED_CHARACTERS 2

◆ RMW_NODE_NAME_INVALID_STARTS_WITH_NUMBER

#define RMW_NODE_NAME_INVALID_STARTS_WITH_NUMBER 3

◆ RMW_NODE_NAME_INVALID_TOO_LONG

#define RMW_NODE_NAME_INVALID_TOO_LONG 4

◆ RMW_NODE_NAME_MAX_NAME_LENGTH

#define RMW_NODE_NAME_MAX_NAME_LENGTH 255 /* arbitrary constraint */

Function Documentation

◆ rmw_validate_node_name()

rmw_ret_t rmw_validate_node_name	(	const char *	node_name,
		int *	validation_result,
		size_t *	invalid_index
	)

Determine if a node name is valid.

Node names must follow these rules:

must not be an empty string
must only contain alphanumeric characters and underscores (a-z|A-Z|0-9|_)
must not start with a number

If either the node name C string or validation_result pointer are null, then RMW_RET_INVALID_ARGUMENT will be returned. The node_name should be a valid, null-terminated C string. The validation_result int pointer should point to valid memory so a result can be stored in it as an output variable. The invalid_index size_t pointer should either point NULL or to valid memory so in the event of a validation error, the location in the input string can be stored therein. If NULL is passed in for invalid_index, it will be not be set.

The invalid_index will not be assigned a value if the node name is valid.

The int which validation_result points to will have a one of a few possible results values (defined with macros) stored into it:

RMW_NODE_NAME_VALID
RMW_NODE_NAME_INVALID_IS_EMPTY_STRING
RMW_NODE_NAME_INVALID_CONTAINS_UNALLOWED_CHARACTERS
RMW_NODE_NAME_INVALID_STARTS_WITH_NUMBER
RMW_NODE_NAME_INVALID_TOO_LONG

The result value can be converted to a description with the rmw_node_name_validation_result_string() function.

The RMW_NODE_NAME_INVALID_TOO_LONG is guaranteed to be checked last, such that if you get that result, then you can assume all other checks succeeded. This is done so that the length limit can be treated as a warning rather than an error if desired.

Parameters

[in]	node_name	node name to be validated
[out]	validation_result	int in which the result of the check is stored
[out]	invalid_index	size_t index of the input string where an error occurred

Returns: RMW_RET_OK on successfully running the check, or; RMW_RET_INVALID_ARGUMENT on invalid parameters, or; RMW_RET_ERROR when an unspecified error occurs.

◆ rmw_validate_node_name_with_size()

rmw_ret_t rmw_validate_node_name_with_size	(	const char *	node_name,
		size_t	node_name_length,
		int *	validation_result,
		size_t *	invalid_index
	)

Deterimine if a given node name is valid.

This is an overload with an extra parameter for the length of node_name.

Parameters

[in] node_name_length The number of characters in node_name.

See also: rmw_validate_node_name(const char *, int *, size_t *)

◆ rmw_node_name_validation_result_string()

const char* rmw_node_name_validation_result_string ( int validation_result )

Return a validation result description, or NULL if unknown or RMW_NODE_NAME_VALID.

Macros

Functions