Skip to content

Commit

Permalink
Make compositing generic over layout_task
Browse files Browse the repository at this point in the history
This will allow breaking the layout -> compositing dependency
  • Loading branch information
Ariel Ben-Yehuda committed Jul 21, 2014
1 parent 4b3a78e commit 7ac6924
Show file tree
Hide file tree
Showing 4 changed files with 119 additions and 109 deletions.
100 changes: 42 additions & 58 deletions src/components/compositing/constellation.rs
Expand Up @@ -10,6 +10,7 @@ use geom::size::TypedSize2D;
use gfx::render_task;
use libc;
use pipeline::{Pipeline, CompositionPipeline};
use layout::layout_task::LayoutTaskFactory;
use script::script_task::{ResizeMsg, ResizeInactiveMsg, ExitPipelineMsg};
use script::layout_interface;
use script::layout_interface::LayoutChan;
Expand All @@ -31,13 +32,14 @@ use servo_util::time::TimeProfilerChan;
use servo_util::url::parse_url;
use servo_util::task::spawn_named;
use std::cell::RefCell;
use std::kinds::marker;
use std::mem::replace;
use std::io;
use std::rc::Rc;
use url::Url;

/// Maintains the pipelines and navigation context and grants permission to composite
pub struct Constellation {
pub struct Constellation<LTF> {
pub chan: ConstellationChan,
pub request_port: Receiver<Msg>,
pub compositor_chan: CompositorChan,
Expand All @@ -49,6 +51,7 @@ pub struct Constellation {
next_pipeline_id: PipelineId,
pending_frames: Vec<FrameChange>,
pending_sizes: HashMap<(PipelineId, SubpageId), TypedRect<PagePx, f32>>,
layout_task_factory: marker::CovariantType<LTF>,
pub time_profiler_chan: TimeProfilerChan,
pub window_size: WindowSizeData,
pub opts: Opts,
Expand Down Expand Up @@ -240,7 +243,7 @@ impl NavigationContext {
}
}

impl Constellation {
impl<LTF: LayoutTaskFactory> Constellation<LTF> {
pub fn start(compositor_chan: CompositorChan,
opts: &Opts,
resource_task: ResourceTask,
Expand All @@ -252,7 +255,7 @@ impl Constellation {
let constellation_chan_clone = constellation_chan.clone();
let opts_clone = opts.clone();
spawn_named("Constellation", proc() {
let mut constellation = Constellation {
let mut constellation : Constellation<LTF> = Constellation {
chan: constellation_chan_clone,
request_port: constellation_port,
compositor_chan: compositor_chan,
Expand All @@ -264,6 +267,7 @@ impl Constellation {
next_pipeline_id: PipelineId(0),
pending_frames: vec!(),
pending_sizes: HashMap::new(),
layout_task_factory: marker::CovariantType,
time_profiler_chan: time_profiler_chan,
window_size: WindowSizeData {
visible_viewport: TypedSize2D(800_f32, 600_f32),
Expand All @@ -286,6 +290,26 @@ impl Constellation {
}
}

/// Helper function for creating a pipeline
fn new_pipeline(&self,
id: PipelineId,
subpage_id: Option<SubpageId>,
url: Url)
-> Pipeline {
Pipeline::create::<LTF>(id,
subpage_id,
self.chan.clone(),
self.compositor_chan.clone(),
self.image_cache_task.clone(),
self.font_cache_task.clone(),
self.resource_task.clone(),
self.time_profiler_chan.clone(),
self.window_size,
self.opts.clone(),
url)
}


/// Helper function for getting a unique pipeline Id
fn get_next_pipeline_id(&mut self) -> PipelineId {
let id = self.next_pipeline_id;
Expand Down Expand Up @@ -422,17 +446,7 @@ impl Constellation {
debug!("creating replacement pipeline for about:failure");

let new_id = self.get_next_pipeline_id();
let pipeline = Pipeline::create(new_id,
subpage_id,
self.chan.clone(),
self.compositor_chan.clone(),
self.image_cache_task.clone(),
self.font_cache_task.clone(),
self.resource_task.clone(),
self.time_profiler_chan.clone(),
self.window_size,
self.opts.clone(),
parse_url("about:failure", None));
let pipeline = self.new_pipeline(new_id, subpage_id, parse_url("about:failure", None));
pipeline.load();

let pipeline_wrapped = Rc::new(pipeline);
Expand All @@ -450,17 +464,8 @@ impl Constellation {
}

fn handle_init_load(&mut self, url: Url) {
let pipeline = Pipeline::create(self.get_next_pipeline_id(),
None,
self.chan.clone(),
self.compositor_chan.clone(),
self.image_cache_task.clone(),
self.font_cache_task.clone(),
self.resource_task.clone(),
self.time_profiler_chan.clone(),
self.window_size,
self.opts.clone(),
url);
let next_pipeline_id = self.get_next_pipeline_id();
let pipeline = self.new_pipeline(next_pipeline_id, None, url);
pipeline.load();
let pipeline_wrapped = Rc::new(pipeline);

Expand Down Expand Up @@ -577,30 +582,20 @@ impl Constellation {
let pipeline = if same_script {
debug!("Constellation: loading same-origin iframe at {:?}", url);
// Reuse the script task if same-origin url's
Pipeline::with_script(next_pipeline_id,
subpage_id,
self.chan.clone(),
self.compositor_chan.clone(),
self.image_cache_task.clone(),
self.font_cache_task.clone(),
self.time_profiler_chan.clone(),
self.opts.clone(),
source_pipeline.clone(),
url)
Pipeline::with_script::<LTF>(next_pipeline_id,
subpage_id,
self.chan.clone(),
self.compositor_chan.clone(),
self.image_cache_task.clone(),
self.font_cache_task.clone(),
self.time_profiler_chan.clone(),
self.opts.clone(),
source_pipeline.clone(),
url)
} else {
debug!("Constellation: loading cross-origin iframe at {:?}", url);
// Create a new script task if not same-origin url's
Pipeline::create(next_pipeline_id,
Some(subpage_id),
self.chan.clone(),
self.compositor_chan.clone(),
self.image_cache_task.clone(),
self.font_cache_task.clone(),
self.resource_task.clone(),
self.time_profiler_chan.clone(),
self.window_size,
self.opts.clone(),
url)
self.new_pipeline(next_pipeline_id, Some(subpage_id), url)
};

debug!("Constellation: sending load msg to pipeline {:?}", pipeline.id);
Expand Down Expand Up @@ -647,18 +642,7 @@ impl Constellation {
let subpage_id = source_frame.pipeline.subpage_id;
let next_pipeline_id = self.get_next_pipeline_id();

let pipeline = Pipeline::create(next_pipeline_id,
subpage_id,
self.chan.clone(),
self.compositor_chan.clone(),
self.image_cache_task.clone(),
self.font_cache_task.clone(),
self.resource_task.clone(),
self.time_profiler_chan.clone(),
self.window_size,
self.opts.clone(),
url);

let pipeline = self.new_pipeline(next_pipeline_id, subpage_id, url);
pipeline.load();
let pipeline_wrapped = Rc::new(pipeline);

Expand Down
100 changes: 52 additions & 48 deletions src/components/compositing/pipeline.rs
Expand Up @@ -3,7 +3,7 @@
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */

use CompositorChan;
use layout::layout_task::LayoutTask;
use layout::layout_task::LayoutTaskFactory;

use gfx::render_task::{PaintPermissionGranted, PaintPermissionRevoked};
use gfx::render_task::{RenderChan, RenderTask};
Expand Down Expand Up @@ -45,17 +45,18 @@ pub struct CompositionPipeline {
impl Pipeline {
/// Starts a render task, layout task, and script task. Returns the channels wrapped in a
/// struct.
pub fn with_script(id: PipelineId,
subpage_id: SubpageId,
constellation_chan: ConstellationChan,
compositor_chan: CompositorChan,
image_cache_task: ImageCacheTask,
font_cache_task: FontCacheTask,
time_profiler_chan: TimeProfilerChan,
opts: Opts,
script_pipeline: Rc<Pipeline>,
url: Url)
-> Pipeline {
pub fn with_script<LTF:LayoutTaskFactory>(
id: PipelineId,
subpage_id: SubpageId,
constellation_chan: ConstellationChan,
compositor_chan: CompositorChan,
image_cache_task: ImageCacheTask,
font_cache_task: FontCacheTask,
time_profiler_chan: TimeProfilerChan,
opts: Opts,
script_pipeline: Rc<Pipeline>,
url: Url)
-> Pipeline {
let (layout_port, layout_chan) = LayoutChan::new();
let (render_port, render_chan) = RenderChan::new();
let (render_shutdown_chan, render_shutdown_port) = channel();
Expand All @@ -76,18 +77,19 @@ impl Pipeline {
time_profiler_chan.clone(),
render_shutdown_chan);

LayoutTask::create(id,
layout_port,
layout_chan.clone(),
constellation_chan,
failure,
script_pipeline.script_chan.clone(),
render_chan.clone(),
image_cache_task.clone(),
font_cache_task.clone(),
opts.clone(),
time_profiler_chan,
layout_shutdown_chan);
LayoutTaskFactory::create(None::<&mut LTF>,
id,
layout_port,
layout_chan.clone(),
constellation_chan,
failure,
script_pipeline.script_chan.clone(),
render_chan.clone(),
image_cache_task.clone(),
font_cache_task.clone(),
opts.clone(),
time_profiler_chan,
layout_shutdown_chan);

let new_layout_info = NewLayoutInfo {
old_pipeline_id: script_pipeline.id.clone(),
Expand All @@ -109,18 +111,19 @@ impl Pipeline {
url)
}

pub fn create(id: PipelineId,
subpage_id: Option<SubpageId>,
constellation_chan: ConstellationChan,
compositor_chan: CompositorChan,
image_cache_task: ImageCacheTask,
font_cache_task: FontCacheTask,
resource_task: ResourceTask,
time_profiler_chan: TimeProfilerChan,
window_size: WindowSizeData,
opts: Opts,
url: Url)
-> Pipeline {
pub fn create<LTF:LayoutTaskFactory>(
id: PipelineId,
subpage_id: Option<SubpageId>,
constellation_chan: ConstellationChan,
compositor_chan: CompositorChan,
image_cache_task: ImageCacheTask,
font_cache_task: FontCacheTask,
resource_task: ResourceTask,
time_profiler_chan: TimeProfilerChan,
window_size: WindowSizeData,
opts: Opts,
url: Url)
-> Pipeline {
let (script_port, script_chan) = ScriptChan::new();
let (layout_port, layout_chan) = LayoutChan::new();
let (render_port, render_chan) = RenderChan::new();
Expand Down Expand Up @@ -161,18 +164,19 @@ impl Pipeline {
time_profiler_chan.clone(),
render_shutdown_chan);

LayoutTask::create(id,
layout_port,
layout_chan.clone(),
constellation_chan,
failure,
script_chan.clone(),
render_chan.clone(),
image_cache_task,
font_cache_task,
opts.clone(),
time_profiler_chan,
layout_shutdown_chan);
LayoutTaskFactory::create(None::<&mut LTF>,
id,
layout_port,
layout_chan.clone(),
constellation_chan,
failure,
script_chan.clone(),
render_chan.clone(),
image_cache_task,
font_cache_task,
opts.clone(),
time_profiler_chan,
layout_shutdown_chan);

pipeline
}
Expand Down
24 changes: 22 additions & 2 deletions src/components/layout/layout_task.rs
Expand Up @@ -62,6 +62,23 @@ use style::{AuthorOrigin, Stylesheet, Stylist};
use sync::{Arc, Mutex};
use url::Url;

// A static method creating a layout task
pub trait LayoutTaskFactory {
fn create(_phantom: Option<&mut Self>, // FIXME: use a proper static method
id: PipelineId,
port: Receiver<Msg>,
chan: LayoutChan,
constellation_chan: ConstellationChan,
failure_msg: Failure,
script_chan: ScriptChan,
render_chan: RenderChan,
img_cache_task: ImageCacheTask,
font_cache_task: FontCacheTask,
opts: Opts,
time_profiler_chan: TimeProfilerChan,
shutdown_chan: Sender<()>);
}

/// Information needed by the layout task.
pub struct LayoutTask {
/// The ID of the pipeline that we belong to.
Expand Down Expand Up @@ -272,9 +289,10 @@ impl ImageResponder for LayoutImageResponder {
}
}

impl LayoutTask {
impl LayoutTaskFactory for LayoutTask {
/// Spawns a new layout task.
pub fn create(id: PipelineId,
fn create(_phantom: Option<&mut LayoutTask>,
id: PipelineId,
port: Receiver<Msg>,
chan: LayoutChan,
constellation_chan: ConstellationChan,
Expand Down Expand Up @@ -306,7 +324,9 @@ impl LayoutTask {
shutdown_chan.send(());
});
}
}

impl LayoutTask {
/// Creates a new `LayoutTask` structure.
fn new(id: PipelineId,
port: Receiver<Msg>,
Expand Down
4 changes: 3 additions & 1 deletion src/components/main/servo.rs
Expand Up @@ -20,6 +20,7 @@ extern crate servo_msg = "msg";
#[phase(plugin, link)]
extern crate servo_util = "util";
extern crate script;
extern crate layout;
extern crate green;
extern crate gfx;
extern crate libc;
Expand Down Expand Up @@ -125,7 +126,8 @@ pub fn run(opts: opts::Opts) {
ImageCacheTask::new(resource_task.clone())
};
let font_cache_task = FontCacheTask::new();
let constellation_chan = Constellation::start(compositor_chan,
let constellation_chan = Constellation::<layout::layout_task::LayoutTask>::start(
compositor_chan,
opts,
resource_task,
image_cache_task,
Expand Down

0 comments on commit 7ac6924

Please sign in to comment.