Adding run_at to chrome.tabs.executeScript/insertCss.

chrome/renderer/extensions/user_script_idle_scheduler.cc

 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #include "chrome/renderer/extensions/user_script_idle_scheduler.h"
 
 #include "base/bind.h"
 #include "base/message_loop.h"
 #include "chrome/common/extensions/extension_error_utils.h"
 #include "chrome/common/extensions/extension_messages.h"
+#include "chrome/common/extensions/user_script.h"
 #include "chrome/renderer/extensions/extension_dispatcher.h"
 #include "chrome/renderer/extensions/extension_groups.h"
 #include "chrome/renderer/extensions/extension_helper.h"
 #include "chrome/renderer/extensions/user_script_slave.h"
 #include "content/public/renderer/render_view.h"
 #include "third_party/WebKit/Source/WebKit/chromium/public/WebDocument.h"
 #include "third_party/WebKit/Source/WebKit/chromium/public/WebFrame.h"
 #include "third_party/WebKit/Source/WebKit/chromium/public/platform/WebString.h"
 #include "third_party/WebKit/Source/WebKit/chromium/public/WebView.h"
 
 namespace {
 // The length of time to wait after the DOM is complete to try and run user
 // scripts.
 const int kUserScriptIdleTimeoutMs = 200;
 }
 
 using WebKit::WebDocument;
 using WebKit::WebFrame;
 using WebKit::WebString;
 using WebKit::WebView;
 
 UserScriptIdleScheduler::UserScriptIdleScheduler(
     WebFrame* frame, ExtensionDispatcher* extension_dispatcher)
     : ALLOW_THIS_IN_INITIALIZER_LIST(weak_factory_(this)),
       frame_(frame),
       has_run_(false),
+      current_location_(-1),
       extension_dispatcher_(extension_dispatcher) {
+  for (int i = 0; i < UserScript::RUN_LOCATION_LAST; ++i)
+    pending_code_execution_queue_.push_back(

[Aaron Boodman, 2012/03/03 00:59:10]

You're essentially using this like a map. So why not make it a map:

std::map<UserScript::RunLocation, std::queue<...>>

[eaugusti, 2012/03/27 00:43:33]

Done.

+      std::queue<linked_ptr<ExtensionMsg_ExecuteCode_Params> >());
 }
 
 UserScriptIdleScheduler::~UserScriptIdleScheduler() {
 }
 
 void UserScriptIdleScheduler::ExecuteCode(
     const ExtensionMsg_ExecuteCode_Params& params) {
-  if (!has_run_) {
-    pending_code_execution_queue_.push(
+  if (!has_run_ &&
+      params.run_at != UserScript::DOCUMENT_NOW &&

[Mihai Parparita -not on Chrome, 2012/03/01 00:40:08]

Is it OK to always immediately execute script when DOCUMENT_NOW is passed in? It
seems like if we're before DOCUMENT_START, then there might not be a document to
execute in.

[Aaron Boodman, 2012/03/03 00:59:10]

Agree with Mihai that we should always wait until at least DOCUMENT_START.

[eaugusti, 2012/03/27 00:43:33]

Done.

[eaugusti, 2012/03/27 00:43:34]

Done.

+      current_location_ < params.run_at) {
+    pending_code_execution_queue_[params.run_at].push(
         linked_ptr<ExtensionMsg_ExecuteCode_Params>(
             new ExtensionMsg_ExecuteCode_Params(params)));
     return;
   }
-
   ExecuteCodeImpl(params);
 }
 
+void UserScriptIdleScheduler::DidCreateDocumentElement() {
+  current_location_ = UserScript::DOCUMENT_START;
+  MessageLoop::current()->PostTask(

[Aaron Boodman, 2012/03/03 00:59:10]

Why PostTask as opposed to running immediately? The one for DidFinishLoad() was
there for a pretty specific reason which is commented. I don't think it applies
here.

[eaugusti, 2012/03/27 00:43:34]

Done.

+      FROM_HERE, base::Bind(&UserScriptIdleScheduler::MaybeRun,
+                            weak_factory_.GetWeakPtr()));
+}
+
 void UserScriptIdleScheduler::DidFinishDocumentLoad() {
+  current_location_ = UserScript::DOCUMENT_END;
+  // Schedule a run for DOCUMENT_END
+  MessageLoop::current()->PostTask(

[Aaron Boodman, 2012/03/03 00:59:10]

Same here. Don't think PostTask is necessary.

[eaugusti, 2012/03/27 00:43:34]

Done.

+      FROM_HERE, base::Bind(&UserScriptIdleScheduler::MaybeRun,
+                            weak_factory_.GetWeakPtr()));
+  // Schedule a run for DOCUMENT_IDLE
   MessageLoop::current()->PostDelayedTask(
-      FROM_HERE, base::Bind(&UserScriptIdleScheduler::MaybeRun,
+      FROM_HERE, base::Bind(&UserScriptIdleScheduler::IdleTimeout,
                             weak_factory_.GetWeakPtr()),
       base::TimeDelta::FromMilliseconds(kUserScriptIdleTimeoutMs));
 }
 
 void UserScriptIdleScheduler::DidFinishLoad() {
+  current_location_ = UserScript::DOCUMENT_IDLE;
   // Ensure that running scripts does not keep any progress UI running.
   MessageLoop::current()->PostTask(
       FROM_HERE, base::Bind(&UserScriptIdleScheduler::MaybeRun,
                             weak_factory_.GetWeakPtr()));
 }
 
 void UserScriptIdleScheduler::DidStartProvisionalLoad() {
   // The frame is navigating, so reset the state since we'll want to inject
   // scripts once the load finishes.
+  current_location_ = -1;
   has_run_ = false;
   weak_factory_.InvalidateWeakPtrs();
-  while (!pending_code_execution_queue_.empty())
-    pending_code_execution_queue_.pop();
+  Schedule::iterator itr = pending_code_execution_queue_.begin();
+  for (itr = pending_code_execution_queue_.begin();
+       itr != pending_code_execution_queue_.end(); ++itr) {
+    while (!itr->empty())
+      itr->pop();
+  }
+}
+
+void UserScriptIdleScheduler::IdleTimeout() {
+  current_location_ = UserScript::DOCUMENT_IDLE;
+  MessageLoop::current()->PostTask(
+      FROM_HERE, base::Bind(&UserScriptIdleScheduler::MaybeRun,
+                            weak_factory_.GetWeakPtr()));
 }
 
 void UserScriptIdleScheduler::MaybeRun() {
-  if (has_run_)
+  if (has_run_ || current_location_ == -1)
     return;
 
   // Note: we must set this before calling ExecuteCodeImpl, because that may

[Mihai Parparita -not on Chrome, 2012/03/01 00:40:08]

This comment doesn't seem to be true anymore (ExecuteCodeImpl doesn't call
MaybeRun), and should probably be deleted.

[eaugusti, 2012/03/27 00:43:34]

Done.

   // result in a synchronous call back into MaybeRun if there is a pending task
   // currently in the queue.
   // http://code.google.com/p/chromium/issues/detail?id=29644
   has_run_ = true;
 
   extension_dispatcher_->user_script_slave()->InjectScripts(
-      frame_, UserScript::DOCUMENT_IDLE);
+      frame_, (UserScript::RunLocation)current_location_);

[Mihai Parparita -not on Chrome, 2012/03/01 00:40:08]

Use C++-style casts:
http://google-styleguide.googlecode.com/svn/trunk/cppguide.xml#Casting

Alternatively (and I think like this better), add a new RunLocation enum value
UNDEFINED, and use that instead of a special -1 value, so that current_location_
can be of type RunLocation.

[eaugusti, 2012/03/27 00:43:34]

Done.

 
-  while (!pending_code_execution_queue_.empty()) {
-    linked_ptr<ExtensionMsg_ExecuteCode_Params>& params =
-        pending_code_execution_queue_.front();
-    ExecuteCodeImpl(*params);
-    pending_code_execution_queue_.pop();
+  // Run all tasks from the current time and earlier.
+  for (int runTime = 0; runTime <= current_location_; ++runTime) {
+    while (!pending_code_execution_queue_[runTime].empty()) {
+      linked_ptr<ExtensionMsg_ExecuteCode_Params>& params =
+        pending_code_execution_queue_[runTime].front();
+      ExecuteCodeImpl(*params);
+      pending_code_execution_queue_[runTime].pop();
+    }
   }
 }
 
 void UserScriptIdleScheduler::ExecuteCodeImpl(
     const ExtensionMsg_ExecuteCode_Params& params) {
   const Extension* extension = extension_dispatcher_->extensions()->GetByID(
       params.extension_id);
   content::RenderView* render_view =
       content::RenderView::FromWebView(frame_->view());
 
@@ skipping 67 matching lines @@
   if (!parent_frame)
     return false;
 
   for (WebFrame* child_frame = parent_frame->firstChild(); child_frame;
        child_frame = child_frame->nextSibling()) {
     frames_vector->push_back(child_frame);
     GetAllChildFrames(child_frame, frames_vector);
   }
   return true;
 }