aboutsummaryrefslogtreecommitdiff
path: root/include/lldb/Core/InputReader.h
blob: fa86e9a39e2bca382945fcad329ea2f3dcd89977 (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
//===-- InputReader.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_InputReader_h_
#define liblldb_InputReader_h_

#include <string.h>

#include "lldb/lldb-public.h"
#include "lldb/lldb-enumerations.h"
#include "lldb/Core/Error.h"
#include "lldb/Core/StringList.h"
#include "lldb/Host/Predicate.h"


namespace lldb_private {

class InputReader
{
public:

    typedef size_t (*Callback) (void *baton, 
                                InputReader &reader, 
                                lldb::InputReaderAction notification,
                                const char *bytes, 
                                size_t bytes_len);
    
    struct HandlerData
    {
        InputReader& reader;
        const char *bytes;
        size_t bytes_len;
        void* baton;
        
        HandlerData(InputReader& r,
                    const char* b,
                    size_t l,
                    void* t) : 
        reader(r),
        bytes(b),
        bytes_len(l),
        baton(t)
        {
        }
        
        lldb::StreamSP
        GetOutStream();
        
        bool
        GetBatchMode();
    };
    
    struct InitializationParameters
    {
    private:
        void* m_baton;
        lldb::InputReaderGranularity m_token_size;
        char* m_end_token;
        char* m_prompt;
        bool m_echo;
        bool m_save_user_input;
    public:
        InitializationParameters() :
        m_baton(NULL),
        m_token_size(lldb::eInputReaderGranularityLine),
        m_echo(true),
        m_save_user_input(false)
        {
            SetEndToken("DONE");
            SetPrompt("> ");
        }
        
        InitializationParameters&
        SetEcho(bool e)
        {
            m_echo = e;
            return *this;
        }
        
        InitializationParameters&
        SetSaveUserInput(bool s)
        {
            m_save_user_input = s;
            return *this;
        }
        
        InitializationParameters&
        SetBaton(void* b)
        {
            m_baton = b;
            return *this;
        }
        
        InitializationParameters&
        SetGranularity(lldb::InputReaderGranularity g)
        {
            m_token_size = g;
            return *this;
        }
        
        InitializationParameters&
        SetEndToken(const char* e)
        {
            m_end_token = new char[strlen(e)+1];
            ::strcpy(m_end_token,e);
            return *this;
        }
        
        InitializationParameters&
        SetPrompt(const char* p)
        {
            m_prompt = new char[strlen(p)+1];
            ::strcpy(m_prompt,p);
            return *this;
        }
        
        friend class InputReaderEZ;
        
    };

    InputReader (Debugger &debugger);

    virtual
    ~InputReader ();

    virtual Error
    Initialize (Callback callback, 
                void *baton,
                lldb::InputReaderGranularity token_size,
                const char *end_token,
                const char *prompt,
                bool echo);
    
    virtual Error Initialize(void* baton,
                             lldb::InputReaderGranularity token_size = lldb::eInputReaderGranularityLine,
                             const char* end_token = "DONE",
                             const char *prompt = "> ",
                             bool echo = true)
    {
        return Error("unimplemented");
    }
    
    virtual Error
    Initialize(InitializationParameters& params)
    {
        return Error("unimplemented");
    }
    
    // to use these handlers instead of the Callback function, you must subclass
    // InputReaderEZ, and redefine the handlers for the events you care about
    virtual void
    ActivateHandler(HandlerData&) {}
    
    virtual void
    DeactivateHandler(HandlerData&) {}
    
    virtual void
    ReactivateHandler(HandlerData&) {}
    
    virtual void
    AsynchronousOutputWrittenHandler(HandlerData&) {}
    
    virtual void
    GotTokenHandler(HandlerData&) {}
    
    virtual void
    InterruptHandler(HandlerData&) {}
    
    virtual void
    EOFHandler(HandlerData&) {}
    
    virtual void
    DoneHandler(HandlerData&) {}
    
    bool
    IsDone () const
    {
        return m_done;
    }

    void
    SetIsDone (bool b)
    {
        m_done = b;
    }

    lldb::InputReaderGranularity
    GetGranularity () const
    {
        return m_granularity;
    }

    bool
    GetEcho () const
    {
        return m_echo;
    }
    
    StringList&
    GetUserInput()
    {
        return m_user_input;
    }
    
    virtual bool
    GetSaveUserInput()
    {
        return false;
    }

    // Subclasses _can_ override this function to get input as it comes in
    // without any granularity
    virtual size_t
    HandleRawBytes (const char *bytes, size_t bytes_len);

    Debugger &
    GetDebugger()
    {
        return m_debugger;
    }

    bool 
    IsActive () const
    {
        return m_active;
    }

    const char *
    GetPrompt () const;

    void
    RefreshPrompt();
    
    // If you want to read from an input reader synchronously, then just initialize the
    // reader and then call WaitOnReaderIsDone, which will return when the reader is popped.
    void
    WaitOnReaderIsDone ();

    static const char *
    GranularityAsCString (lldb::InputReaderGranularity granularity);

protected:
    friend class Debugger;

    void
    Notify (lldb::InputReaderAction notification);

    Debugger &m_debugger;
    Callback m_callback;
    void *m_callback_baton;
    std::string m_end_token;
    std::string m_prompt;
    lldb::InputReaderGranularity m_granularity;
    bool m_done;
    bool m_echo;
    bool m_active;
    Predicate<bool> m_reader_done;
    StringList m_user_input;
    bool m_save_user_input;

private:
    DISALLOW_COPY_AND_ASSIGN (InputReader);

};

} // namespace lldb_private

#endif // #ifndef liblldb_InputReader_h_