1// Protocol Buffers - Google's data interchange format
2// Copyright 2008 Google Inc. All rights reserved.
3// https://developers.google.com/protocol-buffers/
4//
5// Redistribution and use in source and binary forms, with or without
6// modification, are permitted provided that the following conditions are
7// met:
8//
9// * Redistributions of source code must retain the above copyright
10// notice, this list of conditions and the following disclaimer.
11// * Redistributions in binary form must reproduce the above
12// copyright notice, this list of conditions and the following disclaimer
13// in the documentation and/or other materials provided with the
14// distribution.
15// * Neither the name of Google Inc. nor the names of its
16// contributors may be used to endorse or promote products derived from
17// this software without specific prior written permission.
18//
19// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
23// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30
31// Author: kenton@google.com (Kenton Varda)
32
33#include <google/protobuf/stubs/substitute.h>
34
35#include <google/protobuf/stubs/logging.h>
36#include <google/protobuf/stubs/strutil.h>
37#include <google/protobuf/stubs/stl_util.h>
38
39namespace google {
40namespace protobuf {
41namespace strings {
42
43using internal::SubstituteArg;
44
45// Returns the number of args in arg_array which were passed explicitly
46// to Substitute().
47static int CountSubstituteArgs(const SubstituteArg* const* args_array) {
48 int count = 0;
49 while (args_array[count] != nullptr && args_array[count]->size() != -1) {
50 ++count;
51 }
52 return count;
53}
54
55std::string Substitute(const std::string& format, const SubstituteArg& arg0,
56 const SubstituteArg& arg1, const SubstituteArg& arg2,
57 const SubstituteArg& arg3, const SubstituteArg& arg4,
58 const SubstituteArg& arg5, const SubstituteArg& arg6,
59 const SubstituteArg& arg7, const SubstituteArg& arg8,
60 const SubstituteArg& arg9) {
61 std::string result;
62 SubstituteAndAppend(output: &result, format: format.c_str(), arg0, arg1, arg2, arg3, arg4,
63 arg5, arg6, arg7, arg8, arg9);
64 return result;
65}
66
67void SubstituteAndAppend(std::string* output, const char* format,
68 const SubstituteArg& arg0, const SubstituteArg& arg1,
69 const SubstituteArg& arg2, const SubstituteArg& arg3,
70 const SubstituteArg& arg4, const SubstituteArg& arg5,
71 const SubstituteArg& arg6, const SubstituteArg& arg7,
72 const SubstituteArg& arg8, const SubstituteArg& arg9) {
73 const SubstituteArg* const args_array[] = {
74 &arg0, &arg1, &arg2, &arg3, &arg4, &arg5, &arg6, &arg7, &arg8, &arg9, nullptr
75 };
76
77 // Determine total size needed.
78 int size = 0;
79 for (int i = 0; format[i] != '\0'; i++) {
80 if (format[i] == '$') {
81 if (ascii_isdigit(c: format[i+1])) {
82 int index = format[i+1] - '0';
83 if (args_array[index]->size() == -1) {
84 GOOGLE_LOG(DFATAL)
85 << "strings::Substitute format string invalid: asked for \"$"
86 << index << "\", but only " << CountSubstituteArgs(args_array)
87 << " args were given. Full format string was: \""
88 << CEscape(src: format) << "\".";
89 return;
90 }
91 size += args_array[index]->size();
92 ++i; // Skip next char.
93 } else if (format[i+1] == '$') {
94 ++size;
95 ++i; // Skip next char.
96 } else {
97 GOOGLE_LOG(DFATAL)
98 << "Invalid strings::Substitute() format string: \""
99 << CEscape(src: format) << "\".";
100 return;
101 }
102 } else {
103 ++size;
104 }
105 }
106
107 if (size == 0) return;
108
109 // Build the string.
110 int original_size = output->size();
111 STLStringResizeUninitialized(s: output, new_size: original_size + size);
112 char* target = string_as_array(str: output) + original_size;
113 for (int i = 0; format[i] != '\0'; i++) {
114 if (format[i] == '$') {
115 if (ascii_isdigit(c: format[i+1])) {
116 unsigned int index = format[i+1] - '0';
117 assert(index < 10);
118 const SubstituteArg* src = args_array[index];
119 memcpy(dest: target, src: src->data(), n: src->size());
120 target += src->size();
121 ++i; // Skip next char.
122 } else if (format[i+1] == '$') {
123 *target++ = '$';
124 ++i; // Skip next char.
125 }
126 } else {
127 *target++ = format[i];
128 }
129 }
130
131 GOOGLE_DCHECK_EQ(target - output->data(), output->size());
132}
133
134} // namespace strings
135} // namespace protobuf
136} // namespace google
137