/* * DISTRHO Plugin Framework (DPF) * Copyright (C) 2012-2021 Filipe Coelho * * Permission to use, copy, modify, and/or distribute this software for any purpose with * or without fee is hereby granted, provided that the above copyright notice and this * permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD * TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN * NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER * IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ #ifndef DGL_WINDOW_PRIVATE_DATA_HPP_INCLUDED #define DGL_WINDOW_PRIVATE_DATA_HPP_INCLUDED #include "../Window.hpp" #include "../Widget.hpp" #include "ApplicationPrivateData.hpp" #include "pugl.hpp" #include START_NAMESPACE_DGL class TopLevelWidget; // ----------------------------------------------------------------------- struct Window::PrivateData : IdleCallback { /** Reference to the DGL Application class this (private data) window associates with. */ Application& app; /** Direct access to the DGL Application private data where we registers ourselves in. */ Application::PrivateData* const appData; /** Pointer to the the DGL Window class that this private data belongs to. */ Window* const self; /** Pugl view instance. */ PuglView* const view; /** Pugl view instance of the transient parent window. */ PuglView* const transientParentView; /** Reserved space for graphics context. */ mutable uint8_t graphicsContext[sizeof(void*)]; /** The top-level widgets associated with this Window. */ std::list topLevelWidgets; /** Whether this Window is closed (not visible or counted in the Application it is tied to). Defaults to true unless embed (embed windows are never closed). */ bool isClosed; /** Whether this Window is currently visible/mapped. Defaults to false. */ bool isVisible; /** Whether this Window is embed into another (usually not DGL-controlled) Window. */ const bool isEmbed; /** Scale factor to report to widgets on request, purely informational. */ double scaleFactor; /** Automatic scaling to apply on widgets, implemented internally. */ bool autoScaling; double autoScaleFactor; /** Pugl geometry constraints access. */ uint minWidth, minHeight; bool keepAspectRatio; #ifdef DISTRHO_OS_WINDOWS /** Selected file for openFileBrowser on windows, stored for fake async operation. */ const char* win32SelectedFile; #endif /** Modal window setup. */ struct Modal { PrivateData* parent; // parent of this window (so we can become modal) PrivateData* child; // child window to give focus to when modal mode is enabled bool enabled; // wherever modal mode is enabled (only possible if parent != null) /** Constructor for a non-modal window. */ Modal() noexcept : parent(nullptr), child(nullptr), enabled(false) {} /** Constructor for a modal window (with a parent). */ Modal(PrivateData* const p) noexcept : parent(p), child(nullptr), enabled(false) {} /** Destructor. */ ~Modal() noexcept { DISTRHO_SAFE_ASSERT(! enabled); } DISTRHO_DECLARE_NON_COPYABLE(Modal) DISTRHO_PREVENT_HEAP_ALLOCATION } modal; /** Constructor for a regular, standalone window. */ explicit PrivateData(Application& app, Window* self); /** Constructor for a modal window. */ explicit PrivateData(Application& app, Window* self, PrivateData* ppData); /** Constructor for an embed Window, with a few extra hints from the host side. */ explicit PrivateData(Application& app, Window* self, uintptr_t parentWindowHandle, double scaling, bool resizable); /** Constructor for an embed Window, with a few extra hints from the host side. */ explicit PrivateData(Application& app, Window* self, uintptr_t parentWindowHandle, uint width, uint height, double scaling, bool resizable); /** Destructor. */ ~PrivateData() override; /** Helper initialization function called at the end of all this class constructors. */ void initPre(uint width, uint height, bool resizable); /** Helper initialization function called on the Window constructor after we are done. */ void initPost(); /** Hide window and notify application of a window close event. * Does nothing if window is embed (that is, not standalone). * The application event-loop will stop when all windows have been closed. * * @note It is possible to hide the window while not stopping the event-loop. * A closed window is always hidden, but the reverse is not always true. */ void close(); void show(); void hide(); void focus(); void setResizable(bool resizable); const GraphicsContext& getGraphicsContext() const noexcept; // idle callback stuff void idleCallback() override; bool addIdleCallback(IdleCallback* callback, uint timerFrequencyInMs); bool removeIdleCallback(IdleCallback* callback); #ifndef DGL_FILE_BROWSER_DISABLED // file handling bool openFileBrowser(const Window::FileBrowserOptions& options); # ifdef DISTRHO_OS_MAC static void openPanelCallback(PuglView* view, const char* path); # endif #endif // modal handling void startModal(); void stopModal(); void runAsModal(bool blockWait); // pugl events void onPuglConfigure(double width, double height); void onPuglExpose(); void onPuglClose(); void onPuglFocus(bool focus, CrossingMode mode); void onPuglKey(const Widget::KeyboardEvent& ev); void onPuglSpecial(const Widget::SpecialEvent& ev); void onPuglText(const Widget::CharacterInputEvent& ev); void onPuglMouse(const Widget::MouseEvent& ev); void onPuglMotion(const Widget::MotionEvent& ev); void onPuglScroll(const Widget::ScrollEvent& ev); // Pugl event handling entry point static PuglStatus puglEventCallback(PuglView* view, const PuglEvent* event); DISTRHO_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR(PrivateData) }; // ----------------------------------------------------------------------- END_NAMESPACE_DGL #if 0 // #if defined(DISTRHO_OS_HAIKU) // BApplication* bApplication; // BView* bView; // BWindow* bWindow; #if defined(DISTRHO_OS_MAC) // NSView* mView; // id mWindow; // id mParentWindow; # ifndef DGL_FILE_BROWSER_DISABLED NSOpenPanel* fOpenFilePanel; id fFilePanelDelegate; # endif #elif defined(DISTRHO_OS_WINDOWS) // HWND hwnd; // HWND hwndParent; # ifndef DGL_FILE_BROWSER_DISABLED String fSelectedFile; # endif #endif #endif #if 0 // ----------------------------------------------------------------------- // Window Private struct Window::PrivateData { // ------------------------------------------------------------------- bool handlePluginSpecial(const bool press, const Key key) { DBGp("PUGL: handlePluginSpecial : %i %i\n", press, key); if (fModal.childFocus != nullptr) { fModal.childFocus->focus(); return true; } int mods = 0x0; switch (key) { case kKeyShift: mods |= kModifierShift; break; case kKeyControl: mods |= kModifierControl; break; case kKeyAlt: mods |= kModifierAlt; break; default: break; } if (mods != 0x0) { if (press) fView->mods |= mods; else fView->mods &= ~(mods); } Widget::SpecialEvent ev; ev.press = press; ev.key = key; ev.mod = static_cast(fView->mods); ev.time = 0; FOR_EACH_WIDGET_INV(rit) { Widget* const widget(*rit); if (widget->isVisible() && widget->onSpecial(ev)) return true; } return false; } #if defined(DISTRHO_OS_MAC) && !defined(DGL_FILE_BROWSER_DISABLED) static void openPanelDidEnd(NSOpenPanel* panel, int returnCode, void *userData) { PrivateData* pData = (PrivateData*)userData; if (returnCode == NSOKButton) { NSArray* urls = [panel URLs]; NSURL* fileUrl = nullptr; for (NSUInteger i = 0, n = [urls count]; i < n && !fileUrl; ++i) { NSURL* url = (NSURL*)[urls objectAtIndex:i]; if ([url isFileURL]) fileUrl = url; } if (fileUrl) { PuglView* view = pData->fView; if (view->fileSelectedFunc) { const char* fileName = [fileUrl.path UTF8String]; view->fileSelectedFunc(view, fileName); } } } [pData->fOpenFilePanel release]; pData->fOpenFilePanel = nullptr; } #endif // ------------------------------------------------------------------- DISTRHO_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR(PrivateData) }; #endif #endif // DGL_WINDOW_PRIVATE_DATA_HPP_INCLUDED