SBFunction.h

Go to the documentation of this file.

//===-- SBFunction.h --------------------------------------------*- C++ -*-===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
 
#ifndef LLDB_API_SBFUNCTION_H
#define LLDB_API_SBFUNCTION_H
 
#include "lldb/API/SBAddress.h"
#include "lldb/API/SBAddressRangeList.h"
#include "lldb/API/SBDefines.h"
#include "lldb/API/SBInstructionList.h"
 
namespace lldb {
 
class LLDB_API SBFunction {
public:
  SBFunction();
 
  SBFunction(const lldb::SBFunction &rhs);
 
  const lldb::SBFunction &operator=(const lldb::SBFunction &rhs);
 
  ~SBFunction();
 
  explicit operator bool() const;
 
  bool IsValid() const;
 
  const char *GetName() const;
 
  const char *GetDisplayName() const;
 
  const char *GetMangledName() const;
 
  const char *GetBaseName() const;
 
  lldb::SBInstructionList GetInstructions(lldb::SBTarget target);
 
  lldb::SBInstructionList GetInstructions(lldb::SBTarget target,
                                          const char *flavor);
 
  lldb::SBAddress GetStartAddress();
 
  LLDB_DEPRECATED_FIXME("Not compatible with discontinuous functions.",
                        "GetRanges()")
  lldb::SBAddress GetEndAddress();
 
  lldb::SBAddressRangeList GetRanges();
 
  const char *GetArgumentName(uint32_t arg_idx);
 
  uint32_t GetPrologueByteSize();
 
  lldb::SBType GetType();
 
  lldb::SBBlock GetBlock();
 
  lldb::LanguageType GetLanguage();
 
  bool GetIsOptimized();
 
  bool operator==(const lldb::SBFunction &rhs) const;
 
  bool operator!=(const lldb::SBFunction &rhs) const;
 
  bool GetDescription(lldb::SBStream &description);
 
protected:
  lldb_private::Function *get();
 
  void reset(lldb_private::Function *lldb_object_ptr);
 
private:
  friend class SBAddress;
  friend class SBFrame;
  friend class SBSymbolContext;
 
  SBFunction(lldb_private::Function *lldb_object_ptr);
 
  lldb_private::Function *m_opaque_ptr = nullptr;
};
 
} // namespace lldb
 
#endif // LLDB_API_SBFUNCTION_H