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 {
43 return m_collection_sp->GetSubValue(exe_ctx, path, error);
44}
45
48 llvm::StringRef path,
49 llvm::StringRef value) {
50 return m_collection_sp->SetSubValue(exe_ctx, op, path, value);
51}
52
54 Stream &strm, uint32_t dump_mask,
55 bool is_json) {
56 if (is_json) {
57 llvm::json::Value json = m_collection_sp->ToJSON(exe_ctx);
58 strm.Printf("%s", llvm::formatv("{0:2}", json).str().c_str());
59 } else
60 m_collection_sp->DumpValue(exe_ctx, strm, dump_mask);
61}
62
64 Stream &strm) const {
65 strm.PutCString("Top level variables:\n\n");
66
67 return m_collection_sp->DumpAllDescriptions(interpreter, strm);
68}
69
71 Stream &strm,
72 llvm::StringRef property_path,
73 uint32_t dump_mask, bool is_json) {
74 return m_collection_sp->DumpPropertyValue(exe_ctx, strm, property_path,
75 dump_mask, is_json);
76}
77
78size_t
79Properties::Apropos(llvm::StringRef keyword,
80 std::vector<const Property *> &matching_properties) const {
81 m_collection_sp->Apropos(keyword, matching_properties);
82 return matching_properties.size();
83}
84
86 static constexpr llvm::StringLiteral g_experimental("experimental");
87 return g_experimental;
88}
89
90bool Properties::IsSettingExperimental(llvm::StringRef setting) {
91 if (setting.empty())
92 return false;
93
94 llvm::StringRef experimental = GetExperimentalSettingsName();
95 size_t dot_pos = setting.find_first_of('.');
96 return setting.take_front(dot_pos) == experimental;
97}
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
lldb::OptionValuePropertiesSP m_collection_sp
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()
An error handling class.
Definition Status.h:118
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.
std::shared_ptr< lldb_private::OptionValueProperties > OptionValuePropertiesSP
std::shared_ptr< lldb_private::OptionValue > OptionValueSP