← Back to branch summary

~ubuntu-branches/ubuntu/wily/mir/wily-proposed

« back to all changes in this revision

Viewing changes to include/test/mir_test/fake_clock.h

  • Committer: Package Import Robot
  • Author(s): Ubuntu daily release
  • Date: 2014-10-10 14:01:26 UTC
  • mto: This revision was merged to the branch mainline in revision 84.
  • Revision ID: package-import@ubuntu.com-20141010140126-n1czko8na1kuz4ll
Tags: upstream-0.8.0+14.10.20141010
Import upstream version 0.8.0+14.10.20141010

Show diffs side-by-side

added added

removed removed

Lines of Context:
include/test/mir_test/fake_clock.h
1
 
/*
2
 
 * Copyright © 2014 Canonical Ltd.
3
 
 *
4
 
 * This program is free software: you can redistribute it and/or modify it
5
 
 * under the terms of the GNU General Public License version 3,
6
 
 * as published by the Free Software Foundation.
7
 
 *
8
 
 * This program is distributed in the hope that it will be useful,
9
 
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10
 
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
 
 * GNU General Public License for more details.
12
 
 *
13
 
 * You should have received a copy of the GNU General Public License
14
 
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
15
 
 *
16
 
 * Authored by: Christopher James Halse Rogers <christopher.halse.rogers@canonical.com>
17
 
 */
18
 
 
19
 
#ifndef MIR_TEST_FAKE_CLOCK_H_
20
 
#define MIR_TEST_FAKE_CLOCK_H_
21
 
 
22
 
#include <chrono>
23
 
#include <functional>
24
 
#include <list>
25
 
 
26
 
namespace mir
27
 
{
28
 
namespace test
29
 
{
30
 
/**
31
 
 * @brief An invasive time source for Mocks/Stubs/Fakes that depend on timing
32
 
 */
33
 
class FakeClock
34
 
{
35
 
public:
36
 
    typedef std::chrono::nanoseconds duration;
37
 
    typedef duration::rep rep;
38
 
    typedef duration::period period;
39
 
    typedef std::chrono::time_point<FakeClock, duration> time_point;
40
 
 
41
 
    static constexpr bool is_steady = false;
42
 
    time_point now() const;
43
 
 
44
 
    FakeClock();
45
 
    /**
46
 
     * \brief Advance the fake clock
47
 
     * \note Advancing by a negative duration will move the clock backwards
48
 
     */
49
 
    template<typename rep, typename period>
50
 
    void advance_time(std::chrono::duration<rep, period> by)
51
 
    {
52
 
        advance_time_ns(std::chrono::duration_cast<std::chrono::nanoseconds>(by));
53
 
    }
54
 
 
55
 
    /**
56
 
     * \brief Register an event callback when the time is changed
57
 
     * \param cb    Function to call when the time is changed.
58
 
     *              This function is called with the new time.
59
 
     *              If the function returns false, it will no longer be called
60
 
     *              on subsequent time changes.
61
 
     */
62
 
    void register_time_change_callback(std::function<bool(time_point)> cb);
63
 
private:
64
 
    void advance_time_ns(std::chrono::nanoseconds by);
65
 
    std::chrono::nanoseconds current_time;
66
 
    std::list<std::function<bool(time_point)>> callbacks;
67
 
};
68
 
 
69
 
}
70
 
}
71
 
 
72
 
#endif // MIR_TEST_FAKE_CLOCK_H_