LLDB mainline
FormattersHelpers.cpp
Go to the documentation of this file.
1//===-- FormattersHelpers.cpp ---------------------------------------------===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8
9
10
11
13#include "lldb/Core/Module.h"
15#include "lldb/Target/Target.h"
16#include "lldb/Target/Thread.h"
19
20using namespace lldb;
21using namespace lldb_private;
22using namespace lldb_private::formatters;
23
26 llvm::StringRef type_name, TypeFormatImpl::Flags flags, bool regex) {
27 lldb::TypeFormatImplSP format_sp(new TypeFormatImpl_Format(format, flags));
28
29 FormatterMatchType match_type =
31 category_sp->AddTypeFormat(type_name, match_type, format_sp);
32}
33
36 llvm::StringRef type_name, bool regex) {
37 FormatterMatchType match_type =
39 category_sp->AddTypeSummary(type_name, match_type, summary_sp);
40}
41
43 TypeCategoryImpl::SharedPointer category_sp, const char *string,
44 llvm::StringRef type_name, TypeSummaryImpl::Flags flags, bool regex) {
45 lldb::TypeSummaryImplSP summary_sp(new StringSummaryFormat(flags, string));
46
47 FormatterMatchType match_type =
49 category_sp->AddTypeSummary(type_name, match_type, summary_sp);
50}
51
53 TypeCategoryImpl::SharedPointer category_sp, llvm::StringRef type_name,
54 TypeSummaryImpl::Flags flags, bool regex) {
55 flags.SetShowMembersOneLiner(true);
56 lldb::TypeSummaryImplSP summary_sp(new StringSummaryFormat(flags, ""));
57
58 FormatterMatchType match_type =
60 category_sp->AddTypeSummary(type_name, match_type, summary_sp);
61}
62
65 CXXFunctionSummaryFormat::Callback funct, const char *description,
66 llvm::StringRef type_name, TypeSummaryImpl::Flags flags, bool regex) {
67 lldb::TypeSummaryImplSP summary_sp(
68 new CXXFunctionSummaryFormat(flags, funct, description));
69
70 FormatterMatchType match_type =
72 category_sp->AddTypeSummary(type_name, match_type, summary_sp);
73}
74
78 const char *description, llvm::StringRef type_name,
79 ScriptedSyntheticChildren::Flags flags, bool regex) {
81 new CXXSyntheticChildren(flags, description, generator));
82 FormatterMatchType match_type =
84 category_sp->AddTypeSynthetic(type_name, match_type, synth_sp);
85}
86
89 std::vector<std::string> children, const char *description,
90 llvm::StringRef type_name, ScriptedSyntheticChildren::Flags flags,
91 bool regex) {
92 TypeFilterImplSP filter_sp(new TypeFilterImpl(flags));
93 for (auto child : children)
94 filter_sp->AddExpressionPath(child);
95 FormatterMatchType match_type =
97 category_sp->AddTypeFilter(type_name, match_type, filter_sp);
98}
99
101 if (!item_name || !*item_name)
102 return UINT32_MAX;
103 if (*item_name != '[')
104 return UINT32_MAX;
105 item_name++;
106 char *endptr = nullptr;
107 unsigned long int idx = ::strtoul(item_name, &endptr, 0);
108 if (idx == 0 && endptr == item_name)
109 return UINT32_MAX;
110 if (idx == ULONG_MAX)
111 return UINT32_MAX;
112 return idx;
113}
114
118 AddressType type;
119
120 if (valobj.IsPointerType())
121 data_addr = valobj.GetPointerValue(&type);
122 else if (valobj.IsArrayType())
123 data_addr = valobj.GetAddressOf(/*scalar_is_load_address=*/true, &type);
124 if (data_addr != LLDB_INVALID_ADDRESS && type == eAddressTypeFile)
125 return Address(data_addr, valobj.GetModule()->GetSectionList());
126
127 return data_addr;
128}
A section + offset based address class.
Definition: Address.h:62
std::function< SyntheticChildrenFrontEnd *(CXXSyntheticChildren *, lldb::ValueObjectSP)> CreateFrontEndCallback
std::shared_ptr< TypeCategoryImpl > SharedPointer
Definition: TypeCategory.h:357
Flags & SetShowMembersOneLiner(bool value=true)
Definition: TypeSummary.h:160
lldb::addr_t GetPointerValue(AddressType *address_type=nullptr)
virtual lldb::ModuleSP GetModule()
Return the module associated with this value object in case the value is from an executable file and ...
virtual lldb::addr_t GetAddressOf(bool scalar_is_load_address=true, AddressType *address_type=nullptr)
#define LLDB_INVALID_ADDRESS
Definition: lldb-defines.h:82
#define UINT32_MAX
Definition: lldb-defines.h:19
void AddOneLineSummary(TypeCategoryImpl::SharedPointer category_sp, llvm::StringRef type_name, TypeSummaryImpl::Flags flags, bool regex=false)
void AddCXXSummary(TypeCategoryImpl::SharedPointer category_sp, CXXFunctionSummaryFormat::Callback funct, const char *description, llvm::StringRef type_name, TypeSummaryImpl::Flags flags, bool regex=false)
Add a summary that is implemented by a C++ callback.
size_t ExtractIndexFromString(const char *item_name)
void AddStringSummary(TypeCategoryImpl::SharedPointer category_sp, const char *string, llvm::StringRef type_name, TypeSummaryImpl::Flags flags, bool regex=false)
void AddCXXSynthetic(TypeCategoryImpl::SharedPointer category_sp, CXXSyntheticChildren::CreateFrontEndCallback generator, const char *description, llvm::StringRef type_name, ScriptedSyntheticChildren::Flags flags, bool regex=false)
Add a synthetic that is implemented by a C++ callback.
void AddFilter(TypeCategoryImpl::SharedPointer category_sp, std::vector< std::string > children, const char *description, llvm::StringRef type_name, ScriptedSyntheticChildren::Flags flags, bool regex=false)
void AddFormat(TypeCategoryImpl::SharedPointer category_sp, lldb::Format format, llvm::StringRef type_name, TypeFormatImpl::Flags flags, bool regex=false)
Address GetArrayAddressOrPointerValue(ValueObject &valobj)
void AddSummary(TypeCategoryImpl::SharedPointer category_sp, lldb::TypeSummaryImplSP summary_sp, llvm::StringRef type_name, bool regex=false)
A class that represents a running process on the host machine.
@ eAddressTypeFile
Address is an address as found in an object or symbol file.
Definition: SBAddress.h:15
std::shared_ptr< lldb_private::TypeSummaryImpl > TypeSummaryImplSP
Definition: lldb-forward.h:466
std::shared_ptr< lldb_private::TypeFormatImpl > TypeFormatImplSP
Definition: lldb-forward.h:463
Format
Display format definitions.
FormatterMatchType
Type of match to be performed when looking for a formatter for a data type.
@ eFormatterMatchExact
@ eFormatterMatchRegex
std::shared_ptr< lldb_private::SyntheticChildren > SyntheticChildrenSP
Definition: lldb-forward.h:436
std::shared_ptr< lldb_private::TypeFilterImpl > TypeFilterImplSP
Definition: lldb-forward.h:459
uint64_t addr_t
Definition: lldb-types.h:80
std::function< bool(ValueObject &, Stream &, const TypeSummaryOptions &)> Callback
Definition: TypeSummary.h:311