xref: /freebsd/contrib/llvm-project/llvm/include/llvm/DebugInfo/CodeView/CVSymbolVisitor.h (revision 5ca8e32633c4ffbbcd6762e5888b6a4ba0708c6c)
1 //===- CVSymbolVisitor.h ----------------------------------------*- 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_DEBUGINFO_CODEVIEW_CVSYMBOLVISITOR_H
10 #define LLVM_DEBUGINFO_CODEVIEW_CVSYMBOLVISITOR_H
11 
12 #include "llvm/DebugInfo/CodeView/CVRecord.h"
13 #include "llvm/Support/Error.h"
14 
15 namespace llvm {
16 namespace codeview {
17 class SymbolVisitorCallbacks;
18 
19 class CVSymbolVisitor {
20 public:
21   struct FilterOptions {
22     std::optional<uint32_t> SymbolOffset;
23     std::optional<uint32_t> ParentRecursiveDepth;
24     std::optional<uint32_t> ChildRecursiveDepth;
25   };
26 
27   CVSymbolVisitor(SymbolVisitorCallbacks &Callbacks);
28 
29   Error visitSymbolRecord(CVSymbol &Record);
30   Error visitSymbolRecord(CVSymbol &Record, uint32_t Offset);
31   Error visitSymbolStream(const CVSymbolArray &Symbols);
32   Error visitSymbolStream(const CVSymbolArray &Symbols, uint32_t InitialOffset);
33   Error visitSymbolStreamFiltered(const CVSymbolArray &Symbols,
34                                   const FilterOptions &Filter);
35 
36 private:
37   SymbolVisitorCallbacks &Callbacks;
38 };
39 
40 } // end namespace codeview
41 } // end namespace llvm
42 
43 #endif // LLVM_DEBUGINFO_CODEVIEW_CVSYMBOLVISITOR_H
44