1 //===-- UserSettingsController.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 #include "lldb/Core/UserSettingsController.h"
10 
11 #include "lldb/Interpreter/OptionValueProperties.h"
12 #include "lldb/Utility/Status.h"
13 #include "lldb/Utility/Stream.h"
14 
15 #include <memory>
16 
17 namespace lldb_private {
18 class CommandInterpreter;
19 }
20 namespace lldb_private {
21 class ConstString;
22 }
23 namespace lldb_private {
24 class ExecutionContext;
25 }
26 namespace lldb_private {
27 class Property;
28 }
29 
30 using namespace lldb;
31 using namespace lldb_private;
32 
33 lldb::OptionValueSP
34 Properties::GetPropertyValue(const ExecutionContext *exe_ctx,
35                              llvm::StringRef path, bool will_modify,
36                              Status &error) const {
37   OptionValuePropertiesSP properties_sp(GetValueProperties());
38   if (properties_sp)
39     return properties_sp->GetSubValue(exe_ctx, path, will_modify, error);
40   return lldb::OptionValueSP();
41 }
42 
43 Status Properties::SetPropertyValue(const ExecutionContext *exe_ctx,
44                                     VarSetOperationType op,
45                                     llvm::StringRef path,
46                                     llvm::StringRef value) {
47   OptionValuePropertiesSP properties_sp(GetValueProperties());
48   if (properties_sp)
49     return properties_sp->SetSubValue(exe_ctx, op, path, value);
50   Status error;
51   error.SetErrorString("no properties");
52   return error;
53 }
54 
55 void Properties::DumpAllPropertyValues(const ExecutionContext *exe_ctx,
56                                        Stream &strm, uint32_t dump_mask,
57                                        bool is_json) {
58   OptionValuePropertiesSP properties_sp(GetValueProperties());
59   if (!properties_sp)
60     return;
61 
62   if (is_json) {
63     llvm::json::Value json = properties_sp->ToJSON(exe_ctx);
64     strm.Printf("%s", llvm::formatv("{0:2}", json).str().c_str());
65   } else
66     properties_sp->DumpValue(exe_ctx, strm, dump_mask);
67 }
68 
69 void Properties::DumpAllDescriptions(CommandInterpreter &interpreter,
70                                      Stream &strm) const {
71   strm.PutCString("Top level variables:\n\n");
72 
73   OptionValuePropertiesSP properties_sp(GetValueProperties());
74   if (properties_sp)
75     return properties_sp->DumpAllDescriptions(interpreter, strm);
76 }
77 
78 Status Properties::DumpPropertyValue(const ExecutionContext *exe_ctx,
79                                      Stream &strm,
80                                      llvm::StringRef property_path,
81                                      uint32_t dump_mask, bool is_json) {
82   OptionValuePropertiesSP properties_sp(GetValueProperties());
83   if (properties_sp) {
84     return properties_sp->DumpPropertyValue(exe_ctx, strm, property_path,
85                                             dump_mask, is_json);
86   }
87   Status error;
88   error.SetErrorString("empty property list");
89   return error;
90 }
91 
92 size_t
93 Properties::Apropos(llvm::StringRef keyword,
94                     std::vector<const Property *> &matching_properties) const {
95   OptionValuePropertiesSP properties_sp(GetValueProperties());
96   if (properties_sp) {
97     properties_sp->Apropos(keyword, matching_properties);
98   }
99   return matching_properties.size();
100 }
101 
102 lldb::OptionValuePropertiesSP
103 Properties::GetSubProperty(const ExecutionContext *exe_ctx,
104                            ConstString name) {
105   OptionValuePropertiesSP properties_sp(GetValueProperties());
106   if (properties_sp)
107     return properties_sp->GetSubProperty(exe_ctx, name);
108   return lldb::OptionValuePropertiesSP();
109 }
110 
111 const char *Properties::GetExperimentalSettingsName() { return "experimental"; }
112 
113 bool Properties::IsSettingExperimental(llvm::StringRef setting) {
114   if (setting.empty())
115     return false;
116 
117   llvm::StringRef experimental = GetExperimentalSettingsName();
118   size_t dot_pos = setting.find_first_of('.');
119   return setting.take_front(dot_pos) == experimental;
120 }
121