include/llvm/Support/Format.h

   1 //===- Format.h - Efficient printf-style formatting for streams -*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file implements the format() function, which can be used with other
  11 // LLVM subsystems to provide printf-style formatting.  This gives all the power
  12 // and risk of printf.  This can be used like this (with raw_ostreams as an
  13 // example):
  14 //
  15 //    OS << "mynumber: " << format("%4.5f", 1234.412) << '\n';
  16 //
  17 // Or if you prefer:
  18 //
  19 //  OS << format("mynumber: %4.5f\n", 1234.412);
  20 //
  21 //===----------------------------------------------------------------------===//
  22
  23 #ifndef LLVM_SUPPORT_FORMAT_H
  24 #define LLVM_SUPPORT_FORMAT_H
  25
  26 #include <cassert>
  27 #include <cstdio>
  28 #ifdef _MSC_VER
  29 // FIXME: This define is wrong:
  30 //  - _snprintf does not guarantee that trailing null is always added - if
  31 //    there is no space for null, it does not report any error.
  32 //  - According to C++ standard, snprintf should be visible in the 'std'
  33 //    namespace - this define makes this impossible.
  34 #define snprintf _snprintf
  35 #endif
  36
  37 namespace llvm {
  38
  39 /// format_object_base - This is a helper class used for handling formatted
  40 /// output.  It is the abstract base class of a templated derived class.
  41 class format_object_base {
  42 protected:
  43   const char *Fmt;
  44   virtual void home(); // Out of line virtual method.
  45
  46   /// snprint - Call snprintf() for this object, on the given buffer and size.
  47   virtual int snprint(char *Buffer, unsigned BufferSize) const = 0;
  48
  49 public:
  50   format_object_base(const char *fmt) : Fmt(fmt) {}
  51   virtual ~format_object_base() {}
  52
  53   /// print - Format the object into the specified buffer.  On success, this
  54   /// returns the length of the formatted string.  If the buffer is too small,
  55   /// this returns a length to retry with, which will be larger than BufferSize.
  56   unsigned print(char *Buffer, unsigned BufferSize) const {
  57     assert(BufferSize && "Invalid buffer size!");
  58
  59     // Print the string, leaving room for the terminating null.
  60     int N = snprint(Buffer, BufferSize);
  61
  62     // VC++ and old GlibC return negative on overflow, just double the size.
  63     if (N < 0)
  64       return BufferSize*2;
  65
  66     // Other impls yield number of bytes needed, not including the final '\0'.
  67     if (unsigned(N) >= BufferSize)
  68       return N+1;
  69
  70     // Otherwise N is the length of output (not including the final '\0').
  71     return N;
  72   }
  73 };
  74
  75 /// format_object1 - This is a templated helper class used by the format
  76 /// function that captures the object to be formated and the format string. When
  77 /// actually printed, this synthesizes the string into a temporary buffer
  78 /// provided and returns whether or not it is big enough.
  79 template <typename T>
  80 class format_object1 : public format_object_base {
  81   T Val;
  82 public:
  83   format_object1(const char *fmt, const T &val)
  84     : format_object_base(fmt), Val(val) {
  85   }
  86
  87   int snprint(char *Buffer, unsigned BufferSize) const override {
  88     return snprintf(Buffer, BufferSize, Fmt, Val);
  89   }
  90 };
  91
  92 /// format_object2 - This is a templated helper class used by the format
  93 /// function that captures the object to be formated and the format string. When
  94 /// actually printed, this synthesizes the string into a temporary buffer
  95 /// provided and returns whether or not it is big enough.
  96 template <typename T1, typename T2>
  97 class format_object2 : public format_object_base {
  98   T1 Val1;
  99   T2 Val2;
 100 public:
 101   format_object2(const char *fmt, const T1 &val1, const T2 &val2)
 102   : format_object_base(fmt), Val1(val1), Val2(val2) {
 103   }
 104
 105   int snprint(char *Buffer, unsigned BufferSize) const override {
 106     return snprintf(Buffer, BufferSize, Fmt, Val1, Val2);
 107   }
 108 };
 109
 110 /// format_object3 - This is a templated helper class used by the format
 111 /// function that captures the object to be formated and the format string. When
 112 /// actually printed, this synthesizes the string into a temporary buffer
 113 /// provided and returns whether or not it is big enough.
 114 template <typename T1, typename T2, typename T3>
 115 class format_object3 : public format_object_base {
 116   T1 Val1;
 117   T2 Val2;
 118   T3 Val3;
 119 public:
 120   format_object3(const char *fmt, const T1 &val1, const T2 &val2,const T3 &val3)
 121     : format_object_base(fmt), Val1(val1), Val2(val2), Val3(val3) {
 122   }
 123
 124   int snprint(char *Buffer, unsigned BufferSize) const override {
 125     return snprintf(Buffer, BufferSize, Fmt, Val1, Val2, Val3);
 126   }
 127 };
 128
 129 /// format_object4 - This is a templated helper class used by the format
 130 /// function that captures the object to be formated and the format string. When
 131 /// actually printed, this synthesizes the string into a temporary buffer
 132 /// provided and returns whether or not it is big enough.
 133 template <typename T1, typename T2, typename T3, typename T4>
 134 class format_object4 : public format_object_base {
 135   T1 Val1;
 136   T2 Val2;
 137   T3 Val3;
 138   T4 Val4;
 139 public:
 140   format_object4(const char *fmt, const T1 &val1, const T2 &val2,
 141                  const T3 &val3, const T4 &val4)
 142     : format_object_base(fmt), Val1(val1), Val2(val2), Val3(val3), Val4(val4) {
 143   }
 144
 145   int snprint(char *Buffer, unsigned BufferSize) const override {
 146     return snprintf(Buffer, BufferSize, Fmt, Val1, Val2, Val3, Val4);
 147   }
 148 };
 149
 150 /// format_object5 - This is a templated helper class used by the format
 151 /// function that captures the object to be formated and the format string. When
 152 /// actually printed, this synthesizes the string into a temporary buffer
 153 /// provided and returns whether or not it is big enough.
 154 template <typename T1, typename T2, typename T3, typename T4, typename T5>
 155 class format_object5 : public format_object_base {
 156   T1 Val1;
 157   T2 Val2;
 158   T3 Val3;
 159   T4 Val4;
 160   T5 Val5;
 161 public:
 162   format_object5(const char *fmt, const T1 &val1, const T2 &val2,
 163                  const T3 &val3, const T4 &val4, const T5 &val5)
 164     : format_object_base(fmt), Val1(val1), Val2(val2), Val3(val3), Val4(val4),
 165       Val5(val5) {
 166   }
 167
 168   int snprint(char *Buffer, unsigned BufferSize) const override {
 169     return snprintf(Buffer, BufferSize, Fmt, Val1, Val2, Val3, Val4, Val5);
 170   }
 171 };
 172
 173 /// format_object6 - This is a templated helper class used by the format
 174 /// function that captures the object to be formated and the format string. When
 175 /// actually printed, this synthesizes the string into a temporary buffer
 176 /// provided and returns whether or not it is big enough.
 177 template <typename T1, typename T2, typename T3, typename T4, typename T5,
 178           typename T6>
 179 class format_object6 : public format_object_base {
 180   T1 Val1;
 181   T2 Val2;
 182   T3 Val3;
 183   T4 Val4;
 184   T5 Val5;
 185   T6 Val6;
 186 public:
 187   format_object6(const char *Fmt, const T1 &Val1, const T2 &Val2,
 188                  const T3 &Val3, const T4 &Val4, const T5 &Val5, const T6 &Val6)
 189     : format_object_base(Fmt), Val1(Val1), Val2(Val2), Val3(Val3), Val4(Val4),
 190       Val5(Val5), Val6(Val6) { }
 191
 192   int snprint(char *Buffer, unsigned BufferSize) const override {
 193     return snprintf(Buffer, BufferSize, Fmt, Val1, Val2, Val3, Val4, Val5, Val6);
 194   }
 195 };
 196
 197 /// This is a helper function that is used to produce formatted output.
 198 ///
 199 /// This is typically used like:
 200 /// \code
 201 ///   OS << format("%0.4f", myfloat) << '\n';
 202 /// \endcode
 203 template <typename T>
 204 inline format_object1<T> format(const char *Fmt, const T &Val) {
 205   return format_object1<T>(Fmt, Val);
 206 }
 207
 208 /// This is a helper function that is used to produce formatted output.
 209 ///
 210 /// This is typically used like:
 211 /// \code
 212 ///   OS << format("%0.4f", myfloat) << '\n';
 213 /// \endcode
 214 template <typename T1, typename T2>
 215 inline format_object2<T1, T2> format(const char *Fmt, const T1 &Val1,
 216                                      const T2 &Val2) {
 217   return format_object2<T1, T2>(Fmt, Val1, Val2);
 218 }
 219
 220 /// This is a helper function that is used to produce formatted output.
 221 ///
 222 /// This is typically used like:
 223 /// \code
 224 ///   OS << format("%0.4f", myfloat) << '\n';
 225 /// \endcode
 226 template <typename T1, typename T2, typename T3>
 227   inline format_object3<T1, T2, T3> format(const char *Fmt, const T1 &Val1,
 228                                            const T2 &Val2, const T3 &Val3) {
 229   return format_object3<T1, T2, T3>(Fmt, Val1, Val2, Val3);
 230 }
 231
 232 /// This is a helper function that is used to produce formatted output.
 233 ///
 234 /// This is typically used like:
 235 /// \code
 236 ///   OS << format("%0.4f", myfloat) << '\n';
 237 /// \endcode
 238 template <typename T1, typename T2, typename T3, typename T4>
 239 inline format_object4<T1, T2, T3, T4> format(const char *Fmt, const T1 &Val1,
 240                                              const T2 &Val2, const T3 &Val3,
 241                                              const T4 &Val4) {
 242   return format_object4<T1, T2, T3, T4>(Fmt, Val1, Val2, Val3, Val4);
 243 }
 244
 245 /// This is a helper function that is used to produce formatted output.
 246 ///
 247 /// This is typically used like:
 248 /// \code
 249 ///   OS << format("%0.4f", myfloat) << '\n';
 250 /// \endcode
 251 template <typename T1, typename T2, typename T3, typename T4, typename T5>
 252 inline format_object5<T1, T2, T3, T4, T5> format(const char *Fmt,const T1 &Val1,
 253                                              const T2 &Val2, const T3 &Val3,
 254                                              const T4 &Val4, const T5 &Val5) {
 255   return format_object5<T1, T2, T3, T4, T5>(Fmt, Val1, Val2, Val3, Val4, Val5);
 256 }
 257
 258 /// This is a helper function that is used to produce formatted output.
 259 ///
 260 /// This is typically used like:
 261 /// \code
 262 ///   OS << format("%0.4f", myfloat) << '\n';
 263 /// \endcode
 264 template <typename T1, typename T2, typename T3, typename T4, typename T5,
 265           typename T6>
 266 inline format_object6<T1, T2, T3, T4, T5, T6>
 267 format(const char *Fmt, const T1 &Val1, const T2 &Val2, const T3 &Val3,
 268        const T4 &Val4, const T5 &Val5, const T6 &Val6) {
 269   return format_object6<T1, T2, T3, T4, T5, T6>(Fmt, Val1, Val2, Val3, Val4,
 270                                                 Val5, Val6);
 271 }
 272
 273 } // end namespace llvm
 274
 275 #endif