mirror of
https://github.com/RPCS3/llvm-mirror.git
synced 2024-11-23 19:23:23 +01:00
076a6683eb
We've been running doxygen with the autobrief option for a couple of years now. This makes the \brief markers into our comments redundant. Since they are a visual distraction and we don't want to encourage more \brief markers in new code either, this patch removes them all. Patch produced by for i in $(git grep -l '\\brief'); do perl -pi -e 's/\\brief //g' $i & done Differential Revision: https://reviews.llvm.org/D46290 llvm-svn: 331272
62 lines
1.8 KiB
C++
62 lines
1.8 KiB
C++
//===- RenderingSupport.h - output stream rendering support functions ----===//
|
|
//
|
|
// The LLVM Compiler Infrastructure
|
|
//
|
|
// This file is distributed under the University of Illinois Open Source
|
|
// License. See LICENSE.TXT for details.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#ifndef LLVM_COV_RENDERINGSUPPORT_H
|
|
#define LLVM_COV_RENDERINGSUPPORT_H
|
|
|
|
#include "llvm/Support/raw_ostream.h"
|
|
#include <utility>
|
|
|
|
namespace llvm {
|
|
|
|
/// A helper class that resets the output stream's color if needed
|
|
/// when destroyed.
|
|
class ColoredRawOstream {
|
|
ColoredRawOstream(const ColoredRawOstream &OS) = delete;
|
|
|
|
public:
|
|
raw_ostream &OS;
|
|
bool IsColorUsed;
|
|
|
|
ColoredRawOstream(raw_ostream &OS, bool IsColorUsed)
|
|
: OS(OS), IsColorUsed(IsColorUsed) {}
|
|
|
|
ColoredRawOstream(ColoredRawOstream &&Other)
|
|
: OS(Other.OS), IsColorUsed(Other.IsColorUsed) {
|
|
// Reset the other IsColorUsed so that the other object won't reset the
|
|
// color when destroyed.
|
|
Other.IsColorUsed = false;
|
|
}
|
|
|
|
~ColoredRawOstream() {
|
|
if (IsColorUsed)
|
|
OS.resetColor();
|
|
}
|
|
};
|
|
|
|
template <typename T>
|
|
inline raw_ostream &operator<<(const ColoredRawOstream &OS, T &&Value) {
|
|
return OS.OS << std::forward<T>(Value);
|
|
}
|
|
|
|
/// Change the color of the output stream if the `IsColorUsed` flag
|
|
/// is true. Returns an object that resets the color when destroyed.
|
|
inline ColoredRawOstream colored_ostream(raw_ostream &OS,
|
|
raw_ostream::Colors Color,
|
|
bool IsColorUsed = true,
|
|
bool Bold = false, bool BG = false) {
|
|
if (IsColorUsed)
|
|
OS.changeColor(Color, Bold, BG);
|
|
return ColoredRawOstream(OS, IsColorUsed);
|
|
}
|
|
|
|
} // namespace llvm
|
|
|
|
#endif // LLVM_COV_RENDERINGSUPPORT_H
|