layout_snapshot.hpp

Go to the documentation of this file.

#pragma once
 
#include <pulp/view/view.hpp>
 
#include <string>
#include <string_view>
#include <vector>
 
namespace pulp::view {
 
struct LayoutTreeSnapshotOptions {
    std::string surface = "view";
    std::string fixture;
    float viewport_width = 0.0f;
    float viewport_height = 0.0f;
};
 
struct LayoutTreeTolerance {
    float numeric_bounds_px = 0.0f;
    float text_box_px = 0.5f;
};
 
struct LayoutTreeDiff {
    std::vector<std::string> messages;
 
    bool empty() const { return messages.empty(); }
};

std::string dump_layout_tree(
    const View& root,
    const LayoutTreeSnapshotOptions& options = {});

bool layout_tree_snapshots_equivalent(
    std::string_view actual_json,
    std::string_view expected_json,
    const LayoutTreeTolerance& tolerance = {},
    LayoutTreeDiff* diff = nullptr);
 
} // namespace pulp::view