llvm-mirror/include/llvm/Support/FormatCommon.h
Zachary Turner 1cad744181 [Support] Introduce llvm::formatv() function.
This introduces a new type-safe general purpose formatting
library.  It provides compile-time type safety, does not require
a format specifier (since the type is deduced), and provides
mechanisms for extending the format capability to user defined
types, and overriding the formatting behavior for existing types.

This patch additionally adds documentation for the API to the
LLVM programmer's manual.

Mailing List Thread:
http://lists.llvm.org/pipermail/llvm-dev/2016-October/105836.html

Differential Revision: https://reviews.llvm.org/D25587

llvm-svn: 286682
2016-11-11 23:57:40 +00:00

69 lines
1.9 KiB
C++

//===- FormatAdapters.h - Formatters for common LLVM types -----*- C++ -*-===//
//
// The LLVM Compiler Infrastructure
//
// This file is distributed under the University of Illinois Open Source
// License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//
#ifndef LLVM_SUPPORT_FORMATCOMMON_H
#define LLVM_SUPPORT_FORMATCOMMON_H
#include "llvm/ADT/SmallString.h"
#include "llvm/Support/FormatVariadicDetails.h"
#include "llvm/Support/raw_ostream.h"
namespace llvm {
enum class AlignStyle { Left, Center, Right };
struct FmtAlign {
detail::format_wrapper &Wrapper;
AlignStyle Where;
size_t Amount;
FmtAlign(detail::format_wrapper &Wrapper, AlignStyle Where, size_t Amount)
: Wrapper(Wrapper), Where(Where), Amount(Amount) {}
void format(raw_ostream &S, StringRef Options) {
// If we don't need to align, we can format straight into the underlying
// stream. Otherwise we have to go through an intermediate stream first
// in order to calculate how long the output is so we can align it.
// TODO: Make the format method return the number of bytes written, that
// way we can also skip the intermediate stream for left-aligned output.
if (Amount == 0) {
Wrapper.format(S, Options);
return;
}
SmallString<64> Item;
raw_svector_ostream Stream(Item);
Wrapper.format(Stream, Options);
if (Amount <= Item.size()) {
S << Item;
return;
}
size_t PadAmount = Amount - Item.size();
switch (Where) {
case AlignStyle::Left:
S << Item;
S.indent(PadAmount);
break;
case AlignStyle::Center: {
size_t X = PadAmount / 2;
S.indent(X);
S << Item;
S.indent(PadAmount - X);
break;
}
default:
S.indent(PadAmount);
S << Item;
break;
}
}
};
}
#endif