1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: exec sample demonstrates wxExecute and related functions
4 // Author: Vadim Zeitlin
8 // Copyright: (c) Vadim Zeitlin
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
12 // ============================================================================
14 // ============================================================================
16 // ----------------------------------------------------------------------------
18 // ----------------------------------------------------------------------------
21 #pragma implementation "exec.cpp"
22 #pragma interface "exec.cpp"
25 // For compilers that support precompilation, includes "wx/wx.h".
26 #include "wx/wxprec.h"
32 // for all others, include the necessary headers (this file is usually all you
33 // need because it includes almost all "standard" wxWindows headers
41 #include "wx/msgdlg.h"
42 #include "wx/textdlg.h"
43 #include "wx/filedlg.h"
44 #include "wx/choicdlg.h"
46 #include "wx/button.h"
47 #include "wx/textctrl.h"
48 #include "wx/listbox.h"
53 #include "wx/txtstrm.h"
55 #include "wx/process.h"
57 #include "wx/mimetype.h"
63 // ----------------------------------------------------------------------------
64 // the usual application and main frame classes
65 // ----------------------------------------------------------------------------
67 // Define a new application type, each program should derive a class from wxApp
68 class MyApp
: public wxApp
71 // override base class virtuals
72 // ----------------------------
74 // this one is called on application startup and is a good place for the app
75 // initialization (doing it here and not in the ctor allows to have an error
76 // return: if OnInit() returns false, the application terminates)
77 virtual bool OnInit();
80 // Define an array of process pointers used by MyFrame
82 WX_DEFINE_ARRAY(MyPipedProcess
*, MyProcessesArray
);
84 // Define a new frame type: this is going to be our main frame
85 class MyFrame
: public wxFrame
89 MyFrame(const wxString
& title
, const wxPoint
& pos
, const wxSize
& size
);
91 // event handlers (these functions should _not_ be virtual)
92 void OnQuit(wxCommandEvent
& event
);
94 void OnKill(wxCommandEvent
& event
);
96 void OnClear(wxCommandEvent
& event
);
98 void OnSyncExec(wxCommandEvent
& event
);
99 void OnAsyncExec(wxCommandEvent
& event
);
100 void OnShell(wxCommandEvent
& event
);
101 void OnExecWithRedirect(wxCommandEvent
& event
);
102 void OnExecWithPipe(wxCommandEvent
& event
);
104 void OnPOpen(wxCommandEvent
& event
);
106 void OnFileExec(wxCommandEvent
& event
);
108 void OnAbout(wxCommandEvent
& event
);
110 // polling output of async processes
111 void OnIdle(wxIdleEvent
& event
);
113 // for MyPipedProcess
114 void OnProcessTerminated(MyPipedProcess
*process
);
115 wxListBox
*GetLogListBox() const { return m_lbox
; }
118 void ShowOutput(const wxString
& cmd
,
119 const wxArrayString
& output
,
120 const wxString
& title
);
122 void DoAsyncExec(const wxString
& cmd
);
124 // the PID of the last process we launched asynchronously
127 // last command we executed
131 void OnDDEExec(wxCommandEvent
& event
);
132 void OnDDERequest(wxCommandEvent
& event
);
136 // last params of a DDE transaction
140 #endif // __WINDOWS__
144 MyProcessesArray m_running
;
146 // any class wishing to process wxWindows events must use this macro
147 DECLARE_EVENT_TABLE()
150 // ----------------------------------------------------------------------------
151 // MyPipeFrame: allows the user to communicate with the child process
152 // ----------------------------------------------------------------------------
154 class MyPipeFrame
: public wxFrame
157 MyPipeFrame(wxFrame
*parent
,
162 void OnTextEnter(wxCommandEvent
& event
) { DoSend(); }
163 void OnBtnSend(wxCommandEvent
& event
) { DoSend(); }
164 void OnBtnGet(wxCommandEvent
& event
) { DoGet(); }
166 void OnClose(wxCloseEvent
& event
);
168 void DoSend() { m_out
.WriteString(m_textIn
->GetValue() + '\n'); DoGet(); }
172 wxProcess
*m_process
;
174 wxTextInputStream m_in
;
175 wxTextOutputStream m_out
;
177 wxTextCtrl
*m_textIn
,
180 DECLARE_EVENT_TABLE()
183 // ----------------------------------------------------------------------------
184 // wxProcess-derived classes
185 // ----------------------------------------------------------------------------
187 // This is the handler for process termination events
188 class MyProcess
: public wxProcess
191 MyProcess(MyFrame
*parent
, const wxString
& cmd
)
192 : wxProcess(parent
), m_cmd(cmd
)
197 // instead of overriding this virtual function we might as well process the
198 // event from it in the frame class - this might be more convenient in some
200 virtual void OnTerminate(int pid
, int status
);
207 // A specialization of MyProcess for redirecting the output
208 class MyPipedProcess
: public MyProcess
211 MyPipedProcess(MyFrame
*parent
, const wxString
& cmd
)
212 : MyProcess(parent
, cmd
)
217 virtual void OnTerminate(int pid
, int status
);
219 virtual bool HasInput();
222 // A version of MyPipedProcess which also sends input to the stdin of the
224 class MyPipedProcess2
: public MyPipedProcess
227 MyPipedProcess2(MyFrame
*parent
, const wxString
& cmd
, const wxString
& input
)
228 : MyPipedProcess(parent
, cmd
), m_input(input
)
232 virtual bool HasInput();
238 // ----------------------------------------------------------------------------
240 // ----------------------------------------------------------------------------
242 // IDs for the controls and the menu commands
261 Exec_Btn_Send
= 1000,
265 static const wxChar
*DIALOG_TITLE
= _T("Exec sample");
267 // ----------------------------------------------------------------------------
268 // event tables and other macros for wxWindows
269 // ----------------------------------------------------------------------------
271 // the event tables connect the wxWindows events with the functions (event
272 // handlers) which process them. It can be also done at run-time, but for the
273 // simple menu events like this the static method is much simpler.
274 BEGIN_EVENT_TABLE(MyFrame
, wxFrame
)
275 EVT_MENU(Exec_Quit
, MyFrame::OnQuit
)
276 EVT_MENU(Exec_Kill
, MyFrame::OnKill
)
277 EVT_MENU(Exec_ClearLog
, MyFrame::OnClear
)
279 EVT_MENU(Exec_SyncExec
, MyFrame::OnSyncExec
)
280 EVT_MENU(Exec_AsyncExec
, MyFrame::OnAsyncExec
)
281 EVT_MENU(Exec_Shell
, MyFrame::OnShell
)
282 EVT_MENU(Exec_Redirect
, MyFrame::OnExecWithRedirect
)
283 EVT_MENU(Exec_Pipe
, MyFrame::OnExecWithPipe
)
285 EVT_MENU(Exec_POpen
, MyFrame::OnPOpen
)
287 EVT_MENU(Exec_OpenFile
, MyFrame::OnFileExec
)
290 EVT_MENU(Exec_DDEExec
, MyFrame::OnDDEExec
)
291 EVT_MENU(Exec_DDERequest
, MyFrame::OnDDERequest
)
292 #endif // __WINDOWS__
294 EVT_MENU(Exec_About
, MyFrame::OnAbout
)
296 EVT_IDLE(MyFrame::OnIdle
)
299 BEGIN_EVENT_TABLE(MyPipeFrame
, wxFrame
)
300 EVT_BUTTON(Exec_Btn_Send
, MyPipeFrame::OnBtnSend
)
301 EVT_BUTTON(Exec_Btn_Get
, MyPipeFrame::OnBtnGet
)
303 EVT_TEXT_ENTER(-1, MyPipeFrame::OnTextEnter
)
305 EVT_CLOSE(MyPipeFrame::OnClose
)
308 // Create a new application object: this macro will allow wxWindows to create
309 // the application object during program execution (it's better than using a
310 // static object for many reasons) and also declares the accessor function
311 // wxGetApp() which will return the reference of the right type (i.e. MyApp and
315 // ============================================================================
317 // ============================================================================
319 // ----------------------------------------------------------------------------
320 // the application class
321 // ----------------------------------------------------------------------------
323 // `Main program' equivalent: the program execution "starts" here
326 // Create the main application window
327 MyFrame
*frame
= new MyFrame(_T("Exec wxWindows sample"),
328 wxDefaultPosition
, wxSize(500, 140));
330 // Show it and tell the application that it's our main window
334 // success: wxApp::OnRun() will be called which will enter the main message
335 // loop and the application will run. If we returned FALSE here, the
336 // application would exit immediately.
340 // ----------------------------------------------------------------------------
342 // ----------------------------------------------------------------------------
345 MyFrame::MyFrame(const wxString
& title
, const wxPoint
& pos
, const wxSize
& size
)
346 : wxFrame((wxFrame
*)NULL
, -1, title
, pos
, size
)
351 // we need this in order to allow the about menu relocation, since ABOUT is
352 // not the default id of the about menu
353 wxApp::s_macAboutMenuItemId
= Exec_About
;
357 wxMenu
*menuFile
= new wxMenu(_T(""), wxMENU_TEAROFF
);
358 menuFile
->Append(Exec_Kill
, _T("&Kill process...\tCtrl-K"),
359 _T("Kill a process by PID"));
360 menuFile
->AppendSeparator();
361 menuFile
->Append(Exec_ClearLog
, _T("&Clear log\tCtrl-C"),
362 _T("Clear the log window"));
363 menuFile
->AppendSeparator();
364 menuFile
->Append(Exec_Quit
, _T("E&xit\tAlt-X"), _T("Quit this program"));
366 wxMenu
*execMenu
= new wxMenu
;
367 execMenu
->Append(Exec_SyncExec
, _T("Sync &execution...\tCtrl-E"),
368 _T("Launch a program and return when it terminates"));
369 execMenu
->Append(Exec_AsyncExec
, _T("&Async execution...\tCtrl-A"),
370 _T("Launch a program and return immediately"));
371 execMenu
->Append(Exec_Shell
, _T("Execute &shell command...\tCtrl-S"),
372 _T("Launch a shell and execute a command in it"));
373 execMenu
->AppendSeparator();
374 execMenu
->Append(Exec_Redirect
, _T("Capture command &output...\tCtrl-O"),
375 _T("Launch a program and capture its output"));
376 execMenu
->Append(Exec_Pipe
, _T("&Pipe through command..."),
377 _T("Pipe a string through a filter"));
378 execMenu
->Append(Exec_POpen
, _T("&Open a pipe to a command...\tCtrl-P"),
379 _T("Open a pipe to and from another program"));
381 execMenu
->AppendSeparator();
382 execMenu
->Append(Exec_OpenFile
, _T("Open &file...\tCtrl-F"),
383 _T("Launch the command to open this kind of files"));
385 execMenu
->AppendSeparator();
386 execMenu
->Append(Exec_DDEExec
, _T("Execute command via &DDE...\tCtrl-D"));
387 execMenu
->Append(Exec_DDERequest
, _T("Send DDE &request...\tCtrl-R"));
390 wxMenu
*helpMenu
= new wxMenu(_T(""), wxMENU_TEAROFF
);
391 helpMenu
->Append(Exec_About
, _T("&About...\tF1"), _T("Show about dialog"));
393 // now append the freshly created menu to the menu bar...
394 wxMenuBar
*menuBar
= new wxMenuBar();
395 menuBar
->Append(menuFile
, _T("&File"));
396 menuBar
->Append(execMenu
, _T("&Exec"));
397 menuBar
->Append(helpMenu
, _T("&Help"));
399 // ... and attach this menu bar to the frame
402 // create the listbox in which we will show misc messages as they come
403 m_lbox
= new wxListBox(this, -1);
404 wxFont
font(12, wxFONTFAMILY_TELETYPE
, wxFONTSTYLE_NORMAL
,
405 wxFONTWEIGHT_NORMAL
);
407 m_lbox
->SetFont(font
);
410 // create a status bar just for fun (by default with 1 pane only)
412 SetStatusText(_T("Welcome to wxWindows exec sample!"));
413 #endif // wxUSE_STATUSBAR
416 // ----------------------------------------------------------------------------
417 // event handlers: file and help menu
418 // ----------------------------------------------------------------------------
420 void MyFrame::OnQuit(wxCommandEvent
& WXUNUSED(event
))
422 // TRUE is to force the frame to close
426 void MyFrame::OnClear(wxCommandEvent
& WXUNUSED(event
))
431 void MyFrame::OnAbout(wxCommandEvent
& WXUNUSED(event
))
433 wxMessageBox(_T("Exec wxWindows Sample\n© 2000-2001 Vadim Zeitlin"),
434 _T("About Exec"), wxOK
| wxICON_INFORMATION
, this);
437 void MyFrame::OnKill(wxCommandEvent
& WXUNUSED(event
))
439 long pid
= wxGetNumberFromUser(_T("Please specify the process to kill"),
443 // we need the full unsigned int range
452 static const wxString signalNames
[] =
454 _T("Just test (SIGNONE)"),
455 _T("Hangup (SIGHUP)"),
456 _T("Interrupt (SIGINT)"),
457 _T("Quit (SIGQUIT)"),
458 _T("Illegal instruction (SIGILL)"),
459 _T("Trap (SIGTRAP)"),
460 _T("Abort (SIGABRT)"),
461 _T("Emulated trap (SIGEMT)"),
462 _T("FP exception (SIGFPE)"),
463 _T("Kill (SIGKILL)"),
465 _T("Segment violation (SIGSEGV)"),
466 _T("System (SIGSYS)"),
467 _T("Broken pipe (SIGPIPE)"),
468 _T("Alarm (SIGALRM)"),
469 _T("Terminate (SIGTERM)"),
472 int sig
= wxGetSingleChoiceIndex(_T("How to kill the process?"),
474 WXSIZEOF(signalNames
), signalNames
,
479 wxFAIL_MSG( _T("unexpected return value") );
507 if ( wxProcess::Exists(pid
) )
508 wxLogStatus(_T("Process %ld is running."), pid
);
510 wxLogStatus(_T("No process with pid = %ld."), pid
);
514 wxKillError rc
= wxProcess::Kill(pid
, (wxSignal
)sig
);
515 if ( rc
== wxKILL_OK
)
517 wxLogStatus(_T("Process %ld killed with signal %d."), pid
, sig
);
521 static const wxChar
*errorText
[] =
524 _T("signal not supported"),
525 _T("permission denied"),
526 _T("no such process"),
527 _T("unspecified error"),
530 wxLogStatus(_T("Failed to kill process %ld with signal %d: %s"),
531 pid
, sig
, errorText
[rc
]);
536 // ----------------------------------------------------------------------------
537 // event handlers: exec menu
538 // ----------------------------------------------------------------------------
540 void MyFrame::DoAsyncExec(const wxString
& cmd
)
542 wxProcess
*process
= new MyProcess(this, cmd
);
543 m_pidLast
= wxExecute(cmd
, wxEXEC_ASYNC
, process
);
546 wxLogError( _T("Execution of '%s' failed."), cmd
.c_str() );
552 wxLogStatus( _T("Process %ld (%s) launched."),
553 m_pidLast
, cmd
.c_str() );
559 void MyFrame::OnSyncExec(wxCommandEvent
& WXUNUSED(event
))
561 wxString cmd
= wxGetTextFromUser(_T("Enter the command: "),
568 wxLogStatus( _T("'%s' is running please wait..."), cmd
.c_str() );
570 int code
= wxExecute(cmd
, wxEXEC_SYNC
);
572 wxLogStatus(_T("Process '%s' terminated with exit code %d."),
578 void MyFrame::OnAsyncExec(wxCommandEvent
& WXUNUSED(event
))
580 wxString cmd
= wxGetTextFromUser(_T("Enter the command: "),
590 void MyFrame::OnShell(wxCommandEvent
& WXUNUSED(event
))
592 wxString cmd
= wxGetTextFromUser(_T("Enter the command: "),
599 int code
= wxShell(cmd
);
600 wxLogStatus(_T("Shell command '%s' terminated with exit code %d."),
605 void MyFrame::OnExecWithRedirect(wxCommandEvent
& WXUNUSED(event
))
607 wxString cmd
= wxGetTextFromUser(_T("Enter the command: "),
615 switch ( wxMessageBox(_T("Execute it synchronously?"),
617 wxYES_NO
| wxCANCEL
| wxICON_QUESTION
, this) )
633 wxArrayString output
, errors
;
634 int code
= wxExecute(cmd
, output
, errors
);
635 wxLogStatus(_T("command '%s' terminated with exit code %d."),
640 ShowOutput(cmd
, output
, _T("Output"));
641 ShowOutput(cmd
, errors
, _T("Errors"));
646 MyPipedProcess
*process
= new MyPipedProcess(this, cmd
);
647 if ( !wxExecute(cmd
, wxEXEC_ASYNC
, process
) )
649 wxLogError(_T("Execution of '%s' failed."), cmd
.c_str());
655 m_running
.Add(process
);
662 void MyFrame::OnExecWithPipe(wxCommandEvent
& WXUNUSED(event
))
665 m_cmdLast
= _T("tr [a-z] [A-Z]");
667 wxString cmd
= wxGetTextFromUser(_T("Enter the command: "),
674 wxString input
= wxGetTextFromUser(_T("Enter the string to send to it: "),
679 // always execute the filter asynchronously
680 MyPipedProcess2
*process
= new MyPipedProcess2(this, cmd
, input
);
681 long pid
= wxExecute(cmd
, wxEXEC_ASYNC
, process
);
684 wxLogStatus( _T("Process %ld (%s) launched."), pid
, cmd
.c_str() );
686 m_running
.Add(process
);
690 wxLogError(_T("Execution of '%s' failed."), cmd
.c_str());
698 void MyFrame::OnPOpen(wxCommandEvent
& event
)
700 wxString cmd
= wxGetTextFromUser(_T("Enter the command to launch: "),
706 wxProcess
*process
= wxProcess::Open(cmd
);
709 wxLogError(_T("Failed to launch the command."));
713 wxOutputStream
*out
= process
->GetOutputStream();
716 wxLogError(_T("Failed to connect to child stdin"));
720 wxInputStream
*in
= process
->GetInputStream();
723 wxLogError(_T("Failed to connect to child stdout"));
727 new MyPipeFrame(this, cmd
, process
);
730 void MyFrame::OnFileExec(wxCommandEvent
& event
)
732 static wxString s_filename
;
734 wxString filename
= wxLoadFileSelector(_T(""), _T(""), s_filename
);
738 s_filename
= filename
;
740 wxString ext
= filename
.AfterFirst(_T('.'));
741 wxFileType
*ft
= wxTheMimeTypesManager
->GetFileTypeFromExtension(ext
);
744 wxLogError(_T("Impossible to determine the file type for extension '%s'"),
750 bool ok
= ft
->GetOpenCommand(&cmd
,
751 wxFileType::MessageParameters(filename
, _T("")));
755 wxLogError(_T("Impossible to find out how to open files of extension '%s'"),
763 // ----------------------------------------------------------------------------
765 // ----------------------------------------------------------------------------
769 bool MyFrame::GetDDEServer()
771 wxString server
= wxGetTextFromUser(_T("Server to connect to:"),
772 DIALOG_TITLE
, m_server
);
778 wxString topic
= wxGetTextFromUser(_T("DDE topic:"), DIALOG_TITLE
, m_topic
);
784 wxString cmd
= wxGetTextFromUser(_T("DDE command:"), DIALOG_TITLE
, m_cmdDde
);
793 void MyFrame::OnDDEExec(wxCommandEvent
& WXUNUSED(event
))
795 if ( !GetDDEServer() )
799 wxConnectionBase
*conn
= client
.MakeConnection("", m_server
, m_topic
);
802 wxLogError(_T("Failed to connect to the DDE server '%s'."),
807 if ( !conn
->Execute(m_cmdDde
) )
809 wxLogError(_T("Failed to execute command '%s' via DDE."),
814 wxLogStatus(_T("Successfully executed DDE command"));
819 void MyFrame::OnDDERequest(wxCommandEvent
& WXUNUSED(event
))
821 if ( !GetDDEServer() )
825 wxConnectionBase
*conn
= client
.MakeConnection("", m_server
, m_topic
);
828 wxLogError(_T("Failed to connect to the DDE server '%s'."),
833 if ( !conn
->Request(m_cmdDde
) )
835 wxLogError(_T("Failed to send request '%s' via DDE."),
840 wxLogStatus(_T("Successfully sent DDE request."));
845 #endif // __WINDOWS__
847 // ----------------------------------------------------------------------------
849 // ----------------------------------------------------------------------------
852 void MyFrame::OnIdle(wxIdleEvent
& event
)
854 size_t count
= m_running
.GetCount();
855 for ( size_t n
= 0; n
< count
; n
++ )
857 if ( m_running
[n
]->HasInput() )
864 void MyFrame::OnProcessTerminated(MyPipedProcess
*process
)
866 m_running
.Remove(process
);
870 void MyFrame::ShowOutput(const wxString
& cmd
,
871 const wxArrayString
& output
,
872 const wxString
& title
)
874 size_t count
= output
.GetCount();
878 m_lbox
->Append(wxString::Format(_T("--- %s of '%s' ---"),
879 title
.c_str(), cmd
.c_str()));
881 for ( size_t n
= 0; n
< count
; n
++ )
883 m_lbox
->Append(output
[n
]);
886 m_lbox
->Append(wxString::Format(_T("--- End of %s ---"),
887 title
.Lower().c_str()));
890 // ----------------------------------------------------------------------------
892 // ----------------------------------------------------------------------------
894 void MyProcess::OnTerminate(int pid
, int status
)
896 wxLogStatus(m_parent
, _T("Process %u ('%s') terminated with exit code %d."),
897 pid
, m_cmd
.c_str(), status
);
899 // we're not needed any more
903 // ----------------------------------------------------------------------------
905 // ----------------------------------------------------------------------------
907 bool MyPipedProcess::HasInput()
909 bool hasInput
= FALSE
;
911 wxInputStream
& is
= *GetInputStream();
914 wxTextInputStream
tis(is
);
916 // this assumes that the output is always line buffered
918 msg
<< m_cmd
<< _T(" (stdout): ") << tis
.ReadLine();
920 m_parent
->GetLogListBox()->Append(msg
);
925 wxInputStream
& es
= *GetErrorStream();
928 wxTextInputStream
tis(es
);
930 // this assumes that the output is always line buffered
932 msg
<< m_cmd
<< _T(" (stderr): ") << tis
.ReadLine();
934 m_parent
->GetLogListBox()->Append(msg
);
942 void MyPipedProcess::OnTerminate(int pid
, int status
)
944 // show the rest of the output
948 m_parent
->OnProcessTerminated(this);
950 MyProcess::OnTerminate(pid
, status
);
953 // ----------------------------------------------------------------------------
955 // ----------------------------------------------------------------------------
957 bool MyPipedProcess2::HasInput()
961 wxTextOutputStream
os(*GetOutputStream());
962 os
.WriteString(m_input
);
967 // call us once again - may be we'll have output
971 return MyPipedProcess::HasInput();
974 // ============================================================================
975 // MyPipeFrame implementation
976 // ============================================================================
978 MyPipeFrame::MyPipeFrame(wxFrame
*parent
,
981 : wxFrame(parent
, -1, cmd
),
983 // in a real program we'd check that the streams are !NULL here
984 m_in(*process
->GetInputStream()),
985 m_out(*process
->GetOutputStream())
987 m_textIn
= new wxTextCtrl(this, -1, _T(""),
988 wxDefaultPosition
, wxDefaultSize
,
990 m_textOut
= new wxTextCtrl(this, -1, _T(""));
991 m_textOut
->SetEditable(FALSE
);
993 wxSizer
*sizerTop
= new wxBoxSizer(wxVERTICAL
);
994 sizerTop
->Add(m_textIn
, 0, wxGROW
| wxALL
, 5);
996 wxSizer
*sizerBtns
= new wxBoxSizer(wxHORIZONTAL
);
997 sizerBtns
->Add(new wxButton(this, Exec_Btn_Send
, _T("&Send")), 0,
999 sizerBtns
->Add(new wxButton(this, Exec_Btn_Get
, _T("&Get")), 0,
1002 sizerTop
->Add(sizerBtns
, 0, wxCENTRE
| wxALL
, 5);
1003 sizerTop
->Add(m_textOut
, 0, wxGROW
| wxALL
, 5);
1006 sizerTop
->Fit(this);
1011 void MyPipeFrame::DoGet()
1013 m_textOut
->SetValue(m_in
.ReadLine());
1016 void MyPipeFrame::OnClose(wxCloseEvent
& event
)
1018 m_process
->CloseOutput();