X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/9243700fb212c2508c4d4c80fb8eb968e565e44d..4b5e178a4c22caac92952131632641c63821fc0c:/src/unix/utilsunx.cpp diff --git a/src/unix/utilsunx.cpp b/src/unix/utilsunx.cpp index 2b5056af5f..426da9a340 100644 --- a/src/unix/utilsunx.cpp +++ b/src/unix/utilsunx.cpp @@ -39,8 +39,12 @@ #include "wx/process.h" #include "wx/thread.h" +#include "wx/cmdline.h" + #include "wx/wfstream.h" +#include "wx/private/selectdispatcher.h" +#include "wx/private/fdiodispatcher.h" #include "wx/unix/execute.h" #include "wx/unix/private.h" @@ -65,8 +69,6 @@ #endif // HAS_PIPE_INPUT_STREAM -#if wxUSE_BASE - #if defined(__MWERKS__) && defined(__MACH__) #ifndef WXWIN_OS_DESCRIPTION #define WXWIN_OS_DESCRIPTION "MacOS X" @@ -263,106 +265,80 @@ int wxKill(long pid, wxSignal sig, wxKillError *rc, int flags) return err; } -#define WXEXECUTE_NARGS 127 - -#if defined(__DARWIN__) -long wxMacExecute(wxChar **argv, - int flags, - wxProcess *process); -#endif - -long wxExecute( const wxString& command, int flags, wxProcess *process ) +// Shutdown or reboot the PC +bool wxShutdown(int flags) { - wxCHECK_MSG( !command.empty(), 0, wxT("can't exec empty command") ); + flags &= ~wxSHUTDOWN_FORCE; - wxLogTrace(wxT("exec"), wxT("Executing \"%s\""), command.c_str()); + wxChar level; + switch ( flags ) + { + case wxSHUTDOWN_POWEROFF: + level = _T('0'); + break; -#if wxUSE_THREADS - // fork() doesn't mix well with POSIX threads: on many systems the program - // deadlocks or crashes for some reason. Probably our code is buggy and - // doesn't do something which must be done to allow this to work, but I - // don't know what yet, so for now just warn the user (this is the least we - // can do) about it - wxASSERT_MSG( wxThread::IsMain(), - _T("wxExecute() can be called only from the main thread") ); -#endif // wxUSE_THREADS + case wxSHUTDOWN_REBOOT: + level = _T('6'); + break; - int argc = 0; - wxChar *argv[WXEXECUTE_NARGS]; - wxString argument; - const wxChar *cptr = command.c_str(); - wxChar quotechar = wxT('\0'); // is arg quoted? - bool escaped = false; + case wxSHUTDOWN_LOGOFF: + // TODO: use dcop to log off? + return false; - // split the command line in arguments - do - { - argument = wxEmptyString; - quotechar = wxT('\0'); + default: + wxFAIL_MSG( _T("unknown wxShutdown() flag") ); + return false; + } - // eat leading whitespace: - while ( wxIsspace(*cptr) ) - cptr++; + return system(wxString::Format("init %c", level).mb_str()) == 0; +} - if ( *cptr == wxT('\'') || *cptr == wxT('"') ) - quotechar = *cptr++; +// ---------------------------------------------------------------------------- +// wxStream classes to support IO redirection in wxExecute +// ---------------------------------------------------------------------------- - do - { - if ( *cptr == wxT('\\') && ! escaped ) - { - escaped = true; - cptr++; - continue; - } +#if HAS_PIPE_INPUT_STREAM - // all other characters: - argument += *cptr++; - escaped = false; +bool wxPipeInputStream::CanRead() const +{ + if ( m_lasterror == wxSTREAM_EOF ) + return false; - // have we reached the end of the argument? - if ( (*cptr == quotechar && ! escaped) - || (quotechar == wxT('\0') && wxIsspace(*cptr)) - || *cptr == wxT('\0') ) - { - wxASSERT_MSG( argc < WXEXECUTE_NARGS, - wxT("too many arguments in wxExecute") ); + // check if there is any input available + struct timeval tv; + tv.tv_sec = 0; + tv.tv_usec = 0; - argv[argc] = new wxChar[argument.length() + 1]; - wxStrcpy(argv[argc], argument.c_str()); - argc++; + const int fd = m_file->fd(); - // if not at end of buffer, swallow last character: - if(*cptr) - cptr++; + fd_set readfds; - break; // done with this one, start over - } - } while(*cptr); - } while(*cptr); - argv[argc] = NULL; + wxFD_ZERO(&readfds); + wxFD_SET(fd, &readfds); - long lRc; -#if defined(__DARWIN__) - // wxMacExecute only executes app bundles. - // It returns an error code if the target is not an app bundle, thus falling - // through to the regular wxExecute for non app bundles. - lRc = wxMacExecute(argv, flags, process); - if( lRc != ((flags & wxEXEC_SYNC) ? -1 : 0)) - return lRc; -#endif + switch ( select(fd + 1, &readfds, NULL, NULL, &tv) ) + { + case -1: + wxLogSysError(_("Impossible to get child process input")); + // fall through - // do execute the command - lRc = wxExecute(argv, flags, process); + case 0: + return false; - // clean up - argc = 0; - while( argv[argc] ) - delete [] argv[argc++]; + default: + wxFAIL_MSG(_T("unexpected select() return value")); + // still fall through - return lRc; + case 1: + // input available -- or maybe not, as select() returns 1 when a + // read() will complete without delay, but it could still not read + // anything + return !Eof(); + } } +#endif // HAS_PIPE_INPUT_STREAM + // ---------------------------------------------------------------------------- // wxShell // ---------------------------------------------------------------------------- @@ -396,79 +372,97 @@ bool wxShell(const wxString& command, wxArrayString& output) return wxExecute(wxMakeShellCommand(command), output); } -// Shutdown or reboot the PC -bool wxShutdown(wxShutdownFlags wFlags) +namespace { - wxChar level; - switch ( wFlags ) + +// helper class for storing arguments as char** array suitable for passing to +// execvp(), whatever form they were passed to us +class ArgsArray +{ +public: + ArgsArray(const wxArrayString& args) { - case wxSHUTDOWN_POWEROFF: - level = _T('0'); - break; + Init(args.size()); - case wxSHUTDOWN_REBOOT: - level = _T('6'); - break; + for ( int i = 0; i < m_argc; i++ ) + { + m_argv[i] = wxStrdup(args[i]); + } + } - default: - wxFAIL_MSG( _T("unknown wxShutdown() flag") ); - return false; +#if wxUSE_UNICODE + ArgsArray(wchar_t **wargv) + { + int argc = 0; + while ( *wargv++ ) + argc++; + + Init(argc); + + for ( int i = 0; i < m_argc; i++ ) + { + m_argv[i] = wxSafeConvertWX2MB(wargv[i]).release(); + } } +#endif // wxUSE_UNICODE - return system(wxString::Format(_T("init %c"), level).mb_str()) == 0; -} + ~ArgsArray() + { + for ( int i = 0; i < m_argc; i++ ) + { + free(m_argv[i]); + } -// ---------------------------------------------------------------------------- -// wxStream classes to support IO redirection in wxExecute -// ---------------------------------------------------------------------------- + delete [] m_argv; + } -#if HAS_PIPE_INPUT_STREAM + operator char**() const { return m_argv; } -bool wxPipeInputStream::CanRead() const -{ - if ( m_lasterror == wxSTREAM_EOF ) - return false; +private: + void Init(int argc) + { + m_argc = argc; + m_argv = new char *[m_argc + 1]; + m_argv[m_argc] = NULL; + } - // check if there is any input available - struct timeval tv; - tv.tv_sec = 0; - tv.tv_usec = 0; + int m_argc; + char **m_argv; - const int fd = m_file->fd(); + DECLARE_NO_COPY_CLASS(ArgsArray) +}; - fd_set readfds; +} // anonymous namespace - wxFD_ZERO(&readfds); - wxFD_SET(fd, &readfds); +// ---------------------------------------------------------------------------- +// wxExecute implementations +// ---------------------------------------------------------------------------- - switch ( select(fd + 1, &readfds, NULL, NULL, &tv) ) - { - case -1: - wxLogSysError(_("Impossible to get child process input")); - // fall through +#if defined(__DARWIN__) +bool wxMacLaunch(char **argv); +#endif - case 0: - return false; +long wxExecute(const wxString& command, int flags, wxProcess *process) +{ + ArgsArray argv(wxCmdLineParser::ConvertStringToArgs(command, + wxCMD_LINE_SPLIT_UNIX)); - default: - wxFAIL_MSG(_T("unexpected select() return value")); - // still fall through + return wxExecute(argv, flags, process); +} - case 1: - // input available -- or maybe not, as select() returns 1 when a - // read() will complete without delay, but it could still not read - // anything - return !Eof(); - } +#if wxUSE_UNICODE + +long wxExecute(wchar_t **wargv, int flags, wxProcess *process) +{ + ArgsArray argv(wargv); + + return wxExecute(argv, flags, process); } -#endif // HAS_PIPE_INPUT_STREAM +#endif // wxUSE_UNICODE -// ---------------------------------------------------------------------------- // wxExecute: the real worker function -// ---------------------------------------------------------------------------- - -long wxExecute(wxChar **argv, int flags, wxProcess *process) +long wxExecute(char **argv, int flags, wxProcess *process) { // for the sync execution, we return -1 to indicate failure, but for async // case we return 0 which is never a valid PID @@ -479,49 +473,38 @@ long wxExecute(wxChar **argv, int flags, wxProcess *process) wxCHECK_MSG( *argv, ERROR_RETURN_CODE, wxT("can't exec empty command") ); -#if wxUSE_UNICODE - int mb_argc = 0; - char *mb_argv[WXEXECUTE_NARGS]; +#if wxUSE_THREADS + // fork() doesn't mix well with POSIX threads: on many systems the program + // deadlocks or crashes for some reason. Probably our code is buggy and + // doesn't do something which must be done to allow this to work, but I + // don't know what yet, so for now just warn the user (this is the least we + // can do) about it + wxASSERT_MSG( wxThread::IsMain(), + _T("wxExecute() can be called only from the main thread") ); +#endif // wxUSE_THREADS - while (argv[mb_argc]) +#if defined(__WXCOCOA__) || ( defined(__WXOSX_MAC__) && wxOSX_USE_COCOA_OR_CARBON ) + // wxMacLaunch() only executes app bundles and only does it asynchronously. + // It returns false if the target is not an app bundle, thus falling + // through to the regular code for non app bundles. + if ( !(flags & wxEXEC_SYNC) && wxMacLaunch(argv) ) { - wxWX2MBbuf mb_arg = wxSafeConvertWX2MB(argv[mb_argc]); - mb_argv[mb_argc] = strdup(mb_arg); - mb_argc++; + // we don't have any PID to return so just make up something non null + return -1; } - mb_argv[mb_argc] = (char *) NULL; - - // this macro will free memory we used above - #define ARGS_CLEANUP \ - for ( mb_argc = 0; mb_argv[mb_argc]; mb_argc++ ) \ - free(mb_argv[mb_argc]) -#else // ANSI - // no need for cleanup - #define ARGS_CLEANUP - - wxChar **mb_argv = argv; -#endif // Unicode/ANSI - - // we want this function to work even if there is no wxApp so ensure that - // we have a valid traits pointer - wxConsoleAppTraits traitsConsole; - wxAppTraits *traits = wxTheApp ? wxTheApp->GetTraits() : NULL; - if ( !traits ) - traits = &traitsConsole; - - // this struct contains all information which we pass to and from - // wxAppTraits methods +#endif // __DARWIN__ + + + // this struct contains all information which we use for housekeeping wxExecuteData execData; execData.flags = flags; execData.process = process; // create pipes - if ( !traits->CreateEndProcessPipe(execData) ) + if ( !execData.pipeEndProcDetect.Create() ) { wxLogError( _("Failed to execute '%s'\n"), *argv ); - ARGS_CLEANUP; - return ERROR_RETURN_CODE; } @@ -536,8 +519,6 @@ long wxExecute(wxChar **argv, int flags, wxProcess *process) { wxLogError( _("Failed to execute '%s'\n"), *argv ); - ARGS_CLEANUP; - return ERROR_RETURN_CODE; } } @@ -557,36 +538,14 @@ long wxExecute(wxChar **argv, int flags, wxProcess *process) { wxLogSysError( _("Fork failed") ); - ARGS_CLEANUP; - return ERROR_RETURN_CODE; } else if ( pid == 0 ) // we're in child { - // These lines close the open file descriptors to to avoid any - // input/output which might block the process or irritate the user. If - // one wants proper IO for the subprocess, the right thing to do is to - // start an xterm executing it. - if ( !(flags & wxEXEC_SYNC) ) - { - // FD_SETSIZE is unsigned under BSD, signed under other platforms - // so we need a cast to avoid warnings on all platforms - for ( int fd = 0; fd < (int)FD_SETSIZE; fd++ ) - { - if ( fd == pipeIn[wxPipe::Read] - || fd == pipeOut[wxPipe::Write] - || fd == pipeErr[wxPipe::Write] - || traits->IsWriteFDOfEndProcessPipe(execData, fd) ) - { - // don't close this one, we still need it - continue; - } - - // leave stderr opened too, it won't do any harm - if ( fd != STDERR_FILENO ) - close(fd); - } - } + // NB: we used to close all the unused descriptors of the child here + // but this broke some programs which relied on e.g. FD 1 being + // always opened so don't do it any more, after all there doesn't + // seem to be any real problem with keeping them opened #if !defined(__VMS) && !defined(__EMX__) if ( flags & wxEXEC_MAKE_GROUP_LEADER ) @@ -598,8 +557,10 @@ long wxExecute(wxChar **argv, int flags, wxProcess *process) #endif // !__VMS // reading side can be safely closed but we should keep the write one - // opened - traits->DetachWriteFDOfEndProcessPipe(execData); + // opened, it will be only closed when the process terminates resulting + // in a read notification to the parent + execData.pipeEndProcDetect.Detach(wxPipe::Write); + execData.pipeEndProcDetect.Close(); // redirect stdin, stdout and stderr if ( pipeIn.IsOk() ) @@ -616,12 +577,11 @@ long wxExecute(wxChar **argv, int flags, wxProcess *process) pipeErr.Close(); } - execvp (*mb_argv, mb_argv); + execvp(*argv, argv); fprintf(stderr, "execvp("); - // CS changed ppc to ppc_ as ppc is not available under mac os CW Mach-O - for ( char **ppc_ = mb_argv; *ppc_; ppc_++ ) - fprintf(stderr, "%s%s", ppc_ == mb_argv ? "" : ", ", *ppc_); + for ( char **a = argv; *a; a++ ) + fprintf(stderr, "%s%s", a == argv ? "" : ", ", *a); fprintf(stderr, ") failed with error %d!\n", errno); // there is no return after successful exec() @@ -639,8 +599,6 @@ long wxExecute(wxChar **argv, int flags, wxProcess *process) } else // we're in parent { - ARGS_CLEANUP; - // save it for WaitForChild() use execData.pid = pid; @@ -651,19 +609,17 @@ long wxExecute(wxChar **argv, int flags, wxProcess *process) // called bufOut and not bufIn wxStreamTempInputBuffer bufOut, bufErr; -#endif // HAS_PIPE_INPUT_STREAM if ( process && process->IsRedirected() ) { -#if HAS_PIPE_INPUT_STREAM wxOutputStream *inStream = new wxFileOutputStream(pipeIn.Detach(wxPipe::Write)); - wxPipeInputStream *outStream = - new wxPipeInputStream(pipeOut.Detach(wxPipe::Read)); + const int fdOut = pipeOut.Detach(wxPipe::Read); + wxPipeInputStream *outStream = new wxPipeInputStream(fdOut); - wxPipeInputStream *errStream = - new wxPipeInputStream(pipeErr.Detach(wxPipe::Read)); + const int fdErr = pipeErr.Detach(wxPipe::Read); + wxPipeInputStream *errStream = new wxPipeInputStream(fdErr); process->SetPipeStreams(outStream, inStream, errStream); @@ -672,8 +628,11 @@ long wxExecute(wxChar **argv, int flags, wxProcess *process) execData.bufOut = &bufOut; execData.bufErr = &bufErr; -#endif // HAS_PIPE_INPUT_STREAM + + execData.fdOut = fdOut; + execData.fdErr = fdErr; } +#endif // HAS_PIPE_INPUT_STREAM if ( pipeIn.IsOk() ) { @@ -682,6 +641,13 @@ long wxExecute(wxChar **argv, int flags, wxProcess *process) pipeErr.Close(); } + // we want this function to work even if there is no wxApp so ensure + // that we have a valid traits pointer + wxConsoleAppTraits traitsConsole; + wxAppTraits *traits = wxTheApp ? wxTheApp->GetTraits() : NULL; + if ( !traits ) + traits = &traitsConsole; + return traits->WaitForChild(execData); } @@ -691,7 +657,6 @@ long wxExecute(wxChar **argv, int flags, wxProcess *process) } #undef ERROR_RETURN_CODE -#undef ARGS_CLEANUP // ---------------------------------------------------------------------------- // file and directory functions @@ -792,16 +757,14 @@ static bool wxGetHostNameInternal(wxChar *buf, int sz) bool ok = uname(&uts) != -1; if ( ok ) { - wxStrncpy(buf, wxSafeConvertMB2WX(uts.nodename), sz - 1); - buf[sz] = wxT('\0'); + wxStrlcpy(buf, wxSafeConvertMB2WX(uts.nodename), sz); } #elif defined(HAVE_GETHOSTNAME) char cbuf[sz]; bool ok = gethostname(cbuf, sz) != -1; if ( ok ) { - wxStrncpy(buf, wxSafeConvertMB2WX(cbuf), sz - 1); - buf[sz] = wxT('\0'); + wxStrlcpy(buf, wxSafeConvertMB2WX(cbuf), sz); } #else // no uname, no gethostname wxFAIL_MSG(wxT("don't know host name for this machine")); @@ -854,7 +817,7 @@ bool wxGetFullHostName(wxChar *buf, int sz) else { // the canonical name - wxStrncpy(buf, wxSafeConvertMB2WX(host->h_name), sz); + wxStrlcpy(buf, wxSafeConvertMB2WX(host->h_name), sz); } } //else: it's already a FQDN (BSD behaves this way) @@ -870,7 +833,7 @@ bool wxGetUserId(wxChar *buf, int sz) *buf = wxT('\0'); if ((who = getpwuid(getuid ())) != NULL) { - wxStrncpy (buf, wxSafeConvertMB2WX(who->pw_name), sz - 1); + wxStrlcpy (buf, wxSafeConvertMB2WX(who->pw_name), sz); return true; } @@ -888,7 +851,7 @@ bool wxGetUserName(wxChar *buf, int sz) char *comma = strchr(who->pw_gecos, ','); if (comma) *comma = '\0'; // cut off non-name comment fields - wxStrncpy (buf, wxSafeConvertMB2WX(who->pw_gecos), sz - 1); + wxStrlcpy(buf, wxSafeConvertMB2WX(who->pw_gecos), sz); return true; } @@ -1220,320 +1183,263 @@ bool wxHandleFatalExceptions(bool doit) #endif // wxUSE_ON_FATAL_EXCEPTION -#endif // wxUSE_BASE - -#ifdef __DARWIN__ - #include -#endif // ---------------------------------------------------------------------------- // wxExecute support // ---------------------------------------------------------------------------- -/* - NOTE: If this proves not to work well for wxMac then move back to the old - behavior. If, however, it proves to work just fine, nuke all of the code - for the old behavior. I strongly suggest backporting this to 2.8 as well. - However, beware that while you can nuke the old code here, you cannot - nuke the wxAddProcessCallbackForPid from the 2.8 branch (found in - utilsexc_cf since it's an exported symbol). - */ -// #define USE_OLD_DARWIN_END_PROCESS_DETECT (defined(__DARWIN__) && defined(__WXMAC__)) -#define USE_OLD_DARWIN_END_PROCESS_DETECT 0 - -// wxMac/wxCocoa don't use the same process end detection mechanisms so we don't -// need wxExecute-related helpers for them -#if !USE_OLD_DARWIN_END_PROCESS_DETECT - -bool wxAppTraits::CreateEndProcessPipe(wxExecuteData& execData) +int wxAppTraits::AddProcessCallback(wxEndProcessData *data, int fd) { - return execData.pipeEndProcDetect.Create(); -} + // define a custom handler processing only the closure of the descriptor + struct wxEndProcessFDIOHandler : public wxFDIOHandler + { + wxEndProcessFDIOHandler(wxEndProcessData *data, int fd) + : m_data(data), m_fd(fd) + { + } -bool wxAppTraits::IsWriteFDOfEndProcessPipe(wxExecuteData& execData, int fd) -{ - return fd == (execData.pipeEndProcDetect)[wxPipe::Write]; -} + virtual void OnReadWaiting() + { + wxFDIODispatcher::Get()->UnregisterFD(m_fd); + close(m_fd); -void wxAppTraits::DetachWriteFDOfEndProcessPipe(wxExecuteData& execData) -{ - execData.pipeEndProcDetect.Detach(wxPipe::Write); - execData.pipeEndProcDetect.Close(); -} + wxHandleProcessTermination(m_data); -#else // !Darwin + delete this; + } -bool wxAppTraits::CreateEndProcessPipe(wxExecuteData& WXUNUSED(execData)) -{ - return true; + virtual void OnWriteWaiting() { wxFAIL_MSG("unreachable"); } + virtual void OnExceptionWaiting() { wxFAIL_MSG("unreachable"); } + + wxEndProcessData * const m_data; + const int m_fd; + }; + + wxFDIODispatcher::Get()->RegisterFD + ( + fd, + new wxEndProcessFDIOHandler(data, fd), + wxFDIO_INPUT + ); + return fd; // unused, but return something unique for the tag } -bool -wxAppTraits::IsWriteFDOfEndProcessPipe(wxExecuteData& WXUNUSED(execData), - int WXUNUSED(fd)) +bool wxAppTraits::CheckForRedirectedIO(wxExecuteData& execData) { +#if HAS_PIPE_INPUT_STREAM + bool hasIO = false; + + if ( execData.bufOut && execData.bufOut->Update() ) + hasIO = true; + + if ( execData.bufErr && execData.bufErr->Update() ) + hasIO = true; + + return hasIO; +#else // !HAS_PIPE_INPUT_STREAM return false; +#endif // HAS_PIPE_INPUT_STREAM/!HAS_PIPE_INPUT_STREAM } -void -wxAppTraits::DetachWriteFDOfEndProcessPipe(wxExecuteData& WXUNUSED(execData)) +// helper classes/functions used by WaitForChild() +namespace { - // nothing to do here, we don't use the pipe -} -#endif // !Darwin/Darwin - -#if wxUSE_GUI - -int wxGUIAppTraits::WaitForChild(wxExecuteData& execData) +// convenient base class for IO handlers which are registered for read +// notifications only and which also stores the FD we're reading from +// +// the derived classes still have to implement OnReadWaiting() +class wxReadFDIOHandler : public wxFDIOHandler { - wxEndProcessData *endProcData = new wxEndProcessData; +public: + wxReadFDIOHandler(wxFDIODispatcher& disp, int fd) : m_fd(fd) + { + if ( fd ) + disp.RegisterFD(fd, this, wxFDIO_INPUT); + } - const int flags = execData.flags; + virtual void OnWriteWaiting() { wxFAIL_MSG("unreachable"); } + virtual void OnExceptionWaiting() { wxFAIL_MSG("unreachable"); } - // wxAddProcessCallback is now (with DARWIN) allowed to call the - // callback function directly if the process terminates before - // the callback can be added to the run loop. Set up the endProcData. - if ( flags & wxEXEC_SYNC ) - { - // we may have process for capturing the program output, but it's - // not used in wxEndProcessData in the case of sync execution - endProcData->process = NULL; +protected: + const int m_fd; - // sync execution: indicate it by negating the pid - endProcData->pid = -execData.pid; - } - else + DECLARE_NO_COPY_CLASS(wxReadFDIOHandler) +}; + +// class for monitoring our end of the process detection pipe, simply sets a +// flag when input on the pipe (which must be due to EOF) is detected +class wxEndHandler : public wxReadFDIOHandler +{ +public: + wxEndHandler(wxFDIODispatcher& disp, int fd) + : wxReadFDIOHandler(disp, fd) { - // async execution, nothing special to do -- caller will be - // notified about the process termination if process != NULL, endProcData - // will be deleted in GTK_EndProcessDetector - endProcData->process = execData.process; - endProcData->pid = execData.pid; + m_terminated = false; } + bool Terminated() const { return m_terminated; } - if ( !(flags & wxEXEC_NOEVENTS) ) - { -#if USE_OLD_DARWIN_END_PROCESS_DETECT - endProcData->tag = wxAddProcessCallbackForPid(endProcData, execData.pid); -#else - endProcData->tag = wxAddProcessCallback - ( - endProcData, - execData.pipeEndProcDetect.Detach(wxPipe::Read) - ); + virtual void OnReadWaiting() { m_terminated = true; } - execData.pipeEndProcDetect.Close(); -#endif // USE_OLD_DARWIN_END_PROCESS_DETECT - } +private: + bool m_terminated; - if ( flags & wxEXEC_SYNC ) - { - wxBusyCursor bc; - int exitcode = 0; + DECLARE_NO_COPY_CLASS(wxEndHandler) +}; - wxWindowDisabler *wd = flags & (wxEXEC_NODISABLE | wxEXEC_NOEVENTS) - ? NULL - : new wxWindowDisabler; +#if HAS_PIPE_INPUT_STREAM - if ( flags & wxEXEC_NOEVENTS ) - { - // just block waiting for the child to exit - int status = 0; - - int result = waitpid(execData.pid, &status, 0); -#ifdef __DARWIN__ - /* DE: waitpid manpage states that waitpid can fail with EINTR - if the call is interrupted by a caught signal. I suppose - that means that this ought to be a while loop. - - The odd thing is that it seems to fail EVERY time. It fails - with a quickly exiting process (e.g. echo), and fails with a - slowly exiting process (e.g. sleep 2) but clearly after - having waited for the child to exit. Maybe it's a bug in - my particular version. - - It works, however, from the CFSocket callback without this - trick but in that case it's used only after CFSocket calls - the callback and with the WNOHANG flag which would seem to - preclude it from being interrupted or at least make it much - less likely since it would not then be waiting. - - If Darwin's man page is to be believed then this is definitely - necessary. It's just weird that I've never seen it before - and apparently no one else has either or you'd think they'd - have reported it by now. Perhaps blocking the GUI while - waiting for a child process to exit is simply not that common. - */ - if(result == -1 && errno == EINTR) - { - result = waitpid(execData.pid, &status, 0); - } +// class for monitoring our ends of child stdout/err, should be constructed +// with the FD and stream from wxExecuteData and will do nothing if they're +// invalid +// +// unlike wxEndHandler this class registers itself with the provided dispatcher +class wxRedirectedIOHandler : public wxReadFDIOHandler +{ +public: + wxRedirectedIOHandler(wxFDIODispatcher& disp, + int fd, + wxStreamTempInputBuffer *buf) + : wxReadFDIOHandler(disp, fd), + m_buf(buf) + { + } -#endif + virtual void OnReadWaiting() + { + m_buf->Update(); + } - if ( result == -1 ) - { - wxLogLastError(_T("waitpid")); - exitcode = -1; - } - else - { - wxASSERT_MSG( result == execData.pid, - _T("unexpected waitpid() return value") ); - - if ( WIFEXITED(status) ) - { - exitcode = WEXITSTATUS(status); - } - else // abnormal termination? - { - wxASSERT_MSG( WIFSIGNALED(status), - _T("unexpected child wait status") ); - exitcode = -1; - } - } - } - else // !wxEXEC_NOEVENTS - { - // endProcData->pid will be set to 0 from - // wxHandleProcessTermination when the process terminates - while ( endProcData->pid != 0 ) - { - bool idle = true; +private: + wxStreamTempInputBuffer * const m_buf; + + DECLARE_NO_COPY_CLASS(wxRedirectedIOHandler) +}; -#if HAS_PIPE_INPUT_STREAM - if ( execData.bufOut ) - { - execData.bufOut->Update(); - idle = false; - } - - if ( execData.bufErr ) - { - execData.bufErr->Update(); - idle = false; - } #endif // HAS_PIPE_INPUT_STREAM - // don't consume 100% of the CPU while we're sitting in this - // loop - if ( idle ) - wxMilliSleep(1); +// helper function which calls waitpid() and analyzes the result +int DoWaitForChild(int pid, int flags = 0) +{ + wxASSERT_MSG( pid > 0, "invalid PID" ); - // give GTK+ a chance to call GTK_EndProcessDetector here and - // also repaint the GUI - wxYield(); - } + int status, rc; - exitcode = endProcData->exitcode; - } + // loop while we're getting EINTR + for ( ;; ) + { + rc = waitpid(pid, &status, flags); - delete wd; - delete endProcData; + if ( rc != -1 || errno != EINTR ) + break; + } - return exitcode; + if ( rc == 0 ) + { + // This can only happen if the child application closes our dummy pipe + // that is used to monitor its lifetime; in that case, our best bet is + // to pretend the process did terminate, because otherwise wxExecute() + // would hang indefinitely (OnReadWaiting() won't be called again, the + // descriptor is closed now). + wxLogDebug("Child process (PID %d) still alive but pipe closed so " + "generating a close notification", pid); } - else // async execution + else if ( rc == -1 ) { - return execData.pid; + wxLogLastError(wxString::Format("waitpid(%d)", pid)); } -} - -#endif //wxUSE_GUI + else // child did terminate + { + wxASSERT_MSG( rc == pid, "unexpected waitpid() return value" ); -#if wxUSE_BASE + if ( WIFEXITED(status) ) + return WEXITSTATUS(status); + else if ( WIFSIGNALED(status) ) + return -WTERMSIG(status); + else + { + wxLogError("Child process (PID %d) exited for unknown reason, " + "status = %d", pid, status); + } + } -#ifdef wxHAS_GENERIC_PROCESS_CALLBACK -struct wxEndProcessFDIOHandler : public wxFDIOHandler -{ - wxEndProcessFDIOHandler(wxEndProcessData *data, int fd) - : m_data(data), m_fd(fd) - {} + return -1; +} - virtual void OnReadWaiting() - { wxFAIL_MSG("this isn't supposed to happen"); } - virtual void OnWriteWaiting() - { wxFAIL_MSG("this isn't supposed to happen"); } +} // anonymous namespace - virtual void OnExceptionWaiting() +int wxAppTraits::WaitForChild(wxExecuteData& execData) +{ + if ( !(execData.flags & wxEXEC_SYNC) ) { - int pid = (m_data->pid > 0) ? m_data->pid : -(m_data->pid); - int status = 0; - - // has the process really terminated? - int rc = waitpid(pid, &status, WNOHANG); - if ( rc == 0 ) - { - // This can only happen if the child application closes our dummy - // pipe that is used to monitor its lifetime; in that case, our - // best bet is to pretend the process did terminate, because - // otherwise wxExecute() would hang indefinitely - // (OnExceptionWaiting() won't be called again, the descriptor - // is closed now). - wxLogDebug("Child process (PID %i) still alive, even though notification was received that it terminated.", pid); - } - else if ( rc == -1 ) - { - // As above, if waitpid() fails, the best we can do is to log the - // error and pretend the child terminated: - wxLogSysError(_("Failed to check child process' status")); - } + // asynchronous execution: just launch the process and return, + // endProcData will be destroyed when it terminates (currently we leak + // it if the process doesn't terminate before we do and this should be + // fixed but it's not a real leak so it's not really very high + // priority) + wxEndProcessData *endProcData = new wxEndProcessData; + endProcData->process = execData.process; + endProcData->pid = execData.pid; + endProcData->tag = AddProcessCallback + ( + endProcData, + execData.GetEndProcReadFD() + ); + endProcData->async = true; - // set exit code to -1 if something bad happened - m_data->exitcode = (rc > 0 && WIFEXITED(status)) - ? WEXITSTATUS(status) - : -1; + return execData.pid; + } + //else: synchronous execution case - wxLogTrace("exec", - "Child process (PID %i) terminated with exit code %i", - pid, m_data->exitcode); +#if HAS_PIPE_INPUT_STREAM + wxProcess * const process = execData.process; + if ( process && process->IsRedirected() ) + { + // we can't simply block waiting for the child to terminate as we would + // dead lock if it writes more than the pipe buffer size (typically + // 4KB) bytes of output -- it would then block waiting for us to read + // the data while we'd block waiting for it to terminate + // + // so multiplex here waiting for any input from the child or closure of + // the pipe used to indicate its termination + wxSelectDispatcher disp; - // child exited, end waiting - wxFDIODispatcher::Get()->UnregisterFD(m_fd); - close(m_fd); + wxEndHandler endHandler(disp, execData.GetEndProcReadFD()); - m_data->fdioHandler = NULL; - wxHandleProcessTermination(m_data); + wxRedirectedIOHandler outHandler(disp, execData.fdOut, execData.bufOut), + errHandler(disp, execData.fdErr, execData.bufErr); - delete this; + while ( !endHandler.Terminated() ) + { + disp.Dispatch(); + } } + //else: no IO redirection, just block waiting for the child to exit +#endif // HAS_PIPE_INPUT_STREAM - wxEndProcessData *m_data; - int m_fd; -}; - -int wxAddProcessCallback(wxEndProcessData *proc_data, int fd) -{ - proc_data->fdioHandler = new wxEndProcessFDIOHandler(proc_data, fd); - wxFDIODispatcher::Get()->RegisterFD - ( - fd, - proc_data->fdioHandler, - wxFDIO_EXCEPTION - ); - return fd; // unused, but return something unique for the tag + return DoWaitForChild(execData.pid); } -#endif // wxHAS_GENERIC_PROCESS_CALLBACK -void wxHandleProcessTermination(wxEndProcessData *proc_data) +void wxHandleProcessTermination(wxEndProcessData *data) { + data->exitcode = DoWaitForChild(data->pid, WNOHANG); + // notify user about termination if required - if ( proc_data->process ) + if ( data->process ) { - proc_data->process->OnTerminate(proc_data->pid, proc_data->exitcode); + data->process->OnTerminate(data->pid, data->exitcode); } - // clean up - if ( proc_data->pid > 0 ) + if ( data->async ) { - delete proc_data; + // in case of asynchronous execution we don't need this data any more + // after the child terminates + delete data; } - else + else // sync execution { - // let wxExecute() know that the process has terminated - proc_data->pid = 0; + // let wxExecute() know that the process has terminated + data->pid = 0; } } -#endif // wxUSE_BASE