base/stringprintf.h

   1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef BASE_STRINGPRINTF_H_
   6 #define BASE_STRINGPRINTF_H_
   7
   8 #include <stdarg.h>   // va_list
   9
  10 #include <string>
  11
  12 #include "base/base_export.h"
  13 #include "base/compiler_specific.h"
  14
  15 namespace base {
  16
  17 // Return a C++ string given printf-like input.
  18 BASE_EXPORT std::string StringPrintf(const char* format, ...)
  19     PRINTF_FORMAT(1, 2);
  20 // OS_ANDROID's libc does not support wchar_t, so several overloads are omitted.
  21 #if !defined(OS_ANDROID)
  22 BASE_EXPORT std::wstring StringPrintf(const wchar_t* format, ...)
  23     WPRINTF_FORMAT(1, 2);
  24 #endif
  25
  26 // Return a C++ string given vprintf-like input.
  27 BASE_EXPORT std::string StringPrintV(const char* format, va_list ap)
  28     PRINTF_FORMAT(1, 0);
  29
  30 // Store result into a supplied string and return it.
  31 BASE_EXPORT const std::string& SStringPrintf(std::string* dst,
  32                                              const char* format, ...)
  33     PRINTF_FORMAT(2, 3);
  34 #if !defined(OS_ANDROID)
  35 BASE_EXPORT const std::wstring& SStringPrintf(std::wstring* dst,
  36                                               const wchar_t* format, ...)
  37     WPRINTF_FORMAT(2, 3);
  38 #endif
  39
  40 // Append result to a supplied string.
  41 BASE_EXPORT void StringAppendF(std::string* dst, const char* format, ...)
  42     PRINTF_FORMAT(2, 3);
  43 #if !defined(OS_ANDROID)
  44 // TODO(evanm): this is only used in a few places in the code;
  45 // replace with string16 version.
  46 BASE_EXPORT void StringAppendF(std::wstring* dst, const wchar_t* format, ...)
  47     WPRINTF_FORMAT(2, 3);
  48 #endif
  49
  50 // Lower-level routine that takes a va_list and appends to a specified
  51 // string.  All other routines are just convenience wrappers around it.
  52 BASE_EXPORT void StringAppendV(std::string* dst, const char* format, va_list ap)
  53     PRINTF_FORMAT(2, 0);
  54 #if !defined(OS_ANDROID)
  55 BASE_EXPORT void StringAppendV(std::wstring* dst,
  56                                const wchar_t* format, va_list ap)
  57     WPRINTF_FORMAT(2, 0);
  58 #endif
  59
  60 }  // namespace base
  61
  62 // Don't require the namespace for legacy code. New code should use "base::" or
  63 // have its own using decl.
  64 //
  65 // TODO(brettw) remove these when calling code is converted.
  66 using base::StringPrintf;
  67
  68 #endif  // BASE_STRINGPRINTF_H_