llvm-mirror/tools/llvm-cov/RenderingSupport.h
Chandler Carruth ae65e281f3 Update the file headers across all of the LLVM projects in the monorepo
to reflect the new license.

We understand that people may be surprised that we're moving the header
entirely to discuss the new license. We checked this carefully with the
Foundation's lawyer and we believe this is the correct approach.

Essentially, all code in the project is now made available by the LLVM
project under our new license, so you will see that the license headers
include that license only. Some of our contributors have contributed
code under our old license, and accordingly, we have retained a copy of
our old license notice in the top-level files in each project and
repository.

llvm-svn: 351636
2019-01-19 08:50:56 +00:00

61 lines
1.8 KiB
C++

//===- RenderingSupport.h - output stream rendering support functions ----===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
#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