1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
|
// Copyright 2017 Open Source Robotics Foundation, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
/// \file
#ifndef RCUTILS__STRDUP_H_
#define RCUTILS__STRDUP_H_
#ifdef __cplusplus
extern "C"
{
#endif
#include <string.h>
#include "rcutils/allocator.h"
#include "rcutils/macros.h"
#include "rcutils/visibility_control.h"
/// Return a duplicated string with an allocator, or null if an error occurs.
/**
* This function is identical to rcutils_strndup() except the length of the
* c string does not have to be given and therefore the c string must be
* null terminated.
*
* \see rcutils_strndup()
*
* \param[in] str null terminated c string to be duplicated
* \param[in] allocator the allocator to use for allocation
* \return duplicated string, or
* \return `NULL` if there is an error.
*/
RCUTILS_PUBLIC
RCUTILS_WARN_UNUSED
char *
rcutils_strdup(const char * str, rcutils_allocator_t allocator);
/// Return a duplicated string with an allocator, or null if an error occurs.
/**
* This function can fail and return null if memory cannot be allocated or
* if the input c string pointer is null.
* In both cases no error message is set.
* The returned string should be deallocated using the given allocator when
* it is no longer needed.
*
* The max_length given does not include the null terminating character.
* Therefore a max_length of 0 will still result in a duplicated string, but
* the string will be an empty string of strlen 0, but it still must be
* deallocated.
* All returned strings are null terminated.
*
* \param[in] str null terminated c string to be duplicated
* \param[in] max_length maximum length of the string to duplicate
* \param[in] allocator the allocator to use for allocation
* \return duplicated string, or
* \return `NULL` if there is an error.
*/
RCUTILS_PUBLIC
RCUTILS_WARN_UNUSED
char *
rcutils_strndup(const char * str, size_t max_length, rcutils_allocator_t allocator);
#ifdef __cplusplus
}
#endif
#endif // RCUTILS__STRDUP_H_
|
