- b527a3e4b36b644ac424e3c525b1cd393f6f6c40 Fix some typos in the usage examples by Jorg Brown <jorg@google.com>
  - 82be4a9adf3bb0ddafc0d46274969c99afffe870 Fix typo in optional.h comment. by Abseil Team <absl-team@google.com>
  - d6ee63bf8fc51fba074c23b33cebc28c808d7f07 Remove internal-only identifiers from code. by Daniel Katz <katzdm@google.com>
  - f9c3ad2f0d73f53b21603638af8b4bed636e79f4 Use easier understandable names for absl::StartsWith and ... by Abseil Team <absl-team@google.com>
  - 7c16c14fefee89c927b8789d6043c4691bcffc9b Add -Wno-missing-prototypes back to the LLVM copts. by Derek Mauro <dmauro@google.com>
  - 2f4b7d2e50c7023240242f1e15db60ccd7e8768d IWYU | absl/strings by Juemin Yang <jueminyang@google.com>
  - a99cbcc1daa34a2d6a2bb26de275e05173cc77e9 IWYU | absl/type by Juemin Yang <jueminyang@google.com>
  - 12e1146d0fc76c071d7e0ebaabb62f0a984fae66 Use LLVM_FLAGS and LLVM_TEST_FLAGS when --compiler=llvm. by Derek Mauro <dmauro@google.com>
  - cd6bea616abda558d0bace5bd77455662a233688 IWYU | absl/debugging by Juemin Yang <jueminyang@google.com>
  - d9a7382e59d46a8581b6b7a31cd5a48bb89326e9 IWYU | absl/synchronization by Juemin Yang <jueminyang@google.com>
  - 07ec7d6d5a4a666f4183c5d0ed9c342baa7b24bc IWYU | absl/numeric by Juemin Yang <jueminyang@google.com>
  - 12bfe40051f4270f8707e191af5652f83f2f750c Remove the RoundTrip{Float,Double}ToBuffer routines from ... by Jorg Brown <jorg@google.com>
  - eeb4fd67c9d97f66cb9475c3c5e51ab132f1c810 Adds conversion functions for converting between absl/tim... by Greg Miller <jgm@google.com>
  - 59a2108d05d4ea85dc5cc11e49b2cd2335d4295a Change Substitute to use %.6g formatting rather than 15/1... by Jorg Brown <jorg@google.com>
  - 394becb48e0fcd161642cdaac5120d32567e0ef8 IWYU | absl/meta by Juemin Yang <jueminyang@google.com>
  - 1e5da6e8da336699b2469dcf6dda025b9b0ec4c9 Rewrite atomic_hook.h to not use std::atomic<T*> under Wi... by Greg Falcon <gfalcon@google.com>
GitOrigin-RevId: b527a3e4b36b644ac424e3c525b1cd393f6f6c40
Change-Id: I14e331d91c956ef045ac7927091a9f179716de0c
		
	
			
		
			
				
	
	
		
			676 lines
		
	
	
	
		
			32 KiB
		
	
	
	
		
			C++
		
	
	
	
	
	
			
		
		
	
	
			676 lines
		
	
	
	
		
			32 KiB
		
	
	
	
		
			C++
		
	
	
	
	
	
| //
 | |
| // Copyright 2017 The Abseil Authors.
 | |
| //
 | |
| // 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: substitute.h
 | |
| // -----------------------------------------------------------------------------
 | |
| //
 | |
| // This package contains functions for efficiently performing std::string
 | |
| // substitutions using a format std::string with positional notation:
 | |
| // `Substitute()` and `SubstituteAndAppend()`.
 | |
| //
 | |
| // Unlike printf-style format specifiers, `Substitute()` functions do not need
 | |
| // to specify the type of the substitution arguments. Supported arguments
 | |
| // following the format std::string, such as strings, string_views, ints,
 | |
| // floats, and bools, are automatically converted to strings during the
 | |
| // substitution process. (See below for a full list of supported types.)
 | |
| //
 | |
| // `Substitute()` does not allow you to specify *how* to format a value, beyond
 | |
| // the default conversion to std::string. For example, you cannot format an integer
 | |
| // in hex.
 | |
| //
 | |
| // The format std::string uses positional identifiers indicated by a dollar sign ($)
 | |
| // and single digit positional ids to indicate which substitution arguments to
 | |
| // use at that location within the format std::string.
 | |
| //
 | |
| // Example 1:
 | |
| //   std::string s = Substitute("$1 purchased $0 $2. Thanks $1!",
 | |
| //                         5, "Bob", "Apples");
 | |
| //   EXPECT_EQ("Bob purchased 5 Apples. Thanks Bob!", s);
 | |
| //
 | |
| // Example 2:
 | |
| //   std::string s = "Hi. ";
 | |
| //   SubstituteAndAppend(&s, "My name is $0 and I am $1 years old.", "Bob", 5);
 | |
| //   EXPECT_EQ("Hi. My name is Bob and I am 5 years old.", s);
 | |
| //
 | |
| // Differences from `StringPrintf()`:
 | |
| //   * The format std::string does not identify the types of arguments. Instead, the
 | |
| //     arguments are implicitly converted to strings. See below for a list of
 | |
| //     accepted types.
 | |
| //   * Substitutions in the format std::string are identified by a '$' followed by a
 | |
| //     single digit. You can use arguments out-of-order and use the same
 | |
| //     argument multiple times.
 | |
| //   * A '$$' sequence in the format std::string means output a literal '$'
 | |
| //     character.
 | |
| //   * `Substitute()` is significantly faster than `StringPrintf()`. For very
 | |
| //     large strings, it may be orders of magnitude faster.
 | |
| //
 | |
| // Supported types:
 | |
| //   * absl::string_view, std::string, const char* (null is equivalent to "")
 | |
| //   * int32_t, int64_t, uint32_t, uint64
 | |
| //   * float, double
 | |
| //   * bool (Printed as "true" or "false")
 | |
| //   * pointer types other than char* (Printed as "0x<lower case hex std::string>",
 | |
| //     except that null is printed as "NULL")
 | |
| //
 | |
| // If an invalid format std::string is provided, Substitute returns an empty std::string
 | |
| // and SubstituteAndAppend does not change the provided output std::string.
 | |
| // A format std::string is invalid if it:
 | |
| //   * ends in an unescaped $ character,
 | |
| //     e.g. "Hello $", or
 | |
| //   * calls for a position argument which is not provided,
 | |
| //     e.g. Substitute("Hello $2", "world"), or
 | |
| //   * specifies a non-digit, non-$ character after an unescaped $ character,
 | |
| //     e.g. "Hello $f".
 | |
| // In debug mode, i.e. #ifndef NDEBUG, such errors terminate the program.
 | |
| 
 | |
| #ifndef ABSL_STRINGS_SUBSTITUTE_H_
 | |
| #define ABSL_STRINGS_SUBSTITUTE_H_
 | |
| 
 | |
| #include <cstring>
 | |
| #include <string>
 | |
| 
 | |
| #include "absl/base/macros.h"
 | |
| #include "absl/base/port.h"
 | |
| #include "absl/strings/ascii.h"
 | |
| #include "absl/strings/escaping.h"
 | |
| #include "absl/strings/numbers.h"
 | |
| #include "absl/strings/str_join.h"
 | |
| #include "absl/strings/str_split.h"
 | |
| #include "absl/strings/string_view.h"
 | |
| #include "absl/strings/strip.h"
 | |
| 
 | |
| namespace absl {
 | |
| namespace substitute_internal {
 | |
| 
 | |
| // Arg
 | |
| //
 | |
| // This class provides an argument type for `absl::Substitute()` and
 | |
| // `absl::SubstituteAndAppend()`. `Arg` handles implicit conversion of various
 | |
| // types to a std::string. (`Arg` is very similar to the `AlphaNum` class in
 | |
| // `StrCat()`.)
 | |
| //
 | |
| // This class has implicit constructors.
 | |
| class Arg {
 | |
|  public:
 | |
|   // Overloads for std::string-y things
 | |
|   //
 | |
|   // Explicitly overload `const char*` so the compiler doesn't cast to `bool`.
 | |
|   Arg(const char* value)  // NOLINT(runtime/explicit)
 | |
|       : piece_(value) {}
 | |
|   Arg(const std::string& value)  // NOLINT(runtime/explicit)
 | |
|       : piece_(value) {}
 | |
|   Arg(absl::string_view value)  // NOLINT(runtime/explicit)
 | |
|       : piece_(value) {}
 | |
| 
 | |
|   // Overloads for primitives
 | |
|   //
 | |
|   // No overloads are available for signed and unsigned char because if people
 | |
|   // are explicitly declaring their chars as signed or unsigned then they are
 | |
|   // probably using them as 8-bit integers and would probably prefer an integer
 | |
|   // representation. However, we can't really know, so we make the caller decide
 | |
|   // what to do.
 | |
|   Arg(char value)  // NOLINT(runtime/explicit)
 | |
|       : piece_(scratch_, 1) { scratch_[0] = value; }
 | |
|   Arg(short value)  // NOLINT(runtime/explicit)
 | |
|       : piece_(scratch_,
 | |
|                numbers_internal::FastIntToBuffer(value, scratch_) - scratch_) {}
 | |
|   Arg(unsigned short value)  // NOLINT(runtime/explicit)
 | |
|       : piece_(scratch_,
 | |
|                numbers_internal::FastIntToBuffer(value, scratch_) - scratch_) {}
 | |
|   Arg(int value)  // NOLINT(runtime/explicit)
 | |
|       : piece_(scratch_,
 | |
|                numbers_internal::FastIntToBuffer(value, scratch_) - scratch_) {}
 | |
|   Arg(unsigned int value)  // NOLINT(runtime/explicit)
 | |
|       : piece_(scratch_,
 | |
|                numbers_internal::FastIntToBuffer(value, scratch_) - scratch_) {}
 | |
|   Arg(long value)  // NOLINT(runtime/explicit)
 | |
|       : piece_(scratch_,
 | |
|                numbers_internal::FastIntToBuffer(value, scratch_) - scratch_) {}
 | |
|   Arg(unsigned long value)  // NOLINT(runtime/explicit)
 | |
|       : piece_(scratch_,
 | |
|                numbers_internal::FastIntToBuffer(value, scratch_) - scratch_) {}
 | |
|   Arg(long long value)  // NOLINT(runtime/explicit)
 | |
|       : piece_(scratch_,
 | |
|                numbers_internal::FastIntToBuffer(value, scratch_) - scratch_) {}
 | |
|   Arg(unsigned long long value)  // NOLINT(runtime/explicit)
 | |
|       : piece_(scratch_,
 | |
|                numbers_internal::FastIntToBuffer(value, scratch_) - scratch_) {}
 | |
|   Arg(float value)  // NOLINT(runtime/explicit)
 | |
|       : piece_(scratch_, numbers_internal::SixDigitsToBuffer(value, scratch_)) {
 | |
|   }
 | |
|   Arg(double value)  // NOLINT(runtime/explicit)
 | |
|       : piece_(scratch_, numbers_internal::SixDigitsToBuffer(value, scratch_)) {
 | |
|   }
 | |
|   Arg(bool value)  // NOLINT(runtime/explicit)
 | |
|       : piece_(value ? "true" : "false") {}
 | |
|   // `void*` values, with the exception of `char*`, are printed as
 | |
|   // `StringPrintf()` with format "%p": e.g. ("0x<hex value>").
 | |
|   // However, in the case of `nullptr`, "NULL" is printed.
 | |
|   Arg(const void* value);  // NOLINT(runtime/explicit)
 | |
| 
 | |
|   Arg(const Arg&) = delete;
 | |
|   Arg& operator=(const Arg&) = delete;
 | |
| 
 | |
|   absl::string_view piece() const { return piece_; }
 | |
| 
 | |
|  private:
 | |
|   absl::string_view piece_;
 | |
|   char scratch_[numbers_internal::kFastToBufferSize];
 | |
| };
 | |
| 
 | |
| // Internal helper function. Don't call this from outside this implementation.
 | |
| // This interface may change without notice.
 | |
| void SubstituteAndAppendArray(std::string* output, absl::string_view format,
 | |
|                               const absl::string_view* args_array,
 | |
|                               size_t num_args);
 | |
| 
 | |
| #if defined(ABSL_BAD_CALL_IF)
 | |
| constexpr int CalculateOneBit(const char* format) {
 | |
|   return (*format < '0' || *format > '9') ? 0 : (1 << (*format - '0'));
 | |
| }
 | |
| 
 | |
| constexpr const char* SkipNumber(const char* format) {
 | |
|   return !*format ? format : (format + 1);
 | |
| }
 | |
| 
 | |
| constexpr int PlaceholderBitmask(const char* format) {
 | |
|   return !*format ? 0 : *format != '$'
 | |
|                              ? PlaceholderBitmask(format + 1)
 | |
|                              : (CalculateOneBit(format + 1) |
 | |
|                                    PlaceholderBitmask(SkipNumber(format + 1)));
 | |
| }
 | |
| #endif  // ABSL_BAD_CALL_IF
 | |
| 
 | |
| }  // namespace substitute_internal
 | |
| 
 | |
| //
 | |
| // PUBLIC API
 | |
| //
 | |
| 
 | |
| // SubstituteAndAppend()
 | |
| //
 | |
| // Substitutes variables into a given format std::string and appends to a given
 | |
| // output std::string. See file comments above for usage.
 | |
| //
 | |
| // The declarations of `SubstituteAndAppend()` below consist of overloads
 | |
| // for passing 0 to 10 arguments, respectively.
 | |
| //
 | |
| // NOTE: A zero-argument `SubstituteAndAppend()` may be used within variadic
 | |
| // templates to allow a variable number of arguments.
 | |
| //
 | |
| // Example:
 | |
| //  template <typename... Args>
 | |
| //  void VarMsg(std::string* boilerplate, absl::string_view format,
 | |
| //      const Args&... args) {
 | |
| //    absl::SubstituteAndAppend(boilerplate, format, args...);
 | |
| //  }
 | |
| //
 | |
| inline void SubstituteAndAppend(std::string* output, absl::string_view format) {
 | |
|   substitute_internal::SubstituteAndAppendArray(output, format, nullptr, 0);
 | |
| }
 | |
| 
 | |
| inline void SubstituteAndAppend(std::string* output, absl::string_view format,
 | |
|                                 const substitute_internal::Arg& a0) {
 | |
|   const absl::string_view args[] = {a0.piece()};
 | |
|   substitute_internal::SubstituteAndAppendArray(output, format, args,
 | |
|                                                 ABSL_ARRAYSIZE(args));
 | |
| }
 | |
| 
 | |
| inline void SubstituteAndAppend(std::string* output, absl::string_view format,
 | |
|                                 const substitute_internal::Arg& a0,
 | |
|                                 const substitute_internal::Arg& a1) {
 | |
|   const absl::string_view args[] = {a0.piece(), a1.piece()};
 | |
|   substitute_internal::SubstituteAndAppendArray(output, format, args,
 | |
|                                                 ABSL_ARRAYSIZE(args));
 | |
| }
 | |
| 
 | |
| inline void SubstituteAndAppend(std::string* output, absl::string_view format,
 | |
|                                 const substitute_internal::Arg& a0,
 | |
|                                 const substitute_internal::Arg& a1,
 | |
|                                 const substitute_internal::Arg& a2) {
 | |
|   const absl::string_view args[] = {a0.piece(), a1.piece(), a2.piece()};
 | |
|   substitute_internal::SubstituteAndAppendArray(output, format, args,
 | |
|                                                 ABSL_ARRAYSIZE(args));
 | |
| }
 | |
| 
 | |
| inline void SubstituteAndAppend(std::string* output, absl::string_view format,
 | |
|                                 const substitute_internal::Arg& a0,
 | |
|                                 const substitute_internal::Arg& a1,
 | |
|                                 const substitute_internal::Arg& a2,
 | |
|                                 const substitute_internal::Arg& a3) {
 | |
|   const absl::string_view args[] = {a0.piece(), a1.piece(), a2.piece(),
 | |
|                                     a3.piece()};
 | |
|   substitute_internal::SubstituteAndAppendArray(output, format, args,
 | |
|                                                 ABSL_ARRAYSIZE(args));
 | |
| }
 | |
| 
 | |
| inline void SubstituteAndAppend(std::string* output, absl::string_view format,
 | |
|                                 const substitute_internal::Arg& a0,
 | |
|                                 const substitute_internal::Arg& a1,
 | |
|                                 const substitute_internal::Arg& a2,
 | |
|                                 const substitute_internal::Arg& a3,
 | |
|                                 const substitute_internal::Arg& a4) {
 | |
|   const absl::string_view args[] = {a0.piece(), a1.piece(), a2.piece(),
 | |
|                                     a3.piece(), a4.piece()};
 | |
|   substitute_internal::SubstituteAndAppendArray(output, format, args,
 | |
|                                                 ABSL_ARRAYSIZE(args));
 | |
| }
 | |
| 
 | |
| inline void SubstituteAndAppend(std::string* output, absl::string_view format,
 | |
|                                 const substitute_internal::Arg& a0,
 | |
|                                 const substitute_internal::Arg& a1,
 | |
|                                 const substitute_internal::Arg& a2,
 | |
|                                 const substitute_internal::Arg& a3,
 | |
|                                 const substitute_internal::Arg& a4,
 | |
|                                 const substitute_internal::Arg& a5) {
 | |
|   const absl::string_view args[] = {a0.piece(), a1.piece(), a2.piece(),
 | |
|                                     a3.piece(), a4.piece(), a5.piece()};
 | |
|   substitute_internal::SubstituteAndAppendArray(output, format, args,
 | |
|                                                 ABSL_ARRAYSIZE(args));
 | |
| }
 | |
| 
 | |
| inline void SubstituteAndAppend(std::string* output, absl::string_view format,
 | |
|                                 const substitute_internal::Arg& a0,
 | |
|                                 const substitute_internal::Arg& a1,
 | |
|                                 const substitute_internal::Arg& a2,
 | |
|                                 const substitute_internal::Arg& a3,
 | |
|                                 const substitute_internal::Arg& a4,
 | |
|                                 const substitute_internal::Arg& a5,
 | |
|                                 const substitute_internal::Arg& a6) {
 | |
|   const absl::string_view args[] = {a0.piece(), a1.piece(), a2.piece(),
 | |
|                                     a3.piece(), a4.piece(), a5.piece(),
 | |
|                                     a6.piece()};
 | |
|   substitute_internal::SubstituteAndAppendArray(output, format, args,
 | |
|                                                 ABSL_ARRAYSIZE(args));
 | |
| }
 | |
| 
 | |
| inline void SubstituteAndAppend(
 | |
|     std::string* output, absl::string_view format,
 | |
|     const substitute_internal::Arg& a0, const substitute_internal::Arg& a1,
 | |
|     const substitute_internal::Arg& a2, const substitute_internal::Arg& a3,
 | |
|     const substitute_internal::Arg& a4, const substitute_internal::Arg& a5,
 | |
|     const substitute_internal::Arg& a6, const substitute_internal::Arg& a7) {
 | |
|   const absl::string_view args[] = {a0.piece(), a1.piece(), a2.piece(),
 | |
|                                     a3.piece(), a4.piece(), a5.piece(),
 | |
|                                     a6.piece(), a7.piece()};
 | |
|   substitute_internal::SubstituteAndAppendArray(output, format, args,
 | |
|                                                 ABSL_ARRAYSIZE(args));
 | |
| }
 | |
| 
 | |
| inline void SubstituteAndAppend(
 | |
|     std::string* output, absl::string_view format,
 | |
|     const substitute_internal::Arg& a0, const substitute_internal::Arg& a1,
 | |
|     const substitute_internal::Arg& a2, const substitute_internal::Arg& a3,
 | |
|     const substitute_internal::Arg& a4, const substitute_internal::Arg& a5,
 | |
|     const substitute_internal::Arg& a6, const substitute_internal::Arg& a7,
 | |
|     const substitute_internal::Arg& a8) {
 | |
|   const absl::string_view args[] = {a0.piece(), a1.piece(), a2.piece(),
 | |
|                                     a3.piece(), a4.piece(), a5.piece(),
 | |
|                                     a6.piece(), a7.piece(), a8.piece()};
 | |
|   substitute_internal::SubstituteAndAppendArray(output, format, args,
 | |
|                                                 ABSL_ARRAYSIZE(args));
 | |
| }
 | |
| 
 | |
| inline void SubstituteAndAppend(
 | |
|     std::string* output, absl::string_view format,
 | |
|     const substitute_internal::Arg& a0, const substitute_internal::Arg& a1,
 | |
|     const substitute_internal::Arg& a2, const substitute_internal::Arg& a3,
 | |
|     const substitute_internal::Arg& a4, const substitute_internal::Arg& a5,
 | |
|     const substitute_internal::Arg& a6, const substitute_internal::Arg& a7,
 | |
|     const substitute_internal::Arg& a8, const substitute_internal::Arg& a9) {
 | |
|   const absl::string_view args[] = {
 | |
|       a0.piece(), a1.piece(), a2.piece(), a3.piece(), a4.piece(),
 | |
|       a5.piece(), a6.piece(), a7.piece(), a8.piece(), a9.piece()};
 | |
|   substitute_internal::SubstituteAndAppendArray(output, format, args,
 | |
|                                                 ABSL_ARRAYSIZE(args));
 | |
| }
 | |
| 
 | |
| #if defined(ABSL_BAD_CALL_IF)
 | |
| // This body of functions catches cases where the number of placeholders
 | |
| // doesn't match the number of data arguments.
 | |
| void SubstituteAndAppend(std::string* output, const char* format)
 | |
|     ABSL_BAD_CALL_IF(substitute_internal::PlaceholderBitmask(format) != 0,
 | |
|                      "There were no substitution arguments "
 | |
|                      "but this format std::string has a $[0-9] in it");
 | |
| 
 | |
| void SubstituteAndAppend(std::string* output, const char* format,
 | |
|                          const substitute_internal::Arg& a0)
 | |
|     ABSL_BAD_CALL_IF(substitute_internal::PlaceholderBitmask(format) != 1,
 | |
|                      "There was 1 substitution argument given, but "
 | |
|                      "this format std::string is either missing its $0, or "
 | |
|                      "contains one of $1-$9");
 | |
| 
 | |
| void SubstituteAndAppend(std::string* output, const char* format,
 | |
|                          const substitute_internal::Arg& a0,
 | |
|                          const substitute_internal::Arg& a1)
 | |
|     ABSL_BAD_CALL_IF(substitute_internal::PlaceholderBitmask(format) != 3,
 | |
|                      "There were 2 substitution arguments given, but "
 | |
|                      "this format std::string is either missing its $0/$1, or "
 | |
|                      "contains one of $2-$9");
 | |
| 
 | |
| void SubstituteAndAppend(std::string* output, const char* format,
 | |
|                          const substitute_internal::Arg& a0,
 | |
|                          const substitute_internal::Arg& a1,
 | |
|                          const substitute_internal::Arg& a2)
 | |
|     ABSL_BAD_CALL_IF(substitute_internal::PlaceholderBitmask(format) != 7,
 | |
|                      "There were 3 substitution arguments given, but "
 | |
|                      "this format std::string is either missing its $0/$1/$2, or "
 | |
|                      "contains one of $3-$9");
 | |
| 
 | |
| void SubstituteAndAppend(std::string* output, const char* format,
 | |
|                          const substitute_internal::Arg& a0,
 | |
|                          const substitute_internal::Arg& a1,
 | |
|                          const substitute_internal::Arg& a2,
 | |
|                          const substitute_internal::Arg& a3)
 | |
|     ABSL_BAD_CALL_IF(substitute_internal::PlaceholderBitmask(format) != 15,
 | |
|                      "There were 4 substitution arguments given, but "
 | |
|                      "this format std::string is either missing its $0-$3, or "
 | |
|                      "contains one of $4-$9");
 | |
| 
 | |
| void SubstituteAndAppend(std::string* output, const char* format,
 | |
|                          const substitute_internal::Arg& a0,
 | |
|                          const substitute_internal::Arg& a1,
 | |
|                          const substitute_internal::Arg& a2,
 | |
|                          const substitute_internal::Arg& a3,
 | |
|                          const substitute_internal::Arg& a4)
 | |
|     ABSL_BAD_CALL_IF(substitute_internal::PlaceholderBitmask(format) != 31,
 | |
|                      "There were 5 substitution arguments given, but "
 | |
|                      "this format std::string is either missing its $0-$4, or "
 | |
|                      "contains one of $5-$9");
 | |
| 
 | |
| void SubstituteAndAppend(std::string* output, const char* format,
 | |
|                          const substitute_internal::Arg& a0,
 | |
|                          const substitute_internal::Arg& a1,
 | |
|                          const substitute_internal::Arg& a2,
 | |
|                          const substitute_internal::Arg& a3,
 | |
|                          const substitute_internal::Arg& a4,
 | |
|                          const substitute_internal::Arg& a5)
 | |
|     ABSL_BAD_CALL_IF(substitute_internal::PlaceholderBitmask(format) != 63,
 | |
|                      "There were 6 substitution arguments given, but "
 | |
|                      "this format std::string is either missing its $0-$5, or "
 | |
|                      "contains one of $6-$9");
 | |
| 
 | |
| void SubstituteAndAppend(
 | |
|     std::string* output, const char* format, const substitute_internal::Arg& a0,
 | |
|     const substitute_internal::Arg& a1, const substitute_internal::Arg& a2,
 | |
|     const substitute_internal::Arg& a3, const substitute_internal::Arg& a4,
 | |
|     const substitute_internal::Arg& a5, const substitute_internal::Arg& a6)
 | |
|     ABSL_BAD_CALL_IF(substitute_internal::PlaceholderBitmask(format) != 127,
 | |
|                      "There were 7 substitution arguments given, but "
 | |
|                      "this format std::string is either missing its $0-$6, or "
 | |
|                      "contains one of $7-$9");
 | |
| 
 | |
| void SubstituteAndAppend(
 | |
|     std::string* output, const char* format, const substitute_internal::Arg& a0,
 | |
|     const substitute_internal::Arg& a1, const substitute_internal::Arg& a2,
 | |
|     const substitute_internal::Arg& a3, const substitute_internal::Arg& a4,
 | |
|     const substitute_internal::Arg& a5, const substitute_internal::Arg& a6,
 | |
|     const substitute_internal::Arg& a7)
 | |
|     ABSL_BAD_CALL_IF(substitute_internal::PlaceholderBitmask(format) != 255,
 | |
|                      "There were 8 substitution arguments given, but "
 | |
|                      "this format std::string is either missing its $0-$7, or "
 | |
|                      "contains one of $8-$9");
 | |
| 
 | |
| void SubstituteAndAppend(
 | |
|     std::string* output, const char* format, const substitute_internal::Arg& a0,
 | |
|     const substitute_internal::Arg& a1, const substitute_internal::Arg& a2,
 | |
|     const substitute_internal::Arg& a3, const substitute_internal::Arg& a4,
 | |
|     const substitute_internal::Arg& a5, const substitute_internal::Arg& a6,
 | |
|     const substitute_internal::Arg& a7, const substitute_internal::Arg& a8)
 | |
|     ABSL_BAD_CALL_IF(
 | |
|         substitute_internal::PlaceholderBitmask(format) != 511,
 | |
|         "There were 9 substitution arguments given, but "
 | |
|         "this format std::string is either missing its $0-$8, or contains a $9");
 | |
| 
 | |
| void SubstituteAndAppend(
 | |
|     std::string* output, const char* format, const substitute_internal::Arg& a0,
 | |
|     const substitute_internal::Arg& a1, const substitute_internal::Arg& a2,
 | |
|     const substitute_internal::Arg& a3, const substitute_internal::Arg& a4,
 | |
|     const substitute_internal::Arg& a5, const substitute_internal::Arg& a6,
 | |
|     const substitute_internal::Arg& a7, const substitute_internal::Arg& a8,
 | |
|     const substitute_internal::Arg& a9)
 | |
|     ABSL_BAD_CALL_IF(substitute_internal::PlaceholderBitmask(format) != 1023,
 | |
|                      "There were 10 substitution arguments given, but this "
 | |
|                      "format std::string doesn't contain all of $0 through $9");
 | |
| #endif  // ABSL_BAD_CALL_IF
 | |
| 
 | |
| // Substitute()
 | |
| //
 | |
| // Substitutes variables into a given format std::string. See file comments above
 | |
| // for usage.
 | |
| //
 | |
| // The declarations of `Substitute()` below consist of overloads for passing 0
 | |
| // to 10 arguments, respectively.
 | |
| //
 | |
| // NOTE: A zero-argument `Substitute()` may be used within variadic templates to
 | |
| // allow a variable number of arguments.
 | |
| //
 | |
| // Example:
 | |
| //  template <typename... Args>
 | |
| //  void VarMsg(absl::string_view format, const Args&... args) {
 | |
| //    std::string s = absl::Substitute(format, args...);
 | |
| 
 | |
| ABSL_MUST_USE_RESULT inline std::string Substitute(absl::string_view format) {
 | |
|   std::string result;
 | |
|   SubstituteAndAppend(&result, format);
 | |
|   return result;
 | |
| }
 | |
| 
 | |
| ABSL_MUST_USE_RESULT inline std::string Substitute(
 | |
|     absl::string_view format, const substitute_internal::Arg& a0) {
 | |
|   std::string result;
 | |
|   SubstituteAndAppend(&result, format, a0);
 | |
|   return result;
 | |
| }
 | |
| 
 | |
| ABSL_MUST_USE_RESULT inline std::string Substitute(
 | |
|     absl::string_view format, const substitute_internal::Arg& a0,
 | |
|     const substitute_internal::Arg& a1) {
 | |
|   std::string result;
 | |
|   SubstituteAndAppend(&result, format, a0, a1);
 | |
|   return result;
 | |
| }
 | |
| 
 | |
| ABSL_MUST_USE_RESULT inline std::string Substitute(
 | |
|     absl::string_view format, const substitute_internal::Arg& a0,
 | |
|     const substitute_internal::Arg& a1, const substitute_internal::Arg& a2) {
 | |
|   std::string result;
 | |
|   SubstituteAndAppend(&result, format, a0, a1, a2);
 | |
|   return result;
 | |
| }
 | |
| 
 | |
| ABSL_MUST_USE_RESULT inline std::string Substitute(
 | |
|     absl::string_view format, const substitute_internal::Arg& a0,
 | |
|     const substitute_internal::Arg& a1, const substitute_internal::Arg& a2,
 | |
|     const substitute_internal::Arg& a3) {
 | |
|   std::string result;
 | |
|   SubstituteAndAppend(&result, format, a0, a1, a2, a3);
 | |
|   return result;
 | |
| }
 | |
| 
 | |
| ABSL_MUST_USE_RESULT inline std::string Substitute(
 | |
|     absl::string_view format, const substitute_internal::Arg& a0,
 | |
|     const substitute_internal::Arg& a1, const substitute_internal::Arg& a2,
 | |
|     const substitute_internal::Arg& a3, const substitute_internal::Arg& a4) {
 | |
|   std::string result;
 | |
|   SubstituteAndAppend(&result, format, a0, a1, a2, a3, a4);
 | |
|   return result;
 | |
| }
 | |
| 
 | |
| ABSL_MUST_USE_RESULT inline std::string Substitute(
 | |
|     absl::string_view format, const substitute_internal::Arg& a0,
 | |
|     const substitute_internal::Arg& a1, const substitute_internal::Arg& a2,
 | |
|     const substitute_internal::Arg& a3, const substitute_internal::Arg& a4,
 | |
|     const substitute_internal::Arg& a5) {
 | |
|   std::string result;
 | |
|   SubstituteAndAppend(&result, format, a0, a1, a2, a3, a4, a5);
 | |
|   return result;
 | |
| }
 | |
| 
 | |
| ABSL_MUST_USE_RESULT inline std::string Substitute(
 | |
|     absl::string_view format, const substitute_internal::Arg& a0,
 | |
|     const substitute_internal::Arg& a1, const substitute_internal::Arg& a2,
 | |
|     const substitute_internal::Arg& a3, const substitute_internal::Arg& a4,
 | |
|     const substitute_internal::Arg& a5, const substitute_internal::Arg& a6) {
 | |
|   std::string result;
 | |
|   SubstituteAndAppend(&result, format, a0, a1, a2, a3, a4, a5, a6);
 | |
|   return result;
 | |
| }
 | |
| 
 | |
| ABSL_MUST_USE_RESULT inline std::string Substitute(
 | |
|     absl::string_view format, const substitute_internal::Arg& a0,
 | |
|     const substitute_internal::Arg& a1, const substitute_internal::Arg& a2,
 | |
|     const substitute_internal::Arg& a3, const substitute_internal::Arg& a4,
 | |
|     const substitute_internal::Arg& a5, const substitute_internal::Arg& a6,
 | |
|     const substitute_internal::Arg& a7) {
 | |
|   std::string result;
 | |
|   SubstituteAndAppend(&result, format, a0, a1, a2, a3, a4, a5, a6, a7);
 | |
|   return result;
 | |
| }
 | |
| 
 | |
| ABSL_MUST_USE_RESULT inline std::string Substitute(
 | |
|     absl::string_view format, const substitute_internal::Arg& a0,
 | |
|     const substitute_internal::Arg& a1, const substitute_internal::Arg& a2,
 | |
|     const substitute_internal::Arg& a3, const substitute_internal::Arg& a4,
 | |
|     const substitute_internal::Arg& a5, const substitute_internal::Arg& a6,
 | |
|     const substitute_internal::Arg& a7, const substitute_internal::Arg& a8) {
 | |
|   std::string result;
 | |
|   SubstituteAndAppend(&result, format, a0, a1, a2, a3, a4, a5, a6, a7, a8);
 | |
|   return result;
 | |
| }
 | |
| 
 | |
| ABSL_MUST_USE_RESULT inline std::string Substitute(
 | |
|     absl::string_view format, const substitute_internal::Arg& a0,
 | |
|     const substitute_internal::Arg& a1, const substitute_internal::Arg& a2,
 | |
|     const substitute_internal::Arg& a3, const substitute_internal::Arg& a4,
 | |
|     const substitute_internal::Arg& a5, const substitute_internal::Arg& a6,
 | |
|     const substitute_internal::Arg& a7, const substitute_internal::Arg& a8,
 | |
|     const substitute_internal::Arg& a9) {
 | |
|   std::string result;
 | |
|   SubstituteAndAppend(&result, format, a0, a1, a2, a3, a4, a5, a6, a7, a8, a9);
 | |
|   return result;
 | |
| }
 | |
| 
 | |
| #if defined(ABSL_BAD_CALL_IF)
 | |
| // This body of functions catches cases where the number of placeholders
 | |
| // doesn't match the number of data arguments.
 | |
| std::string Substitute(const char* format)
 | |
|     ABSL_BAD_CALL_IF(substitute_internal::PlaceholderBitmask(format) != 0,
 | |
|                      "There were no substitution arguments "
 | |
|                      "but this format std::string has a $[0-9] in it");
 | |
| 
 | |
| std::string Substitute(const char* format, const substitute_internal::Arg& a0)
 | |
|     ABSL_BAD_CALL_IF(substitute_internal::PlaceholderBitmask(format) != 1,
 | |
|                      "There was 1 substitution argument given, but "
 | |
|                      "this format std::string is either missing its $0, or "
 | |
|                      "contains one of $1-$9");
 | |
| 
 | |
| std::string Substitute(const char* format, const substitute_internal::Arg& a0,
 | |
|                   const substitute_internal::Arg& a1)
 | |
|     ABSL_BAD_CALL_IF(substitute_internal::PlaceholderBitmask(format) != 3,
 | |
|                      "There were 2 substitution arguments given, but "
 | |
|                      "this format std::string is either missing its $0/$1, or "
 | |
|                      "contains one of $2-$9");
 | |
| 
 | |
| std::string Substitute(const char* format, const substitute_internal::Arg& a0,
 | |
|                   const substitute_internal::Arg& a1,
 | |
|                   const substitute_internal::Arg& a2)
 | |
|     ABSL_BAD_CALL_IF(substitute_internal::PlaceholderBitmask(format) != 7,
 | |
|                      "There were 3 substitution arguments given, but "
 | |
|                      "this format std::string is either missing its $0/$1/$2, or "
 | |
|                      "contains one of $3-$9");
 | |
| 
 | |
| std::string Substitute(const char* format, const substitute_internal::Arg& a0,
 | |
|                   const substitute_internal::Arg& a1,
 | |
|                   const substitute_internal::Arg& a2,
 | |
|                   const substitute_internal::Arg& a3)
 | |
|     ABSL_BAD_CALL_IF(substitute_internal::PlaceholderBitmask(format) != 15,
 | |
|                      "There were 4 substitution arguments given, but "
 | |
|                      "this format std::string is either missing its $0-$3, or "
 | |
|                      "contains one of $4-$9");
 | |
| 
 | |
| std::string Substitute(const char* format, const substitute_internal::Arg& a0,
 | |
|                   const substitute_internal::Arg& a1,
 | |
|                   const substitute_internal::Arg& a2,
 | |
|                   const substitute_internal::Arg& a3,
 | |
|                   const substitute_internal::Arg& a4)
 | |
|     ABSL_BAD_CALL_IF(substitute_internal::PlaceholderBitmask(format) != 31,
 | |
|                      "There were 5 substitution arguments given, but "
 | |
|                      "this format std::string is either missing its $0-$4, or "
 | |
|                      "contains one of $5-$9");
 | |
| 
 | |
| std::string Substitute(const char* format, const substitute_internal::Arg& a0,
 | |
|                   const substitute_internal::Arg& a1,
 | |
|                   const substitute_internal::Arg& a2,
 | |
|                   const substitute_internal::Arg& a3,
 | |
|                   const substitute_internal::Arg& a4,
 | |
|                   const substitute_internal::Arg& a5)
 | |
|     ABSL_BAD_CALL_IF(substitute_internal::PlaceholderBitmask(format) != 63,
 | |
|                      "There were 6 substitution arguments given, but "
 | |
|                      "this format std::string is either missing its $0-$5, or "
 | |
|                      "contains one of $6-$9");
 | |
| 
 | |
| std::string Substitute(const char* format, const substitute_internal::Arg& a0,
 | |
|                   const substitute_internal::Arg& a1,
 | |
|                   const substitute_internal::Arg& a2,
 | |
|                   const substitute_internal::Arg& a3,
 | |
|                   const substitute_internal::Arg& a4,
 | |
|                   const substitute_internal::Arg& a5,
 | |
|                   const substitute_internal::Arg& a6)
 | |
|     ABSL_BAD_CALL_IF(substitute_internal::PlaceholderBitmask(format) != 127,
 | |
|                      "There were 7 substitution arguments given, but "
 | |
|                      "this format std::string is either missing its $0-$6, or "
 | |
|                      "contains one of $7-$9");
 | |
| 
 | |
| std::string Substitute(const char* format, const substitute_internal::Arg& a0,
 | |
|                   const substitute_internal::Arg& a1,
 | |
|                   const substitute_internal::Arg& a2,
 | |
|                   const substitute_internal::Arg& a3,
 | |
|                   const substitute_internal::Arg& a4,
 | |
|                   const substitute_internal::Arg& a5,
 | |
|                   const substitute_internal::Arg& a6,
 | |
|                   const substitute_internal::Arg& a7)
 | |
|     ABSL_BAD_CALL_IF(substitute_internal::PlaceholderBitmask(format) != 255,
 | |
|                      "There were 8 substitution arguments given, but "
 | |
|                      "this format std::string is either missing its $0-$7, or "
 | |
|                      "contains one of $8-$9");
 | |
| 
 | |
| std::string Substitute(
 | |
|     const char* format, const substitute_internal::Arg& a0,
 | |
|     const substitute_internal::Arg& a1, const substitute_internal::Arg& a2,
 | |
|     const substitute_internal::Arg& a3, const substitute_internal::Arg& a4,
 | |
|     const substitute_internal::Arg& a5, const substitute_internal::Arg& a6,
 | |
|     const substitute_internal::Arg& a7, const substitute_internal::Arg& a8)
 | |
|     ABSL_BAD_CALL_IF(
 | |
|         substitute_internal::PlaceholderBitmask(format) != 511,
 | |
|         "There were 9 substitution arguments given, but "
 | |
|         "this format std::string is either missing its $0-$8, or contains a $9");
 | |
| 
 | |
| std::string Substitute(
 | |
|     const char* format, const substitute_internal::Arg& a0,
 | |
|     const substitute_internal::Arg& a1, const substitute_internal::Arg& a2,
 | |
|     const substitute_internal::Arg& a3, const substitute_internal::Arg& a4,
 | |
|     const substitute_internal::Arg& a5, const substitute_internal::Arg& a6,
 | |
|     const substitute_internal::Arg& a7, const substitute_internal::Arg& a8,
 | |
|     const substitute_internal::Arg& a9)
 | |
|     ABSL_BAD_CALL_IF(substitute_internal::PlaceholderBitmask(format) != 1023,
 | |
|                      "There were 10 substitution arguments given, but this "
 | |
|                      "format std::string doesn't contain all of $0 through $9");
 | |
| #endif  // ABSL_BAD_CALL_IF
 | |
| 
 | |
| }  // namespace absl
 | |
| 
 | |
| #endif  // ABSL_STRINGS_SUBSTITUTE_H_
 |