-rw-r--r-- | libopie/oprocess.h | 72 |
1 files changed, 7 insertions, 65 deletions
diff --git a/libopie/oprocess.h b/libopie/oprocess.h index fd726b4..bf5fe0e 100644 --- a/libopie/oprocess.h +++ b/libopie/oprocess.h | |||
@@ -158,65 +158,67 @@ public: | |||
158 | * communication with stdout as well as with stdin, you would | 158 | * communication with stdout as well as with stdin, you would |
159 | * specify @p Stdin @p | @p Stdout | 159 | * specify @p Stdin @p | @p Stdout |
160 | * | 160 | * |
161 | * If @p NoRead is specified in conjunction with @p Stdout, | 161 | * If @p NoRead is specified in conjunction with @p Stdout, |
162 | * no data is actually read from @p Stdout but only | 162 | * no data is actually read from @p Stdout but only |
163 | * the signal @ref childOutput(int fd) is emitted. | 163 | * the signal @ref childOutput(int fd) is emitted. |
164 | */ | 164 | */ |
165 | enum Communication { NoCommunication = 0, Stdin = 1, Stdout = 2, Stderr = 4, | 165 | enum Communication { NoCommunication = 0, Stdin = 1, Stdout = 2, Stderr = 4, |
166 | AllOutput = 6, All = 7, | 166 | AllOutput = 6, All = 7, |
167 | NoRead }; | 167 | NoRead }; |
168 | 168 | ||
169 | /** | 169 | /** |
170 | * Run-modes for a child process. | 170 | * Run-modes for a child process. |
171 | */ | 171 | */ |
172 | enum RunMode { | 172 | enum RunMode { |
173 | /** | 173 | /** |
174 | * The application does not receive notifications from the subprocess when | 174 | * The application does not receive notifications from the subprocess when |
175 | * it is finished or aborted. | 175 | * it is finished or aborted. |
176 | */ | 176 | */ |
177 | DontCare, | 177 | DontCare, |
178 | /** | 178 | /** |
179 | * The application is notified when the subprocess dies. | 179 | * The application is notified when the subprocess dies. |
180 | */ | 180 | */ |
181 | NotifyOnExit, | 181 | NotifyOnExit, |
182 | /** | 182 | /** |
183 | * The application is suspended until the started process is finished. | 183 | * The application is suspended until the started process is finished. |
184 | */ | 184 | */ |
185 | Block }; | 185 | Block }; |
186 | 186 | ||
187 | /** | 187 | /** |
188 | * Constructor | 188 | * Constructor |
189 | */ | 189 | */ |
190 | OProcess(); | 190 | OProcess(QObject *parent = 0, const char *name = 0); |
191 | OProcess(const QString &arg0, QObject *parent = 0, const char *name = 0); | ||
192 | OProcess(const QStringList &args, QObject *parent = 0, const char *name = 0); | ||
191 | 193 | ||
192 | /** | 194 | /** |
193 | *Destructor: | 195 | *Destructor: |
194 | * | 196 | * |
195 | * If the process is running when the destructor for this class | 197 | * If the process is running when the destructor for this class |
196 | * is called, the child process is killed with a SIGKILL, but | 198 | * is called, the child process is killed with a SIGKILL, but |
197 | * only if the run mode is not of type @p DontCare. | 199 | * only if the run mode is not of type @p DontCare. |
198 | * Processes started as @p DontCare keep running anyway. | 200 | * Processes started as @p DontCare keep running anyway. |
199 | */ | 201 | */ |
200 | virtual ~OProcess(); | 202 | virtual ~OProcess(); |
201 | 203 | ||
202 | /** | 204 | /** |
203 | @deprecated | 205 | @deprecated |
204 | 206 | ||
205 | The use of this function is now deprecated. -- Please use the | 207 | The use of this function is now deprecated. -- Please use the |
206 | "operator<<" instead of "setExecutable". | 208 | "operator<<" instead of "setExecutable". |
207 | 209 | ||
208 | Sets the executable to be started with this OProcess object. | 210 | Sets the executable to be started with this OProcess object. |
209 | Returns false if the process is currently running (in that | 211 | Returns false if the process is currently running (in that |
210 | case the executable remains unchanged.) | 212 | case the executable remains unchanged.) |
211 | 213 | ||
212 | @see operator<< | 214 | @see operator<< |
213 | 215 | ||
214 | */ | 216 | */ |
215 | bool setExecutable(const QString& proc); | 217 | bool setExecutable(const QString& proc); |
216 | 218 | ||
217 | 219 | ||
218 | /** | 220 | /** |
219 | * Sets the executable and the command line argument list for this process. | 221 | * Sets the executable and the command line argument list for this process. |
220 | * | 222 | * |
221 | * For example, doing an "ls -l /usr/local/bin" can be achieved by: | 223 | * For example, doing an "ls -l /usr/local/bin" can be achieved by: |
222 | * <pre> | 224 | * <pre> |
@@ -331,64 +333,66 @@ public: | |||
331 | * this function because if the process did not exit normally, | 333 | * this function because if the process did not exit normally, |
332 | * it does not have a valid exit status. | 334 | * it does not have a valid exit status. |
333 | */ | 335 | */ |
334 | int exitStatus() const; | 336 | int exitStatus() const; |
335 | 337 | ||
336 | 338 | ||
337 | /** | 339 | /** |
338 | * Transmit data to the child process's stdin. | 340 | * Transmit data to the child process's stdin. |
339 | * | 341 | * |
340 | * OProcess::writeStdin may return false in the following cases: | 342 | * OProcess::writeStdin may return false in the following cases: |
341 | * | 343 | * |
342 | * @li The process is not currently running. | 344 | * @li The process is not currently running. |
343 | * | 345 | * |
344 | * @li Communication to stdin has not been requested in the @ref start() call. | 346 | * @li Communication to stdin has not been requested in the @ref start() call. |
345 | * | 347 | * |
346 | * @li Transmission of data to the child process by a previous call to | 348 | * @li Transmission of data to the child process by a previous call to |
347 | * @ref writeStdin() is still in progress. | 349 | * @ref writeStdin() is still in progress. |
348 | * | 350 | * |
349 | * Please note that the data is sent to the client asynchronously, | 351 | * Please note that the data is sent to the client asynchronously, |
350 | * so when this function returns, the data might not have been | 352 | * so when this function returns, the data might not have been |
351 | * processed by the child process. | 353 | * processed by the child process. |
352 | * | 354 | * |
353 | * If all the data has been sent to the client, the signal | 355 | * If all the data has been sent to the client, the signal |
354 | * @ref wroteStdin() will be emitted. | 356 | * @ref wroteStdin() will be emitted. |
355 | * | 357 | * |
356 | * Please note that you must not free "buffer" or call @ref writeStdin() | 358 | * Please note that you must not free "buffer" or call @ref writeStdin() |
357 | * again until either a @ref wroteStdin() signal indicates that the | 359 | * again until either a @ref wroteStdin() signal indicates that the |
358 | * data has been sent or a @ref processHasExited() signal shows that | 360 | * data has been sent or a @ref processHasExited() signal shows that |
359 | * the child process is no longer alive... | 361 | * the child process is no longer alive... |
360 | **/ | 362 | **/ |
361 | bool writeStdin(const char *buffer, int buflen); | 363 | bool writeStdin(const char *buffer, int buflen); |
362 | 364 | ||
365 | void flushStdin(); | ||
366 | |||
363 | /** | 367 | /** |
364 | * This causes the stdin file descriptor of the child process to be | 368 | * This causes the stdin file descriptor of the child process to be |
365 | * closed indicating an "EOF" to the child. | 369 | * closed indicating an "EOF" to the child. |
366 | * | 370 | * |
367 | * @return @p false if no communication to the process's stdin | 371 | * @return @p false if no communication to the process's stdin |
368 | * had been specified in the call to @ref start(). | 372 | * had been specified in the call to @ref start(). |
369 | */ | 373 | */ |
370 | bool closeStdin(); | 374 | bool closeStdin(); |
371 | 375 | ||
372 | /** | 376 | /** |
373 | * This causes the stdout file descriptor of the child process to be | 377 | * This causes the stdout file descriptor of the child process to be |
374 | * closed. | 378 | * closed. |
375 | * | 379 | * |
376 | * @return @p false if no communication to the process's stdout | 380 | * @return @p false if no communication to the process's stdout |
377 | * had been specified in the call to @ref start(). | 381 | * had been specified in the call to @ref start(). |
378 | */ | 382 | */ |
379 | bool closeStdout(); | 383 | bool closeStdout(); |
380 | 384 | ||
381 | /** | 385 | /** |
382 | * This causes the stderr file descriptor of the child process to be | 386 | * This causes the stderr file descriptor of the child process to be |
383 | * closed. | 387 | * closed. |
384 | * | 388 | * |
385 | * @return @p false if no communication to the process's stderr | 389 | * @return @p false if no communication to the process's stderr |
386 | * had been specified in the call to @ref start(). | 390 | * had been specified in the call to @ref start(). |
387 | */ | 391 | */ |
388 | bool closeStderr(); | 392 | bool closeStderr(); |
389 | 393 | ||
390 | /** | 394 | /** |
391 | * Lets you see what your arguments are for debugging. | 395 | * Lets you see what your arguments are for debugging. |
392 | */ | 396 | */ |
393 | 397 | ||
394 | const QValueList<QCString> &args() { return arguments; } | 398 | const QValueList<QCString> &args() { return arguments; } |
@@ -702,104 +706,42 @@ protected: | |||
702 | /** | 706 | /** |
703 | * @ref OProcessController is a friend of OProcess because it has to have | 707 | * @ref OProcessController is a friend of OProcess because it has to have |
704 | * access to various data members. | 708 | * access to various data members. |
705 | */ | 709 | */ |
706 | friend class OProcessController; | 710 | friend class OProcessController; |
707 | 711 | ||
708 | 712 | ||
709 | private: | 713 | private: |
710 | /** | 714 | /** |
711 | * Searches for a valid shell. | 715 | * Searches for a valid shell. |
712 | * Here is the algorithm used for finding an executable shell: | 716 | * Here is the algorithm used for finding an executable shell: |
713 | * | 717 | * |
714 | * @li Try the executable pointed to by the "SHELL" environment | 718 | * @li Try the executable pointed to by the "SHELL" environment |
715 | * variable with white spaces stripped off | 719 | * variable with white spaces stripped off |
716 | * | 720 | * |
717 | * @li If your process runs with uid != euid or gid != egid, a shell | 721 | * @li If your process runs with uid != euid or gid != egid, a shell |
718 | * not listed in /etc/shells will not used. | 722 | * not listed in /etc/shells will not used. |
719 | * | 723 | * |
720 | * @li If no valid shell could be found, "/bin/sh" is used as a last resort. | 724 | * @li If no valid shell could be found, "/bin/sh" is used as a last resort. |
721 | */ | 725 | */ |
722 | QCString searchShell(); | 726 | QCString searchShell(); |
723 | 727 | ||
724 | /** | 728 | /** |
725 | * Used by @ref searchShell in order to find out whether the shell found | 729 | * Used by @ref searchShell in order to find out whether the shell found |
726 | * is actually executable at all. | 730 | * is actually executable at all. |
727 | */ | 731 | */ |
728 | bool isExecutable(const QCString &filename); | 732 | bool isExecutable(const QCString &filename); |
729 | 733 | ||
730 | // Disallow assignment and copy-construction | 734 | // Disallow assignment and copy-construction |
731 | OProcess( const OProcess& ); | 735 | OProcess( const OProcess& ); |
732 | OProcess& operator= ( const OProcess& ); | 736 | OProcess& operator= ( const OProcess& ); |
733 | 737 | ||
734 | protected: | ||
735 | virtual void virtual_hook( int id, void* data ); | ||
736 | private: | ||
737 | OProcessPrivate *d; | ||
738 | }; | ||
739 | |||
740 | class KShellProcessPrivate; | ||
741 | |||
742 | /** | ||
743 | * @obsolete | ||
744 | * | ||
745 | * This class is obsolete. Use OProcess and OProcess::setUseShell(true) | ||
746 | * instead. | ||
747 | * | ||
748 | * @short A class derived from @ref OProcess to start child | ||
749 | * processes through a shell. | ||
750 | * @author Christian Czezakte <e9025461@student.tuwien.ac.at> | ||
751 | * @version $Id$ | ||
752 | */ | ||
753 | class KShellProcess: public OProcess | ||
754 | { | ||
755 | Q_OBJECT | ||
756 | |||
757 | public: | ||
758 | |||
759 | /** | ||
760 | * Constructor | ||
761 | * | ||
762 | * By specifying the name of a shell (like "/bin/bash") you can override | ||
763 | * the mechanism for finding a valid shell as described in OProcess::searchShell() | ||
764 | */ | ||
765 | KShellProcess(const char *shellname=0); | ||
766 | |||
767 | /** | ||
768 | * Destructor. | ||
769 | */ | ||
770 | ~KShellProcess(); | ||
771 | |||
772 | /** | ||
773 | * Starts up the process. -- For a detailed description | ||
774 | * have a look at the "start" member function and the detailed | ||
775 | * description of @ref OProcess . | ||
776 | */ | ||
777 | virtual bool start(RunMode runmode = NotifyOnExit, | ||
778 | Communication comm = NoCommunication); | ||
779 | |||
780 | /** | ||
781 | * This function can be used to quote an argument string such that | ||
782 | * the shell processes it properly. This is e. g. necessary for | ||
783 | * user-provided file names which may contain spaces or quotes. | ||
784 | * It also prevents expansion of wild cards and environment variables. | ||
785 | */ | ||
786 | static QString quote(const QString &arg); | ||
787 | |||
788 | private: | 738 | private: |
739 | void init ( ); | ||
789 | 740 | ||
790 | QCString shell; | 741 | OProcessPrivate *d; |
791 | |||
792 | // Disallow assignment and copy-construction | ||
793 | KShellProcess( const KShellProcess& ); | ||
794 | KShellProcess& operator= ( const KShellProcess& ); | ||
795 | |||
796 | protected: | ||
797 | virtual void virtual_hook( int id, void* data ); | ||
798 | private: | ||
799 | KShellProcessPrivate *d; | ||
800 | }; | 742 | }; |
801 | 743 | ||
802 | 744 | ||
803 | 745 | ||
804 | #endif | 746 | #endif |
805 | 747 | ||