DebugInfo/CodeView/CVTypeVisitor.h

0001 //===- CVTypeVisitor.h ------------------------------------------*- C++ -*-===//
0002 //
0003 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
0004 // See https://llvm.org/LICENSE.txt for license information.
0005 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
0006 //
0007 //===----------------------------------------------------------------------===//
0008
0009 #ifndef LLVM_DEBUGINFO_CODEVIEW_CVTYPEVISITOR_H
0010 #define LLVM_DEBUGINFO_CODEVIEW_CVTYPEVISITOR_H
0011
0012 #include "llvm/ADT/ArrayRef.h"
0013 #include "llvm/DebugInfo/CodeView/CVRecord.h"
0014 #include "llvm/DebugInfo/CodeView/CodeView.h"
0015 #include "llvm/Support/Error.h"
0016
0017 namespace llvm {
0018 namespace codeview {
0019 class TypeIndex;
0020 class TypeCollection;
0021 class TypeVisitorCallbacks;
0022 struct CVMemberRecord;
0023
0024 enum VisitorDataSource {
0025   VDS_BytesPresent, // The record bytes are passed into the visitation
0026                     // function.  The algorithm should first deserialize them
0027                     // before passing them on through the pipeline.
0028   VDS_BytesExternal // The record bytes are not present, and it is the
0029                     // responsibility of the visitor callback interface to
0030                     // supply the bytes.
0031 };
0032
0033 Error visitTypeRecord(CVType &Record, TypeIndex Index,
0034                       TypeVisitorCallbacks &Callbacks,
0035                       VisitorDataSource Source = VDS_BytesPresent);
0036 Error visitTypeRecord(CVType &Record, TypeVisitorCallbacks &Callbacks,
0037                       VisitorDataSource Source = VDS_BytesPresent);
0038
0039 Error visitMemberRecord(CVMemberRecord Record, TypeVisitorCallbacks &Callbacks,
0040                         VisitorDataSource Source = VDS_BytesPresent);
0041 Error visitMemberRecord(TypeLeafKind Kind, ArrayRef<uint8_t> Record,
0042                         TypeVisitorCallbacks &Callbacks);
0043
0044 Error visitMemberRecordStream(ArrayRef<uint8_t> FieldList,
0045                               TypeVisitorCallbacks &Callbacks);
0046
0047 Error visitTypeStream(const CVTypeArray &Types, TypeVisitorCallbacks &Callbacks,
0048                       VisitorDataSource Source = VDS_BytesPresent);
0049 Error visitTypeStream(CVTypeRange Types, TypeVisitorCallbacks &Callbacks);
0050 Error visitTypeStream(TypeCollection &Types, TypeVisitorCallbacks &Callbacks);
0051
0052 } // end namespace codeview
0053 } // end namespace llvm
0054
0055 #endif // LLVM_DEBUGINFO_CODEVIEW_CVTYPEVISITOR_H