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
39 #include "wx/msgdlg.h"
40 #include "wx/textdlg.h"
41 #include "wx/listbox.h"
42 #include "wx/filedlg.h"
43 #include "wx/choicdlg.h"
46 #include "wx/txtstrm.h"
48 #include "wx/process.h"
50 #include "wx/mimetype.h"
56 // ----------------------------------------------------------------------------
58 // ----------------------------------------------------------------------------
60 // Define a new application type, each program should derive a class from wxApp
61 class MyApp
: public wxApp
64 // override base class virtuals
65 // ----------------------------
67 // this one is called on application startup and is a good place for the app
68 // initialization (doing it here and not in the ctor allows to have an error
69 // return: if OnInit() returns false, the application terminates)
70 virtual bool OnInit();
73 // Define an array of process pointers used by MyFrame
75 WX_DEFINE_ARRAY(MyPipedProcess
*, MyProcessesArray
);
77 // Define a new frame type: this is going to be our main frame
78 class MyFrame
: public wxFrame
82 MyFrame(const wxString
& title
, const wxPoint
& pos
, const wxSize
& size
);
84 // event handlers (these functions should _not_ be virtual)
85 void OnQuit(wxCommandEvent
& event
);
87 void OnKill(wxCommandEvent
& event
);
89 void OnClear(wxCommandEvent
& event
);
91 void OnSyncExec(wxCommandEvent
& event
);
92 void OnAsyncExec(wxCommandEvent
& event
);
93 void OnShell(wxCommandEvent
& event
);
94 void OnExecWithRedirect(wxCommandEvent
& event
);
95 void OnExecWithPipe(wxCommandEvent
& event
);
97 void OnFileExec(wxCommandEvent
& event
);
99 void OnAbout(wxCommandEvent
& event
);
101 // polling output of async processes
102 void OnIdle(wxIdleEvent
& event
);
104 // for MyPipedProcess
105 void OnProcessTerminated(MyPipedProcess
*process
);
106 wxListBox
*GetLogListBox() const { return m_lbox
; }
109 void ShowOutput(const wxString
& cmd
,
110 const wxArrayString
& output
,
111 const wxString
& title
);
113 void DoAsyncExec(const wxString
& cmd
);
115 // the PID of the last process we launched asynchronously
118 // last command we executed
122 void OnDDEExec(wxCommandEvent
& event
);
123 void OnDDERequest(wxCommandEvent
& event
);
127 // last params of a DDE transaction
131 #endif // __WINDOWS__
135 MyProcessesArray m_running
;
137 // any class wishing to process wxWindows events must use this macro
138 DECLARE_EVENT_TABLE()
141 // This is the handler for process termination events
142 class MyProcess
: public wxProcess
145 MyProcess(MyFrame
*parent
, const wxString
& cmd
)
146 : wxProcess(parent
), m_cmd(cmd
)
151 // instead of overriding this virtual function we might as well process the
152 // event from it in the frame class - this might be more convenient in some
154 virtual void OnTerminate(int pid
, int status
);
161 // A specialization of MyProcess for redirecting the output
162 class MyPipedProcess
: public MyProcess
165 MyPipedProcess(MyFrame
*parent
, const wxString
& cmd
)
166 : MyProcess(parent
, cmd
)
171 virtual void OnTerminate(int pid
, int status
);
173 virtual bool HasInput();
176 // A version of MyPipedProcess which also sends input to the stdin of the
178 class MyPipedProcess2
: public MyPipedProcess
181 MyPipedProcess2(MyFrame
*parent
, const wxString
& cmd
, const wxString
& input
)
182 : MyPipedProcess(parent
, cmd
), m_input(input
)
186 virtual bool HasInput();
192 // ----------------------------------------------------------------------------
194 // ----------------------------------------------------------------------------
196 // IDs for the controls and the menu commands
214 static const wxChar
*DIALOG_TITLE
= _T("Exec sample");
216 // ----------------------------------------------------------------------------
217 // event tables and other macros for wxWindows
218 // ----------------------------------------------------------------------------
220 // the event tables connect the wxWindows events with the functions (event
221 // handlers) which process them. It can be also done at run-time, but for the
222 // simple menu events like this the static method is much simpler.
223 BEGIN_EVENT_TABLE(MyFrame
, wxFrame
)
224 EVT_MENU(Exec_Quit
, MyFrame::OnQuit
)
225 EVT_MENU(Exec_Kill
, MyFrame::OnKill
)
226 EVT_MENU(Exec_ClearLog
, MyFrame::OnClear
)
228 EVT_MENU(Exec_SyncExec
, MyFrame::OnSyncExec
)
229 EVT_MENU(Exec_AsyncExec
, MyFrame::OnAsyncExec
)
230 EVT_MENU(Exec_Shell
, MyFrame::OnShell
)
231 EVT_MENU(Exec_Redirect
, MyFrame::OnExecWithRedirect
)
232 EVT_MENU(Exec_Pipe
, MyFrame::OnExecWithPipe
)
234 EVT_MENU(Exec_OpenFile
, MyFrame::OnFileExec
)
237 EVT_MENU(Exec_DDEExec
, MyFrame::OnDDEExec
)
238 EVT_MENU(Exec_DDERequest
, MyFrame::OnDDERequest
)
239 #endif // __WINDOWS__
241 EVT_MENU(Exec_About
, MyFrame::OnAbout
)
243 EVT_IDLE(MyFrame::OnIdle
)
246 // Create a new application object: this macro will allow wxWindows to create
247 // the application object during program execution (it's better than using a
248 // static object for many reasons) and also declares the accessor function
249 // wxGetApp() which will return the reference of the right type (i.e. MyApp and
253 // ============================================================================
255 // ============================================================================
257 // ----------------------------------------------------------------------------
258 // the application class
259 // ----------------------------------------------------------------------------
261 // `Main program' equivalent: the program execution "starts" here
264 // Create the main application window
265 MyFrame
*frame
= new MyFrame(_T("Exec wxWindows sample"),
266 wxDefaultPosition
, wxSize(500, 140));
268 // Show it and tell the application that it's our main window
272 // success: wxApp::OnRun() will be called which will enter the main message
273 // loop and the application will run. If we returned FALSE here, the
274 // application would exit immediately.
278 // ----------------------------------------------------------------------------
280 // ----------------------------------------------------------------------------
283 MyFrame::MyFrame(const wxString
& title
, const wxPoint
& pos
, const wxSize
& size
)
284 : wxFrame((wxFrame
*)NULL
, -1, title
, pos
, size
)
289 // we need this in order to allow the about menu relocation, since ABOUT is
290 // not the default id of the about menu
291 wxApp::s_macAboutMenuItemId
= Exec_About
;
295 wxMenu
*menuFile
= new wxMenu(_T(""), wxMENU_TEAROFF
);
296 menuFile
->Append(Exec_Kill
, _T("&Kill process...\tCtrl-K"),
297 _T("Kill a process by PID"));
298 menuFile
->AppendSeparator();
299 menuFile
->Append(Exec_ClearLog
, _T("&Clear log\tCtrl-C"),
300 _T("Clear the log window"));
301 menuFile
->AppendSeparator();
302 menuFile
->Append(Exec_Quit
, _T("E&xit\tAlt-X"), _T("Quit this program"));
304 wxMenu
*execMenu
= new wxMenu
;
305 execMenu
->Append(Exec_SyncExec
, _T("Sync &execution...\tCtrl-E"),
306 _T("Launch a program and return when it terminates"));
307 execMenu
->Append(Exec_AsyncExec
, _T("&Async execution...\tCtrl-A"),
308 _T("Launch a program and return immediately"));
309 execMenu
->Append(Exec_Shell
, _T("Execute &shell command...\tCtrl-S"),
310 _T("Launch a shell and execute a command in it"));
311 execMenu
->AppendSeparator();
312 execMenu
->Append(Exec_Redirect
, _T("Capture command &output...\tCtrl-O"),
313 _T("Launch a program and capture its output"));
314 execMenu
->Append(Exec_Pipe
, _T("&Pipe through command...\tCtrl-P"),
315 _T("Pipe a string through a filter"));
317 execMenu
->AppendSeparator();
318 execMenu
->Append(Exec_OpenFile
, _T("Open &file...\tCtrl-F"),
319 _T("Launch the command to open this kind of files"));
321 execMenu
->AppendSeparator();
322 execMenu
->Append(Exec_DDEExec
, _T("Execute command via &DDE...\tCtrl-D"));
323 execMenu
->Append(Exec_DDERequest
, _T("Send DDE &request...\tCtrl-R"));
326 wxMenu
*helpMenu
= new wxMenu(_T(""), wxMENU_TEAROFF
);
327 helpMenu
->Append(Exec_About
, _T("&About...\tF1"), _T("Show about dialog"));
329 // now append the freshly created menu to the menu bar...
330 wxMenuBar
*menuBar
= new wxMenuBar();
331 menuBar
->Append(menuFile
, _T("&File"));
332 menuBar
->Append(execMenu
, _T("&Exec"));
333 menuBar
->Append(helpMenu
, _T("&Help"));
335 // ... and attach this menu bar to the frame
338 // create the listbox in which we will show misc messages as they come
339 m_lbox
= new wxListBox(this, -1);
340 wxFont
font(12, wxFONTFAMILY_TELETYPE
, wxFONTSTYLE_NORMAL
,
341 wxFONTWEIGHT_NORMAL
);
343 m_lbox
->SetFont(font
);
346 // create a status bar just for fun (by default with 1 pane only)
348 SetStatusText(_T("Welcome to wxWindows exec sample!"));
349 #endif // wxUSE_STATUSBAR
352 // ----------------------------------------------------------------------------
353 // event handlers: file and help menu
354 // ----------------------------------------------------------------------------
356 void MyFrame::OnQuit(wxCommandEvent
& WXUNUSED(event
))
358 // TRUE is to force the frame to close
362 void MyFrame::OnClear(wxCommandEvent
& WXUNUSED(event
))
367 void MyFrame::OnAbout(wxCommandEvent
& WXUNUSED(event
))
369 wxMessageBox(_T("Exec wxWindows Sample\n© 2000-2001 Vadim Zeitlin"),
370 _T("About Exec"), wxOK
| wxICON_INFORMATION
, this);
373 void MyFrame::OnKill(wxCommandEvent
& WXUNUSED(event
))
375 long pid
= wxGetNumberFromUser(_T("Please specify the process to kill"),
387 static const wxString signalNames
[] =
389 _T("Just test (SIGNONE)"),
390 _T("Hangup (SIGHUP)"),
391 _T("Interrupt (SIGINT)"),
392 _T("Quit (SIGQUIT)"),
393 _T("Illegal instruction (SIGILL)"),
394 _T("Trap (SIGTRAP)"),
395 _T("Abort (SIGABRT)"),
396 _T("Emulated trap (SIGEMT)"),
397 _T("FP exception (SIGFPE)"),
398 _T("Kill (SIGKILL)"),
400 _T("Segment violation (SIGSEGV)"),
401 _T("System (SIGSYS)"),
402 _T("Broken pipe (SIGPIPE)"),
403 _T("Alarm (SIGALRM)"),
404 _T("Terminate (SIGTERM)"),
407 int sig
= wxGetSingleChoiceIndex(_T("How to kill the process?"),
409 WXSIZEOF(signalNames
), signalNames
,
414 wxFAIL_MSG( _T("unexpected return value") );
442 if ( wxProcess::Exists(pid
) )
443 wxLogStatus(_T("Process %d is running."), pid
);
445 wxLogStatus(_T("No process with pid = %d."), pid
);
449 wxKillError rc
= wxProcess::Kill(pid
, (wxSignal
)sig
);
450 if ( rc
== wxKILL_OK
)
452 wxLogStatus(_T("Process %d killed with signal %d."), pid
, sig
);
456 static const wxChar
*errorText
[] =
459 _T("signal not supported"),
460 _T("permission denied"),
461 _T("no such process"),
462 _T("unspecified error"),
465 wxLogStatus(_T("Failed to kill process %d with signal %d: %s"),
466 pid
, sig
, errorText
[rc
]);
471 // ----------------------------------------------------------------------------
472 // event handlers: exec menu
473 // ----------------------------------------------------------------------------
475 void MyFrame::DoAsyncExec(const wxString
& cmd
)
477 wxProcess
*process
= new MyProcess(this, cmd
);
478 m_pidLast
= wxExecute(cmd
, FALSE
/* async */, process
);
481 wxLogError(_T("Execution of '%s' failed."), cmd
.c_str());
487 wxLogStatus(_T("Process %ld (%s) launched."), m_pidLast
, cmd
.c_str());
493 void MyFrame::OnSyncExec(wxCommandEvent
& WXUNUSED(event
))
495 wxString cmd
= wxGetTextFromUser(_T("Enter the command: "),
502 wxLogStatus(_T("'%s' is running please wait..."), cmd
.c_str());
504 int code
= wxExecute(cmd
, TRUE
/* sync */);
506 wxLogStatus(_T("Process '%s' terminated with exit code %d."),
511 void MyFrame::OnAsyncExec(wxCommandEvent
& WXUNUSED(event
))
513 wxString cmd
= wxGetTextFromUser(_T("Enter the command: "),
523 void MyFrame::OnShell(wxCommandEvent
& WXUNUSED(event
))
525 wxString cmd
= wxGetTextFromUser(_T("Enter the command: "),
532 int code
= wxShell(cmd
);
533 wxLogStatus(_T("Shell command '%s' terminated with exit code %d."),
538 void MyFrame::OnExecWithRedirect(wxCommandEvent
& WXUNUSED(event
))
540 wxString cmd
= wxGetTextFromUser(_T("Enter the command: "),
548 switch ( wxMessageBox(_T("Execute it synchronously?"),
550 wxYES_NO
| wxCANCEL
| wxICON_QUESTION
, this) )
566 wxArrayString output
, errors
;
567 int code
= wxExecute(cmd
, output
, errors
);
568 wxLogStatus(_T("command '%s' terminated with exit code %d."),
573 ShowOutput(cmd
, output
, _T("Output"));
574 ShowOutput(cmd
, errors
, _T("Errors"));
579 MyPipedProcess
*process
= new MyPipedProcess(this, cmd
);
580 if ( !wxExecute(cmd
, FALSE
/* async */, process
) )
582 wxLogError(_T("Execution of '%s' failed."), cmd
.c_str());
588 m_running
.Add(process
);
595 void MyFrame::OnExecWithPipe(wxCommandEvent
& WXUNUSED(event
))
598 m_cmdLast
= _T("tr [a-z] [A-Z]");
600 wxString cmd
= wxGetTextFromUser(_T("Enter the command: "),
607 wxString input
= wxGetTextFromUser(_T("Enter the string to send to it: "),
612 // always execute the filter asynchronously
613 MyPipedProcess2
*process
= new MyPipedProcess2(this, cmd
, input
);
614 int pid
= wxExecute(cmd
, FALSE
/* async */, process
);
617 wxLogStatus(_T("Process %ld (%s) launched."), pid
, cmd
.c_str());
619 m_running
.Add(process
);
623 wxLogError(_T("Execution of '%s' failed."), cmd
.c_str());
631 void MyFrame::OnFileExec(wxCommandEvent
& event
)
633 static wxString s_filename
;
635 wxString filename
= wxLoadFileSelector(_T("file"), _T(""), s_filename
);
639 s_filename
= filename
;
641 wxString ext
= filename
.AfterFirst(_T('.'));
642 wxFileType
*ft
= wxTheMimeTypesManager
->GetFileTypeFromExtension(ext
);
645 wxLogError(_T("Impossible to determine the file type for extension '%s'"),
651 bool ok
= ft
->GetOpenCommand(&cmd
,
652 wxFileType::MessageParameters(filename
, _T("")));
656 wxLogError(_T("Impossible to find out how to open files of extension '%s'"),
664 // ----------------------------------------------------------------------------
666 // ----------------------------------------------------------------------------
670 bool MyFrame::GetDDEServer()
672 wxString server
= wxGetTextFromUser(_T("Server to connect to:"),
673 DIALOG_TITLE
, m_server
);
679 wxString topic
= wxGetTextFromUser(_T("DDE topic:"), DIALOG_TITLE
, m_topic
);
685 wxString cmd
= wxGetTextFromUser(_T("DDE command:"), DIALOG_TITLE
, m_cmdDde
);
694 void MyFrame::OnDDEExec(wxCommandEvent
& WXUNUSED(event
))
696 if ( !GetDDEServer() )
700 wxConnectionBase
*conn
= client
.MakeConnection("", m_server
, m_topic
);
703 wxLogError(_T("Failed to connect to the DDE server '%s'."),
708 if ( !conn
->Execute(m_cmdDde
) )
710 wxLogError(_T("Failed to execute command '%s' via DDE."),
715 wxLogStatus(_T("Successfully executed DDE command"));
720 void MyFrame::OnDDERequest(wxCommandEvent
& WXUNUSED(event
))
722 if ( !GetDDEServer() )
726 wxConnectionBase
*conn
= client
.MakeConnection("", m_server
, m_topic
);
729 wxLogError(_T("Failed to connect to the DDE server '%s'."),
734 if ( !conn
->Request(m_cmdDde
) )
736 wxLogError(_T("Failed to send request '%s' via DDE."),
741 wxLogStatus(_T("Successfully sent DDE request."));
746 #endif // __WINDOWS__
748 // ----------------------------------------------------------------------------
750 // ----------------------------------------------------------------------------
753 void MyFrame::OnIdle(wxIdleEvent
& event
)
755 size_t count
= m_running
.GetCount();
756 for ( size_t n
= 0; n
< count
; n
++ )
758 if ( m_running
[n
]->HasInput() )
765 void MyFrame::OnProcessTerminated(MyPipedProcess
*process
)
767 m_running
.Remove(process
);
771 void MyFrame::ShowOutput(const wxString
& cmd
,
772 const wxArrayString
& output
,
773 const wxString
& title
)
775 size_t count
= output
.GetCount();
779 m_lbox
->Append(wxString::Format(_T("--- %s of '%s' ---"),
780 title
.c_str(), cmd
.c_str()));
782 for ( size_t n
= 0; n
< count
; n
++ )
784 m_lbox
->Append(output
[n
]);
787 m_lbox
->Append(_T("--- End of output ---"));
790 // ----------------------------------------------------------------------------
792 // ----------------------------------------------------------------------------
794 void MyProcess::OnTerminate(int pid
, int status
)
796 wxLogStatus(m_parent
, _T("Process %u ('%s') terminated with exit code %d."),
797 pid
, m_cmd
.c_str(), status
);
799 // we're not needed any more
803 // ----------------------------------------------------------------------------
805 // ----------------------------------------------------------------------------
807 bool MyPipedProcess::HasInput()
809 bool hasInput
= FALSE
;
811 wxInputStream
& is
= *GetInputStream();
814 wxTextInputStream
tis(is
);
816 // this assumes that the output is always line buffered
818 msg
<< m_cmd
<< _T(" (stdout): ") << tis
.ReadLine();
820 m_parent
->GetLogListBox()->Append(msg
);
825 wxInputStream
& es
= *GetErrorStream();
828 wxTextInputStream
tis(es
);
830 // this assumes that the output is always line buffered
832 msg
<< m_cmd
<< _T(" (stderr): ") << tis
.ReadLine();
834 m_parent
->GetLogListBox()->Append(msg
);
842 void MyPipedProcess::OnTerminate(int pid
, int status
)
844 // show the rest of the output
848 m_parent
->OnProcessTerminated(this);
850 MyProcess::OnTerminate(pid
, status
);
853 // ----------------------------------------------------------------------------
855 // ----------------------------------------------------------------------------
857 bool MyPipedProcess2::HasInput()
861 wxTextOutputStream
os(*GetOutputStream());
862 os
.WriteString(m_input
);
867 // call us once again - may be we'll have output
871 return MyPipedProcess::HasInput();