mirror of
https://github.com/RPCS3/llvm.git
synced 2026-01-31 01:25:19 +01:00
ee39f0be06
Summary: Someone must be responsible for handling an Error. When formatv takes ownership of an Error, the formatv_object destructor must take care of this. Passing an error by value to formatv() is not considered explicit enough to mark the error as handled (see D49013), so we require callers to use a format adapter to confirm this intent. Reviewers: zturner Subscribers: llvm-commits, lhames Differential Revision: https://reviews.llvm.org/D49170 git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@336888 91177308-0d34-0410-b5e6-96231b3b80d8
110 lines
3.3 KiB
C++
110 lines
3.3 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_FORMATADAPTERS_H
|
|
#define LLVM_SUPPORT_FORMATADAPTERS_H
|
|
|
|
#include "llvm/ADT/SmallString.h"
|
|
#include "llvm/ADT/StringRef.h"
|
|
#include "llvm/Support/Error.h"
|
|
#include "llvm/Support/FormatCommon.h"
|
|
#include "llvm/Support/FormatVariadicDetails.h"
|
|
#include "llvm/Support/raw_ostream.h"
|
|
|
|
namespace llvm {
|
|
template <typename T> class FormatAdapter : public detail::format_adapter {
|
|
protected:
|
|
explicit FormatAdapter(T &&Item) : Item(std::forward<T>(Item)) {}
|
|
|
|
T Item;
|
|
};
|
|
|
|
namespace detail {
|
|
template <typename T> class AlignAdapter final : public FormatAdapter<T> {
|
|
AlignStyle Where;
|
|
size_t Amount;
|
|
char Fill;
|
|
|
|
public:
|
|
AlignAdapter(T &&Item, AlignStyle Where, size_t Amount, char Fill)
|
|
: FormatAdapter<T>(std::forward<T>(Item)), Where(Where), Amount(Amount),
|
|
Fill(Fill) {}
|
|
|
|
void format(llvm::raw_ostream &Stream, StringRef Style) {
|
|
auto Adapter = detail::build_format_adapter(std::forward<T>(this->Item));
|
|
FmtAlign(Adapter, Where, Amount, Fill).format(Stream, Style);
|
|
}
|
|
};
|
|
|
|
template <typename T> class PadAdapter final : public FormatAdapter<T> {
|
|
size_t Left;
|
|
size_t Right;
|
|
|
|
public:
|
|
PadAdapter(T &&Item, size_t Left, size_t Right)
|
|
: FormatAdapter<T>(std::forward<T>(Item)), Left(Left), Right(Right) {}
|
|
|
|
void format(llvm::raw_ostream &Stream, StringRef Style) {
|
|
auto Adapter = detail::build_format_adapter(std::forward<T>(this->Item));
|
|
Stream.indent(Left);
|
|
Adapter.format(Stream, Style);
|
|
Stream.indent(Right);
|
|
}
|
|
};
|
|
|
|
template <typename T> class RepeatAdapter final : public FormatAdapter<T> {
|
|
size_t Count;
|
|
|
|
public:
|
|
RepeatAdapter(T &&Item, size_t Count)
|
|
: FormatAdapter<T>(std::forward<T>(Item)), Count(Count) {}
|
|
|
|
void format(llvm::raw_ostream &Stream, StringRef Style) {
|
|
auto Adapter = detail::build_format_adapter(std::forward<T>(this->Item));
|
|
for (size_t I = 0; I < Count; ++I) {
|
|
Adapter.format(Stream, Style);
|
|
}
|
|
}
|
|
};
|
|
|
|
class ErrorAdapter : public FormatAdapter<Error> {
|
|
public:
|
|
ErrorAdapter(Error &&Item) : FormatAdapter(std::move(Item)) {}
|
|
ErrorAdapter(ErrorAdapter &&) = default;
|
|
~ErrorAdapter() { consumeError(std::move(Item)); }
|
|
void format(llvm::raw_ostream &Stream, StringRef Style) { Stream << Item; }
|
|
};
|
|
}
|
|
|
|
template <typename T>
|
|
detail::AlignAdapter<T> fmt_align(T &&Item, AlignStyle Where, size_t Amount,
|
|
char Fill = ' ') {
|
|
return detail::AlignAdapter<T>(std::forward<T>(Item), Where, Amount, Fill);
|
|
}
|
|
|
|
template <typename T>
|
|
detail::PadAdapter<T> fmt_pad(T &&Item, size_t Left, size_t Right) {
|
|
return detail::PadAdapter<T>(std::forward<T>(Item), Left, Right);
|
|
}
|
|
|
|
template <typename T>
|
|
detail::RepeatAdapter<T> fmt_repeat(T &&Item, size_t Count) {
|
|
return detail::RepeatAdapter<T>(std::forward<T>(Item), Count);
|
|
}
|
|
|
|
// llvm::Error values must be consumed before being destroyed.
|
|
// Wrapping an error in fmt_consume explicitly indicates that the formatv_object
|
|
// should take ownership and consume it.
|
|
inline detail::ErrorAdapter fmt_consume(Error &&Item) {
|
|
return detail::ErrorAdapter(std::move(Item));
|
|
}
|
|
}
|
|
|
|
#endif
|