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.mpNSView = nullptr;
  47     maSysData.mbOpenGL = false;
  48
  49     NSRect aInitFrame = { NSZeroPoint, { 20, 20 } };
  50     mpClipView = [[NSClipView alloc] initWithFrame: aInitFrame ];
  51     if( mpClipView )
  52     {
  53         [mpFrame->getNSView() addSubview: mpClipView];
  54         [mpClipView setHidden: YES];
  55     }
  56     if (pWindowData && pWindowData->bOpenGL)
  57     {
  58         maSysData.mbOpenGL = true;
  59 SAL_WNODEPRECATED_DECLARATIONS_PUSH
  60             // "'NSOpenGLPixelFormat' is deprecated: first deprecated in macOS 10.14 - Please use
  61             // Metal or MetalKit."
  62         NSOpenGLPixelFormat* pixFormat = nullptr;
  63 SAL_WNODEPRECATED_DECLARATIONS_POP
  64
  65         if (pWindowData->bLegacy)
  66         {
  67 SAL_WNODEPRECATED_DECLARATIONS_PUSH
  68                 // "'NSOpenGLPixelFormatAttribute' is deprecated: first deprecated in macOS 10.14"
  69             NSOpenGLPixelFormatAttribute const aAttributes[] =
  70 SAL_WNODEPRECATED_DECLARATIONS_POP
  71             {
  72 SAL_WNODEPRECATED_DECLARATIONS_PUSH
  73                     // "'NSOpenGLPFADoubleBuffer' is deprecated: first deprecated in macOS 10.14",
  74                     // "'NSOpenGLPFAAlphaSize' is deprecated: first deprecated in macOS 10.14",
  75                     // "'NSOpenGLPFAColorSize' is deprecated: first deprecated in macOS 10.14",
  76                     // "'NSOpenGLPFADepthSize' is deprecated: first deprecated in macOS 10.14",
  77                     // "'NSOpenGLPFAMultisample' is deprecated: first deprecated in macOS 10.14",
  78                     // "'NSOpenGLPFASampleBuffers' is deprecated: first deprecated in macOS 10.14",
  79                     // "'NSOpenGLPixelFormatAttribute' is deprecated: first deprecated in macOS
  80                     // 10.14",
  81                     // "'NSOpenGLPFASamples' is deprecated: first deprecated in macOS 10.14"
  82                 NSOpenGLPFADoubleBuffer,
  83                 NSOpenGLPFAAlphaSize, 8,
  84                 NSOpenGLPFAColorSize, 24,
  85                 NSOpenGLPFADepthSize, 24,
  86                 NSOpenGLPFAMultisample,
  87                 NSOpenGLPFASampleBuffers, NSOpenGLPixelFormatAttribute(1),
  88                 NSOpenGLPFASamples, NSOpenGLPixelFormatAttribute(4),
  89 SAL_WNODEPRECATED_DECLARATIONS_POP
  90                 0
  91             };
  92 SAL_WNODEPRECATED_DECLARATIONS_PUSH
  93                 // "'NSOpenGLPixelFormat' is deprecated: first deprecated in macOS 10.14 - Please
  94                 // use Metal or MetalKit."
  95             pixFormat = [[NSOpenGLPixelFormat alloc] initWithAttributes:aAttributes];
  96 SAL_WNODEPRECATED_DECLARATIONS_POP
  97         }
  98         else
  99         {
 100 SAL_WNODEPRECATED_DECLARATIONS_PUSH
 101                 // "'NSOpenGLPixelFormatAttribute' is deprecated: first deprecated in macOS 10.14"
 102             NSOpenGLPixelFormatAttribute const aAttributes[] =
 103 SAL_WNODEPRECATED_DECLARATIONS_POP
 104             {
 105 SAL_WNODEPRECATED_DECLARATIONS_PUSH
 106                     // "'NSOpenGLPFAOpenGLProfile' is deprecated: first deprecated in macOS 10.14",
 107                     // "'NSOpenGLProfileVersion3_2Core' is deprecated: first deprecated in macOS
 108                     // 10.14",
 109                     // "'NSOpenGLPFADoubleBuffer' is deprecated: first deprecated in macOS 10.14",
 110                     // "'NSOpenGLPFAAlphaSize' is deprecated: first deprecated in macOS 10.14",
 111                     // "'NSOpenGLPFAColorSize' is deprecated: first deprecated in macOS 10.14",
 112                     // "'NSOpenGLPFADepthSize' is deprecated: first deprecated in macOS 10.14",
 113                     // "'NSOpenGLPFAMultisample' is deprecated: first deprecated in macOS 10.14",
 114                     // "'NSOpenGLPFASampleBuffers' is deprecated: first deprecated in macOS 10.14",
 115                     // "'NSOpenGLPixelFormatAttribute' is deprecated: first deprecated in macOS
 116                     // 10.14",
 117                     // "'NSOpenGLPFASamples' is deprecated: first deprecated in macOS 10.14"
 118                 NSOpenGLPFAOpenGLProfile, NSOpenGLProfileVersion3_2Core,
 119                 NSOpenGLPFADoubleBuffer,
 120                 NSOpenGLPFAAlphaSize, 8,
 121                 NSOpenGLPFAColorSize, 24,
 122                 NSOpenGLPFADepthSize, 24,
 123                 NSOpenGLPFAMultisample,
 124                 NSOpenGLPFASampleBuffers, NSOpenGLPixelFormatAttribute(1),
 125                 NSOpenGLPFASamples, NSOpenGLPixelFormatAttribute(4),
 126 SAL_WNODEPRECATED_DECLARATIONS_POP
 127                 0
 128             };
 129 SAL_WNODEPRECATED_DECLARATIONS_PUSH
 130                 // "'NSOpenGLPixelFormat' is deprecated: first deprecated in macOS 10.14 - Please
 131                 // use Metal or MetalKit."
 132             pixFormat = [[NSOpenGLPixelFormat alloc] initWithAttributes:aAttributes];
 133 SAL_WNODEPRECATED_DECLARATIONS_POP
 134         }
 135
 136 SAL_WNODEPRECATED_DECLARATIONS_PUSH
 137             // "'NSOpenGLView' is deprecated: first deprecated in macOS 10.14 - Please use MTKView
 138             // instead."
 139         maSysData.mpNSView = [[NSOpenGLView alloc] initWithFrame: aInitFrame pixelFormat:pixFormat];
 140 SAL_WNODEPRECATED_DECLARATIONS_POP
 141     }
 142     else
 143     {
 144         maSysData.mpNSView = [[NSView alloc] initWithFrame: aInitFrame];
 145     }
 146
 147     if( maSysData.mpNSView )
 148     {
 149         if( mpClipView )
 150             [mpClipView setDocumentView: maSysData.mpNSView];
 151     }
 152 }
 153
 154 AquaSalObject::~AquaSalObject()
 155 {
 156     assert( GetSalData()->mpInstance->IsMainThread() );
 157
 158     if( maSysData.mpNSView )
 159     {
 160         NSView *pView = maSysData.mpNSView;
 161         [pView removeFromSuperview];
 162         [pView release];
 163     }
 164     if( mpClipView )
 165     {
 166         [mpClipView removeFromSuperview];
 167         [mpClipView release];
 168     }
 169 }
 170
 171 // Please note that the talk about QTMovieView below presumably refers
 172 // to stuff in the QuickTime avmedia thingie, and that QuickTime is
 173 // deprecated, not available for 64-bit code, and won't thus be used
 174 // in a "modern" build of LO anyway. So the relevance of the comment
 175 // is unclear.
 176
 177 /*
 178    sadly there seems to be no way to impose clipping on a child view,
 179    especially a QTMovieView which seems to ignore the current context
 180    completely. Also there is no real way to shape a window; on Aqua a
 181    similar effect to non-rectangular windows is achieved by using a
 182    non-opaque window and not painting where one wants the background
 183    to shine through.
 184
 185    With respect to SalObject this leaves us to having an NSClipView
 186    containing the child view. Even a QTMovieView respects the boundaries of
 187    that, which gives us a clip "region" consisting of one rectangle.
 188    This is gives us an 80% solution only, though.
 189 */
 190
 191 void AquaSalObject::ResetClipRegion()
 192 {
 193     mbClip = false;
 194     setClippedPosSize();
 195 }
 196
 197 void AquaSalObject::BeginSetClipRegion( sal_uInt32 )
 198 {
 199     mbClip = false;
 200 }
 201
 202 void AquaSalObject::UnionClipRegion(
 203     tools::Long nX, tools::Long nY, tools::Long nWidth, tools::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(
 238     tools::Long nX, tools::Long nY, tools::Long nWidth, tools::Long nHeight )
 239 {
 240     mnX = nX;
 241     mnY = nY;
 242     mnWidth = nWidth;
 243     mnHeight = nHeight;
 244     setClippedPosSize();
 245 }
 246
 247 void AquaSalObject::setClippedPosSize()
 248 {
 249     OSX_SALDATA_RUNINMAIN( setClippedPosSize() )
 250
 251     NSRect aViewRect = { NSZeroPoint, NSMakeSize( mnWidth, mnHeight) };
 252     if( maSysData.mpNSView )
 253     {
 254         NSView* pNSView = maSysData.mpNSView;
 255         [pNSView setFrame: aViewRect];
 256     }
 257
 258     NSRect aClipViewRect = NSMakeRect( mnX, mnY, mnWidth, mnHeight);
 259     NSPoint aClipPt = NSZeroPoint;
 260     if( mbClip )
 261     {
 262         aClipViewRect.origin.x += mnClipX;
 263         aClipViewRect.origin.y += mnClipY;
 264         aClipViewRect.size.width = mnClipWidth;
 265         aClipViewRect.size.height = mnClipHeight;
 266         aClipPt.x = mnClipX;
 267         if( mnClipY == 0 )
 268             aClipPt.y = mnHeight - mnClipHeight;
 269     }
 270
 271     mpFrame->VCLToCocoa( aClipViewRect, false );
 272     [mpClipView setFrame: aClipViewRect];
 273
 274     [mpClipView scrollToPoint: aClipPt];
 275 }
 276
 277 void AquaSalObject::Show( bool bVisible )
 278 {
 279     if( !mpClipView )
 280         return;
 281
 282     OSX_SALDATA_RUNINMAIN( Show( bVisible ) )
 283
 284     [mpClipView setHidden: (bVisible ? NO : YES)];
 285 }
 286
 287 const SystemEnvData* AquaSalObject::GetSystemData() const
 288 {
 289     return &maSysData;
 290 }
 291
 292 namespace {
 293
 294 class AquaOpenGLContext : public OpenGLContext
 295 {
 296 public:
 297     virtual void initWindow() override;
 298
 299 private:
 300     GLWindow m_aGLWin;
 301
 302     virtual const GLWindow& getOpenGLWindow() const override { return m_aGLWin; }
 303     virtual GLWindow& getModifiableOpenGLWindow() override { return m_aGLWin; }
 304 SAL_WNODEPRECATED_DECLARATIONS_PUSH
 305         // "'NSOpenGLView' is deprecated: first deprecated in macOS 10.14 - Please use MTKView
 306         // instead."
 307     NSOpenGLView* getOpenGLView();
 308 SAL_WNODEPRECATED_DECLARATIONS_POP
 309     virtual bool ImplInit() override;
 310     virtual SystemWindowData generateWinData(vcl::Window* pParent, bool bRequestLegacyContext) override;
 311     virtual void makeCurrent() override;
 312     virtual void destroyCurrentContext() override;
 313     virtual void resetCurrent() override;
 314     virtual void swapBuffers() override;
 315 };
 316
 317 }
 318
 319 void AquaOpenGLContext::resetCurrent()
 320 {
 321     OSX_SALDATA_RUNINMAIN( resetCurrent() )
 322
 323     clearCurrent();
 324
 325     OpenGLZone aZone;
 326
 327     (void) this; // loplugin:staticmethods
 328 SAL_WNODEPRECATED_DECLARATIONS_PUSH
 329         // "'NSOpenGLContext' is deprecated: first deprecated in macOS 10.14 - Please use Metal or
 330         // MetalKit."
 331     [NSOpenGLContext clearCurrentContext];
 332 SAL_WNODEPRECATED_DECLARATIONS_POP
 333 }
 334
 335 void AquaOpenGLContext::makeCurrent()
 336 {
 337     OSX_SALDATA_RUNINMAIN( makeCurrent() )
 338
 339     if (isCurrent())
 340         return;
 341
 342     OpenGLZone aZone;
 343
 344     clearCurrent();
 345
 346 SAL_WNODEPRECATED_DECLARATIONS_PUSH
 347         // "'NSOpenGLView' is deprecated: first deprecated in macOS 10.14 - Please use MTKView
 348         // instead."
 349     NSOpenGLView* pView = getOpenGLView();
 350 SAL_WNODEPRECATED_DECLARATIONS_POP
 351     [[pView openGLContext] makeCurrentContext];
 352
 353     registerAsCurrent();
 354 }
 355
 356 void AquaOpenGLContext::swapBuffers()
 357 {
 358     OSX_SALDATA_RUNINMAIN( swapBuffers() )
 359
 360     OpenGLZone aZone;
 361
 362 SAL_WNODEPRECATED_DECLARATIONS_PUSH
 363         // "'NSOpenGLView' is deprecated: first deprecated in macOS 10.14 - Please use MTKView
 364         // instead."
 365     NSOpenGLView* pView = getOpenGLView();
 366 SAL_WNODEPRECATED_DECLARATIONS_POP
 367     [[pView openGLContext] flushBuffer];
 368
 369     BuffersSwapped();
 370 }
 371
 372 SystemWindowData AquaOpenGLContext::generateWinData(vcl::Window* /*pParent*/, bool bRequestLegacyContext)
 373 {
 374     SystemWindowData aWinData;
 375     aWinData.bOpenGL = true;
 376     aWinData.bLegacy = bRequestLegacyContext;
 377     return aWinData;
 378 }
 379
 380 void AquaOpenGLContext::destroyCurrentContext()
 381 {
 382     OSX_SALDATA_RUNINMAIN( destroyCurrentContext() )
 383 SAL_WNODEPRECATED_DECLARATIONS_PUSH
 384         // "'NSOpenGLContext' is deprecated: first deprecated in macOS 10.14 - Please use Metal or
 385         // MetalKit."
 386     [NSOpenGLContext clearCurrentContext];
 387 SAL_WNODEPRECATED_DECLARATIONS_POP
 388 }
 389
 390 void AquaOpenGLContext::initWindow()
 391 {
 392     OSX_SALDATA_RUNINMAIN( initWindow() )
 393
 394     if( !m_pChildWindow )
 395     {
 396         SystemWindowData winData = generateWinData(mpWindow, mbRequestLegacyContext);
 397         m_pChildWindow = VclPtr<SystemChildWindow>::Create(mpWindow, 0, &winData, false);
 398     }
 399
 400     if (m_pChildWindow)
 401     {
 402         InitChildWindow(m_pChildWindow.get());
 403     }
 404 }
 405
 406 bool AquaOpenGLContext::ImplInit()
 407 {
 408     OSX_SALDATA_RUNINMAIN_UNION( ImplInit(), boolean )
 409
 410     OpenGLZone aZone;
 411
 412     VCL_GL_INFO("OpenGLContext::ImplInit----start");
 413 SAL_WNODEPRECATED_DECLARATIONS_PUSH
 414         // "'NSOpenGLView' is deprecated: first deprecated in macOS 10.14 - Please use MTKView
 415         // instead."
 416     NSOpenGLView* pView = getOpenGLView();
 417 SAL_WNODEPRECATED_DECLARATIONS_POP
 418     [[pView openGLContext] makeCurrentContext];
 419
 420     bool bRet = InitGL();
 421     InitGLDebugging();
 422     return bRet;
 423 }
 424
 425 SAL_WNODEPRECATED_DECLARATIONS_PUSH
 426         // "'NSOpenGLView' is deprecated: first deprecated in macOS 10.14 - Please use MTKView
 427         // instead."
 428 NSOpenGLView* AquaOpenGLContext::getOpenGLView()
 429 SAL_WNODEPRECATED_DECLARATIONS_POP
 430 {
 431 SAL_WNODEPRECATED_DECLARATIONS_PUSH
 432         // "'NSOpenGLView' is deprecated: first deprecated in macOS 10.14 - Please use MTKView
 433         // instead."
 434     return reinterpret_cast<NSOpenGLView*>(m_pChildWindow->GetSystemData()->mpNSView);
 435 SAL_WNODEPRECATED_DECLARATIONS_POP
 436 }
 437
 438 OpenGLContext* AquaSalInstance::CreateOpenGLContext()
 439 {
 440     OSX_SALDATA_RUNINMAIN_POINTER( CreateOpenGLContext(), OpenGLContext* )
 441     return new AquaOpenGLContext;
 442 }
 443
 444 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */