aboutsummaryrefslogtreecommitdiff
path: root/source/Plugins/LanguageRuntime/ObjC/AppleObjCRuntime/AppleObjCRuntime.h
blob: 342824e79b1f76eb964591a8fafeb575b877c910 (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
//===-- AppleObjCRuntime.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_AppleObjCRuntime_h_
#define liblldb_AppleObjCRuntime_h_

// C Includes
// C++ Includes
// Other libraries and framework includes
#include "llvm/ADT/Optional.h"

// Project includes
#include "lldb/lldb-private.h"
#include "lldb/Target/LanguageRuntime.h"
#include "lldb/Target/ObjCLanguageRuntime.h"
#include "AppleObjCTrampolineHandler.h"
#include "AppleThreadPlanStepThroughObjCTrampoline.h"

namespace lldb_private {
    
class AppleObjCRuntime :
        public lldb_private::ObjCLanguageRuntime
{
public:
    ~AppleObjCRuntime() override;

    //------------------------------------------------------------------
    // Static Functions
    //------------------------------------------------------------------
    // Note there is no CreateInstance, Initialize & Terminate functions here, because
    // you can't make an instance of this generic runtime.

    static bool classof(const ObjCLanguageRuntime* runtime)
    {
        switch (runtime->GetRuntimeVersion())
        {
            case ObjCRuntimeVersions::eAppleObjC_V1:
            case ObjCRuntimeVersions::eAppleObjC_V2:
                return true;
            default:
                return false;
        }
    }
    
    // These are generic runtime functions:
    bool
    GetObjectDescription (Stream &str, Value &value, ExecutionContextScope *exe_scope) override;
    
    bool
    GetObjectDescription (Stream &str, ValueObject &object) override;
    
    bool
    CouldHaveDynamicValue (ValueObject &in_value) override;
    
    bool
    GetDynamicTypeAndAddress (ValueObject &in_value, 
                              lldb::DynamicValueType use_dynamic, 
                              TypeAndOrName &class_type_or_name, 
                              Address &address,
                              Value::ValueType &value_type) override;

    TypeAndOrName
    FixUpDynamicType (const TypeAndOrName& type_and_or_name,
                      ValueObject& static_value) override;
    
    // These are the ObjC specific functions.
    
    bool
    IsModuleObjCLibrary (const lldb::ModuleSP &module_sp) override;
    
    bool
    ReadObjCLibrary (const lldb::ModuleSP &module_sp) override;

    bool
    HasReadObjCLibrary ()  override
    {
        return m_read_objc_library;
    }
    
    lldb::ThreadPlanSP
    GetStepThroughTrampolinePlan (Thread &thread, bool stop_others) override;
    
    // Get the "libobjc.A.dylib" module from the current target if we can find
    // it, also cache it once it is found to ensure quick lookups.
    lldb::ModuleSP
    GetObjCModule ();
    
    // Sync up with the target

    void
    ModulesDidLoad (const ModuleList &module_list) override;

    void
    SetExceptionBreakpoints() override;

    void
    ClearExceptionBreakpoints() override;
    
    bool
    ExceptionBreakpointsAreSet() override;
    
    bool
    ExceptionBreakpointsExplainStop(lldb::StopInfoSP stop_reason) override;
    
    lldb::SearchFilterSP
    CreateExceptionSearchFilter() override;
    
    uint32_t
    GetFoundationVersion();
    
protected:
    // Call CreateInstance instead.
    AppleObjCRuntime(Process *process);

    bool
    CalculateHasNewLiteralsAndIndexing() override;
    
    static bool
    AppleIsModuleObjCLibrary(const lldb::ModuleSP &module_sp);

    static ObjCRuntimeVersions
    GetObjCVersion(Process *process, lldb::ModuleSP &objc_module_sp);

    void
    ReadObjCLibraryIfNeeded(const ModuleList &module_list);

    Address *
    GetPrintForDebuggerAddr();
    
    std::unique_ptr<Address>  m_PrintForDebugger_addr;
    bool m_read_objc_library;
    std::unique_ptr<lldb_private::AppleObjCTrampolineHandler> m_objc_trampoline_handler_ap;
    lldb::BreakpointSP m_objc_exception_bp_sp;
    lldb::ModuleWP m_objc_module_wp;
    std::unique_ptr<FunctionCaller>  m_print_object_caller_up;
    
    llvm::Optional<uint32_t> m_Foundation_major;
};
    
} // namespace lldb_private

#endif // liblldb_AppleObjCRuntime_h_