BuildStatusReporter.h

#pragma once
#include <string>
#include <memory>
#include <map>

#include <boost/program_options/variables_map.hpp>
#include <boost/program_options/options_description.hpp>

#include "BuildStatus.h"

class BuildStatusReporter {
public:
	virtual ~BuildStatusReporter();
	virtual auto getName() const -> std::string = 0; //< Retrieves the name of the reporter.
	virtual auto getOptionsDescription() const -> boost::program_options::options_description; //< Retrieves the parameters requested by the reporter.
	virtual void init(const boost::program_options::variables_map& options); //< Prepares the reporter to receive build statuses.
	virtual void reportBuildStatus(const BuildStatus&) = 0; //< Informs the reporter of the latest build status.
	virtual auto getHelpString() const -> std::string; //< Get the usage information in a form that can be printed to the console.
};


// Keeps track of all the registered reporters.
class BuildStatusReporterRegistry {
public: // Singleton.
	static BuildStatusReporterRegistry& instance();

public:	// Registry methods.
	void registerReporter(std::unique_ptr<BuildStatusReporter> reporter); //< Adds a reporter to the registry.
	auto getReporter(const std::string& reporterName) -> BuildStatusReporter&; //< Gets a reporter by its name.
	auto getHelpString() -> std::string; //< Gathers up the help strings for all reporters.
	
private: // Data.
	std::map<std::string, std::unique_ptr<BuildStatusReporter>> registry_;
};


// A helper to register reporters by declaring a statically allocated variable in a compilation unit.
struct BuildStatusRegistrar {
	BuildStatusRegistrar(std::unique_ptr<BuildStatusReporter> reporter);
};