blob: 0c05ef44e31c84b9e6a46646e55d1416901f8110 [file] [log] [blame]
//===-- SBCompileUnit.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_SBCOMPILEUNIT_H
#define LLDB_API_SBCOMPILEUNIT_H
#include "lldb/API/SBDefines.h"
#include "lldb/API/SBFileSpec.h"
namespace lldb {
class LLDB_API SBCompileUnit {
public:
SBCompileUnit();
SBCompileUnit(const lldb::SBCompileUnit &rhs);
~SBCompileUnit();
const lldb::SBCompileUnit &operator=(const lldb::SBCompileUnit &rhs);
explicit operator bool() const;
bool IsValid() const;
lldb::SBFileSpec GetFileSpec() const;
uint32_t GetNumLineEntries() const;
lldb::SBLineEntry GetLineEntryAtIndex(uint32_t idx) const;
uint32_t FindLineEntryIndex(uint32_t start_idx, uint32_t line,
lldb::SBFileSpec *inline_file_spec) const;
uint32_t FindLineEntryIndex(uint32_t start_idx, uint32_t line,
lldb::SBFileSpec *inline_file_spec,
bool exact) const;
SBFileSpec GetSupportFileAtIndex(uint32_t idx) const;
uint32_t GetNumSupportFiles() const;
uint32_t FindSupportFileIndex(uint32_t start_idx, const SBFileSpec &sb_file,
bool full);
/// Get all types matching \a type_mask from debug info in this
/// compile unit.
///
/// \param[in] type_mask
/// A bitfield that consists of one or more bits logically OR'ed
/// together from the lldb::TypeClass enumeration. This allows
/// you to request only structure types, or only class, struct
/// and union types. Passing in lldb::eTypeClassAny will return
/// all types found in the debug information for this compile
/// unit.
///
/// \return
/// A list of types in this compile unit that match \a type_mask
lldb::SBTypeList GetTypes(uint32_t type_mask = lldb::eTypeClassAny);
lldb::LanguageType GetLanguage();
bool operator==(const lldb::SBCompileUnit &rhs) const;
bool operator!=(const lldb::SBCompileUnit &rhs) const;
bool GetDescription(lldb::SBStream &description);
private:
friend class SBAddress;
friend class SBFrame;
friend class SBSymbolContext;
friend class SBModule;
SBCompileUnit(lldb_private::CompileUnit *lldb_object_ptr);
const lldb_private::CompileUnit *operator->() const;
const lldb_private::CompileUnit &operator*() const;
lldb_private::CompileUnit *get();
void reset(lldb_private::CompileUnit *lldb_object_ptr);
lldb_private::CompileUnit *m_opaque_ptr;
};
} // namespace lldb
#endif // LLDB_API_SBCOMPILEUNIT_H