llvm-project/lldb/include/lldb/Core/InputReader.h

//===-- 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_