From cb9cfe2b22e6d80e8b30ad64f2cff5e22a61c284 Mon Sep 17 00:00:00 2001
From: Avi Weinstock <aweinstock314@gmail.com>
Date: Wed, 25 Mar 2015 10:58:54 -0400
Subject: [PATCH] Replace (String, Option<String>) with MozBrowserEvent in uses
 of MozBrowserEventMsg.

---
 components/compositing/constellation.rs    | 21 +++----
 components/compositing/pipeline.rs         | 12 ++--
 components/msg/constellation_msg.rs        | 66 +++++++++++++++++++++-
 components/script/dom/document.rs          | 17 +++---
 components/script/dom/htmliframeelement.rs | 12 ++--
 components/script/script_task.rs           | 19 +++----
 components/script_traits/lib.rs            |  4 +-
 7 files changed, 102 insertions(+), 49 deletions(-)

diff --git a/components/compositing/constellation.rs b/components/compositing/constellation.rs
index 45dd597b4137..e5eccca7e1a9 100644
--- a/components/compositing/constellation.rs
+++ b/components/compositing/constellation.rs
@@ -20,7 +20,7 @@ use msg::constellation_msg::{self, ConstellationChan, Failure};
 use msg::constellation_msg::{IFrameSandboxState, NavigationDirection};
 use msg::constellation_msg::{Key, KeyState, KeyModifiers, LoadData};
 use msg::constellation_msg::{FrameId, PipelineExitType, PipelineId};
-use msg::constellation_msg::{SubpageId, WindowSizeData};
+use msg::constellation_msg::{SubpageId, WindowSizeData, MozBrowserEvent};
 use msg::constellation_msg::Msg as ConstellationMsg;
 use net::image_cache_task::{ImageCacheTask, ImageCacheTaskClient};
 use net::resource_task::{self, ResourceTask};
@@ -364,15 +364,13 @@ impl<LTF: LayoutTaskFactory, STF: ScriptTaskFactory> Constellation<LTF, STF> {
                 debug!("constellation got get-pipeline-title message");
                 self.handle_get_pipeline_title_msg(pipeline_id);
             }
-            ConstellationMsg::MozBrowserEvent(pipeline_id,
-                                              subpage_id,
-                                              event_name,
-                                              event_detail) => {
+            ConstellationMsg::MozBrowserEventMsg(pipeline_id,
+                                                 subpage_id,
+                                                 event) => {
                 debug!("constellation got mozbrowser event message");
                 self.handle_mozbrowser_event_msg(pipeline_id,
                                                  subpage_id,
-                                                 event_name,
-                                                 event_detail);
+                                                 event);
             }
         }
         true
@@ -643,14 +641,13 @@ impl<LTF: LayoutTaskFactory, STF: ScriptTaskFactory> Constellation<LTF, STF> {
     fn handle_mozbrowser_event_msg(&mut self,
                                    containing_pipeline_id: PipelineId,
                                    subpage_id: SubpageId,
-                                   event_name: String,
-                                   event_detail: Option<String>) {
+                                   event: MozBrowserEvent) {
         assert!(opts::experimental_enabled());
 
         // Find the script channel for the given parent pipeline,
         // and pass the event to that script task.
         let pipeline = self.pipeline(containing_pipeline_id);
-        pipeline.trigger_mozbrowser_event(subpage_id, event_name, event_detail);
+        pipeline.trigger_mozbrowser_event(subpage_id, event);
     }
 
     fn add_or_replace_pipeline_in_frame_tree(&mut self, frame_change: FrameChange) {
@@ -880,9 +877,7 @@ impl<LTF: LayoutTaskFactory, STF: ScriptTaskFactory> Constellation<LTF, STF> {
             // If this is an iframe, then send the event with new url
             if let Some((containing_pipeline_id, subpage_id, url)) = event_info {
                 let parent_pipeline = self.pipeline(containing_pipeline_id);
-                parent_pipeline.trigger_mozbrowser_event(subpage_id,
-                                                         "mozbrowserlocationchange".to_owned(),
-                                                          Some(url));
+                parent_pipeline.trigger_mozbrowser_event(subpage_id, MozBrowserEvent::LocationChange(url));
             }
         }
     }
diff --git a/components/compositing/pipeline.rs b/components/compositing/pipeline.rs
index b5fcebb578ae..a0b3c4b06dc8 100644
--- a/components/compositing/pipeline.rs
+++ b/components/compositing/pipeline.rs
@@ -15,7 +15,7 @@ use gfx::paint_task::{PaintChan, PaintTask};
 use gfx::font_cache_task::FontCacheTask;
 use layers::geometry::DevicePixel;
 use msg::constellation_msg::{ConstellationChan, Failure, FrameId, PipelineId, SubpageId};
-use msg::constellation_msg::{LoadData, WindowSizeData, PipelineExitType};
+use msg::constellation_msg::{LoadData, WindowSizeData, PipelineExitType, MozBrowserEvent};
 use net::image_cache_task::ImageCacheTask;
 use net::resource_task::ResourceTask;
 use net::storage_task::StorageTask;
@@ -248,15 +248,13 @@ impl Pipeline {
 
     pub fn trigger_mozbrowser_event(&self,
                                      subpage_id: SubpageId,
-                                     event_name: String,
-                                     event_detail: Option<String>) {
+                                     event: MozBrowserEvent) {
         assert!(opts::experimental_enabled());
 
         let ScriptControlChan(ref script_channel) = self.script_chan;
-        let event = ConstellationControlMsg::MozBrowserEvent(self.id,
-                                                             subpage_id,
-                                                             event_name,
-                                                             event_detail);
+        let event = ConstellationControlMsg::MozBrowserEventMsg(self.id,
+                                                                subpage_id,
+                                                                event);
         script_channel.send(event).unwrap();
     }
 }
diff --git a/components/msg/constellation_msg.rs b/components/msg/constellation_msg.rs
index 28528a6ff8e3..d260d344b2d3 100644
--- a/components/msg/constellation_msg.rs
+++ b/components/msg/constellation_msg.rs
@@ -213,9 +213,73 @@ pub enum Msg {
     /// Requests that the constellation inform the compositor of the a cursor change.
     SetCursor(Cursor),
     /// Dispatch a mozbrowser event to a given iframe. Only available in experimental mode.
-    MozBrowserEvent(PipelineId, SubpageId, String, Option<String>),
+    MozBrowserEventMsg(PipelineId, SubpageId, MozBrowserEvent),
 }
 
+// https://developer.mozilla.org/en-US/docs/Web/API/Using_the_Browser_API#Events
+pub enum MozBrowserEvent {
+    /// Sent when the scroll position within a browser <iframe> changes.
+    AsyncScroll,
+    /// Sent when window.close() is called within a browser <iframe>.
+    Close,
+    /// Sent when a browser <iframe> tries to open a context menu. This allows  handling <menuitem> element available within the browser <iframe>'s content.
+    ContextMenu,
+    /// Sent when an error occurred while trying to load content within a browser <iframe>.
+    Error,
+    /// Sent when the favicon of a browser <iframe> changes.
+    IconChange,
+    /// Sent when the browser <iframe> has finished loading all its assets.
+    LoadEnd,
+    /// Sent when the browser <iframe> starts to load a new page.
+    LoadStart,
+    /// Sent when a browser <iframe>'s location changes.
+    LocationChange(String),
+    /// Sent when window.open() is called within a browser <iframe>.
+    OpenWindow,
+    /// Sent when the SSL state changes within a browser <iframe>.
+    SecurityChange,
+    /// Sent when alert(), confirm(), or prompt() is called within a browser <iframe>.
+    ShowModalPrompt,
+    /// Sent when the document.title changes within a browser <iframe>.
+    TitleChange(String),
+    /// Sent when an HTTP authentification is requested.
+    UsernameAndPasswordRequired,
+    /// Sent when a link to a search engine is found.
+    OpenSearch,
+}
+
+impl MozBrowserEvent {
+    pub fn name(&self) -> &'static str {
+        match *self {
+            MozBrowserEvent::AsyncScroll => "mozbrowserasyncscroll",
+            MozBrowserEvent::Close => "mozbrowserclose",
+            MozBrowserEvent::ContextMenu => "mozbrowsercontextmenu",
+            MozBrowserEvent::Error => "mozbrowsererror",
+            MozBrowserEvent::IconChange => "mozbrowsericonchange",
+            MozBrowserEvent::LoadEnd => "mozbrowserloadend",
+            MozBrowserEvent::LoadStart => "mozbrowserloadstart",
+            MozBrowserEvent::LocationChange(_) => "mozbrowserlocationchange",
+            MozBrowserEvent::OpenWindow => "mozbrowseropenwindow",
+            MozBrowserEvent::SecurityChange => "mozbrowsersecuritychange",
+            MozBrowserEvent::ShowModalPrompt => "mozbrowsershowmodalprompt",
+            MozBrowserEvent::TitleChange(_) => "mozbrowsertitlechange",
+            MozBrowserEvent::UsernameAndPasswordRequired => "mozbrowserusernameandpasswordrequired",
+            MozBrowserEvent::OpenSearch => "mozbrowseropensearch"
+        }
+    }
+    pub fn detail(&self) -> Option<String> {
+        match *self {
+            MozBrowserEvent::AsyncScroll | MozBrowserEvent::Close | MozBrowserEvent::ContextMenu |
+            MozBrowserEvent::Error | MozBrowserEvent::IconChange | MozBrowserEvent::LoadEnd |
+            MozBrowserEvent::LoadStart | MozBrowserEvent::OpenWindow | MozBrowserEvent::SecurityChange |
+            MozBrowserEvent::ShowModalPrompt | MozBrowserEvent::UsernameAndPasswordRequired | MozBrowserEvent::OpenSearch => None,
+            MozBrowserEvent::LocationChange(ref new_location) => Some(new_location.clone()),
+            MozBrowserEvent::TitleChange(ref new_title) => Some(new_title.clone()),
+        }
+    }
+}
+
+
 /// Similar to net::resource_task::LoadData
 /// can be passed to LoadUrl to load a page with GET/POST
 /// parameters or headers
diff --git a/components/script/dom/document.rs b/components/script/dom/document.rs
index a153d462772b..8ceb6ace1f30 100644
--- a/components/script/dom/document.rs
+++ b/components/script/dom/document.rs
@@ -61,7 +61,7 @@ use dom::window::{Window, WindowHelpers, ReflowReason};
 use layout_interface::{HitTestResponse, MouseOverResponse};
 use msg::compositor_msg::ScriptListener;
 use msg::constellation_msg::Msg as ConstellationMsg;
-use msg::constellation_msg::{ConstellationChan, Key, KeyState, KeyModifiers};
+use msg::constellation_msg::{ConstellationChan, Key, KeyState, KeyModifiers, MozBrowserEvent};
 use msg::constellation_msg::{SUPER, ALT, SHIFT, CONTROL};
 use net::resource_task::ControlMsg::{SetCookiesForUrl, GetCookiesForUrl};
 use net::cookie_storage::CookieSource::NonHTTP;
@@ -223,7 +223,7 @@ pub trait DocumentHelpers<'a> {
     fn handle_mouse_move_event(self, js_runtime: *mut JSRuntime, point: Point2D<f32>,
                                prev_mouse_over_targets: &mut Vec<JS<Node>>) -> bool;
     fn set_current_script(self, script: Option<JSRef<HTMLScriptElement>>);
-    fn trigger_mozbrowser_event(self, event_name: String, event_detail: Option<String>);
+    fn trigger_mozbrowser_event(self, event: MozBrowserEvent);
 }
 
 impl<'a> DocumentHelpers<'a> for JSRef<'a, Document> {
@@ -458,7 +458,7 @@ impl<'a> DocumentHelpers<'a> for JSRef<'a, Document> {
     /// Handles any updates when the document's title has changed.
     fn title_changed(self) {
         // https://developer.mozilla.org/en-US/docs/Web/Events/mozbrowsertitlechange
-        self.trigger_mozbrowser_event("mozbrowsertitlechange".to_owned(), Some(self.Title()));
+        self.trigger_mozbrowser_event(MozBrowserEvent::TitleChange(self.Title()));
 
         self.send_title_to_compositor();
     }
@@ -683,16 +683,15 @@ impl<'a> DocumentHelpers<'a> for JSRef<'a, Document> {
         self.current_script.assign(script);
     }
 
-    fn trigger_mozbrowser_event(self, event_name: String, event_detail: Option<String>) {
+    fn trigger_mozbrowser_event(self, event: MozBrowserEvent) {
         if opts::experimental_enabled() {
             let window = self.window.root();
 
             if let Some((containing_pipeline_id, subpage_id)) = window.r().parent_info() {
                 let ConstellationChan(ref chan) = window.r().constellation_chan();
-                let event = ConstellationMsg::MozBrowserEvent(containing_pipeline_id,
-                                                              subpage_id,
-                                                              event_name,
-                                                              event_detail);
+                let event = ConstellationMsg::MozBrowserEventMsg(containing_pipeline_id,
+                                                                 subpage_id,
+                                                                 event);
                 chan.send(event).unwrap();
             }
         }
@@ -1464,7 +1463,7 @@ impl DocumentProgressHandler {
         });
 
         // https://developer.mozilla.org/en-US/docs/Web/Events/mozbrowserloadend
-        document.r().trigger_mozbrowser_event("mozbrowserloadend".to_owned(), None);
+        document.r().trigger_mozbrowser_event(MozBrowserEvent::LoadEnd);
 
         window_ref.reflow(ReflowGoal::ForDisplay,
                           ReflowQueryType::NoQuery,
diff --git a/components/script/dom/htmliframeelement.rs b/components/script/dom/htmliframeelement.rs
index 64a0f2db7a76..1c5e9ec2349d 100644
--- a/components/script/dom/htmliframeelement.rs
+++ b/components/script/dom/htmliframeelement.rs
@@ -29,7 +29,7 @@ use dom::virtualmethods::VirtualMethods;
 use dom::window::{Window, WindowHelpers};
 use page::IterablePage;
 
-use msg::constellation_msg::{PipelineId, SubpageId, ConstellationChan, NavigationDirection};
+use msg::constellation_msg::{PipelineId, SubpageId, ConstellationChan, MozBrowserEvent, NavigationDirection};
 use msg::constellation_msg::IFrameSandboxState::{IFrameSandboxed, IFrameUnsandboxed};
 use msg::constellation_msg::Msg as ConstellationMsg;
 use util::opts;
@@ -72,7 +72,7 @@ pub trait HTMLIFrameElementHelpers {
     fn process_the_iframe_attributes(self);
     fn generate_new_subpage_id(self) -> (SubpageId, Option<SubpageId>);
     fn navigate_child_browsing_context(self, url: Url);
-    fn dispatch_mozbrowser_event(self, event_name: String, event_detail: Option<String>);
+    fn dispatch_mozbrowser_event(self, event: MozBrowserEvent);
     fn update_subpage_id(self, new_subpage_id: SubpageId);
 }
 
@@ -125,7 +125,7 @@ impl<'a> HTMLIFrameElementHelpers for JSRef<'a, HTMLIFrameElement> {
 
         if opts::experimental_enabled() {
             // https://developer.mozilla.org/en-US/docs/Web/Events/mozbrowserloadstart
-            self.dispatch_mozbrowser_event("mozbrowserloadstart".to_owned(), None);
+            self.dispatch_mozbrowser_event(MozBrowserEvent::LoadStart);
         }
     }
 
@@ -138,7 +138,7 @@ impl<'a> HTMLIFrameElementHelpers for JSRef<'a, HTMLIFrameElement> {
         self.navigate_child_browsing_context(url);
     }
 
-    fn dispatch_mozbrowser_event(self, event_name: String, event_detail: Option<String>) {
+    fn dispatch_mozbrowser_event(self, event: MozBrowserEvent) {
         // TODO(gw): Support mozbrowser event types that have detail which is not a string.
         // See https://developer.mozilla.org/en-US/docs/Web/API/Using_the_Browser_API
         // for a list of mozbrowser events.
@@ -148,10 +148,10 @@ impl<'a> HTMLIFrameElementHelpers for JSRef<'a, HTMLIFrameElement> {
             let window = window_from_node(self).root();
             let cx = window.r().get_cx();
             let custom_event = CustomEvent::new(GlobalRef::Window(window.r()),
-                                                event_name.to_owned(),
+                                                event.name().to_owned(),
                                                 true,
                                                 true,
-                                                event_detail.to_jsval(cx)).root();
+                                                event.detail().to_jsval(cx)).root();
             let target: JSRef<EventTarget> = EventTargetCast::from_ref(self);
             let event: JSRef<Event> = EventCast::from_ref(custom_event.r());
             event.fire(target);
diff --git a/components/script/script_task.rs b/components/script/script_task.rs
index 35e57eacfa3e..5fb17c2fcd3d 100644
--- a/components/script/script_task.rs
+++ b/components/script/script_task.rs
@@ -57,8 +57,8 @@ use script_traits::ScriptTaskFactory;
 use msg::compositor_msg::ReadyState::{FinishedLoading, Loading, PerformingLayout};
 use msg::compositor_msg::{LayerId, ScriptListener};
 use msg::constellation_msg::{ConstellationChan};
-use msg::constellation_msg::{LoadData, PipelineId, SubpageId};
-use msg::constellation_msg::{Failure, Msg, WindowSizeData, PipelineExitType};
+use msg::constellation_msg::{LoadData, PipelineId, SubpageId, MozBrowserEvent};
+use msg::constellation_msg::{Failure, WindowSizeData, PipelineExitType};
 use msg::constellation_msg::Msg as ConstellationMsg;
 use net::image_cache_task::ImageCacheTask;
 use net::resource_task::{ResourceTask, ControlMsg, LoadResponse};
@@ -644,14 +644,12 @@ impl ScriptTask {
                 self.handle_freeze_msg(pipeline_id),
             ConstellationControlMsg::Thaw(pipeline_id) =>
                 self.handle_thaw_msg(pipeline_id),
-            ConstellationControlMsg::MozBrowserEvent(parent_pipeline_id,
-                                                     subpage_id,
-                                                     event_name,
-                                                     event_detail) =>
+            ConstellationControlMsg::MozBrowserEventMsg(parent_pipeline_id,
+                                                        subpage_id,
+                                                        event) =>
                 self.handle_mozbrowser_event_msg(parent_pipeline_id,
                                                  subpage_id,
-                                                 event_name,
-                                                 event_detail),
+                                                 event),
             ConstellationControlMsg::UpdateSubpageId(containing_pipeline_id,
                                                      old_subpage_id,
                                                      new_subpage_id) =>
@@ -802,8 +800,7 @@ impl ScriptTask {
     fn handle_mozbrowser_event_msg(&self,
                                    parent_pipeline_id: PipelineId,
                                    subpage_id: SubpageId,
-                                   event_name: String,
-                                   event_detail: Option<String>) {
+                                   event: MozBrowserEvent) {
         let borrowed_page = self.root_page();
 
         let frame_element = borrowed_page.find(parent_pipeline_id).and_then(|page| {
@@ -817,7 +814,7 @@ impl ScriptTask {
         }).root();
 
         if let Some(frame_element) = frame_element {
-            frame_element.r().dispatch_mozbrowser_event(event_name, event_detail);
+            frame_element.r().dispatch_mozbrowser_event(event);
         }
     }
 
diff --git a/components/script_traits/lib.rs b/components/script_traits/lib.rs
index 6ae35202c7ec..5b4be3731b2e 100644
--- a/components/script_traits/lib.rs
+++ b/components/script_traits/lib.rs
@@ -21,7 +21,7 @@ use devtools_traits::DevtoolsControlChan;
 use libc::c_void;
 use msg::constellation_msg::{ConstellationChan, PipelineId, Failure, WindowSizeData};
 use msg::constellation_msg::{LoadData, SubpageId, Key, KeyState, KeyModifiers};
-use msg::constellation_msg::PipelineExitType;
+use msg::constellation_msg::{MozBrowserEvent, PipelineExitType};
 use msg::compositor_msg::ScriptListener;
 use net::image_cache_task::ImageCacheTask;
 use net::resource_task::ResourceTask;
@@ -73,7 +73,7 @@ pub enum ConstellationControlMsg {
     /// Notifies script task that a url should be loaded in this iframe.
     Navigate(PipelineId, SubpageId, LoadData),
     /// Requests the script task forward a mozbrowser event to an iframe it owns
-    MozBrowserEvent(PipelineId, SubpageId, String, Option<String>),
+    MozBrowserEventMsg(PipelineId, SubpageId, MozBrowserEvent),
     /// Updates the current subpage id of a given iframe
     UpdateSubpageId(PipelineId, SubpageId, SubpageId),
 }