stub_flutter_glfw_api.h

Go to the documentation of this file.

// Copyright 2013 The Flutter Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
 
#ifndef FLUTTER_SHELL_PLATFORM_GLFW_CLIENT_WRAPPER_TESTING_STUB_FLUTTER_GLFW_API_H_
#define FLUTTER_SHELL_PLATFORM_GLFW_CLIENT_WRAPPER_TESTING_STUB_FLUTTER_GLFW_API_H_
 
#include <memory>
 
#include "flutter/shell/platform/glfw/public/flutter_glfw.h"
 
namespace flutter {
namespace testing {
 
// Base class for a object that provides test implementations of the APIs in
// the headers in platform/glfw/public/.
 
// Linking this class into a test binary will provide dummy forwarding
// implementations of that C API, so that the wrapper can be tested separately
// from the actual library.
class StubFlutterGlfwApi {
 public:
  // Sets |stub| as the instance to which calls to the Flutter library C APIs
  // will be forwarded.
  static void SetTestStub(StubFlutterGlfwApi* stub);
 
  // Returns the current stub, as last set by SetTestFlutterStub.
  static StubFlutterGlfwApi* GetTestStub();
 
  virtual ~StubFlutterGlfwApi() {}
 
  // Called for FlutterDesktopInit.
  virtual bool Init() { return true; }
 
  // Called for FlutterDesktopTerminate.
  virtual void Terminate() {}
 
  // Called for FlutterDesktopCreateWindow.
  virtual FlutterDesktopWindowControllerRef CreateWindow(
      const FlutterDesktopWindowProperties& window_properties,
      const FlutterDesktopEngineProperties& engine_properties) {
    return nullptr;
  }
 
  // Called for FlutterDesktopDestroyWindow
  virtual void DestroyWindow() {}
 
  // Called for FlutterDesktopWindowSetHoverEnabled.
  virtual void SetHoverEnabled(bool enabled) {}
 
  // Called for FlutterDesktopWindowSetTitle.
  virtual void SetWindowTitle(const char* title) {}
 
  //  Called for FlutterDesktopWindowSetIcon.
  virtual void SetWindowIcon(uint8_t* pixel_data, int width, int height) {}
 
  // Called for FlutterDesktopWindowGetFrame.
  virtual void GetWindowFrame(int* x, int* y, int* width, int* height) {
    x = y = width = height = 0;
  }
 
  // Called for FlutterDesktopWindowGetFrame.
  virtual void SetWindowFrame(int x, int y, int width, int height) {}
 
  // Called for FlutterDesktopWindowGetScaleFactor.
  virtual double GetWindowScaleFactor() { return 1.0; }
 
  // Called for FlutterDesktopWindowSetPixelRatioOverride.
  virtual void SetPixelRatioOverride(double pixel_ratio) {}
 
  // Called for FlutterDesktopWindowSetSizeLimits.
  virtual void SetSizeLimits(FlutterDesktopSize minimum_size,
                             FlutterDesktopSize maximum_size) {}
 
  // Called for FlutterDesktopRunWindowEventLoopWithTimeout.
  virtual bool RunWindowEventLoopWithTimeout(uint32_t millisecond_timeout) {
    return true;
  }
 
  // Called for FlutterDesktopRunEngine.
  virtual FlutterDesktopEngineRef RunEngine(
      const FlutterDesktopEngineProperties& properties) {
    return nullptr;
  }
 
  // Called for FlutterDesktopRunEngineEventLoopWithTimeout.
  virtual void RunEngineEventLoopWithTimeout(uint32_t millisecond_timeout) {}
 
  // Called for FlutterDesktopShutDownEngine.
  virtual bool ShutDownEngine() { return true; }
 
  // Called for FlutterDesktopPluginRegistrarEnableInputBlocking.
  virtual void PluginRegistrarEnableInputBlocking(const char* channel) {}
};
 
// A test helper that owns a stub implementation, making it the test stub for
// the lifetime of the object, then restoring the previous value.
class ScopedStubFlutterGlfwApi {
 public:
  // Calls SetTestFlutterStub with |stub|.
  explicit ScopedStubFlutterGlfwApi(std::unique_ptr<StubFlutterGlfwApi> stub);
 
  // Restores the previous test stub.
  ~ScopedStubFlutterGlfwApi();
 
  StubFlutterGlfwApi* stub() { return stub_.get(); }
 
 private:
  std::unique_ptr<StubFlutterGlfwApi> stub_;
  // The previous stub.
  StubFlutterGlfwApi* previous_stub_;
};
 
}  // namespace testing
}  // namespace flutter
 
#endif  // FLUTTER_SHELL_PLATFORM_GLFW_CLIENT_WRAPPER_TESTING_STUB_FLUTTER_GLFW_API_H_