Coverage Report

Created: 2019-02-21 13:17

/Users/buildslave/jenkins/workspace/clang-stage2-coverage-R/llvm/include/llvm/MC/MCInstPrinter.h
Line
Count
Source (jump to first uncovered line)
1
//===- MCInstPrinter.h - MCInst to target assembly syntax -------*- 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
#ifndef LLVM_MC_MCINSTPRINTER_H
10
#define LLVM_MC_MCINSTPRINTER_H
11
12
#include "llvm/Support/Format.h"
13
#include <cstdint>
14
15
namespace llvm {
16
17
class MCAsmInfo;
18
class MCInst;
19
class MCInstrInfo;
20
class MCRegisterInfo;
21
class MCSubtargetInfo;
22
class raw_ostream;
23
class StringRef;
24
25
/// Convert `Bytes' to a hex string and output to `OS'
26
void dumpBytes(ArrayRef<uint8_t> Bytes, raw_ostream &OS);
27
28
namespace HexStyle {
29
30
enum Style {
31
  C,  ///< 0xff
32
  Asm ///< 0ffh
33
};
34
35
} // end namespace HexStyle
36
37
/// This is an instance of a target assembly language printer that
38
/// converts an MCInst to valid target assembly syntax.
39
class MCInstPrinter {
40
protected:
41
  /// A stream that comments can be emitted to if desired.  Each comment
42
  /// must end with a newline.  This will be null if verbose assembly emission
43
  /// is disabled.
44
  raw_ostream *CommentStream = nullptr;
45
  const MCAsmInfo &MAI;
46
  const MCInstrInfo &MII;
47
  const MCRegisterInfo &MRI;
48
49
  /// True if we are printing marked up assembly.
50
  bool UseMarkup = false;
51
52
  /// True if we are printing immediates as hex.
53
  bool PrintImmHex = false;
54
55
  /// Which style to use for printing hexadecimal values.
56
  HexStyle::Style PrintHexStyle = HexStyle::C;
57
58
  /// Utility function for printing annotations.
59
  void printAnnotation(raw_ostream &OS, StringRef Annot);
60
61
public:
62
  MCInstPrinter(const MCAsmInfo &mai, const MCInstrInfo &mii,
63
26.4k
                const MCRegisterInfo &mri) : MAI(mai), MII(mii), MRI(mri) {}
64
65
  virtual ~MCInstPrinter();
66
67
  /// Specify a stream to emit comments to.
68
23.4k
  void setCommentStream(raw_ostream &OS) { CommentStream = &OS; }
69
70
  /// Print the specified MCInst to the specified raw_ostream.
71
  virtual void printInst(const MCInst *MI, raw_ostream &OS, StringRef Annot,
72
                         const MCSubtargetInfo &STI) = 0;
73
74
  /// Return the name of the specified opcode enum (e.g. "MOV32ri") or
75
  /// empty if we can't resolve it.
76
  StringRef getOpcodeName(unsigned Opcode) const;
77
78
  /// Print the assembler register name.
79
  virtual void printRegName(raw_ostream &OS, unsigned RegNo) const;
80
81
5.38M
  bool getUseMarkup() const { return UseMarkup; }
82
  void setUseMarkup(bool Value) { UseMarkup = Value; }
83
84
  /// Utility functions to make adding mark ups simpler.
85
  StringRef markup(StringRef s) const;
86
  StringRef markup(StringRef a, StringRef b) const;
87
88
579
  bool getPrintImmHex() const { return PrintImmHex; }
89
  void setPrintImmHex(bool Value) { PrintImmHex = Value; }
90
91
0
  HexStyle::Style getPrintHexStyle() const { return PrintHexStyle; }
92
0
  void setPrintHexStyle(HexStyle::Style Value) { PrintHexStyle = Value; }
93
94
  /// Utility function to print immediates in decimal or hex.
95
564k
  format_object<int64_t> formatImm(int64_t Value) const {
96
564k
    return PrintImmHex ? 
formatHex(Value)1.66k
:
formatDec(Value)562k
;
97
564k
  }
98
99
  /// Utility functions to print decimal/hexadecimal values.
100
  format_object<int64_t> formatDec(int64_t Value) const;
101
  format_object<int64_t> formatHex(int64_t Value) const;
102
  format_object<uint64_t> formatHex(uint64_t Value) const;
103
};
104
105
} // end namespace llvm
106
107
#endif // LLVM_MC_MCINSTPRINTER_H