GlobalKeyboardHook.h

Go to the documentation of this file.

/*
 * Copyright (c) 2019 pongasoft
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 *
 * @author Yan Pujante
 */
#pragma once

#include <vstgui4/vstgui/lib/cframe.h>
#include <pongasoft/VST/GUI/Types.h>
#include "SelfContainedViewListener.h"

namespace pongasoft::VST::GUI::Views {

using namespace VSTGUI;

class GlobalKeyboardHook : public SelfContainedViewListener, protected IKeyboardHook
{
public:
  std::shared_ptr<GlobalKeyboardHook> onKeyDown(KeyboardEventCallback iOnKeyDownCallback)
  {
    fOnKeyDownCallback = std::move(iOnKeyDownCallback);
    return std::dynamic_pointer_cast<GlobalKeyboardHook>(shared_from_this());
  }

  std::shared_ptr<GlobalKeyboardHook> onKeyUp(KeyboardEventCallback iOnKeyUpCallback)
  {
    fOnKeyUpCallback = std::move(iOnKeyUpCallback);
    return std::dynamic_pointer_cast<GlobalKeyboardHook>(shared_from_this());
  }

  static std::shared_ptr<GlobalKeyboardHook> create(CView *iView)
  {
    return SelfContainedViewListener::create<GlobalKeyboardHook>(iView);
  }

  std::shared_ptr<SelfContainedViewListener> registerView(CView *iView) override
  {
    auto res = SelfContainedViewListener::registerView(iView);
    maybeRegisterKeyboardHook();
    return res;
  }

protected:
  void viewAttached(CView *iView) override
  {
    DCHECK_F(iView == fView);
    maybeRegisterKeyboardHook();
  }

  void viewRemoved(CView *iView) override
  {
    DCHECK_F(iView == fView);
    maybeUnregisterKeyboardHook();
  }

public:
  void unregister() override
  {
    maybeUnregisterKeyboardHook();
    SelfContainedViewListener::unregister();
  }

  GlobalKeyboardHook() = default;

protected:
  // maybeRegisterKeyboardHook
  void maybeRegisterKeyboardHook()
  {
    if(!fFrame)
    {
      fFrame = fView->getFrame();
      if(fFrame)
      {
        fFrame->registerKeyboardHook(this);
      }
    }
  }

  // maybeUnregisterKeyboardHook
  void maybeUnregisterKeyboardHook()
  {
    if(fFrame)
    {
      fFrame->unregisterKeyboardHook(this);
      fFrame = nullptr;
    }
  }

  int32_t onKeyDown(const VstKeyCode &iCode, CFrame *frame) override
  {
    return fOnKeyDownCallback ? fOnKeyDownCallback(iCode): CKeyboardEventResult::kKeyboardEventNotHandled;
  }

  int32_t onKeyUp(const VstKeyCode &iCode, CFrame *frame) override
  {
    return fOnKeyUpCallback ? fOnKeyUpCallback(iCode): CKeyboardEventResult::kKeyboardEventNotHandled;
  }

protected:
  CFrame *fFrame{};
  KeyboardEventCallback fOnKeyDownCallback{};
  KeyboardEventCallback fOnKeyUpCallback{};
};

inline std::shared_ptr<GlobalKeyboardHook> registerGlobalKeyboardHook(CView *iView) { return GlobalKeyboardHook::create(iView); }

}