Skip to content

Commit

Permalink
Add fragment debug id
Browse files Browse the repository at this point in the history
  • Loading branch information
@ferjm
ferjm committed Feb 21, 2020
1 parent 84dd334 commit 67706f9
Show file tree
Hide file tree
Showing 7 changed files with 90 additions and 38 deletions.
3 changes: 2 additions & 1 deletion components/layout_2020/flow/inline.rs
View file
Expand Up @@ -7,7 +7,7 @@ use crate::flow::float::FloatBox;
use crate::flow::FlowLayout;
use crate::formatting_contexts::IndependentFormattingContext;
use crate::fragments::CollapsedBlockMargins;
use crate::fragments::{AnonymousFragment, BoxFragment, Fragment, TextFragment};
use crate::fragments::{AnonymousFragment, BoxFragment, DebugId, Fragment, TextFragment};
use crate::geom::flow_relative::{Rect, Sides, Vec2};
use crate::positioned::{relative_adjustement, AbsolutelyPositionedBox, PositioningContext};
use crate::sizing::ContentSizes;
Expand Down Expand Up @@ -713,6 +713,7 @@ impl TextRun {
.fragments_so_far
.push(Fragment::Text(TextFragment {
tag: self.tag,
debug_id: DebugId::new(),
parent_style: self.parent_style.clone(),
rect,
ascent: font_ascent.into(),
Expand Down
3 changes: 2 additions & 1 deletion components/layout_2020/flow/mod.rs
View file
Expand Up @@ -8,8 +8,9 @@ use crate::context::LayoutContext;
use crate::flow::float::{FloatBox, FloatContext};
use crate::flow::inline::InlineFormattingContext;
use crate::formatting_contexts::{IndependentFormattingContext, IndependentLayout, NonReplacedIFC};
use crate::fragments::{AnonymousFragment, BoxFragment, Fragment};
use crate::fragments::{AnonymousFragment, BoxFragment};
use crate::fragments::{CollapsedBlockMargins, CollapsedMargin};
use crate::fragments::{DebugId, Fragment};
use crate::geom::flow_relative::{Rect, Sides, Vec2};
use crate::positioned::{AbsolutelyPositionedBox, PositioningContext};
use crate::replaced::ReplacedContent;
Expand Down
53 changes: 50 additions & 3 deletions components/layout_2020/fragments.rs
View file
Expand Up @@ -4,6 +4,7 @@

use crate::geom::flow_relative::{Rect, Sides, Vec2};
use crate::geom::{PhysicalPoint, PhysicalRect};
use crate::layout_debug;
use gfx::text::glyph::GlyphStore;
use gfx_traits::print_tree::PrintTree;
use serde::ser::{Serialize, SerializeStruct, Serializer};
Expand All @@ -27,6 +28,7 @@ pub(crate) enum Fragment {

pub(crate) struct BoxFragment {
pub tag: OpaqueNode,
pub debug_id: DebugId,
pub style: ServoArc<ComputedValues>,
pub children: Vec<Fragment>,

Expand Down Expand Up @@ -61,6 +63,7 @@ pub(crate) struct CollapsedMargin {
/// Can contain child fragments with relative coordinates, but does not contribute to painting itself.
#[derive(Serialize)]
pub(crate) struct AnonymousFragment {
pub debug_id: DebugId,
pub rect: Rect<Length>,
pub children: Vec<Fragment>,
pub mode: WritingMode,
Expand All @@ -70,6 +73,7 @@ pub(crate) struct AnonymousFragment {
}

pub(crate) struct TextFragment {
pub debug_id: DebugId,
pub tag: OpaqueNode,
pub parent_style: ServoArc<ComputedValues>,
pub rect: Rect<Length>,
Expand All @@ -79,6 +83,7 @@ pub(crate) struct TextFragment {
}

pub(crate) struct ImageFragment {
pub debug_id: DebugId,
pub style: ServoArc<ComputedValues>,
pub rect: Rect<Length>,
pub image_key: ImageKey,
Expand Down Expand Up @@ -123,6 +128,7 @@ impl Fragment {
impl AnonymousFragment {
pub fn no_op(mode: WritingMode) -> Self {
Self {
debug_id: DebugId::new(),
children: vec![],
rect: Rect::zero(),
mode,
Expand All @@ -140,6 +146,7 @@ impl AnonymousFragment {
)
});
AnonymousFragment {
debug_id: DebugId::new(),
rect,
children,
mode,
Expand Down Expand Up @@ -179,6 +186,7 @@ impl BoxFragment {
});
BoxFragment {
tag,
debug_id: DebugId::new(),
style,
children,
content_rect,
Expand Down Expand Up @@ -349,7 +357,8 @@ impl CollapsedMargin {

impl Serialize for BoxFragment {
fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
let mut serializer = serializer.serialize_struct("BoxFragment", 6)?;
let mut serializer = serializer.serialize_struct("BoxFragment", 7)?;
serializer.serialize_field("debug_id", &self.debug_id)?;
serializer.serialize_field("content_rect", &self.content_rect)?;
serializer.serialize_field("padding", &self.padding)?;
serializer.serialize_field("border", &self.border)?;
Expand All @@ -365,7 +374,8 @@ impl Serialize for BoxFragment {

impl Serialize for TextFragment {
fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
let mut serializer = serializer.serialize_struct("TextFragment", 3)?;
let mut serializer = serializer.serialize_struct("TextFragment", 4)?;
serializer.serialize_field("debug_id", &self.debug_id)?;
serializer.serialize_field("rect", &self.rect)?;
serializer.serialize_field("ascent", &self.ascent)?;
serializer.serialize_field("glyphs", &self.glyphs)?;
Expand All @@ -375,8 +385,45 @@ impl Serialize for TextFragment {

impl Serialize for ImageFragment {
fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
let mut serializer = serializer.serialize_struct("ImageFragment", 1)?;
let mut serializer = serializer.serialize_struct("ImageFragment", 2)?;
serializer.serialize_field("debug_id", &self.debug_id)?;
serializer.serialize_field("rect", &self.rect)?;
serializer.end()
}
}

#[cfg(not(debug_assertions))]
#[derive(Clone)]
pub struct DebugId;

#[cfg(debug_assertions)]
#[derive(Clone)]
pub struct DebugId(u16);

#[cfg(not(debug_assertions))]
impl DebugId {
pub fn new() -> DebugId {
DebugId
}
}

#[cfg(debug_assertions)]
impl DebugId {
pub fn new() -> DebugId {
DebugId(layout_debug::generate_unique_debug_id())
}
}

#[cfg(not(debug_assertions))]
impl Serialize for DebugId {
fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
serializer.serialize_str(&format!("{:p}", &self))
}
}

#[cfg(debug_assertions)]
impl Serialize for DebugId {
fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
serializer.serialize_u16(self.0)
}
}
11 changes: 11 additions & 0 deletions components/layout_2020/layout_debug.rs
View file
Expand Up @@ -10,10 +10,15 @@ use serde_json::{to_string, to_value, Value};
use std::cell::RefCell;
use std::fs::File;
use std::io::Write;
#[cfg(debug_assertions)]
use std::sync::atomic::{AtomicUsize, Ordering};
use std::sync::Arc;

thread_local!(static STATE_KEY: RefCell<Option<State>> = RefCell::new(None));

#[cfg(debug_assertions)]
static DEBUG_ID_COUNTER: AtomicUsize = AtomicUsize::new(0);

pub struct Scope;

#[macro_export]
Expand Down Expand Up @@ -80,6 +85,12 @@ impl Drop for Scope {
}
}

/// Generate a unique ID for Fragments.
#[cfg(debug_assertions)]
pub fn generate_unique_debug_id() -> u16 {
DEBUG_ID_COUNTER.fetch_add(1, Ordering::SeqCst) as u16
}

/// Begin a layout debug trace. If this has not been called,
/// creating debug scopes has no effect.
pub fn begin_trace(root: Arc<FragmentTreeRoot>) {
Expand Down
2 changes: 1 addition & 1 deletion components/layout_2020/positioned.rs
View file
Expand Up @@ -5,7 +5,7 @@
use crate::context::LayoutContext;
use crate::dom_traversal::{Contents, NodeExt};
use crate::formatting_contexts::IndependentFormattingContext;
use crate::fragments::{AnonymousFragment, BoxFragment, CollapsedBlockMargins, Fragment};
use crate::fragments::{AnonymousFragment, BoxFragment, CollapsedBlockMargins, DebugId, Fragment};
use crate::geom::flow_relative::{Rect, Sides, Vec2};
use crate::sizing::ContentSizesRequest;
use crate::style_ext::{ComputedValuesExt, DisplayInside};
Expand Down
3 changes: 2 additions & 1 deletion components/layout_2020/replaced.rs
View file
Expand Up @@ -3,7 +3,7 @@
* file, You can obtain one at https://mozilla.org/MPL/2.0/. */

use crate::dom_traversal::NodeExt;
use crate::fragments::{Fragment, ImageFragment};
use crate::fragments::{DebugId, Fragment, ImageFragment};
use crate::geom::flow_relative::{Rect, Vec2};
use crate::geom::PhysicalSize;
use crate::sizing::ContentSizes;
Expand Down Expand Up @@ -113,6 +113,7 @@ impl ReplacedContent {
.and_then(|image| image.id)
.map(|image_key| {
Fragment::Image(ImageFragment {
debug_id: DebugId::new(),
style: style.clone(),
rect: Rect {
start_corner: Vec2::zero(),
Expand Down
53 changes: 22 additions & 31 deletions etc/layout_viewer/viewer.html
View file
Expand Up @@ -57,8 +57,8 @@ <h1> Servo Layout Viewer </h1>
<div class="row">
<div class="col-sm-12">
<div class='panel panel-default'>
<div class='panel-heading'>Flow Tree</div>
<div class='panel-body' id="flow-tree"></div>
<div class='panel-heading'>Fragment Tree</div>
<div class='panel-body' id="fragment-tree"></div>
</div>
</div>
<div class="col-sm-12">
Expand Down Expand Up @@ -90,28 +90,19 @@ <h1> Servo Layout Viewer </h1>
<script src="js/formatters.min.js"></script>

<script>
function get_base(trace_node) {
if (typeof(trace_node.data.base) == "undefined" && typeof(trace_node.data.block_flow) != "undefined") {
return trace_node.data.block_flow.base;
}
else {
return trace_node.data.base;
}
}

function create_flow_tree(trace_node) {
function create_fragment_tree(trace_node) {
var fragment = Object.values(trace_node)[0];
var node = {
text: Object.keys(trace_node)[0],
// id: base.id,
// icon: "dummy",
// href: "#diff-" + base.id
id: fragment.id,
icon: "dummy",
href: "#diff-" + fragment.id
};

var fragment = Object.values(trace_node)[0];
if (fragment.children) {
var children = [];
for (var i=0 ; i < fragment.children.length ; ++i) {
children.push(create_flow_tree(fragment.children[i]));
children.push(create_fragment_tree(fragment.children[i]));
}

if (children.length > 0) {
Expand All @@ -134,25 +125,25 @@ <h1> Servo Layout Viewer </h1>
}

function flatten_trace(trace_node) {
var flow_tree = create_flow_tree(Object.values(trace_node)[0]);
var fragment_tree = create_fragment_tree(Object.values(trace_node)[0]);

//var flow_hash = {};
//create_flow_hash(trace_node[0], flow_hash);

return {
tree: flow_tree,
tree: fragment_tree,
//flows: flow_hash,
}
}

function create_tree_node(trace_node) {
function create_trace_tree_node(trace_node) {
var pre_trace = flatten_trace(trace_node.pre);
var post_trace = flatten_trace(trace_node.post);

var tree_node = {
text: Object.keys(trace_node)[0],
text: trace_node.name,
icon: "dummy",
flow_tree: pre_trace.tree, // assume pre/post trace always have same tree!
fragment_tree: pre_trace.tree, // assume pre/post trace always have same tree!
//pre: pre_trace.flows,
//post: post_trace.flows,
};
Expand All @@ -161,7 +152,7 @@ <h1> Servo Layout Viewer </h1>
if (trace_node.children) {
var children = [];
for (var i=0 ; i < trace_node.children.length ; ++i) {
children.push(create_tree_node(trace_node.children[i]));
children.push(create_trace_tree_node(trace_node.children[i]));
}

if (children.length > 0) {
Expand All @@ -172,11 +163,11 @@ <h1> Servo Layout Viewer </h1>
return tree_node;
}

function update_flow_tree_bgcolor(flow_tree_node, node_color_hash) {
flow_tree_node.backColor = node_color_hash[flow_tree_node.id];
if (flow_tree_node.nodes !== undefined) {
for (var i=0 ; i < flow_tree_node.nodes.length ; ++i) {
update_flow_tree_bgcolor(flow_tree_node.nodes[i], node_color_hash)
function update_fragment_tree_bgcolor(fragment_tree_node, node_color_hash) {
fragment_tree_node.backColor = node_color_hash[fragment_tree_node.id];
if (fragment_tree_node.nodes !== undefined) {
for (var i=0 ; i < fragment_tree_node.nodes.length ; ++i) {
update_fragment_tree_bgcolor(fragment_tree_node.nodes[i], node_color_hash)
}
}
}
Expand All @@ -185,7 +176,7 @@ <h1> Servo Layout Viewer </h1>
jsondiffpatch.formatters.html.hideUnchanged();

var node_color_hash = {};
var tree = [ create_tree_node(data) ];
var tree = [ create_trace_tree_node(data) ];
$('#trace-tree').treeview({data: tree, levels: 3});
$('#trace-tree').on('nodeSelected', function(event, node) {
$("#flow-diffs").empty();
Expand Down Expand Up @@ -228,8 +219,8 @@ <h1> Servo Layout Viewer </h1>
}
}

update_flow_tree_bgcolor(node.flow_tree, node_color_hash);
$('#flow-tree').treeview({data: [node.flow_tree], levels: 100, enableLinks: true, emptyIcon: "glyphicon glyphicon-unchecked hidden-glyphicon"});
update_fragment_tree_bgcolor(node.fragment_tree, node_color_hash);
$('#fragment-tree').treeview({data: [node.fragment_tree], levels: 100, enableLinks: true, emptyIcon: "glyphicon glyphicon-unchecked hidden-glyphicon"});
});

$('#trace-tree').treeview(true).selectNode(0);
Expand Down

0 comments on commit 67706f9

Please sign in to comment.