Merge lp:~thomas-voss/location-service/export-glib-context into lp:location-service

[Thomas Voß]

Export location::glib::Context and enable clients to connect to the service.

Export location::glib::Context and enable clients to connect to the service.

[Simon Fels (morphis)]

LGTM

review: Approve

=== modified file 'doc/api.md'
--- doc/api.md	2017-04-05 08:27:15 +0000
+++ doc/api.md	2017-04-26 20:01:55 +0000
@@ -23,25 +23,36 @@
 the client API:
 
 ```{cpp}
-auto service = location::connect_to_service(...);
-auto session = service->create_session_for_criteria(location::Criteria{});
-
-session->updates().position.changed().connect([this](const location::Update<location::Position>& pos)
-{
-  std::cout << pos << std::endl;
-});
-
-session->updates().heading.changed().connect([this](const location::Update<location::units::Degrees>& heading)
-{
-  std::cout << pos << std::endl;
-});
-
-session->updates().velocity.changed().connect([this](const location::Update<location::units::MetersPerSecond>& velocity)
-{
-  std::cout << pos << std::endl;
-});
-
-session->updates().position_status = location::Service::Session::Updates::Status::enabled;
-session->updates().heading_status = location::Service::Session::Updates::Status::enabled;
-session->updates().velocity_status = location::Service::Session::Updates::Status::enabled;
+#include <location/service.h>
+#include <location/session.h>
+
+#include <location/glib/context.h>
+
+auto context = location::glib::Context::create_for_system_bus();
+
+context->connect_to_service([context](const location::Service::Ptr& service)
+{
+	service->create_session_for_criteria(location::Criteria{}, [context, service](const location::Session::Ptr& session)
+	{
+		session->updates().position.changed().connect([this](const location::Update<location::Position>& pos)
+		{
+			std::cout << pos << std::endl;
+		});
+
+	    session->updates().heading.changed().connect([this](const location::Update<location::units::Degrees>& heading)
+	    {
+		    std::cout << pos << std::endl;
+	    });
+
+        session->updates().velocity.changed().connect([this](const location::Update<location::units::MetersPerSecond>& velocity)
+	    {
+		    std::cout << pos << std::endl;
+	    });
+
+	    session->updates().position_status = location::Service::Session::Updates::Status::enabled;
+	    session->updates().heading_status = location::Service::Session::Updates::Status::enabled;
+	    session->updates().velocity_status = location::Service::Session::Updates::Status::enabled;
+	});
+});
+
 ```

=== added directory 'include/location/glib'
=== added file 'include/location/glib/context.h'
--- include/location/glib/context.h	1970-01-01 00:00:00 +0000
+++ include/location/glib/context.h	2017-04-26 20:01:55 +0000
@@ -0,0 +1,73 @@
+/*
+ * Copyright © 2017 Canonical Ltd.
+ *
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License version 3,
+ * as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * Authored by: Thomas Voß <[e-mail]>
+ */
+#ifndef LOCATION_GLIB_CONTEXT_H_
+#define LOCATION_GLIB_CONTEXT_H_
+
+#include <location/service.h>
+#include <location/visibility.h>
+
+#include <functional>
+#include <memory>
+
+namespace location
+{
+namespace glib
+{
+
+/// @brief A Context bundles together runtime resources for
+/// accessing a locationd service instance.
+///
+/// Note that both create_* functions assume that they are invoked
+/// on a thread with a valid GMainContext. More to this, the resulting
+/// Context instance will be associated with the GMainContext.
+class LOCATION_DLL_PUBLIC Context
+{
+public:
+    /// @brief Callback handles receiving of Service instances.
+    typedef std::function<void(const Service::Ptr&)> Callback;
+
+    /// @brief create_for_system_bus connects to a service instance
+    /// on the system bus.
+    static std::shared_ptr<Context> create_for_system_bus();
+
+    /// @brief create_for_session_bus connects to a service instance
+    /// on the session bus.
+    static std::shared_ptr<Context> create_for_session_bus();
+
+    /// @cond
+    Context(const Context&) = delete;
+    Context(Context&&) = delete;
+    virtual ~Context();
+    Context& operator=(const Context&) = delete;
+    Context& operator=(Context&&) = delete;
+    /// @endcond
+
+    /// @brief connect_to_service tries to establish a connection
+    /// to a service instance.
+    virtual void connect_to_service(const Callback& cb) = 0;
+
+protected:
+    /// @cond
+    Context();
+    /// @endcond
+};
+
+}  // namespace glib
+}  // namespace location
+
+#endif  // LOCATION_GLIB_CONTEXT_H_

=== modified file 'src/location/CMakeLists.txt'
--- src/location/CMakeLists.txt	2017-04-05 12:34:53 +0000
+++ src/location/CMakeLists.txt	2017-04-26 20:01:55 +0000
@@ -123,6 +123,7 @@
   events/reference_position_updated.cpp
   events/wifi_and_cell_id_reporting_state_changed.cpp
 
+  glib/context.cpp
   glib/holder.h
   glib/runtime.h
   glib/runtime.cpp

=== modified file 'src/location/cmds/monitor.cpp'
--- src/location/cmds/monitor.cpp	2017-03-07 10:01:34 +0000
+++ src/location/cmds/monitor.cpp	2017-04-26 20:01:55 +0000
@@ -55,7 +55,8 @@
     flag(cli::make_flag(cli::Name{"bus"}, cli::Description{"bus instance to connect to, defaults to system"}, bus));
     action([this](const Context& ctxt)
     {
-        glib::Runtime runtime;
+        glib::Runtime runtime{glib::Runtime::WithOwnMainLoop{}};
+        runtime.redirect_logging();
 
         location::dbus::stub::Service::create(bus, [this, &ctxt](const Result<location::dbus::stub::Service::Ptr>& result) mutable
         {

=== modified file 'src/location/cmds/provider.cpp'
--- src/location/cmds/provider.cpp	2017-03-07 10:01:34 +0000
+++ src/location/cmds/provider.cpp	2017-04-26 20:01:55 +0000
@@ -47,7 +47,8 @@
     {
         die_if(not id, ctxt.cout, "name of actual provider implementation is missing");
 
-        glib::Runtime runtime;
+        glib::Runtime runtime{glib::Runtime::WithOwnMainLoop{}};
+        runtime.redirect_logging();
 
         location::dbus::stub::Service::create(bus, [this](const location::Result<location::dbus::stub::Service::Ptr>& result)
         {

=== modified file 'src/location/cmds/run.cpp'
--- src/location/cmds/run.cpp	2017-03-23 12:32:38 +0000
+++ src/location/cmds/run.cpp	2017-04-26 20:01:55 +0000
@@ -49,7 +49,8 @@
     {
         account_for_lp1447110();
 
-        glib::Runtime runtime;
+        glib::Runtime runtime{glib::Runtime::WithOwnMainLoop{}};
+        runtime.redirect_logging();
 
         // The engine instance is the core piece of functionality.
         auto engine = std::make_shared<location::Engine>(

=== modified file 'src/location/cmds/status.cpp'
--- src/location/cmds/status.cpp	2017-03-07 10:01:34 +0000
+++ src/location/cmds/status.cpp	2017-04-26 20:01:55 +0000
@@ -58,7 +58,8 @@
     flag(cli::make_flag(cli::Name{"bus"}, cli::Description{"bus instance to connect to, defaults to system"}, bus));
     action([this](const Context& ctxt)
     {
-        location::glib::Runtime runtime;
+        glib::Runtime runtime{glib::Runtime::WithOwnMainLoop{}};
+        runtime.redirect_logging();
 
         location::dbus::stub::Service::create(bus, [this, &ctxt](const location::Result<location::dbus::stub::Service::Ptr>& result)
         {

=== added file 'src/location/glib/context.cpp'
--- src/location/glib/context.cpp	1970-01-01 00:00:00 +0000
+++ src/location/glib/context.cpp	2017-04-26 20:01:55 +0000
@@ -0,0 +1,64 @@
+/*
+ * Copyright © 2017 Canonical Ltd.
+ *
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License version 3,
+ * as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * Authored by: Thomas Voß <[e-mail]>
+ */
+
+#include <location/glib/context.h>
+
+#include <location/result.h>
+#include <location/dbus/stub/service.h>
+#include <location/glib/runtime.h>
+
+#include <thread>
+
+namespace
+{
+
+class Context : public location::glib::Context
+{
+public:
+    Context(location::dbus::Bus bus) : bus_{bus}
+    {
+    }
+
+    void connect_to_service(const Callback& cb) override
+    {
+        location::dbus::stub::Service::create(bus_, [this, cb](const location::Result<location::dbus::stub::Service::Ptr>& result)
+        {
+            if (result)
+                cb(result.value());
+        });
+    }
+
+private:
+    location::dbus::Bus bus_;
+    location::glib::Runtime runtime_;
+};
+
+}  // namespace
+
+std::shared_ptr<location::glib::Context> location::glib::Context::create_for_system_bus()
+{
+    return std::make_shared<::Context>(location::dbus::Bus::system);
+}
+
+std::shared_ptr<location::glib::Context> location::glib::Context::create_for_session_bus()
+{
+    return std::make_shared<::Context>(location::dbus::Bus::session);
+}
+
+location::glib::Context::~Context() = default;
+location::glib::Context::Context() = default;

=== modified file 'src/location/glib/runtime.cpp'
--- src/location/glib/runtime.cpp	2017-03-07 10:01:34 +0000
+++ src/location/glib/runtime.cpp	2017-04-26 20:01:55 +0000
@@ -88,36 +88,57 @@
 }
 
 location::glib::Runtime::Runtime()
+    : main_loop_{nullptr},
+      event_fd_{event_fd_or_throw()},
+      signal_fd_{-1},
+      event_fd_input_stream{make_shared_object(g_unix_input_stream_new(event_fd_, true))}
+{
+    g_input_stream_read_async(event_fd_input_stream.get(), &event_fd_buffer, sizeof(event_fd_buffer), G_PRIORITY_LOW,
+                              nullptr, Runtime::on_event_fd_read_finished, this);
+
+    runtime = this;
+}
+
+location::glib::Runtime::Runtime(WithOwnMainLoop)
     : main_loop_{g_main_loop_new(nullptr, false)},
       event_fd_{event_fd_or_throw()},
       signal_fd_{signal_fd_or_throw()},
       event_fd_input_stream{make_shared_object(g_unix_input_stream_new(event_fd_, true))},
       signal_fd_input_stream{make_shared_object(g_unix_input_stream_new(signal_fd_, true))}
 {
-    g_log_set_default_handler(handle_log_message, nullptr);
+    g_input_stream_read_async(event_fd_input_stream.get(), &event_fd_buffer, sizeof(event_fd_buffer), G_PRIORITY_LOW,
+                              nullptr, Runtime::on_event_fd_read_finished, this);
 
     g_input_stream_read_async(signal_fd_input_stream.get(), &signal_fd_buffer, sizeof(signal_fd_buffer), G_PRIORITY_LOW,
                               nullptr, Runtime::on_signal_fd_read_finished, this);
-    g_input_stream_read_async(event_fd_input_stream.get(), &event_fd_buffer, sizeof(event_fd_buffer), G_PRIORITY_LOW,
-                              nullptr, Runtime::on_event_fd_read_finished, this);
-
     runtime = this;
 }
 
 location::glib::Runtime::~Runtime()
 {
-    g_main_loop_unref(main_loop_);
+    if (main_loop_)
+        g_main_loop_unref(main_loop_);
     runtime = nullptr;
 }
 
+void location::glib::Runtime::redirect_logging()
+{
+    g_log_set_default_handler(handle_log_message, nullptr);
+}
+
 int location::glib::Runtime::run()
 {
+    if (!main_loop_)
+        throw std::runtime_error{"Missing main loop"};
     g_main_loop_run(main_loop_);
+
     return EXIT_SUCCESS;
 }
 
 void location::glib::Runtime::stop()
 {
+    if (!main_loop_)
+        throw std::runtime_error{"Missing main loop"};
     g_main_loop_quit(main_loop_);
 }
 

=== modified file 'src/location/glib/runtime.h'
--- src/location/glib/runtime.h	2017-03-04 21:43:23 +0000
+++ src/location/glib/runtime.h	2017-04-26 20:01:55 +0000
@@ -37,11 +37,18 @@
 class LOCATION_DLL_PUBLIC Runtime
 {
 public:
+    struct WithOwnMainLoop {};
+
     static Runtime* instance();
 
     Runtime();
+    explicit Runtime(WithOwnMainLoop);
     ~Runtime();
 
+    // redirect_logging interacts with the glib runtime
+    // to redirect logging to location::Logging facilities.
+    void redirect_logging();
+
     // executes the underlying event loop and blocks until
     // the runtime is stopped or a SIGINT/SIGTERM is delivered
     // to the application.

=== modified file 'tests/serializing_bus_test.cpp'
--- tests/serializing_bus_test.cpp	2017-03-04 21:43:23 +0000
+++ tests/serializing_bus_test.cpp	2017-04-26 20:01:55 +0000
@@ -52,7 +52,7 @@
 {
     using namespace ::testing;
 
-    location::glib::Runtime runtime;
+    location::glib::Runtime runtime{location::glib::Runtime::WithOwnMainLoop{}};
 
     auto sb = location::glib::SerializingBus::create();
     auto receiver = std::make_shared<NiceMock<MockEventReceiver>>();