stx-execpipe.h

// -*- mode: c++; fill-column: 79 -*-
// $Id: stx-execpipe.h 8 2010-07-18 19:36:15Z tb $

/*
 * STX Execution Pipe Library v0.7.0
 * Copyright (C) 2010 Timo Bingmann
 *
 * This library is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by the
 * Free Software Foundation; either version 2.1 of the License, or (at your
 * option) any later version.
 *
 * This library 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 Lesser General Public License
 * for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this library; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 */

#ifndef _STX_EXECPIPE_H_
#define _STX_EXECPIPE_H_

#include <string>
#include <vector>

namespace stx {

class PipeSource
{
private:
    class ExecPipeImpl*         m_impl;

    friend class ExecPipeImpl;

public:
    PipeSource();

    virtual bool poll() = 0;

    void write(const void* data, unsigned int datalen);
};

class PipeSink
{
public:
    virtual void process(const void* data, unsigned int datalen) = 0;

    virtual void eof() = 0;
};

class PipeFunction : public PipeSink
{
private:
    class ExecPipeImpl*         m_impl;

    unsigned int                m_stageid;

    friend class ExecPipeImpl;

public:
    PipeFunction();

    void write(const void* data, unsigned int datalen);
};

class ExecPipe
{
protected:
    class ExecPipeImpl*         m_impl;

public:
    ExecPipe();

    ~ExecPipe();

    ExecPipe(const ExecPipe& ep);

    ExecPipe&   operator=(const ExecPipe& ep);

    // *** Debugging Output ***

    enum DebugLevel
    {
        DL_ERROR=0, 
        DL_INFO=1,  
        DL_DEBUG=2, 
        DL_TRACE=3  
    };

    void set_debug_level(enum DebugLevel dl);

    void set_debug_output(void (*output)(const char *line));

    // *** Input Selectors ***


    void set_input_fd(int fd);

    void set_input_file(const char* path);

    void set_input_string(const std::string* input);

    void set_input_source(PipeSource* source);
    

    // *** Output Selectors ***


    void set_output_fd(int fd);

    void set_output_file(const char* path, int mode = 0666);

    void set_output_string(std::string* output);

    void set_output_sink(PipeSink* sink);


    // *** Pipe Stages ***


    unsigned int size() const;

    void add_exec(const char* prog);

    void add_exec(const char* prog, const char* arg1);

    void add_exec(const char* prog, const char* arg1, const char* arg2);

    void add_exec(const char* prog, const char* arg1, const char* arg2, const char* arg3);

    void add_exec(const std::vector<std::string>* args);


    void add_execp(const char* prog);

    void add_execp(const char* prog, const char* arg1);

    void add_execp(const char* prog, const char* arg1, const char* arg2);

    void add_execp(const char* prog, const char* arg1, const char* arg2, const char* arg3);

    void add_execp(const std::vector<std::string>* args);

    void add_exece(const char* path,
                   const std::vector<std::string>* args,
                   const std::vector<std::string>* env);

    void add_function(PipeFunction* func);


    // *** Run Pipe ***

    ExecPipe& run();

    // *** Inspection After Pipe Execution ***


    int get_return_status(unsigned int stageid) const;

    int get_return_code(unsigned int stageid) const;

    int get_return_signal(unsigned int stageid) const;

    bool all_return_codes_zero() const;

};
 
} // namespace stx

#endif // _STX_EXECPIPE_H_

---