renderer.hpp

Go to the documentation of this file.

#pragma once
 
#include <string>
#include <vector>
 
#include "color.hpp"
#include "report.hpp"
 
namespace pretty_diagnostics {
 
struct GlyphSet {
    std::string corner_top_left;
    std::string corner_bottom_right;
    std::string tee_right;
    std::string cap_left;
    std::string cap_right;
    std::string line_vertical;
    std::string line_horizontal;
    std::string label_start;
    std::string label_end;
    std::string filler;
    std::string arrow_right;
};
 
namespace Glyphs {
    GlyphSet Unicode();
 
    GlyphSet Ascii();
} // namespace Glyphs
 
struct ColorSet {
    std::vector<color::Code> error;
    std::vector<color::Code> warning;
    std::vector<color::Code> info;
    std::vector<color::Code> unknown;
};
 
namespace Colors {
    ColorSet Default();
}
 
struct Config {
    GlyphSet glyphs = Glyphs::Unicode();
 
    ColorSet colors = Colors::Default();
};
 
class TextRenderer final : public IReporterRenderer {
public:
    explicit TextRenderer(const Report& report, Config config = {});
 
    void render(const Severity& severity, std::ostream& stream) override;
 
    void render(const Report& report, std::ostream& stream) override;
 
    void render(const FileGroup& file_group, std::ostream& stream) override;
 
    void render(const LineGroup& line_group, std::ostream& stream) override;
 
    void render(const Label& label, std::ostream& stream, const std::vector<std::string>& text_lines, size_t text_index, bool active_render,
                size_t column_start = 0) const;
 
    static void render_wrapped_text(const std::string& text, const std::string& wrapped_prefix, size_t max_width, std::ostream& stream);
 
    [[nodiscard]] static size_t widest_line_number(const Report::MappedFileGroups& groups, size_t padding);
 
    [[nodiscard]] static std::vector<std::string> wrap_text(const std::string& text, size_t max_width);
 
private:
    size_t _line_number_width, _snippet_width;
    std::string _whitespaces;
    Config _config;
};
} // namespace pretty_diagnostics
 
// BSD 3-Clause License
//
// Copyright (c) 2025, Timo Behrend
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
// 1. Redistributions of source code must retain the above copyright notice, this
//    list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright notice,
//    this list of conditions and the following disclaimer in the documentation
//    and/or other materials provided with the distribution.
//
// 3. Neither the name of the copyright holder nor the names of its
//    contributors may be used to endorse or promote products derived from
//    this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
// DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
// FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
// DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
// SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
// CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
// OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.