IPlugWebView.h

 /*
 ==============================================================================
 
  MIT License
 
  iPlug2 WebView Library
  Copyright (c) 2024 Oliver Larkin
 
  Permission is hereby granted, free of charge, to any person obtaining a copy
  of this software and associated documentation files (the "Software"), to deal
  in the Software without restriction, including without limitation the rights
  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  copies of the Software, and to permit persons to whom the Software is
  furnished to do so, subject to the following conditions:
 
  The above copyright notice and this permission notice shall be included in all
  copies or substantial portions of the Software.
 
  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  SOFTWARE.
 
 ==============================================================================
*/
 
#pragma once
 
#include "IPlugPlatform.h"
#include "IPlugLogger.h"
#include "wdlstring.h"
#include <functional>
#include <memory>
 
BEGIN_IPLUG_NAMESPACE
 
class IWebViewImpl;
 
class IWebView
{
public:
  using completionHandlerFunc = std::function<void(const char* result)>;
 
  IWebView(bool opaque = true, bool enableDevTools = false, const char* customUrlScheme = "");
  virtual ~IWebView();
  
  void* OpenWebView(void* pParent, float x, float y, float w, float h, float scale = 1.0f);
  void CloseWebView();
  void HideWebView(bool hide);
  
  void LoadHTML(const char* html);
  
  void LoadURL(const char* url);
  
  void LoadFile(const char* fileName, const char* bundleID = "");
  
  void ReloadPageContent();
  
  void EvaluateJavaScript(const char* scriptStr, completionHandlerFunc func = nullptr);
  
  void EnableScroll(bool enable);
  
  void EnableInteraction(bool enable);
  
  void SetWebViewBounds(float x, float y, float w, float h, float scale = 1.);
  
  void GetWebRoot(WDL_String& path) const;
  
  const char* GetCustomUrlScheme() const { return mCustomUrlScheme.Get(); }
  
  bool GetEnableDevTools() const { return mEnableDevTools; }
 
  bool IsOpaque() const { return mOpaque; }
 
  void SetCustomUrlScheme(const char* customUrlScheme) { mCustomUrlScheme.Set(customUrlScheme); }
  
  void SetEnableDevTools(bool enable) { mEnableDevTools = enable; }
  
#pragma mark -
  
  virtual void OnWebViewReady() {}
  
  virtual void OnWebContentLoaded() {}
  
  virtual void OnMessageFromWebView(const char* json) {}
  
  virtual bool OnCanNavigateToURL(const char* url) { return true; }
  
  virtual bool OnCanDownloadMIMEType(const char* mimeType) { return false; }
  
  virtual void OnGetLocalDownloadPathForFile(const char* fileName, WDL_String& localPath);
 
  virtual void OnDownloadedFile(const char* path) { DBGMSG("Downloaded %s\n", path);}
  
  virtual void OnFailedToDownloadFile(const char* path) { DBGMSG("Downloading %s failed\n", path); }
 
  virtual void OnReceivedData(size_t numBytesReceived, size_t totalNumBytes) {}
 
private:
  std::unique_ptr<IWebViewImpl> mpImpl;
  bool mOpaque;
  bool mEnableDevTools = false;
  WDL_String mCustomUrlScheme;
};
 
END_IPLUG_NAMESPACE