228 lines
8.9 KiB
C
228 lines
8.9 KiB
C
|
//===-- OptionValueProperties.h ---------------------------------*- C++ -*-===//
|
||
|
|
//
|
||
|
|
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
|
||
|
|
// See https://llvm.org/LICENSE.txt for license information.
|
||
|
|
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
|
||
|
|
//
|
||
|
|
//===----------------------------------------------------------------------===//
|
||
|
|
|
||
|
|
#ifndef LLDB_INTERPRETER_OPTIONVALUEPROPERTIES_H
|
||
|
|
#define LLDB_INTERPRETER_OPTIONVALUEPROPERTIES_H
|
||
|
|
|
||
|
|
#include <vector>
|
||
|
|
|
||
|
|
#include "lldb/Core/FormatEntity.h"
|
||
|
|
#include "lldb/Core/UniqueCStringMap.h"
|
||
|
|
#include "lldb/Interpreter/OptionValue.h"
|
||
|
|
#include "lldb/Interpreter/Property.h"
|
||
|
|
#include "lldb/Utility/ConstString.h"
|
||
|
|
|
||
|
|
namespace lldb_private {
|
||
|
|
class Properties;
|
||
|
|
|
||
|
|
class OptionValueProperties
|
||
|
|
: public Cloneable<OptionValueProperties, OptionValue>,
|
||
|
|
public std::enable_shared_from_this<OptionValueProperties> {
|
||
|
|
public:
|
||
|
|
OptionValueProperties() = default;
|
||
|
|
|
||
|
|
OptionValueProperties(ConstString name);
|
||
|
|
|
||
|
|
~OptionValueProperties() override = default;
|
||
|
|
|
||
|
|
Type GetType() const override { return eTypeProperties; }
|
||
|
|
|
||
|
|
void Clear() override;
|
||
|
|
|
||
|
|
static lldb::OptionValuePropertiesSP
|
||
|
|
CreateLocalCopy(const Properties &global_properties);
|
||
|
|
|
||
|
|
lldb::OptionValueSP
|
||
|
|
DeepCopy(const lldb::OptionValueSP &new_parent) const override;
|
||
|
|
|
||
|
|
Status
|
||
|
|
SetValueFromString(llvm::StringRef value,
|
||
|
|
VarSetOperationType op = eVarSetOperationAssign) override;
|
||
|
|
|
||
|
|
void DumpValue(const ExecutionContext *exe_ctx, Stream &strm,
|
||
|
|
uint32_t dump_mask) override;
|
||
|
|
|
||
|
|
llvm::json::Value ToJSON(const ExecutionContext *exe_ctx) override;
|
||
|
|
|
||
|
|
ConstString GetName() const override { return m_name; }
|
||
|
|
|
||
|
|
virtual Status DumpPropertyValue(const ExecutionContext *exe_ctx,
|
||
|
|
Stream &strm, llvm::StringRef property_path,
|
||
|
|
uint32_t dump_mask, bool is_json = false);
|
||
|
|
|
||
|
|
virtual void DumpAllDescriptions(CommandInterpreter &interpreter,
|
||
|
|
Stream &strm) const;
|
||
|
|
|
||
|
|
void Apropos(llvm::StringRef keyword,
|
||
|
|
std::vector<const Property *> &matching_properties) const;
|
||
|
|
|
||
|
|
void Initialize(const PropertyDefinitions &setting_definitions);
|
||
|
|
|
||
|
|
// bool
|
||
|
|
// GetQualifiedName (Stream &strm);
|
||
|
|
|
||
|
|
// Subclass specific functions
|
||
|
|
|
||
|
|
virtual size_t GetNumProperties() const;
|
||
|
|
|
||
|
|
// Get the index of a property given its exact name in this property
|
||
|
|
// collection, "name" can't be a path to a property path that refers to a
|
||
|
|
// property within a property
|
||
|
|
virtual uint32_t GetPropertyIndex(ConstString name) const;
|
||
|
|
|
||
|
|
// Get a property by exact name exists in this property collection, name can
|
||
|
|
// not be a path to a property path that refers to a property within a
|
||
|
|
// property
|
||
|
|
virtual const Property *GetProperty(const ExecutionContext *exe_ctx,
|
||
|
|
bool will_modify,
|
||
|
|
ConstString name) const;
|
||
|
|
|
||
|
|
virtual const Property *GetPropertyAtIndex(const ExecutionContext *exe_ctx,
|
||
|
|
bool will_modify,
|
||
|
|
uint32_t idx) const;
|
||
|
|
|
||
|
|
// Property can be be a property path like
|
||
|
|
// "target.process.extra-startup-command"
|
||
|
|
virtual const Property *GetPropertyAtPath(const ExecutionContext *exe_ctx,
|
||
|
|
bool will_modify,
|
||
|
|
llvm::StringRef property_path) const;
|
||
|
|
|
||
|
|
virtual lldb::OptionValueSP
|
||
|
|
GetPropertyValueAtIndex(const ExecutionContext *exe_ctx, bool will_modify,
|
||
|
|
uint32_t idx) const;
|
||
|
|
|
||
|
|
virtual lldb::OptionValueSP GetValueForKey(const ExecutionContext *exe_ctx,
|
||
|
|
ConstString key,
|
||
|
|
bool value_will_be_modified) const;
|
||
|
|
|
||
|
|
lldb::OptionValueSP GetSubValue(const ExecutionContext *exe_ctx,
|
||
|
|
llvm::StringRef name,
|
||
|
|
bool value_will_be_modified,
|
||
|
|
Status &error) const override;
|
||
|
|
|
||
|
|
Status SetSubValue(const ExecutionContext *exe_ctx, VarSetOperationType op,
|
||
|
|
llvm::StringRef path, llvm::StringRef value) override;
|
||
|
|
|
||
|
|
OptionValueArch *
|
||
|
|
GetPropertyAtIndexAsOptionValueArch(const ExecutionContext *exe_ctx,
|
||
|
|
uint32_t idx) const;
|
||
|
|
|
||
|
|
OptionValueLanguage *
|
||
|
|
GetPropertyAtIndexAsOptionValueLanguage(const ExecutionContext *exe_ctx,
|
||
|
|
uint32_t idx) const;
|
||
|
|
|
||
|
|
bool SetPropertyAtIndexAsLanguage(const ExecutionContext *exe_ctx,
|
||
|
|
uint32_t idx, lldb::LanguageType lang);
|
||
|
|
|
||
|
|
bool GetPropertyAtIndexAsArgs(const ExecutionContext *exe_ctx, uint32_t idx,
|
||
|
|
Args &args) const;
|
||
|
|
|
||
|
|
bool SetPropertyAtIndexFromArgs(const ExecutionContext *exe_ctx, uint32_t idx,
|
||
|
|
const Args &args);
|
||
|
|
|
||
|
|
bool GetPropertyAtIndexAsBoolean(const ExecutionContext *exe_ctx,
|
||
|
|
uint32_t idx, bool fail_value) const;
|
||
|
|
|
||
|
|
bool SetPropertyAtIndexAsBoolean(const ExecutionContext *exe_ctx,
|
||
|
|
uint32_t idx, bool new_value);
|
||
|
|
|
||
|
|
OptionValueDictionary *
|
||
|
|
GetPropertyAtIndexAsOptionValueDictionary(const ExecutionContext *exe_ctx,
|
||
|
|
uint32_t idx) const;
|
||
|
|
|
||
|
|
int64_t GetPropertyAtIndexAsEnumeration(const ExecutionContext *exe_ctx,
|
||
|
|
uint32_t idx,
|
||
|
|
int64_t fail_value) const;
|
||
|
|
|
||
|
|
bool SetPropertyAtIndexAsEnumeration(const ExecutionContext *exe_ctx,
|
||
|
|
uint32_t idx, int64_t new_value);
|
||
|
|
|
||
|
|
const FormatEntity::Entry *
|
||
|
|
GetPropertyAtIndexAsFormatEntity(const ExecutionContext *exe_ctx,
|
||
|
|
uint32_t idx);
|
||
|
|
|
||
|
|
const RegularExpression *
|
||
|
|
GetPropertyAtIndexAsOptionValueRegex(const ExecutionContext *exe_ctx,
|
||
|
|
uint32_t idx) const;
|
||
|
|
|
||
|
|
OptionValueSInt64 *
|
||
|
|
GetPropertyAtIndexAsOptionValueSInt64(const ExecutionContext *exe_ctx,
|
||
|
|
uint32_t idx) const;
|
||
|
|
|
||
|
|
OptionValueUInt64 *
|
||
|
|
GetPropertyAtIndexAsOptionValueUInt64(const ExecutionContext *exe_ctx,
|
||
|
|
uint32_t idx) const;
|
||
|
|
|
||
|
|
int64_t GetPropertyAtIndexAsSInt64(const ExecutionContext *exe_ctx,
|
||
|
|
uint32_t idx, int64_t fail_value) const;
|
||
|
|
|
||
|
|
bool SetPropertyAtIndexAsSInt64(const ExecutionContext *exe_ctx, uint32_t idx,
|
||
|
|
int64_t new_value);
|
||
|
|
|
||
|
|
uint64_t GetPropertyAtIndexAsUInt64(const ExecutionContext *exe_ctx,
|
||
|
|
uint32_t idx, uint64_t fail_value) const;
|
||
|
|
|
||
|
|
bool SetPropertyAtIndexAsUInt64(const ExecutionContext *exe_ctx, uint32_t idx,
|
||
|
|
uint64_t new_value);
|
||
|
|
|
||
|
|
llvm::StringRef GetPropertyAtIndexAsString(const ExecutionContext *exe_ctx,
|
||
|
|
uint32_t idx,
|
||
|
|
llvm::StringRef fail_value) const;
|
||
|
|
|
||
|
|
bool SetPropertyAtIndexAsString(const ExecutionContext *exe_ctx, uint32_t idx,
|
||
|
|
llvm::StringRef new_value);
|
||
|
|
|
||
|
|
OptionValueString *
|
||
|
|
GetPropertyAtIndexAsOptionValueString(const ExecutionContext *exe_ctx,
|
||
|
|
bool will_modify, uint32_t idx) const;
|
||
|
|
|
||
|
|
OptionValueFileSpec *
|
||
|
|
GetPropertyAtIndexAsOptionValueFileSpec(const ExecutionContext *exe_ctx,
|
||
|
|
bool will_modify, uint32_t idx) const;
|
||
|
|
|
||
|
|
FileSpec GetPropertyAtIndexAsFileSpec(const ExecutionContext *exe_ctx,
|
||
|
|
uint32_t idx) const;
|
||
|
|
|
||
|
|
bool SetPropertyAtIndexAsFileSpec(const ExecutionContext *exe_ctx,
|
||
|
|
uint32_t idx, const FileSpec &file_spec);
|
||
|
|
|
||
|
|
OptionValuePathMappings *GetPropertyAtIndexAsOptionValuePathMappings(
|
||
|
|
const ExecutionContext *exe_ctx, bool will_modify, uint32_t idx) const;
|
||
|
|
|
||
|
|
OptionValueFileSpecList *GetPropertyAtIndexAsOptionValueFileSpecList(
|
||
|
|
const ExecutionContext *exe_ctx, bool will_modify, uint32_t idx) const;
|
||
|
|
|
||
|
|
void AppendProperty(ConstString name, ConstString desc,
|
||
|
|
bool is_global, const lldb::OptionValueSP &value_sp);
|
||
|
|
|
||
|
|
lldb::OptionValuePropertiesSP GetSubProperty(const ExecutionContext *exe_ctx,
|
||
|
|
ConstString name);
|
||
|
|
|
||
|
|
void SetValueChangedCallback(uint32_t property_idx,
|
||
|
|
std::function<void()> callback);
|
||
|
|
|
||
|
|
protected:
|
||
|
|
Property *ProtectedGetPropertyAtIndex(uint32_t idx) {
|
||
|
|
return ((idx < m_properties.size()) ? &m_properties[idx] : nullptr);
|
||
|
|
}
|
||
|
|
|
||
|
|
const Property *ProtectedGetPropertyAtIndex(uint32_t idx) const {
|
||
|
|
return ((idx < m_properties.size()) ? &m_properties[idx] : nullptr);
|
||
|
|
}
|
||
|
|
|
||
|
|
typedef UniqueCStringMap<size_t> NameToIndex;
|
||
|
|
|
||
|
|
ConstString m_name;
|
||
|
|
std::vector<Property> m_properties;
|
||
|
|
NameToIndex m_name_to_index;
|
||
|
|
};
|
||
|
|
|
||
|
|
} // namespace lldb_private
|
||
|
|
|
||
|
|
#endif // LLDB_INTERPRETER_OPTIONVALUEPROPERTIES_H
|