From 4dc4d8b318c9bee25ca9b2982495b2906cc76287 Mon Sep 17 00:00:00 2001
From: Vincent Sanders <vince@kyllikki.org>
Date: Tue, 20 Aug 2019 00:16:52 +0100
Subject: add miscellaneous event to browser window callback table

extend the browser window callback table with a miscallaneous event
 entry. This is used to replace all browser window callbacks which
 take no parameters.

This reduces the API surface from seven separate calls to a single
 call with an enumeration which may be readily extended.

The initial implementation in the frontends simply calls the original
 implementations to reduce scope for errors.
---
 include/netsurf/window.h | 121 +++++++++++++++++++++++++----------------------
 1 file changed, 65 insertions(+), 56 deletions(-)

(limited to 'include/netsurf/window.h')

diff --git a/include/netsurf/window.h b/include/netsurf/window.h
index 9f5371e97..e396f7820 100644
--- a/include/netsurf/window.h
+++ b/include/netsurf/window.h
@@ -28,6 +28,14 @@
 
 #include "netsurf/console.h"
 
+struct browser_window;
+struct form_control;
+struct rect;
+struct hlcache_handle;
+struct nsurl;
+
+enum gui_pointer_shape;
+
 typedef enum gui_save_type {
 	GUI_SAVE_SOURCE,
 	GUI_SAVE_DRAW,
@@ -61,13 +69,57 @@ typedef enum {
 	GW_CREATE_TAB = (1 << 1) /**< Create tab in same window as existing */
 } gui_window_create_flags;
 
-struct browser_window;
-struct form_control;
-struct rect;
-struct hlcache_handle;
-struct nsurl;
+/**
+ * Window events
+ *
+ * these are events delivered to a gui window which have no additional
+ * parameters and hence do not require separate callbacks.
+ */
+enum gui_window_event {
+	/**
+	 * An empty event should never occour
+	 */
+	GW_EVENT_NONE = 0,
 
-enum gui_pointer_shape;
+	/**
+	 * Update the extent of the inside of a browser window to that of the
+	 * current content.
+	 *
+	 * @todo this is used to update scroll bars does it need
+	 * renaming? some frontends (windows) do not even implement it.
+	 */
+	GW_EVENT_UPDATE_EXTENT,
+
+	/**
+	 * Remove the caret, if present.
+	 */
+	GW_EVENT_REMOVE_CARET,
+
+	/**
+	 * start the navigation throbber.
+	 */
+	GW_EVENT_START_THROBBER,
+
+	/**
+	 * stop the navigation throbber.
+	 */
+	GW_EVENT_STOP_THROBBER,
+
+	/**
+	 * Starts drag scrolling of a browser window
+	 */
+	GW_EVENT_SCROLL_START,
+
+	/**
+	 * Called when the gui_window has new content.
+	 */
+	GW_EVENT_NEW_CONTENT,
+
+	/**
+	 * selection started
+	 */
+	GW_EVENT_START_SELECTION,
+};
 
 /**
  * Graphical user interface window function table.
@@ -182,16 +234,16 @@ struct gui_window_table {
 
 
 	/**
-	 * Update the extent of the inside of a browser window to that of the
-	 * current content.
+	 * Miscelaneous event occoured for a window
 	 *
-	 * @todo this is used to update scroll bars does it need
-	 * renaming? some frontends (windows) do not even implement it.
+	 * This is used to inform the frontend of window events which
+	 *   require no additional parameters.
 	 *
-	 * \param gw The gui window to update the extent of.
+	 * \param gw The gui window the event occoured for
+	 * \param event Which event has occoured.
+	 * \return NSERROR_OK if teh event was processed else error code.
 	 */
-	void (*update_extent)(struct gui_window *gw);
-
+	nserror (*event)(struct gui_window *gw, enum gui_window_event event);
 
 	/* Optional entries */
 
@@ -246,27 +298,6 @@ struct gui_window_table {
 	 */
 	void (*place_caret)(struct gui_window *g, int x, int y, int height, const struct rect *clip);
 
-	/**
-	 * Remove the caret, if present.
-	 *
-	 * \param g window with caret
-	 */
-	void (*remove_caret)(struct gui_window *g);
-
-	/**
-	 * start the navigation throbber.
-	 *
-	 * \param g window in which to start throbber.
-	 */
-	void (*start_throbber)(struct gui_window *g);
-
-	/**
-	 * stop the navigation throbber.
-	 *
-	 * \param g window with throbber to stop
-	 */
-	void (*stop_throbber)(struct gui_window *g);
-
 	/**
 	 * start a drag operation within a window
 	 *
@@ -287,21 +318,6 @@ struct gui_window_table {
 	 */
 	nserror (*save_link)(struct gui_window *g, struct nsurl *url, const char *title);
 
-
-	/**
-	 * Starts drag scrolling of a browser window
-	 *
-	 * \param g the window to scroll
-	 */
-	bool (*scroll_start)(struct gui_window *g);
-
-	/**
-	 * Called when the gui_window has new content.
-	 *
-	 * \param gw The gui window that has new content
-	 */
-	void (*new_content)(struct gui_window *gw);
-
 	/**
 	 * create a form select menu
 	 *
@@ -336,13 +352,6 @@ struct gui_window_table {
 	 */
 	void (*drag_save_selection)(struct gui_window *gw, const char *selection);
 
-	/**
-	 * selection started
-	 *
-	 * \param gw The gui window to start selection in.
-	 */
-	void (*start_selection)(struct gui_window *gw);
-
 	/**
 	 * console logging happening.
 	 *
-- 
cgit v1.2.3