X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/77ffb5937e89927b621128789401db8921fe580f..04fa04d8067d235ab45b5bc05b65f0679634b541:/src/unix/utilsunx.cpp?ds=inline diff --git a/src/unix/utilsunx.cpp b/src/unix/utilsunx.cpp index 35d0fcbc10..ec550fcf24 100644 --- a/src/unix/utilsunx.cpp +++ b/src/unix/utilsunx.cpp @@ -1,10 +1,10 @@ ///////////////////////////////////////////////////////////////////////////// -// Name: unix/utilsunx.cpp -// Purpose: generic Unix implementation of many wx functions +// Name: src/unix/utilsunx.cpp +// Purpose: generic Unix implementation of many wx functions (for wxBase) // Author: Vadim Zeitlin // Id: $Id$ // Copyright: (c) 1998 Robert Roebling, Vadim Zeitlin -// Licence: wxWidgets licence +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// // ============================================================================ @@ -18,36 +18,75 @@ // for compilers that support precompilation, includes "wx.h". #include "wx/wxprec.h" -#include "wx/defs.h" -#include "wx/string.h" +#include "wx/utils.h" + +#define USE_PUTENV (!defined(HAVE_SETENV) && defined(HAVE_PUTENV)) + +#ifndef WX_PRECOMP + #include "wx/string.h" + #include "wx/intl.h" + #include "wx/log.h" + #include "wx/app.h" + #include "wx/wxcrtvararg.h" + #if USE_PUTENV + #include "wx/module.h" + #include "wx/hashmap.h" + #endif +#endif -#include "wx/intl.h" -#include "wx/log.h" -#include "wx/app.h" #include "wx/apptrait.h" -#include "wx/utils.h" #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" + +#ifdef wxHAS_GENERIC_PROCESS_CALLBACK +#include "wx/private/fdiodispatcher.h" +#endif + +#include +#include // waitpid() + +#ifdef HAVE_SYS_SELECT_H +# include +#endif + +#define HAS_PIPE_STREAMS (wxUSE_STREAMS && wxUSE_FILE) -#if wxUSE_STREAMS +#if HAS_PIPE_STREAMS // define this to let wxexec.cpp know that we know what we're doing #define _WX_USED_BY_WXEXECUTE_ #include "../common/execcmn.cpp" -#endif // wxUSE_STREAMS - -#if wxUSE_BASE - -#if defined( __MWERKS__ ) && defined(__MACH__) -#define WXWIN_OS_DESCRIPTION "MacOS X" -#define HAVE_NANOSLEEP -#define HAVE_UNAME +#endif // HAS_PIPE_STREAMS + +#if defined(__MWERKS__) && defined(__MACH__) + #ifndef WXWIN_OS_DESCRIPTION + #define WXWIN_OS_DESCRIPTION "MacOS X" + #endif + #ifndef HAVE_NANOSLEEP + #define HAVE_NANOSLEEP + #endif + #ifndef HAVE_UNAME + #define HAVE_UNAME + #endif + + // our configure test believes we can use sigaction() if the function is + // available but Metrowekrs with MSL run-time does have the function but + // doesn't have sigaction struct so finally we can't use it... + #ifdef __MSL__ + #undef wxUSE_ON_FATAL_EXCEPTION + #define wxUSE_ON_FATAL_EXCEPTION 0 + #endif #endif // not only the statfs syscall is called differently depending on platform, but @@ -64,6 +103,11 @@ #endif // __BSD__/!__BSD__ #define wxStatfs statfs + + #ifndef HAVE_STATFS_DECL + // some systems lack statfs() prototype in the system headers (AIX 4) + extern "C" int statfs(const char *path, struct statfs *buf); + #endif #endif // HAVE_STATFS #ifdef HAVE_STATVFS @@ -90,7 +134,6 @@ #include #include #include -#include #include #include #include @@ -103,6 +146,12 @@ #include // for uname() #endif // HAVE_UNAME +// Used by wxGetFreeMemory(). +#ifdef __SGI__ + #include + #include // for SAGET and MINFO structures +#endif + // ---------------------------------------------------------------------------- // conditional compilation // ---------------------------------------------------------------------------- @@ -111,26 +160,22 @@ // headers - please add your system here if it is the case for your OS. // SunOS < 5.6 (i.e. Solaris < 2.6) and DG-UX are like this. #if !defined(HAVE_USLEEP) && \ - (defined(__SUN__) && !defined(__SunOs_5_6) && \ + ((defined(__SUN__) && !defined(__SunOs_5_6) && \ !defined(__SunOs_5_7) && !defined(__SUNPRO_CC)) || \ - defined(__osf__) || defined(__EMX__) + defined(__osf__) || defined(__EMX__)) extern "C" { - #ifdef __SUN__ + #ifdef __EMX__ + /* I copied this from the XFree86 diffs. AV. */ + #define INCL_DOSPROCESS + #include + inline void usleep(unsigned long delay) + { + DosSleep(delay ? (delay/1000l) : 1l); + } + #else // Unix int usleep(unsigned int usec); - #else // !Sun - #ifdef __EMX__ - /* I copied this from the XFree86 diffs. AV. */ - #define INCL_DOSPROCESS - #include - inline void usleep(unsigned long delay) - { - DosSleep(delay ? (delay/1000l) : 1l); - } - #else // !Sun && !EMX - void usleep(unsigned long usec); - #endif - #endif // Sun/EMX/Something else + #endif // __EMX__/Unix }; #define HAVE_USLEEP 1 @@ -149,15 +194,15 @@ void wxSleep(int nSecs) sleep(nSecs); } -void wxUsleep(unsigned long milliseconds) +void wxMicroSleep(unsigned long microseconds) { #if defined(HAVE_NANOSLEEP) timespec tmReq; - tmReq.tv_sec = (time_t)(milliseconds / 1000); - tmReq.tv_nsec = (milliseconds % 1000) * 1000 * 1000; + tmReq.tv_sec = (time_t)(microseconds / 1000000); + tmReq.tv_nsec = (microseconds % 1000000) * 1000; // we're not interested in remaining time nor in return value - (void)nanosleep(&tmReq, (timespec *)NULL); + (void)nanosleep(&tmReq, NULL); #elif defined(HAVE_USLEEP) // uncomment this if you feel brave or if you are sure that your version // of Solaris has a safe usleep() function but please notice that usleep() @@ -167,25 +212,30 @@ void wxUsleep(unsigned long milliseconds) #error "usleep() cannot be used in MT programs under Solaris." #endif // Sun - usleep(milliseconds * 1000); // usleep(3) wants microseconds + usleep(microseconds); #elif defined(HAVE_SLEEP) // under BeOS sleep() takes seconds (what about other platforms, if any?) - sleep(milliseconds * 1000); + sleep(microseconds * 1000000); #else // !sleep function - #error "usleep() or nanosleep() function required for wxUsleep" + #error "usleep() or nanosleep() function required for wxMicroSleep" #endif // sleep function } +void wxMilliSleep(unsigned long milliseconds) +{ + wxMicroSleep(milliseconds*1000); +} + // ---------------------------------------------------------------------------- // process management // ---------------------------------------------------------------------------- -int wxKill(long pid, wxSignal sig, wxKillError *rc) +int wxKill(long pid, wxSignal sig, wxKillError *rc, int flags) { - int err = kill((pid_t)pid, (int)sig); + int err = kill((pid_t) (flags & wxKILL_CHILDREN) ? -pid : pid, (int)sig); if ( rc ) { - switch ( errno ) + switch ( err ? errno : 0 ) { case 0: *rc = wxKILL_OK; @@ -205,7 +255,7 @@ int wxKill(long pid, wxSignal sig, wxKillError *rc) default: // this goes against Unix98 docs so log it - wxLogDebug(_T("unexpected kill(2) return value %d"), err); + wxLogDebug(wxT("unexpected kill(2) return value %d"), err); // something else... *rc = wxKILL_ERROR; @@ -215,88 +265,119 @@ int wxKill(long pid, wxSignal sig, wxKillError *rc) return err; } -#define WXEXECUTE_NARGS 127 - -long wxExecute( const wxString& command, int flags, wxProcess *process ) +// Shutdown or reboot the PC +bool wxShutdown(int flags) { - wxCHECK_MSG( !command.IsEmpty(), 0, wxT("can't exec empty command") ); + flags &= ~wxSHUTDOWN_FORCE; -#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 + wxChar level; + switch ( flags ) + { + case wxSHUTDOWN_POWEROFF: + level = wxT('0'); + 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_REBOOT: + level = wxT('6'); + break; - // split the command line in arguments - do - { - argument=wxT(""); - quotechar = wxT('\0'); + case wxSHUTDOWN_LOGOFF: + // TODO: use dcop to log off? + return false; - // eat leading whitespace: - while ( wxIsspace(*cptr) ) - cptr++; + default: + wxFAIL_MSG( wxT("unknown wxShutdown() flag") ); + return false; + } - if ( *cptr == wxT('\'') || *cptr == wxT('"') ) - quotechar = *cptr++; + return system(wxString::Format("init %c", level).mb_str()) == 0; +} - do - { - if ( *cptr == wxT('\\') && ! escaped ) - { - escaped = TRUE; - cptr++; - continue; - } +// ---------------------------------------------------------------------------- +// wxStream classes to support IO redirection in wxExecute +// ---------------------------------------------------------------------------- - // all other characters: - argument += *cptr++; - escaped = FALSE; +#if HAS_PIPE_STREAMS - // 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") ); +bool wxPipeInputStream::CanRead() const +{ + if ( m_lasterror == wxSTREAM_EOF ) + return false; + + // 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); + + switch ( select(fd + 1, &readfds, NULL, NULL, &tv) ) + { + case -1: + wxLogSysError(_("Impossible to get child process input")); + // fall through - // do execute the command - long lRc = wxExecute(argv, flags, process); + case 0: + return false; - // clean up - argc = 0; - while( argv[argc] ) - delete [] argv[argc++]; + default: + wxFAIL_MSG(wxT("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(); + } } +size_t wxPipeOutputStream::OnSysWrite(const void *buffer, size_t size) +{ + // We need to suppress error logging here, because on writing to a pipe + // which is full, wxFile::Write reports a system error. However, this is + // not an extraordinary situation, and it should not be reported to the + // user (but if really needed, the program can recognize it by checking + // whether LastRead() == 0.) Other errors will be reported below. + size_t ret; + { + wxLogNull logNo; + ret = m_file->Write(buffer, size); + } + + switch ( m_file->GetLastError() ) + { + // pipe is full +#ifdef EAGAIN + case EAGAIN: +#endif +#if defined(EWOULDBLOCK) && (EWOULDBLOCK != EAGAIN) + case EWOULDBLOCK: +#endif + // do not treat it as an error + m_file->ClearLastError(); + // fall through + + // no error + case 0: + break; + + // some real error + default: + wxLogSysError(_("Can't write to child process's stdin")); + m_lasterror = wxSTREAM_WRITE_ERROR; + } + + return ret; +} + +#endif // HAS_PIPE_STREAMS + // ---------------------------------------------------------------------------- // wxShell // ---------------------------------------------------------------------------- @@ -307,12 +388,12 @@ static wxString wxMakeShellCommand(const wxString& command) if ( !command ) { // just an interactive shell - cmd = _T("xterm"); + cmd = wxT("xterm"); } else { // execute command in a shell - cmd << _T("/bin/sh -c '") << command << _T('\''); + cmd << wxT("/bin/sh -c '") << command << wxT('\''); } return cmd; @@ -325,89 +406,105 @@ bool wxShell(const wxString& command) bool wxShell(const wxString& command, wxArrayString& output) { - wxCHECK_MSG( !!command, FALSE, _T("can't exec shell non interactively") ); + wxCHECK_MSG( !command.empty(), false, wxT("can't exec shell non interactively") ); return wxExecute(wxMakeShellCommand(command), output); } -// Shutdown or reboot the PC -bool wxShutdown(wxShutdownFlags wFlags) +namespace { - wxChar level; - switch ( wFlags ) - { - case wxSHUTDOWN_POWEROFF: - level = _T('0'); - break; - case wxSHUTDOWN_REBOOT: - level = _T('6'); - break; +// 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) + { + Init(args.size()); - default: - wxFAIL_MSG( _T("unknown wxShutdown() flag") ); - return FALSE; + for ( int i = 0; i < m_argc; i++ ) + { + m_argv[i] = wxStrdup(args[i]); + } } - return system(wxString::Format(_T("init %c"), level).mb_str()) == 0; -} - +#if wxUSE_UNICODE + ArgsArray(wchar_t **wargv) + { + int argc = 0; + while ( wargv[argc] ) + argc++; -// ---------------------------------------------------------------------------- -// wxStream classes to support IO redirection in wxExecute -// ---------------------------------------------------------------------------- + Init(argc); -#if wxUSE_STREAMS + for ( int i = 0; i < m_argc; i++ ) + { + m_argv[i] = wxSafeConvertWX2MB(wargv[i]).release(); + } + } +#endif // wxUSE_UNICODE -bool wxPipeInputStream::CanRead() const -{ - if ( m_lasterror == wxSTREAM_EOF ) - return FALSE; + ~ArgsArray() + { + for ( int i = 0; i < m_argc; i++ ) + { + free(m_argv[i]); + } - // check if there is any input available - struct timeval tv; - tv.tv_sec = 0; - tv.tv_usec = 0; + delete [] m_argv; + } - const int fd = m_file->fd(); + operator char**() const { return m_argv; } - fd_set readfds; - FD_ZERO(&readfds); - FD_SET(fd, &readfds); - switch ( select(fd + 1, &readfds, NULL, NULL, &tv) ) +private: + void Init(int argc) { - case -1: - wxLogSysError(_("Impossible to get child process input")); - // fall through - - case 0: - return FALSE; + m_argc = argc; + m_argv = new char *[m_argc + 1]; + m_argv[m_argc] = NULL; + } - default: - wxFAIL_MSG(_T("unexpected select() return value")); - // still fall through + int m_argc; + char **m_argv; - 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(); - } -} + wxDECLARE_NO_COPY_CLASS(ArgsArray); +}; -#endif // wxUSE_STREAMS +} // anonymous namespace // ---------------------------------------------------------------------------- -// wxExecute: the real worker function +// wxExecute implementations // ---------------------------------------------------------------------------- -#ifdef __VMS - #pragma message disable codeunreachable +#if defined(__DARWIN__) +bool wxMacLaunch(char **argv); #endif -long wxExecute(wxChar **argv, - int flags, - wxProcess *process) +long wxExecute(const wxString& command, int flags, wxProcess *process, + const wxExecuteEnv *env) +{ + ArgsArray argv(wxCmdLineParser::ConvertStringToArgs(command, + wxCMD_LINE_SPLIT_UNIX)); + + return wxExecute(argv, flags, process, env); +} + +#if wxUSE_UNICODE + +long wxExecute(wchar_t **wargv, int flags, wxProcess *process, + const wxExecuteEnv *env) +{ + ArgsArray argv(wargv); + + return wxExecute(argv, flags, process, env); +} + +#endif // wxUSE_UNICODE + +// wxExecute: the real worker function +long wxExecute(char **argv, int flags, wxProcess *process, + const wxExecuteEnv *env) { // for the sync execution, we return -1 to indicate failure, but for async // case we return 0 which is never a valid PID @@ -418,49 +515,38 @@ long wxExecute(wxChar **argv, 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(), + wxT("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 = wxConvertWX2MB(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; } @@ -475,8 +561,6 @@ long wxExecute(wxChar **argv, { wxLogError( _("Failed to execute '%s'\n"), *argv ); - ARGS_CLEANUP; - return ERROR_RETURN_CODE; } } @@ -496,36 +580,14 @@ long wxExecute(wxChar **argv, { 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 ) @@ -536,10 +598,6 @@ long wxExecute(wxChar **argv, } #endif // !__VMS - // reading side can be safely closed but we should keep the write one - // opened - traits->DetachWriteFDOfEndProcessPipe(execData); - // redirect stdin, stdout and stderr if ( pipeIn.IsOk() ) { @@ -555,12 +613,78 @@ long wxExecute(wxChar **argv, pipeErr.Close(); } - execvp (*mb_argv, mb_argv); + // Close all (presumably accidentally) inherited file descriptors to + // avoid descriptor leaks. This means that we don't allow inheriting + // them purposefully but this seems like a lesser evil in wx code. + // Ideally we'd provide some flag to indicate that none (or some?) of + // the descriptors do not need to be closed but for now this is better + // than never closing them at all as wx code never used FD_CLOEXEC. + + // Note that while the reading side of the end process detection pipe + // can be safely closed, we should keep the write one opened, it will + // be only closed when the process terminates resulting in a read + // notification to the parent + const int fdEndProc = execData.pipeEndProcDetect.Detach(wxPipe::Write); + execData.pipeEndProcDetect.Close(); + + // TODO: Iterating up to FD_SETSIZE is both inefficient (because it may + // be quite big) and incorrect (because in principle we could + // have more opened descriptions than this number). Unfortunately + // there is no good portable solution for closing all descriptors + // above a certain threshold but non-portable solutions exist for + // most platforms, see [http://stackoverflow.com/questions/899038/ + // getting-the-highest-allocated-file-descriptor] + for ( int fd = 0; fd < (int)FD_SETSIZE; ++fd ) + { + if ( fd != STDIN_FILENO && + fd != STDOUT_FILENO && + fd != STDERR_FILENO && + fd != fdEndProc ) + { + close(fd); + } + } + + + // Process additional options if we have any + if ( env ) + { + // Change working directory if it is specified + if ( !env->cwd.empty() ) + wxSetWorkingDirectory(env->cwd); + + // Change environment if needed. + // + // NB: We can't use execve() currently because we allow using + // non full paths to wxExecute(), i.e. we want to search for + // the program in PATH. However it just might be simpler/better + // to do the search manually and use execve() envp parameter to + // set up the environment of the child process explicitly + // instead of doing what we do below. + if ( !env->env.empty() ) + { + wxEnvVariableHashMap oldenv; + wxGetEnvMap(&oldenv); + + // Remove unwanted variables + wxEnvVariableHashMap::const_iterator it; + for ( it = oldenv.begin(); it != oldenv.end(); ++it ) + { + if ( env->env.find(it->first) == env->env.end() ) + wxUnsetEnv(it->first); + } + + // And add the new ones (possibly replacing the old values) + for ( it = env->env.begin(); it != env->env.end(); ++it ) + wxSetEnv(it->first, it->second); + } + } + + 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() @@ -578,31 +702,45 @@ long wxExecute(wxChar **argv, } else // we're in parent { - ARGS_CLEANUP; - // save it for WaitForChild() use execData.pid = pid; + if (execData.process) + execData.process->SetPid(pid); // and also in the wxProcess // prepare for IO redirection -#if wxUSE_STREAMS +#if HAS_PIPE_STREAMS // the input buffer bufOut is connected to stdout, this is why it is // called bufOut and not bufIn wxStreamTempInputBuffer bufOut, bufErr; -#endif // wxUSE_STREAMS if ( process && process->IsRedirected() ) { -#if wxUSE_STREAMS + // Avoid deadlocks which could result from trying to write to the + // child input pipe end while the child itself is writing to its + // output end and waiting for us to read from it. + if ( !pipeIn.MakeNonBlocking(wxPipe::Write) ) + { + // This message is not terrible useful for the user but what + // else can we do? Also, should we fail here or take the risk + // to continue and deadlock? Currently we choose the latter but + // it might not be the best idea. + wxLogSysError(_("Failed to set up non-blocking pipe, " + "the program might hang.")); +#if wxUSE_LOG + wxLog::FlushActive(); +#endif + } + wxOutputStream *inStream = - new wxFileOutputStream(pipeIn.Detach(wxPipe::Write)); + new wxPipeOutputStream(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); @@ -611,8 +749,11 @@ long wxExecute(wxChar **argv, execData.bufOut = &bufOut; execData.bufErr = &bufErr; -#endif // wxUSE_STREAMS + + execData.fdOut = fdOut; + execData.fdErr = fdErr; } +#endif // HAS_PIPE_STREAMS if ( pipeIn.IsOk() ) { @@ -621,18 +762,22 @@ long wxExecute(wxChar **argv, 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); } +#if !defined(__VMS) && !defined(__INTEL_COMPILER) return ERROR_RETURN_CODE; -} - -#ifdef __VMS - #pragma message enable codeunreachable #endif +} #undef ERROR_RETURN_CODE -#undef ARGS_CLEANUP // ---------------------------------------------------------------------------- // file and directory functions @@ -640,9 +785,9 @@ long wxExecute(wxChar **argv, const wxChar* wxGetHomeDir( wxString *home ) { - *home = wxGetUserHome( wxString() ); + *home = wxGetUserHome(); wxString tmp; - if ( home->IsEmpty() ) + if ( home->empty() ) *home = wxT("/"); #ifdef __VMS tmp = *home; @@ -652,11 +797,7 @@ const wxChar* wxGetHomeDir( wxString *home ) return home->c_str(); } -#if wxUSE_UNICODE -const wxMB2WXbuf wxGetUserHome( const wxString &user ) -#else // just for binary compatibility -- there is no 'const' here -char *wxGetUserHome( const wxString &user ) -#endif +wxString wxGetUserHome( const wxString &user ) { struct passwd *who = (struct passwd *) NULL; @@ -666,20 +807,17 @@ char *wxGetUserHome( const wxString &user ) if ((ptr = wxGetenv(wxT("HOME"))) != NULL) { -#if wxUSE_UNICODE - wxWCharBuffer buffer( ptr ); - return buffer; -#else return ptr; -#endif } - if ((ptr = wxGetenv(wxT("USER"))) != NULL || (ptr = wxGetenv(wxT("LOGNAME"))) != NULL) + + if ((ptr = wxGetenv(wxT("USER"))) != NULL || + (ptr = wxGetenv(wxT("LOGNAME"))) != NULL) { - who = getpwnam(wxConvertWX2MB(ptr)); + who = getpwnam(wxSafeConvertWX2MB(ptr)); } - // We now make sure the the user exists! - if (who == NULL) + // make sure the user exists! + if ( !who ) { who = getpwuid(getuid()); } @@ -689,19 +827,48 @@ char *wxGetUserHome( const wxString &user ) who = getpwnam (user.mb_str()); } - return wxConvertMB2WX(who ? who->pw_dir : 0); + return wxSafeConvertMB2WX(who ? who->pw_dir : 0); } // ---------------------------------------------------------------------------- // network and user id routines // ---------------------------------------------------------------------------- +// private utility function which returns output of the given command, removing +// the trailing newline +static wxString wxGetCommandOutput(const wxString &cmd) +{ + FILE *f = popen(cmd.ToAscii(), "r"); + if ( !f ) + { + wxLogSysError(wxT("Executing \"%s\" failed"), cmd.c_str()); + return wxEmptyString; + } + + wxString s; + char buf[256]; + while ( !feof(f) ) + { + if ( !fgets(buf, sizeof(buf), f) ) + break; + + s += wxString::FromAscii(buf); + } + + pclose(f); + + if ( !s.empty() && s.Last() == wxT('\n') ) + s.RemoveLast(); + + return s; +} + // retrieve either the hostname or FQDN depending on platform (caller must // check whether it's one or the other, this is why this function is for // private use only) static bool wxGetHostNameInternal(wxChar *buf, int sz) { - wxCHECK_MSG( buf, FALSE, wxT("NULL pointer in wxGetHostNameInternal") ); + wxCHECK_MSG( buf, false, wxT("NULL pointer in wxGetHostNameInternal") ); *buf = wxT('\0'); @@ -711,15 +878,19 @@ static bool wxGetHostNameInternal(wxChar *buf, int sz) bool ok = uname(&uts) != -1; if ( ok ) { - wxStrncpy(buf, wxConvertMB2WX(uts.nodename), sz - 1); - buf[sz] = wxT('\0'); + wxStrlcpy(buf, wxSafeConvertMB2WX(uts.nodename), sz); } #elif defined(HAVE_GETHOSTNAME) - bool ok = gethostname(buf, sz) != -1; + char cbuf[sz]; + bool ok = gethostname(cbuf, sz) != -1; + if ( ok ) + { + wxStrlcpy(buf, wxSafeConvertMB2WX(cbuf), sz); + } #else // no uname, no gethostname wxFAIL_MSG(wxT("don't know host name for this machine")); - bool ok = FALSE; + bool ok = false; #endif // uname/gethostname if ( !ok ) @@ -757,17 +928,17 @@ bool wxGetFullHostName(wxChar *buf, int sz) { if ( !wxStrchr(buf, wxT('.')) ) { - struct hostent *host = gethostbyname(wxConvertWX2MB(buf)); + struct hostent *host = gethostbyname(wxSafeConvertWX2MB(buf)); if ( !host ) { wxLogSysError(_("Cannot get the official hostname")); - ok = FALSE; + ok = false; } else { // the canonical name - wxStrncpy(buf, wxConvertMB2WX(host->h_name), sz); + wxStrlcpy(buf, wxSafeConvertMB2WX(host->h_name), sz); } } //else: it's already a FQDN (BSD behaves this way) @@ -783,45 +954,98 @@ bool wxGetUserId(wxChar *buf, int sz) *buf = wxT('\0'); if ((who = getpwuid(getuid ())) != NULL) { - wxStrncpy (buf, wxConvertMB2WX(who->pw_name), sz - 1); - return TRUE; + wxStrlcpy (buf, wxSafeConvertMB2WX(who->pw_name), sz); + return true; } - return FALSE; + return false; } bool wxGetUserName(wxChar *buf, int sz) { +#ifdef HAVE_PW_GECOS struct passwd *who; *buf = wxT('\0'); if ((who = getpwuid (getuid ())) != NULL) { - // pw_gecos field in struct passwd is not standard -#ifdef HAVE_PW_GECOS char *comma = strchr(who->pw_gecos, ','); if (comma) *comma = '\0'; // cut off non-name comment fields - wxStrncpy (buf, wxConvertMB2WX(who->pw_gecos), sz - 1); + wxStrlcpy(buf, wxSafeConvertMB2WX(who->pw_gecos), sz); + return true; + } + + return false; #else // !HAVE_PW_GECOS - wxStrncpy (buf, wxConvertMB2WX(who->pw_name), sz - 1); + return wxGetUserId(buf, sz); #endif // HAVE_PW_GECOS/!HAVE_PW_GECOS - return TRUE; - } +} + +bool wxIsPlatform64Bit() +{ + const wxString machine = wxGetCommandOutput(wxT("uname -m")); + + // the test for "64" is obviously not 100% reliable but seems to work fine + // in practice + return machine.Contains(wxT("64")) || + machine.Contains(wxT("alpha")); +} + +#ifdef __LINUX__ +wxLinuxDistributionInfo wxGetLinuxDistributionInfo() +{ + const wxString id = wxGetCommandOutput(wxT("lsb_release --id")); + const wxString desc = wxGetCommandOutput(wxT("lsb_release --description")); + const wxString rel = wxGetCommandOutput(wxT("lsb_release --release")); + const wxString codename = wxGetCommandOutput(wxT("lsb_release --codename")); - return FALSE; + wxLinuxDistributionInfo ret; + + id.StartsWith("Distributor ID:\t", &ret.Id); + desc.StartsWith("Description:\t", &ret.Description); + rel.StartsWith("Release:\t", &ret.Release); + codename.StartsWith("Codename:\t", &ret.CodeName); + + return ret; } +#endif -// this function is in mac/utils.cpp for wxMac +// these functions are in src/osx/utilsexc_base.cpp for wxMac #ifndef __WXMAC__ +wxOperatingSystemId wxGetOsVersion(int *verMaj, int *verMin) +{ + // get OS version + int major, minor; + wxString release = wxGetCommandOutput(wxT("uname -r")); + if ( release.empty() || + wxSscanf(release.c_str(), wxT("%d.%d"), &major, &minor) != 2 ) + { + // failed to get version string or unrecognized format + major = + minor = -1; + } + + if ( verMaj ) + *verMaj = major; + if ( verMin ) + *verMin = minor; + + // try to understand which OS are we running + wxString kernel = wxGetCommandOutput(wxT("uname -s")); + if ( kernel.empty() ) + kernel = wxGetCommandOutput(wxT("uname -o")); + + if ( kernel.empty() ) + return wxOS_UNKNOWN; + + return wxPlatformInfo::GetOperatingSystemId(kernel); +} + wxString wxGetOsDescription() { -#ifndef WXWIN_OS_DESCRIPTION - #error WXWIN_OS_DESCRIPTION should be defined in config.h by configure -#else - return wxString::FromAscii( WXWIN_OS_DESCRIPTION ); -#endif + return wxGetCommandOutput(wxT("uname -s -r -m")); } #endif // !__WXMAC__ @@ -831,7 +1055,7 @@ unsigned long wxGetProcessId() return (unsigned long)getpid(); } -long wxGetFreeMemory() +wxMemorySize wxGetFreeMemory() { #if defined(__LINUX__) // get it from /proc/meminfo @@ -843,16 +1067,43 @@ long wxGetFreeMemory() char buf[1024]; if ( fgets(buf, WXSIZEOF(buf), fp) && fgets(buf, WXSIZEOF(buf), fp) ) { - long memTotal, memUsed; - sscanf(buf, "Mem: %ld %ld %ld", &memTotal, &memUsed, &memFree); + // /proc/meminfo changed its format in kernel 2.6 + if ( wxPlatformInfo().CheckOSVersion(2, 6) ) + { + unsigned long cached, buffers; + sscanf(buf, "MemFree: %ld", &memFree); + + fgets(buf, WXSIZEOF(buf), fp); + sscanf(buf, "Buffers: %lu", &buffers); + + fgets(buf, WXSIZEOF(buf), fp); + sscanf(buf, "Cached: %lu", &cached); + + // add to "MemFree" also the "Buffers" and "Cached" values as + // free(1) does as otherwise the value never makes sense: for + // kernel 2.6 it's always almost 0 + memFree += buffers + cached; + + // values here are always expressed in kB and we want bytes + memFree *= 1024; + } + else // Linux 2.4 (or < 2.6, anyhow) + { + long memTotal, memUsed; + sscanf(buf, "Mem: %ld %ld %ld", &memTotal, &memUsed, &memFree); + } } fclose(fp); - return memFree; + return (wxMemorySize)memFree; } -#elif defined(__SUN__) && defined(_SC_AVPHYS_PAGES) - return sysconf(_SC_AVPHYS_PAGES)*sysconf(_SC_PAGESIZE); +#elif defined(__SGI__) + struct rminfo realmem; + if ( sysmp(MP_SAGET, MPSA_RMINFO, &realmem, sizeof realmem) == 0 ) + return ((wxMemorySize)realmem.physmem * sysconf(_SC_PAGESIZE)); +#elif defined(_SC_AVPHYS_PAGES) + return ((wxMemorySize)sysconf(_SC_AVPHYS_PAGES))*sysconf(_SC_PAGESIZE); //#elif defined(__FREEBSD__) -- might use sysctl() to find it out, probably #endif @@ -860,7 +1111,7 @@ long wxGetFreeMemory() return -1; } -bool wxGetDiskSpace(const wxString& path, wxLongLong *pTotal, wxLongLong *pFree) +bool wxGetDiskSpace(const wxString& path, wxDiskspaceSize_t *pTotal, wxDiskspaceSize_t *pFree) { #if defined(HAVE_STATFS) || defined(HAVE_STATVFS) // the case to "char *" is needed for AIX 4.3 @@ -869,30 +1120,30 @@ bool wxGetDiskSpace(const wxString& path, wxLongLong *pTotal, wxLongLong *pFree) { wxLogSysError( wxT("Failed to get file system statistics") ); - return FALSE; + return false; } // under Solaris we also have to use f_frsize field instead of f_bsize // which is in general a multiple of f_frsize #ifdef HAVE_STATVFS - wxLongLong blockSize = fs.f_frsize; + wxDiskspaceSize_t blockSize = fs.f_frsize; #else // HAVE_STATFS - wxLongLong blockSize = fs.f_bsize; + wxDiskspaceSize_t blockSize = fs.f_bsize; #endif // HAVE_STATVFS/HAVE_STATFS if ( pTotal ) { - *pTotal = wxLongLong(fs.f_blocks) * blockSize; + *pTotal = wxDiskspaceSize_t(fs.f_blocks) * blockSize; } if ( pFree ) { - *pFree = wxLongLong(fs.f_bavail) * blockSize; + *pFree = wxDiskspaceSize_t(fs.f_bavail) * blockSize; } - return TRUE; + return true; #else // !HAVE_STATFS && !HAVE_STATVFS - return FALSE; + return false; #endif // HAVE_STATFS } @@ -900,46 +1151,105 @@ bool wxGetDiskSpace(const wxString& path, wxLongLong *pTotal, wxLongLong *pFree) // env vars // ---------------------------------------------------------------------------- +#if USE_PUTENV + +WX_DECLARE_STRING_HASH_MAP(char *, wxEnvVars); + +static wxEnvVars gs_envVars; + +class wxSetEnvModule : public wxModule +{ +public: + virtual bool OnInit() { return true; } + virtual void OnExit() + { + for ( wxEnvVars::const_iterator i = gs_envVars.begin(); + i != gs_envVars.end(); + ++i ) + { + free(i->second); + } + + gs_envVars.clear(); + } + + DECLARE_DYNAMIC_CLASS(wxSetEnvModule) +}; + +IMPLEMENT_DYNAMIC_CLASS(wxSetEnvModule, wxModule) + +#endif // USE_PUTENV + bool wxGetEnv(const wxString& var, wxString *value) { // wxGetenv is defined as getenv() - wxChar *p = wxGetenv(var); + char *p = wxGetenv(var); if ( !p ) - return FALSE; + return false; if ( value ) { *value = p; } - return TRUE; + return true; } -bool wxSetEnv(const wxString& variable, const wxChar *value) +static bool wxDoSetEnv(const wxString& variable, const char *value) { #if defined(HAVE_SETENV) - return setenv(variable.mb_str(), - value ? (const char *)wxString(value).mb_str() - : NULL, - 1 /* overwrite */) == 0; + if ( !value ) + { +#ifdef HAVE_UNSETENV + // don't test unsetenv() return value: it's void on some systems (at + // least Darwin) + unsetenv(variable.mb_str()); + return true; +#else + value = ""; // we can't pass NULL to setenv() +#endif + } + + return setenv(variable.mb_str(), value, 1 /* overwrite */) == 0; #elif defined(HAVE_PUTENV) wxString s = variable; if ( value ) - s << _T('=') << value; + s << wxT('=') << value; // transform to ANSI - const char *p = s.mb_str(); + const wxWX2MBbuf p = s.mb_str(); - // the string will be free()d by libc char *buf = (char *)malloc(strlen(p) + 1); strcpy(buf, p); + // store the string to free() it later + wxEnvVars::iterator i = gs_envVars.find(variable); + if ( i != gs_envVars.end() ) + { + free(i->second); + i->second = buf; + } + else // this variable hadn't been set before + { + gs_envVars[variable] = buf; + } + return putenv(buf) == 0; #else // no way to set an env var - return FALSE; + return false; #endif } +bool wxSetEnv(const wxString& variable, const wxString& value) +{ + return wxDoSetEnv(variable, value.mb_str()); +} + +bool wxUnsetEnv(const wxString& variable) +{ + return wxDoSetEnv(variable, NULL); +} + // ---------------------------------------------------------------------------- // signal handling // ---------------------------------------------------------------------------- @@ -962,13 +1272,13 @@ extern "C" void wxFatalSignalHandler(wxTYPE_SA_HANDLER) bool wxHandleFatalExceptions(bool doit) { // old sig handlers - static bool s_savedHandlers = FALSE; + static bool s_savedHandlers = false; static struct sigaction s_handlerFPE, s_handlerILL, s_handlerBUS, s_handlerSEGV; - bool ok = TRUE; + bool ok = true; if ( doit && !s_savedHandlers ) { // install the signal handler @@ -987,10 +1297,10 @@ bool wxHandleFatalExceptions(bool doit) ok &= sigaction(SIGSEGV, &act, &s_handlerSEGV) == 0; if ( !ok ) { - wxLogDebug(_T("Failed to install our signal handler.")); + wxLogDebug(wxT("Failed to install our signal handler.")); } - s_savedHandlers = TRUE; + s_savedHandlers = true; } else if ( s_savedHandlers ) { @@ -1001,10 +1311,10 @@ bool wxHandleFatalExceptions(bool doit) ok &= sigaction(SIGSEGV, &s_handlerSEGV, NULL) == 0; if ( !ok ) { - wxLogDebug(_T("Failed to uninstall our signal handler.")); + wxLogDebug(wxT("Failed to uninstall our signal handler.")); } - s_savedHandlers = FALSE; + s_savedHandlers = false; } //else: nothing to do @@ -1014,195 +1324,270 @@ bool wxHandleFatalExceptions(bool doit) #endif // wxUSE_ON_FATAL_EXCEPTION // ---------------------------------------------------------------------------- -// error and debug output routines (deprecated, use wxLog) +// wxExecute support // ---------------------------------------------------------------------------- -#if WXWIN_COMPATIBILITY_2_2 - -void wxDebugMsg( const char *format, ... ) -{ - va_list ap; - va_start( ap, format ); - vfprintf( stderr, format, ap ); - fflush( stderr ); - va_end(ap); -} - -void wxError( const wxString &msg, const wxString &title ) -{ - wxFprintf( stderr, _("Error ") ); - if (!title.IsNull()) wxFprintf( stderr, wxT("%s "), WXSTRINGCAST(title) ); - if (!msg.IsNull()) wxFprintf( stderr, wxT(": %s"), WXSTRINGCAST(msg) ); - wxFprintf( stderr, wxT(".\n") ); -} - -void wxFatalError( const wxString &msg, const wxString &title ) +int wxAppTraits::AddProcessCallback(wxEndProcessData *data, int fd) { - wxFprintf( stderr, _("Error ") ); - if (!title.IsNull()) wxFprintf( stderr, wxT("%s "), WXSTRINGCAST(title) ); - if (!msg.IsNull()) wxFprintf( stderr, wxT(": %s"), WXSTRINGCAST(msg) ); - wxFprintf( stderr, wxT(".\n") ); - exit(3); // the same exit code as for abort() -} + // 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) + { + } -#endif // WXWIN_COMPATIBILITY_2_2 + virtual void OnReadWaiting() + { + wxFDIODispatcher::Get()->UnregisterFD(m_fd); + close(m_fd); -#endif // wxUSE_BASE + wxHandleProcessTermination(m_data); -#if wxUSE_GUI + delete this; + } -// ---------------------------------------------------------------------------- -// wxExecute support -// ---------------------------------------------------------------------------- + virtual void OnWriteWaiting() { wxFAIL_MSG("unreachable"); } + virtual void OnExceptionWaiting() { wxFAIL_MSG("unreachable"); } -// Darwin doesn't use the same process end detection mechanisms so we don't -// need wxExecute-related helpers for it -#if !(defined(__DARWIN__) && defined(__WXMAC__)) + wxEndProcessData * const m_data; + const int m_fd; + }; -bool wxGUIAppTraits::CreateEndProcessPipe(wxExecuteData& execData) -{ - return execData.pipeEndProcDetect.Create(); + wxFDIODispatcher::Get()->RegisterFD + ( + fd, + new wxEndProcessFDIOHandler(data, fd), + wxFDIO_INPUT + ); + return fd; // unused, but return something unique for the tag } -bool wxGUIAppTraits::IsWriteFDOfEndProcessPipe(wxExecuteData& execData, int fd) +bool wxAppTraits::CheckForRedirectedIO(wxExecuteData& execData) { - return fd == (execData.pipeEndProcDetect)[wxPipe::Write]; -} +#if HAS_PIPE_STREAMS + bool hasIO = false; -void wxGUIAppTraits::DetachWriteFDOfEndProcessPipe(wxExecuteData& execData) -{ - execData.pipeEndProcDetect.Detach(wxPipe::Write); - execData.pipeEndProcDetect.Close(); -} + if ( execData.bufOut && execData.bufOut->Update() ) + hasIO = true; -#else // !Darwin + if ( execData.bufErr && execData.bufErr->Update() ) + hasIO = true; -bool wxGUIAppTraits::CreateEndProcessPipe(wxExecuteData& WXUNUSED(execData)) -{ - return true; -} + return hasIO; +#else // !HAS_PIPE_STREAMS + wxUnusedVar(execData); -bool -wxGUIAppTraits::IsWriteFDOfEndProcessPipe(wxExecuteData& WXUNUSED(execData), - int WXUNUSED(fd)) -{ return false; +#endif // HAS_PIPE_STREAMS/!HAS_PIPE_STREAMS } -void -wxGUIAppTraits::DetachWriteFDOfEndProcessPipe(wxExecuteData& WXUNUSED(execData)) +// helper classes/functions used by WaitForChild() +namespace { - // nothing to do here, we don't use the pipe -} - -#endif // !Darwin/Darwin -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; - - // 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 ( execData.flags & wxEXEC_SYNC ) +public: + wxReadFDIOHandler(wxFDIODispatcher& disp, int fd) : m_fd(fd) { - // 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; - - // sync execution: indicate it by negating the pid - endProcData->pid = -execData.pid; + if ( fd ) + disp.RegisterFD(fd, this, wxFDIO_INPUT); } - else + + virtual void OnWriteWaiting() { wxFAIL_MSG("unreachable"); } + virtual void OnExceptionWaiting() { wxFAIL_MSG("unreachable"); } + +protected: + const int m_fd; + + wxDECLARE_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 defined(__DARWIN__) && defined(__WXMAC__) - endProcData->tag = wxAddProcessCallbackForPid(endProcData, execData.pid); -#else - endProcData->tag = wxAddProcessCallback - ( - endProcData, - execData.pipeEndProcDetect.Detach(wxPipe::Read) - ); + virtual void OnReadWaiting() { m_terminated = true; } + +private: + bool m_terminated; + + wxDECLARE_NO_COPY_CLASS(wxEndHandler); +}; - execData.pipeEndProcDetect.Close(); -#endif // defined(__DARWIN__) && defined(__WXMAC__) +#if HAS_PIPE_STREAMS - if ( execData.flags & wxEXEC_SYNC ) +// 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) { - wxBusyCursor bc; - wxWindowDisabler wd; + } - // endProcData->pid will be set to 0 from GTK_EndProcessDetector when the - // process terminates - while ( endProcData->pid != 0 ) - { - bool idle = true; + virtual void OnReadWaiting() + { + m_buf->Update(); + } -#if wxUSE_STREAMS - if ( execData.bufOut ) - { - execData.bufOut->Update(); - idle = false; - } +private: + wxStreamTempInputBuffer * const m_buf; - if ( execData.bufErr ) - { - execData.bufErr->Update(); - idle = false; - } -#endif // wxUSE_STREAMS + wxDECLARE_NO_COPY_CLASS(wxRedirectedIOHandler); +}; - // don't consume 100% of the CPU while we're sitting this in this - // loop - if ( idle ) - wxUsleep(1); +#endif // HAS_PIPE_STREAMS - // give GTK+ a chance to call GTK_EndProcessDetector here and - // also repaint the GUI - wxYield(); - } +// helper function which calls waitpid() and analyzes the result +int DoWaitForChild(int pid, int flags = 0) +{ + wxASSERT_MSG( pid > 0, "invalid PID" ); + + int status, rc; - int exitcode = endProcData->exitcode; + // loop while we're getting EINTR + for ( ;; ) + { + rc = waitpid(pid, &status, flags); - delete endProcData; + if ( rc != -1 || errno != EINTR ) + break; + } + + 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 if ( rc == -1 ) + { + wxLogLastError(wxString::Format("waitpid(%d)", pid)); + } + else // child did terminate + { + wxASSERT_MSG( rc == pid, "unexpected waitpid() return value" ); + + // notice that the caller expects the exit code to be signed, e.g. -1 + // instead of 255 so don't assign WEXITSTATUS() to an int + signed char exitcode; + if ( WIFEXITED(status) ) + exitcode = WEXITSTATUS(status); + else if ( WIFSIGNALED(status) ) + exitcode = -WTERMSIG(status); + else + { + wxLogError("Child process (PID %d) exited for unknown reason, " + "status = %d", pid, status); + exitcode = -1; + } return exitcode; } - else // async execution + + return -1; +} + +} // anonymous namespace + +int wxAppTraits::WaitForChild(wxExecuteData& execData) +{ + if ( !(execData.flags & wxEXEC_SYNC) ) { + // 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; + return execData.pid; } -} + //else: synchronous execution case -#endif // wxUSE_GUI -#if wxUSE_BASE +#if HAS_PIPE_STREAMS && wxUSE_SOCKETS + 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; + + wxEndHandler endHandler(disp, execData.GetEndProcReadFD()); + + wxRedirectedIOHandler outHandler(disp, execData.fdOut, execData.bufOut), + errHandler(disp, execData.fdErr, execData.bufErr); -void wxHandleProcessTermination(wxEndProcessData *proc_data) + while ( !endHandler.Terminated() ) + { + disp.Dispatch(); + } + } + //else: no IO redirection, just block waiting for the child to exit +#endif // HAS_PIPE_STREAMS + + return DoWaitForChild(execData.pid); +} + +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