LLVM 19.0.0git
Printable.h
Go to the documentation of this file.
1//===--- Printable.h - Print function helpers -------------------*- C++ -*-===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8//
9// This file defines the Printable struct.
10//
11//===----------------------------------------------------------------------===//
12
13#ifndef LLVM_SUPPORT_PRINTABLE_H
14#define LLVM_SUPPORT_PRINTABLE_H
15
16#include <functional>
17#include <utility>
18
19namespace llvm {
20
21class raw_ostream;
22
23/// Simple wrapper around std::function<void(raw_ostream&)>.
24/// This class is useful to construct print helpers for raw_ostream.
25///
26/// Example:
27/// Printable printRegister(unsigned Register) {
28/// return Printable([Register](raw_ostream &OS) {
29/// OS << getRegisterName(Register);
30/// });
31/// }
32/// ... OS << printRegister(Register); ...
33///
34/// Implementation note: Ideally this would just be a typedef, but doing so
35/// leads to operator << being ambiguous as function has matching constructors
36/// in some STL versions. I have seen the problem on gcc 4.6 libstdc++ and
37/// microsoft STL.
38class Printable {
39public:
40 std::function<void(raw_ostream &OS)> Print;
41 Printable(std::function<void(raw_ostream &OS)> Print)
42 : Print(std::move(Print)) {}
43};
44
46 P.Print(OS);
47 return OS;
48}
49
50} // namespace llvm
51
52#endif
#define P(N)
raw_pwrite_stream & OS
Simple wrapper around std::function<void(raw_ostream&)>.
Definition: Printable.h:38
Printable(std::function< void(raw_ostream &OS)> Print)
Definition: Printable.h:41
std::function< void(raw_ostream &OS)> Print
Definition: Printable.h:40
This class implements an extremely fast bulk output stream that can only output to a stream.
Definition: raw_ostream.h:52
This is an optimization pass for GlobalISel generic memory operations.
Definition: AddressRanges.h:18
raw_ostream & operator<<(raw_ostream &OS, const APFixedPoint &FX)
Definition: APFixedPoint.h:293
OutputIt move(R &&Range, OutputIt Out)
Provide wrappers to std::move which take ranges instead of having to pass begin/end explicitly.
Definition: STLExtras.h:1858
Implement std::hash so that hash_code can be used in STL containers.
Definition: BitVector.h:858