LLDB mainline
UserSettingsController.cpp
Go to the documentation of this file.
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
10
12#include "lldb/Utility/Status.h"
13#include "lldb/Utility/Stream.h"
14
15#include <memory>
16
17namespace lldb_private {
19}
20namespace lldb_private {
21class ConstString;
22}
23namespace lldb_private {
25}
26namespace lldb_private {
27class Property;
28}
29
30using namespace lldb;
31using namespace lldb_private;
32
33Properties::Properties() = default;
34
36 : m_collection_sp(collection_sp) {}
37
38Properties::~Properties() = default;
39
42 llvm::StringRef path, Status &error) const {
44 if (properties_sp)
45 return properties_sp->GetSubValue(exe_ctx, path, error);
46 return lldb::OptionValueSP();
47}
48
51 llvm::StringRef path,
52 llvm::StringRef value) {
54 if (properties_sp)
55 return properties_sp->SetSubValue(exe_ctx, op, path, value);
57 error.SetErrorString("no properties");
58 return error;
59}
60
62 Stream &strm, uint32_t dump_mask,
63 bool is_json) {
65 if (!properties_sp)
66 return;
67
68 if (is_json) {
69 llvm::json::Value json = properties_sp->ToJSON(exe_ctx);
70 strm.Printf("%s", llvm::formatv("{0:2}", json).str().c_str());
71 } else
72 properties_sp->DumpValue(exe_ctx, strm, dump_mask);
73}
74
76 Stream &strm) const {
77 strm.PutCString("Top level variables:\n\n");
78
80 if (properties_sp)
81 return properties_sp->DumpAllDescriptions(interpreter, strm);
82}
83
85 Stream &strm,
86 llvm::StringRef property_path,
87 uint32_t dump_mask, bool is_json) {
89 if (properties_sp) {
90 return properties_sp->DumpPropertyValue(exe_ctx, strm, property_path,
91 dump_mask, is_json);
92 }
94 error.SetErrorString("empty property list");
95 return error;
96}
97
98size_t
99Properties::Apropos(llvm::StringRef keyword,
100 std::vector<const Property *> &matching_properties) const {
102 if (properties_sp) {
103 properties_sp->Apropos(keyword, matching_properties);
104 }
105 return matching_properties.size();
106}
107
109 static constexpr llvm::StringLiteral g_experimental("experimental");
110 return g_experimental;
111}
112
113bool 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}
static llvm::raw_ostream & error(Stream &strm)
A uniqued constant string class.
Definition: ConstString.h:40
"lldb/Target/ExecutionContext.h" A class that contains an execution context.
virtual void DumpAllDescriptions(CommandInterpreter &interpreter, Stream &strm) const
virtual Status DumpPropertyValue(const ExecutionContext *exe_ctx, Stream &strm, llvm::StringRef property_path, uint32_t dump_mask, bool is_json=false)
virtual void DumpAllPropertyValues(const ExecutionContext *exe_ctx, Stream &strm, uint32_t dump_mask, bool is_json=false)
size_t Apropos(llvm::StringRef keyword, std::vector< const Property * > &matching_properties) const
virtual Status SetPropertyValue(const ExecutionContext *exe_ctx, VarSetOperationType op, llvm::StringRef property_path, llvm::StringRef value)
virtual lldb::OptionValueSP GetPropertyValue(const ExecutionContext *exe_ctx, llvm::StringRef property_path, Status &error) const
static bool IsSettingExperimental(llvm::StringRef setting)
static llvm::StringRef GetExperimentalSettingsName()
virtual lldb::OptionValuePropertiesSP GetValueProperties() const
An error handling class.
Definition: Status.h:44
A stream class that can stream formatted output to a file.
Definition: Stream.h:28
size_t Printf(const char *format,...) __attribute__((format(printf
Output printf formatted output to the stream.
Definition: Stream.cpp:134
size_t PutCString(llvm::StringRef cstr)
Output a C string to the stream.
Definition: Stream.cpp:65
A class that represents a running process on the host machine.
VarSetOperationType
Settable state variable types.
Definition: SBAddress.h:15
std::shared_ptr< lldb_private::OptionValueProperties > OptionValuePropertiesSP
Definition: lldb-forward.h:383
std::shared_ptr< lldb_private::OptionValue > OptionValueSP
Definition: lldb-forward.h:380