IGraphicsWin.h

/*
 ==============================================================================
 
 This file is part of the iPlug 2 library. Copyright (C) the iPlug 2 developers.
 
 See LICENSE.txt for  more info.
 
 ==============================================================================
*/
 
#pragma once
 
#include <windows.h>
#include <windowsx.h>
#include <winuser.h>
 
#include "IGraphics_select.h"
#include "IGraphicsWinFonts.h"
 
BEGIN_IPLUG_NAMESPACE
BEGIN_IGRAPHICS_NAMESPACE
 
class IGraphicsWin final : public IGRAPHICS_DRAW_CLASS
{
  using InstalledFont = InstalledWinFont;
  using Font = WinFont;
  
public:
  IGraphicsWin(IGEditorDelegate& dlg, int w, int h, int fps, float scale);
  ~IGraphicsWin();
 
  void SetWinModuleHandle(void* pInstance) override { mHInstance = (HINSTANCE) pInstance; }
  void* GetWinModuleHandle() override { return mHInstance; }
 
  void ForceEndUserEdit() override;
  float GetPlatformWindowScale() const override { return GetScreenScale(); }
 
  void PlatformResize(bool parentHasResized) override;
 
  void CheckTabletInput(UINT msg);
  void DestroyEditWindow();
    
  void HideMouseCursor(bool hide, bool lock) override;
  void MoveMouseCursor(float x, float y) override;
  ECursor SetMouseCursor(ECursor cursorType) override;
  
  void GetMouseLocation(float& x, float&y) const override;
 
  EMsgBoxResult ShowMessageBox(const char* str, const char* title, EMsgBoxType type, IMsgBoxCompletionHandlerFunc completionHandler) override;
 
  void* OpenWindow(void* pParent) override;
  void CloseWindow() override;
  bool WindowIsOpen() override { return (mPlugWnd); }
 
  void UpdateTooltips() override {}
 
  bool RevealPathInExplorerOrFinder(WDL_String& path, bool select) override;
  void PromptForFile(WDL_String& fileName, WDL_String& path, EFileAction action, const char* ext, IFileDialogCompletionHandlerFunc completionHandler) override;
  void PromptForDirectory(WDL_String& dir, IFileDialogCompletionHandlerFunc completionHandler) override;
  bool PromptForColor(IColor& color, const char* str, IColorPickerHandlerFunc func) override;
 
  IPopupMenu* GetItemMenu(long idx, long& idxInMenu, long& offsetIdx, IPopupMenu& baseMenu);
  HMENU CreateMenu(IPopupMenu& menu, long* pOffsetIdx);
 
  bool OpenURL(const char* url, const char* msgWindowTitle, const char* confirmMsg, const char* errMsgOnFailure) override;
 
  void* GetWindow() override { return mPlugWnd; }
 
  const char* GetPlatformAPIStr() override { return "win32"; };
 
  bool GetTextFromClipboard(WDL_String& str) override;
  bool SetTextInClipboard(const char* str) override;
  bool SetFilePathInClipboard(const char* path) override;
 
  bool InitiateExternalFileDragDrop(const char* path, const IRECT& iconBounds) override;
 
  bool PlatformSupportsMultiTouch() const override;
 
  static LRESULT CALLBACK WndProc(HWND hWnd, UINT msg, WPARAM wParam, LPARAM lParam);
  static LRESULT CALLBACK ParamEditProc(HWND hWnd, UINT msg, WPARAM wParam, LPARAM lParam);
  static BOOL CALLBACK FindMainWindow(HWND hWnd, LPARAM lParam);
 
  DWORD OnVBlankRun();
 
protected:
  IPopupMenu* CreatePlatformPopupMenu(IPopupMenu& menu, const IRECT bounds, bool& isAsync) override;
  void CreatePlatformTextEntry(int paramIdx, const IText& text, const IRECT& bounds, int length, const char* str) override;
 
  void SetTooltip(const char* tooltip);
  void ShowTooltip();
  void HideTooltip();
    
  HWND GetMainWnd();
  IRECT GetWindowRECT();
 
private:
 
  void OnDisplayTimer(int vBlankCount = 0);
 
  enum EParamEditMsg
  {
    kNone,
    kEditing,
    kUpdate,
    kCancel,
    kCommit
  };
 
  PlatformFontPtr LoadPlatformFont(const char* fontID, const char* fileNameOrResID) override;
  PlatformFontPtr LoadPlatformFont(const char* fontID, const char* fontName, ETextStyle style) override;
  PlatformFontPtr LoadPlatformFont(const char* fontID, void* pData, int dataSize) override;
  void CachePlatformFont(const char* fontID, const PlatformFontPtr& font) override;
 
  inline IMouseInfo GetMouseInfo(LPARAM lParam, WPARAM wParam);
  bool MouseCursorIsLocked();
 
  void ActivateGLContext() override;
  void DeactivateGLContext() override;
  
#ifdef IGRAPHICS_GL
  void CreateGLContext(); // OpenGL context management - TODO: RAII instead ?
  void DestroyGLContext();
  HGLRC mHGLRC = nullptr;
  HGLRC mStartHGLRC = nullptr;
  HDC mStartHDC = nullptr;
#endif
 
  HINSTANCE mHInstance = nullptr;
  HWND mPlugWnd = nullptr;
  HWND mParamEditWnd = nullptr;
  HWND mTooltipWnd = nullptr;
  HWND mParentWnd = nullptr;
  HWND mMainWnd = nullptr;
  WNDPROC mDefEditProc = nullptr;
  HFONT mEditFont = nullptr;
  DWORD mPID = 0;
 
  void StartVBlankThread(HWND hWnd);
  void StopVBlankThread();
  void VBlankNotify();
    
  HWND mVBlankWindow = 0; // Window to post messages to for every vsync
  volatile bool mVBlankShutdown = false; // Flag to indiciate that the vsync thread should shutdown
  HANDLE mVBlankThread = INVALID_HANDLE_VALUE; //ID of thread.
  volatile DWORD mVBlankCount = 0; // running count of vblank events since the start of the window.
  int mVBlankSkipUntil = 0; // support for skipping vblank notification if the last callback took  too long.  This helps keep the message pump clear in the case of overload.
  bool mVSYNCEnabled = false;
  
  const IParam* mEditParam = nullptr;
  IText mEditText;
  IRECT mEditRECT;
 
  EParamEditMsg mParamEditMsg = kNone;
  bool mShowingTooltip = false;
  float mHiddenCursorX = 0.f;
  float mHiddenCursorY = 0.f;
  int mTooltipIdx = -1;
 
  WDL_String mMainWndClassName;
    
  static StaticStorage<InstalledFont> sPlatformFontCache;
  static StaticStorage<HFontHolder> sHFontCache;
 
  std::unordered_map<ITouchID, IMouseInfo> mDeltaCapture; // associative array of touch id pointers to IMouseInfo structs, so that we can get deltas
};
 
END_IGRAPHICS_NAMESPACE
END_IPLUG_NAMESPACE