xref: /aosp_15_r20/external/pigweed/pw_bluetooth_sapphire/lib/cpp-string/public/cpp-string/string_printf.h (revision 61c4878ac05f98d0ceed94b57d316916de578985)
1 // Copyright 2023 The Pigweed Authors
2 //
3 // Licensed under the Apache License, Version 2.0 (the "License"); you may not
4 // use this file except in compliance with the License. You may obtain a copy of
5 // the License at
6 //
7 //     https://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, WITHOUT
11 // WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
12 // License for the specific language governing permissions and limitations under
13 // the License.
14 
15 // |printf()|-like formatting functions that output/append to C++ strings.
16 
17 #pragma once
18 
19 #include <stdarg.h>
20 
21 #include <string>
22 
23 namespace bt_lib_cpp_string {
24 
25 // Formats |printf()|-like input and returns it as an |std::string|.
26 [[nodiscard, gnu::format(printf, 1, 2)]] std::string StringPrintf(
27     const char* format, ...);
28 
29 // Formats |vprintf()|-like input and returns it as an |std::string|.
30 [[nodiscard]] std::string StringVPrintf(const char* format, va_list ap);
31 
32 // Formats |printf()|-like input and appends it to |*dest|.
33 [[gnu::format(printf, 2, 3)]] void StringAppendf(std::string* dest,
34                                                  const char* format,
35                                                  ...);
36 
37 // Formats |vprintf()|-like input and appends it to |*dest|.
38 void StringVAppendf(std::string* dest, const char* format, va_list ap);
39 
40 }  // namespace bt_lib_cpp_string
41