diff options
Diffstat (limited to 'vcl/osx/salobj.cxx')
| -rw-r--r-- | vcl/osx/salobj.cxx | 444 |
1 files changed, 444 insertions, 0 deletions
diff --git a/vcl/osx/salobj.cxx b/vcl/osx/salobj.cxx new file mode 100644 index 000000000..6cf114f20 --- /dev/null +++ b/vcl/osx/salobj.cxx @@ -0,0 +1,444 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you 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 . + */ + +#include <string.h> +#include <tools/debug.hxx> +#include <vcl/opengl/OpenGLContext.hxx> +#include <vcl/opengl/OpenGLHelper.hxx> +#include <opengl/zone.hxx> + +#include <osx/saldata.hxx> +#include <osx/salframe.h> +#include <osx/salinst.h> +#include <osx/salobj.h> +#include <osx/runinmain.hxx> + +#include <AppKit/NSOpenGLView.h> + +AquaSalObject::AquaSalObject( AquaSalFrame* pFrame, SystemWindowData const * pWindowData ) : + mpFrame( pFrame ), + mnClipX( -1 ), + mnClipY( -1 ), + mnClipWidth( -1 ), + mnClipHeight( -1 ), + mbClip( false ), + mnX( 0 ), + mnY( 0 ), + mnWidth( 20 ), + mnHeight( 20 ) +{ + maSysData.mpNSView = nullptr; + maSysData.mbOpenGL = false; + + NSRect aInitFrame = { NSZeroPoint, { 20, 20 } }; + mpClipView = [[NSClipView alloc] initWithFrame: aInitFrame ]; + if( mpClipView ) + { + [mpFrame->getNSView() addSubview: mpClipView]; + [mpClipView setHidden: YES]; + } + if (pWindowData && pWindowData->bOpenGL) + { + maSysData.mbOpenGL = true; +SAL_WNODEPRECATED_DECLARATIONS_PUSH + // "'NSOpenGLPixelFormat' is deprecated: first deprecated in macOS 10.14 - Please use + // Metal or MetalKit." + NSOpenGLPixelFormat* pixFormat = nullptr; +SAL_WNODEPRECATED_DECLARATIONS_POP + + if (pWindowData->bLegacy) + { +SAL_WNODEPRECATED_DECLARATIONS_PUSH + // "'NSOpenGLPixelFormatAttribute' is deprecated: first deprecated in macOS 10.14" + NSOpenGLPixelFormatAttribute const aAttributes[] = +SAL_WNODEPRECATED_DECLARATIONS_POP + { +SAL_WNODEPRECATED_DECLARATIONS_PUSH + // "'NSOpenGLPFADoubleBuffer' is deprecated: first deprecated in macOS 10.14", + // "'NSOpenGLPFAAlphaSize' is deprecated: first deprecated in macOS 10.14", + // "'NSOpenGLPFAColorSize' is deprecated: first deprecated in macOS 10.14", + // "'NSOpenGLPFADepthSize' is deprecated: first deprecated in macOS 10.14", + // "'NSOpenGLPFAMultisample' is deprecated: first deprecated in macOS 10.14", + // "'NSOpenGLPFASampleBuffers' is deprecated: first deprecated in macOS 10.14", + // "'NSOpenGLPixelFormatAttribute' is deprecated: first deprecated in macOS + // 10.14", + // "'NSOpenGLPFASamples' is deprecated: first deprecated in macOS 10.14" + NSOpenGLPFADoubleBuffer, + NSOpenGLPFAAlphaSize, 8, + NSOpenGLPFAColorSize, 24, + NSOpenGLPFADepthSize, 24, + NSOpenGLPFAMultisample, + NSOpenGLPFASampleBuffers, NSOpenGLPixelFormatAttribute(1), + NSOpenGLPFASamples, NSOpenGLPixelFormatAttribute(4), +SAL_WNODEPRECATED_DECLARATIONS_POP + 0 + }; +SAL_WNODEPRECATED_DECLARATIONS_PUSH + // "'NSOpenGLPixelFormat' is deprecated: first deprecated in macOS 10.14 - Please + // use Metal or MetalKit." + pixFormat = [[NSOpenGLPixelFormat alloc] initWithAttributes:aAttributes]; +SAL_WNODEPRECATED_DECLARATIONS_POP + } + else + { +SAL_WNODEPRECATED_DECLARATIONS_PUSH + // "'NSOpenGLPixelFormatAttribute' is deprecated: first deprecated in macOS 10.14" + NSOpenGLPixelFormatAttribute const aAttributes[] = +SAL_WNODEPRECATED_DECLARATIONS_POP + { +SAL_WNODEPRECATED_DECLARATIONS_PUSH + // "'NSOpenGLPFAOpenGLProfile' is deprecated: first deprecated in macOS 10.14", + // "'NSOpenGLProfileVersion3_2Core' is deprecated: first deprecated in macOS + // 10.14", + // "'NSOpenGLPFADoubleBuffer' is deprecated: first deprecated in macOS 10.14", + // "'NSOpenGLPFAAlphaSize' is deprecated: first deprecated in macOS 10.14", + // "'NSOpenGLPFAColorSize' is deprecated: first deprecated in macOS 10.14", + // "'NSOpenGLPFADepthSize' is deprecated: first deprecated in macOS 10.14", + // "'NSOpenGLPFAMultisample' is deprecated: first deprecated in macOS 10.14", + // "'NSOpenGLPFASampleBuffers' is deprecated: first deprecated in macOS 10.14", + // "'NSOpenGLPixelFormatAttribute' is deprecated: first deprecated in macOS + // 10.14", + // "'NSOpenGLPFASamples' is deprecated: first deprecated in macOS 10.14" + NSOpenGLPFAOpenGLProfile, NSOpenGLProfileVersion3_2Core, + NSOpenGLPFADoubleBuffer, + NSOpenGLPFAAlphaSize, 8, + NSOpenGLPFAColorSize, 24, + NSOpenGLPFADepthSize, 24, + NSOpenGLPFAMultisample, + NSOpenGLPFASampleBuffers, NSOpenGLPixelFormatAttribute(1), + NSOpenGLPFASamples, NSOpenGLPixelFormatAttribute(4), +SAL_WNODEPRECATED_DECLARATIONS_POP + 0 + }; +SAL_WNODEPRECATED_DECLARATIONS_PUSH + // "'NSOpenGLPixelFormat' is deprecated: first deprecated in macOS 10.14 - Please + // use Metal or MetalKit." + pixFormat = [[NSOpenGLPixelFormat alloc] initWithAttributes:aAttributes]; +SAL_WNODEPRECATED_DECLARATIONS_POP + } + +SAL_WNODEPRECATED_DECLARATIONS_PUSH + // "'NSOpenGLView' is deprecated: first deprecated in macOS 10.14 - Please use MTKView + // instead." + maSysData.mpNSView = [[NSOpenGLView alloc] initWithFrame: aInitFrame pixelFormat:pixFormat]; +SAL_WNODEPRECATED_DECLARATIONS_POP + } + else + { + maSysData.mpNSView = [[NSView alloc] initWithFrame: aInitFrame]; + } + + if( maSysData.mpNSView ) + { + if( mpClipView ) + [mpClipView setDocumentView: maSysData.mpNSView]; + } +} + +AquaSalObject::~AquaSalObject() +{ + assert( GetSalData()->mpInstance->IsMainThread() ); + + if( maSysData.mpNSView ) + { + NSView *pView = maSysData.mpNSView; + [pView removeFromSuperview]; + [pView release]; + } + if( mpClipView ) + { + [mpClipView removeFromSuperview]; + [mpClipView release]; + } +} + +// Please note that the talk about QTMovieView below presumably refers +// to stuff in the QuickTime avmedia thingie, and that QuickTime is +// deprecated, not available for 64-bit code, and won't thus be used +// in a "modern" build of LO anyway. So the relevance of the comment +// is unclear. + +/* + sadly there seems to be no way to impose clipping on a child view, + especially a QTMovieView which seems to ignore the current context + completely. Also there is no real way to shape a window; on Aqua a + similar effect to non-rectangular windows is achieved by using a + non-opaque window and not painting where one wants the background + to shine through. + + With respect to SalObject this leaves us to having an NSClipView + containing the child view. Even a QTMovieView respects the boundaries of + that, which gives us a clip "region" consisting of one rectangle. + This is gives us an 80% solution only, though. +*/ + +void AquaSalObject::ResetClipRegion() +{ + mbClip = false; + setClippedPosSize(); +} + +void AquaSalObject::BeginSetClipRegion( sal_uInt32 ) +{ + mbClip = false; +} + +void AquaSalObject::UnionClipRegion( + tools::Long nX, tools::Long nY, tools::Long nWidth, tools::Long nHeight ) +{ + if( mbClip ) + { + if( nX < mnClipX ) + { + mnClipWidth += mnClipX - nX; + mnClipX = nX; + } + if( nX + nWidth > mnClipX + mnClipWidth ) + mnClipWidth = nX + nWidth - mnClipX; + if( nY < mnClipY ) + { + mnClipHeight += mnClipY - nY; + mnClipY = nY; + } + if( nY + nHeight > mnClipY + mnClipHeight ) + mnClipHeight = nY + nHeight - mnClipY; + } + else + { + mnClipX = nX; + mnClipY = nY; + mnClipWidth = nWidth; + mnClipHeight = nHeight; + mbClip = true; + } +} + +void AquaSalObject::EndSetClipRegion() +{ + setClippedPosSize(); +} + +void AquaSalObject::SetPosSize( + tools::Long nX, tools::Long nY, tools::Long nWidth, tools::Long nHeight ) +{ + mnX = nX; + mnY = nY; + mnWidth = nWidth; + mnHeight = nHeight; + setClippedPosSize(); +} + +void AquaSalObject::setClippedPosSize() +{ + OSX_SALDATA_RUNINMAIN( setClippedPosSize() ) + + NSRect aViewRect = { NSZeroPoint, NSMakeSize( mnWidth, mnHeight) }; + if( maSysData.mpNSView ) + { + NSView* pNSView = maSysData.mpNSView; + [pNSView setFrame: aViewRect]; + } + + NSRect aClipViewRect = NSMakeRect( mnX, mnY, mnWidth, mnHeight); + NSPoint aClipPt = NSZeroPoint; + if( mbClip ) + { + aClipViewRect.origin.x += mnClipX; + aClipViewRect.origin.y += mnClipY; + aClipViewRect.size.width = mnClipWidth; + aClipViewRect.size.height = mnClipHeight; + aClipPt.x = mnClipX; + if( mnClipY == 0 ) + aClipPt.y = mnHeight - mnClipHeight; + } + + mpFrame->VCLToCocoa( aClipViewRect, false ); + [mpClipView setFrame: aClipViewRect]; + + [mpClipView scrollToPoint: aClipPt]; +} + +void AquaSalObject::Show( bool bVisible ) +{ + if( !mpClipView ) + return; + + OSX_SALDATA_RUNINMAIN( Show( bVisible ) ) + + [mpClipView setHidden: (bVisible ? NO : YES)]; +} + +const SystemEnvData* AquaSalObject::GetSystemData() const +{ + return &maSysData; +} + +namespace { + +class AquaOpenGLContext : public OpenGLContext +{ +public: + virtual void initWindow() override; + +private: + GLWindow m_aGLWin; + + virtual const GLWindow& getOpenGLWindow() const override { return m_aGLWin; } + virtual GLWindow& getModifiableOpenGLWindow() override { return m_aGLWin; } +SAL_WNODEPRECATED_DECLARATIONS_PUSH + // "'NSOpenGLView' is deprecated: first deprecated in macOS 10.14 - Please use MTKView + // instead." + NSOpenGLView* getOpenGLView(); +SAL_WNODEPRECATED_DECLARATIONS_POP + virtual bool ImplInit() override; + virtual SystemWindowData generateWinData(vcl::Window* pParent, bool bRequestLegacyContext) override; + virtual void makeCurrent() override; + virtual void destroyCurrentContext() override; + virtual void resetCurrent() override; + virtual void swapBuffers() override; +}; + +} + +void AquaOpenGLContext::resetCurrent() +{ + OSX_SALDATA_RUNINMAIN( resetCurrent() ) + + clearCurrent(); + + OpenGLZone aZone; + + (void) this; // loplugin:staticmethods +SAL_WNODEPRECATED_DECLARATIONS_PUSH + // "'NSOpenGLContext' is deprecated: first deprecated in macOS 10.14 - Please use Metal or + // MetalKit." + [NSOpenGLContext clearCurrentContext]; +SAL_WNODEPRECATED_DECLARATIONS_POP +} + +void AquaOpenGLContext::makeCurrent() +{ + OSX_SALDATA_RUNINMAIN( makeCurrent() ) + + if (isCurrent()) + return; + + OpenGLZone aZone; + + clearCurrent(); + +SAL_WNODEPRECATED_DECLARATIONS_PUSH + // "'NSOpenGLView' is deprecated: first deprecated in macOS 10.14 - Please use MTKView + // instead." + NSOpenGLView* pView = getOpenGLView(); +SAL_WNODEPRECATED_DECLARATIONS_POP + [[pView openGLContext] makeCurrentContext]; + + registerAsCurrent(); +} + +void AquaOpenGLContext::swapBuffers() +{ + OSX_SALDATA_RUNINMAIN( swapBuffers() ) + + OpenGLZone aZone; + +SAL_WNODEPRECATED_DECLARATIONS_PUSH + // "'NSOpenGLView' is deprecated: first deprecated in macOS 10.14 - Please use MTKView + // instead." + NSOpenGLView* pView = getOpenGLView(); +SAL_WNODEPRECATED_DECLARATIONS_POP + [[pView openGLContext] flushBuffer]; + + BuffersSwapped(); +} + +SystemWindowData AquaOpenGLContext::generateWinData(vcl::Window* /*pParent*/, bool bRequestLegacyContext) +{ + SystemWindowData aWinData; + aWinData.bOpenGL = true; + aWinData.bLegacy = bRequestLegacyContext; + return aWinData; +} + +void AquaOpenGLContext::destroyCurrentContext() +{ + OSX_SALDATA_RUNINMAIN( destroyCurrentContext() ) +SAL_WNODEPRECATED_DECLARATIONS_PUSH + // "'NSOpenGLContext' is deprecated: first deprecated in macOS 10.14 - Please use Metal or + // MetalKit." + [NSOpenGLContext clearCurrentContext]; +SAL_WNODEPRECATED_DECLARATIONS_POP +} + +void AquaOpenGLContext::initWindow() +{ + OSX_SALDATA_RUNINMAIN( initWindow() ) + + if( !m_pChildWindow ) + { + SystemWindowData winData = generateWinData(mpWindow, mbRequestLegacyContext); + m_pChildWindow = VclPtr<SystemChildWindow>::Create(mpWindow, 0, &winData, false); + } + + if (m_pChildWindow) + { + InitChildWindow(m_pChildWindow.get()); + } +} + +bool AquaOpenGLContext::ImplInit() +{ + OSX_SALDATA_RUNINMAIN_UNION( ImplInit(), boolean ) + + OpenGLZone aZone; + + VCL_GL_INFO("OpenGLContext::ImplInit----start"); +SAL_WNODEPRECATED_DECLARATIONS_PUSH + // "'NSOpenGLView' is deprecated: first deprecated in macOS 10.14 - Please use MTKView + // instead." + NSOpenGLView* pView = getOpenGLView(); +SAL_WNODEPRECATED_DECLARATIONS_POP + [[pView openGLContext] makeCurrentContext]; + + bool bRet = InitGL(); + InitGLDebugging(); + return bRet; +} + +SAL_WNODEPRECATED_DECLARATIONS_PUSH + // "'NSOpenGLView' is deprecated: first deprecated in macOS 10.14 - Please use MTKView + // instead." +NSOpenGLView* AquaOpenGLContext::getOpenGLView() +SAL_WNODEPRECATED_DECLARATIONS_POP +{ +SAL_WNODEPRECATED_DECLARATIONS_PUSH + // "'NSOpenGLView' is deprecated: first deprecated in macOS 10.14 - Please use MTKView + // instead." + return reinterpret_cast<NSOpenGLView*>(m_pChildWindow->GetSystemData()->mpNSView); +SAL_WNODEPRECATED_DECLARATIONS_POP +} + +OpenGLContext* AquaSalInstance::CreateOpenGLContext() +{ + OSX_SALDATA_RUNINMAIN_POINTER( CreateOpenGLContext(), OpenGLContext* ) + return new AquaOpenGLContext; +} + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |