1*dda28197Spatrick //===-- LanguageCategory.cpp ----------------------------------------------===//
2061da546Spatrick //
3061da546Spatrick // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4061da546Spatrick // See https://llvm.org/LICENSE.txt for license information.
5061da546Spatrick // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6061da546Spatrick //
7061da546Spatrick //===----------------------------------------------------------------------===//
8061da546Spatrick
9061da546Spatrick #include "lldb/DataFormatters/LanguageCategory.h"
10061da546Spatrick
11061da546Spatrick #include "lldb/DataFormatters/FormatManager.h"
12061da546Spatrick #include "lldb/DataFormatters/TypeCategory.h"
13061da546Spatrick #include "lldb/DataFormatters/TypeFormat.h"
14061da546Spatrick #include "lldb/DataFormatters/TypeSummary.h"
15061da546Spatrick #include "lldb/DataFormatters/TypeSynthetic.h"
16061da546Spatrick #include "lldb/Target/Language.h"
17061da546Spatrick
18061da546Spatrick using namespace lldb;
19061da546Spatrick using namespace lldb_private;
20061da546Spatrick
LanguageCategory(lldb::LanguageType lang_type)21061da546Spatrick LanguageCategory::LanguageCategory(lldb::LanguageType lang_type)
22061da546Spatrick : m_category_sp(), m_hardcoded_formats(), m_hardcoded_summaries(),
23061da546Spatrick m_hardcoded_synthetics(), m_format_cache(), m_enabled(false) {
24061da546Spatrick if (Language *language_plugin = Language::FindPlugin(lang_type)) {
25061da546Spatrick m_category_sp = language_plugin->GetFormatters();
26061da546Spatrick m_hardcoded_formats = language_plugin->GetHardcodedFormats();
27061da546Spatrick m_hardcoded_summaries = language_plugin->GetHardcodedSummaries();
28061da546Spatrick m_hardcoded_synthetics = language_plugin->GetHardcodedSynthetics();
29061da546Spatrick }
30061da546Spatrick Enable();
31061da546Spatrick }
32061da546Spatrick
33061da546Spatrick template<typename ImplSP>
Get(FormattersMatchData & match_data,ImplSP & retval_sp)34061da546Spatrick bool LanguageCategory::Get(FormattersMatchData &match_data,
35061da546Spatrick ImplSP &retval_sp) {
36061da546Spatrick if (!m_category_sp)
37061da546Spatrick return false;
38061da546Spatrick
39061da546Spatrick if (!IsEnabled())
40061da546Spatrick return false;
41061da546Spatrick
42061da546Spatrick if (match_data.GetTypeForCache()) {
43061da546Spatrick if (m_format_cache.Get(match_data.GetTypeForCache(), retval_sp))
44061da546Spatrick return (bool)retval_sp;
45061da546Spatrick }
46061da546Spatrick
47061da546Spatrick ValueObject &valobj(match_data.GetValueObject());
48061da546Spatrick bool result = m_category_sp->Get(valobj.GetObjectRuntimeLanguage(),
49061da546Spatrick match_data.GetMatchesVector(), retval_sp);
50061da546Spatrick if (match_data.GetTypeForCache() &&
51061da546Spatrick (!retval_sp || !retval_sp->NonCacheable())) {
52061da546Spatrick m_format_cache.Set(match_data.GetTypeForCache(), retval_sp);
53061da546Spatrick }
54061da546Spatrick return result;
55061da546Spatrick }
56061da546Spatrick
57061da546Spatrick namespace lldb_private {
58061da546Spatrick
59061da546Spatrick /// Explicit instantiations for the three types.
60061da546Spatrick /// \{
61061da546Spatrick template bool
62061da546Spatrick LanguageCategory::Get<lldb::TypeFormatImplSP>(FormattersMatchData &,
63061da546Spatrick lldb::TypeFormatImplSP &);
64061da546Spatrick template bool
65061da546Spatrick LanguageCategory::Get<lldb::TypeSummaryImplSP>(FormattersMatchData &,
66061da546Spatrick lldb::TypeSummaryImplSP &);
67061da546Spatrick template bool
68061da546Spatrick LanguageCategory::Get<lldb::SyntheticChildrenSP>(FormattersMatchData &,
69061da546Spatrick lldb::SyntheticChildrenSP &);
70061da546Spatrick /// \}
71061da546Spatrick
72061da546Spatrick template <>
GetHardcodedFinder()73061da546Spatrick auto &LanguageCategory::GetHardcodedFinder<lldb::TypeFormatImplSP>() {
74061da546Spatrick return m_hardcoded_formats;
75061da546Spatrick }
76061da546Spatrick
77061da546Spatrick template <>
GetHardcodedFinder()78061da546Spatrick auto &LanguageCategory::GetHardcodedFinder<lldb::TypeSummaryImplSP>() {
79061da546Spatrick return m_hardcoded_summaries;
80061da546Spatrick }
81061da546Spatrick
82061da546Spatrick template <>
GetHardcodedFinder()83061da546Spatrick auto &LanguageCategory::GetHardcodedFinder<lldb::SyntheticChildrenSP>() {
84061da546Spatrick return m_hardcoded_synthetics;
85061da546Spatrick }
86061da546Spatrick
87061da546Spatrick } // namespace lldb_private
88061da546Spatrick
89061da546Spatrick template <typename ImplSP>
GetHardcoded(FormatManager & fmt_mgr,FormattersMatchData & match_data,ImplSP & retval_sp)90061da546Spatrick bool LanguageCategory::GetHardcoded(FormatManager &fmt_mgr,
91061da546Spatrick FormattersMatchData &match_data,
92061da546Spatrick ImplSP &retval_sp) {
93061da546Spatrick if (!IsEnabled())
94061da546Spatrick return false;
95061da546Spatrick
96061da546Spatrick ValueObject &valobj(match_data.GetValueObject());
97061da546Spatrick lldb::DynamicValueType use_dynamic(match_data.GetDynamicValueType());
98061da546Spatrick
99061da546Spatrick for (auto &candidate : GetHardcodedFinder<ImplSP>()) {
100061da546Spatrick if (auto result = candidate(valobj, use_dynamic, fmt_mgr)) {
101061da546Spatrick retval_sp = result;
102061da546Spatrick break;
103061da546Spatrick }
104061da546Spatrick }
105061da546Spatrick return (bool)retval_sp;
106061da546Spatrick }
107061da546Spatrick
108061da546Spatrick /// Explicit instantiations for the three types.
109061da546Spatrick /// \{
110061da546Spatrick template bool LanguageCategory::GetHardcoded<lldb::TypeFormatImplSP>(
111061da546Spatrick FormatManager &, FormattersMatchData &, lldb::TypeFormatImplSP &);
112061da546Spatrick template bool LanguageCategory::GetHardcoded<lldb::TypeSummaryImplSP>(
113061da546Spatrick FormatManager &, FormattersMatchData &, lldb::TypeSummaryImplSP &);
114061da546Spatrick template bool LanguageCategory::GetHardcoded<lldb::SyntheticChildrenSP>(
115061da546Spatrick FormatManager &, FormattersMatchData &, lldb::SyntheticChildrenSP &);
116061da546Spatrick /// \}
117061da546Spatrick
GetCategory() const118061da546Spatrick lldb::TypeCategoryImplSP LanguageCategory::GetCategory() const {
119061da546Spatrick return m_category_sp;
120061da546Spatrick }
121061da546Spatrick
GetFormatCache()122061da546Spatrick FormatCache &LanguageCategory::GetFormatCache() { return m_format_cache; }
123061da546Spatrick
Enable()124061da546Spatrick void LanguageCategory::Enable() {
125061da546Spatrick if (m_category_sp)
126061da546Spatrick m_category_sp->Enable(true, TypeCategoryMap::Default);
127061da546Spatrick m_enabled = true;
128061da546Spatrick }
129061da546Spatrick
Disable()130061da546Spatrick void LanguageCategory::Disable() {
131061da546Spatrick if (m_category_sp)
132061da546Spatrick m_category_sp->Disable();
133061da546Spatrick m_enabled = false;
134061da546Spatrick }
135061da546Spatrick
IsEnabled()136061da546Spatrick bool LanguageCategory::IsEnabled() { return m_enabled; }
137