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
  29 namespace llvm {
  30
  31 /// format_object_base - This is a helper class used for handling formatted
  32 /// output.  It is the abstract base class of a templated derived class.
  33 class format_object_base {
  34 protected:
  35   const char *Fmt;
  36   virtual void home(); // Out of line virtual method.
  37
  38   /// snprint - Call snprintf() for this object, on the given buffer and size.
  39   virtual int snprint(char *Buffer, unsigned BufferSize) const = 0;
  40
  41 public:
  42   format_object_base(const char *fmt) : Fmt(fmt) {}
  43   virtual ~format_object_base() {}
  44
  45   /// print - Format the object into the specified buffer.  On success, this
  46   /// returns the length of the formatted string.  If the buffer is too small,
  47   /// this returns a length to retry with, which will be larger than BufferSize.
  48   unsigned print(char *Buffer, unsigned BufferSize) const {
  49     assert(BufferSize && "Invalid buffer size!");
  50
  51     // Print the string, leaving room for the terminating null.
  52     int N = snprint(Buffer, BufferSize);
  53
  54     // VC++ and old GlibC return negative on overflow, just double the size.
  55     if (N < 0)
  56       return BufferSize*2;
  57
  58     // Other impls yield number of bytes needed, not including the final '\0'.
  59     if (unsigned(N) >= BufferSize)
  60       return N+1;
  61
  62     // Otherwise N is the length of output (not including the final '\0').
  63     return N;
  64   }
  65 };
  66
  67 /// format_object1 - This is a templated helper class used by the format
  68 /// function that captures the object to be formated and the format string. When
  69 /// actually printed, this synthesizes the string into a temporary buffer
  70 /// provided and returns whether or not it is big enough.
  71 template <typename T>
  72 class format_object1 : public format_object_base {
  73   T Val;
  74 public:
  75   format_object1(const char *fmt, const T &val)
  76     : format_object_base(fmt), Val(val) {
  77   }
  78
  79   virtual int snprint(char *Buffer, unsigned BufferSize) const {
  80     return snprintf(Buffer, BufferSize, Fmt, Val);
  81   }
  82 };
  83
  84 /// format_object2 - This is a templated helper class used by the format
  85 /// function that captures the object to be formated and the format string. When
  86 /// actually printed, this synthesizes the string into a temporary buffer
  87 /// provided and returns whether or not it is big enough.
  88 template <typename T1, typename T2>
  89 class format_object2 : public format_object_base {
  90   T1 Val1;
  91   T2 Val2;
  92 public:
  93   format_object2(const char *fmt, const T1 &val1, const T2 &val2)
  94   : format_object_base(fmt), Val1(val1), Val2(val2) {
  95   }
  96
  97   virtual int snprint(char *Buffer, unsigned BufferSize) const {
  98     return snprintf(Buffer, BufferSize, Fmt, Val1, Val2);
  99   }
 100 };
 101
 102 /// format_object3 - This is a templated helper class used by the format
 103 /// function that captures the object to be formated and the format string. When
 104 /// actually printed, this synthesizes the string into a temporary buffer
 105 /// provided and returns whether or not it is big enough.
 106 template <typename T1, typename T2, typename T3>
 107 class format_object3 : public format_object_base {
 108   T1 Val1;
 109   T2 Val2;
 110   T3 Val3;
 111 public:
 112   format_object3(const char *fmt, const T1 &val1, const T2 &val2,const T3 &val3)
 113     : format_object_base(fmt), Val1(val1), Val2(val2), Val3(val3) {
 114   }
 115
 116   virtual int snprint(char *Buffer, unsigned BufferSize) const {
 117     return snprintf(Buffer, BufferSize, Fmt, Val1, Val2, Val3);
 118   }
 119 };
 120
 121 /// format - This is a helper function that is used to produce formatted output.
 122 /// This is typically used like:  OS << format("%0.4f", myfloat) << '\n';
 123 template <typename T>
 124 inline format_object1<T> format(const char *Fmt, const T &Val) {
 125   return format_object1<T>(Fmt, Val);
 126 }
 127
 128 /// format - This is a helper function that is used to produce formatted output.
 129 /// This is typically used like:  OS << format("%0.4f", myfloat) << '\n';
 130 template <typename T1, typename T2>
 131 inline format_object2<T1, T2> format(const char *Fmt, const T1 &Val1,
 132                                      const T2 &Val2) {
 133   return format_object2<T1, T2>(Fmt, Val1, Val2);
 134 }
 135
 136 /// format - This is a helper function that is used to produce formatted output.
 137 /// This is typically used like:  OS << format("%0.4f", myfloat) << '\n';
 138 template <typename T1, typename T2, typename T3>
 139   inline format_object3<T1, T2, T3> format(const char *Fmt, const T1 &Val1,
 140                                            const T2 &Val2, const T3 &Val3) {
 141   return format_object3<T1, T2, T3>(Fmt, Val1, Val2, Val3);
 142 }
 143
 144 } // end namespace llvm
 145
 146 #endif