Fix a tiny memory-leak when calling vfork
[ardour.git] / libs / pbd / pbd / system_exec.h
index 1232175fecc8192643c4bc2db22c3b5afbe56bc7..1e36c3df9fcba136adc0f70738d52babd5b98ef1 100644 (file)
 #undef interface // VKamyshniy: to avoid "include/giomm-2.4/giomm/dbusmessage.h:270:94: error: expected ',' or '...' before 'struct'"
 #endif
 
+#else // posix
+#include <sys/types.h>
+#include <sys/wait.h> /* WNOHANG is part of the exposed API */
 #endif
 
 #include <string>
 #include <pthread.h>
 #include <signal.h>
+#include <map>
+
 #ifdef NOPBD  /* unit-test outside ardour */
 #include <sigc++/bind.h>
 #include <sigc++/signal.h>
@@ -94,8 +99,29 @@ class LIBPBD_API SystemExec
                 *
                 */
                SystemExec (std::string c, char ** a);
+
+               /** similar to \ref SystemExec but expects a whole command line, and
+                * handles some simple escape sequences.
+                *
+                * @param command complete command-line to be executed
+                * @param subs a map of <char, std::string> listing the % substitutions to
+                *             be made.
+                *
+                * creates an argv array from the given command string, splitting into
+                * parameters at spaces.
+                * "\ " is non-splitting space, "\\" (and "\" at end of command) as "\",
+                * for "%<char>", <char> is looked up in subs and the corresponding string
+                * substituted. "%%" (and "%" at end of command)
+                * returns an argv array suitable for creating a new SystemExec with
+                */
+               SystemExec (std::string command, const std::map<char, std::string> subs);
+
                virtual ~SystemExec ();
 
+               static char* format_key_value_parameter (std::string, std::string);
+
+               std::string to_s() const;
+
                /** fork and execute the given program
                 *
                 * @param stderr_mode select what to do with program's standard error
@@ -140,12 +166,19 @@ class LIBPBD_API SystemExec
                 */
                void close_stdin ();
                /** write into child-program's STDIN
-                * @param d data to write
+                * @param d text to write
                 * @param len length of data to write, if it is 0 (zero), d.length() is
                 * used to determine the number of bytes to transmit.
                 * @return number of bytes written.
                 */
-               int write_to_stdin (std::string d, size_t len=0);
+               size_t write_to_stdin (std::string const& d, size_t len=0);
+
+               /** write into child-program's STDIN
+                * @param data data to write
+                * @param bytes length of data to write
+                * @return number of bytes written.
+                */
+               size_t write_to_stdin (const void* d, size_t bytes=0);
 
                /** The ReadStdout signal is emitted when the application writes to STDOUT.
                 * it passes the written data and its length in bytes as arguments to the bound
@@ -182,6 +215,7 @@ class LIBPBD_API SystemExec
                int nicelevel; ///< process nice level - defaults to 0
 
                void make_argp(std::string);
+               void make_argp_escaped(std::string command, const std::map<char, std::string> subs);
                void make_envp();
 
                char **argp;
@@ -197,10 +231,13 @@ class LIBPBD_API SystemExec
                void make_wargs(char **);
 #else
                pid_t pid;
+# ifndef NO_VFORK
+               char **argx;
+# endif
 #endif
+               void init ();
                pthread_mutex_t write_lock;
 
-               int fdin; ///< file-descriptor for writing to child's STDIN. This variable is identical to pin[1] but also used as status check if the stdin pipe is open: <0 means closed.
                int pok[2];
                int pin[2];
                int pout[2];