Merge lp:~kdub/mir/publish-nbs-client-api into lp:mir

[Kevin DuBois]

publish the already-vetted headers for MirBuffer and MirPresentationChain for the 0.25 series.

publish the already-vetted headers for MirBuffer and MirPresentationChain for the 0.25 series.

[Mir CI Bot (mir-ci-bot)]

FAILED: Continuous integration, rev:3396
https://mir-jenkins.ubuntu.com/job/mir-ci/1247/
Executed test runs:
    FAILURE: https://mir-jenkins.ubuntu.com/job/build-mir/1455/console
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-0-fetch/1507
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=vivid+overlay/1498
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=xenial/1498
    FAILURE: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=clang,platform=mesa,release=vivid+overlay/1469/console
    FAILURE: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=xenial/1469/console
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=cross-armhf,compiler=gcc,platform=android,release=vivid+overlay/1469
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=cross-armhf,compiler=gcc,platform=android,release=vivid+overlay/1469/artifact/output/*zip*/output.zip
    FAILURE: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=android,release=vivid+overlay/1469/console
    FAILURE: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=mesa,release=xenial/1469/console

Click here to trigger a rebuild:
https://mir-jenkins.ubuntu.com/job/mir-ci/1247/rebuild

review: Needs Fixing (continuous-integration)

[Cemil Azizoglu (cemil-azizoglu)]

It's actually resubmit.

I don't think this should be published until we're fully done with the MirRenderSurface work.

review: Disapprove

[Kevin DuBois (kdub)]

Hmm, my understanding was that the 'MirRenderSurface' work would stack nicely on top of both the MirBufferStream and MirPresentationChain api. It would be good to get as many of the "NBS" headers out as possible in 0.25.

[Cemil Azizoglu (cemil-azizoglu)]

I don't have any concerns for NBS at the moment. Just being a bit cautious but like you said I'd like to see the MirRenderSurface actually be able to nicely fit on top of NBS.

[Chris Halse Rogers (raof)]

I'm reasonably certain that this won't conflict at all with MirRenderSurface. But there's plenty of room for my reasonable-certainties to be wrong ☺.

I'd be happy for this to land now, and equally happy to delay it until after MirRenderSurface.

[Kevin DuBois (kdub)]

Well, happy to change to WIP for now, but I think it would be good to work out the MirRenderSurface compatibility stuff so at least the NBS headers (and vulkan support) can be released in 0.25.

Unmerged revisions

3396. By Kevin DuBois on 2016-07-07

merge in mir, fix a conflict

3395. By Kevin DuBois on 2016-07-05

merge in mir, fix conflicts

3394. By Kevin DuBois on 2016-06-06

merge in mir

3393. By Kevin DuBois on 2016-05-17

merge mir, 1 conflict

3392. By Kevin DuBois on 2016-04-07

publish NBS client api

=== modified file 'examples/CMakeLists.txt'
--- examples/CMakeLists.txt	2016-06-02 05:33:50 +0000
+++ examples/CMakeLists.txt	2016-07-07 18:42:58 +0000
@@ -277,3 +277,20 @@
   eglapp
   ${Boost_LIBRARIES}
 )
+
+mir_add_wrapped_executable(mir_demo_client_prerendered_frames
+    mir_demo_client_prerendered_frames.c
+)
+
+target_link_libraries(mir_demo_client_prerendered_frames
+    mirclient
+    m
+)
+
+mir_add_wrapped_executable(mir_demo_client_chain_jumping_buffers
+    mir_demo_client_chain_jumping_buffers.c
+)
+
+target_link_libraries(mir_demo_client_chain_jumping_buffers
+    mirclient
+)

=== renamed file 'playground/mir_demo_client_chain_jumping_buffers.c' => 'examples/mir_demo_client_chain_jumping_buffers.c'
=== renamed file 'playground/mir_demo_client_prerendered_frames.c' => 'examples/mir_demo_client_prerendered_frames.c'
=== modified file 'include/client/mir_toolkit/client_types.h'
--- include/client/mir_toolkit/client_types.h	2016-06-03 03:38:40 +0000
+++ include/client/mir_toolkit/client_types.h	2016-07-07 18:42:58 +0000
@@ -47,6 +47,9 @@
 typedef struct MirPersistentId MirPersistentId;
 typedef struct MirBlob MirBlob;
 typedef struct MirDisplayConfig MirDisplayConfig;
+typedef struct MirPresentationChain MirPresentationChain;
+typedef struct MirBuffer MirBuffer;
+typedef void* MirNativeFence;
 typedef struct MirError MirError;
 
 
@@ -313,6 +316,13 @@
     mir_output_connection_state_unknown
 } MirOutputConnectionState;
 
+typedef enum MirBufferAccess
+{
+    mir_none,
+    mir_read,
+    mir_read_write,
+} MirBufferAccess;
+
 typedef struct MirDisplayMode
 {
     uint32_t vertical_resolution;
@@ -479,6 +489,22 @@
     MirError const* error,
     void* context);
 
+/**
+ * Callback called when a buffer is available for use.
+ *   \param [in]       buffer  The buffer that is availble
+ *   \param [in, out]  context The context provided by client
+ */
+typedef void (*mir_buffer_callback)(
+    MirBuffer* buffer, void* context);
+
+/**
+ * Callback called when a presentation chain is available 
+ *   \param [in]       chain   The chain that is availble
+ *   \param [in, out]  context The context provided by client
+ */
+typedef void (*mir_presentation_chain_callback)(
+    MirPresentationChain* chain, void* context);
+
 #ifdef __cplusplus
 }
 /**@}*/

=== renamed file 'src/include/client/mir_toolkit/mir_buffer.h' => 'include/client/mir_toolkit/mir_buffer.h'
--- src/include/client/mir_toolkit/mir_buffer.h	2016-07-05 12:40:56 +0000
+++ include/client/mir_toolkit/mir_buffer.h	2016-07-07 18:42:58 +0000
@@ -19,7 +19,7 @@
 #define MIR_TOOLKIT_MIR_BUFFER_H_
 
 #include <mir_toolkit/mir_native_buffer.h>
-#include <mir_toolkit/client_types_nbs.h>
+#include <mir_toolkit/client_types.h>
 
 #ifdef __cplusplus
 /**

=== renamed file 'src/include/client/mir_toolkit/mir_presentation_chain.h' => 'include/client/mir_toolkit/mir_presentation_chain.h'
--- src/include/client/mir_toolkit/mir_presentation_chain.h	2016-06-02 05:33:50 +0000
+++ include/client/mir_toolkit/mir_presentation_chain.h	2016-07-07 18:42:58 +0000
@@ -18,7 +18,7 @@
 #ifndef MIR_TOOLKIT_MIR_PRESENTATION_CHAIN_H_
 #define MIR_TOOLKIT_MIR_PRESENTATION_CHAIN_H_
 
-#include <mir_toolkit/client_types_nbs.h>
+#include <mir_toolkit/client_types.h>
 
 #ifdef __cplusplus
 /**

=== modified file 'playground/CMakeLists.txt'
--- playground/CMakeLists.txt	2016-06-07 18:17:41 +0000
+++ playground/CMakeLists.txt	2016-07-07 18:42:58 +0000
@@ -18,21 +18,3 @@
 )
 
 add_subdirectory(demo-shell/)
-
-set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -std=c99")
-mir_add_wrapped_executable(mir_demo_client_prerendered_frames
-    mir_demo_client_prerendered_frames.c
-)
-
-target_link_libraries(mir_demo_client_prerendered_frames
-    mirclient
-    m
-)
-
-mir_add_wrapped_executable(mir_demo_client_chain_jumping_buffers
-    mir_demo_client_chain_jumping_buffers.c
-)
-
-target_link_libraries(mir_demo_client_chain_jumping_buffers
-    mirclient
-)

=== modified file 'src/client/mir_connection.h'
--- src/client/mir_connection.h	2016-06-28 12:18:18 +0000
+++ src/client/mir_connection.h	2016-07-07 18:42:58 +0000
@@ -29,7 +29,7 @@
 #include "mir/frontend/surface_id.h"
 #include "mir/client_context.h"
 #include "mir_toolkit/mir_client_library.h"
-#include "mir_toolkit/client_types_nbs.h"
+#include "mir_toolkit/client_types.h"
 #include "mir_surface.h"
 #include "display_configuration.h"
 

=== modified file 'src/client/symbols.map'
--- src/client/symbols.map	2016-07-07 09:54:02 +0000
+++ src/client/symbols.map	2016-07-07 18:42:58 +0000
@@ -359,7 +359,36 @@
     };
 } MIR_CLIENT_DETAIL_9v19;
 
-MIR_CLIENT_DETAIL_private_buffer_semantics {
+MIR_CLIENT_DETAIL_0.24 {
+  global:
+    extern "C++" { 
+      mir::input::receiver::XKBMapper::XKBMapper*;
+      mir::input::receiver::XKBMapper::?XKBMapper*;
+      mir::input::receiver::XKBMapper::set_key_state*;
+      mir::input::receiver::XKBMapper::set_keymap*;
+      mir::input::receiver::XKBMapper::reset_keymap*;
+      mir::input::receiver::XKBMapper::map_event*;
+    };
+} MIR_CLIENT_DETAIL_0.21;
+
+MIR_CLIENT_0.24 {  # New functions in Mir 0.24
+  global:
+    mir_event_get_input_device_state_event;
+    mir_input_device_state_event_device_count;
+    mir_input_device_state_event_device_id;
+    mir_input_device_state_event_device_pointer_buttons;
+    mir_input_device_state_event_device_pointer_buttons;
+    mir_input_device_state_event_device_pressed_keys_count;
+    mir_input_device_state_event_device_pressed_keys;
+    mir_input_device_state_event_modifiers;
+    mir_input_device_state_event_pointer_axis;
+    mir_input_device_state_event_pointer_buttons;
+    mir_input_device_state_event_time;
+    mir_input_device_state_event_device_pointer_buttons;
+    mir_surface_spec_set_pointer_confinement;
+} MIR_CLIENT_0.22;
+
+MIR_CLIENT_0.25 { # New functions in Mir 0.25
   global:
     mir_buffer_get_fence;
     mir_buffer_associate_fence;
@@ -383,35 +412,4 @@
     mir_buffer_get_buffer_usage;
     mir_buffer_is_valid;
     mir_buffer_get_error_message;
-  local:
-    *;
-} MIR_CLIENT_DETAIL_9v19;
-
-MIR_CLIENT_DETAIL_0.24 {
-  global:
-    extern "C++" { 
-      mir::input::receiver::XKBMapper::XKBMapper*;
-      mir::input::receiver::XKBMapper::?XKBMapper*;
-      mir::input::receiver::XKBMapper::set_key_state*;
-      mir::input::receiver::XKBMapper::set_keymap*;
-      mir::input::receiver::XKBMapper::reset_keymap*;
-      mir::input::receiver::XKBMapper::map_event*;
-    };
-} MIR_CLIENT_DETAIL_0.21;
-
-MIR_CLIENT_0.24 {  # New functions in Mir 0.24
-  global:
-    mir_event_get_input_device_state_event;
-    mir_input_device_state_event_device_count;
-    mir_input_device_state_event_device_id;
-    mir_input_device_state_event_device_pointer_buttons;
-    mir_input_device_state_event_device_pointer_buttons;
-    mir_input_device_state_event_device_pressed_keys_count;
-    mir_input_device_state_event_device_pressed_keys;
-    mir_input_device_state_event_modifiers;
-    mir_input_device_state_event_pointer_axis;
-    mir_input_device_state_event_pointer_buttons;
-    mir_input_device_state_event_time;
-    mir_input_device_state_event_device_pointer_buttons;
-    mir_surface_spec_set_pointer_confinement;
-} MIR_CLIENT_0.22;
+} MIR_CLIENT_0.24;

=== modified file 'src/include/client/mir/client_buffer.h'
--- src/include/client/mir/client_buffer.h	2016-05-03 06:55:25 +0000
+++ src/include/client/mir/client_buffer.h	2016-07-07 18:42:58 +0000
@@ -20,7 +20,7 @@
 #ifndef MIR_CLIENT_CLIENT_BUFFER_H_
 #define MIR_CLIENT_CLIENT_BUFFER_H_
 
-#include <mir_toolkit/client_types_nbs.h>
+#include <mir_toolkit/client_types.h>
 #include <mir_toolkit/mir_native_buffer.h>
 #include "mir/graphics/native_buffer.h"
 #include "mir_toolkit/common.h"

=== removed file 'src/include/client/mir_toolkit/client_types_nbs.h'
--- src/include/client/mir_toolkit/client_types_nbs.h	2016-06-02 05:33:50 +0000
+++ src/include/client/mir_toolkit/client_types_nbs.h	1970-01-01 00:00:00 +0000
@@ -1,50 +0,0 @@
-/*
- * Copyright © 2016 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/>.
- *
- */
-
-#ifndef MIR_TOOLKIT_CLIENT_TYPES_NBS_H_
-#define MIR_TOOLKIT_CLIENT_TYPES_NBS_H_
-
-#include <mir_toolkit/client_types.h>
-
-#ifdef __cplusplus
-/**
- * \defgroup mir_toolkit MIR graphics tools API
- * @{
- */
-extern "C" {
-#endif
-
-/* NOTE: this file will be rolled into mir_toolkit/client_types.h when made public. */
-typedef struct MirPresentationChain MirPresentationChain;
-typedef struct MirBuffer MirBuffer;
-typedef void* MirNativeFence;
-
-typedef void (*mir_buffer_callback)(MirBuffer*, void* context);
-typedef void (*mir_presentation_chain_callback)(MirPresentationChain*, void* context);
-typedef enum MirBufferAccess
-{
-    mir_none,
-    mir_read,
-    mir_read_write,
-} MirBufferAccess;
-
-#ifdef __cplusplus
-}
-/**@}*/
-#endif
-
-#endif /* MIR_TOOLKIT_CLIENT_TYPES_NBS_H_ */

=== modified file 'tests/acceptance-tests/CMakeLists.txt'
--- tests/acceptance-tests/CMakeLists.txt	2016-06-27 15:03:55 +0000
+++ tests/acceptance-tests/CMakeLists.txt	2016-07-07 18:42:58 +0000
@@ -56,6 +56,7 @@
   test_surface_raise.cpp
   test_client_cookie.cpp
   test_new_display_configuration.cpp
+  test_presentation_chain.cpp
   test_persistent_surface_store.cpp
 )
 

=== renamed file 'tests/acceptance-tests/throwback/test_presentation_chain.cpp' => 'tests/acceptance-tests/test_presentation_chain.cpp'
=== modified file 'tests/acceptance-tests/throwback/CMakeLists.txt'
--- tests/acceptance-tests/throwback/CMakeLists.txt	2016-05-03 06:55:25 +0000
+++ tests/acceptance-tests/throwback/CMakeLists.txt	2016-07-07 18:42:58 +0000
@@ -10,6 +10,4 @@
   test_client_cursor_api.cpp     # uses BasicWindowManager<>
   test_client_library_errors.cpp # uses UsingClientPlatform
   test_shell_control_of_surface_configuration.cpp # uses CanonicalWindowManager
-
-  test_presentation_chain.cpp
 )