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
12#include "lldb/DataFormatters/FormattersHelpers.h"
13#include "lldb/Core/Module.h"
14#include "lldb/Target/StackFrame.h"
15#include "lldb/Target/Target.h"
16#include "lldb/Target/Thread.h"
17#include "lldb/Utility/ConstString.h"
18#include "lldb/Utility/RegularExpression.h"
19
20using namespace lldb;
21using namespace lldb_private;
22using namespace lldb_private::formatters;
23
24void lldb_private::formatters::AddFormat(
25    TypeCategoryImpl::SharedPointer category_sp, lldb::Format format,
26    ConstString type_name, TypeFormatImpl::Flags flags, bool regex) {
27  lldb::TypeFormatImplSP format_sp(new TypeFormatImpl_Format(format, flags));
28
29  FormatterMatchType match_type =
30      regex ? eFormatterMatchRegex : eFormatterMatchExact;
31  category_sp->AddTypeFormat(type_name.GetStringRef(), match_type, format_sp);
32}
33
34void lldb_private::formatters::AddSummary(
35    TypeCategoryImpl::SharedPointer category_sp, TypeSummaryImplSP summary_sp,
36    ConstString type_name, bool regex) {
37  FormatterMatchType match_type =
38      regex ? eFormatterMatchRegex : eFormatterMatchExact;
39  category_sp->AddTypeSummary(type_name.GetStringRef(), match_type, summary_sp);
40}
41
42void lldb_private::formatters::AddStringSummary(
43    TypeCategoryImpl::SharedPointer category_sp, const char *string,
44    ConstString type_name, TypeSummaryImpl::Flags flags, bool regex) {
45  lldb::TypeSummaryImplSP summary_sp(new StringSummaryFormat(flags, string));
46
47  FormatterMatchType match_type =
48      regex ? eFormatterMatchRegex : eFormatterMatchExact;
49  category_sp->AddTypeSummary(type_name.GetStringRef(), match_type, summary_sp);
50}
51
52void lldb_private::formatters::AddOneLineSummary(
53    TypeCategoryImpl::SharedPointer category_sp, ConstString 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 =
59      regex ? eFormatterMatchRegex : eFormatterMatchExact;
60  category_sp->AddTypeSummary(type_name.GetStringRef(), match_type, summary_sp);
61}
62
63void lldb_private::formatters::AddCXXSummary(
64    TypeCategoryImpl::SharedPointer category_sp,
65    CXXFunctionSummaryFormat::Callback funct, const char *description,
66    ConstString type_name, TypeSummaryImpl::Flags flags, bool regex) {
67  lldb::TypeSummaryImplSP summary_sp(
68      new CXXFunctionSummaryFormat(flags, funct, description));
69
70  FormatterMatchType match_type =
71      regex ? eFormatterMatchRegex : eFormatterMatchExact;
72  category_sp->AddTypeSummary(type_name.GetStringRef(), match_type, summary_sp);
73}
74
75void lldb_private::formatters::AddCXXSynthetic(
76    TypeCategoryImpl::SharedPointer category_sp,
77    CXXSyntheticChildren::CreateFrontEndCallback generator,
78    const char *description, ConstString type_name,
79    ScriptedSyntheticChildren::Flags flags, bool regex) {
80  lldb::SyntheticChildrenSP synth_sp(
81      new CXXSyntheticChildren(flags, description, generator));
82  FormatterMatchType match_type =
83      regex ? eFormatterMatchRegex : eFormatterMatchExact;
84  category_sp->AddTypeSynthetic(type_name.GetStringRef(), match_type, synth_sp);
85}
86
87void lldb_private::formatters::AddFilter(
88    TypeCategoryImpl::SharedPointer category_sp,
89    std::vector<std::string> children, const char *description,
90    ConstString type_name, ScriptedSyntheticChildren::Flags flags, bool regex) {
91  TypeFilterImplSP filter_sp(new TypeFilterImpl(flags));
92  for (auto child : children)
93    filter_sp->AddExpressionPath(child);
94  FormatterMatchType match_type =
95      regex ? eFormatterMatchRegex : eFormatterMatchExact;
96  category_sp->AddTypeFilter(type_name.GetStringRef(), match_type, filter_sp);
97}
98
99size_t lldb_private::formatters::ExtractIndexFromString(const char *item_name) {
100  if (!item_name || !*item_name)
101    return UINT32_MAX;
102  if (*item_name != '[')
103    return UINT32_MAX;
104  item_name++;
105  char *endptr = nullptr;
106  unsigned long int idx = ::strtoul(item_name, &endptr, 0);
107  if (idx == 0 && endptr == item_name)
108    return UINT32_MAX;
109  if (idx == ULONG_MAX)
110    return UINT32_MAX;
111  return idx;
112}
113
114Address
115lldb_private::formatters::GetArrayAddressOrPointerValue(ValueObject &valobj) {
116  lldb::addr_t data_addr = LLDB_INVALID_ADDRESS;
117  AddressType type;
118
119  if (valobj.IsPointerType())
120    data_addr = valobj.GetPointerValue(&type);
121  else if (valobj.IsArrayType())
122    data_addr = valobj.GetAddressOf(/*scalar_is_load_address=*/true, &type);
123  if (data_addr != LLDB_INVALID_ADDRESS && type == eAddressTypeFile)
124    return Address(data_addr, valobj.GetModule()->GetSectionList());
125
126  return data_addr;
127}
128
129lldb::ValueObjectSP
130lldb_private::formatters::GetValueOfLibCXXCompressedPair(ValueObject &pair) {
131  ValueObjectSP value =
132      pair.GetChildMemberWithName(ConstString("__value_"), true);
133  if (!value) {
134    // pre-r300140 member name
135    value = pair.GetChildMemberWithName(ConstString("__first_"), true);
136  }
137  return value;
138}
139