diff --git a/components/style/gecko/restyle_damage.rs b/components/style/gecko/restyle_damage.rs index a1c7fc2c4e9..074259920cd 100644 --- a/components/style/gecko/restyle_damage.rs +++ b/components/style/gecko/restyle_damage.rs @@ -2,6 +2,8 @@ * License, v. 2.0. If a copy of the MPL was not distributed with this * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ +//! Gecko's restyle damage computation (aka change hints, aka `nsChangeHint`). + use gecko_bindings::bindings; use gecko_bindings::structs; use gecko_bindings::structs::{nsChangeHint, nsStyleContext}; @@ -10,28 +12,42 @@ use properties::ComputedValues; use std::ops::{BitOr, BitOrAssign}; use std::sync::Arc; +/// The representation of Gecko's restyle damage is just a wrapper over +/// `nsChangeHint`. #[derive(Clone, Copy, Debug, PartialEq)] pub struct GeckoRestyleDamage(nsChangeHint); impl GeckoRestyleDamage { + /// Trivially construct a new `GeckoRestyleDamage`. pub fn new(raw: nsChangeHint) -> Self { GeckoRestyleDamage(raw) } + /// Get the inner change hint for this damage. pub fn as_change_hint(&self) -> nsChangeHint { self.0 } + /// Get an empty change hint, that is (`nsChangeHint(0)`). pub fn empty() -> Self { GeckoRestyleDamage(nsChangeHint(0)) } + /// Returns whether this restyle damage represents the empty damage. pub fn is_empty(&self) -> bool { self.0 == nsChangeHint(0) } + /// Computes a change hint given an old style (in the form of a + /// `nsStyleContext`, and a new style (in the form of `ComputedValues`). + /// + /// Note that we could in theory just get two `ComputedValues` here and diff + /// them, but Gecko has an interesting optimization when they mark accessed + /// structs, so they effectively only diff structs that have ever been + /// accessed from layout. pub fn compute(source: &nsStyleContext, new_style: &Arc) -> Self { + // TODO(emilio): Const-ify this? let context = source as *const nsStyleContext as *mut nsStyleContext; let hint = unsafe { bindings::Gecko_CalcStyleDifference(context, @@ -40,6 +56,8 @@ impl GeckoRestyleDamage { GeckoRestyleDamage(hint) } + /// Get a restyle damage that represents the maximum action to be taken + /// (rebuild and reflow). pub fn rebuild_and_reflow() -> Self { GeckoRestyleDamage(structs::nsChangeHint_nsChangeHint_ReconstructFrame) }