vcl/osx/salobj.cxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #include <string.h>
  21 #include <tools/debug.hxx>
  22 #include <vcl/opengl/OpenGLContext.hxx>
  23 #include <vcl/opengl/OpenGLHelper.hxx>
  24 #include <opengl/zone.hxx>
  25
  26 #include <osx/saldata.hxx>
  27 #include <osx/salframe.h>
  28 #include <osx/salinst.h>
  29 #include <osx/salobj.h>
  30 #include <osx/runinmain.hxx>
  31
  32 #include <AppKit/NSOpenGLView.h>
  33
  34 AquaSalObject::AquaSalObject( AquaSalFrame* pFrame, SystemWindowData const * pWindowData ) :
  35     mpFrame( pFrame ),
  36     mnClipX( -1 ),
  37     mnClipY( -1 ),
  38     mnClipWidth( -1 ),
  39     mnClipHeight( -1 ),
  40     mbClip( false ),
  41     mnX( 0 ),
  42     mnY( 0 ),
  43     mnWidth( 20 ),
  44     mnHeight( 20 )
  45 {
  46     maSysData.nSize = sizeof( maSysData );
  47     maSysData.mpNSView = nullptr;
  48     maSysData.mbOpenGL = false;
  49
  50     NSRect aInitFrame = { NSZeroPoint, { 20, 20 } };
  51     mpClipView = [[NSClipView alloc] initWithFrame: aInitFrame ];
  52     if( mpClipView )
  53     {
  54         [mpFrame->getNSView() addSubview: mpClipView];
  55         [mpClipView setHidden: YES];
  56     }
  57     if (pWindowData && pWindowData->bOpenGL)
  58     {
  59         maSysData.mbOpenGL = true;
  60 SAL_WNODEPRECATED_DECLARATIONS_PUSH
  61             // "'NSOpenGLPixelFormat' is deprecated: first deprecated in macOS 10.14 - Please use
  62             // Metal or MetalKit."
  63         NSOpenGLPixelFormat* pixFormat = nullptr;
  64 SAL_WNODEPRECATED_DECLARATIONS_POP
  65
  66         if (pWindowData->bLegacy)
  67         {
  68 SAL_WNODEPRECATED_DECLARATIONS_PUSH
  69                 // "'NSOpenGLPixelFormatAttribute' is deprecated: first deprecated in macOS 10.14"
  70             NSOpenGLPixelFormatAttribute const aAttributes[] =
  71 SAL_WNODEPRECATED_DECLARATIONS_POP
  72             {
  73 SAL_WNODEPRECATED_DECLARATIONS_PUSH
  74                     // "'NSOpenGLPFADoubleBuffer' is deprecated: first deprecated in macOS 10.14",
  75                     // "'NSOpenGLPFAAlphaSize' is deprecated: first deprecated in macOS 10.14",
  76                     // "'NSOpenGLPFAColorSize' is deprecated: first deprecated in macOS 10.14",
  77                     // "'NSOpenGLPFADepthSize' is deprecated: first deprecated in macOS 10.14",
  78                     // "'NSOpenGLPFAMultisample' is deprecated: first deprecated in macOS 10.14",
  79                     // "'NSOpenGLPFASampleBuffers' is deprecated: first deprecated in macOS 10.14",
  80                     // "'NSOpenGLPixelFormatAttribute' is deprecated: first deprecated in macOS
  81                     // 10.14",
  82                     // "'NSOpenGLPFASamples' is deprecated: first deprecated in macOS 10.14"
  83                 NSOpenGLPFADoubleBuffer,
  84                 NSOpenGLPFAAlphaSize, 8,
  85                 NSOpenGLPFAColorSize, 24,
  86                 NSOpenGLPFADepthSize, 24,
  87                 NSOpenGLPFAMultisample,
  88                 NSOpenGLPFASampleBuffers, NSOpenGLPixelFormatAttribute(1),
  89                 NSOpenGLPFASamples, NSOpenGLPixelFormatAttribute(4),
  90 SAL_WNODEPRECATED_DECLARATIONS_POP
  91                 0
  92             };
  93 SAL_WNODEPRECATED_DECLARATIONS_PUSH
  94                 // "'NSOpenGLPixelFormat' is deprecated: first deprecated in macOS 10.14 - Please
  95                 // use Metal or MetalKit."
  96             pixFormat = [[NSOpenGLPixelFormat alloc] initWithAttributes:aAttributes];
  97 SAL_WNODEPRECATED_DECLARATIONS_POP
  98         }
  99         else
 100         {
 101 SAL_WNODEPRECATED_DECLARATIONS_PUSH
 102                 // "'NSOpenGLPixelFormatAttribute' is deprecated: first deprecated in macOS 10.14"
 103             NSOpenGLPixelFormatAttribute const aAttributes[] =
 104 SAL_WNODEPRECATED_DECLARATIONS_POP
 105             {
 106 SAL_WNODEPRECATED_DECLARATIONS_PUSH
 107                     // "'NSOpenGLPFAOpenGLProfile' is deprecated: first deprecated in macOS 10.14",
 108                     // "'NSOpenGLProfileVersion3_2Core' is deprecated: first deprecated in macOS
 109                     // 10.14",
 110                     // "'NSOpenGLPFADoubleBuffer' is deprecated: first deprecated in macOS 10.14",
 111                     // "'NSOpenGLPFAAlphaSize' is deprecated: first deprecated in macOS 10.14",
 112                     // "'NSOpenGLPFAColorSize' is deprecated: first deprecated in macOS 10.14",
 113                     // "'NSOpenGLPFADepthSize' is deprecated: first deprecated in macOS 10.14",
 114                     // "'NSOpenGLPFAMultisample' is deprecated: first deprecated in macOS 10.14",
 115                     // "'NSOpenGLPFASampleBuffers' is deprecated: first deprecated in macOS 10.14",
 116                     // "'NSOpenGLPixelFormatAttribute' is deprecated: first deprecated in macOS
 117                     // 10.14",
 118                     // "'NSOpenGLPFASamples' is deprecated: first deprecated in macOS 10.14"
 119                 NSOpenGLPFAOpenGLProfile, NSOpenGLProfileVersion3_2Core,
 120                 NSOpenGLPFADoubleBuffer,
 121                 NSOpenGLPFAAlphaSize, 8,
 122                 NSOpenGLPFAColorSize, 24,
 123                 NSOpenGLPFADepthSize, 24,
 124                 NSOpenGLPFAMultisample,
 125                 NSOpenGLPFASampleBuffers, NSOpenGLPixelFormatAttribute(1),
 126                 NSOpenGLPFASamples, NSOpenGLPixelFormatAttribute(4),
 127 SAL_WNODEPRECATED_DECLARATIONS_POP
 128                 0
 129             };
 130 SAL_WNODEPRECATED_DECLARATIONS_PUSH
 131                 // "'NSOpenGLPixelFormat' is deprecated: first deprecated in macOS 10.14 - Please
 132                 // use Metal or MetalKit."
 133             pixFormat = [[NSOpenGLPixelFormat alloc] initWithAttributes:aAttributes];
 134 SAL_WNODEPRECATED_DECLARATIONS_POP
 135         }
 136
 137 SAL_WNODEPRECATED_DECLARATIONS_PUSH
 138             // "'NSOpenGLView' is deprecated: first deprecated in macOS 10.14 - Please use MTKView
 139             // instead."
 140         maSysData.mpNSView = [[NSOpenGLView alloc] initWithFrame: aInitFrame pixelFormat:pixFormat];
 141 SAL_WNODEPRECATED_DECLARATIONS_POP
 142     }
 143     else
 144     {
 145         maSysData.mpNSView = [[NSView alloc] initWithFrame: aInitFrame];
 146     }
 147
 148     if( maSysData.mpNSView )
 149     {
 150         if( mpClipView )
 151             [mpClipView setDocumentView: maSysData.mpNSView];
 152     }
 153 }
 154
 155 AquaSalObject::~AquaSalObject()
 156 {
 157     assert( GetSalData()->mpInstance->IsMainThread() );
 158
 159     if( maSysData.mpNSView )
 160     {
 161         NSView *pView = maSysData.mpNSView;
 162         [pView removeFromSuperview];
 163         [pView release];
 164     }
 165     if( mpClipView )
 166     {
 167         [mpClipView removeFromSuperview];
 168         [mpClipView release];
 169     }
 170 }
 171
 172 // Please note that the talk about QTMovieView below presumably refers
 173 // to stuff in the QuickTime avmedia thingie, and that QuickTime is
 174 // deprecated, not available for 64-bit code, and won't thus be used
 175 // in a "modern" build of LO anyway. So the relevance of the comment
 176 // is unclear.
 177
 178 /*
 179    sadly there seems to be no way to impose clipping on a child view,
 180    especially a QTMovieView which seems to ignore the current context
 181    completely. Also there is no real way to shape a window; on Aqua a
 182    similar effect to non-rectangular windows is achieved by using a
 183    non-opaque window and not painting where one wants the background
 184    to shine through.
 185
 186    With respect to SalObject this leaves us to having an NSClipView
 187    containing the child view. Even a QTMovieView respects the boundaries of
 188    that, which gives us a clip "region" consisting of one rectangle.
 189    This is gives us an 80% solution only, though.
 190 */
 191
 192 void AquaSalObject::ResetClipRegion()
 193 {
 194     mbClip = false;
 195     setClippedPosSize();
 196 }
 197
 198 void AquaSalObject::BeginSetClipRegion( sal_uInt32 )
 199 {
 200     mbClip = false;
 201 }
 202
 203 void AquaSalObject::UnionClipRegion( long nX, long nY, long nWidth, long nHeight )
 204 {
 205     if( mbClip )
 206     {
 207         if( nX < mnClipX )
 208         {
 209             mnClipWidth += mnClipX - nX;
 210             mnClipX = nX;
 211         }
 212         if( nX + nWidth > mnClipX + mnClipWidth )
 213             mnClipWidth = nX + nWidth - mnClipX;
 214         if( nY < mnClipY )
 215         {
 216             mnClipHeight += mnClipY - nY;
 217             mnClipY = nY;
 218         }
 219         if( nY + nHeight > mnClipY + mnClipHeight )
 220             mnClipHeight = nY + nHeight - mnClipY;
 221     }
 222     else
 223     {
 224         mnClipX = nX;
 225         mnClipY = nY;
 226         mnClipWidth = nWidth;
 227         mnClipHeight = nHeight;
 228         mbClip = true;
 229     }
 230 }
 231
 232 void AquaSalObject::EndSetClipRegion()
 233 {
 234     setClippedPosSize();
 235 }
 236
 237 void AquaSalObject::SetPosSize( long nX, long nY, long nWidth, long nHeight )
 238 {
 239     mnX = nX;
 240     mnY = nY;
 241     mnWidth = nWidth;
 242     mnHeight = nHeight;
 243     setClippedPosSize();
 244 }
 245
 246 void AquaSalObject::setClippedPosSize()
 247 {
 248     OSX_SALDATA_RUNINMAIN( setClippedPosSize() )
 249
 250     NSRect aViewRect = { NSZeroPoint, NSMakeSize( mnWidth, mnHeight) };
 251     if( maSysData.mpNSView )
 252     {
 253         NSView* pNSView = maSysData.mpNSView;
 254         [pNSView setFrame: aViewRect];
 255     }
 256
 257     NSRect aClipViewRect = NSMakeRect( mnX, mnY, mnWidth, mnHeight);
 258     NSPoint aClipPt = NSZeroPoint;
 259     if( mbClip )
 260     {
 261         aClipViewRect.origin.x += mnClipX;
 262         aClipViewRect.origin.y += mnClipY;
 263         aClipViewRect.size.width = mnClipWidth;
 264         aClipViewRect.size.height = mnClipHeight;
 265         aClipPt.x = mnClipX;
 266         if( mnClipY == 0 )
 267             aClipPt.y = mnHeight - mnClipHeight;
 268     }
 269
 270     mpFrame->VCLToCocoa( aClipViewRect, false );
 271     [mpClipView setFrame: aClipViewRect];
 272
 273     [mpClipView scrollToPoint: aClipPt];
 274 }
 275
 276 void AquaSalObject::Show( bool bVisible )
 277 {
 278     if( !mpClipView )
 279         return;
 280
 281     OSX_SALDATA_RUNINMAIN( Show( bVisible ) )
 282
 283     [mpClipView setHidden: (bVisible ? NO : YES)];
 284 }
 285
 286 const SystemEnvData* AquaSalObject::GetSystemData() const
 287 {
 288     return &maSysData;
 289 }
 290
 291 class AquaOpenGLContext : public OpenGLContext
 292 {
 293 public:
 294     virtual void initWindow() override;
 295
 296 private:
 297     GLWindow m_aGLWin;
 298
 299     virtual const GLWindow& getOpenGLWindow() const override { return m_aGLWin; }
 300     virtual GLWindow& getModifiableOpenGLWindow() override { return m_aGLWin; }
 301 SAL_WNODEPRECATED_DECLARATIONS_PUSH
 302         // "'NSOpenGLView' is deprecated: first deprecated in macOS 10.14 - Please use MTKView
 303         // instead."
 304     NSOpenGLView* getOpenGLView();
 305 SAL_WNODEPRECATED_DECLARATIONS_POP
 306     virtual bool ImplInit() override;
 307     virtual SystemWindowData generateWinData(vcl::Window* pParent, bool bRequestLegacyContext) override;
 308     virtual void makeCurrent() override;
 309     virtual void destroyCurrentContext() override;
 310     virtual void resetCurrent() override;
 311     virtual void swapBuffers() override;
 312 };
 313
 314 void AquaOpenGLContext::resetCurrent()
 315 {
 316     OSX_SALDATA_RUNINMAIN( resetCurrent() )
 317
 318     clearCurrent();
 319
 320     OpenGLZone aZone;
 321
 322     (void) this; // loplugin:staticmethods
 323 SAL_WNODEPRECATED_DECLARATIONS_PUSH
 324         // "'NSOpenGLContext' is deprecated: first deprecated in macOS 10.14 - Please use Metal or
 325         // MetalKit."
 326     [NSOpenGLContext clearCurrentContext];
 327 SAL_WNODEPRECATED_DECLARATIONS_POP
 328 }
 329
 330 void AquaOpenGLContext::makeCurrent()
 331 {
 332     OSX_SALDATA_RUNINMAIN( makeCurrent() )
 333
 334     if (isCurrent())
 335         return;
 336
 337     OpenGLZone aZone;
 338
 339     clearCurrent();
 340
 341 SAL_WNODEPRECATED_DECLARATIONS_PUSH
 342         // "'NSOpenGLView' is deprecated: first deprecated in macOS 10.14 - Please use MTKView
 343         // instead."
 344     NSOpenGLView* pView = getOpenGLView();
 345 SAL_WNODEPRECATED_DECLARATIONS_POP
 346     [[pView openGLContext] makeCurrentContext];
 347
 348     registerAsCurrent();
 349 }
 350
 351 void AquaOpenGLContext::swapBuffers()
 352 {
 353     OSX_SALDATA_RUNINMAIN( swapBuffers() )
 354
 355     OpenGLZone aZone;
 356
 357 SAL_WNODEPRECATED_DECLARATIONS_PUSH
 358         // "'NSOpenGLView' is deprecated: first deprecated in macOS 10.14 - Please use MTKView
 359         // instead."
 360     NSOpenGLView* pView = getOpenGLView();
 361 SAL_WNODEPRECATED_DECLARATIONS_POP
 362     [[pView openGLContext] flushBuffer];
 363
 364     BuffersSwapped();
 365 }
 366
 367 SystemWindowData AquaOpenGLContext::generateWinData(vcl::Window* /*pParent*/, bool bRequestLegacyContext)
 368 {
 369     SystemWindowData aWinData;
 370     aWinData.bOpenGL = true;
 371     aWinData.bLegacy = bRequestLegacyContext;
 372     return aWinData;
 373 }
 374
 375 void AquaOpenGLContext::destroyCurrentContext()
 376 {
 377     OSX_SALDATA_RUNINMAIN( destroyCurrentContext() )
 378 SAL_WNODEPRECATED_DECLARATIONS_PUSH
 379         // "'NSOpenGLContext' is deprecated: first deprecated in macOS 10.14 - Please use Metal or
 380         // MetalKit."
 381     [NSOpenGLContext clearCurrentContext];
 382 SAL_WNODEPRECATED_DECLARATIONS_POP
 383 }
 384
 385 void AquaOpenGLContext::initWindow()
 386 {
 387     OSX_SALDATA_RUNINMAIN( initWindow() )
 388
 389     if( !m_pChildWindow )
 390     {
 391         SystemWindowData winData = generateWinData(mpWindow, mbRequestLegacyContext);
 392         m_pChildWindow = VclPtr<SystemChildWindow>::Create(mpWindow, 0, &winData, false);
 393     }
 394
 395     if (m_pChildWindow)
 396     {
 397         InitChildWindow(m_pChildWindow.get());
 398     }
 399 }
 400
 401 bool AquaOpenGLContext::ImplInit()
 402 {
 403     OSX_SALDATA_RUNINMAIN_UNION( ImplInit(), boolean )
 404
 405     OpenGLZone aZone;
 406
 407     VCL_GL_INFO("OpenGLContext::ImplInit----start");
 408 SAL_WNODEPRECATED_DECLARATIONS_PUSH
 409         // "'NSOpenGLView' is deprecated: first deprecated in macOS 10.14 - Please use MTKView
 410         // instead."
 411     NSOpenGLView* pView = getOpenGLView();
 412 SAL_WNODEPRECATED_DECLARATIONS_POP
 413     [[pView openGLContext] makeCurrentContext];
 414
 415     bool bRet = InitGL();
 416     InitGLDebugging();
 417     return bRet;
 418 }
 419
 420 SAL_WNODEPRECATED_DECLARATIONS_PUSH
 421         // "'NSOpenGLView' is deprecated: first deprecated in macOS 10.14 - Please use MTKView
 422         // instead."
 423 NSOpenGLView* AquaOpenGLContext::getOpenGLView()
 424 SAL_WNODEPRECATED_DECLARATIONS_POP
 425 {
 426 SAL_WNODEPRECATED_DECLARATIONS_PUSH
 427         // "'NSOpenGLView' is deprecated: first deprecated in macOS 10.14 - Please use MTKView
 428         // instead."
 429     return reinterpret_cast<NSOpenGLView*>(m_pChildWindow->GetSystemData()->mpNSView);
 430 SAL_WNODEPRECATED_DECLARATIONS_POP
 431 }
 432
 433 OpenGLContext* AquaSalInstance::CreateOpenGLContext()
 434 {
 435     OSX_SALDATA_RUNINMAIN_POINTER( CreateOpenGLContext(), OpenGLContext* )
 436     return new AquaOpenGLContext;
 437 }
 438
 439 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */