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