rcutils
master
C API providing common utilities and data structures.
Main Page
Classes
Class List
Class Index
Class Members
All
a
b
d
e
f
i
l
m
o
r
s
z
Variables
a
b
d
e
f
i
l
m
o
r
s
z
Files
File List
File Members
All
_
a
g
h
m
r
Functions
_
r
Variables
Typedefs
Enumerations
Enumerator
Macros
_
a
h
m
r
•
All
Classes
Namespaces
Files
Functions
Variables
Typedefs
Enumerations
Enumerator
Macros
Pages
include
rcutils
format_string.h
Go to the documentation of this file.
1
// Copyright 2017 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__FORMAT_STRING_H_
16
#define RCUTILS__FORMAT_STRING_H_
17
18
#ifdef __cplusplus
19
extern
"C"
20
{
21
#endif
22
23
#include <string.h>
24
25
#include "
rcutils/allocator.h
"
26
#include "
rcutils/macros.h
"
27
#include "
rcutils/visibility_control.h
"
28
30
35
#define rcutils_format_string(allocator, format_string, ...) \
36
rcutils_format_string_limit(allocator, 2048, format_string, __VA_ARGS__)
37
39
66
RCUTILS_PUBLIC
67
RCUTILS_WARN_UNUSED
68
char
*
69
rcutils_format_string_limit
(
70
rcutils_allocator_t
allocator,
71
size_t
limit,
72
const
char
* format_string,
73
...)
75
RCUTILS_ATTRIBUTE_PRINTF_FORMAT
(3, 4)
77
;
78
79
#ifdef __cplusplus
80
}
81
#endif
82
83
#endif // RCUTILS__FORMAT_STRING_H_
RCUTILS_ATTRIBUTE_PRINTF_FORMAT
#define RCUTILS_ATTRIBUTE_PRINTF_FORMAT(format_string_index, first_to_check_index)
Definition:
macros.h:102
macros.h
rcutils_format_string_limit
char * rcutils_format_string_limit(rcutils_allocator_t allocator, size_t limit, const char *format_string,...)
Return a newly allocated string, created with a format string up to a limit.
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
visibility_control.h
rcutils_allocator_t
Encapsulation of an allocator.
Definition:
allocator.h:47
allocator.h
RCUTILS_PUBLIC
#define RCUTILS_PUBLIC
Definition:
visibility_control.h:23
Generated by
1.8.17