contrib/llvm/tools/lldb/include/lldb/API/SBSymbolContext.h

   1 //===-- SBSymbolContext.h ---------------------------------------*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9
  10 #ifndef LLDB_SBSymbolContext_h_
  11 #define LLDB_SBSymbolContext_h_
  12
  13 #include "lldb/API/SBBlock.h"
  14 #include "lldb/API/SBCompileUnit.h"
  15 #include "lldb/API/SBDefines.h"
  16 #include "lldb/API/SBFunction.h"
  17 #include "lldb/API/SBLineEntry.h"
  18 #include "lldb/API/SBModule.h"
  19 #include "lldb/API/SBSymbol.h"
  20
  21 namespace lldb {
  22
  23 class LLDB_API SBSymbolContext {
  24 public:
  25   SBSymbolContext();
  26
  27   SBSymbolContext(const lldb::SBSymbolContext &rhs);
  28
  29   ~SBSymbolContext();
  30
  31   bool IsValid() const;
  32
  33   const lldb::SBSymbolContext &operator=(const lldb::SBSymbolContext &rhs);
  34
  35   lldb::SBModule GetModule();
  36   lldb::SBCompileUnit GetCompileUnit();
  37   lldb::SBFunction GetFunction();
  38   lldb::SBBlock GetBlock();
  39   lldb::SBLineEntry GetLineEntry();
  40   lldb::SBSymbol GetSymbol();
  41
  42   void SetModule(lldb::SBModule module);
  43   void SetCompileUnit(lldb::SBCompileUnit compile_unit);
  44   void SetFunction(lldb::SBFunction function);
  45   void SetBlock(lldb::SBBlock block);
  46   void SetLineEntry(lldb::SBLineEntry line_entry);
  47   void SetSymbol(lldb::SBSymbol symbol);
  48
  49   SBSymbolContext GetParentOfInlinedScope(const SBAddress &curr_frame_pc,
  50                                           SBAddress &parent_frame_addr) const;
  51
  52   bool GetDescription(lldb::SBStream &description);
  53
  54 protected:
  55   friend class SBAddress;
  56   friend class SBFrame;
  57   friend class SBModule;
  58   friend class SBThread;
  59   friend class SBTarget;
  60   friend class SBSymbolContextList;
  61
  62   lldb_private::SymbolContext *operator->() const;
  63
  64   lldb_private::SymbolContext &operator*();
  65
  66   lldb_private::SymbolContext &ref();
  67
  68   const lldb_private::SymbolContext &operator*() const;
  69
  70   lldb_private::SymbolContext *get() const;
  71
  72   SBSymbolContext(const lldb_private::SymbolContext *sc_ptr);
  73
  74   void SetSymbolContext(const lldb_private::SymbolContext *sc_ptr);
  75
  76 private:
  77   std::unique_ptr<lldb_private::SymbolContext> m_opaque_ap;
  78 };
  79
  80 } // namespace lldb
  81
  82 #endif // LLDB_SBSymbolContext_h_