plaintext_serializer.hpp

Go to the documentation of this file.

#pragma once
 
#include "api/requirement.hpp"
#include "api/stringize.hpp"
#include "grading_session.hpp"
#include "output/serializer.hpp"
#include "output/sink.hpp"
#include "output/verbosity.hpp"
#include "user/program_options.hpp"
 
#include <fmt/base.h>
#include <fmt/color.h>
#include <fmt/format.h>
 
#include <cstddef>
#include <string>
#include <string_view>
#include <unordered_map>
 
namespace asmgrader {
 
class PlainTextSerializer : public Serializer
{
public:
    PlainTextSerializer(Sink& sink, ProgramOptions::ColorizeOpt colorize_option, VerbosityLevel verbosity);
 
    void on_student_begin(const StudentInfo& info) override;
    void on_student_end(const StudentInfo& info) override;
 
    void on_run_metadata(const RunMetadata& data) override;
    void on_requirement_result(const RequirementResult& data) override;
    void on_test_begin(std::string_view test_name) override;
    void on_test_result(const TestResult& data) override;
    void on_assignment_result(const AssignmentResult& data) override;
 
    void on_warning(std::string_view what) override;
    void on_error(std::string_view what) override;
 
    void finalize() override;
 
private:
    std::string serialize_req_expr(const exprs::ExpressionRepr& expr);
    std::string serialize_req_expr_simple(const exprs::ExpressionRepr& expr);
    static bool process_colorize_opt(ProgramOptions::ColorizeOpt colorize_option);
    static std::size_t get_terminal_width();
 
    void output_grade_percentage(const AssignmentResult& data);
 
    template <fmt::formattable T>
    auto style(const T& arg, fmt::text_style style) const -> decltype(fmt::styled(arg, style));
 
    template <fmt::formattable T>
    std::string style_str(const T& arg, fmt::text_style style, fmt::format_string<T> fmt = "{}") const;
 
    std::string maybe_highlight(const stringize::StringizeResult& what) const;
 
    static std::string pluralize(std::string_view root, int count, std::string_view suffix = "s",
                                 std::size_t replace_last_chars = 0);
 
    // Basic styles for different kinds of output:
    //   error    - FAILED messages, fatal errors, etc.
    //   success  - PASSED messages
    //   header   - section header (like "String Test Results:")
    //   value    - for variables or literal values referenced for test requirements
    static constexpr auto ERROR_STYLE = fmt::fg(fmt::color::red) | fmt::emphasis::bold;
    static constexpr auto WARNING_STYLE = fmt::fg(fmt::color::yellow) | fmt::emphasis::bold;
    static constexpr auto SUCCESS_STYLE = fmt::fg(fmt::color::lime_green);
    static constexpr auto POP_OUT_STYLE =
        fmt::emphasis::underline | fmt::emphasis::bold | fmt::fg(fmt::color::golden_rod);
    static constexpr auto VALUE_STYLE = fmt::fg(fmt::color::aqua);
 
    static constexpr std::size_t DEFAULT_WIDTH = 80;
 
    static constexpr auto MAKE_LINE_DIVIDER = [](char chr) {
        return [chr](std::size_t len) { return std::string(len, chr); };
    };
 
    // Basic line dividers to seperate output, parameterized on length
    // Line Divider 2x Emphasized : "#######"...
    // Line Divider Emphasized    : "======="...
    // Line Divider               : "--------...
    static const inline auto LINE_DIVIDER = MAKE_LINE_DIVIDER('-');
    static const inline auto LINE_DIVIDER_EM = MAKE_LINE_DIVIDER('=');
    static const inline auto LINE_DIVIDER_2EM = MAKE_LINE_DIVIDER('#');
 
    bool do_colorize_;
    std::size_t terminal_width_;
 
    std::unordered_map<std::string, std::size_t> repeat_requirements_;
};
 
template <fmt::formattable T>
auto PlainTextSerializer::style(const T& arg, fmt::text_style style) const -> decltype(fmt::styled(arg, style)) {
    if (!do_colorize_) {
        return fmt::styled(arg, {});
    }
    return fmt::styled(arg, style);
}
 
template <fmt::formattable T>
std::string PlainTextSerializer::style_str(const T& arg, fmt::text_style style, fmt::format_string<T> fmt) const {
    if (!do_colorize_) {
        return fmt::vformat(fmt.str, fmt::vargs<T>{arg});
    }
 
    return fmt::vformat(style, fmt.str, fmt::vargs<T>{arg});
}
 
} // namespace asmgrader