appearance_defects.hpp

Go to the documentation of this file.

#pragma once
 
#include <pulp/view/view.hpp>
 
#include <string>
#include <vector>
 
namespace pulp::view {

 
enum class AppearanceDefectKind {
    text_overlap,
    painted_wider_than_box,
    canvas_text_overlap,
    container_paints_no_text,
};
 
const char* to_string(AppearanceDefectKind kind);

enum class TextRunSkip {
    none,
    invisible,        
    empty_text,       
    clipped_away,     
    unmeasurable,     
    degenerate_box,   
};

struct TextRun {
    std::string node_id;
    std::string kind;      
    std::string text;
    Rect ink{};            
    Rect visible_ink{};
    Rect box{};            
    Rect clip{};           
    int paint_order = 0;
    const View* scroll_frame = nullptr;
    bool from_canvas = false;
};

struct AppearanceCoverage {
    int text_nodes_seen = 0;        
    int text_runs_measured = 0;     
    int skipped_invisible = 0;
    int skipped_empty = 0;
    int skipped_clipped = 0;
    int skipped_clipped_in_empty_container = 0;
    int skipped_unmeasurable = 0;
    int skipped_degenerate_box = 0;
 
    int canvas_widgets = 0;
    int canvas_text_commands = 0;
    int canvas_text_measured = 0;
    int canvas_text_skipped = 0;
 
    int pairs_compared = 0;
    int pairs_skipped_cross_frame = 0;

    bool shaping_is_real = false;
 
    int total_skipped() const {
        return skipped_invisible + skipped_empty + skipped_clipped +
               skipped_unmeasurable + skipped_degenerate_box;
    }
    int text_runs_total() const { return text_runs_measured + total_skipped(); }

    bool trustworthy() const;
 
    std::string to_string() const;
};
 
struct AppearanceFinding {
    AppearanceDefectKind kind = AppearanceDefectKind::text_overlap;
    std::string a_id, a_text;
    std::string b_id, b_text;
    Rect a_rect{}, b_rect{}, overlap{};
    float painted_width = 0.0f;
    float box_width = 0.0f;
    int clipped_runs = 0;
    float overflow_px = 0.0f;
 
    std::string describe() const;
};
 
struct AppearanceReport {
    std::vector<AppearanceFinding> findings;
    AppearanceCoverage coverage;
    std::vector<TextRun> runs;
 
    bool clean() const { return findings.empty(); }
    std::string to_string() const;
};
 
struct AppearanceOptions {
    float overlap_tolerance_px = 0.5f;
    float width_tolerance_px = 0.5f;
    float min_overlap_area_px2 = 1.0f;
    bool include_canvas_text = true;
    bool compare_across_scroll_frames = false;
    float control_inflate_ink_px = 0.0f;
};

AppearanceReport detect_appearance_defects(const View& root,
                                           const AppearanceOptions& options = {});
 
} // namespace pulp::view