rcutils  master
C API providing common utilities and data structures.
char_array.h
Go to the documentation of this file.
1 // Copyright 2018 Open Source Robotics Foundation, Inc.
2 //
3 // Licensed under the Apache License, Version 2.0 (the "License");
4 // you may not use this file except in compliance with the License.
5 // You may obtain a copy of the License at
6 //
7 // http://www.apache.org/licenses/LICENSE-2.0
8 //
9 // Unless required by applicable law or agreed to in writing, software
10 // distributed under the License is distributed on an "AS IS" BASIS,
11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 // See the License for the specific language governing permissions and
13 // limitations under the License.
14 
16 
17 #ifndef RCUTILS__TYPES__CHAR_ARRAY_H_
18 #define RCUTILS__TYPES__CHAR_ARRAY_H_
19 
20 #if __cplusplus
21 extern "C"
22 {
23 #endif
24 
25 #include <stdarg.h>
26 
27 #include "rcutils/allocator.h"
28 #include "rcutils/types/rcutils_ret.h"
29 #include "rcutils/visibility_control.h"
30 
32 typedef struct RCUTILS_PUBLIC_TYPE rcutils_char_array_t
33 {
35  char * buffer;
36 
42  bool owns_buffer;
43 
45  size_t buffer_length;
46 
48  size_t buffer_capacity;
49 
51  rcutils_allocator_t allocator;
52 } rcutils_char_array_t;
53 
55 
58 RCUTILS_PUBLIC
59 RCUTILS_WARN_UNUSED
60 rcutils_char_array_t
61 rcutils_get_zero_initialized_char_array(void);
62 
64 
78 RCUTILS_PUBLIC
79 RCUTILS_WARN_UNUSED
80 rcutils_ret_t
81 rcutils_char_array_init(
82  rcutils_char_array_t * char_array,
83  size_t buffer_capacity,
84  const rcutils_allocator_t * allocator);
85 
87 
101 RCUTILS_PUBLIC
102 RCUTILS_WARN_UNUSED
103 rcutils_ret_t
104 rcutils_char_array_fini(rcutils_char_array_t * char_array);
105 
107 
126 RCUTILS_PUBLIC
127 RCUTILS_WARN_UNUSED
128 rcutils_ret_t
129 rcutils_char_array_resize(rcutils_char_array_t * char_array, size_t new_size);
130 
132 
144 RCUTILS_PUBLIC
145 RCUTILS_WARN_UNUSED
146 rcutils_ret_t
147 rcutils_char_array_expand_as_needed(rcutils_char_array_t * char_array, size_t new_size);
148 
150 
165 RCUTILS_PUBLIC
166 RCUTILS_WARN_UNUSED
167 rcutils_ret_t
168 rcutils_char_array_vsprintf(rcutils_char_array_t * char_array, const char * format, va_list args);
169 
171 
184 RCUTILS_PUBLIC
185 RCUTILS_WARN_UNUSED
186 rcutils_ret_t
187 rcutils_char_array_strncat(rcutils_char_array_t * char_array, const char * src, size_t n);
188 
190 
203 RCUTILS_PUBLIC
204 RCUTILS_WARN_UNUSED
205 rcutils_ret_t
206 rcutils_char_array_strcat(rcutils_char_array_t * char_array, const char * src);
207 
209 
220 RCUTILS_PUBLIC
221 RCUTILS_WARN_UNUSED
222 rcutils_ret_t
223 rcutils_char_array_memcpy(rcutils_char_array_t * char_array, const char * src, size_t n);
224 
226 
237 RCUTILS_PUBLIC
238 RCUTILS_WARN_UNUSED
239 rcutils_ret_t
240 rcutils_char_array_strcpy(rcutils_char_array_t * char_array, const char * src);
241 
242 #if __cplusplus
243 }
244 #endif
245 
246 #endif // RCUTILS__TYPES__CHAR_ARRAY_H_
rcutils_char_array_init
rcutils_ret_t rcutils_char_array_init(rcutils_char_array_t *char_array, size_t buffer_capacity, const rcutils_allocator_t *allocator)
Initialize a zero initialized char array struct.
rcutils_char_array_t::buffer
char * buffer
A pointer to the allocated memory for this char array.
Definition: char_array.h:35
rcutils_char_array_strncat
rcutils_ret_t rcutils_char_array_strncat(rcutils_char_array_t *char_array, const char *src, size_t n)
Append a string (or part of it) to the string in buffer.
rcutils_char_array_t
struct rcutils_char_array_t rcutils_char_array_t
The structure holding the metadata for a char array.
rcutils_char_array_resize
rcutils_ret_t rcutils_char_array_resize(rcutils_char_array_t *char_array, size_t new_size)
Resize the internal buffer of the char array.
rcutils_char_array_memcpy
rcutils_ret_t rcutils_char_array_memcpy(rcutils_char_array_t *char_array, const char *src, size_t n)
Copy memory to buffer.
rcutils_char_array_t::buffer_length
size_t buffer_length
The length of the data stored in the buffer pointer.
Definition: char_array.h:45
rcutils_char_array_t::owns_buffer
bool owns_buffer
Definition: char_array.h:42
rcutils_char_array_t::buffer_capacity
size_t buffer_capacity
The maximum capacity of the buffer pointer.
Definition: char_array.h:48
RCUTILS_PUBLIC_TYPE
#define RCUTILS_PUBLIC_TYPE
Definition: visibility_control.h:29
rcutils_char_array_t::allocator
rcutils_allocator_t allocator
The allocator used to allocate and free the data in the pointer.
Definition: char_array.h:51
rcutils_char_array_strcpy
rcutils_ret_t rcutils_char_array_strcpy(rcutils_char_array_t *char_array, const char *src)
Copy a string to buffer.
rcutils_ret_t
int rcutils_ret_t
The type that holds a return value for an rcutils operation.
Definition: rcutils_ret.h:26
RCUTILS_WARN_UNUSED
#define RCUTILS_WARN_UNUSED
A macro to make the compiler warn when the return value of a function is not used.
Definition: macros.h:27
rcutils_ret.h
visibility_control.h
rcutils_allocator_t
Encapsulation of an allocator.
Definition: allocator.h:47
allocator.h
rcutils_char_array_fini
rcutils_ret_t rcutils_char_array_fini(rcutils_char_array_t *char_array)
Finalize a char array struct.
RCUTILS_PUBLIC
#define RCUTILS_PUBLIC
Definition: visibility_control.h:23
rcutils_char_array_expand_as_needed
rcutils_ret_t rcutils_char_array_expand_as_needed(rcutils_char_array_t *char_array, size_t new_size)
Expand the internal buffer of the char array.
rcutils_char_array_strcat
rcutils_ret_t rcutils_char_array_strcat(rcutils_char_array_t *char_array, const char *src)
Append a string to the string in buffer.
rcutils_char_array_vsprintf
rcutils_ret_t rcutils_char_array_vsprintf(rcutils_char_array_t *char_array, const char *format, va_list args)
Produce output according to format and args.
va_list
rcutils_char_array_t
The structure holding the metadata for a char array.
Definition: char_array.h:32
rcutils_get_zero_initialized_char_array
rcutils_char_array_t rcutils_get_zero_initialized_char_array(void)
Return a zero initialized char array struct.
Generated by   doxygen 1.8.17