pipeline.hpp

Go to the documentation of this file.

#ifndef PIPELINE_H_
#define PIPELINE_H_
 
#include <vector>
#include <functional>
#include <stdexcept>
#include <utility>
 
namespace found {
 
class Action {
 public:
    virtual void DoAction() = 0;
};
 
template<typename Input, typename Output>
class Stage : public Action {
 public:
    Stage() = default;
 
    virtual ~Stage() = default;
 
    virtual Output Run(const Input &input) = 0;
 
    void DoAction() override {  // GCOVR_EXCL_START
      *this->product = this->Run(this->resource);
    };  // GCOVR_EXCL_STOP
 
    Input &GetResource() {return resource;}  // GCOVR_EXCL_LINE
 
    Output *&GetProduct() {return product;}  // GCOVR_EXCL_LINE
 
 protected:
    Input resource;
    Output *product;
};
 
template<typename Input, typename Output>
class Pipeline : public Stage<Input, Output> {
 public:
    explicit Pipeline(std::vector<std::reference_wrapper<Action>> &stages)
       : stages(stages), firstResource(nullptr), ready(false) {}
 
    Pipeline() : firstResource(nullptr), ready(false) {}
 
    template<typename I, typename O> Pipeline &AddStage(Stage<I, O> &stage) {
        // Check the input
        if (this->ready) throw std::invalid_argument("Pipeline is already ready");  // GCOVR_EXCL_LINE
        if (this->stages.empty()) {
            if (!std::is_same<Input, I>::value) {
                throw std::invalid_argument("The initial input type is not correct");  // GCOVR_EXCL_LINE
            }
           this->firstResource = reinterpret_cast<Input *>(&stage.GetResource());
        } else {
            // Chain here, and blindly trust the user
            *this->lastProduct = static_cast<void *>(&stage.GetResource());
        }
        // Add to our list
        this->stages.push_back(stage);
        // Now, reset the lastProduct to be of this stage
        this->lastProduct = reinterpret_cast<void **>(&stage.GetProduct());
        // Return the pipeline for chaining
        return *this;
    }
 
    template<typename I> Pipeline &Complete(Stage<I, Output> &stage) {
        this->AddStage(stage);
        this->ready = true;
        stage.GetProduct() = &this->finalProduct;
        return *this;
    }
 
    Output Run(const Input &input) override {
        // MANUAL VERIFICATION: The below branch is fully tested via pipeline-test.cpp
        if (!this->ready)  // GCOVR_EXCL_LINE
            throw std::runtime_error("This is an illegal action: the pipeline is not ready yet");  // GCOVR_EXCL_LINE
        this->resource = input;
        *this->firstResource = input;
        for (Action &stage : this->stages) {
            stage.DoAction();
        }
        this->product = &this->finalProduct;
        return this->finalProduct;
    }
 
 private:
    std::vector<std::reference_wrapper<Action>> stages;
    Input *firstResource;
    Output finalProduct;
    void **lastProduct = nullptr;
    bool ready;
};
 
}  // namespace found
 
#endif