A line table entry class. More...

#include "lldb/Symbol/LineEntry.h"

Public Member Functions
	LineEntry ()
	Default constructor.

void	Clear ()
	Clear the object's state.

bool	Dump (Stream s, Target target, bool show_file, Address::DumpStyle style, Address::DumpStyle fallback_style, bool show_range) const
	Dump a description of this object to a Stream.

bool	GetDescription (Stream s, lldb::DescriptionLevel level, CompileUnit cu, Target *target, bool show_address_only) const

bool	DumpStopContext (Stream *s, bool show_fullpaths) const
	Dumps information specific to a process that stops at this line entry to the supplied stream s.

bool	IsValid () const
	Check if a line entry object is valid.

AddressRange	GetSameLineContiguousAddressRange (bool include_inlined_functions) const
	Give the range for this LineEntry + any additional LineEntries for this same source line that are contiguous.

void	ApplyFileMappings (lldb::TargetSP target_sp)
	Apply file mappings from target.source-map to the LineEntry's file.

const FileSpec &	GetFile () const
	Helper to access the file.

Static Public Member Functions
static int	Compare (const LineEntry &lhs, const LineEntry &rhs)
	Compare two LineEntry objects.

Public Attributes
AddressRange	range
	The section offset address range for this line entry.

lldb::SupportFileSP	file_sp
	The source file, possibly mapped by the target.source-map setting.

lldb::SupportFileSP	original_file_sp
	The original source file, from debug info.

uint32_t	line = LLDB_INVALID_LINE_NUMBER
	The source line number, or LLDB_INVALID_LINE_NUMBER if there is no line number information.

uint16_t	column = 0
	The column number of the source line, or zero if there is no column information.

uint16_t	is_start_of_statement: 1
	Indicates this entry is the beginning of a statement.

uint16_t	is_start_of_basic_block: 1
	Indicates this entry is the beginning of a basic block.

uint16_t	is_prologue_end: 1
	Indicates this entry is one (of possibly many) where execution should be suspended for an entry breakpoint of a function.

uint16_t	is_epilogue_begin: 1
	Indicates this entry is one (of possibly many) where execution should be suspended for an exit breakpoint of a function.

uint16_t	is_terminal_entry: 1
	Indicates this entry is that of the first byte after the end of a sequence of target machine instructions.

Detailed Description

A line table entry class.

Definition at line 21 of file LineEntry.h.

Constructor & Destructor Documentation

◆ LineEntry()

LineEntry::LineEntry ( )

Default constructor.

Initialize all member variables to invalid values.

Definition at line 16 of file LineEntry.cpp.

Member Function Documentation

◆ ApplyFileMappings()

void LineEntry::ApplyFileMappings ( lldb::TargetSP target_sp )

Apply file mappings from target.source-map to the LineEntry's file.

Parameters

[in] target_sp Shared pointer to the target this LineEntry belongs to.

Definition at line 244 of file LineEntry.cpp.

References file_sp, and original_file_sp.

Referenced by lldb_private::StackFrameList::GetFramesUpTo(), and lldb_private::StackFrame::GetSymbolContext().

◆ Clear()

void LineEntry::Clear ( )

Clear the object's state.

Clears all member variables to invalid values.

Definition at line 22 of file LineEntry.cpp.

References lldb_private::AddressRange::Clear(), column, file_sp, is_epilogue_begin, is_prologue_end, is_start_of_basic_block, is_start_of_statement, is_terminal_entry, line, LLDB_INVALID_LINE_NUMBER, original_file_sp, and range.

Referenced by lldb_private::Address::CalculateSymbolContextLineEntry(), lldb_private::SymbolContext::Clear(), lldb_private::Variable::DumpDeclaration(), lldb_private::LineTable::GetLineEntryAtIndex(), and lldb::SBSymbolContext::SetLineEntry().

◆ Compare()

int LineEntry::Compare	(	const LineEntry &	lhs,
		const LineEntry &	rhs
	)

static

Compare two LineEntry objects.

Parameters

[in]	lhs	The Left Hand Side const LineEntry object reference.
[in]	rhs	The Right Hand Side const LineEntry object reference.

Returns: -1 if lhs < rhs 0 if lhs == rhs 1 if lhs > rhs

Definition at line 147 of file LineEntry.cpp.

References column, lldb_private::FileSpec::Compare(), lldb_private::Address::CompareFileAddress(), lldb_private::AddressRange::GetBaseAddress(), lldb_private::AddressRange::GetByteSize(), GetFile(), is_terminal_entry, line, and range.

Referenced by lldb_private::SymbolContext::GetAddressRangeFromHereToEndLine(), lldb::SBLineEntry::operator!=(), lldb_private::operator<(), lldb::SBLineEntry::operator==(), and lldb_private::operator==().

◆ Dump()

bool LineEntry::Dump	(	Stream *	s,
		Target *	target,
		bool	show_file,
		Address::DumpStyle	style,
		Address::DumpStyle	fallback_style,
		bool	show_range
	)		const

Dump a description of this object to a Stream.

Dump a description of the contents of this object to the supplied stream s.

Parameters

[in]	s	The stream to which to dump the object description.
[in]	show_file	If true, display the filename with the line entry which requires that the compile unit object comp_unit be a valid pointer.
[in]	style	The display style for the section offset address.

Returns: Returns true if the address was able to be displayed using style. File and load addresses may be unresolved and it may not be possible to display a valid address value. Returns false if the address was not able to be properly dumped.

See also: Address::DumpStyle

Definition at line 60 of file LineEntry.cpp.

References column, lldb_private::Address::Dump(), lldb_private::AddressRange::Dump(), lldb_private::AddressRange::GetBaseAddress(), GetFile(), is_epilogue_begin, is_prologue_end, is_start_of_basic_block, is_start_of_statement, is_terminal_entry, line, lldb_private::Stream::Printf(), and range.

Referenced by lldb_private::SymbolContext::Dump(), lldb_private::LineTable::Dump(), GetDescription(), and lldb_private::ThreadPlanStepRange::InRange().

◆ DumpStopContext()

bool LineEntry::DumpStopContext	(	Stream *	s,
		bool	show_fullpaths
	)		const

Dumps information specific to a process that stops at this line entry to the supplied stream s.

Parameters

[in] s The stream to which to dump the object description.

Returns: Returns true if the file and line were properly dumped, false otherwise.

Definition at line 39 of file LineEntry.cpp.

References lldb_private::Stream::AsRawOstream(), column, lldb_private::FileSpec::Dump(), lldb_private::ConstString::Dump(), file_sp, lldb_private::FileSpec::GetFilename(), line, lldb_private::Stream::Printf(), and lldb_private::Stream::PutChar().

Referenced by lldb_private::SymbolContext::DumpStopContext(), lldb_private::BreakpointLocation::GetDescription(), lldb_private::ThreadPlanStepInRange::GetDescription(), and lldb_private::ThreadPlanStepOverRange::GetDescription().

◆ GetDescription()

bool LineEntry::GetDescription	(	Stream *	s,
		lldb::DescriptionLevel	level,
		CompileUnit *	cu,
		Target *	target,
		bool	show_address_only
	)		const

◆ GetFile()

const FileSpec & lldb_private::LineEntry::GetFile ( ) const

inline

Helper to access the file.

Definition at line 134 of file LineEntry.h.

References file_sp.

Referenced by Compare(), CommandObjectSourceList::DisplayFunctionSource(), CommandObjectThreadJump::DoExecute(), Dump(), CommandObjectSourceInfo::DumpFileLinesInCompUnit(), CommandObjectSourceInfo::DumpLinesInSymbolContexts(), lldb_private::Disassembler::ElideMixedSourceAndDisassemblyLine(), FileLineAndColumnMatches(), lldb_private::BreakpointResolverFileLine::FilterContexts(), lldb_private::FormatEntity::Format(), CommandObjectBreakpointSet::GetDefaultFile(), lldb_private::SourceManager::GetDefaultFileAndLine(), lldb_private::Address::GetDescription(), GetDescription(), lldb_private::Function::GetEndLineSourceInfo(), lldb_private::Disassembler::GetFunctionDeclLineEntry(), lldb_private::Function::GetStartLineSourceInfo(), lldb_private::StackFrame::GetStatus(), lldb_private::Thread::GetStatus(), lldb_private::ClangExpressionSourceCode::GetText(), lldb_private::formatters::LibcxxFunctionSummaryProvider(), CommandObjectSourceList::SourceInfo::operator<(), lldb_private::Disassembler::PrintInstructions(), lldb_private::CompileUnit::ResolveSymbolContext(), lldb_private::StackFrameList::SetDefaultFileAndLineToSelectedFrame(), lldb_private::Thread::SetSelectedFrameByIndexNoisily(), and lldb::SBThread::StepOverUntil().

◆ GetSameLineContiguousAddressRange()

AddressRange LineEntry::GetSameLineContiguousAddressRange ( bool include_inlined_functions ) const

Give the range for this LineEntry + any additional LineEntries for this same source line that are contiguous.

A compiler may emit multiple line entries for a single source line, e.g. to indicate subexpressions at different columns. This method will get the AddressRange for all of the LineEntries for this source line that are contiguous. Line entries with a line number of 0 are treated specially - these are compiler-generated line table entries that the user did not write in their source code, and we want to skip past in the debugger. If this LineEntry is for line 32, and the following LineEntry is for line 0, we will extend the range to include the AddressRange of the line 0 LineEntry (and it will include the range of the following LineEntries that match either 32 or 0.)

When include_inlined_functions is true inlined functions with a call site at this LineEntry will also be included in the complete range.

If the initial LineEntry this method is called on is a line #0, only the range of continuous LineEntries with line #0 will be included in the complete range.

Parameters

[in] include_inlined_functions Whether to include inlined functions at the same line or not.