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 
15 #ifndef RCUTILS__TYPES__CHAR_ARRAY_H_
16 #define RCUTILS__TYPES__CHAR_ARRAY_H_
17 
18 #if __cplusplus
19 extern "C"
20 {
21 #endif
22 
23 #include <stdarg.h>
24 
25 #include "rcutils/allocator.h"
28 
30 {
31  char * buffer;
32 
39 
40  size_t buffer_length;
44 
46 
53 
55 
73  rcutils_char_array_t * char_array,
74  size_t buffer_capacity,
75  const rcutils_allocator_t * allocator);
76 
78 
96 
98 
120 rcutils_char_array_resize(rcutils_char_array_t * char_array, size_t new_size);
121 
123 
138 rcutils_char_array_expand_as_needed(rcutils_char_array_t * char_array, size_t new_size);
139 
141 
158 rcutils_char_array_vsprintf(rcutils_char_array_t * char_array, const char * format, va_list args);
159 
161 
177 rcutils_char_array_strncat(rcutils_char_array_t * char_array, const char * src, size_t n);
178 
180 
195 rcutils_char_array_strcat(rcutils_char_array_t * char_array, const char * src);
196 
198 
212 rcutils_char_array_memcpy(rcutils_char_array_t * char_array, const char * src, size_t n);
213 
215 
228 rcutils_char_array_strcpy(rcutils_char_array_t * char_array, const char * src);
229 
230 #if __cplusplus
231 }
232 #endif
233 
234 #endif // RCUTILS__TYPES__CHAR_ARRAY_H_
Definition: char_array.h:29
rcutils_ret_t rcutils_char_array_strcpy(rcutils_char_array_t *char_array, const char *src)
Copy a string to buffer.
rcutils_ret_t rcutils_char_array_fini(rcutils_char_array_t *char_array)
Finalize a char array struct.
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_ret_t rcutils_char_array_strcat(rcutils_char_array_t *char_array, const char *src)
Append a string to the string in buffer.
int rcutils_ret_t
Definition: rcutils_ret.h:23
rcutils_ret_t rcutils_char_array_memcpy(rcutils_char_array_t *char_array, const char *src, size_t n)
Copy memory to buffer.
#define RCUTILS_PUBLIC_TYPE
Definition: visibility_control.h:51
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.
char * buffer
Definition: char_array.h:31
rcutils_char_array_t rcutils_get_zero_initialized_char_array(void)
Return a zero initialized char array struct.
Encapsulation of an allocator.
Definition: allocator.h:45
struct rcutils_char_array_t rcutils_char_array_t
bool owns_buffer
Definition: char_array.h:38
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_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.
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_allocator_t allocator
Definition: char_array.h:42
#define RCUTILS_WARN_UNUSED
Definition: macros.h:24
#define RCUTILS_PUBLIC
Definition: visibility_control.h:48
size_t buffer_capacity
Definition: char_array.h:41
size_t buffer_length
Definition: char_array.h:40