xref: /freebsd/contrib/llvm-project/lldb/source/API/SBLineEntry.cpp (revision 0fca6ea1d4eea4c934cfff25ac9ee8ad6fe95583)
15ffd83dbSDimitry Andric //===-- SBLineEntry.cpp ---------------------------------------------------===//
20b57cec5SDimitry Andric //
30b57cec5SDimitry Andric // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
40b57cec5SDimitry Andric // See https://llvm.org/LICENSE.txt for license information.
50b57cec5SDimitry Andric // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
60b57cec5SDimitry Andric //
70b57cec5SDimitry Andric //===----------------------------------------------------------------------===//
80b57cec5SDimitry Andric 
90b57cec5SDimitry Andric #include "lldb/API/SBLineEntry.h"
100b57cec5SDimitry Andric #include "Utils.h"
110b57cec5SDimitry Andric #include "lldb/API/SBStream.h"
120b57cec5SDimitry Andric #include "lldb/Host/PosixApi.h"
130b57cec5SDimitry Andric #include "lldb/Symbol/LineEntry.h"
1404eeddc0SDimitry Andric #include "lldb/Utility/Instrumentation.h"
150b57cec5SDimitry Andric #include "lldb/Utility/StreamString.h"
160b57cec5SDimitry Andric 
17fe6060f1SDimitry Andric #include <climits>
180b57cec5SDimitry Andric 
190b57cec5SDimitry Andric using namespace lldb;
200b57cec5SDimitry Andric using namespace lldb_private;
210b57cec5SDimitry Andric 
SBLineEntry()2204eeddc0SDimitry Andric SBLineEntry::SBLineEntry() { LLDB_INSTRUMENT_VA(this); }
230b57cec5SDimitry Andric 
SBLineEntry(const SBLineEntry & rhs)2404eeddc0SDimitry Andric SBLineEntry::SBLineEntry(const SBLineEntry &rhs) {
2504eeddc0SDimitry Andric   LLDB_INSTRUMENT_VA(this, rhs);
260b57cec5SDimitry Andric 
270b57cec5SDimitry Andric   m_opaque_up = clone(rhs.m_opaque_up);
280b57cec5SDimitry Andric }
290b57cec5SDimitry Andric 
SBLineEntry(const lldb_private::LineEntry * lldb_object_ptr)3004eeddc0SDimitry Andric SBLineEntry::SBLineEntry(const lldb_private::LineEntry *lldb_object_ptr) {
310b57cec5SDimitry Andric   if (lldb_object_ptr)
329dba64beSDimitry Andric     m_opaque_up = std::make_unique<LineEntry>(*lldb_object_ptr);
330b57cec5SDimitry Andric }
340b57cec5SDimitry Andric 
operator =(const SBLineEntry & rhs)350b57cec5SDimitry Andric const SBLineEntry &SBLineEntry::operator=(const SBLineEntry &rhs) {
3604eeddc0SDimitry Andric   LLDB_INSTRUMENT_VA(this, rhs);
370b57cec5SDimitry Andric 
380b57cec5SDimitry Andric   if (this != &rhs)
390b57cec5SDimitry Andric     m_opaque_up = clone(rhs.m_opaque_up);
4004eeddc0SDimitry Andric   return *this;
410b57cec5SDimitry Andric }
420b57cec5SDimitry Andric 
SetLineEntry(const lldb_private::LineEntry & lldb_object_ref)430b57cec5SDimitry Andric void SBLineEntry::SetLineEntry(const lldb_private::LineEntry &lldb_object_ref) {
449dba64beSDimitry Andric   m_opaque_up = std::make_unique<LineEntry>(lldb_object_ref);
450b57cec5SDimitry Andric }
460b57cec5SDimitry Andric 
475ffd83dbSDimitry Andric SBLineEntry::~SBLineEntry() = default;
480b57cec5SDimitry Andric 
GetStartAddress() const490b57cec5SDimitry Andric SBAddress SBLineEntry::GetStartAddress() const {
5004eeddc0SDimitry Andric   LLDB_INSTRUMENT_VA(this);
510b57cec5SDimitry Andric 
520b57cec5SDimitry Andric   SBAddress sb_address;
530b57cec5SDimitry Andric   if (m_opaque_up)
54e8d8bef9SDimitry Andric     sb_address.SetAddress(m_opaque_up->range.GetBaseAddress());
550b57cec5SDimitry Andric 
5604eeddc0SDimitry Andric   return sb_address;
570b57cec5SDimitry Andric }
580b57cec5SDimitry Andric 
GetEndAddress() const590b57cec5SDimitry Andric SBAddress SBLineEntry::GetEndAddress() const {
6004eeddc0SDimitry Andric   LLDB_INSTRUMENT_VA(this);
610b57cec5SDimitry Andric 
620b57cec5SDimitry Andric   SBAddress sb_address;
630b57cec5SDimitry Andric   if (m_opaque_up) {
64e8d8bef9SDimitry Andric     sb_address.SetAddress(m_opaque_up->range.GetBaseAddress());
650b57cec5SDimitry Andric     sb_address.OffsetAddress(m_opaque_up->range.GetByteSize());
660b57cec5SDimitry Andric   }
6704eeddc0SDimitry Andric   return sb_address;
680b57cec5SDimitry Andric }
690b57cec5SDimitry Andric 
GetSameLineContiguousAddressRangeEnd(bool include_inlined_functions) const70*0fca6ea1SDimitry Andric SBAddress SBLineEntry::GetSameLineContiguousAddressRangeEnd(
71*0fca6ea1SDimitry Andric     bool include_inlined_functions) const {
72*0fca6ea1SDimitry Andric   LLDB_INSTRUMENT_VA(this);
73*0fca6ea1SDimitry Andric 
74*0fca6ea1SDimitry Andric   SBAddress sb_address;
75*0fca6ea1SDimitry Andric   if (m_opaque_up) {
76*0fca6ea1SDimitry Andric     AddressRange line_range = m_opaque_up->GetSameLineContiguousAddressRange(
77*0fca6ea1SDimitry Andric         include_inlined_functions);
78*0fca6ea1SDimitry Andric 
79*0fca6ea1SDimitry Andric     sb_address.SetAddress(line_range.GetBaseAddress());
80*0fca6ea1SDimitry Andric     sb_address.OffsetAddress(line_range.GetByteSize());
81*0fca6ea1SDimitry Andric   }
82*0fca6ea1SDimitry Andric   return sb_address;
83*0fca6ea1SDimitry Andric }
84*0fca6ea1SDimitry Andric 
IsValid() const850b57cec5SDimitry Andric bool SBLineEntry::IsValid() const {
8604eeddc0SDimitry Andric   LLDB_INSTRUMENT_VA(this);
870b57cec5SDimitry Andric   return this->operator bool();
880b57cec5SDimitry Andric }
operator bool() const890b57cec5SDimitry Andric SBLineEntry::operator bool() const {
9004eeddc0SDimitry Andric   LLDB_INSTRUMENT_VA(this);
910b57cec5SDimitry Andric 
920b57cec5SDimitry Andric   return m_opaque_up.get() && m_opaque_up->IsValid();
930b57cec5SDimitry Andric }
940b57cec5SDimitry Andric 
GetFileSpec() const950b57cec5SDimitry Andric SBFileSpec SBLineEntry::GetFileSpec() const {
9604eeddc0SDimitry Andric   LLDB_INSTRUMENT_VA(this);
970b57cec5SDimitry Andric 
980b57cec5SDimitry Andric   SBFileSpec sb_file_spec;
99*0fca6ea1SDimitry Andric   if (m_opaque_up.get() && m_opaque_up->GetFile())
100*0fca6ea1SDimitry Andric     sb_file_spec.SetFileSpec(m_opaque_up->GetFile());
1010b57cec5SDimitry Andric 
10204eeddc0SDimitry Andric   return sb_file_spec;
1030b57cec5SDimitry Andric }
1040b57cec5SDimitry Andric 
GetLine() const1050b57cec5SDimitry Andric uint32_t SBLineEntry::GetLine() const {
10604eeddc0SDimitry Andric   LLDB_INSTRUMENT_VA(this);
1070b57cec5SDimitry Andric 
1080b57cec5SDimitry Andric   uint32_t line = 0;
1090b57cec5SDimitry Andric   if (m_opaque_up)
1100b57cec5SDimitry Andric     line = m_opaque_up->line;
1110b57cec5SDimitry Andric 
1120b57cec5SDimitry Andric   return line;
1130b57cec5SDimitry Andric }
1140b57cec5SDimitry Andric 
GetColumn() const1150b57cec5SDimitry Andric uint32_t SBLineEntry::GetColumn() const {
11604eeddc0SDimitry Andric   LLDB_INSTRUMENT_VA(this);
1170b57cec5SDimitry Andric 
1180b57cec5SDimitry Andric   if (m_opaque_up)
1190b57cec5SDimitry Andric     return m_opaque_up->column;
1200b57cec5SDimitry Andric   return 0;
1210b57cec5SDimitry Andric }
1220b57cec5SDimitry Andric 
SetFileSpec(lldb::SBFileSpec filespec)1230b57cec5SDimitry Andric void SBLineEntry::SetFileSpec(lldb::SBFileSpec filespec) {
12404eeddc0SDimitry Andric   LLDB_INSTRUMENT_VA(this, filespec);
1250b57cec5SDimitry Andric 
1260b57cec5SDimitry Andric   if (filespec.IsValid())
127*0fca6ea1SDimitry Andric     ref().file_sp = std::make_shared<SupportFile>(filespec.ref());
1280b57cec5SDimitry Andric   else
129*0fca6ea1SDimitry Andric     ref().file_sp = std::make_shared<SupportFile>();
1300b57cec5SDimitry Andric }
SetLine(uint32_t line)1310b57cec5SDimitry Andric void SBLineEntry::SetLine(uint32_t line) {
13204eeddc0SDimitry Andric   LLDB_INSTRUMENT_VA(this, line);
1330b57cec5SDimitry Andric 
1340b57cec5SDimitry Andric   ref().line = line;
1350b57cec5SDimitry Andric }
1360b57cec5SDimitry Andric 
SetColumn(uint32_t column)1370b57cec5SDimitry Andric void SBLineEntry::SetColumn(uint32_t column) {
13804eeddc0SDimitry Andric   LLDB_INSTRUMENT_VA(this, column);
1390b57cec5SDimitry Andric 
1400b57cec5SDimitry Andric   ref().line = column;
1410b57cec5SDimitry Andric }
1420b57cec5SDimitry Andric 
operator ==(const SBLineEntry & rhs) const1430b57cec5SDimitry Andric bool SBLineEntry::operator==(const SBLineEntry &rhs) const {
14404eeddc0SDimitry Andric   LLDB_INSTRUMENT_VA(this, rhs);
1450b57cec5SDimitry Andric 
1460b57cec5SDimitry Andric   lldb_private::LineEntry *lhs_ptr = m_opaque_up.get();
1470b57cec5SDimitry Andric   lldb_private::LineEntry *rhs_ptr = rhs.m_opaque_up.get();
1480b57cec5SDimitry Andric 
1490b57cec5SDimitry Andric   if (lhs_ptr && rhs_ptr)
1500b57cec5SDimitry Andric     return lldb_private::LineEntry::Compare(*lhs_ptr, *rhs_ptr) == 0;
1510b57cec5SDimitry Andric 
1520b57cec5SDimitry Andric   return lhs_ptr == rhs_ptr;
1530b57cec5SDimitry Andric }
1540b57cec5SDimitry Andric 
operator !=(const SBLineEntry & rhs) const1550b57cec5SDimitry Andric bool SBLineEntry::operator!=(const SBLineEntry &rhs) const {
15604eeddc0SDimitry Andric   LLDB_INSTRUMENT_VA(this, rhs);
1570b57cec5SDimitry Andric 
1580b57cec5SDimitry Andric   lldb_private::LineEntry *lhs_ptr = m_opaque_up.get();
1590b57cec5SDimitry Andric   lldb_private::LineEntry *rhs_ptr = rhs.m_opaque_up.get();
1600b57cec5SDimitry Andric 
1610b57cec5SDimitry Andric   if (lhs_ptr && rhs_ptr)
1620b57cec5SDimitry Andric     return lldb_private::LineEntry::Compare(*lhs_ptr, *rhs_ptr) != 0;
1630b57cec5SDimitry Andric 
1640b57cec5SDimitry Andric   return lhs_ptr != rhs_ptr;
1650b57cec5SDimitry Andric }
1660b57cec5SDimitry Andric 
operator ->() const1670b57cec5SDimitry Andric const lldb_private::LineEntry *SBLineEntry::operator->() const {
1680b57cec5SDimitry Andric   return m_opaque_up.get();
1690b57cec5SDimitry Andric }
1700b57cec5SDimitry Andric 
ref()1710b57cec5SDimitry Andric lldb_private::LineEntry &SBLineEntry::ref() {
1720b57cec5SDimitry Andric   if (m_opaque_up == nullptr)
1735ffd83dbSDimitry Andric     m_opaque_up = std::make_unique<lldb_private::LineEntry>();
1740b57cec5SDimitry Andric   return *m_opaque_up;
1750b57cec5SDimitry Andric }
1760b57cec5SDimitry Andric 
ref() const1770b57cec5SDimitry Andric const lldb_private::LineEntry &SBLineEntry::ref() const { return *m_opaque_up; }
1780b57cec5SDimitry Andric 
GetDescription(SBStream & description)1790b57cec5SDimitry Andric bool SBLineEntry::GetDescription(SBStream &description) {
18004eeddc0SDimitry Andric   LLDB_INSTRUMENT_VA(this, description);
1810b57cec5SDimitry Andric 
1820b57cec5SDimitry Andric   Stream &strm = description.ref();
1830b57cec5SDimitry Andric 
1840b57cec5SDimitry Andric   if (m_opaque_up) {
1850b57cec5SDimitry Andric     char file_path[PATH_MAX * 2];
186*0fca6ea1SDimitry Andric     m_opaque_up->GetFile().GetPath(file_path, sizeof(file_path));
1870b57cec5SDimitry Andric     strm.Printf("%s:%u", file_path, GetLine());
1880b57cec5SDimitry Andric     if (GetColumn() > 0)
1890b57cec5SDimitry Andric       strm.Printf(":%u", GetColumn());
1900b57cec5SDimitry Andric   } else
1910b57cec5SDimitry Andric     strm.PutCString("No value");
1920b57cec5SDimitry Andric 
1930b57cec5SDimitry Andric   return true;
1940b57cec5SDimitry Andric }
1950b57cec5SDimitry Andric 
get()1960b57cec5SDimitry Andric lldb_private::LineEntry *SBLineEntry::get() { return m_opaque_up.get(); }
197