vcl/osx/saltimer.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 <sal/config.h>
  21
  22 #include <rtl/math.hxx>
  23 #include <tools/time.hxx>
  24
  25 #include <osx/saltimer.h>
  26 #include <osx/salnstimer.h>
  27 #include <osx/saldata.hxx>
  28 #include <osx/salframe.h>
  29 #include <osx/salinst.h>
  30
  31
  32 void ImplNSAppPostEvent( short nEventId, BOOL bAtStart, int nUserData )
  33 {
  34     ReleasePoolHolder aPool;
  35 SAL_WNODEPRECATED_DECLARATIONS_PUSH
  36 // 'NSApplicationDefined' is deprecated: first deprecated in macOS 10.12
  37     NSEvent* pEvent = [NSEvent otherEventWithType: NSApplicationDefined
  38 SAL_WNODEPRECATED_DECLARATIONS_POP
  39                                location: NSZeroPoint
  40                                modifierFlags: 0
  41                                timestamp: [[NSProcessInfo processInfo] systemUptime]
  42                                windowNumber: 0
  43                                context: nil
  44                                subtype: nEventId
  45                                data1: nUserData
  46                                data2: 0];
  47     assert( pEvent );
  48     if ( nil == pEvent )
  49         return;
  50     if ( NO == bAtStart )
  51     {
  52         // nextEventMatchingMask has to run in the main thread!
  53         assert([NSThread isMainThread]);
  54
  55         // Posting an event to the end of an empty queue fails,
  56         // so we peek the queue and post to the start, if empty.
  57         // Some Qt bugs even indicate nextEvent without dequeue
  58         // sometimes blocks, so we dequeue and re-add the event.
  59         NSEvent* pPeekEvent = [NSApp nextEventMatchingMask: NSEventMaskAny
  60                                untilDate: nil
  61                                inMode: NSDefaultRunLoopMode
  62                                dequeue: YES];
  63         if ( nil == pPeekEvent )
  64             bAtStart = YES;
  65         else
  66             [NSApp postEvent: pPeekEvent atStart: YES];
  67     }
  68     [NSApp postEvent: pEvent atStart: bAtStart];
  69 }
  70
  71 void AquaSalTimer::queueDispatchTimerEvent( bool bAtStart )
  72 {
  73     Stop();
  74     m_bDirectTimeout = true;
  75     ImplNSAppPostEvent( AquaSalInstance::DispatchTimerEvent,
  76                         bAtStart, GetNextEventVersion() );
  77 }
  78
  79 void AquaSalTimer::Start( sal_uInt64 nMS )
  80 {
  81     SalData* pSalData = GetSalData();
  82
  83     if( !pSalData->mpInstance->IsMainThread() )
  84     {
  85         ImplNSAppPostEvent( AquaSalInstance::AppStartTimerEvent, YES, nMS );
  86         return;
  87     }
  88
  89     m_bDirectTimeout = (0 == nMS) && !pSalData->mpInstance->mbIsLiveResize;
  90     if ( m_bDirectTimeout )
  91         Stop();
  92     else
  93     {
  94         NSTimeInterval aTI = double(nMS) / 1000.0;
  95         if( m_pRunningTimer != nil )
  96         {
  97             if ([m_pRunningTimer isValid] && rtl::math::approxEqual(
  98                     [m_pRunningTimer timeInterval], aTI))
  99             {
 100                 // set new fire date
 101                 [m_pRunningTimer setFireDate: [NSDate dateWithTimeIntervalSinceNow: aTI]];
 102             }
 103             else
 104                 Stop();
 105         }
 106         else
 107             Stop();
 108         if( m_pRunningTimer == nil )
 109         {
 110             m_pRunningTimer = [[NSTimer scheduledTimerWithTimeInterval: aTI
 111                                                     target: [[[TimerCallbackCaller alloc] init] autorelease]
 112                                                     selector: @selector(timerElapsed:)
 113                                                     userInfo: nil
 114                                                     repeats: NO
 115                                            ] retain];
 116             /* #i84055# add timer to tracking run loop mode,
 117                so they also elapse while e.g. life resize
 118             */
 119             [[NSRunLoop currentRunLoop] addTimer: m_pRunningTimer forMode: NSEventTrackingRunLoopMode];
 120         }
 121     }
 122 }
 123
 124 void AquaSalTimer::Stop()
 125 {
 126     assert( GetSalData()->mpInstance->IsMainThread() );
 127
 128     if( m_pRunningTimer != nil )
 129     {
 130         [m_pRunningTimer invalidate];
 131         [m_pRunningTimer release];
 132         m_pRunningTimer = nil;
 133     }
 134     InvalidateEvent();
 135 }
 136
 137 void AquaSalTimer::callTimerCallback()
 138 {
 139     ImplSVData* pSVData = ImplGetSVData();
 140     SolarMutexGuard aGuard;
 141     m_bDirectTimeout = false;
 142     if( pSVData->maSchedCtx.mpSalTimer )
 143         pSVData->maSchedCtx.mpSalTimer->CallCallback();
 144 }
 145
 146 void AquaSalTimer::handleTimerElapsed()
 147 {
 148     if ( m_bDirectTimeout || GetSalData()->mpInstance->mbIsLiveResize )
 149     {
 150         // Stop the timer, as it is just invalidated after the firing function
 151         Stop();
 152         callTimerCallback();
 153     }
 154     else
 155         queueDispatchTimerEvent( YES );
 156 }
 157
 158 bool AquaSalTimer::handleDispatchTimerEvent( NSEvent *pEvent )
 159 {
 160     bool bIsValidEvent = IsValidEventVersion( [pEvent data1] );
 161     if ( bIsValidEvent )
 162         callTimerCallback();
 163     return bIsValidEvent;
 164 }
 165
 166 void AquaSalTimer::handleStartTimerEvent( NSEvent* pEvent )
 167 {
 168     ImplSVData* pSVData = ImplGetSVData();
 169     if( pSVData->maSchedCtx.mpSalTimer )
 170     {
 171         NSTimeInterval posted = [pEvent timestamp] + NSTimeInterval([pEvent data1])/1000.0;
 172         NSTimeInterval current = [NSDate timeIntervalSinceReferenceDate];
 173         sal_uLong nTimeoutMS = 0;
 174         if( (posted - current) > 0.0 )
 175             nTimeoutMS = ceil( (posted - current) * 1000 );
 176         Start( nTimeoutMS );
 177     }
 178 }
 179
 180 bool AquaSalTimer::IsTimerElapsed() const
 181 {
 182     assert( !((ExistsValidEvent() || m_bDirectTimeout) && m_pRunningTimer) );
 183     if ( ExistsValidEvent() || m_bDirectTimeout )
 184         return true;
 185     if ( !m_pRunningTimer )
 186         return false;
 187     NSDate* pDt = [m_pRunningTimer fireDate];
 188     return pDt && ([pDt timeIntervalSinceNow] < 0);
 189 }
 190
 191 AquaSalTimer::AquaSalTimer( )
 192     : m_pRunningTimer( nil )
 193 {
 194 }
 195
 196 AquaSalTimer::~AquaSalTimer()
 197 {
 198     Stop();
 199 }
 200
 201 void AquaSalTimer::handleWindowShouldClose()
 202 {
 203     // for whatever reason events get filtered on close, presumably by
 204     // timestamp so post a new timeout event, if there was one queued...
 205     if ( ExistsValidEvent() && !m_pRunningTimer )
 206         queueDispatchTimerEvent( NO );
 207 }
 208
 209 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */