1 //===-- OptionValueString.h -------------------------------------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 #ifndef liblldb_OptionValueString_h_
11 #define liblldb_OptionValueString_h_
17 // Other libraries and framework includes
19 #include "lldb/Utility/Flags.h"
21 #include "lldb/Interpreter/OptionValue.h"
23 namespace lldb_private {
25 class OptionValueString : public OptionValue {
27 typedef Status (*ValidatorCallback)(const char *string, void *baton);
29 enum Options { eOptionEncodeCharacterEscapeSequences = (1u << 0) };
32 : OptionValue(), m_current_value(), m_default_value(), m_options(),
33 m_validator(), m_validator_baton() {}
35 OptionValueString(ValidatorCallback validator, void *baton = nullptr)
36 : OptionValue(), m_current_value(), m_default_value(), m_options(),
37 m_validator(validator), m_validator_baton(baton) {}
39 OptionValueString(const char *value)
40 : OptionValue(), m_current_value(), m_default_value(), m_options(),
41 m_validator(), m_validator_baton() {
42 if (value && value[0]) {
43 m_current_value.assign(value);
44 m_default_value.assign(value);
48 OptionValueString(const char *current_value, const char *default_value)
49 : OptionValue(), m_current_value(), m_default_value(), m_options(),
50 m_validator(), m_validator_baton() {
51 if (current_value && current_value[0])
52 m_current_value.assign(current_value);
53 if (default_value && default_value[0])
54 m_default_value.assign(default_value);
57 OptionValueString(const char *value, ValidatorCallback validator,
58 void *baton = nullptr)
59 : OptionValue(), m_current_value(), m_default_value(), m_options(),
60 m_validator(validator), m_validator_baton(baton) {
61 if (value && value[0]) {
62 m_current_value.assign(value);
63 m_default_value.assign(value);
67 OptionValueString(const char *current_value, const char *default_value,
68 ValidatorCallback validator, void *baton = nullptr)
69 : OptionValue(), m_current_value(), m_default_value(), m_options(),
70 m_validator(validator), m_validator_baton(baton) {
71 if (current_value && current_value[0])
72 m_current_value.assign(current_value);
73 if (default_value && default_value[0])
74 m_default_value.assign(default_value);
77 ~OptionValueString() override = default;
79 //---------------------------------------------------------------------
80 // Virtual subclass pure virtual overrides
81 //---------------------------------------------------------------------
83 OptionValue::Type GetType() const override { return eTypeString; }
85 void DumpValue(const ExecutionContext *exe_ctx, Stream &strm,
86 uint32_t dump_mask) override;
89 SetValueFromString(llvm::StringRef value,
90 VarSetOperationType op = eVarSetOperationAssign) override;
92 SetValueFromString(const char *,
93 VarSetOperationType = eVarSetOperationAssign) = delete;
95 bool Clear() override {
96 m_current_value = m_default_value;
97 m_value_was_set = false;
101 lldb::OptionValueSP DeepCopy() const override;
103 //---------------------------------------------------------------------
104 // Subclass specific functions
105 //---------------------------------------------------------------------
107 Flags &GetOptions() { return m_options; }
109 const Flags &GetOptions() const { return m_options; }
111 const char *operator=(const char *value) {
112 SetCurrentValue(llvm::StringRef::withNullAsEmpty(value));
113 return m_current_value.c_str();
116 const char *GetCurrentValue() const { return m_current_value.c_str(); }
117 llvm::StringRef GetCurrentValueAsRef() const { return m_current_value; }
119 const char *GetDefaultValue() const { return m_default_value.c_str(); }
120 llvm::StringRef GetDefaultValueAsRef() const { return m_default_value; }
122 Status SetCurrentValue(const char *) = delete;
123 Status SetCurrentValue(llvm::StringRef value);
125 Status AppendToCurrentValue(const char *value);
127 void SetDefaultValue(const char *value) {
128 if (value && value[0])
129 m_default_value.assign(value);
131 m_default_value.clear();
134 bool IsCurrentValueEmpty() const { return m_current_value.empty(); }
136 bool IsDefaultValueEmpty() const { return m_default_value.empty(); }
139 std::string m_current_value;
140 std::string m_default_value;
142 ValidatorCallback m_validator;
143 void *m_validator_baton;
146 } // namespace lldb_private
148 #endif // liblldb_OptionValueString_h_