Issue 5556 - Update to use libadblockplus revision hg:566f64c8a2a8

include/AdblockPlus/JsEngine.h

 /*
  * This file is part of Adblock Plus <https://adblockplus.org/>,
- * Copyright (C) 2006-2017 eyeo GmbH
+ * Copyright (C) 2006-present eyeo GmbH
  *
  * Adblock Plus is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License version 3 as
  * published by the Free Software Foundation.
  *
  * Adblock Plus is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
  *
  * You should have received a copy of the GNU General Public License
  * along with Adblock Plus.  If not, see <http://www.gnu.org/licenses/>.
  */
 
 #ifndef ADBLOCK_PLUS_JS_ENGINE_H
 #define ADBLOCK_PLUS_JS_ENGINE_H
 
 #include <functional>
 #include <map>
 #include <list>
 #include <stdexcept>
 #include <stdint.h>
 #include <string>
 #include <mutex>
 #include <AdblockPlus/AppInfo.h>
 #include <AdblockPlus/LogSystem.h>
-#include <AdblockPlus/FileSystem.h>
+#include <AdblockPlus/IFileSystem.h>
 #include <AdblockPlus/JsValue.h>
-#include <AdblockPlus/WebRequest.h>
+#include <AdblockPlus/IWebRequest.h>
 #include <AdblockPlus/ITimer.h>
+#include <AdblockPlus/Scheduler.h>
 
 namespace v8
 {
   class Isolate;
   class Value;
   class Context;
   template<typename T> class FunctionCallbackInfo;
   typedef void(*FunctionCallback)(const FunctionCallbackInfo<v8::Value>& info);
 }
 
 namespace AdblockPlus
 {
   class JsEngine;
+  class Platform;
 
   /**
    * Shared smart pointer to a `JsEngine` instance.
    */
   typedef std::shared_ptr<JsEngine> JsEnginePtr;
 
   /**
-   * A factory to construct DefaultTimer.
+   * Provides with isolate. The main aim of this iterface is to delegate a
+   * proper initialization and deinitialization of v8::Isolate to an embedder.
    */
-  TimerPtr CreateDefaultTimer();
+  struct IV8IsolateProvider
+  {
+    virtual ~IV8IsolateProvider() {}
 
-  /**
-   * A factory to construct DefaultFileSystem.
-   */
-  FileSystemPtr CreateDefaultFileSystem();
-
-  /**
-   * A factory to construct DefaultWebRequest.
-   */
-  WebRequestPtr CreateDefaultWebRequest();
-
-  /**
-   * Scope based isolate manager. Creates a new isolate instance on
-   * constructing and disposes it on destructing.
-   */
-  class ScopedV8Isolate
-  {
-  public:
-    ScopedV8Isolate();
-    ~ScopedV8Isolate();
-    v8::Isolate* Get()
-    {
-      return isolate;
-    }
-  private:
-    ScopedV8Isolate(const ScopedV8Isolate&);
-    ScopedV8Isolate& operator=(const ScopedV8Isolate&);
-
-    v8::Isolate* isolate;
+    /**
+     * Returns v8::Isolate. All subsequent calls of this method should return
+     * the same pointer to v8::Isolate as the first call.
+     */
+    virtual v8::Isolate* Get() = 0;
   };
 
   /**
    * JavaScript engine used by `FilterEngine`, wraps v8.
    */
   class JsEngine : public std::enable_shared_from_this<JsEngine>
   {
     friend class JsValue;
     friend class JsContext;
 
     struct JsWeakValuesList
     {
       ~JsWeakValuesList();
       std::vector<v8::Global<v8::Value>> values;
     };
     typedef std::list<JsWeakValuesList> JsWeakValuesLists;
   public:
     /**
      * Event callback function.
      */
     typedef std::function<void(JsValueList&& params)> EventCallback;
 
     /**
      * Maps events to callback functions.
      */
     typedef std::map<std::string, EventCallback> EventMap;
 
     /**
      * An opaque structure representing ID of stored JsValueList.
-     * 
      */
     class JsWeakValuesID
     {
       friend class JsEngine;
       JsWeakValuesLists::const_iterator iterator;
     };
 
     /**
      * Creates a new JavaScript engine instance.
+     *
      * @param appInfo Information about the app.
-     * @param timer Implementation of timer.
-     * @param fileSystem Implementation of filesystem.
-     * @param webRequest Implementation of web request.
+     * @param platform AdblockPlus platform providing with necessary
+     *        dependencies.
+     * @param isolate A provider of v8::Isolate, if the value is nullptr then
+     *        a default implementation is used.
      * @return New `JsEngine` instance.
      */
-    static JsEnginePtr New(const AppInfo& appInfo = AppInfo(),
-      TimerPtr timer = CreateDefaultTimer(),
-      FileSystemPtr fileSystem = CreateDefaultFileSystem(),
-      WebRequestPtr webRequest = CreateDefaultWebRequest());
-
+    static JsEnginePtr New(const AppInfo& appInfo, Platform& platform, std::unique_ptr<IV8IsolateProvider> isolate = nullptr);
     /**
      * Registers the callback function for an event.
      * @param eventName Event name. Note that this can be any string - it's a
      *        general purpose event handling mechanism.
      * @param callback Event callback function.
      */
     void SetEventCallback(const std::string& eventName, const EventCallback& callback);
 
     /**
      * Removes the callback function for an event.
@@ skipping 109 matching lines @@
 
     /**
      * Converts v8 arguments to `JsValue` objects.
      * @param arguments `v8::FunctionCallbackInfo` object containing the arguments to
      *        convert.
      * @return List of arguments converted to `const JsValue` objects.
      */
     JsValueList ConvertArguments(const v8::FunctionCallbackInfo<v8::Value>& arguments);
 
     /**
-     * Private functionality.
-     * @return The asynchronous IFileSystem implementation.
-     */
-    FileSystemPtr GetAsyncFileSystem() const;
-
-    /**
-     * Sets the synchronous `FileSystem` implementation used for all
-     * file I/O. Setting this is optional, the engine will use the
-     * implementation created by `CreateDefaultFileSystem()` by
-     * default, which might be sufficient.
-     * @param The `FileSystem` instance to use.
-     */
-    void SetFileSystem(const FileSystemSyncPtr& val);
-
-    /**
-     * Sets the `WebRequest` implementation used for XMLHttpRequests.
-     * Setting this is optional, the engine will use a `DefaultWebRequest`
-     * instance by default, which might be sufficient.
-     * @param The `WebRequest` instance to use.
-     */
-    void SetWebRequest(const WebRequestSharedPtr& val);
-
-    /**
-     * @see `SetLogSystem()`.
-     */
-    LogSystemPtr GetLogSystem() const;
-
-    /**
-     * Sets the `LogSystem` implementation used for logging (e.g. to handle
-     * `console.log()` calls from JavaScript).
-     * Setting this is optional, the engine will use a `DefaultLogSystem`
-     * instance by default, which might be sufficient.
-     * @param The `LogSystem` instance to use.
-     */
-    void SetLogSystem(const LogSystemPtr& val);
-
-    /**
      * Sets a global property that can be accessed by all the scripts.
      * @param name Name of the property to set.
      * @param value Value of the property to set.
      */
     void SetGlobalProperty(const std::string& name, const AdblockPlus::JsValue& value);
 
     /**
      * Returns a pointer to associated v8::Isolate.
      */
     v8::Isolate* GetIsolate()
     {
-      return isolate.Get();
+      return isolate->Get();
     }
 
     /**
      * Notifies JS engine about critically low memory what should cause a
      * garbage collection.
      */
     void NotifyLowMemory();
+
+    /**
+     * Private functionality.
+     */
+    Platform& GetPlatform()
+    {
+      return platform;
+    }
   private:
     void CallTimerTask(const JsWeakValuesID& timerParamsID);
 
-    explicit JsEngine(TimerPtr timer, FileSystemPtr fileSystem, WebRequestPtr webRequest);
+    explicit JsEngine(Platform& platform, std::unique_ptr<IV8IsolateProvider> isolate);
 
     JsValue GetGlobalObject();
 
+    Platform& platform;
     /// Isolate must be disposed only after disposing of all objects which are
     /// using it.
-    ScopedV8Isolate isolate;
+    std::unique_ptr<IV8IsolateProvider> isolate;
 
-    FileSystemPtr fileSystem;
-    LogSystemPtr logSystem;
     std::unique_ptr<v8::Global<v8::Context>> context;
     EventMap eventCallbacks;
     std::mutex eventCallbacksMutex;
     JsWeakValuesLists jsWeakValuesLists;
     std::mutex jsWeakValuesListsMutex;
-    TimerPtr timer;
-    WebRequestPtr webRequest;
-    WebRequestSharedPtr webRequestLegacy;
   };
 }
 
 #endif