4f4c5fcfdf
This is a combination of running clang-tidy with modernize-use-nullptr check for some ports (GTK, X11, OSX) and manual changes to the ports for which it couldn't be used easily (MSW, DFB) and also manually updating the docs. Also replace NULL with null or nullptr in the comments as this is more consistent with the use of nullptr in the code and makes it simpler to grep for the remaining occurrences of NULL itself. And also use null in the assert messages. Only a few occurrences of "NULL" are still left in non-C files, mostly corresponding to unclear comments or string output which it might not be safe to change.
136 lines
4 KiB
C++
136 lines
4 KiB
C++
///////////////////////////////////////////////////////////////////////////////
|
|
// Name: wx/unix/private/executeiohandler.h
|
|
// Purpose: IO handler class for the FD used by wxExecute() under Unix
|
|
// Author: Rob Bresalier, Vadim Zeitlin
|
|
// Created: 2013-01-06
|
|
// Copyright: (c) 2013 Rob Bresalier, Vadim Zeitlin
|
|
// Licence: wxWindows licence
|
|
///////////////////////////////////////////////////////////////////////////////
|
|
|
|
#ifndef _WX_UNIX_PRIVATE_EXECUTEIOHANDLER_H_
|
|
#define _WX_UNIX_PRIVATE_EXECUTEIOHANDLER_H_
|
|
|
|
#include "wx/private/streamtempinput.h"
|
|
|
|
// This class handles IO events on the pipe FD connected to the child process
|
|
// stdout/stderr and is used by wxExecute().
|
|
//
|
|
// Currently it can derive from either wxEventLoopSourceHandler or
|
|
// wxFDIOHandler depending on the kind of dispatcher/event loop it is used
|
|
// with. In the future, when we get rid of wxFDIOHandler entirely, it will
|
|
// derive from wxEventLoopSourceHandler only.
|
|
template <class T>
|
|
class wxExecuteIOHandlerBase : public T
|
|
{
|
|
public:
|
|
wxExecuteIOHandlerBase(int fd, wxStreamTempInputBuffer& buf)
|
|
: m_fd(fd),
|
|
m_buf(buf)
|
|
{
|
|
m_callbackDisabled = false;
|
|
}
|
|
|
|
// Called when the associated descriptor is available for reading.
|
|
virtual void OnReadWaiting() override
|
|
{
|
|
// Sync process, process all data coming at us from the pipe so that
|
|
// the pipe does not get full and cause a deadlock situation.
|
|
m_buf.Update();
|
|
|
|
if ( m_buf.Eof() )
|
|
DisableCallback();
|
|
}
|
|
|
|
// These methods are never called as we only monitor the associated FD for
|
|
// reading, but we still must implement them as they're pure virtual in the
|
|
// base class.
|
|
virtual void OnWriteWaiting() override { }
|
|
virtual void OnExceptionWaiting() override { }
|
|
|
|
// Disable any future calls to our OnReadWaiting(), can be called when
|
|
// we're sure that no more input is forthcoming.
|
|
void DisableCallback()
|
|
{
|
|
if ( !m_callbackDisabled )
|
|
{
|
|
m_callbackDisabled = true;
|
|
|
|
DoDisable();
|
|
}
|
|
}
|
|
|
|
protected:
|
|
const int m_fd;
|
|
|
|
private:
|
|
virtual void DoDisable() = 0;
|
|
|
|
wxStreamTempInputBuffer& m_buf;
|
|
|
|
// If true, DisableCallback() had been already called.
|
|
bool m_callbackDisabled;
|
|
|
|
wxDECLARE_NO_COPY_CLASS(wxExecuteIOHandlerBase);
|
|
};
|
|
|
|
// This is the version used with wxFDIODispatcher, which must be passed to the
|
|
// ctor in order to register this handler with it.
|
|
class wxExecuteFDIOHandler : public wxExecuteIOHandlerBase<wxFDIOHandler>
|
|
{
|
|
public:
|
|
wxExecuteFDIOHandler(wxFDIODispatcher& dispatcher,
|
|
int fd,
|
|
wxStreamTempInputBuffer& buf)
|
|
: wxExecuteIOHandlerBase<wxFDIOHandler>(fd, buf),
|
|
m_dispatcher(dispatcher)
|
|
{
|
|
dispatcher.RegisterFD(fd, this, wxFDIO_INPUT);
|
|
}
|
|
|
|
virtual ~wxExecuteFDIOHandler()
|
|
{
|
|
DisableCallback();
|
|
}
|
|
|
|
private:
|
|
virtual void DoDisable() override
|
|
{
|
|
m_dispatcher.UnregisterFD(m_fd);
|
|
}
|
|
|
|
wxFDIODispatcher& m_dispatcher;
|
|
|
|
wxDECLARE_NO_COPY_CLASS(wxExecuteFDIOHandler);
|
|
};
|
|
|
|
// And this is the version used with an event loop. As AddSourceForFD() is
|
|
// static, we don't require passing the event loop to the ctor but an event
|
|
// loop must be running to handle our events.
|
|
class wxExecuteEventLoopSourceHandler
|
|
: public wxExecuteIOHandlerBase<wxEventLoopSourceHandler>
|
|
{
|
|
public:
|
|
wxExecuteEventLoopSourceHandler(int fd, wxStreamTempInputBuffer& buf)
|
|
: wxExecuteIOHandlerBase<wxEventLoopSourceHandler>(fd, buf)
|
|
{
|
|
m_source = wxEventLoop::AddSourceForFD(fd, this, wxEVENT_SOURCE_INPUT);
|
|
}
|
|
|
|
virtual ~wxExecuteEventLoopSourceHandler()
|
|
{
|
|
DisableCallback();
|
|
}
|
|
|
|
private:
|
|
virtual void DoDisable() override
|
|
{
|
|
delete m_source;
|
|
m_source = nullptr;
|
|
}
|
|
|
|
wxEventLoopSource* m_source;
|
|
|
|
wxDECLARE_NO_COPY_CLASS(wxExecuteEventLoopSourceHandler);
|
|
};
|
|
|
|
#endif // _WX_UNIX_PRIVATE_EXECUTEIOHANDLER_H_
|