include/wx/unix/execute.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        unix/execute.h
   3 // Purpose:     private details of wxExecute() implementation
   4 // Author:      Vadim Zeitlin
   5 // Id:          $Id$
   6 // Copyright:   (c) 1998 Robert Roebling, Julian Smart, Vadim Zeitlin
   7 // Licence:     wxWindows licence
   8 /////////////////////////////////////////////////////////////////////////////
   9
  10 #ifndef _WX_UNIX_EXECUTE_H
  11 #define _WX_UNIX_EXECUTE_H
  12
  13 #include "wx/unix/pipe.h"
  14
  15 class WXDLLIMPEXP_FWD_BASE wxProcess;
  16 class wxStreamTempInputBuffer;
  17
  18 // some ports have toolkit-specific implementations of wxAddProcessCallback()
  19 // but by default we use a generic wxFDIOHandler-based mechanism under Unix
  20 #if defined(__UNIX__) && \
  21     !(defined(__WXGTK__) || defined(__WXMOTIF__) || defined(__WXMGL__))
  22     #define wxHAS_GENERIC_PROCESS_CALLBACK 1
  23 #endif
  24
  25 #ifdef wxHAS_GENERIC_PROCESS_CALLBACK
  26 struct wxEndProcessFDIOHandler;
  27 #endif
  28
  29 // if pid > 0, the execution is async and the data is freed in the callback
  30 // executed when the process terminates, if pid < 0, the execution is
  31 // synchronous and the caller (wxExecute) frees the data
  32 struct wxEndProcessData
  33 {
  34     int pid;                // pid of the process
  35     int tag;                // port dependent value
  36     wxProcess *process;     // if !NULL: notified on process termination
  37     int  exitcode;          // the exit code
  38
  39 #ifdef wxHAS_GENERIC_PROCESS_CALLBACK
  40     wxEndProcessFDIOHandler *fdioHandler;
  41 #endif
  42 };
  43
  44 // struct in which information is passed from wxExecute() to wxAppTraits
  45 // methods
  46 struct wxExecuteData
  47 {
  48     wxExecuteData()
  49     {
  50         flags =
  51         pid = 0;
  52
  53         process = NULL;
  54
  55 #if wxUSE_STREAMS
  56         bufOut =
  57         bufErr = NULL;
  58 #endif // wxUSE_STREAMS
  59     }
  60
  61     // wxExecute() flags
  62     int flags;
  63
  64     // the pid of the child process
  65     int pid;
  66
  67     // the associated process object or NULL
  68     wxProcess *process;
  69
  70     // pipe used for end process detection
  71     wxPipe pipeEndProcDetect;
  72
  73 #if wxUSE_STREAMS
  74     // the input buffer bufOut is connected to stdout, this is why it is
  75     // called bufOut and not bufIn
  76     wxStreamTempInputBuffer *bufOut,
  77                             *bufErr;
  78 #endif // wxUSE_STREAMS
  79 };
  80
  81 // this function is called when the process terminates from port specific
  82 // callback function and is common to all ports (src/unix/utilsunx.cpp)
  83 extern WXDLLIMPEXP_BASE void wxHandleProcessTermination(wxEndProcessData *proc_data);
  84
  85 // This function is called to associate the port-specific callback with the
  86 // child process. The return valus is port-specific.
  87 //
  88 // The file descriptor 'fd' is descriptor of a dummy pipe opened between the
  89 // parent and the child. No data are written to or read from this pipe, its
  90 // sole purpose is that the child process will close it when it terminates and
  91 // the parent will be notified about it if it looks at 'fd' (e.g. using
  92 // select()).
  93 //
  94 // wxAddProcessCallback() does whatever is necessary to ensure that 'fd' is
  95 // periodically (typically every event loop iteration) checked for its status
  96 // and that wxHandleProcessTermination() is called once 'fd' indicates the
  97 // child terminated.
  98 extern WXDLLIMPEXP_CORE int wxAddProcessCallback(wxEndProcessData *proc_data, int fd);
  99
 100 #if defined(__WXMAC__) || defined(__WXCOCOA__)
 101 // For ports (e.g. DARWIN) which can add callbacks based on the pid
 102 extern int wxAddProcessCallbackForPid(wxEndProcessData *proc_data, int pid);
 103 #endif
 104
 105 #endif // _WX_UNIX_EXECUTE_H