aboutsummaryrefslogtreecommitdiff
path: root/include/lldb/Interpreter/Property.h
blob: cb4c827ded06223797ebd41d5e34884fbd8c570a (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
//===-- Property.h ----------------------------------------------*- C++ -*-===//
//
//                     The LLVM Compiler Infrastructure
//
// This file is distributed under the University of Illinois Open Source
// License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//

#ifndef liblldb_Property_h_
#define liblldb_Property_h_

// C Includes
// C++ Includes
#include <string>

// Other libraries and framework includes
// Project includes
#include "lldb/lldb-defines.h"
#include "lldb/Core/ConstString.h"
#include "lldb/Core/Flags.h"
#include "lldb/Interpreter/OptionValue.h"

namespace lldb_private {

    // A structure that can be used to create a global table for all properties.
    // Property class instances can be constructed using one of these.
    struct PropertyDefinition
    {
        const char *name;
        OptionValue::Type type;
        bool global;                        // false == this setting is a global setting by default
        uintptr_t default_uint_value;
        const char *default_cstr_value;
        OptionEnumValueElement *enum_values;
        const char *description;
    };
    
    class Property
    {
    public:
        Property (const PropertyDefinition &definition);
        
        Property (const ConstString &name,
                  const ConstString &desc,
                  bool is_global,
                  const lldb::OptionValueSP &value_sp);
        
        const ConstString &
        GetName() const
        {
            return m_name;
        }
        
        const char *
        GetDescription () const
        {
            return m_description.GetCString();
        }
        
        const lldb::OptionValueSP &
        GetValue() const
        {
            return m_value_sp;
        }
        
        void
        SetOptionValue (const lldb::OptionValueSP &value_sp)
        {
            m_value_sp = value_sp;
        }
        
        
        bool
        IsValid() const
        {
            return (bool)m_value_sp;
        }
        
        bool
        IsGlobal () const
        {
            return m_is_global;
        }
        
        void
        Dump (const ExecutionContext *exe_ctx,
              Stream &strm,
              uint32_t dump_mask) const;
        
        bool
        DumpQualifiedName(Stream &strm) const;

        void
        DumpDescription (CommandInterpreter &interpreter,
                         Stream &strm,
                         uint32_t output_width,
                         bool display_qualified_name) const;

        void
        SetValueChangedCallback (OptionValueChangedCallback callback, void *baton);

    protected:
        ConstString m_name;
        ConstString m_description;
        lldb::OptionValueSP m_value_sp;
        bool m_is_global;
    };

} // namespace lldb_private

#endif  // liblldb_Property_h_