extensions/browser/declarative_user_script_master.h

   1 // Copyright 2014 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef EXTENSIONS_BROWSER_DECLARATIVE_USER_SCRIPT_MASTER_H_
   6 #define EXTENSIONS_BROWSER_DECLARATIVE_USER_SCRIPT_MASTER_H_
   7
   8 #include <set>
   9
  10 #include "base/memory/scoped_ptr.h"
  11 #include "base/scoped_observer.h"
  12 #include "extensions/common/host_id.h"
  13
  14 namespace content {
  15 class BrowserContext;
  16 }
  17
  18 namespace extensions {
  19
  20 class UserScript;
  21 class UserScriptLoader;
  22
  23 // Manages declarative user scripts for a single extension. Owns a
  24 // UserScriptLoader to which file loading and shared memory management
  25 // operations are delegated, and provides an interface for adding, removing,
  26 // and clearing scripts.
  27 class DeclarativeUserScriptMaster {
  28  public:
  29   DeclarativeUserScriptMaster(content::BrowserContext* browser_context,
  30                               const HostID& host_id);
  31   ~DeclarativeUserScriptMaster();
  32
  33   // Adds script to shared memory region. This may not happen right away if a
  34   // script load is in progress.
  35   void AddScript(const UserScript& script);
  36
  37   // Adds a set of scripts to shared meomory region. The fetch of the content
  38   // of the script on WebUI requires to start URL request to the associated
  39   // render specified by |render_process_id, render_view_id|.
  40   // This may not happen right away if a script load is in progress.
  41   void AddScripts(const std::set<UserScript>& scripts,
  42                   int render_process_id,
  43                   int render_view_id);
  44
  45   // Removes script from shared memory region. This may not happen right away if
  46   // a script load is in progress.
  47   void RemoveScript(const UserScript& script);
  48
  49   // Removes a set of scripts from shared memory region. This may not happen
  50   // right away if a script load is in progress.
  51   void RemoveScripts(const std::set<UserScript>& scripts);
  52
  53   // Removes all scripts from shared memory region. This may not happen right
  54   // away if a script load is in progress.
  55   void ClearScripts();
  56
  57   const HostID& host_id() const { return host_id_; }
  58
  59   UserScriptLoader* loader() { return loader_.get(); }
  60
  61  private:
  62   // ID of host that owns scripts that this component manages.
  63   HostID host_id_;
  64
  65   // Script loader that handles loading contents of scripts into shared memory
  66   // and notifying renderers of script updates.
  67   scoped_ptr<UserScriptLoader> loader_;
  68
  69   DISALLOW_COPY_AND_ASSIGN(DeclarativeUserScriptMaster);
  70 };
  71
  72 }  // namespace extensions
  73
  74 #endif  // EXTENSIONS_BROWSER_DECLARATIVE_USER_SCRIPT_MASTER_H_