aboutsummaryrefslogtreecommitdiff
path: root/include/lldb/Core/ValueObjectConstResult.h
blob: f63ee83284df7cc126cdbfc4ffbcccdf0b5d24ac (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
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
//===-- ValueObjectConstResult.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_ValueObjectConstResult_h_
#define liblldb_ValueObjectConstResult_h_

// C Includes
// C++ Includes
// Other libraries and framework includes
// Project includes
#include "lldb/Core/ValueObject.h"

#include "lldb/Core/ValueObjectConstResultImpl.h"

namespace lldb_private {

//----------------------------------------------------------------------
// A frozen ValueObject copied into host memory
//----------------------------------------------------------------------
class ValueObjectConstResult : public ValueObject
{
public:
    ~ValueObjectConstResult() override;

    static lldb::ValueObjectSP
    Create (ExecutionContextScope *exe_scope,
            lldb::ByteOrder byte_order, 
            uint32_t addr_byte_size,
            lldb::addr_t address = LLDB_INVALID_ADDRESS);

    static lldb::ValueObjectSP
    Create (ExecutionContextScope *exe_scope,
            const CompilerType &compiler_type,
            const ConstString &name,
            const DataExtractor &data,
            lldb::addr_t address = LLDB_INVALID_ADDRESS);

    static lldb::ValueObjectSP
    Create (ExecutionContextScope *exe_scope,
            const CompilerType &compiler_type,
            const ConstString &name,
            const lldb::DataBufferSP &result_data_sp,
            lldb::ByteOrder byte_order, 
            uint32_t addr_size,
            lldb::addr_t address = LLDB_INVALID_ADDRESS);

    static lldb::ValueObjectSP
    Create (ExecutionContextScope *exe_scope,
            const CompilerType &compiler_type,
            const ConstString &name,
            lldb::addr_t address,
            AddressType address_type,
            uint32_t addr_byte_size);

    static lldb::ValueObjectSP
    Create (ExecutionContextScope *exe_scope,
            Value &value,
            const ConstString &name,
            Module* module = nullptr);

    // When an expression fails to evaluate, we return an error
    static lldb::ValueObjectSP
    Create (ExecutionContextScope *exe_scope,
            const Error& error);

    uint64_t
    GetByteSize() override;

    lldb::ValueType
    GetValueType() const override;

    size_t
    CalculateNumChildren(uint32_t max) override;

    ConstString
    GetTypeName() override;

    ConstString
    GetDisplayTypeName() override;
    
    bool
    IsInScope() override;

    void
    SetByteSize (size_t size);
    
    lldb::ValueObjectSP
    Dereference(Error &error) override;
    
    ValueObject *
    CreateChildAtIndex(size_t idx, bool synthetic_array_member, int32_t synthetic_index) override;
    
    lldb::ValueObjectSP
    GetSyntheticChildAtOffset(uint32_t offset, const CompilerType& type, bool can_create) override;
    
    lldb::ValueObjectSP
    AddressOf(Error &error) override;
    
    lldb::addr_t
    GetAddressOf(bool scalar_is_load_address = true,
                 AddressType *address_type = nullptr) override;
    
    size_t
    GetPointeeData(DataExtractor& data,
                   uint32_t item_idx = 0,
                   uint32_t item_count = 1) override;
    
    lldb::addr_t
    GetLiveAddress() override
    {
        return m_impl.GetLiveAddress();
    }
    
    void
    SetLiveAddress(lldb::addr_t addr = LLDB_INVALID_ADDRESS,
                   AddressType address_type = eAddressTypeLoad) override
    {
        m_impl.SetLiveAddress(addr, address_type);
    }
    
    lldb::ValueObjectSP
    GetDynamicValue(lldb::DynamicValueType valueType) override;
    
    lldb::LanguageType
    GetPreferredDisplayLanguage() override;

    lldb::ValueObjectSP
    Cast(const CompilerType &compiler_type) override;

protected:
    bool
    UpdateValue() override;
    
    CompilerType
    GetCompilerTypeImpl() override;

    ConstString m_type_name;
    uint64_t m_byte_size;
    
    ValueObjectConstResultImpl m_impl;

private:
    friend class ValueObjectConstResultImpl;

    ValueObjectConstResult (ExecutionContextScope *exe_scope,
                            lldb::ByteOrder byte_order, 
                            uint32_t addr_byte_size,
                            lldb::addr_t address);

    ValueObjectConstResult (ExecutionContextScope *exe_scope,
                            const CompilerType &compiler_type,
                            const ConstString &name,
                            const DataExtractor &data,
                            lldb::addr_t address);

    ValueObjectConstResult (ExecutionContextScope *exe_scope,
                            const CompilerType &compiler_type,
                            const ConstString &name,
                            const lldb::DataBufferSP &result_data_sp,
                            lldb::ByteOrder byte_order, 
                            uint32_t addr_size,
                            lldb::addr_t address);

    ValueObjectConstResult (ExecutionContextScope *exe_scope,
                            const CompilerType &compiler_type,
                            const ConstString &name,
                            lldb::addr_t address,
                            AddressType address_type,
                            uint32_t addr_byte_size);

    ValueObjectConstResult (ExecutionContextScope *exe_scope,
                            const Value &value,
                            const ConstString &name,
                            Module* module = nullptr);

    ValueObjectConstResult (ExecutionContextScope *exe_scope,
                            const Error& error);

    DISALLOW_COPY_AND_ASSIGN (ValueObjectConstResult);
};

} // namespace lldb_private

#endif // liblldb_ValueObjectConstResult_h_