stderr_styled_user_diagnostics.hpp

Go to the documentation of this file.

#pragma once
 
#include <string>
#include <vector>
 
#include "gsl/pointers"
 
#include "porytiles2/utilities/text/text_formatter.hpp"
#include "porytiles2/xcut/diagnostics/user_diagnostics.hpp"
#include "porytiles2/xcut/result/error.hpp"
 
namespace porytiles2 {
 
/*
 * TODO: change this class to ConfigurableUserDiagnostics. We should expose for configuration:
 * 1. Where the diagnostics go: stderr, stdout, a file?
 * 2. Colors on or off
 * 3. Diagnostic tag include and exclude filters
 * 4. Diagnostic tag settable limits: stop showing diagnostics with a given tag when a limit is hit
 */
 
class StderrStyledUserDiagnostics final : public UserDiagnostics {
  public:
    explicit StderrStyledUserDiagnostics(const gsl::not_null<TextFormatter *> format) : format_{format} {}
 
    void note(const std::string &tag, const std::vector<std::string> &lines) const override;
 
    void warn_note(const std::string &tag, const std::vector<std::string> &lines) const override;
 
    void warn(const std::string &tag, const std::vector<std::string> &lines) const override;
 
    void err(const std::string &tag, const std::vector<std::string> &lines) const override;
 
    void emit_fatal_proximate(const Error &err) const override;
 
    void emit_fatal_step(const Error &err) const override;
 
    void emit_fatal_root(const Error &err) const override;
 
  private:
    TextFormatter *format_;
};
 
} // namespace porytiles2