]> git.saurik.com Git - wxWidgets.git/blobdiff - src/unix/utilsunx.cpp
fix a typo in comment
[wxWidgets.git] / src / unix / utilsunx.cpp
index 3616d4ae5acc9edfc375db30581cac19c5a83b0c..d7036f000b5dcd08d0d94031cf7ee786bfb2dd25 100644 (file)
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        src/unix/utilsunx.cpp
-// Purpose:     generic Unix implementation of many wx functions
+// Purpose:     generic Unix implementation of many wx functions (for wxBase)
 // Author:      Vadim Zeitlin
 // Id:          $Id$
 // Copyright:   (c) 1998 Robert Roebling, Vadim Zeitlin
@@ -39,6 +39,8 @@
 #include "wx/process.h"
 #include "wx/thread.h"
 
+#include "wx/cmdline.h"
+
 #include "wx/wfstream.h"
 
 #include "wx/private/selectdispatcher.h"
@@ -200,7 +202,7 @@ void wxMicroSleep(unsigned long microseconds)
     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()
@@ -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,38 +473,29 @@ 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;
@@ -520,8 +505,6 @@ long wxExecute(wxChar **argv, int flags, wxProcess *process)
     {
         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]
-                        || fd == (execData.pipeEndProcDetect)[wxPipe::Write] )
-                {
-                    // 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 )
@@ -618,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()
@@ -641,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;
 
@@ -685,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);
     }
 
@@ -694,7 +657,6 @@ long wxExecute(wxChar **argv, int flags, wxProcess *process)
 }
 
 #undef ERROR_RETURN_CODE
-#undef ARGS_CLEANUP
 
 // ----------------------------------------------------------------------------
 // file and directory functions
@@ -795,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"));
@@ -857,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)
@@ -873,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;
     }
 
@@ -891,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;
     }
 
@@ -911,7 +871,7 @@ bool wxIsPlatform64Bit()
                 machine.Contains(wxT("alpha"));
 }
 
-// these functions are 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)
@@ -1327,7 +1287,7 @@ private:
     DECLARE_NO_COPY_CLASS(wxEndHandler)
 };
 
-#if wxUSE_STREAMS
+#if HAS_PIPE_INPUT_STREAM
 
 // 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
@@ -1356,7 +1316,7 @@ private:
     DECLARE_NO_COPY_CLASS(wxRedirectedIOHandler)
 };
 
-#endif // wxUSE_STREAMS
+#endif // HAS_PIPE_INPUT_STREAM
 
 // helper function which calls waitpid() and analyzes the result
 int DoWaitForChild(int pid, int flags = 0)
@@ -1412,20 +1372,26 @@ int wxAppTraits::WaitForChild(wxExecuteData& execData)
 {
     if ( !(execData.flags & wxEXEC_SYNC) )
     {
-        // asynchronous execution: just launch the process and return
+        // 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->process = execData.process;
+        endProcData->pid = execData.pid;
         endProcData->tag = AddProcessCallback
                            (
                              endProcData,
                              execData.GetEndProcReadFD()
                            );
+        endProcData->async = true;
 
         return execData.pid;
     }
+    //else: synchronous execution case
 
-#if wxUSE_STREAMS
+#if HAS_PIPE_INPUT_STREAM
     wxProcess * const process = execData.process;
     if ( process && process->IsRedirected() )
     {
@@ -1449,7 +1415,7 @@ int wxAppTraits::WaitForChild(wxExecuteData& execData)
         }
     }
     //else: no IO redirection, just block waiting for the child to exit
-#endif // wxUSE_STREAMS
+#endif // HAS_PIPE_INPUT_STREAM
 
     return DoWaitForChild(execData.pid);
 }
@@ -1464,9 +1430,16 @@ void wxHandleProcessTermination(wxEndProcessData *data)
         data->process->OnTerminate(data->pid, data->exitcode);
     }
 
-    // this function is only called for asynchronously executing children, now
-    // that we have received the notification about their termination there is
-    // no need to keep it around any longer
-    delete data;
+    if ( data->async )
+    {
+        // in case of asynchronous execution we don't need this data any more
+        // after the child terminates
+        delete data;
+    }
+    else // sync execution
+    {
+        // let wxExecute() know that the process has terminated
+        data->pid = 0;
+    }
 }