include/salhelper/timer.hxx

   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
  21 #ifndef INCLUDED_SALHELPER_TIMER_HXX
  22 #define INCLUDED_SALHELPER_TIMER_HXX
  23
  24 #include "salhelper/simplereferenceobject.hxx"
  25 #include "osl/time.h"
  26 #include "salhelper/salhelperdllapi.h"
  27
  28 namespace salhelper
  29 {
  30
  31 /** Helper class for easier manipulation with TimeValue.
  32  *
  33  *  Times are seconds in UTC since 01.01.1970
  34  */
  35 struct SAL_WARN_UNUSED TTimeValue : public TimeValue
  36 {
  37     TTimeValue()
  38     {
  39         Seconds = 0;
  40         Nanosec = 0;
  41     }
  42
  43     TTimeValue( sal_uInt32 Secs, sal_uInt32 Nano )
  44     {
  45         Seconds = Secs;
  46         Nanosec = Nano;
  47
  48         normalize();
  49     }
  50
  51     TTimeValue(sal_uInt32 MilliSecs)
  52     {
  53         Seconds = MilliSecs / 1000L;
  54         Nanosec = (MilliSecs % 1000) * 1000000L;
  55
  56         normalize();
  57     }
  58
  59     TTimeValue( const TimeValue& rTimeValue )
  60     {
  61         Seconds = rTimeValue.Seconds;
  62         Nanosec = rTimeValue.Nanosec;
  63
  64         normalize();
  65     }
  66
  67     void SAL_CALL normalize()
  68     {
  69         if ( Nanosec > 1000000000 )
  70         {
  71             Seconds += Nanosec / 1000000000;
  72             Nanosec %= 1000000000;
  73         }
  74     }
  75
  76     void SAL_CALL addTime( const TTimeValue& Delta )
  77     {
  78         Seconds += Delta.Seconds;
  79         Nanosec += Delta.Nanosec;
  80
  81         normalize();
  82     }
  83
  84     bool SAL_CALL isEmpty() const
  85     {
  86         return ( ( Seconds == 0 ) && ( Nanosec == 0 ) );
  87     }
  88 };
  89
  90 inline bool operator<( const TTimeValue& rTimeA, const TTimeValue& rTimeB )
  91 {
  92     if ( rTimeA.Seconds < rTimeB.Seconds )
  93         return true;
  94     else if ( rTimeA.Seconds > rTimeB.Seconds )
  95         return false;
  96     else
  97         return ( rTimeA.Nanosec < rTimeB.Nanosec );
  98 }
  99
 100 inline bool operator>( const TTimeValue& rTimeA, const TTimeValue& rTimeB )
 101 {
 102     if ( rTimeA.Seconds > rTimeB.Seconds )
 103         return true;
 104     else if ( rTimeA.Seconds < rTimeB.Seconds )
 105         return false;
 106     else
 107         return ( rTimeA.Nanosec > rTimeB.Nanosec );
 108 }
 109
 110 inline bool operator==( const TTimeValue& rTimeA, const TTimeValue& rTimeB )
 111 {
 112     return ( ( rTimeA.Seconds == rTimeB.Seconds ) &&
 113              ( rTimeA.Nanosec == rTimeB.Nanosec ) );
 114 }
 115
 116 class TimerManager;
 117
 118 /** Interface for the Timer and handling the event
 119 */
 120 class SALHELPER_DLLPUBLIC Timer : public salhelper::SimpleReferenceObject
 121 {
 122 public:
 123
 124     /** Constructor.
 125      */
 126     Timer();
 127
 128     /** Constructor.
 129      */
 130     Timer( const TTimeValue& Time );
 131
 132     /** Constructor.
 133      */
 134     Timer( const TTimeValue& Time, const TTimeValue& RepeatTime );
 135
 136     /** Start timer.
 137      */
 138     void        SAL_CALL start();
 139
 140     /** Abort timer prematurely.
 141      */
 142     void        SAL_CALL stop();
 143
 144     /** Returns sal_True if timer is running.
 145      */
 146     sal_Bool    SAL_CALL isTicking() const;
 147
 148     /** Is the timer expired?
 149      */
 150     sal_Bool    SAL_CALL isExpired() const;
 151
 152     /** Does pTimer expires before us?
 153      */
 154     sal_Bool    SAL_CALL expiresBefore( const Timer* pTimer ) const;
 155
 156     /** Set the absolute time when the timer should fire.
 157      */
 158     void        SAL_CALL setAbsoluteTime( const TTimeValue& Time );
 159
 160     /** Set the time to fire to 'now' + Remaining.
 161      */
 162     void        SAL_CALL setRemainingTime( const TTimeValue& Remaining );
 163
 164     /** Set the time to fire to 'now' + Remaining with repeat interveal
 165      * Repeat.
 166      */
 167     void        SAL_CALL setRemainingTime( const TTimeValue& Remaining, const TTimeValue& Repeat );
 168
 169     /** Adds Time to the 'fire time'.
 170      */
 171     void        SAL_CALL addTime( const TTimeValue& Time );
 172
 173     /** Returns the remaining time before timer expiration relative to now.
 174      */
 175     TTimeValue  SAL_CALL getRemainingTime() const;
 176
 177 protected:
 178
 179     /** Destructor.
 180      */
 181     virtual ~Timer() SAL_OVERRIDE;
 182
 183     /** What should be done when the 'timer fires'.
 184      */
 185     virtual void SAL_CALL onShot() = 0;
 186
 187 protected:
 188
 189     /** holds (initial) expiration time of this timer.
 190      */
 191     TTimeValue  m_aTimeOut;
 192
 193     /** holds the time of expiration of this timer.
 194      */
 195     TTimeValue  m_aExpired;
 196
 197     /** holds the time interveal of successive expirations.
 198      */
 199     TTimeValue  m_aRepeatDelta;
 200
 201     /** Pointer to the next timer (to fire).
 202      */
 203     Timer*      m_pNext;
 204
 205 private:
 206
 207     /** Copy constructor deleted.
 208      */
 209     Timer( const Timer& rTimer ) SAL_DELETED_FUNCTION;
 210
 211     /** Copy assignment operator deleted.
 212      */
 213     void SAL_CALL operator=( const Timer& rTimer ) SAL_DELETED_FUNCTION;
 214
 215     friend class TimerManager;
 216 };
 217
 218 }
 219
 220 #endif // INCLUDED_SALHELPER_TIMER_HXX
 221
 222 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */