Merge lp:~alan-griffiths/miral/rename-place_new_surface-to-place_new_window into lp:miral

[Alan Griffiths]

[libmiral] Rename WindowManagementPolicy::place_new_surface => place_new_window"

[lp:~alan-griffiths/miral/rename-place_new_surface-to-place_new_window]

497. By Alan Griffiths on 2017-01-26

Update changelog

[Gerry Boland (gerboland)]

Witchcraft! But does seem to work

Question on this: do symver lines need to be appended for every miral release from now on?

review: Approve

[Kevin DuBois (kdub)]

ok

review: Approve

[Alan Griffiths (alan-griffiths)]

> Witchcraft! But does seem to work
>
> Question on this: do symver lines need to be appended for every miral release
> from now on?

They result from the deprecation/rename work happening in Mir 0.26. That is part of the plan to break the mirclient ABI in Mir 1.0. That should happen once and things should be stable after that,

Naturally, we can't delete them until we break the MirAL ABI.

=== modified file 'debian/changelog'
--- debian/changelog	2017-01-20 15:02:54 +0000
+++ debian/changelog	2017-01-26 11:36:29 +0000
@@ -7,8 +7,11 @@
       . Compatibility with Mir 0.26 and update API to use the new Mir types and
         enums.
       . Logging of exceptions added to --window-management-trace
+      . Rename WindowManagementPolicy::place_new_surface => place_new_window"
     - Bugs fixed:
       . top-level window is not raised along with its child (LP: #1658085)
+      . miral-shell depends on default cursor theme being installed
+        (LP: #1658159)
 
  -- Alan Griffiths <[e-mail]>  Wed, 14 Dec 2016 16:31:08 +0000
 

=== modified file 'debian/libmiral2.symbols'
--- debian/libmiral2.symbols	2017-01-20 09:06:31 +0000
+++ debian/libmiral2.symbols	2017-01-26 11:36:29 +0000
@@ -361,3 +361,4 @@
  (c++)"miral::WindowInfo::state(MirWindowState)@MIRAL_1.1" 1.1.0
  (c++)"miral::WindowManagementPolicy::advise_state_change(miral::WindowInfo const&, MirWindowState)@MIRAL_1.1" 1.1.0
  (c++)"miral::WindowInfo::can_morph_to(MirWindowType) const@MIRAL_1.1" 1.1.0
+ (c++)"miral::CanonicalWindowManagerPolicy::place_new_window(miral::ApplicationInfo const&, miral::WindowSpecification const&)@MIRAL_1.1" 1.1.0
\ No newline at end of file

=== modified file 'include/miral/canonical_window_manager.h'
--- include/miral/canonical_window_manager.h	2016-12-05 09:46:35 +0000
+++ include/miral/canonical_window_manager.h	2017-01-26 11:36:29 +0000
@@ -31,8 +31,7 @@
 
     explicit CanonicalWindowManagerPolicy(WindowManagerTools const& tools);
 
-    /// places the surfaces as requested
-    auto place_new_surface(
+    auto place_new_window(
         ApplicationInfo const& app_info,
         WindowSpecification const& request_parameters)
         -> WindowSpecification override;

=== modified file 'include/miral/window_management_policy.h'
--- include/miral/window_management_policy.h	2017-01-13 18:28:43 +0000
+++ include/miral/window_management_policy.h	2017-01-26 11:36:29 +0000
@@ -46,11 +46,11 @@
 
     /** Customize initial window placement
      *
-     * @param app_info                the application requesting a new surface
+     * @param app_info                the application requesting a new window
      * @param requested_specification the requested specification (updated with default placement)
      * @return                        the customized specification
      */
-    virtual auto place_new_surface(
+    virtual auto place_new_window(
         ApplicationInfo const& app_info,
         WindowSpecification const& requested_specification) -> WindowSpecification = 0;
 

=== modified file 'miral-kiosk/kiosk_window_manager.cpp'
--- miral-kiosk/kiosk_window_manager.cpp	2017-01-13 18:17:01 +0000
+++ miral-kiosk/kiosk_window_manager.cpp	2017-01-26 11:36:29 +0000
@@ -125,7 +125,7 @@
 
 void KioskWindowManagerPolicy::advise_new_window(WindowInfo const& window_info)
 {
-    // We do this here, not in place_new_surface() so that clients get a resize event.
+    // We do this here, not in place_new_window() so that clients get a resize event.
     // This shouldn't be necessary, but works better with the gtk-mir backend.
     if (maximize_root_windows &&
         window_info.type() == mir_window_type_normal &&

=== modified file 'miral-shell/tiling_window_manager.cpp'
--- miral-shell/tiling_window_manager.cpp	2017-01-20 11:17:36 +0000
+++ miral-shell/tiling_window_manager.cpp	2017-01-26 11:36:29 +0000
@@ -108,7 +108,7 @@
     }
 }
 
-auto TilingWindowManagerPolicy::place_new_surface(
+auto TilingWindowManagerPolicy::place_new_window(
     ApplicationInfo const& app_info,
     WindowSpecification const& request_parameters)
     -> WindowSpecification

=== modified file 'miral-shell/tiling_window_manager.h'
--- miral-shell/tiling_window_manager.h	2017-01-13 18:17:01 +0000
+++ miral-shell/tiling_window_manager.h	2017-01-26 11:36:29 +0000
@@ -54,7 +54,7 @@
 
     ~TilingWindowManagerPolicy();
 
-    auto place_new_surface(
+    auto place_new_window(
         miral::ApplicationInfo const& app_info,
         miral::WindowSpecification const& request_parameters)
         -> miral::WindowSpecification override;

=== modified file 'miral-shell/titlebar_window_manager.cpp'
--- miral-shell/titlebar_window_manager.cpp	2017-01-13 18:17:01 +0000
+++ miral-shell/titlebar_window_manager.cpp	2017-01-26 11:36:29 +0000
@@ -558,10 +558,10 @@
     }
 }
 
-WindowSpecification TitlebarWindowManagerPolicy::place_new_surface(
+WindowSpecification TitlebarWindowManagerPolicy::place_new_window(
     ApplicationInfo const& app_info, WindowSpecification const& request_parameters)
 {
-    auto parameters = CanonicalWindowManagerPolicy::place_new_surface(app_info, request_parameters);
+    auto parameters = CanonicalWindowManagerPolicy::place_new_window(app_info, request_parameters);
 
     bool const needs_titlebar = WindowInfo::needs_titlebar(parameters.type().value());
 

=== modified file 'miral-shell/titlebar_window_manager.h'
--- miral-shell/titlebar_window_manager.h	2017-01-13 18:17:01 +0000
+++ miral-shell/titlebar_window_manager.h	2017-01-26 11:36:29 +0000
@@ -37,7 +37,7 @@
     TitlebarWindowManagerPolicy(miral::WindowManagerTools const& tools, SpinnerSplash const& spinner, miral::InternalClientLauncher const& launcher);
     ~TitlebarWindowManagerPolicy();
 
-    virtual miral::WindowSpecification place_new_surface(
+    virtual miral::WindowSpecification place_new_window(
         miral::ApplicationInfo const& app_info, miral::WindowSpecification const& request_parameters) override;
 
     /** @name example event handling:

=== modified file 'miral/basic_window_manager.cpp'
--- miral/basic_window_manager.cpp	2017-01-20 13:37:24 +0000
+++ miral/basic_window_manager.cpp	2017-01-26 11:36:29 +0000
@@ -92,7 +92,7 @@
 
     auto& session_info = info_for(session);
 
-    WindowSpecification const& spec = policy->place_new_surface(session_info, place_new_surface(session_info, params));
+    WindowSpecification const& spec = policy->place_new_window(session_info, place_new_surface(session_info, params));
     scene::SurfaceCreationParameters parameters;
     spec.update(parameters);
     auto const surface_id = build(session, parameters);

=== modified file 'miral/canonical_window_manager.cpp'
--- miral/canonical_window_manager.cpp	2017-01-20 11:17:36 +0000
+++ miral/canonical_window_manager.cpp	2017-01-26 11:36:29 +0000
@@ -30,7 +30,14 @@
 {
 }
 
-auto miral::CanonicalWindowManagerPolicy::place_new_surface(
+#ifndef __clang__
+extern "C" __attribute__((alias("_ZN5miral28CanonicalWindowManagerPolicy16place_new_windowERKNS_15ApplicationInfoERKNS_19WindowSpecificationE"))) void _ZN5miral28CanonicalWindowManagerPolicy17place_new_surfaceERKNS_15ApplicationInfoERKNS_19WindowSpecificationE();
+__asm__(".symver _ZN5miral28CanonicalWindowManagerPolicy17place_new_surfaceERKNS_15ApplicationInfoERKNS_19WindowSpecificationE,_ZN5miral28CanonicalWindowManagerPolicy17place_new_surfaceERKNS_15ApplicationInfoERKNS_19WindowSpecificationE@MIRAL_1.0");
+#else
+__asm__(".symver _ZN5miral28CanonicalWindowManagerPolicy16place_new_windowERKNS_15ApplicationInfoERKNS_19WindowSpecificationE,_ZN5miral28CanonicalWindowManagerPolicy17place_new_surfaceERKNS_15ApplicationInfoERKNS_19WindowSpecificationE@MIRAL_1.0");
+__asm__(".symver _ZN5miral28CanonicalWindowManagerPolicy16place_new_windowERKNS_15ApplicationInfoERKNS_19WindowSpecificationE,_ZN5miral28CanonicalWindowManagerPolicy16place_new_windowERKNS_15ApplicationInfoERKNS_19WindowSpecificationE@@@MIRAL_1.1");
+#endif
+auto miral::CanonicalWindowManagerPolicy::place_new_window(
     miral::ApplicationInfo const& /*app_info*/,
     miral::WindowSpecification const& request_parameters)
     -> miral::WindowSpecification

=== modified file 'miral/symbols.map'
--- miral/symbols.map	2017-01-16 17:38:32 +0000
+++ miral/symbols.map	2017-01-26 11:36:29 +0000
@@ -344,6 +344,8 @@
     # miral::WindowManagementPolicy::advise_state_change*;
     _ZN5miral22WindowManagementPolicy19advise_state_changeERKNS_10WindowInfoE14MirWindowState;
 
-#  extern "C++" {
-#  };
+  extern "C++" {
+    miral::CanonicalWindowManagerPolicy::place_new_window*;
+    non-virtual?thunk?to?miral::CanonicalWindowManagerPolicy::place_new_window*;
+  };
 } MIRAL_1.0;

=== modified file 'miral/window_management_trace.cpp'
--- miral/window_management_trace.cpp	2017-01-19 11:21:05 +0000
+++ miral/window_management_trace.cpp	2017-01-26 11:36:29 +0000
@@ -521,11 +521,11 @@
 }
 MIRAL_TRACE_EXCEPTION
 
-auto miral::WindowManagementTrace::place_new_surface(
+auto miral::WindowManagementTrace::place_new_window(
     ApplicationInfo const& app_info,
     WindowSpecification const& requested_specification) -> WindowSpecification
 try {
-    auto const result = policy->place_new_surface(app_info, requested_specification);
+    auto const result = policy->place_new_window(app_info, requested_specification);
     mir::log_info("%s app_info=%s, requested_specification=%s -> %s",
               __func__, dump_of(app_info).c_str(), dump_of(requested_specification).c_str(), dump_of(result).c_str());
     return result;

=== modified file 'miral/window_management_trace.h'
--- miral/window_management_trace.h	2017-01-13 18:17:01 +0000
+++ miral/window_management_trace.h	2017-01-26 11:36:29 +0000
@@ -71,7 +71,7 @@
 
     virtual void invoke_under_lock(std::function<void()> const& callback) override;
 
-    virtual auto place_new_surface(
+    virtual auto place_new_window(
         ApplicationInfo const& app_info,
         WindowSpecification const& requested_specification) -> WindowSpecification override;
     virtual void handle_window_ready(WindowInfo& window_info) override;

=== modified file 'scripts/process_doxygen_xml.py'
--- scripts/process_doxygen_xml.py	2017-01-16 17:38:32 +0000
+++ scripts/process_doxygen_xml.py	2017-01-26 11:36:29 +0000
@@ -427,9 +427,9 @@
     # miral::WindowManagementPolicy::advise_state_change*;
     _ZN5miral22WindowManagementPolicy19advise_state_changeERKNS_10WindowInfoE14MirWindowState;
 
-#  extern "C++" {'''
+  extern "C++" {'''
 
-END_NEW_STANZA = '''#  };
+END_NEW_STANZA = '''  };
 } MIRAL_1.0;'''
 
 def _print_report():