xref: /freebsd-src/contrib/llvm-project/llvm/include/llvm/DebugInfo/CodeView/Formatters.h (revision 81ad626541db97eb356e2c1d4a20eb2a26a766ab)
10b57cec5SDimitry Andric //===- Formatters.h ---------------------------------------------*- C++ -*-===//
20b57cec5SDimitry Andric //
30b57cec5SDimitry Andric // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
40b57cec5SDimitry Andric // See https://llvm.org/LICENSE.txt for license information.
50b57cec5SDimitry Andric // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
60b57cec5SDimitry Andric //
70b57cec5SDimitry Andric //===----------------------------------------------------------------------===//
80b57cec5SDimitry Andric 
90b57cec5SDimitry Andric #ifndef LLVM_DEBUGINFO_CODEVIEW_FORMATTERS_H
100b57cec5SDimitry Andric #define LLVM_DEBUGINFO_CODEVIEW_FORMATTERS_H
110b57cec5SDimitry Andric 
120b57cec5SDimitry Andric #include "llvm/ADT/ArrayRef.h"
130b57cec5SDimitry Andric #include "llvm/ADT/StringRef.h"
140b57cec5SDimitry Andric #include "llvm/DebugInfo/CodeView/GUID.h"
150b57cec5SDimitry Andric #include "llvm/DebugInfo/CodeView/TypeIndex.h"
160b57cec5SDimitry Andric #include "llvm/Support/FormatAdapters.h"
170b57cec5SDimitry Andric #include "llvm/Support/FormatVariadic.h"
180b57cec5SDimitry Andric #include "llvm/Support/raw_ostream.h"
190b57cec5SDimitry Andric #include <cstdint>
200b57cec5SDimitry Andric 
210b57cec5SDimitry Andric namespace llvm {
220b57cec5SDimitry Andric 
230b57cec5SDimitry Andric namespace codeview {
240b57cec5SDimitry Andric 
25*81ad6265SDimitry Andric struct GUID;
26*81ad6265SDimitry Andric 
270b57cec5SDimitry Andric namespace detail {
280b57cec5SDimitry Andric 
290b57cec5SDimitry Andric class GuidAdapter final : public FormatAdapter<ArrayRef<uint8_t>> {
300b57cec5SDimitry Andric   ArrayRef<uint8_t> Guid;
310b57cec5SDimitry Andric 
320b57cec5SDimitry Andric public:
330b57cec5SDimitry Andric   explicit GuidAdapter(ArrayRef<uint8_t> Guid);
340b57cec5SDimitry Andric   explicit GuidAdapter(StringRef Guid);
350b57cec5SDimitry Andric 
360b57cec5SDimitry Andric   void format(raw_ostream &Stream, StringRef Style) override;
370b57cec5SDimitry Andric };
380b57cec5SDimitry Andric 
390b57cec5SDimitry Andric } // end namespace detail
400b57cec5SDimitry Andric 
fmt_guid(StringRef Item)410b57cec5SDimitry Andric inline detail::GuidAdapter fmt_guid(StringRef Item) {
420b57cec5SDimitry Andric   return detail::GuidAdapter(Item);
430b57cec5SDimitry Andric }
440b57cec5SDimitry Andric 
fmt_guid(ArrayRef<uint8_t> Item)450b57cec5SDimitry Andric inline detail::GuidAdapter fmt_guid(ArrayRef<uint8_t> Item) {
460b57cec5SDimitry Andric   return detail::GuidAdapter(Item);
470b57cec5SDimitry Andric }
480b57cec5SDimitry Andric 
490b57cec5SDimitry Andric } // end namespace codeview
500b57cec5SDimitry Andric 
510b57cec5SDimitry Andric template <> struct format_provider<codeview::TypeIndex> {
520b57cec5SDimitry Andric public:
530b57cec5SDimitry Andric   static void format(const codeview::TypeIndex &V, raw_ostream &Stream,
540b57cec5SDimitry Andric                      StringRef Style) {
550b57cec5SDimitry Andric     if (V.isNoneType())
560b57cec5SDimitry Andric       Stream << "<no type>";
570b57cec5SDimitry Andric     else {
580b57cec5SDimitry Andric       Stream << formatv("{0:X+4}", V.getIndex());
590b57cec5SDimitry Andric       if (V.isSimple())
600b57cec5SDimitry Andric         Stream << " (" << codeview::TypeIndex::simpleTypeName(V) << ")";
610b57cec5SDimitry Andric     }
620b57cec5SDimitry Andric   }
630b57cec5SDimitry Andric };
640b57cec5SDimitry Andric 
650b57cec5SDimitry Andric template <> struct format_provider<codeview::GUID> {
660b57cec5SDimitry Andric   static void format(const codeview::GUID &V, llvm::raw_ostream &Stream,
670b57cec5SDimitry Andric                      StringRef Style) {
680b57cec5SDimitry Andric     Stream << V;
690b57cec5SDimitry Andric   }
700b57cec5SDimitry Andric };
710b57cec5SDimitry Andric 
720b57cec5SDimitry Andric } // end namespace llvm
730b57cec5SDimitry Andric 
740b57cec5SDimitry Andric #endif // LLVM_DEBUGINFO_CODEVIEW_FORMATTERS_H
75