Merge lp:~robertcarr/mir/demo-input-filters into lp:~mir-team/mir/trunk

[Robert Carr]

Add example demonstrating usage of input filters

Demonstrate usage of input filters.

There is a slight quirk in the static reference to the event filter list (would be nice to just return { event_filter }...see

https://bugs.launchpad.net/mir/+bug/1167133

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:569
http://jenkins.qa.ubuntu.com/job/mir-ci/352/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-android-raring-i386-build/338
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-clang-raring-amd64-build/221
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-quantal-amd64-ci/357
        deb: http://jenkins.qa.ubuntu.com/job/mir-quantal-amd64-ci/357/artifact/work/output/*zip*/output.zip

Click here to trigger a rebuild:
http://s-jenkins:8080/job/mir-ci/352/rebuild

review: Approve (continuous-integration)

[kevin gunn (kgunn72)]

really ?

+ * Authored by: Alan Griffiths <email address hidden>

[Robert Carr (robertcarr)]

Whoops!

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:570
http://jenkins.qa.ubuntu.com/job/mir-ci/353/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-android-raring-i386-build/340
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-clang-raring-amd64-build/223
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-quantal-amd64-ci/358
        deb: http://jenkins.qa.ubuntu.com/job/mir-quantal-amd64-ci/358/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-vm-ci-build/./distribution=precise,flavor=amd64/156

Click here to trigger a rebuild:
http://s-jenkins:8080/job/mir-ci/353/rebuild

review: Approve (continuous-integration)

[Daniel van Vugt (vanvugt)]

Sorry, my fault again...

/home/dan/bzr/mir/tmp.demo/examples/demo_input_filter.cpp: In member function ‘virtual bool {anonymous}::PrintingEventFilter::handles(const MirEvent&)’:
/home/dan/bzr/mir/tmp.demo/examples/demo_input_filter.cpp:39:81: error: ‘const union MirEvent’ has no member named ‘details’
/home/dan/bzr/mir/tmp.demo/examples/demo_input_filter.cpp:40:23: error: ‘const union MirEvent’ has no member named ‘details’
/home/dan/bzr/mir/tmp.demo/examples/demo_input_filter.cpp:40:58: error: ‘const union MirEvent’ has no member named ‘details’
/home/dan/bzr/mir/tmp.demo/examples/demo_input_filter.cpp:42:89: error: ‘const union MirEvent’ has no member named ‘details’
/home/dan/bzr/mir/tmp.demo/examples/demo_input_filter.cpp:43:23: error: ‘const union MirEvent’ has no member named ‘details’
/home/dan/bzr/mir/tmp.demo/examples/demo_input_filter.cpp:43:76: error: ‘const union MirEvent’ has no member named ‘details’
make[2]: *** [examples/CMakeFiles/mir_demo_input_filter.dir/demo_input_filter.cpp.o] Error 1
make[1]: *** [examples/CMakeFiles/mir_demo_input_filter.dir/all] Error 2

review: Needs Fixing

[Alexandros Frantzis (afrantzis)]

Nits:

68 + if (ev.type == mir_event_type_key)

It would be a bit cleaner to add curly braces around the multi-line statement that follows.

93 + std::shared_ptr<PrintingEventFilter> event_filter;

Can be const.

[Robert Carr (robertcarr)]

Trunk merged, MirEventUsage updated, Nits applied!

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:573
http://jenkins.qa.ubuntu.com/job/mir-ci/362/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-android-raring-i386-build/351
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-clang-raring-amd64-build/234
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-quantal-amd64-ci/367
        deb: http://jenkins.qa.ubuntu.com/job/mir-quantal-amd64-ci/367/artifact/work/output/*zip*/output.zip

Click here to trigger a rebuild:
http://s-jenkins:8080/job/mir-ci/362/rebuild

review: Approve (continuous-integration)

[Daniel van Vugt (vanvugt)]

I have no opinion until I get back to this, later. :)

review: Abstain

[Daniel van Vugt (vanvugt)]

OK, looks good.

If I had to nitpick then:

1. Use a consistent CMake syntax. I would recommend:
  add_executable (A
    B.cpp
    C.cpp
    D.cpp
  )
  target_link_libraries (A
    X
    Y
    Z
  )
Because the first argument/s is fixed and required. And subsequent arguments are often part of a variable-length list.

2. This style is confusing and potentially dangerous. Because it's less clear where the real end of the function will be:
  int main()
  try ()
  {
    return 0;
  }
  catch ()
  {
    return 1;
  }
  catch ()
  {
    return 1;
  }
  // There might be more...
  catch ()
  {
    ...
  }

I think it would be clearer as:
  int main()
  {
    int ret = 0;
    try ()
    {
    }
    catch ()
    {
      ret = 1;
    }
    catch ()
    {
      ret = 1;
    }
    return ret;
  }

But overall, it's nice and instructive to see a simple server in action.

review: Approve

[Alexandros Frantzis (afrantzis)]

Looks good.

review: Approve

[Robert Carr (robertcarr)]

Did some minor cmake cleanup :)

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:574
http://jenkins.qa.ubuntu.com/job/mir-ci/378/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-android-raring-i386-build/370
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-clang-raring-amd64-build/253
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-quantal-amd64-ci/383
        deb: http://jenkins.qa.ubuntu.com/job/mir-quantal-amd64-ci/383/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-vm-ci-build/./distribution=precise,flavor=amd64/168

Click here to trigger a rebuild:
http://s-jenkins:8080/job/mir-ci/378/rebuild

review: Approve (continuous-integration)

[PS Jenkins bot (ps-jenkins)]

FAILED: Autolanding.
More details in the following jenkins job:
http://jenkins.qa.ubuntu.com/job/mir-autolanding/146/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/mir-android-raring-i386-build/374/console
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-clang-raring-amd64-build/257
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-quantal-amd64-autolanding/147
        deb: http://jenkins.qa.ubuntu.com/job/mir-quantal-amd64-autolanding/147/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-vm-autolanding-build/./distribution=precise,flavor=amd64/41

review: Needs Fixing (continuous-integration)

[Kevin DuBois (kdub)]

jenkins fails with
keyserver.ubuntu.com: No route to host
?

[PS Jenkins bot (ps-jenkins)]

review: Approve (continuous-integration)

=== modified file 'examples/CMakeLists.txt'
--- examples/CMakeLists.txt	2013-04-01 16:45:07 +0000
+++ examples/CMakeLists.txt	2013-04-12 17:40:32 +0000
@@ -27,15 +27,11 @@
   eglapp
 )
 
-add_executable(
-  mir_demo_client
-
+add_executable(mir_demo_client
   demo_client.c
 )
 
-target_link_libraries(
-  mir_demo_client
-
+target_link_libraries(mir_demo_client
   mirclient
   mirprotobuf
 
@@ -44,15 +40,11 @@
   ${CMAKE_THREAD_LIBS_INIT}
 )
 
-add_executable(
-  mir_demo_client_unaccelerated
-
+add_executable(mir_demo_client_unaccelerated
   demo_client_unaccelerated.c
 )
 
-target_link_libraries(
-  mir_demo_client_unaccelerated
-
+target_link_libraries(mir_demo_client_unaccelerated
   mirclient
   mirprotobuf
 
@@ -61,15 +53,11 @@
   ${CMAKE_THREAD_LIBS_INIT}
 )
 
-add_executable(
-  mir_demo_client_accelerated
-
+add_executable(mir_demo_client_accelerated
   demo_client_accelerated.cpp
 )
 
-target_link_libraries(
-  mir_demo_client_accelerated
-
+target_link_libraries(mir_demo_client_accelerated
   mirdraw
   mirclient
   mirprotobuf
@@ -90,11 +78,11 @@
 )
 
 set(RENDER_TO_FB_SOURCES render_to_fb.cpp)
-add_executable(render_to_fb ${RENDER_TO_FB_SOURCES})
-
-target_link_libraries(
-    render_to_fb
-
+add_executable(render_to_fb 
+  ${RENDER_TO_FB_SOURCES}
+)
+
+target_link_libraries(render_to_fb
     mirserver
     mirlogging
     mirdraw
@@ -103,18 +91,25 @@
 
 set(RENDER_SURFACES_SOURCES render_surfaces.cpp buffer_render_target.cpp image_renderer.cpp)
 add_executable(render_surfaces ${RENDER_SURFACES_SOURCES})
-target_link_libraries(
-    render_surfaces
-
+target_link_libraries(render_surfaces
     mirserver
     mirshell
     ${Boost_LIBRARIES}
 )
 
+add_executable(mir_demo_input_filter
+  demo_input_filter.cpp
+)
+
+target_link_libraries(mir_demo_input_filter  
+  mirserver
+)
+
 set (DEMO_CLIENTS
   mir_demo_client
   mir_demo_client_unaccelerated
   mir_demo_client_accelerated
+  mir_demo_input_filter
   mir_eglflash
   mir_egltriangle
   mir_eglplasma

=== added file 'examples/demo_input_filter.cpp'
--- examples/demo_input_filter.cpp	1970-01-01 00:00:00 +0000
+++ examples/demo_input_filter.cpp	2013-04-12 17:40:32 +0000
@@ -0,0 +1,88 @@
+/*
+ * Copyright © 2013 Canonical Ltd.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU 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 General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * Authored by: Robert Carr <[e-mail]>
+ */
+
+#include "mir/run_mir.h"
+#include "mir/default_server_configuration.h"
+#include "mir/abnormal_exit.h"
+#include "mir/input/event_filter.h"
+
+#include <boost/exception/diagnostic_information.hpp>
+
+#include <iostream>
+
+namespace mi = mir::input;
+
+namespace
+{
+
+struct PrintingEventFilter : public mi::EventFilter
+{
+    bool handles(MirEvent const& ev) override
+    {
+        // TODO: Enhance printing
+        if (ev.type == mir_event_type_key)
+        {
+            std::cout << "Handling key event (time, scancode, keycode): " << ev.key.event_time << " " 
+                << ev.key.scan_code << " " << ev.key.key_code << std::endl;
+        }
+        else if (ev.type == mir_event_type_motion)
+        {
+            std::cout << "Handling motion event (time, pointer0_x, pointer0_y): " << ev.motion.event_time << " "
+                << ev.motion.pointer_coordinates[0].x << " " << ev.motion.pointer_coordinates[0].y << std::endl;
+        }
+        return true;
+    }
+};
+
+struct DemoServerConfiguration : public mir::DefaultServerConfiguration
+{
+    DemoServerConfiguration(int argc, char const* argv[])
+      : DefaultServerConfiguration(argc, argv),
+        event_filter(std::make_shared<PrintingEventFilter>())
+    {
+    }
+    
+    std::initializer_list<std::shared_ptr<mi::EventFilter> const> the_event_filters() override
+    {
+        static std::initializer_list<std::shared_ptr<mi::EventFilter> const> filter_list = { event_filter };
+        return filter_list;
+    }
+
+    std::shared_ptr<PrintingEventFilter> const event_filter;
+};
+
+}
+
+int main(int argc, char const* argv[])
+try
+{
+    DemoServerConfiguration config(argc, argv);
+
+    mir::run_mir(config, [](mir::DisplayServer&) {/* empty init */});
+    return 0;
+}
+catch (mir::AbnormalExit const& error)
+{
+    std::cerr << error.what() << std::endl;
+    return 1;
+}
+catch (std::exception const& error)
+{
+    std::cerr << "ERROR: " << boost::diagnostic_information(error) << std::endl;
+    return 1;
+}