Merge lp:~vanvugt/mir/rename-TimeSource-to-Clock into lp:mir

[Daniel van Vugt]

Rename TimeSource to Clock

"Clock" is a more widely understood word for describing that thing from which you get the time...

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:1310
http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-ci/603/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-android-trusty-i386-build/550
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-clang-trusty-amd64-build/546
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-trusty-touch/154
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-trusty-amd64-ci/329
        deb: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-trusty-amd64-ci/329/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-trusty-armhf-ci/332
        deb: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-trusty-armhf-ci/332/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-trusty-armhf/154
        deb: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-trusty-armhf/154/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-runner-mako/181
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/2680

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/mir-team-mir-development-branch-ci/603/rebuild

review: Approve (continuous-integration)

[Robert Carr (robertcarr)]

I would be mildly inclined to say a "Clock" is an implementation of a "TimeSource". I can't make a strong argument for any of the names here though.

review: Abstain

[Kevin DuBois (kdub)]

I don't see a strong reason to do this...
If we do though, lets update l27,208,236 to all be consistent

review: Abstain

[Daniel van Vugt (vanvugt)]

Better naming improves understanding and therefore maintainability. AFAIK all existing C and C++ interfaces for such functionality call it "clock".

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:1312
http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-ci/609/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-android-trusty-i386-build/557
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-clang-trusty-amd64-build/553
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-trusty-touch/161
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-trusty-amd64-ci/335
        deb: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-trusty-amd64-ci/335/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-trusty-armhf-ci/338
        deb: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-trusty-armhf-ci/338/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-trusty-armhf/161
        deb: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-trusty-armhf/161/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-runner-mako/188
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/2712

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/mir-team-mir-development-branch-ci/609/rebuild

review: Approve (continuous-integration)

[Alan Griffiths (alan-griffiths)]

Maybe we should also rename namespace time to chrono too. ;)

review: Approve

[Daniel van Vugt (vanvugt)]

AFAICT "chrono" and "time" are synonyms. The former derived from Greek, the latter from Old English. But once again, choose the word more people will understand :)

=== modified file 'include/server/mir/default_server_configuration.h'
--- include/server/mir/default_server_configuration.h	2013-12-20 08:04:42 +0000
+++ include/server/mir/default_server_configuration.h	2014-01-06 02:59:24 +0000
@@ -65,7 +65,7 @@
 }
 namespace time
 {
-class TimeSource;
+class Clock;
 }
 namespace scene
 {
@@ -230,7 +230,7 @@
     virtual std::shared_ptr<logging::Logger> the_logger();
     /** @} */
 
-    virtual std::shared_ptr<time::TimeSource>    the_time_source();
+    virtual std::shared_ptr<time::Clock> the_clock();
 
 protected:
     using DefaultConfigurationOptions::the_options;
@@ -283,7 +283,7 @@
     CachedPtr<compositor::CompositorReport> compositor_report;
     CachedPtr<logging::Logger> logger;
     CachedPtr<graphics::DisplayReport> display_report;
-    CachedPtr<time::TimeSource> time_source;
+    CachedPtr<time::Clock> clock;
     CachedPtr<MainLoop> main_loop;
     CachedPtr<ServerStatusListener> server_status_listener;
     CachedPtr<graphics::DisplayConfigurationPolicy> display_configuration_policy;

=== modified file 'include/server/mir/logging/message_processor_report.h'
--- include/server/mir/logging/message_processor_report.h	2013-08-28 03:41:48 +0000
+++ include/server/mir/logging/message_processor_report.h	2014-01-06 02:59:24 +0000
@@ -20,7 +20,7 @@
 #define MIR_LOGGING_MESSAGE_PROCESSOR_REPORT_H_
 
 #include "mir/frontend/message_processor_report.h"
-#include "mir/time/time_source.h"
+#include "mir/time/clock.h"
 
 #include <memory>
 #include <mutex>
@@ -56,7 +56,7 @@
 public:
     MessageProcessorReport(
         std::shared_ptr<Logger> const& log,
-        std::shared_ptr<time::TimeSource> const& time_source);
+        std::shared_ptr<time::Clock> const& clock);
 
     void received_invocation(void const* mediator, int id, std::string const& method);
 
@@ -74,7 +74,7 @@
 
 private:
     std::shared_ptr<Logger> const log;
-    std::shared_ptr<time::TimeSource> const time_source;
+    std::shared_ptr<time::Clock> const clock;
     std::mutex mutex;
     detail::Mediators mediators;
 };

=== renamed file 'include/server/mir/time/time_source.h' => 'include/server/mir/time/clock.h'
--- include/server/mir/time/time_source.h	2013-04-24 05:22:20 +0000
+++ include/server/mir/time/clock.h	2014-01-06 02:59:24 +0000
@@ -16,8 +16,8 @@
  * Authored by: Thomas Voss <[e-mail]>
  */
 
-#ifndef MIR_TIME_TIME_SOURCE_H_
-#define MIR_TIME_TIME_SOURCE_H_
+#ifndef MIR_TIME_CLOCK_H_
+#define MIR_TIME_CLOCK_H_
 
 #include <chrono>
 
@@ -28,17 +28,17 @@
 
 typedef std::chrono::high_resolution_clock::time_point Timestamp;
 
-class TimeSource
+class Clock
 {
 public:
-    virtual ~TimeSource() = default;
+    virtual ~Clock() = default;
 
     virtual Timestamp sample() const = 0;
 
 protected:
-    TimeSource() = default;
+    Clock() = default;
 };
 }
 }
 
-#endif // MIR_TIME_TIME_SOURCE_H_
+#endif // MIR_TIME_CLOCK_H_

=== modified file 'include/server/mir/time/high_resolution_clock.h'
--- include/server/mir/time/high_resolution_clock.h	2013-04-24 05:22:20 +0000
+++ include/server/mir/time/high_resolution_clock.h	2014-01-06 02:59:24 +0000
@@ -19,14 +19,14 @@
 #ifndef MIR_TIME_HIGH_RESOLUTION_CLOCK_H_
 #define MIR_TIME_HIGH_RESOLUTION_CLOCK_H_
 
-#include "mir/time/time_source.h"
+#include "mir/time/clock.h"
 
 namespace mir
 {
 namespace time
 {
 
-class HighResolutionClock : public TimeSource
+class HighResolutionClock : public Clock
 {
 public:
     virtual Timestamp sample() const override;

=== modified file 'src/server/default_server_configuration.cpp'
--- src/server/default_server_configuration.cpp	2013-12-18 02:19:19 +0000
+++ src/server/default_server_configuration.cpp	2014-01-06 02:59:24 +0000
@@ -183,7 +183,7 @@
             auto mp_report = the_options()->get(msg_processor_report_opt, off_opt_value);
             if (mp_report == log_opt_value)
             {
-                return std::make_shared<ml::MessageProcessorReport>(the_logger(), the_time_source());
+                return std::make_shared<ml::MessageProcessorReport>(the_logger(), the_clock());
             }
             else if (mp_report == lttng_opt_value)
             {
@@ -222,9 +222,9 @@
     return the_input_manager();
 }
 
-std::shared_ptr<mir::time::TimeSource> mir::DefaultServerConfiguration::the_time_source()
+std::shared_ptr<mir::time::Clock> mir::DefaultServerConfiguration::the_clock()
 {
-    return time_source(
+    return clock(
         []()
         {
             return std::make_shared<mir::time::HighResolutionClock>();

=== modified file 'src/server/logging/compositor_report.cpp'
--- src/server/logging/compositor_report.cpp	2014-01-02 09:10:38 +0000
+++ src/server/logging/compositor_report.cpp	2014-01-06 02:59:24 +0000
@@ -31,7 +31,7 @@
 
 logging::CompositorReport::CompositorReport(
     std::shared_ptr<Logger> const& logger,
-    std::shared_ptr<TimeSource> const& clock)
+    std::shared_ptr<Clock> const& clock)
     : logger(logger),
       clock(clock),
       last_report(now())

=== modified file 'src/server/logging/compositor_report.h'
--- src/server/logging/compositor_report.h	2014-01-02 09:10:38 +0000
+++ src/server/logging/compositor_report.h	2014-01-06 02:59:24 +0000
@@ -20,7 +20,7 @@
 #define MIR_LOGGING_COMPOSITOR_REPORT_H_
 
 #include "mir/compositor/compositor_report.h"
-#include "mir/time/time_source.h"
+#include "mir/time/clock.h"
 #include <memory>
 #include <mutex>
 #include <unordered_map>
@@ -37,7 +37,7 @@
 {
 public:
     CompositorReport(std::shared_ptr<Logger> const& logger,
-                     std::shared_ptr<time::TimeSource> const& clock);
+                     std::shared_ptr<time::Clock> const& clock);
     void added_display(int width, int height, int x, int y, SubCompositorId id);
     void began_frame(SubCompositorId id);
     void finished_frame(SubCompositorId id);
@@ -47,7 +47,7 @@
 
 private:
     std::shared_ptr<Logger> const logger;
-    std::shared_ptr<time::TimeSource> const clock;
+    std::shared_ptr<time::Clock> const clock;
 
     typedef time::Timestamp TimePoint;
     TimePoint now() const;

=== modified file 'src/server/logging/default_configuration.cpp'
--- src/server/logging/default_configuration.cpp	2013-12-24 06:16:59 +0000
+++ src/server/logging/default_configuration.cpp	2014-01-06 02:59:24 +0000
@@ -81,7 +81,7 @@
             if (the_options()->get(compositor_report_opt, off_opt_value) == log_opt_value)
             {
                 return std::make_shared<ml::CompositorReport>(
-                    the_logger(), the_time_source());
+                    the_logger(), the_clock());
             }
             else
             {

=== modified file 'src/server/logging/message_processor_report.cpp'
--- src/server/logging/message_processor_report.cpp	2013-12-12 08:34:23 +0000
+++ src/server/logging/message_processor_report.cpp	2014-01-06 02:59:24 +0000
@@ -32,9 +32,9 @@
 
 ml::MessageProcessorReport::MessageProcessorReport(
     std::shared_ptr<Logger> const& log,
-    std::shared_ptr<time::TimeSource> const& time_source) :
+    std::shared_ptr<time::Clock> const& clock) :
     log(log),
-    time_source(time_source)
+    clock(clock)
 {
 }
 
@@ -79,13 +79,13 @@
     auto& invocations = mediators[mediator].current_invocations;
     auto& invocation = invocations[id];
 
-    invocation.start = time_source->sample();
+    invocation.start = clock->sample();
     invocation.method = method;
 }
 
 void ml::MessageProcessorReport::completed_invocation(void const* mediator, int id, bool result)
 {
-    auto const end = time_source->sample();
+    auto const end = clock->sample();
     std::ostringstream out;
 
     {

=== modified file 'tests/unit-tests/logging/message_processor_report.cpp'
--- tests/unit-tests/logging/message_processor_report.cpp	2013-03-28 14:20:06 +0000
+++ tests/unit-tests/logging/message_processor_report.cpp	2014-01-06 02:59:24 +0000
@@ -28,12 +28,12 @@
 
 namespace
 {
-class MockTimeSource : public mir::time::TimeSource
+class MockClock : public mir::time::Clock
 {
 public:
     MOCK_CONST_METHOD0(sample, mir::time::Timestamp());
 
-    ~MockTimeSource() noexcept(true) {}
+    ~MockClock() noexcept(true) {}
 };
 
 class MockLogger : public mir::logging::Logger
@@ -45,13 +45,13 @@
 
 struct MessageProcessorReport : public Test
 {
-    MockLogger     logger;
-    MockTimeSource time_source;
+    MockLogger logger;
+    MockClock clock;
 
     mir::logging::MessageProcessorReport report;
 
     MessageProcessorReport() :
-        report(mir::test::fake_shared(logger), mir::test::fake_shared(time_source))
+        report(mir::test::fake_shared(logger), mir::test::fake_shared(clock))
     {
         EXPECT_CALL(logger, log(
             mir::logging::Logger::debug,
@@ -64,7 +64,7 @@
 TEST_F(MessageProcessorReport, everything_fine)
 {
     mir::time::Timestamp a_time;
-    EXPECT_CALL(time_source, sample()).Times(2).WillRepeatedly(Return(a_time));
+    EXPECT_CALL(clock, sample()).Times(2).WillRepeatedly(Return(a_time));
     EXPECT_CALL(logger, log(
         mir::logging::Logger::informational,
         EndsWith(": a_function(), elapsed=0µs"),
@@ -79,7 +79,7 @@
     mir::time::Timestamp a_time;
     mir::time::Timestamp another_time = a_time + std::chrono::microseconds(1234);
 
-    EXPECT_CALL(time_source, sample()).Times(2)
+    EXPECT_CALL(clock, sample()).Times(2)
     .WillOnce(Return(a_time)).WillOnce(Return(another_time));
 
     EXPECT_CALL(logger, log(
@@ -94,7 +94,7 @@
 TEST_F(MessageProcessorReport, reports_disconnect)
 {
     mir::time::Timestamp a_time;
-    EXPECT_CALL(time_source, sample()).Times(2).WillRepeatedly(Return(a_time));
+    EXPECT_CALL(clock, sample()).Times(2).WillRepeatedly(Return(a_time));
     EXPECT_CALL(logger, log(
         mir::logging::Logger::informational,
         HasSubstr("(disconnecting)"),
@@ -109,7 +109,7 @@
     const char* testError = "***Test error***";
 
     mir::time::Timestamp a_time;
-    EXPECT_CALL(time_source, sample()).Times(2).WillRepeatedly(Return(a_time));
+    EXPECT_CALL(clock, sample()).Times(2).WillRepeatedly(Return(a_time));
     EXPECT_CALL(logger, log(
         mir::logging::Logger::informational,
         HasSubstr(testError),
@@ -122,7 +122,7 @@
 
 TEST_F(MessageProcessorReport, reports_unknown_method)
 {
-    EXPECT_CALL(time_source, sample()).Times(0);
+    EXPECT_CALL(clock, sample()).Times(0);
     EXPECT_CALL(logger, log(
         mir::logging::Logger::warning,
         HasSubstr("UNKNOWN method=\"unknown_function_name\""),
@@ -146,7 +146,7 @@
 TEST_F(MessageProcessorReport, logs_a_debug_message_when_invocation_starts)
 {
     mir::time::Timestamp a_time;
-    EXPECT_CALL(time_source, sample()).Times(AnyNumber()).WillRepeatedly(Return(a_time));
+    EXPECT_CALL(clock, sample()).Times(AnyNumber()).WillRepeatedly(Return(a_time));
     EXPECT_CALL(logger, log(
         mir::logging::Logger::informational,
         HasSubstr("Calls outstanding on exit:"),
@@ -163,7 +163,7 @@
 TEST_F(MessageProcessorReport, logs_incomplete_calls_on_destruction)
 {
     mir::time::Timestamp a_time;
-    EXPECT_CALL(time_source, sample()).Times(AnyNumber()).WillRepeatedly(Return(a_time));
+    EXPECT_CALL(clock, sample()).Times(AnyNumber()).WillRepeatedly(Return(a_time));
 
     EXPECT_CALL(logger, log(
         mir::logging::Logger::informational,

=== modified file 'tests/unit-tests/logging/test_compositor_report.cpp'
--- tests/unit-tests/logging/test_compositor_report.cpp	2013-12-24 08:07:27 +0000
+++ tests/unit-tests/logging/test_compositor_report.cpp	2014-01-06 02:59:24 +0000
@@ -28,7 +28,7 @@
 namespace
 {
 
-class FakeClock : public time::TimeSource
+class FakeClock : public time::Clock
 {
 public:
     void elapse(chrono::microseconds delta)