stringprintf.h revision ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16 
1// Protocol Buffers - Google's data interchange format
2// Copyright 2012 Google Inc.  All rights reserved.
3// http://code.google.com/p/protobuf/
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// from google3/base/stringprintf.h
32//
33// Printf variants that place their output in a C++ string.
34//
35// Usage:
36//      string result = StringPrintf("%d %s\n", 10, "hello");
37//      SStringPrintf(&result, "%d %s\n", 10, "hello");
38//      StringAppendF(&result, "%d %s\n", 20, "there");
39
40#ifndef GOOGLE_PROTOBUF_STUBS_STRINGPRINTF_H
41#define GOOGLE_PROTOBUF_STUBS_STRINGPRINTF_H
42
43#include <stdarg.h>
44#include <string>
45#include <vector>
46
47#include <google/protobuf/stubs/common.h>
48
49namespace google {
50namespace protobuf {
51
52// Return a C++ string
53extern string StringPrintf(const char* format, ...);
54
55// Store result into a supplied string and return it
56extern const string& SStringPrintf(string* dst, const char* format, ...);
57
58// Append result to a supplied string
59extern void StringAppendF(string* dst, const char* format, ...);
60
61// Lower-level routine that takes a va_list and appends to a specified
62// string.  All other routines are just convenience wrappers around it.
63extern void StringAppendV(string* dst, const char* format, va_list ap);
64
65// The max arguments supported by StringPrintfVector
66extern const int kStringPrintfVectorMaxArgs;
67
68// You can use this version when all your arguments are strings, but
69// you don't know how many arguments you'll have at compile time.
70// StringPrintfVector will LOG(FATAL) if v.size() > kStringPrintfVectorMaxArgs
71extern string StringPrintfVector(const char* format, const vector<string>& v);
72
73}  // namespace protobuf
74}  // namespace google
75
76#endif  // GOOGLE_PROTOBUF_STUBS_STRINGPRINTF_H
77