]> git.saurik.com Git - wxWidgets.git/blobdiff - src/unix/utilsunx.cpp
Some doc corrections; Watcom C++ corrections; VC++ 4 corrections
[wxWidgets.git] / src / unix / utilsunx.cpp
index 9121c39e87e43a8d00d65267d90dc18be38aecb6..3b09340becb2edae82448469af9a0f83d3973a86 100644 (file)
 
 #include "wx/utils.h"
 #include "wx/process.h"
+#include "wx/thread.h"
 
-#include "wx/unix/execute.h"
+#if wxUSE_GUI
+    #include "wx/unix/execute.h"
+#endif
 
 #include <stdarg.h>
 #include <dirent.h>
@@ -40,6 +43,8 @@
 #include <fcntl.h>          // for O_WRONLY and friends
 #include <time.h>           // nanosleep() and/or usleep()
 #include <ctype.h>          // isspace()
+#include <sys/time.h>       // needed for FD_SETSIZE
+
 #ifdef HAVE_UNAME
     #include <sys/utsname.h> // for uname()
 #endif // HAVE_UNAME
 #if !defined(HAVE_USLEEP) && \
     (defined(__SUN__) && !defined(__SunOs_5_6) && \
                          !defined(__SunOs_5_7) && !defined(__SUNPRO_CC)) || \
-     defined(__osf__)
+     defined(__osf__) || defined(__EMX__)
     extern "C"
     {
         #ifdef __SUN__
             int usleep(unsigned int usec);
         #else // !Sun
-            void usleep(unsigned long usec);
-        #endif // Sun/!Sun
+            #ifdef __EMX__
+                /* I copied this from the XFree86 diffs. AV. */
+                #define INCL_DOSPROCESS
+                #include <os2.h>
+                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 // Unices without usleep()
-
-// many versions of Unices have this function, but it is not defined in system
-// headers - please add your system here if it is the case for your OS.
-// SunOS (and Solaris) and DG-UX are like this.
-#ifdef HAVE_WAIT4
-  #if defined(__SOLARIS__) || defined(__osf__)
-    extern "C"
-    {
-        pid_t wait4(pid_t pid, int *statusp, int options,
-                    struct rusage *rusage);
-    }
-  #endif
 
-  #define wxWait4(pid, stat, flags, rusage) wait4(pid, stat, flags, rusage)
-#else
-    // no wait4() at all on these systems
-    // TODO verify whether wait3() really works in this situation
-    #define wxWait4(pid, stat, flags, rusage) wait3(stat, flags, rusage)
-#endif // HAVE_WAIT4
+    #define HAVE_USLEEP 1
+#endif // Unices without usleep()
 
 // ============================================================================
 // implementation
@@ -101,7 +99,7 @@ void wxUsleep(unsigned long milliseconds)
 {
 #if defined(HAVE_NANOSLEEP)
     timespec tmReq;
-    tmReq.tv_sec = milliseconds / 1000;
+    tmReq.tv_sec = (time_t)(milliseconds / 1000);
     tmReq.tv_nsec = (milliseconds % 1000) * 1000 * 1000;
 
     // we're not interested in remaining time nor in return value
@@ -111,11 +109,14 @@ void wxUsleep(unsigned long milliseconds)
     // of Solaris has a safe usleep() function but please notice that usleep()
     // is known to lead to crashes in MT programs in Solaris 2.[67] and is not
     // documented as MT-Safe
-    #if defined(__SUN__) && defined(wxUSE_THREADS)
+    #if defined(__SUN__) && wxUSE_THREADS
         #error "usleep() cannot be used in MT programs under Solaris."
     #endif // Sun
 
     usleep(milliseconds * 1000); // usleep(3) wants microseconds
+#elif defined(HAVE_SLEEP)
+    // under BeOS sleep() takes seconds (what about other platforms, if any?)
+    sleep(milliseconds * 1000);
 #else // !sleep function
     #error "usleep() or nanosleep() function required for wxUsleep"
 #endif // sleep function
@@ -125,65 +126,78 @@ void wxUsleep(unsigned long milliseconds)
 // process management
 // ----------------------------------------------------------------------------
 
-int wxKill(long pid, int sig)
+int wxKill(long pid, wxSignal sig)
 {
-    return kill(pid, sig);
+    return kill((pid_t)pid, (int)sig);
 }
 
 #define WXEXECUTE_NARGS   127
 
 long wxExecute( const wxString& command, bool sync, wxProcess *process )
 {
-    wxCHECK_MSG( !command.IsEmpty(), 0, "can't exec empty command" );
+    wxCHECK_MSG( !command.IsEmpty(), 0, wxT("can't exec empty command") );
 
     int argc = 0;
-    char *argv[WXEXECUTE_NARGS];
+    wxChar *argv[WXEXECUTE_NARGS];
     wxString argument;
-    const char *cptr = command.c_str();
-    char quotechar = '\0'; // is arg quoted?
+    const wxChar *cptr = command.c_str();
+    wxChar quotechar = wxT('\0'); // is arg quoted?
     bool escaped = FALSE;
 
+    // split the command line in arguments
     do
     {
-        argument="";
-        quotechar = '\0';
+        argument=wxT("");
+        quotechar = wxT('\0');
+
         // eat leading whitespace:
-        while(*cptr && isspace(*cptr))
+        while ( wxIsspace(*cptr) )
             cptr++;
-        if(*cptr == '\'' || *cptr == '"')
+
+        if ( *cptr == wxT('\'') || *cptr == wxT('"') )
             quotechar = *cptr++;
+
         do
         {
-            if(*cptr == '\\' && ! escaped)
+            if ( *cptr == wxT('\\') && ! escaped )
             {
                 escaped = TRUE;
                 cptr++;
                 continue;
             }
+
             // all other characters:
-            argument += *cptr ++;
+            argument += *cptr++;
             escaped = FALSE;
-            // Have we reached the end of the argument?
-            if((*cptr == quotechar && ! escaped)
-               || (quotechar == '\0' && isspace(*cptr))
-               || *cptr == '\0')
+
+            // have we reached the end of the argument?
+            if ( (*cptr == quotechar && ! escaped)
+                 || (quotechar == wxT('\0') && wxIsspace(*cptr))
+                 || *cptr == wxT('\0') )
             {
-                wxASSERT(argc < WXEXECUTE_NARGS);
-                argv[argc] = new char[argument.Len()+1];
-                strcpy(argv[argc], argument.c_str());
+                wxASSERT_MSG( argc < WXEXECUTE_NARGS,
+                              wxT("too many arguments in wxExecute") );
+
+                argv[argc] = new wxChar[argument.length() + 1];
+                wxStrcpy(argv[argc], argument.c_str());
                 argc++;
+
                 // if not at end of buffer, swallow last character:
-                if(*cptr) cptr++;
+                if(*cptr)
+                    cptr++;
+
                 break; // done with this one, start over
             }
-        }while(*cptr);
-    }while(*cptr);
+        } while(*cptr);
+    } while(*cptr);
     argv[argc] = NULL;
-    
+
+    // do execute the command
     long lRc = wxExecute(argv, sync, process);
 
+    // clean up
     argc = 0;
-    while(argv[argc])
+    while( argv[argc] )
         delete [] argv[argc++];
 
     return lRc;
@@ -193,48 +207,114 @@ bool wxShell(const wxString& command)
 {
     wxString cmd;
     if ( !!command )
-        cmd.Printf("xterm -e %s", command.c_str());
+        cmd.Printf(wxT("xterm -e %s"), command.c_str());
     else
         cmd = command;
 
     return wxExecute(cmd) != 0;
 }
 
+#if wxUSE_GUI
+
 void wxHandleProcessTermination(wxEndProcessData *proc_data)
 {
     int pid = (proc_data->pid > 0) ? proc_data->pid : -(proc_data->pid);
 
+    // waitpid is POSIX so should be available everywhere, however on older
+    // systems wait() might be used instead in a loop (until the right pid
+    // terminates)
     int status = 0;
-    wxWait4(pid, &status, 0, (rusage *) NULL);
+    int rc;
 
-    if (proc_data->process)
-        proc_data->process->OnTerminate(proc_data->pid, status);
+    // wait for child termination and if waitpid() was interrupted, try again
+    do
+    {
+       rc = waitpid(pid, &status, 0);
+    }
+    while ( rc == -1 && errno == EINTR );
 
-    if (proc_data->pid > 0)
+
+    if( rc == -1 || ! (WIFEXITED(status) || WIFSIGNALED(status)) )
     {
-        delete proc_data;
+       wxLogSysError(_("Waiting for subprocess termination failed"));
+       /* AFAIK, this can only happen if something went wrong within
+          wxGTK, i.e. due to a race condition or some serious bug.
+          After having fixed the order of statements in
+          GTK_EndProcessDetector(). (KB)
+       */
     }
     else
     {
-        // wxExecute() will know about it
-        proc_data->exitcode = status;
+        // notify user about termination if required
+        if (proc_data->process)
+        {
+            proc_data->process->OnTerminate(proc_data->pid,
+                                            WEXITSTATUS(status));
+        }
+        // clean up
+        if ( proc_data->pid > 0 )
+        {
+           delete proc_data;
+        }
+        else
+        {
+           // wxExecute() will know about it
+           proc_data->exitcode = status;
 
-        proc_data->pid = 0;
+           proc_data->pid = 0;
+        }
     }
 }
 
-long wxExecute( char **argv, bool sync, wxProcess *process )
+#endif // wxUSE_GUI
+
+#if wxUSE_GUI
+    #define WXUNUSED_UNLESS_GUI(p)  p
+#else
+    #define WXUNUSED_UNLESS_GUI(p)
+#endif
+
+long wxExecute(wxChar **argv,
+               bool sync,
+               wxProcess * WXUNUSED_UNLESS_GUI(process))
 {
-    wxCHECK_MSG( *argv, 0, "can't exec empty command" );
+    wxCHECK_MSG( *argv, 0, wxT("can't exec empty command") );
 
-    int end_proc_detect[2];
+#if wxUSE_UNICODE
+    int mb_argc = 0;
+    char *mb_argv[WXEXECUTE_NARGS];
+
+    while (argv[mb_argc])
+    {
+      wxWX2MBbuf mb_arg = wxConvertWX2MB(argv[mb_argc]);
+      mb_argv[mb_argc] = strdup(mb_arg);
+      mb_argc++;
+    }
+    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
 
+#if wxUSE_GUI
     // create pipes
+    int end_proc_detect[2];
     if (pipe(end_proc_detect) == -1)
     {
         wxLogSysError( _("Pipe creation failed") );
+
+        ARGS_CLEANUP;
+
         return 0;
     }
+#endif // wxUSE_GUI
 
     // fork the process
 #ifdef HAVE_VFORK
@@ -245,23 +325,33 @@ long wxExecute( char **argv, bool sync, wxProcess *process )
     if (pid == -1)
     {
         wxLogSysError( _("Fork failed") );
+
+        ARGS_CLEANUP;
+
         return 0;
     }
     else if (pid == 0)
     {
+#if wxUSE_GUI
         // we're in child
         close(end_proc_detect[0]); // close reading side
+#endif // wxUSE_GUI
 
         // These three 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
+        // one wants proper IO for the subprocess, the right thing to do is
         // to start an xterm executing it.
         if (sync == 0)
         {
             // leave stderr opened, it won't do any hurm
             for ( int fd = 0; fd < FD_SETSIZE; fd++ )
             {
-                if ( fd != end_proc_detect[1] && fd != STDERR_FILENO )
+#if wxUSE_GUI
+                if ( fd == end_proc_detect[1] )
+                    continue;
+#endif // wxUSE_GUI
+
+                if ( fd != STDERR_FILENO )
                     close(fd);
             }
         }
@@ -276,28 +366,30 @@ long wxExecute( char **argv, bool sync, wxProcess *process )
         open("/dev/null", O_WRONLY);  // stderr
 #endif
 
-        execvp (*argv, argv);
+        execvp (*mb_argv, mb_argv);
 
         // there is no return after successful exec()
-        fprintf(stderr, _("Can't execute '%s'\n"), *argv);
+        wxFprintf(stderr, _("Can't execute '%s'\n"), *argv);
 
         _exit(-1);
     }
     else
     {
-        // we're in parent
-        close(end_proc_detect[1]); // close writing side
-
+#if wxUSE_GUI
         wxEndProcessData *data = new wxEndProcessData;
-        data->tag = wxAddProcessCallback(data, end_proc_detect[0]);
+
+        ARGS_CLEANUP;
 
         if ( sync )
         {
-            wxASSERT_MSG( !process, "wxProcess param ignored for sync exec" );
+            wxASSERT_MSG( !process, wxT("wxProcess param ignored for sync exec") );
             data->process = NULL;
 
             // sync execution: indicate it by negating the pid
             data->pid = -pid;
+            data->tag = wxAddProcessCallback(data, end_proc_detect[0]);
+            // we're in parent
+            close(end_proc_detect[1]); // close writing side
 
             // it will be set to 0 from GTK_EndProcessDetector
             while (data->pid != 0)
@@ -312,44 +404,65 @@ long wxExecute( char **argv, bool sync, wxProcess *process )
         else
         {
             // async execution, nothing special to do - caller will be
-            // notified about the process terminationif process != NULL, data
+            // notified about the process termination if process != NULL, data
             // will be deleted in GTK_EndProcessDetector
             data->process = process;
             data->pid = pid;
+            data->tag = wxAddProcessCallback(data, end_proc_detect[0]);
+            // we're in parent
+            close(end_proc_detect[1]); // close writing side
 
             return pid;
         }
+#else // !wxUSE_GUI
+        wxASSERT_MSG( sync, wxT("async execution not supported yet") );
+
+        int exitcode = 0;
+        if ( waitpid(pid, &exitcode, 0) == -1 || !WIFEXITED(exitcode) )
+        {
+            wxLogSysError(_("Waiting for subprocess termination failed"));
+        }
+
+        return exitcode;
+#endif // wxUSE_GUI
     }
+   return 0;
+
+    #undef ARGS_CLEANUP
 }
 
 // ----------------------------------------------------------------------------
 // file and directory functions
 // ----------------------------------------------------------------------------
 
-const char* wxGetHomeDir( wxString *home  )
+const wxChar* wxGetHomeDir( wxString *home  )
 {
     *home = wxGetUserHome( wxString() );
     if ( home->IsEmpty() )
-        *home = "/";
+        *home = wxT("/");
 
     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
 {
     struct passwd *who = (struct passwd *) NULL;
 
-    if (user.IsNull() || (user== ""))
+    if ( !user )
     {
-        register char *ptr;
+        wxChar *ptr;
 
-        if ((ptr = getenv("HOME")) != NULL)
+        if ((ptr = wxGetenv(wxT("HOME"))) != NULL)
         {
             return ptr;
         }
-        if ((ptr = getenv("USER")) != NULL || (ptr = getenv("LOGNAME")) != NULL)
+        if ((ptr = wxGetenv(wxT("USER"))) != NULL || (ptr = wxGetenv(wxT("LOGNAME"))) != NULL)
         {
-            who = getpwnam(ptr);
+            who = getpwnam(wxConvertWX2MB(ptr));
         }
 
         // We now make sure the the user exists!
@@ -360,21 +473,24 @@ char *wxGetUserHome( const wxString &user )
     }
     else
     {
-      who = getpwnam (user);
+      who = getpwnam (user.mb_str());
     }
 
-    return who ? who->pw_dir : (char*)NULL;
+    return wxConvertMB2WX(who ? who->pw_dir : 0);
 }
 
 // ----------------------------------------------------------------------------
-// id routines
+// network and user id routines
 // ----------------------------------------------------------------------------
 
-bool wxGetHostName(char *buf, int sz)
+// 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, "NULL pointer in wxGetHostName" );
+    wxCHECK_MSG( buf, FALSE, wxT("NULL pointer in wxGetHostNameInternal") );
 
-    *buf = '\0';
+    *buf = wxT('\0');
 
     // we're using uname() which is POSIX instead of less standard sysinfo()
 #if defined(HAVE_UNAME)
@@ -382,16 +498,16 @@ bool wxGetHostName(char *buf, int sz)
     bool ok = uname(&uts) != -1;
     if ( ok )
     {
-        strncpy(buf, uts.nodename, sz - 1);
-        buf[sz] = '\0';
+        wxStrncpy(buf, wxConvertMB2WX(uts.nodename), sz - 1);
+        buf[sz] = wxT('\0');
     }
 #elif defined(HAVE_GETHOSTNAME)
     bool ok = gethostname(buf, sz) != -1;
-#else
-    wxFAIL_MSG("don't know host name for this machibe");
+#else // no uname, no gethostname
+    wxFAIL_MSG(wxT("don't know host name for this machine"));
 
     bool ok = FALSE;
-#endif
+#endif // uname/gethostname
 
     if ( !ok )
     {
@@ -401,37 +517,97 @@ bool wxGetHostName(char *buf, int sz)
     return ok;
 }
 
-bool wxGetUserId(char *buf, int sz)
+bool wxGetHostName(wxChar *buf, int sz)
+{
+    bool ok = wxGetHostNameInternal(buf, sz);
+
+    if ( ok )
+    {
+        // BSD systems return the FQDN, we only want the hostname, so extract
+        // it (we consider that dots are domain separators)
+        wxChar *dot = wxStrchr(buf, wxT('.'));
+        if ( dot )
+        {
+            // nuke it
+            *dot = wxT('\0');
+        }
+    }
+
+    return ok;
+}
+
+bool wxGetFullHostName(wxChar *buf, int sz)
+{
+    bool ok = wxGetHostNameInternal(buf, sz);
+
+    if ( ok )
+    {
+        if ( !wxStrchr(buf, wxT('.')) )
+        {
+            struct hostent *host = gethostbyname(wxConvertWX2MB(buf));
+            if ( !host )
+            {
+                wxLogSysError(_("Cannot get the official hostname"));
+
+                ok = FALSE;
+            }
+            else
+            {
+                // the canonical name
+                wxStrncpy(buf, wxConvertMB2WX(host->h_name), sz);
+            }
+        }
+        //else: it's already a FQDN (BSD behaves this way)
+    }
+
+    return ok;
+}
+
+bool wxGetUserId(wxChar *buf, int sz)
 {
     struct passwd *who;
 
-    *buf = '\0';
+    *buf = wxT('\0');
     if ((who = getpwuid(getuid ())) != NULL)
     {
-        strncpy (buf, who->pw_name, sz - 1);
+        wxStrncpy (buf, wxConvertMB2WX(who->pw_name), sz - 1);
         return TRUE;
     }
 
     return FALSE;
 }
 
-bool wxGetUserName(char *buf, int sz)
+bool wxGetUserName(wxChar *buf, int sz)
 {
     struct passwd *who;
-    char *comma;
 
-    *buf = '\0';
-    if ((who = getpwuid (getuid ())) != NULL) {
-       comma = strchr(who->pw_gecos, ',');
+    *buf = wxT('\0');
+    if ((who = getpwuid (getuid ())) != NULL)
+    {
+        // pw_gecos field in struct passwd is not standard
+#if HAVE_PW_GECOS
+       char *comma = strchr(who->pw_gecos, ',');
        if (comma)
            *comma = '\0'; // cut off non-name comment fields
-       strncpy (buf, who->pw_gecos, sz - 1);
+       wxStrncpy (buf, wxConvertMB2WX(who->pw_gecos), sz - 1);
+#else // !HAVE_PW_GECOS
+       wxStrncpy (buf, wxConvertMB2WX(who->pw_name), sz - 1);
+#endif // HAVE_PW_GECOS/!HAVE_PW_GECOS
        return TRUE;
     }
 
     return FALSE;
 }
 
+wxString wxGetOsDescription()
+{
+#ifndef WXWIN_OS_DESCRIPTION
+    #error WXWIN_OS_DESCRIPTION should be defined in config.h by configure
+#else
+    return WXWIN_OS_DESCRIPTION;
+#endif
+}
+
 // ----------------------------------------------------------------------------
 // error and debug output routines (deprecated, use wxLog)
 // ----------------------------------------------------------------------------
@@ -447,29 +623,18 @@ void wxDebugMsg( const char *format, ... )
 
 void wxError( const wxString &msg, const wxString &title )
 {
-  fprintf( stderr, _("Error ") );
-  if (!title.IsNull()) fprintf( stderr, "%s ", WXSTRINGCAST(title) );
-  if (!msg.IsNull()) fprintf( stderr, ": %s", WXSTRINGCAST(msg) );
-  fprintf( stderr, ".\n" );
+  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 )
 {
-  fprintf( stderr, _("Error ") );
-  if (!title.IsNull()) fprintf( stderr, "%s ", WXSTRINGCAST(title) );
-  if (!msg.IsNull()) fprintf( stderr, ": %s", WXSTRINGCAST(msg) );
-  fprintf( stderr, ".\n" );
+  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()
 }
 
-//------------------------------------------------------------------------
-// directory routines
-//------------------------------------------------------------------------
-
-bool wxDirExists( const wxString& dir )
-{
-    char buf[500];
-    strcpy( buf, WXSTRINGCAST(dir) );
-    struct stat sbuf;
-    return ((stat(buf, &sbuf) != -1) && S_ISDIR(sbuf.st_mode) ? TRUE : FALSE);
-}