=== modified file 'client-ABI-sha1sums' --- client-ABI-sha1sums 2014-10-21 16:21:14 +0000 +++ client-ABI-sha1sums 2014-10-23 13:30:17 +0000 @@ -1,4 +1,4 @@ -cbe1e3ccfea6ab5865510f4f598ec11571fcc852 include/client/mir_toolkit/mir_client_library_debug.h +3a60fb3b2b250ca67f54ade346ef658c9259c9a7 include/client/mir_toolkit/debug/surface.h b53736bcb22ddc09aab8275cfdd05c109fdd0f12 include/client/mir_toolkit/mir_client_library_drm.h 1522a5fcdb01c0d9a990364539c4f1255853eef7 include/client/mir_toolkit/mir_client_library.h e6185b680533c5fdcf1294a4797d5c3dd01d433f include/client/mir_toolkit/mir_connection.h === modified file 'debian/control' --- debian/control 2014-10-21 17:22:26 +0000 +++ debian/control 2014-10-23 13:30:17 +0000 @@ -165,6 +165,52 @@ . Contains header files required to develop against Mir. +Package: libmirclient-debug-extension1 +Section: libs +Architecture: i386 amd64 armhf arm64 +Multi-Arch: same +Pre-Depends: ${misc:Pre-Depends} +Depends: ${misc:Depends}, + ${shlibs:Depends}, +Description: Display server for Ubuntu - optional client debug interfaces + Mir is a display server running on linux systems, with a focus on efficiency, + robust operation and a well-defined driver model. + . + This package contains both a shared library containing the client side of + various optional debugging interfaces and the development headers required + to use them. + . + This is primarily useful for developing Mir servers, low-level client + toolkits, or for automated testing in constrained environments. + . + Not all Mir servers have the capability to service these APIs; end-user + applications SHOULD NOT depend on this library. + +Package: libmirclient-debug-extension-dev +Section: libdevel +Architecture: i386 amd64 armhf arm64 +Multi-Arch: same +Pre-Depends: ${misc:Pre-Depends} +Depends: libmirclient-debug-extension1 (= ${binary:Version}) + ${misc:Depends}, + ${shlibs:Depends}, +Description: Display server for Ubuntu - client debug interface headers + Mir is a display server running on linux systems, with a focus on efficiency, + robust operation and a well-defined driver model. + . + This package contains both a shared library containing the client side of + various optional debugging interfaces and the development headers required + to use them. + . + This is primarily useful for developing Mir servers, low-level client + toolkits, or for automated testing in constrained environments. + . + Not all Mir servers have the capability to service these APIs; end-user + applications SHOULD NOT depend on this library. + . + This package contains the development headers required to develop against + the debug extensions. + Package: mir-demos Architecture: i386 amd64 armhf arm64 Depends: ${misc:Depends}, === added file 'debian/libmirclient-debug-extension-dev.install' --- debian/libmirclient-debug-extension-dev.install 1970-01-01 00:00:00 +0000 +++ debian/libmirclient-debug-extension-dev.install 2014-10-23 13:30:17 +0000 @@ -0,0 +1,3 @@ +usr/include/mirclient/mir_toolkit/debug +usr/lib/*/pkgconfig/mirclient-debug-extension.pc +usr/lib/*/libmirclient-debug-extension.so === added file 'debian/libmirclient-debug-extension1.install' --- debian/libmirclient-debug-extension1.install 1970-01-01 00:00:00 +0000 +++ debian/libmirclient-debug-extension1.install 2014-10-23 13:30:17 +0000 @@ -0,0 +1,1 @@ +usr/lib/*/libmirclient-debug-extension.so.* === modified file 'debian/libmirclient-dev.install' --- debian/libmirclient-dev.install 2013-06-24 12:15:28 +0000 +++ debian/libmirclient-dev.install 2014-10-23 13:30:17 +0000 @@ -1,3 +1,3 @@ -usr/include/mirclient +usr/include/mirclient/mir_toolkit/*.h usr/lib/*/pkgconfig/mirclient.pc usr/lib/*/libmirclient.so === added directory 'include/client/mir_toolkit/debug' === renamed file 'include/client/mir_toolkit/mir_client_library_debug.h' => 'include/client/mir_toolkit/debug/surface.h' --- include/client/mir_toolkit/mir_client_library_debug.h 2014-10-01 06:25:56 +0000 +++ include/client/mir_toolkit/debug/surface.h 2014-10-23 13:30:17 +0000 @@ -28,6 +28,7 @@ /** * Return the ID of a surface (only useful for debug output). + * \pre The surface is valid * \param [in] surface The surface * \return An internal ID that identifies the surface */ @@ -43,6 +44,25 @@ */ uint32_t mir_debug_surface_current_buffer_id(MirSurface *surface); +/** + * Get the screen coordinates corresponding to a pair of surface coordinates + * \pre The surface is valid + * \param [in] surface The surface + * \param [in] x, y Surface coordinates to map to screen coordinates + * \param [out] screen_x, screen_y The screen coordinates corresponding to x, y. + * \return True if screen_x and screen_y contain values + * \note There are many cases where such a mapping does not exist or would be expensive + * to calculate. Only Mir servers started with the --debug option will ever return + * values for this call, and even when --debug is enabled servers are free to + * return nothing. + * + * This call will only be interesting for automated testing, where both the client + * and shell state is known and constrained. + */ +MirBool mir_debug_surface_coords_to_screen(MirSurface* surface, + int x, int y, + int* screen_x, int* screen_y); + #ifdef __cplusplus } #endif === modified file 'include/platform/mir/options/configuration.h' --- include/platform/mir/options/configuration.h 2014-10-01 06:25:56 +0000 +++ include/platform/mir/options/configuration.h 2014-10-23 13:30:17 +0000 @@ -43,6 +43,7 @@ extern char const* const frontend_threads_opt; extern char const* const touchspots_opt; extern char const* const fatal_abort_opt; +extern char const* const debug_opt; extern char const* const name_opt; extern char const* const offscreen_opt; === modified file 'include/server/mir/default_server_configuration.h' --- include/server/mir/default_server_configuration.h 2014-10-22 18:55:40 +0000 +++ include/server/mir/default_server_configuration.h 2014-10-23 13:30:17 +0000 @@ -101,6 +101,7 @@ class SceneReport; class PromptSessionListener; class PromptSessionManager; +class CoordinateTranslator; } namespace graphics { @@ -286,6 +287,7 @@ * @{ */ // To customize this behaviour it is recommended you override wrap_session_coordinator(). virtual std::shared_ptr the_session_coordinator(); + virtual std::shared_ptr the_coordinate_translator(); /** @} */ @@ -421,6 +423,7 @@ CachedPtr prompt_session_listener; CachedPtr prompt_session_manager; CachedPtr session_coordinator; + CachedPtr coordinate_translator; CachedPtr emergency_cleanup; CachedPtr host_lifecycle_event_listener; === added file 'include/server/mir/scene/coordinate_translator.h' --- include/server/mir/scene/coordinate_translator.h 1970-01-01 00:00:00 +0000 +++ include/server/mir/scene/coordinate_translator.h 2014-10-23 13:30:17 +0000 @@ -0,0 +1,66 @@ +/* + * Copyright © 2014 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 . + * + * Authored by: Christopher James Halse Rogers + */ + +#ifndef MIR_SCENE_COORDINATE_TRANSLATOR_H_ +#define MIR_SCENE_COORDINATE_TRANSLATOR_H_ + +#include "mir/geometry/point.h" +#include + +namespace mir +{ +namespace frontend +{ +class Surface; +} + +namespace scene +{ + +/** + * Support for the debug "surface to screen" coordinate translation interface. + * \note For shells which do surface transformations the default implementation + * will return incorrect results. + */ +class CoordinateTranslator +{ +public: + virtual ~CoordinateTranslator() = default; + + /** + * \brief Translate a surface coordinate into the screen coordinate space + * \param [in] surface A frontend::Surface. This will need to be dynamic_cast into + * the scene::Surface relevant for the shell. + * \param [in] x, y Coordinates to translate from the surface coordinate space + * \return The coordinates in the screen coordinate space. + * \throws A std::runtime_error if the translation cannot be performed + * for any reason. + * + * \note It is acceptable for this call to unconditionally throw a std::runtime_error. + * It is not required for normal functioning of the server or clients; clients which + * use the debug extension will receive an appropriate failure notice. + */ + virtual geometry::Point surface_to_screen(std::shared_ptr surface, + int32_t x, int32_t y) = 0; +}; + + +} +} + +#endif // MIR_SCENE_COORDINATE_TRANSLATOR_H_ === modified file 'platform-ABI-sha1sums' --- platform-ABI-sha1sums 2014-10-21 16:21:14 +0000 +++ platform-ABI-sha1sums 2014-10-23 13:30:17 +0000 @@ -40,7 +40,7 @@ 1fbe488b4581486fd01e2f03e504f31b72c09040 include/platform/mir/graphics/platform_ipc_operations.h 9c7712af84b6fde1970ff802ad2ea78f892c7b7e include/platform/mir/graphics/platform_ipc_package.h 84c063346b3bd51b4624d9f940008d4c3f8be066 include/platform/mir/graphics/renderable.h -f5746dab3336266cfd410ce4e4d01333df6e5b99 include/platform/mir/options/configuration.h +b19329d35a55f640edd72c0a953908995211d97e include/platform/mir/options/configuration.h 47007c783c174f8e94d332c4b13c6b01358b48fb include/platform/mir/options/default_configuration.h b45f14082c4f8b29efaa1b13de795dcb29deb738 include/platform/mir/options/option.h 3c37cc31e8b290b89c311d82f02e07d342766451 include/platform/mir/options/program_option.h === modified file 'server-ABI-sha1sums' --- server-ABI-sha1sums 2014-10-22 18:55:40 +0000 +++ server-ABI-sha1sums 2014-10-23 13:30:17 +0000 @@ -40,7 +40,7 @@ 1fbe488b4581486fd01e2f03e504f31b72c09040 include/platform/mir/graphics/platform_ipc_operations.h 9c7712af84b6fde1970ff802ad2ea78f892c7b7e include/platform/mir/graphics/platform_ipc_package.h 84c063346b3bd51b4624d9f940008d4c3f8be066 include/platform/mir/graphics/renderable.h -f5746dab3336266cfd410ce4e4d01333df6e5b99 include/platform/mir/options/configuration.h +b19329d35a55f640edd72c0a953908995211d97e include/platform/mir/options/configuration.h 47007c783c174f8e94d332c4b13c6b01358b48fb include/platform/mir/options/default_configuration.h b45f14082c4f8b29efaa1b13de795dcb29deb738 include/platform/mir/options/option.h 3c37cc31e8b290b89c311d82f02e07d342766451 include/platform/mir/options/program_option.h @@ -48,7 +48,7 @@ a9f284ba4b05d58fd3eeb628d1f56fe4ac188526 include/server/mir/compositor/compositor_id.h 878ab5c4007d16dac213a3eb0105421d8ffad206 include/server/mir/compositor/scene_element.h 4fcf34e424128b87ddc76733594e32e09ebbd486 include/server/mir/compositor/scene.h -7e47baf423fc61960d8e4ea92eae93caf71c93e2 include/server/mir/default_server_configuration.h +c14448c8f882f44b05fa56ced7c8db51083a9bd3 include/server/mir/default_server_configuration.h af1ff0714be973ac76d56006a2e5991f68cd1dec include/server/mir/display_server.h a35c5495d8fd28fc0e375b17495fc5caab51b329 include/server/mir/emergency_cleanup.h 938de641cb0e01e1098b007b39b151a7dfe4adc1 include/server/mir/frontend/display_changer.h @@ -75,6 +75,7 @@ 964069b241f1e8211386bb8735ee0f752b666949 include/server/mir/main_loop.h edd5a0a6be0be57ef64c5af89fc5a65dc558648c include/server/mir/report_exception.h 8192727cf5fa0b2b5798b2211c2c8a4ad65c9f60 include/server/mir/run_mir.h +c9de8b851fb22092a9a486d71cd998b4cb8392e1 include/server/mir/scene/coordinate_translator.h 71d9082681aa39d652c88ad3b54665695b521d24 include/server/mir/scene/depth_id.h 4e4e563ab429a13ddca7eead16f2b6cefb8edff6 include/server/mir/scene/null_surface_observer.h d5273f3363b0b776427d5e3f1af99f0f2bcf3fa6 include/server/mir/scene/observer.h === modified file 'src/client/CMakeLists.txt' --- src/client/CMakeLists.txt 2014-10-21 16:21:14 +0000 +++ src/client/CMakeLists.txt 2014-10-23 13:30:17 +0000 @@ -8,12 +8,18 @@ set(PREFIX "${CMAKE_INSTALL_PREFIX}") set(EXEC_PREFIX "${CMAKE_INSTALL_PREFIX}") set(LIBDIR "${CMAKE_INSTALL_FULL_LIBDIR}") -set(INCLUDEDIR "${CMAKE_INSTALL_PREFIX}/include/mirclient") -set(COMMON_INCLUDEDIR "${CMAKE_INSTALL_PREFIX}/include/mircommon") +set(INCLUDEDIR "${CMAKE_INSTALL_PREFIX}/include") configure_file( ${CMAKE_CURRENT_SOURCE_DIR}/mirclient.pc.in ${CMAKE_CURRENT_BINARY_DIR}/mirclient.pc + @ONLY +) + +configure_file( + ${CMAKE_CURRENT_SOURCE_DIR}/mirclient-debug-extension.pc.in + ${CMAKE_CURRENT_BINARY_DIR}/mirclient-debug-extension.pc + @ONLY ) include_directories( @@ -113,3 +119,47 @@ FILES ${CMAKE_CURRENT_BINARY_DIR}/mirclient.pc DESTINATION ${CMAKE_INSTALL_LIBDIR}/pkgconfig ) + +# TODO: Extension apparatus so that mirclient-debug-extension can be a MODULE and not +# duplicate (almost) the entirity of mirclient + +set(MIRCLIENT_DEBUG_EXTENSION_ABI 1) + +add_library( + mirclient-debug-extension SHARED + + mir_debug_api.cpp + $ +) + +target_link_libraries( + mirclient-debug-extension + + mirclient +) + +set(debug_symbol_map ${CMAKE_CURRENT_SOURCE_DIR}/symbols-debug.map) + +set_target_properties( + mirclient-debug-extension + + PROPERTIES + SOVERSION ${MIRCLIENT_DEBUG_EXTENSION_ABI} + LINK_FLAGS "-Wl,--version-script,${debug_symbol_map}" +) + +install( + DIRECTORY ${CMAKE_SOURCE_DIR}/include/client/mir_toolkit/debug + DESTINATION "include/mirclient/mir_toolkit/debug" +) + +install( + TARGETS mirclient-debug-extension + LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR} + ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR}) + +install( + FILES ${CMAKE_CURRENT_BINARY_DIR}/mirclient-debug-extension.pc + DESTINATION ${CMAKE_INSTALL_LIBDIR}/pkgconfig +) + === modified file 'src/client/mir_connection.cpp' --- src/client/mir_connection.cpp 2014-10-01 06:25:56 +0000 +++ src/client/mir_connection.cpp 2014-10-23 13:30:17 +0000 @@ -87,6 +87,7 @@ deregisterer{this}, channel(), server(0), + debug(0), error_message(error_message) { } @@ -97,6 +98,7 @@ platform_library{conf.the_platform_library()}, channel(conf.the_rpc_channel()), server(channel.get(), ::google::protobuf::Service::STUB_DOESNT_OWN_CHANNEL), + debug(channel.get(), ::google::protobuf::Service::STUB_DOESNT_OWN_CHANNEL), logger(conf.the_logger()), client_platform_factory(conf.the_client_platform_factory()), input_platform(conf.the_input_platform()), @@ -133,7 +135,7 @@ mir_surface_callback callback, void * context) { - auto surface = new MirSurface(this, server, platform->create_buffer_factory(), input_platform, params, callback, context); + auto surface = new MirSurface(this, server, &debug, platform->create_buffer_factory(), input_platform, params, callback, context); return surface->get_create_wait_handle(); } === modified file 'src/client/mir_connection.h' --- src/client/mir_connection.h 2014-10-01 06:25:56 +0000 +++ src/client/mir_connection.h 2014-10-23 13:30:17 +0000 @@ -149,6 +149,7 @@ std::shared_ptr const channel; mir::protobuf::DisplayServer::Stub server; + mir::protobuf::Debug::Stub debug; std::shared_ptr const logger; mir::protobuf::Void void_response; mir::protobuf::Connection connect_result; === added file 'src/client/mir_debug_api.cpp' --- src/client/mir_debug_api.cpp 1970-01-01 00:00:00 +0000 +++ src/client/mir_debug_api.cpp 2014-10-23 13:30:17 +0000 @@ -0,0 +1,39 @@ +/* + * Copyright © 2014 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 . + * + * Authored by: Christopher James Halse Rogers + */ + +#include "mir_toolkit/debug/surface.h" + +#include "mir_surface.h" + +uint32_t mir_debug_surface_current_buffer_id(MirSurface* surface) +{ + return surface->get_current_buffer_id(); +} + +int mir_debug_surface_id(MirSurface* surface) +{ + return surface->id(); +} + +MirBool mir_debug_surface_coords_to_screen(MirSurface* surface, + int x, int y, + int* screen_x, int* screen_y) +{ + return surface->translate_to_screen_coordinates(x, y, screen_x, screen_y) ? + mir_true : mir_false ; +} === modified file 'src/client/mir_surface.cpp' --- src/client/mir_surface.cpp 2014-10-21 16:21:14 +0000 +++ src/client/mir_surface.cpp 2014-10-23 13:30:17 +0000 @@ -51,7 +51,27 @@ std::shared_ptr const& input_platform, MirSurfaceParameters const & params, mir_surface_callback callback, void * context) + : MirSurface(allocating_connection, + server, + nullptr, + factory, + input_platform, + params, + callback, context) +{ +} + + +MirSurface::MirSurface( + MirConnection *allocating_connection, + mp::DisplayServer::Stub & server, + mp::Debug::Stub* debug, + std::shared_ptr const& factory, + std::shared_ptr const& input_platform, + MirSurfaceParameters const & params, + mir_surface_callback callback, void * context) : server(server), + debug{debug}, connection(allocating_connection), buffer_depository(std::make_shared(factory, mir::frontend::client_buffer_cache_size)), input_platform(input_platform) @@ -373,6 +393,49 @@ return &configure_wait_handle; } +namespace +{ +void signal_response_received(MirWaitHandle* handle) +{ + handle->result_received(); +} +} + +bool MirSurface::translate_to_screen_coordinates(int x, int y, + int *screen_x, int *screen_y) +{ + if (!debug) + { + return false; + } + + mp::CoordinateTranslationRequest request; + + request.set_x(x); + request.set_y(y); + *request.mutable_surfaceid() = surface.id(); + mp::CoordinateTranslationResponse response; + + MirWaitHandle signal; + signal.expect_result(); + + { + std::lock_guard lock(mutex); + + debug->translate_surface_to_screen( + nullptr, + &request, + &response, + google::protobuf::NewCallback(&signal_response_received, &signal)); + } + + signal.wait_for_one(); + + *screen_x = response.x(); + *screen_y = response.y(); + return !response.has_error(); +} + void MirSurface::on_configured() { std::lock_guard lock(mutex); === modified file 'src/client/mir_surface.h' --- src/client/mir_surface.h 2014-10-21 16:21:14 +0000 +++ src/client/mir_surface.h 2014-10-23 13:30:17 +0000 @@ -62,6 +62,15 @@ MirSurface( MirConnection *allocating_connection, mir::protobuf::DisplayServer::Stub & server, + mir::protobuf::Debug::Stub* debug, + std::shared_ptr const& buffer_factory, + std::shared_ptr const& input_platform, + MirSurfaceParameters const& params, + mir_surface_callback callback, void * context); + + MirSurface( + MirConnection *allocating_connection, + mir::protobuf::DisplayServer::Stub & server, std::shared_ptr const& buffer_factory, std::shared_ptr const& input_platform, MirSurfaceParameters const& params, @@ -87,6 +96,11 @@ EGLNativeWindowType generate_native_window(); MirWaitHandle* configure(MirSurfaceAttrib a, int value); + + // TODO: Some sort of extension mechanism so that this can be moved + // out into a separate class in the libmirclient-debug DSO. + bool translate_to_screen_coordinates(int x, int y, + int* screen_x, int* screen_y); // Non-blocking int attrib(MirSurfaceAttrib a) const; @@ -115,7 +129,8 @@ MirPixelFormat convert_ipc_pf_to_geometry(google::protobuf::int32 pf); void release_cpu_region(); - mir::protobuf::DisplayServer::Stub & server; + mir::protobuf::DisplayServer::Stub& server; + mir::protobuf::Debug::Stub* debug; mir::protobuf::Surface surface; mir::protobuf::BufferRequest buffer_request; std::string error_message; === modified file 'src/client/mir_surface_api.cpp' --- src/client/mir_surface_api.cpp 2014-10-01 06:25:56 +0000 +++ src/client/mir_surface_api.cpp 2014-10-23 13:30:17 +0000 @@ -18,7 +18,6 @@ #include "mir_toolkit/mir_surface.h" #include "mir_toolkit/mir_wait.h" -#include "mir_toolkit/mir_client_library_debug.h" #include "mir_connection.h" #include "mir_surface.h" @@ -152,9 +151,9 @@ nullptr)); } -int mir_surface_get_id(MirSurface* surface) +int mir_surface_get_id(MirSurface* /*surface*/) { - return mir_debug_surface_id(surface); + return 0; } MirWaitHandle* mir_surface_set_type(MirSurface* surf, === added file 'src/client/mirclient-debug-extension.pc.in' --- src/client/mirclient-debug-extension.pc.in 1970-01-01 00:00:00 +0000 +++ src/client/mirclient-debug-extension.pc.in 2014-10-23 13:30:17 +0000 @@ -0,0 +1,11 @@ +prefix=@PREFIX@ +exec_prefix=@EXEC_PREFIX@ +libdir=@LIBDIR@ +includedir=@INCLUDEDIR@/mirclient-debug +common_includedir=@INCLUDEDIR@/mircommon + +Name: mirclient-debug +Description: Mir client debug library +Version: @MIR_VERSION@ +Libs: -L${libdir} -lmirclient-debug +Cflags: -I${includedir} -I${common_includedir} === modified file 'src/client/mirclient.pc.in' --- src/client/mirclient.pc.in 2014-10-01 06:25:56 +0000 +++ src/client/mirclient.pc.in 2014-10-23 13:30:17 +0000 @@ -1,11 +1,13 @@ prefix=@PREFIX@ exec_prefix=@EXEC_PREFIX@ libdir=@LIBDIR@ -includedir=@INCLUDEDIR@ +includedir=@INCLUDEDIR@/mirclient +common_includedir=@INCLUDEDIR@/mircommon + Name: mirclient Description: Mir client library Version: @MIR_VERSION@ Requires.private: protobuf >= 2.4.1 -Libs: -L@LIBDIR@ -lmirclient -Cflags: -I@INCLUDEDIR@ -I@COMMON_INCLUDEDIR@ +Libs: -L${libdir} -lmirclient +Cflags: -I${includedir} -I${common_includedir} === added file 'src/client/symbols-debug.map' --- src/client/symbols-debug.map 1970-01-01 00:00:00 +0000 +++ src/client/symbols-debug.map 2014-10-23 13:30:17 +0000 @@ -0,0 +1,5 @@ +{ + global: + mir_debug_*; + local: *; +}; === modified file 'src/common/protobuf/mir_protobuf.proto' --- src/common/protobuf/mir_protobuf.proto 2014-10-21 16:21:14 +0000 +++ src/common/protobuf/mir_protobuf.proto 2014-10-23 13:30:17 +0000 @@ -228,3 +228,20 @@ rpc stop_prompt_session(Void) returns (Void); rpc exchange_buffer(BufferRequest) returns (Buffer); } + +message CoordinateTranslationRequest { + required SurfaceId surfaceid = 1; + required int32 x = 2; + required int32 y = 3; +} + +message CoordinateTranslationResponse { + optional int32 x = 1; + optional int32 y = 2; + + optional string error = 127; +} + +service Debug { + rpc translate_surface_to_screen(CoordinateTranslationRequest) returns (CoordinateTranslationResponse); +} === modified file 'src/common/symbols.map' --- src/common/symbols.map 2014-10-21 16:21:14 +0000 +++ src/common/symbols.map 2014-10-23 13:30:17 +0000 @@ -143,6 +143,42 @@ mir::protobuf::ConnectParameters::SerializeWithCachedSizes*; mir::protobuf::ConnectParameters::SerializeWithCachedSizesToArray*; mir::protobuf::ConnectParameters::Swap*; + mir::protobuf::CoordinateTranslationRequest::ByteSize*; + mir::protobuf::CoordinateTranslationRequest::Clear*; + mir::protobuf::CoordinateTranslationRequest::?CoordinateTranslationRequest*; + mir::protobuf::CoordinateTranslationRequest::CoordinateTranslationRequest*; + mir::protobuf::CoordinateTranslationRequest::CopyFrom*; + mir::protobuf::CoordinateTranslationRequest::default_instance*; + mir::protobuf::CoordinateTranslationRequest::descriptor*; + mir::protobuf::CoordinateTranslationRequest::GetMetadata*; + mir::protobuf::CoordinateTranslationRequest::IsInitialized*; + mir::protobuf::CoordinateTranslationRequest::kSurfaceidFieldNumber*; + mir::protobuf::CoordinateTranslationRequest::kXFieldNumber*; + mir::protobuf::CoordinateTranslationRequest::kYFieldNumber*; + mir::protobuf::CoordinateTranslationRequest::MergeFrom*; + mir::protobuf::CoordinateTranslationRequest::MergePartialFromCodedStream*; + mir::protobuf::CoordinateTranslationRequest::New*; + mir::protobuf::CoordinateTranslationRequest::SerializeWithCachedSizes*; + mir::protobuf::CoordinateTranslationRequest::SerializeWithCachedSizesToArray*; + mir::protobuf::CoordinateTranslationRequest::Swap*; + mir::protobuf::CoordinateTranslationResponse::ByteSize*; + mir::protobuf::CoordinateTranslationResponse::Clear*; + mir::protobuf::CoordinateTranslationResponse::?CoordinateTranslationResponse*; + mir::protobuf::CoordinateTranslationResponse::CoordinateTranslationResponse*; + mir::protobuf::CoordinateTranslationResponse::CopyFrom*; + mir::protobuf::CoordinateTranslationResponse::default_instance*; + mir::protobuf::CoordinateTranslationResponse::descriptor*; + mir::protobuf::CoordinateTranslationResponse::GetMetadata*; + mir::protobuf::CoordinateTranslationResponse::IsInitialized*; + mir::protobuf::CoordinateTranslationResponse::kErrorFieldNumber*; + mir::protobuf::CoordinateTranslationResponse::kXFieldNumber*; + mir::protobuf::CoordinateTranslationResponse::kYFieldNumber*; + mir::protobuf::CoordinateTranslationResponse::MergeFrom*; + mir::protobuf::CoordinateTranslationResponse::MergePartialFromCodedStream*; + mir::protobuf::CoordinateTranslationResponse::New*; + mir::protobuf::CoordinateTranslationResponse::SerializeWithCachedSizes*; + mir::protobuf::CoordinateTranslationResponse::SerializeWithCachedSizesToArray*; + mir::protobuf::CoordinateTranslationResponse::Swap*; mir::protobuf::CursorSetting::ByteSize*; mir::protobuf::CursorSetting::Clear*; mir::protobuf::CursorSetting::CopyFrom*; @@ -160,6 +196,16 @@ mir::protobuf::CursorSetting::SerializeWithCachedSizes*; mir::protobuf::CursorSetting::SerializeWithCachedSizesToArray*; mir::protobuf::CursorSetting::Swap*; + mir::protobuf::Debug::CallMethod*; + mir::protobuf::Debug::?Debug*; + mir::protobuf::Debug::descriptor*; + mir::protobuf::Debug::GetDescriptor*; + mir::protobuf::Debug::GetRequestPrototype*; + mir::protobuf::Debug::GetResponsePrototype*; + mir::protobuf::Debug_Stub::?Debug_Stub*; + mir::protobuf::Debug_Stub::Debug_Stub*; + mir::protobuf::Debug_Stub::translate_surface_to_screen*; + mir::protobuf::Debug::translate_surface_to_screen*; mir::protobuf::DisplayCard::ByteSize*; mir::protobuf::DisplayCard::Clear*; mir::protobuf::DisplayCard::CopyFrom*; @@ -780,7 +826,11 @@ typeinfo?for?mir::protobuf::BufferRequest; typeinfo?for?mir::protobuf::Connection; typeinfo?for?mir::protobuf::ConnectParameters; + typeinfo?for?mir::protobuf::CoordinateTranslationRequest; + typeinfo?for?mir::protobuf::CoordinateTranslationResponse; typeinfo?for?mir::protobuf::CursorSetting; + typeinfo?for?mir::protobuf::Debug; + typeinfo?for?mir::protobuf::Debug_Stub; typeinfo?for?mir::protobuf::DisplayCard; typeinfo?for?mir::protobuf::DisplayConfiguration; typeinfo?for?mir::protobuf::DisplayInfo; @@ -847,7 +897,11 @@ vtable?for?mir::protobuf::BufferRequest; vtable?for?mir::protobuf::Connection; vtable?for?mir::protobuf::ConnectParameters; + vtable?for?mir::protobuf::CoordinateTranslationRequest; + vtable?for?mir::protobuf::CoordinateTranslationResponse; vtable?for?mir::protobuf::CursorSetting; + vtable?for?mir::protobuf::Debug; + vtable?for?mir::protobuf::Debug_Stub; vtable?for?mir::protobuf::DisplayCard; vtable?for?mir::protobuf::DisplayConfiguration; vtable?for?mir::protobuf::DisplayInfo; === added file 'src/include/server/mir/frontend/unsupported_feature_exception.h' --- src/include/server/mir/frontend/unsupported_feature_exception.h 1970-01-01 00:00:00 +0000 +++ src/include/server/mir/frontend/unsupported_feature_exception.h 2014-10-23 13:30:17 +0000 @@ -0,0 +1,41 @@ +/* + * Copyright © 2014 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 . + * + * Authored by: Christopher James Halse Rogers + */ + + +#ifndef MIR_FRONTEND_UNSUPPORTED_FEATURE_EXCEPTION_H_ +#define MIR_FRONTEND_UNSUPPORTED_FEATURE_EXCEPTION_H_ + +#include + +namespace mir +{ +namespace frontend +{ +class unsupported_feature : public std::runtime_error +{ +public: + unsupported_feature() + : std::runtime_error{"Unsupported feature requested"} + { + } +}; +} +} + + +#endif /* MIR_FRONTEND_UNSUPPORTED_FEATURE_EXCEPTION_H_ */ === modified file 'src/platform/options/default_configuration.cpp' --- src/platform/options/default_configuration.cpp 2014-10-01 06:25:56 +0000 +++ src/platform/options/default_configuration.cpp 2014-10-23 13:30:17 +0000 @@ -45,6 +45,7 @@ char const* const mo::offscreen_opt = "offscreen"; char const* const mo::touchspots_opt = "enable-touchspots"; char const* const mo::fatal_abort_opt = "on-fatal-error-abort"; +char const* const mo::debug_opt = "debug"; char const* const mo::glog = "glog"; char const* const mo::glog_stderrthreshold = "glog-stderrthreshold"; @@ -164,7 +165,9 @@ (touchspots_opt, "Display visualization of touchspots (e.g. for screencasting).") (fatal_abort_opt, "On \"fatal error\" conditions [e.g. drivers behaving " - "in unexpected ways] abort (to get a core dump)"); + "in unexpected ways] abort (to get a core dump)") + (debug_opt, "Enable extra development debugging. " + "This is only interesting for people doing Mir server or client development."); add_platform_options(); } === modified file 'src/platform/symbols.map' --- src/platform/symbols.map 2014-10-21 16:21:14 +0000 +++ src/platform/symbols.map 2014-10-23 13:30:17 +0000 @@ -146,6 +146,7 @@ mir::options::DefaultConfiguration::parse_environment*; mir::options::DefaultConfiguration::the_options*; mir::options::display_report_opt*; + mir::options::debug_opt*; mir::options::enable_input_opt*; mir::options::fatal_abort_opt*; mir::options::frontend_threads_opt*; === modified file 'src/server/frontend/CMakeLists.txt' --- src/server/frontend/CMakeLists.txt 2014-10-01 06:25:56 +0000 +++ src/server/frontend/CMakeLists.txt 2014-10-23 13:30:17 +0000 @@ -22,6 +22,7 @@ session_credentials.cpp default_configuration.cpp default_ipc_factory.cpp + unsupported_coordinate_translator.cpp ) add_library( === modified file 'src/server/frontend/default_configuration.cpp' --- src/server/frontend/default_configuration.cpp 2014-10-01 06:25:56 +0000 +++ src/server/frontend/default_configuration.cpp 2014-10-23 13:30:17 +0000 @@ -22,6 +22,8 @@ #include "default_ipc_factory.h" #include "published_socket_connector.h" +#include "unsupported_coordinate_translator.h" + #include "mir/frontend/protobuf_connection_creator.h" #include "mir/frontend/session_authorizer.h" #include "mir/options/configuration.h" @@ -29,6 +31,7 @@ namespace mf = mir::frontend; namespace mg = mir::graphics; +namespace ms = mir::scene; std::shared_ptr mir::DefaultServerConfiguration::the_connection_creator() @@ -137,13 +140,23 @@ mir::DefaultServerConfiguration::new_ipc_factory( std::shared_ptr const& session_authorizer) { + std::shared_ptr translator; + if (the_options()->is_set(options::debug_opt)) + { + translator = the_coordinate_translator(); + } + else + { + translator = std::make_shared(); + } return std::make_shared( - the_frontend_shell(), - the_session_mediator_report(), - the_graphics_platform(), - the_frontend_display_changer(), - the_buffer_allocator(), - the_screencast(), - session_authorizer, - the_cursor_images()); + the_frontend_shell(), + the_session_mediator_report(), + the_graphics_platform(), + the_frontend_display_changer(), + the_buffer_allocator(), + the_screencast(), + session_authorizer, + the_cursor_images(), + translator); } === modified file 'src/server/frontend/default_ipc_factory.cpp' --- src/server/frontend/default_ipc_factory.cpp 2014-10-01 06:25:56 +0000 +++ src/server/frontend/default_ipc_factory.cpp 2014-10-23 13:30:17 +0000 @@ -38,7 +38,8 @@ std::shared_ptr const& buffer_allocator, std::shared_ptr const& screencast, std::shared_ptr const& session_authorizer, - std::shared_ptr const& cursor_images) : + std::shared_ptr const& cursor_images, + std::shared_ptr const& translator) : shell(shell), no_prompt_shell(std::make_shared(shell)), sm_report(sm_report), @@ -48,7 +49,8 @@ buffer_allocator(buffer_allocator), screencast(screencast), session_authorizer(session_authorizer), - cursor_images(cursor_images) + cursor_images(cursor_images), + translator{translator} { } @@ -120,5 +122,6 @@ resource_cache(), effective_screencast, connection_context, - cursor_images); + cursor_images, + translator); } === modified file 'src/server/frontend/default_ipc_factory.h' --- src/server/frontend/default_ipc_factory.h 2014-10-01 06:25:56 +0000 +++ src/server/frontend/default_ipc_factory.h 2014-10-23 13:30:17 +0000 @@ -33,6 +33,11 @@ class CursorImages; } +namespace scene +{ +class CoordinateTranslator; +} + namespace frontend { class Shell; @@ -52,7 +57,8 @@ std::shared_ptr const& buffer_allocator, std::shared_ptr const& screencast, std::shared_ptr const& session_authorizer, - std::shared_ptr const& cursor_images); + std::shared_ptr const& cursor_images, + std::shared_ptr const& translator); std::shared_ptr make_ipc_server( SessionCredentials const& creds, @@ -83,6 +89,7 @@ std::shared_ptr const screencast; std::shared_ptr const session_authorizer; std::shared_ptr const cursor_images; + std::shared_ptr const translator; }; } } === modified file 'src/server/frontend/protobuf_message_processor.cpp' --- src/server/frontend/protobuf_message_processor.cpp 2014-10-22 18:55:40 +0000 +++ src/server/frontend/protobuf_message_processor.cpp 2014-10-23 13:30:17 +0000 @@ -21,6 +21,7 @@ #include "mir/frontend/message_processor_report.h" #include "mir/frontend/protobuf_message_sender.h" #include "mir/frontend/template_protobuf_message_processor.h" +#include "mir/frontend/unsupported_feature_exception.h" #include "mir_protobuf_wire.pb.h" @@ -104,6 +105,24 @@ self->send_response(invocation.id(), result_message); } } + +// A partial-specialisation to handle error cases. +template +void invoke( + Self* self, + std::string* error, + void (ServerX::*/*function*/)( + ::google::protobuf::RpcController* controller, + const ParameterMessage* request, + ResultMessage* response, + ::google::protobuf::Closure* done), + Invocation const& invocation) +{ + ResultMessage result_message; + result_message.set_error(error->c_str()); + self->send_response(invocation.id(), &result_message); +} + } } } @@ -206,6 +225,24 @@ invoke(this, display_server.get(), &DisplayServer::disconnect, invocation); result = false; } + else if ("translate_surface_to_screen" == invocation.method_name()) + { + try + { + auto debug_interface = dynamic_cast(display_server.get()); + invoke(this, debug_interface, &mir::protobuf::Debug::translate_surface_to_screen, invocation); + } + catch (mir::frontend::unsupported_feature const&) + { + std::string message{"Server does not support the client debugging interface"}; + invoke(this, + &message, + &mir::protobuf::Debug::translate_surface_to_screen, + invocation); + std::runtime_error err{"Client attempted to use unavailable debug interface"}; + report->exception_handled(display_server.get(), invocation.id(), err); + } + } else { report->unknown_method(display_server.get(), invocation.id(), invocation.method_name()); === modified file 'src/server/frontend/session_mediator.cpp' --- src/server/frontend/session_mediator.cpp 2014-10-21 16:21:14 +0000 +++ src/server/frontend/session_mediator.cpp 2014-10-23 13:30:17 +0000 @@ -17,13 +17,13 @@ */ #include "session_mediator.h" -#include "client_buffer_tracker.h" #include "mir/frontend/session_mediator_report.h" #include "mir/frontend/shell.h" #include "mir/frontend/session.h" #include "mir/frontend/surface.h" #include "mir/scene/surface_creation_parameters.h" +#include "mir/scene/coordinate_translator.h" #include "mir/frontend/display_changer.h" #include "resource_cache.h" #include "mir_toolkit/common.h" @@ -73,7 +73,8 @@ std::shared_ptr const& resource_cache, std::shared_ptr const& screencast, ConnectionContext const& connection_context, - std::shared_ptr const& cursor_images) : + std::shared_ptr const& cursor_images, + std::shared_ptr const& translator) : client_pid_(0), shell(shell), graphics_platform(graphics_platform), @@ -86,6 +87,7 @@ screencast(screencast), connection_context(connection_context), cursor_images(cursor_images), + translator{translator}, surface_tracker{static_cast(client_buffer_cache_size)} { } @@ -551,6 +553,32 @@ done->Run(); } +void mir::frontend::SessionMediator::translate_surface_to_screen( + ::google::protobuf::RpcController* , + ::mir::protobuf::CoordinateTranslationRequest const* request, + ::mir::protobuf::CoordinateTranslationResponse* response, + ::google::protobuf::Closure *done) +{ + { + std::unique_lock lock(session_mutex); + + auto session = weak_session.lock(); + + if (session.get() == nullptr) + BOOST_THROW_EXCEPTION(std::logic_error("Invalid application session")); + + auto const id = frontend::SurfaceId(request->surfaceid().value()); + + auto const coords = translator->surface_to_screen(session->get_surface(id), + request->x(), + request->y()); + + response->set_x(coords.x.as_uint32_t()); + response->set_y(coords.y.as_uint32_t()); + } + done->Run(); +} + void mf::SessionMediator::drm_auth_magic( google::protobuf::RpcController* /*controller*/, const mir::protobuf::DRMMagic* request, === modified file 'src/server/frontend/session_mediator.h' --- src/server/frontend/session_mediator.h 2014-10-21 16:21:14 +0000 +++ src/server/frontend/session_mediator.h 2014-10-23 13:30:17 +0000 @@ -46,6 +46,11 @@ class CursorImages; } +namespace scene +{ +class CoordinateTranslator; +} + /// Frontend interface. Mediates the interaction between client /// processes and the core of the mir system. namespace frontend @@ -62,7 +67,7 @@ class PromptSession; // SessionMediator relays requests from the client process into the server. -class SessionMediator : public detail::DisplayServer +class SessionMediator : public detail::DisplayServer, public mir::protobuf::Debug { public: @@ -76,7 +81,8 @@ std::shared_ptr const& resource_cache, std::shared_ptr const& screencast, ConnectionContext const& connection_context, - std::shared_ptr const& cursor_images); + std::shared_ptr const& cursor_images, + std::shared_ptr const& translator); ~SessionMediator() noexcept; @@ -167,6 +173,13 @@ ::mir::protobuf::SocketFD* response, ::google::protobuf::Closure* done) override; + // TODO: Split this into a separate thing + void translate_surface_to_screen( + ::google::protobuf::RpcController* controller, + ::mir::protobuf::CoordinateTranslationRequest const* request, + ::mir::protobuf::CoordinateTranslationResponse* response, + ::google::protobuf::Closure *done) override; + private: void pack_protobuf_buffer(protobuf::Buffer& protobuf_buffer, graphics::Buffer* graphics_buffer, @@ -193,6 +206,7 @@ std::shared_ptr const screencast; ConnectionContext const connection_context; std::shared_ptr const cursor_images; + std::shared_ptr const translator; SurfaceTracker surface_tracker; === added file 'src/server/frontend/unsupported_coordinate_translator.cpp' --- src/server/frontend/unsupported_coordinate_translator.cpp 1970-01-01 00:00:00 +0000 +++ src/server/frontend/unsupported_coordinate_translator.cpp 2014-10-23 13:30:17 +0000 @@ -0,0 +1,32 @@ +/* + * Copyright © 2014 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 . + * + * Authored by: Christopher James Halse Rogers + */ + +#include "unsupported_coordinate_translator.h" +#include "mir/frontend/unsupported_feature_exception.h" + +#include + +namespace mg = mir::geometry; +namespace mf = mir::frontend; + +mg::Point mf::UnsupportedCoordinateTranslator::surface_to_screen( + std::shared_ptr /*surface*/, + int32_t /*x*/, int32_t /*y*/) +{ + BOOST_THROW_EXCEPTION(mir::frontend::unsupported_feature()); +} === added file 'src/server/frontend/unsupported_coordinate_translator.h' --- src/server/frontend/unsupported_coordinate_translator.h 1970-01-01 00:00:00 +0000 +++ src/server/frontend/unsupported_coordinate_translator.h 2014-10-23 13:30:17 +0000 @@ -0,0 +1,37 @@ +/* + * Copyright © 2014 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 . + * + * Authored by: Christopher James Halse Rogers + */ + +#ifndef MIR_FRONTEND_UNSUPPORTED_COORDINATE_TRANSLATOR_H_ +#define MIR_FRONTEND_UNSUPPORTED_COORDINATE_TRANSLATOR_H_ + +#include "mir/scene/coordinate_translator.h" + +namespace mir +{ +namespace frontend +{ +class UnsupportedCoordinateTranslator : public scene::CoordinateTranslator +{ + geometry::Point surface_to_screen(std::shared_ptr surface, + int32_t x, int32_t y) override; +}; + +} +} + +#endif // MIR_FRONTEND_UNSUPPORTED_COORDINATE_TRANSLATOR_H_ === modified file 'src/server/scene/CMakeLists.txt' --- src/server/scene/CMakeLists.txt 2014-10-01 06:25:56 +0000 +++ src/server/scene/CMakeLists.txt 2014-10-23 13:30:17 +0000 @@ -23,4 +23,5 @@ prompt_session_container.cpp prompt_session_manager_impl.cpp rendering_tracker.cpp + default_coordinate_translator.cpp ) === modified file 'src/server/scene/default_configuration.cpp' --- src/server/scene/default_configuration.cpp 2014-10-01 06:25:56 +0000 +++ src/server/scene/default_configuration.cpp 2014-10-23 13:30:17 +0000 @@ -36,6 +36,7 @@ #include "surface_stack.h" #include "threaded_snapshot_strategy.h" #include "prompt_session_manager_impl.h" +#include "default_coordinate_translator.h" namespace mc = mir::compositor; namespace mf = mir::frontend; @@ -238,3 +239,13 @@ the_prompt_session_listener()); }); } + +std::shared_ptr +mir::DefaultServerConfiguration::the_coordinate_translator() +{ + return coordinate_translator( + [this]() + { + return std::make_shared(); + }); +} === added file 'src/server/scene/default_coordinate_translator.cpp' --- src/server/scene/default_coordinate_translator.cpp 1970-01-01 00:00:00 +0000 +++ src/server/scene/default_coordinate_translator.cpp 2014-10-23 13:30:17 +0000 @@ -0,0 +1,32 @@ +/* + * Copyright © 2014 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 . + * + * Authored by: Christopher James Halse Rogers + */ + +#include "default_coordinate_translator.h" +#include "basic_surface.h" + +namespace geom = mir::geometry; +namespace mf = mir::frontend; +namespace ms = mir::scene; + +geom::Point ms::DefaultCoordinateTranslator::surface_to_screen(std::shared_ptr surface, int32_t x, + int32_t y) +{ + auto const scene_surface = std::dynamic_pointer_cast(surface); + + return geom::Point{x + scene_surface->top_left().x.as_int(), y + scene_surface->top_left().y.as_int()}; +} === added file 'src/server/scene/default_coordinate_translator.h' --- src/server/scene/default_coordinate_translator.h 1970-01-01 00:00:00 +0000 +++ src/server/scene/default_coordinate_translator.h 2014-10-23 13:30:17 +0000 @@ -0,0 +1,37 @@ +/* + * Copyright © 2014 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 . + * + * Authored by: Christopher James Halse Rogers + */ + +#ifndef MIR_FRONTEND_DEFAULT_COORDINATE_TRANSLATOR_H_ +#define MIR_FRONTEND_DEFAULT_COORDINATE_TRANSLATOR_H_ + +#include "mir/scene/coordinate_translator.h" + +namespace mir +{ +namespace scene +{ +class DefaultCoordinateTranslator : public CoordinateTranslator +{ +public: + geometry::Point surface_to_screen(std::shared_ptr surface, int32_t x, int32_t y); +}; + +} +} + +#endif // MIR_FRONTEND_DEFAULT_COORDINATE_TRANSLATOR_H_ === modified file 'src/server/symbols.map' --- src/server/symbols.map 2014-10-22 18:55:40 +0000 +++ src/server/symbols.map 2014-10-23 13:30:17 +0000 @@ -39,6 +39,7 @@ mir::DefaultServerConfiguration::the_connection_creator*; mir::DefaultServerConfiguration::the_connector*; mir::DefaultServerConfiguration::the_connector_report*; + mir::DefaultServerConfiguration::the_coordinate_translator*; mir::DefaultServerConfiguration::the_cursor*; mir::DefaultServerConfiguration::the_cursor_images*; mir::DefaultServerConfiguration::the_cursor_listener*; @@ -244,6 +245,9 @@ mir::report_exception*; mir::run_mir*; mir::scene::a_surface*; + mir::scene::CoordinateTranslator::?CoordinateTranslator*; + mir::scene::CoordinateTranslator::CoordinateTranslator*; + mir::scene::CoordinateTranslator::surface_to_screen*; mir::scene::NullSurfaceObserver::alpha_set_to*; mir::scene::NullSurfaceObserver::attrib_changed*; mir::scene::NullSurfaceObserver::cursor_image_set_to*; @@ -648,6 +652,7 @@ typeinfo?for?mir::input::TouchVisualizer; typeinfo?for?mir::input::TouchVisualizer::Spot; typeinfo?for?mir::MainLoop; + typeinfo?for?mir::scene::CoordinateTranslator; typeinfo?for?mir::scene::NullSurfaceObserver; typeinfo?for?mir::scene::Observer; typeinfo?for?mir::scene::PlacementStrategy; @@ -706,6 +711,7 @@ vtable?for?mir::input::TouchVisualizer; vtable?for?mir::input::TouchVisualizer::Spot; vtable?for?mir::MainLoop; + vtable?for?mir::scene::CoordinateTranslator; vtable?for?mir::scene::NullSurfaceObserver; vtable?for?mir::scene::Observer; vtable?for?mir::scene::PlacementStrategy; === modified file 'tests/acceptance-tests/CMakeLists.txt' --- tests/acceptance-tests/CMakeLists.txt 2014-10-21 16:21:14 +0000 +++ tests/acceptance-tests/CMakeLists.txt 2014-10-23 13:30:17 +0000 @@ -42,6 +42,7 @@ test_server_without_active_outputs.cpp test_client_input.cpp test_server_startup.cpp + test_debug_api.cpp test_unresponsive_client.cpp ) @@ -67,6 +68,7 @@ mirserver mirclient + mirclient-debug-extension mirplatform mir-test === modified file 'tests/acceptance-tests/test_client_library.cpp' --- tests/acceptance-tests/test_client_library.cpp 2014-10-21 16:21:14 +0000 +++ tests/acceptance-tests/test_client_library.cpp 2014-10-23 13:30:17 +0000 @@ -17,7 +17,6 @@ */ #include "mir_toolkit/mir_client_library.h" -#include "mir_toolkit/mir_client_library_debug.h" #include "mir_test_framework/stubbed_server_configuration.h" #include "mir_test_framework/in_process_server.h" === modified file 'tests/acceptance-tests/test_client_surface_events.cpp' --- tests/acceptance-tests/test_client_surface_events.cpp 2014-10-01 06:25:56 +0000 +++ tests/acceptance-tests/test_client_surface_events.cpp 2014-10-23 13:30:17 +0000 @@ -17,7 +17,7 @@ */ #include "mir_toolkit/mir_client_library.h" -#include "mir_toolkit/mir_client_library_debug.h" +#include "mir_toolkit/debug/surface.h" #include "mir/shell/surface_coordinator_wrapper.h" === modified file 'tests/acceptance-tests/test_client_surfaces.cpp' --- tests/acceptance-tests/test_client_surfaces.cpp 2014-10-01 06:25:56 +0000 +++ tests/acceptance-tests/test_client_surfaces.cpp 2014-10-23 13:30:17 +0000 @@ -17,7 +17,7 @@ */ #include "mir_toolkit/mir_client_library.h" -#include "mir_toolkit/mir_client_library_debug.h" +#include "mir_toolkit/debug/surface.h" #include "mir_test_framework/stubbed_server_configuration.h" #include "mir_test_framework/basic_client_server_fixture.h" === modified file 'tests/acceptance-tests/test_custom_input_dispatcher.cpp' --- tests/acceptance-tests/test_custom_input_dispatcher.cpp 2014-10-01 06:25:56 +0000 +++ tests/acceptance-tests/test_custom_input_dispatcher.cpp 2014-10-23 13:30:17 +0000 @@ -133,7 +133,7 @@ // may be stopped before events have been dispatched. run_in_test_process([&] { - server_config.dispatching_done.wait_for_signal_ready_for(std::chrono::seconds{5}); + server_config.dispatching_done.wait_for_signal_ready_for(std::chrono::seconds{50}); }); } @@ -179,6 +179,6 @@ launch_client_process(client); run_in_test_process([&] { - server_config.dispatching_done.wait_for_signal_ready_for(std::chrono::seconds{5}); + server_config.dispatching_done.wait_for_signal_ready_for(std::chrono::seconds{50}); }); } === added file 'tests/acceptance-tests/test_debug_api.cpp' --- tests/acceptance-tests/test_debug_api.cpp 1970-01-01 00:00:00 +0000 +++ tests/acceptance-tests/test_debug_api.cpp 2014-10-23 13:30:17 +0000 @@ -0,0 +1,231 @@ +/* + * Copyright © 2014 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 . + * + * Authored by: Christopher James Halse Rogers + */ + +#include "mir/options/option.h" +#include "mir/scene/surface_creation_parameters.h" +#include "mir/scene/placement_strategy.h" +#include "mir/scene/surface.h" +#include "src/server/scene/session_container.h" +#include "mir/shell/surface_coordinator_wrapper.h" + +#include "mir_test/wait_condition.h" +#include "mir_test/client_event_matchers.h" +#include "mir_test/barrier.h" +#include "mir_test_framework/deferred_in_process_server.h" +#include "mir_test_framework/stubbed_server_configuration.h" + +#include "mir_toolkit/mir_client_library.h" +#include "mir_toolkit/debug/surface.h" + +#include +#include + +namespace ms = mir::scene; + +namespace mtf = mir_test_framework; + +namespace +{ +class SimpleConfigurablePlacementStrategy : public ms::PlacementStrategy +{ +public: + ms::SurfaceCreationParameters place(ms::Session const& /*session*/, + ms::SurfaceCreationParameters const& request_parameters) override + { + auto placed = request_parameters; + placed.top_left = placement.top_left; + placed.size = placement.size; + return placed; + } + + mir::geometry::Rectangle placement; +}; + +class SurfacePlacingConfiguration : public mtf::StubbedServerConfiguration +{ +public: + SurfacePlacingConfiguration() + : placement_strategy{std::make_shared()} + { + } + + std::shared_ptr the_placement_strategy() override + { + return placement_strategy; + } + + void set_surface_placement(mir::geometry::Rectangle const& where) + { + placement_strategy->placement = where; + } + + bool is_debug_server() + { + return the_options()->is_set("debug"); + } + +private: + std::shared_ptr placement_strategy; +}; + +char const* debugenv = "MIR_SERVER_DEBUG"; + +void dont_kill_me_bro(MirConnection* /*unused*/, MirLifecycleState /*unused*/, void* /*unused*/) +{ +} + +class TestDebugAPI : public mtf::DeferredInProcessServer +{ +public: + TestDebugAPI() + : old_debug_env{::getenv(debugenv)} + { + mir::geometry::Rectangle surface_location; + surface_location.top_left.x = mir::geometry::X{0}; + surface_location.top_left.y = mir::geometry::Y{0}; + surface_location.size.width = mir::geometry::Width{100}; + surface_location.size.height = mir::geometry::Height{100}; + + server_configuration.set_surface_placement(surface_location); + } + + ~TestDebugAPI() + { + ::unsetenv(debugenv); + if (old_debug_env) + { + ::setenv(debugenv, old_debug_env, 1); + } + } + + void start_server_with_debug(bool debug) + { + if (debug) + { + ::setenv(debugenv, "", 1); + } + else + { + ::unsetenv(debugenv); + } + + if (server_configuration.is_debug_server() != debug) + { + throw std::runtime_error{"Failed to set the debug flag correctly. Have you overriden this with --debug?"}; + } + + start_server(); + connection = mir_connect_sync(new_connection().c_str(), __PRETTY_FUNCTION__); + if (!mir_connection_is_valid(connection)) + { + throw std::runtime_error{std::string{"Failed to connect to test server:"} + + mir_connection_get_error_message(connection)}; + } + mir_connection_set_lifecycle_event_callback(connection, dont_kill_me_bro, nullptr); + } + + void TearDown() override + { + if (connection) + { + mir_connection_release(connection); + } + DeferredInProcessServer::TearDown(); + } + + mir::DefaultServerConfiguration& server_config() override + { + return server_configuration; + } + + SurfacePlacingConfiguration server_configuration; + MirConnection* connection{nullptr}; + +private: + char const* old_debug_env; +}; +} + +TEST_F(TestDebugAPI, TranslatesSurfaceCoordinatesToScreenCoordinates) +{ + start_server_with_debug(true); + + mir::geometry::Rectangle surface_location; + surface_location.top_left.x = mir::geometry::X{200}; + surface_location.top_left.y = mir::geometry::Y{100}; + surface_location.size.width = mir::geometry::Width{800}; + surface_location.size.height = mir::geometry::Height{600}; + + server_configuration.set_surface_placement(surface_location); + + ASSERT_TRUE(mir_connection_is_valid(connection)); + + MirSurfaceParameters const creation_parameters = { + __PRETTY_FUNCTION__, + 800, 600, + mir_pixel_format_argb_8888, + mir_buffer_usage_hardware, + mir_display_output_id_invalid + }; + auto surf = mir_connection_create_surface_sync(connection, &creation_parameters); + ASSERT_TRUE(mir_surface_is_valid(surf)); + + int screen_x, screen_y, x, y; + x = 35, y = 21; + + ASSERT_TRUE(mir_debug_surface_coords_to_screen(surf, x, y, &screen_x, &screen_y)); + EXPECT_EQ(x + surface_location.top_left.x.as_int(), screen_x); + EXPECT_EQ(y + surface_location.top_left.y.as_int(), screen_y); + + mir_surface_release_sync(surf); + + surface_location.top_left.x = mir::geometry::X{100}; + surface_location.top_left.y = mir::geometry::Y{250}; + + server_configuration.set_surface_placement(surface_location); + + surf = mir_connection_create_surface_sync(connection, &creation_parameters); + ASSERT_TRUE(mir_surface_is_valid(surf)); + + ASSERT_TRUE(mir_debug_surface_coords_to_screen(surf, x, y, &screen_x, &screen_y)); + EXPECT_EQ(x + surface_location.top_left.x.as_int(), screen_x); + EXPECT_EQ(y + surface_location.top_left.y.as_int(), screen_y); + + mir_surface_release_sync(surf); +} + +TEST_F(TestDebugAPI, ApiIsUnavaliableWhenServerNotStartedWithDebug) +{ + start_server_with_debug(false); + + MirSurfaceParameters const creation_parameters = { + __PRETTY_FUNCTION__, + 800, 600, + mir_pixel_format_argb_8888, + mir_buffer_usage_hardware, + mir_display_output_id_invalid + }; + auto surf = mir_connection_create_surface_sync(connection, &creation_parameters); + ASSERT_TRUE(mir_surface_is_valid(surf)); + + int screen_x, screen_y; + + EXPECT_FALSE(mir_debug_surface_coords_to_screen(surf, 0, 0, &screen_x, &screen_y)); + + mir_surface_release_sync(surf); +} === added file 'tests/include/mir_test_doubles/mock_coordinate_translator.h' --- tests/include/mir_test_doubles/mock_coordinate_translator.h 1970-01-01 00:00:00 +0000 +++ tests/include/mir_test_doubles/mock_coordinate_translator.h 2014-10-23 13:30:17 +0000 @@ -0,0 +1,42 @@ +/* + * Copyright © 2014 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 . + * + * Authored by: Christopher James Halse Rogers + */ + +#ifndef MIR_TEST_DOUBLES_MOCK_COORDINATE_TRANSLATOR_H_ +#define MIR_TEST_DOUBLES_MOCK_COORDINATE_TRANSLATOR_H_ + +#include "src/server/frontend/coordinate_translator.h" + +#include + +namespace mir +{ +namespace test +{ +namespace doubles +{ +class MockCoordinateTranslator : public mir::frontend::CoordinateTranslator +{ + MOCK_METHOD3(surface_to_screen, geometry::Point(std::shared_ptr, uint32_t, uint32_t)); +}; + +using StubCoordinateTranslator = testing::NiceMock; +} +} +} + +#endif /* MIR_TEST_DOUBLES_MOCK_COORDINATE_TRANSLATOR_H_ */ === modified file 'tests/include/mir_test_doubles/mock_surface.h' --- tests/include/mir_test_doubles/mock_surface.h 2014-10-01 06:25:56 +0000 +++ tests/include/mir_test_doubles/mock_surface.h 2014-10-23 13:30:17 +0000 @@ -21,6 +21,7 @@ #include "src/server/scene/basic_surface.h" #include "src/server/report/null_report_factory.h" +#include "mock_buffer_stream.h" #include @@ -38,7 +39,7 @@ {}, {{},{}}, true, - {}, + std::make_shared>(), {}, {}, {}, === modified file 'tests/integration-tests/CMakeLists.txt' --- tests/integration-tests/CMakeLists.txt 2014-10-21 16:21:14 +0000 +++ tests/integration-tests/CMakeLists.txt 2014-10-23 13:30:17 +0000 @@ -82,6 +82,7 @@ mir-test mir-test-framework mir-test-doubles + mirclient-debug-extension mirdraw mirtestdraw === modified file 'tests/integration-tests/test_stale_frames.cpp' --- tests/integration-tests/test_stale_frames.cpp 2014-10-21 16:21:14 +0000 +++ tests/integration-tests/test_stale_frames.cpp 2014-10-23 13:30:17 +0000 @@ -17,7 +17,7 @@ */ #include "mir_toolkit/mir_client_library.h" -#include "mir_toolkit/mir_client_library_debug.h" +#include "mir_toolkit/debug/surface.h" #include "mir/compositor/compositor.h" #include "mir/compositor/renderer_factory.h" === modified file 'tests/unit-tests/frontend/test_session_mediator.cpp' --- tests/unit-tests/frontend/test_session_mediator.cpp 2014-10-21 16:21:14 +0000 +++ tests/unit-tests/frontend/test_session_mediator.cpp 2014-10-23 13:30:17 +0000 @@ -259,7 +259,7 @@ shell, graphics_platform, graphics_changer, surface_pixel_formats, report, std::make_shared(), - resource_cache, stub_screencast, &connector, nullptr} + resource_cache, stub_screencast, &connector, nullptr, nullptr} { using namespace ::testing; @@ -316,7 +316,7 @@ shell, graphics_platform, graphics_changer, surface_pixel_formats, report, std::make_shared(), - resource_cache, stub_screencast, context, nullptr}; + resource_cache, stub_screencast, context, nullptr, nullptr}; EXPECT_THAT(connects_handled_count, Eq(0)); @@ -421,7 +421,7 @@ surface_pixel_formats, report, std::make_shared(), resource_cache, std::make_shared(), - nullptr, nullptr); + nullptr, nullptr, nullptr); mediator.connect(nullptr, &connect_parameters, &connection, null_callback.get()); EXPECT_THAT(connection.display_configuration(), mt::DisplayConfigMatches(std::cref(config))); @@ -629,7 +629,7 @@ surface_pixel_formats, report, std::make_shared(), resource_cache, std::make_shared(), - nullptr, nullptr}; + nullptr, nullptr, nullptr}; mediator.connect(nullptr, &connect_parameters, &connection, null_callback.get()); @@ -876,7 +876,7 @@ shell, graphics_platform, graphics_changer, surface_pixel_formats, report, std::make_shared(), - mt::fake_shared(mock_cache), stub_screencast, nullptr, nullptr}; + mt::fake_shared(mock_cache), stub_screencast, &connector, nullptr, nullptr}; mediator.connect(nullptr, &connect_parameters, &connection, null_callback.get()); mediator.create_surface(nullptr, &surface_parameters, &surface_response, null_callback.get()); === modified file 'tests/unit-tests/frontend/test_session_mediator_android.cpp' --- tests/unit-tests/frontend/test_session_mediator_android.cpp 2014-10-01 06:25:56 +0000 +++ tests/unit-tests/frontend/test_session_mediator_android.cpp 2014-10-23 13:30:17 +0000 @@ -61,7 +61,7 @@ mediator{shell, graphics_platform, display_changer, surface_pixel_formats, report, std::make_shared(), - resource_cache, std::make_shared(), nullptr, nullptr}, + resource_cache, std::make_shared(), nullptr, nullptr, nullptr}, null_callback{google::protobuf::NewPermanentCallback(google::protobuf::DoNothing)} { } === modified file 'tests/unit-tests/frontend/test_session_mediator_mesa.cpp' --- tests/unit-tests/frontend/test_session_mediator_mesa.cpp 2014-10-21 16:21:14 +0000 +++ tests/unit-tests/frontend/test_session_mediator_mesa.cpp 2014-10-23 13:30:17 +0000 @@ -74,7 +74,8 @@ mediator{shell, mock_platform, display_changer, surface_pixel_formats, report, std::make_shared(), - resource_cache, std::make_shared(), nullptr, nullptr}, + resource_cache, std::make_shared(), nullptr, nullptr, + nullptr}, null_callback{google::protobuf::NewPermanentCallback(google::protobuf::DoNothing)} { }