Merge lp:~alan-griffiths/mir/fix-1717061 into lp:mir

[Alan Griffiths]

Clamp the window aspect ratio dimensions (to avoid ldiv0) and define default window settings in one place. (LP: #1717061)

=== modified file 'src/miral/CMakeLists.txt'
--- src/miral/CMakeLists.txt	2017-09-08 08:45:02 +0000
+++ src/miral/CMakeLists.txt	2017-09-15 09:43:50 +0000
@@ -61,6 +61,7 @@
     window_manager_tools.cpp            ${miral_include}/miral/window_manager_tools.h
                                         ${miral_include}/miral/window_management_policy_addendum2.h
                                         ${miral_include}/miral/window_management_policy_addendum3.h
+                                        window_info_defaults.h
 )
 
 target_include_directories(mirclientcpp

=== modified file 'src/miral/window_info.cpp'
--- src/miral/window_info.cpp	2017-08-21 14:18:55 +0000
+++ src/miral/window_info.cpp	2017-09-15 09:43:50 +0000
@@ -17,6 +17,7 @@
  */
 
 #include "miral/window_info.h"
+#include "window_info_defaults.h"
 
 #include "both_versions.h"
 
@@ -35,7 +36,30 @@
 {
     return optional_value.is_set() ? optional_value.value() : default_;
 }
-}
+
+unsigned clamp_dim(unsigned dim)
+{
+    return std::min<unsigned long>(std::numeric_limits<long>::max(), dim);
+}
+
+// For our convenience when doing calculations we clamp the dimensions of the aspect ratio
+// so they will fit into a long without overflow.
+miral::WindowInfo::AspectRatio clamp(miral::WindowInfo::AspectRatio const& source)
+{
+    return {clamp_dim(source.width), clamp_dim(source.height)};
+}
+}
+
+miral::Width  const miral::default_min_width{0};
+miral::Height const miral::default_min_height{0};
+miral::Width  const miral::default_max_width{std::numeric_limits<int>::max()};
+miral::Height const miral::default_max_height{std::numeric_limits<int>::max()};
+miral::DeltaX const miral::default_width_inc{1};
+miral::DeltaY const miral::default_height_inc{1};
+miral::WindowInfo::AspectRatio const miral::default_min_aspect_ratio{
+    clamp(WindowInfo::AspectRatio{0U, std::numeric_limits<unsigned>::max()})};
+miral::WindowInfo::AspectRatio const miral::default_max_aspect_ratio{
+    clamp(WindowInfo::AspectRatio{std::numeric_limits<unsigned>::max(), 0U})};
 
 struct miral::WindowInfo::Self
 {
@@ -71,16 +95,16 @@
     type{optional_value_or_default(params.type(), mir_window_type_normal)},
     state{optional_value_or_default(params.state(), mir_window_state_restored)},
     restore_rect{params.top_left().value(), params.size().value()},
-    min_width{optional_value_or_default(params.min_width())},
-    min_height{optional_value_or_default(params.min_height())},
-    max_width{optional_value_or_default(params.max_width(), Width{std::numeric_limits<int>::max()})},
-    max_height{optional_value_or_default(params.max_height(), Height{std::numeric_limits<int>::max()})},
+    min_width{optional_value_or_default(params.min_width(), miral::default_min_width)},
+    min_height{optional_value_or_default(params.min_height(), miral::default_min_height)},
+    max_width{optional_value_or_default(params.max_width(), miral::default_max_width)},
+    max_height{optional_value_or_default(params.max_height(), miral::default_max_height)},
     preferred_orientation{optional_value_or_default(params.preferred_orientation(), mir_orientation_mode_any)},
     confine_pointer(optional_value_or_default(params.confine_pointer(), mir_pointer_unconfined)),
-    width_inc{optional_value_or_default(params.width_inc(), DeltaX{1})},
-    height_inc{optional_value_or_default(params.height_inc(), DeltaY{1})},
-    min_aspect(optional_value_or_default(params.min_aspect(), AspectRatio{0U, std::numeric_limits<unsigned>::max()})),
-    max_aspect(optional_value_or_default(params.max_aspect(), AspectRatio{std::numeric_limits<unsigned>::max(), 0U})),
+    width_inc{optional_value_or_default(params.width_inc(), default_width_inc)},
+    height_inc{optional_value_or_default(params.height_inc(), default_height_inc)},
+    min_aspect(optional_value_or_default(params.min_aspect(), default_min_aspect_ratio)),
+    max_aspect(optional_value_or_default(params.max_aspect(), default_max_aspect_ratio)),
     shell_chrome(optional_value_or_default(params.shell_chrome(), mir_shell_chrome_normal))
 {
     if (params.output_id().is_set())
@@ -520,7 +544,7 @@
 
 void miral::WindowInfo::min_aspect(AspectRatio min_aspect)
 {
-    self->min_aspect = min_aspect;
+    self->min_aspect = clamp(min_aspect);
 }
 
 auto miral::WindowInfo::max_aspect() const -> AspectRatio
@@ -530,7 +554,7 @@
 
 void miral::WindowInfo::max_aspect(AspectRatio max_aspect)
 {
-    self->max_aspect = max_aspect;
+    self->max_aspect = clamp(max_aspect);
 }
 
 bool miral::WindowInfo::has_output_id() const

=== added file 'src/miral/window_info_defaults.h'
--- src/miral/window_info_defaults.h	1970-01-01 00:00:00 +0000
+++ src/miral/window_info_defaults.h	2017-09-15 09:43:50 +0000
@@ -0,0 +1,36 @@
+/*
+ * Copyright © 2017 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 2 or 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: Alan Griffiths <[e-mail]>
+ */
+
+#ifndef MIR_WINDOW_INFO_DEFAULTS_H
+#define MIR_WINDOW_INFO_DEFAULTS_H
+
+#include "miral/window_info.h"
+
+namespace miral
+{
+Width  extern const default_min_width;
+Height extern const default_min_height;
+Width  extern const default_max_width;
+Height extern const default_max_height;
+DeltaX extern const default_width_inc;
+DeltaY extern const default_height_inc;
+WindowInfo::AspectRatio extern const default_min_aspect_ratio;
+WindowInfo::AspectRatio extern const default_max_aspect_ratio;
+}
+
+#endif //MIR_WINDOW_INFO_DEFAULTS_H

=== modified file 'src/miral/window_management_trace.cpp'
--- src/miral/window_management_trace.cpp	2017-08-21 14:18:55 +0000
+++ src/miral/window_management_trace.cpp	2017-09-15 09:43:50 +0000
@@ -17,6 +17,7 @@
  */
 
 #include "window_management_trace.h"
+#include "window_info_defaults.h"
 
 #include <miral/application_info.h>
 #include <miral/window_info.h>
@@ -133,18 +134,19 @@
         APPEND(name);
         APPEND(type);
         APPEND(state);
+        bout.append("size", info.window().size());
         if (info.state() != mir_window_state_restored) APPEND(restore_rect);
         if (std::shared_ptr<mir::scene::Surface> parent = info.parent())
             bout.append("parent", parent->name());
         bout.append("children", dump_of(info.children()));
-        if (info.min_width()  != Width{0}) APPEND(min_width);
-        if (info.min_height() != Height{0}) APPEND(min_height);
-        if (info.max_width()  != Width{std::numeric_limits<int>::max()}) APPEND(max_width);
-        if (info.max_height() != Height{std::numeric_limits<int>::max()}) APPEND(max_height);
-        if (info.width_inc()  != DeltaX{1}) APPEND(width_inc);
-        if (info.height_inc() != DeltaY{1}) APPEND(height_inc);
-        if (info.min_aspect() != miral::WindowInfo::AspectRatio{0U, std::numeric_limits<unsigned>::max()}) APPEND(min_aspect);
-        if (info.max_aspect() != miral::WindowInfo::AspectRatio{std::numeric_limits<unsigned>::max(), 0U}) APPEND(max_aspect);
+        if (info.min_width()  != miral::default_min_width)  APPEND(min_width);
+        if (info.min_height() != miral::default_min_height) APPEND(min_height);
+        if (info.max_width()  != miral::default_max_width)  APPEND(max_width);
+        if (info.max_height() != miral::default_max_height) APPEND(max_height);
+        if (info.width_inc()  != miral::default_width_inc)  APPEND(width_inc);
+        if (info.height_inc() != miral::default_height_inc) APPEND(height_inc);
+        if (info.min_aspect() != miral::default_min_aspect_ratio) APPEND(min_aspect);
+        if (info.max_aspect() != miral::default_max_aspect_ratio) APPEND(max_aspect);
         APPEND(preferred_orientation);
         APPEND(confine_pointer);