aboutsummaryrefslogtreecommitdiff
path: root/util/fbcompose/TickTracker.hh
blob: bf1e60e872b29ffb8c41ed62887372c4d213aea9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
/** TickTracker.hh file for the fluxbox compositor. */

// Copyright (c) 2011 Gediminas Liktaras (gliktaras at gmail dot com)
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.


#ifndef FBCOMPOSITOR_TIMER_HH
#define FBCOMPOSITOR_TIMER_HH

#include "config.h"

#include "Exceptions.hh"

#include <sys/time.h>


namespace FbCompositor {

    class TimeException;
    class TickTracker;


    /**
     * A timer class.
     *
     * This class provides a simpler and more flexible interface to deal with
     * time. It was added, since it is not possible to make continuous time
     * measurements with FbTk::FbTickTracker.
     */
    class TickTracker {
    public:
        //--- CONSTRUCTORS AND DESTRUCTORS -------------------------------------

        /** Constructor. */
        TickTracker();

        /** Copy constructor. */
        TickTracker(const TickTracker &other);

        /** Assignment operator. */
        TickTracker &operator=(const TickTracker &other);

        /** Destructor. */
        ~TickTracker();


        //--- TIMER MANIPULATION -----------------------------------------------

        /** Starts the timer. */
        void start();

        /** Stops the timer. */
        void stop();


        //--- TIMER QUERIES ----------------------------------------------------

        /** \returns whether the timer is running. */
        bool isRunning() const;

        /** \returns the tick size. */
        int tickSize() const;


        /** \returns the new number of elapsed ticks since last call of this function. */
        int newElapsedTicks();

        /** \returns the total number of elapsed ticks. */
        int totalElapsedTicks();


        /** Sets the size of a tick. */
        void setTickSize(int usec);


    private:
        //--- INTERNAL FUNTIONS ------------------------------------------------

        /** \returns the difference in time between two timevals. */
        timeval timeDifference(timeval t1, timeval t2);

        /** \returns the difference between two timevals in ticks. */
        int tickDifference(const timeval &t1, const timeval &t2);


        //--- PRIVATE VARIABLES ------------------------------------------------

        /** Whether the timer is running or not. */
        bool m_is_running;

        /** Time the timer was started. */
        timeval m_startTime;


        /** Size of the timer ticks. */
        int m_tick_size;

        /** The number of ticks per second. */
        double m_ticks_per_second;


        /** The number of observed ticks with newElapsedTicks(). */
        int m_observed_ticks;
    };


    //--- INLINE FUNCTIONS -----------------------------------------------------

    // Returns whether the timer is running.
    inline bool TickTracker::isRunning() const {
        return m_is_running;
    }

    // Returns the tick size.
    inline int TickTracker::tickSize() const {
        return m_tick_size;
    }
}


#endif  // FBCOMPOSITOR_TIMER_HH