pbd/pbd/system_exec.h

Go to the documentation of this file.

/*
 * Copyright (C) 2010-2019 Robin Gareus <robin@gareus.org>
 * Copyright (C) 2013-2014 Colin Fletcher <colin.m.fletcher@googlemail.com>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
#ifndef _libpbd_system_exec_h_
#define _libpbd_system_exec_h_
 
#ifndef STDIN_FILENO
#define STDIN_FILENO 0
#endif
#ifndef STDOUT_FILENO
#define STDOUT_FILENO 1
#endif
#ifndef STDERR_FILENO
#define STDERR_FILENO 2
#endif
 
#ifdef PLATFORM_WINDOWS
#include <windows.h>
 
#ifdef interface
#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>
#else
#include "pbd/signals.h"
#endif
 
namespace PBD {
 
class LIBPBD_API SystemExec
{
        public:
                SystemExec (std::string cmd, std::string argv = "", bool supress_ld_env = false);
                SystemExec (std::string cmd, char **argv, bool supress_ld_env = false);
 
                SystemExec (std::string command, const std::map<char, std::string> subs, bool supress_ld_env = false);
 
                virtual ~SystemExec ();
 
                static char* format_key_value_parameter (std::string, std::string);
 
                std::string to_s() const;
 
                enum StdErrMode {
                        ShareWithParent = 0,
                        IgnoreAndClose  = 1,
                        MergeWithStdin  = 2
                };
 
                int start (StdErrMode stderr_mode, const char *_vfork_exec_wrapper);
                void terminate ();
                bool is_running ();
                int wait (int options=0);
                void close_stdin ();
                size_t write_to_stdin (std::string const& d, size_t len=0);
 
                size_t write_to_stdin (const char* d, size_t len=0);
 
                size_t write_to_stdin (const void* data, size_t bytes=0);
 
#ifdef NOPBD  /* outside ardour */
                sigc::signal<void, std::string,size_t> ReadStdout;
#else
                PBD::Signal<void(std::string,size_t)> ReadStdout;
#endif
 
#ifdef NOPBD  /* outside ardour */
                sigc::signal<void> Terminated;
#else
                PBD::Signal<void()> Terminated;
#endif
 
                void output_interposer ();
 
        protected:
                std::string cmd; 
                int nicelevel; 
 
                void make_argp(std::string);
                void make_argp_escaped(std::string command, const std::map<char, std::string> subs);
                void make_envp (bool supress_ld_env);
 
                char **argp;
                char **envp;
 
        private:
#ifdef PLATFORM_WINDOWS
                PROCESS_INFORMATION *pid;
                HANDLE stdinP[2];
                HANDLE stdoutP[2];
                HANDLE stderrP[2];
                char *w_args;
                void make_wargs(char **);
#else
                pid_t pid;
                char **argx;
#endif
                void init ();
                pthread_mutex_t write_lock;
 
                int pok[2];
                int pin[2];
                int pout[2];
 
                pthread_t      thread_id_tt;
                bool           thread_active;
 
}; /* end class */
 
}; /* end namespace */
 
#endif /* _libpbd_system_exec_h_ */