ReaperExtBase.h

Go to the documentation of this file.

/*
 ==============================================================================
 
 This file is part of the iPlug 2 library. Copyright (C) the iPlug 2 developers. 
 
 See LICENSE.txt for  more info.
 
 ==============================================================================
*/
 
#pragma once
 
#include "IPlugTimer.h"
#include "IPlugDelegate_select.h"
#include "wdlstring.h"
 
struct reaper_plugin_info_t;
struct project_config_extension_t;
class ProjectStateContext;
 
BEGIN_IPLUG_NAMESPACE
 
#pragma pack(push, 4)
struct ReaperExtDockState
{
  RECT r;          // Window rect when floating
  int state;       // Bit 0 = visible, Bit 1 = docked
  int whichdock;   // Docker index when docked
};
#pragma pack(pop)
 
class ReaperExtBase : public EDITOR_DELEGATE_CLASS
{
public:
  ReaperExtBase(reaper_plugin_info_t* pRec);
  
  virtual ~ReaperExtBase();
 
  //IEditorDelegate
  void BeginInformHostOfParamChangeFromUI(int paramIdx) override {}; // NO-OP
  
  void EndInformHostOfParamChangeFromUI(int paramIdx) override {}; // NO-OP
  
  bool EditorResizeFromUI(int viewWidth, int viewHeight, bool needsPlatformResize) override;
 
  virtual void OnIdle() {}; // NO-OP
 
  virtual void OnActionRun(int commandId, int flag) {}; // NO-OP
 
  virtual void SaveProjectState(ProjectStateContext* ctx) {}; // NO-OP
 
  virtual bool LoadProjectStateLine(const char* line) { return false; };
 
  virtual void OnBeginLoadProjectState(bool isUndo) {}; // NO-OP
 
  void RegisterAction(const char* actionName, std::function<void()> func, bool addMenuItem = false, int* pToggle = nullptr, const char* contextMenuId = nullptr, const char* menuLabel = nullptr/*, IKeyPress keyCmd*/);
 
  void ShowHideMainWindow();
 
  void ToggleDocking();
 
  bool IsDocked() const { return (mDockState.state & 2) == 2; }
 
  int* GetWindowTogglePtr() { return &mWindowToggle; }
 
  int* GetDockTogglePtr() { return &mDockToggle; }
 
  void SetDockId(const char* id) { mDockId.Set(id); }
 
  void SetMenuName(const char* name) { mMenuName.Set(name); }
 
public:
  // Reaper calls back to this when it wants to execute an action registered by the extension plugin
  static bool HookCommandProc(int command, int flag);
  
  // Reaper calls back to this when it wants to know an actions toggle state
  static int ToggleActionCallback(int command);
 
  // Reaper calls back to this when building a customizable menu, so we can add
  // registered actions to context menus (e.g. the media item right-click menu)
  static void MenuHook(const char* menuidstr, void* menu, int flag);
 
  // Reaper calls back to this after every main-section action ("hookpostcommand")
  static void PostCommandProc(int command, int flag);
 
  // "projectconfig" callbacks - forwarded to the OnBeginLoadProjectState /
  // LoadProjectStateLine / SaveProjectState virtuals on the running instance
  static void BeginLoadProjectState(bool isUndo, project_config_extension_t* reg);
  static bool ProcessExtensionLine(const char* line, ProjectStateContext* ctx, bool isUndo, project_config_extension_t* reg);
  static void SaveExtensionConfig(ProjectStateContext* ctx, bool isUndo, project_config_extension_t* reg);
 
private:
  static WDL_DLGRET MainDlgProc(HWND hwndDlg, UINT uMsg, WPARAM wParam, LPARAM lParam);
  
  void OnTimer(Timer& t);
  void CreateMainWindow();
  void DestroyMainWindow();
  void SaveDockState();
  void LoadDockState();
  void EnsureStateLoaded();
  void UpdateToggleStates();
 
  reaper_plugin_info_t* mRec = nullptr;
  std::unique_ptr<Timer> mTimer;
  ReaperExtDockState mDockState = {};
  WDL_FastString mDockId;
  WDL_FastString mMenuName;
  bool mSaveStateOnDestroy = true;
  bool mStateLoaded = false;
  int mWindowToggle = 0;
  int mDockToggle = 0;
};
 
END_IPLUG_NAMESPACE