[gtk/present-toplevel-2: 1/59] Introduce GdkToplevelLayout

[Matthias Clasen <matthiasc src gnome org>]

commit c0c387020b3be2033e6a78cb77640c3e61c13283
Author: Matthias Clasen <mclasen redhat com>
Date:   Sat Feb 29 10:31:22 2020 -0500

    Introduce GdkToplevelLayout
    
    This will be used in a new GdkTopleve interface in
    the near future.

 gdk/gdk.h               |   1 +
 gdk/gdktoplevellayout.c | 302 ++++++++++++++++++++++++++++++++++++++++++++++++
 gdk/gdktoplevellayout.h |  90 +++++++++++++++
 gdk/meson.build         |   2 +
 4 files changed, 395 insertions(+)
---
diff --git a/gdk/gdk.h b/gdk/gdk.h
index b466fe391a..a4f434511e 100644
--- a/gdk/gdk.h
+++ b/gdk/gdk.h
@@ -69,6 +69,7 @@
 #include <gdk/gdkvulkancontext.h>
 #include <gdk/gdksurface.h>
 #include <gdk/gdkpopup.h>
+#include <gdk/gdktoplevellayout.h>
 
 #include <gdk/gdk-autocleanup.h>
 
diff --git a/gdk/gdktoplevellayout.c b/gdk/gdktoplevellayout.c
new file mode 100644
index 0000000000..6aaf336280
--- /dev/null
+++ b/gdk/gdktoplevellayout.c
@@ -0,0 +1,302 @@
+/* GDK - The GIMP Drawing Kit
+ * Copyright (C) 2020 Red Hat
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2 of the License, or (at your option) any later version.
+ *
+ * This library 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 library. If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+#include "config.h"
+
+#include "gdktoplevellayout.h"
+
+#include "gdkmonitor.h"
+
+/**
+ * SECTION:gdktoplevellayout
+ * @Title: GdkToplevelLayout
+ * @Short_description: Information for presenting toplevels
+ *
+ * Toplevel surfaces are sovereign windows that can be presented
+ * to the user in various states (maximized, on all workspaces,
+ * etc).
+ *
+ * The GdkToplevelLayout struct contains information that
+ * is necessary to do so, and is passed to gdk_toplevel_present().
+ */
+struct _GdkToplevelLayout
+{
+  /* < private >*/
+  grefcount ref_count;
+
+  int min_width;
+  int min_height;
+  guint resizable  : 1;
+  guint maximized  : 1;
+  guint fullscreen : 1;
+  GdkMonitor *fullscreen_monitor;
+};
+
+G_DEFINE_BOXED_TYPE (GdkToplevelLayout, gdk_toplevel_layout,
+                     gdk_toplevel_layout_ref,
+                     gdk_toplevel_layout_unref)
+
+/**
+ * gdk_toplevel_layout_new: (constructor)
+ * @min_width: the minimum width for the layout
+ * @min_height: the minimum height for the layout
+ *
+ * Create a toplevel layout description.
+ *
+ * Used together with gdk_toplevel_present() to describe
+ * how a toplevel surface should be placed and behave on-screen.
+ *
+ * Returns: (transfer full): newly created instance of #GdkToplevelLayout
+ */
+GdkToplevelLayout *
+gdk_toplevel_layout_new (int min_width,
+                         int min_height)
+{
+  GdkToplevelLayout *layout;
+
+  layout = g_new0 (GdkToplevelLayout, 1);
+  g_ref_count_init (&layout->ref_count);
+  layout->min_width = min_width;
+  layout->min_height = min_height;
+  layout->resizable = TRUE;
+  layout->maximized = FALSE;
+  layout->fullscreen = FALSE;
+  layout->fullscreen_monitor = NULL;
+
+  return layout;
+}
+
+/**
+ * gdk_toplevel_layout_ref:
+ * @layout: a #GdkToplevelLayout
+ *
+ * Increases the reference count of @layout.
+ *
+ * Returns: the same @layout
+ */
+GdkToplevelLayout *
+gdk_toplevel_layout_ref (GdkToplevelLayout *layout)
+{
+  g_ref_count_inc (&layout->ref_count);
+  return layout;
+}
+
+/**
+ * gdk_toplevel_layout_unref:
+ * @layout: a #GdkToplevelLayout
+ *
+ * Decreases the reference count of @layout.
+ */
+void
+gdk_toplevel_layout_unref (GdkToplevelLayout *layout)
+{
+  if (g_ref_count_dec (&layout->ref_count))
+    {
+      g_clear_object (&layout->fullscreen_monitor);
+      g_free (layout);
+    }
+}
+
+/**
+ * gdk_toplevel_layout_copy:
+ * @layout: a #GdkToplevelLayout
+ *
+ * Create a new #GdkToplevelLayout and copy the contents of @layout into it.
+ *
+ * Returns: (transfer full): a copy of @layout.
+ */
+GdkToplevelLayout *
+gdk_toplevel_layout_copy (GdkToplevelLayout *layout)
+{
+  GdkToplevelLayout *new_layout;
+
+  new_layout = g_new0 (GdkToplevelLayout, 1);
+  g_ref_count_init (&new_layout->ref_count);
+
+  new_layout->min_width = layout->min_width;
+  new_layout->min_height = layout->min_height;
+  new_layout->resizable = layout->resizable;
+  new_layout->maximized = layout->maximized;
+  new_layout->fullscreen = layout->fullscreen;
+  if (layout->fullscreen_monitor)
+    new_layout->fullscreen_monitor = g_object_ref (layout->fullscreen_monitor);
+
+  return new_layout;
+}
+
+/**
+ * gdk_toplevel_layout_equal:
+ * @layout: a #GdkToplevelLayout
+ * @other: another #GdkToplevelLayout
+ *
+ * Check whether @layout and @other has identical layout properties.
+ *
+ * Returns: %TRUE if @layout and @other have identical layout properties,
+ *     otherwise %FALSE.
+ */
+gboolean
+gdk_toplevel_layout_equal (GdkToplevelLayout *layout,
+                           GdkToplevelLayout *other)
+{
+  g_return_val_if_fail (layout, FALSE);
+  g_return_val_if_fail (other, FALSE);
+
+  return layout->min_width == other->min_width &&
+         layout->min_height == other->min_height &&
+         layout->resizable == other->resizable &&
+         layout->maximized == other->maximized &&
+         layout->fullscreen == other->fullscreen &&
+         layout->fullscreen_monitor == other->fullscreen_monitor;
+}
+
+/**
+ * gdk_toplevel_layout_get_min_width:
+ * @layout: a #GdkToplevelLayout
+ *
+ * Returns the minimum width of the given layout.
+ *
+ * Returns: the minimum width of @layout
+ */
+int
+gdk_toplevel_layout_get_min_width (GdkToplevelLayout *layout)
+{
+  return layout->min_width;
+}
+
+/**
+ * gdk_toplevel_layout_get_min_height:
+ * @layout: a #GdkToplevelLayout
+ *
+ * Returns the minimum height of the given layout.
+ *
+ * Returns: the minimum height of @layout
+ */
+int
+gdk_toplevel_layout_get_min_height (GdkToplevelLayout *layout)
+{
+  return layout->min_height;
+}
+
+/**
+ * gdk_toplevel_layout_set_resizable:
+ * @layout: a #GdkToplevelLayout
+ * @resizable: %TRUE to allow resizing
+ *
+ * Sets whether the layout should allow the user
+ * to resize the surface after it has been presented.
+ */
+void
+gdk_toplevel_layout_set_resizable (GdkToplevelLayout *layout,
+                                   gboolean           resizable)
+{
+  layout->resizable = resizable;
+}
+
+/**
+ * gdk_toplevel_layout_get_resizable:
+ * @layout: a #GdkToplevelLayout
+ *
+ * Returns whether the layout should allow the user
+ * to resize the surface.
+ *
+ * Returns: %TRUE if the layout is resizable
+ */
+gboolean
+gdk_toplevel_layout_get_resizable (GdkToplevelLayout *layout)
+{
+  return layout->resizable;
+}
+
+/**
+ * gdk_toplevel_layout_set_maximized:
+ * @layout: a #GdkToplevelLayout
+ * @maximized: %TRUE to maximize
+ *
+ * Sets whether the layout should cause the surface
+ * to be maximized when presented.
+ */
+void
+gdk_toplevel_layout_set_maximized (GdkToplevelLayout *layout,
+                                   gboolean           maximized)
+{
+  layout->maximized = maximized;
+}
+
+/**
+ * gdk_toplevel_layout_get_maximized:
+ * @layout: a #GdkToplevelLayout
+ *
+ * Returns whether the layout should present the
+ * surface as maximized.
+ *
+ * Returns: %TRUE if the layout is maximized
+ */
+gboolean
+gdk_toplevel_layout_get_maximized (GdkToplevelLayout *layout)
+{
+  return layout->maximized;
+}
+
+/**
+ * gdk_toplevel_layout_set_fullscreen:
+ * @layout: a #GdkToplevelLayout
+ * @fullscreen: %TRUE to fullscreen the surface
+ * @monitor: (nullable): the monitor to fullscreen on
+ *
+ * Sets whether the layout should cause the surface
+ * to be fullscreen when presented.
+ */
+void
+gdk_toplevel_layout_set_fullscreen (GdkToplevelLayout *layout,
+                                    gboolean           fullscreen,
+                                    GdkMonitor        *monitor)
+{
+  layout->fullscreen = fullscreen;
+  if (monitor)
+    layout->fullscreen_monitor = g_object_ref (monitor);
+}
+
+/**
+ * gdk_toplevel_layout_get_fullscreen:
+ * @layout: a #GdkToplevelLayout
+ *
+ * Returns whether the layout should cause the surface
+ * to be fullscreen when presented.
+ *
+ * Returns: %TRUE if @layout is fullscreen
+ */
+gboolean
+gdk_toplevel_layout_get_fullscreen (GdkToplevelLayout *layout)
+{
+  return layout->fullscreen;
+}
+
+/**
+ * gdk_toplevel_layout_get_fullscreen_monitor:
+ * @layout: a #GdkToplevelLayout
+ *
+ * Returns the monitor that the layout is fullscreening
+ * the surface on.
+ *
+ * Returns: (nullable): the monitor on which @layout fullscreens
+ */
+GdkMonitor *
+gdk_toplevel_layout_get_fullscreen_monitor (GdkToplevelLayout *layout)
+{
+  return layout->fullscreen_monitor;
+}
diff --git a/gdk/gdktoplevellayout.h b/gdk/gdktoplevellayout.h
new file mode 100644
index 0000000000..1db7f27257
--- /dev/null
+++ b/gdk/gdktoplevellayout.h
@@ -0,0 +1,90 @@
+/* GDK - The GIMP Drawing Kit
+ * Copyright (C) 2020 Red Hat
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2 of the License, or (at your option) any later version.
+ *
+ * This library 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 library. If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+#ifndef __GDK_TOPLEVEL_LAYOUT_H__
+#define __GDK_TOPLEVEL_LAYOUT_H__
+
+#if !defined(__GDK_H_INSIDE__) && !defined(GTK_COMPILATION)
+#error "Only <gdk/gdk.h> can be included directly."
+#endif
+
+#include <gdk/gdkmonitor.h>
+#include <gdk/gdktypes.h>
+#include <gdk/gdkversionmacros.h>
+
+G_BEGIN_DECLS
+
+/**
+ * GdkTopLevelLayout:
+ */
+typedef struct _GdkToplevelLayout GdkToplevelLayout;
+
+#define GDK_TYPE_TOPLEVEL_LAYOUT (gdk_toplevel_layout_get_type ())
+
+GDK_AVAILABLE_IN_ALL
+GType                   gdk_toplevel_layout_get_type    (void);
+
+GDK_AVAILABLE_IN_ALL
+GdkToplevelLayout *     gdk_toplevel_layout_new         (int min_width,
+                                                         int min_height);
+
+GDK_AVAILABLE_IN_ALL
+GdkToplevelLayout *     gdk_toplevel_layout_ref         (GdkToplevelLayout *layout);
+
+GDK_AVAILABLE_IN_ALL
+void                    gdk_toplevel_layout_unref       (GdkToplevelLayout *layout);
+
+GDK_AVAILABLE_IN_ALL
+GdkToplevelLayout *     gdk_toplevel_layout_copy        (GdkToplevelLayout *layout);
+
+GDK_AVAILABLE_IN_ALL
+gboolean                gdk_toplevel_layout_equal       (GdkToplevelLayout *layout,
+                                                         GdkToplevelLayout *other);
+
+GDK_AVAILABLE_IN_ALL
+void                    gdk_toplevel_layout_set_maximized (GdkToplevelLayout *layout,
+                                                           gboolean           maximized);
+GDK_AVAILABLE_IN_ALL
+void                    gdk_toplevel_layout_set_fullscreen (GdkToplevelLayout *layout,
+                                                            gboolean           fullscreen,
+                                                            GdkMonitor        *monitor);
+
+GDK_AVAILABLE_IN_ALL
+int                     gdk_toplevel_layout_get_min_width  (GdkToplevelLayout *layout);
+GDK_AVAILABLE_IN_ALL
+int                     gdk_toplevel_layout_get_min_height (GdkToplevelLayout *layout);
+
+GDK_AVAILABLE_IN_ALL
+gboolean                gdk_toplevel_layout_get_maximized (GdkToplevelLayout *layout);
+
+GDK_AVAILABLE_IN_ALL
+gboolean                gdk_toplevel_layout_get_fullscreen (GdkToplevelLayout *layout);
+
+GDK_AVAILABLE_IN_ALL
+GdkMonitor *            gdk_toplevel_layout_get_fullscreen_monitor (GdkToplevelLayout *layout);
+
+GDK_AVAILABLE_IN_ALL
+void                    gdk_toplevel_layout_set_resizable (GdkToplevelLayout *layout,
+                                                           gboolean           resizable);
+
+GDK_AVAILABLE_IN_ALL
+gboolean                gdk_toplevel_layout_get_resizable (GdkToplevelLayout *layout);
+
+G_END_DECLS
+
+#endif /* __GDK_TOPLEVEL_LAYOUT_H__ */
diff --git a/gdk/meson.build b/gdk/meson.build
index 71d8393f92..27d1bc3cda 100644
--- a/gdk/meson.build
+++ b/gdk/meson.build
@@ -46,6 +46,7 @@ gdk_public_sources = files([
   'gdkpopuplayout.c',
   'gdkprofiler.c',
   'gdkpopup.c',
+  'gdktoplevellayout.c',
 ])
 
 gdk_public_headers = files([
@@ -91,6 +92,7 @@ gdk_public_headers = files([
   'gdksurface.h',
   'gdkpopuplayout.h',
   'gdkpopup.h',
+  'gdktoplevellayout.h',
 ])
 install_headers(gdk_public_headers, subdir: 'gtk-4.0/gdk/')