include/wx/unix/apptbase.h

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/unix/apptbase.h
   3 // Purpose:     declaration of wxAppTraits for Unix systems
   4 // Author:      Vadim Zeitlin
   5 // Modified by:
   6 // Created:     23.06.2003
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) 2003 Vadim Zeitlin <vadim@wxwidgets.org>
   9 // Licence:     wxWindows licence
  10 ///////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_UNIX_APPTBASE_H_
  13 #define _WX_UNIX_APPTBASE_H_
  14
  15 struct wxEndProcessData;
  16 struct wxExecuteData;
  17 class wxPipe;
  18
  19 // ----------------------------------------------------------------------------
  20 // wxAppTraits: the Unix version adds extra hooks needed by Unix code
  21 // ----------------------------------------------------------------------------
  22
  23 class WXDLLIMPEXP_BASE wxAppTraits : public wxAppTraitsBase
  24 {
  25 public:
  26     // wxExecute() support methods
  27     // ---------------------------
  28
  29     // called before starting the child process and creates the pipe used for
  30     // detecting the process termination asynchronously in GUI, does nothing in
  31     // wxBase
  32     //
  33     // if it returns false, we should return from wxExecute() with an error
  34     virtual bool CreateEndProcessPipe(wxExecuteData& execData);
  35
  36     // test if the given descriptor is the end of the pipe create by the
  37     // function above
  38     virtual bool IsWriteFDOfEndProcessPipe(wxExecuteData& execData, int fd);
  39
  40     // ensure that the write end of the pipe is not closed by wxPipe dtor
  41     virtual void DetachWriteFDOfEndProcessPipe(wxExecuteData& execData);
  42
  43     // wait for the process termination, return whatever wxExecute() must
  44     // return
  45     //
  46     // base class implementation handles all cases except wxEXEC_SYNC without
  47     // wxEXEC_NOEVENTS one which is implemented at the GUI level
  48     virtual int WaitForChild(wxExecuteData& execData);
  49
  50     // integrate the monitoring of the given fd with the port-specific event
  51     // loop: when this fd, which corresponds to a dummy pipe opened between the
  52     // parent and child processes, is closed by the child, the parent is
  53     // notified about this via a call to wxHandleProcessTermination() function
  54     //
  55     // the default implementation uses wxFDIODispatcher and so is suitable for
  56     // the console applications or ports which don't have any specific event
  57     // loop
  58     virtual int AddProcessCallback(wxEndProcessData *data, int fd);
  59
  60
  61     // wxThread helpers
  62     // ----------------
  63
  64     // TODO
  65
  66 #if wxUSE_SOCKETS
  67     // returns the select()-based socket manager for console applications which
  68     // is also used by some ports (wxX11, wxDFB) in the GUI build (hence it is
  69     // here and not in wxConsoleAppTraits)
  70     virtual GSocketManager *GetSocketManager();
  71 #endif
  72
  73 protected:
  74     // a helper for the implementation of WaitForChild() in wxGUIAppTraits:
  75     // checks the streams used for redirected IO in execData and returns true
  76     // if there is any activity in them
  77     bool CheckForRedirectedIO(wxExecuteData& execData);
  78 };
  79
  80 #endif // _WX_UNIX_APPTBASE_H_
  81