aboutsummaryrefslogtreecommitdiff
path: root/include/lldb/DataFormatters/TypeFormat.h
blob: 1090d7843e539a9112556a3e590ac16f086ab975 (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
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
//===-- TypeFormat.h ----------------------------------------------*- C++ -*-===//
//
//                     The LLVM Compiler Infrastructure
//
// This file is distributed under the University of Illinois Open Source
// License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//

#ifndef lldb_TypeFormat_h_
#define lldb_TypeFormat_h_

// C Includes

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

// Other libraries and framework includes

// Project includes
#include "lldb/lldb-public.h"
#include "lldb/lldb-enumerations.h"

#include "lldb/Core/ValueObject.h"

namespace lldb_private {
    class TypeFormatImpl
    {
    public:
        class Flags
        {
        public:
            
            Flags () :
            m_flags (lldb::eTypeOptionCascade)
            {}
            
            Flags (const Flags& other) :
            m_flags (other.m_flags)
            {}
            
            Flags (uint32_t value) :
            m_flags (value)
            {}
            
            Flags&
            operator = (const Flags& rhs)
            {
                if (&rhs != this)
                    m_flags = rhs.m_flags;
                
                return *this;
            }
            
            Flags&
            operator = (const uint32_t& rhs)
            {
                m_flags = rhs;
                return *this;
            }
            
            Flags&
            Clear()
            {
                m_flags = 0;
                return *this;
            }
            
            bool
            GetCascades () const
            {
                return (m_flags & lldb::eTypeOptionCascade) == lldb::eTypeOptionCascade;
            }
            
            Flags&
            SetCascades (bool value = true)
            {
                if (value)
                    m_flags |= lldb::eTypeOptionCascade;
                else
                    m_flags &= ~lldb::eTypeOptionCascade;
                return *this;
            }
            
            bool
            GetSkipPointers () const
            {
                return (m_flags & lldb::eTypeOptionSkipPointers) == lldb::eTypeOptionSkipPointers;
            }
            
            Flags&
            SetSkipPointers (bool value = true)
            {
                if (value)
                    m_flags |= lldb::eTypeOptionSkipPointers;
                else
                    m_flags &= ~lldb::eTypeOptionSkipPointers;
                return *this;
            }
            
            bool
            GetSkipReferences () const
            {
                return (m_flags & lldb::eTypeOptionSkipReferences) == lldb::eTypeOptionSkipReferences;
            }
            
            Flags&
            SetSkipReferences (bool value = true)
            {
                if (value)
                    m_flags |= lldb::eTypeOptionSkipReferences;
                else
                    m_flags &= ~lldb::eTypeOptionSkipReferences;
                return *this;
            }
            
            uint32_t
            GetValue ()
            {
                return m_flags;
            }
            
            void
            SetValue (uint32_t value)
            {
                m_flags = value;
            }
            
        private:
            uint32_t m_flags;
        };
        
        TypeFormatImpl (const Flags& flags = Flags());
        
        typedef std::shared_ptr<TypeFormatImpl> SharedPointer;
        typedef bool(*ValueCallback)(void*, ConstString, const lldb::TypeFormatImplSP&);
        
        virtual ~TypeFormatImpl ();
        
        bool
        Cascades () const
        {
            return m_flags.GetCascades();
        }
        bool
        SkipsPointers () const
        {
            return m_flags.GetSkipPointers();
        }
        bool
        SkipsReferences () const
        {
            return m_flags.GetSkipReferences();
        }
        
        void
        SetCascades (bool value)
        {
            m_flags.SetCascades(value);
        }
        
        void
        SetSkipsPointers (bool value)
        {
            m_flags.SetSkipPointers(value);
        }
        
        void
        SetSkipsReferences (bool value)
        {
            m_flags.SetSkipReferences(value);
        }

        uint32_t
        GetOptions ()
        {
            return m_flags.GetValue();
        }
        
        void
        SetOptions (uint32_t value)
        {
            m_flags.SetValue(value);
        }
        
        uint32_t&
        GetRevision ()
        {
            return m_my_revision;
        }
        
        enum class Type
        {
            eTypeUnknown,
            eTypeFormat,
            eTypeEnum
        };
        
        virtual Type
        GetType ()
        {
            return Type::eTypeUnknown;
        }
        
        // we are using a ValueObject* instead of a ValueObjectSP because we do not need to hold on to this for
        // extended periods of time and we trust the ValueObject to stay around for as long as it is required
        // for us to generate its value
        virtual bool
        FormatObject (ValueObject *valobj,
                      std::string& dest) const = 0;
        
        virtual std::string
        GetDescription() = 0;
        
    protected:
        Flags m_flags;
        uint32_t m_my_revision;
        
    private:
        DISALLOW_COPY_AND_ASSIGN(TypeFormatImpl);
    };
    
    class TypeFormatImpl_Format : public TypeFormatImpl
    {
    public:
        TypeFormatImpl_Format (lldb::Format f = lldb::eFormatInvalid,
                               const TypeFormatImpl::Flags& flags = Flags());
        
        typedef std::shared_ptr<TypeFormatImpl_Format> SharedPointer;
        typedef bool(*ValueCallback)(void*, ConstString, const TypeFormatImpl_Format::SharedPointer&);
        
        virtual ~TypeFormatImpl_Format ();
        
        lldb::Format
        GetFormat () const
        {
            return m_format;
        }
        
        void
        SetFormat (lldb::Format fmt)
        {
            m_format = fmt;
        }
        
        virtual TypeFormatImpl::Type
        GetType ()
        {
            return TypeFormatImpl::Type::eTypeFormat;
        }
        
        virtual bool
        FormatObject (ValueObject *valobj,
                      std::string& dest) const;
        
        virtual std::string
        GetDescription();
        
    protected:
        lldb::Format m_format;
        
    private:
        DISALLOW_COPY_AND_ASSIGN(TypeFormatImpl_Format);
    };
    
    class TypeFormatImpl_EnumType : public TypeFormatImpl
    {
    public:
        TypeFormatImpl_EnumType (ConstString type_name = ConstString(""),
                                 const TypeFormatImpl::Flags& flags = Flags());
        
        typedef std::shared_ptr<TypeFormatImpl_EnumType> SharedPointer;
        typedef bool(*ValueCallback)(void*, ConstString, const TypeFormatImpl_EnumType::SharedPointer&);
        
        ~TypeFormatImpl_EnumType ();
        
        ConstString
        GetTypeName ()
        {
            return m_enum_type;
        }
        
        void
        SetTypeName (ConstString enum_type)
        {
            m_enum_type = enum_type;
        }
        
        virtual TypeFormatImpl::Type
        GetType ()
        {
            return TypeFormatImpl::Type::eTypeEnum;
        }
        
        virtual bool
        FormatObject (ValueObject *valobj,
                      std::string& dest) const;
        
        virtual std::string
        GetDescription();
        
    protected:
        ConstString m_enum_type;
        mutable std::unordered_map<void*,ClangASTType> m_types;
        
    private:
        DISALLOW_COPY_AND_ASSIGN(TypeFormatImpl_EnumType);
    };
} // namespace lldb_private

#endif	// lldb_TypeFormat_h_