Changeset 3d10a2f in mainline

Timestamp:

2021-10-04T12:25:43Z (3 years ago)

Author:

Jiri Svoboda <jiri@…>

Branches:

master, serial, ticket/834-toolchain-update, topic/msim-upgrade, topic/simplify-dev-export

Children:

cd981f2a, e0e1b3d

Parents:

6d172f6

git-author:

Jiri Svoboda <jiri@…> (2021-10-03 17:25:36)

git-committer:

Jiri Svoboda <jiri@…> (2021-10-04 12:25:43)

Message:

Null display spec for the benefit of unit testing

When testing something that takes a display specification as argument,
it is useful to be able to be able to specify dummy output (so far,
only ui_create_disp() could create a UI with dummy output.

Location:

uspace/lib/ui

Files:

• include/types/ui/ui.h (modified) (2 diffs)
• include/ui/window.h (modified) (1 diff)
• src/ui.c (modified) (4 diffs)
• src/window.c (modified) (1 diff)
• test/window.c (modified) (1 diff)

uspace/lib/ui/include/types/ui/ui.h

@@ -46 +46 @@
 /** Use the default console service (argument to ui_create()) */
 #define UI_CONSOLE_DEFAULT "cons@"
+/** Use dummy output (argument to ui_create()) */
+#define UI_DISPLAY_NULL "null@"
 
 /** Window system */
@@ -54 +56 @@
         ui_ws_display,
         /** Console */
-        ui_ws_console
+        ui_ws_console,
+        /** Dummy output */
+        ui_ws_null
 } ui_winsys_t;
 

uspace/lib/ui/include/ui/window.h

@@ -56 +56 @@
 extern ui_window_t *ui_window_get_active(ui_t *);
 extern errno_t ui_window_resize(ui_window_t *, gfx_rect_t *);
+extern ui_t *ui_window_get_ui(ui_window_t *);
 extern ui_resource_t *ui_window_get_res(ui_window_t *);
 extern gfx_context_t *ui_window_get_gc(ui_window_t *);

uspace/lib/ui/src/ui.c

@@ -55 +55 @@
  *
  * Output specification has the form <proto>@<service> where proto is
- * eiher 'disp' for display service or 'cons' for console. Service
- * is a location ID service name (e.g. hid/display).
+ * eiher 'disp' for display service, 'cons' for console, 'null'
+ * for dummy output. Service is a location ID service name (e.g. hid/display).
  *
  * @param ospec Output specification
@@ -82 +82 @@
                 } else if (str_lcmp(ospec, "cons@", str_length("cons@")) == 0) {
                         *ws = ui_ws_console;
+                } else if (str_lcmp(ospec, "null@", str_length("null@")) == 0) {
+                        *ws = ui_ws_null;
                 } else {
                         *ws = ui_ws_unknown;
@@ -99 +101 @@
  *
  * @param ospec Output specification or @c UI_DISPLAY_DEFAULT to use
- *              the default output
+ *              the default display service, UI_CONSOLE_DEFAULT to use
+ *              the default console service, UI_DISPLAY_NULL to use
+ *              dummy output.
  * @param rui Place to store pointer to new UI
  * @return EOK on success or an error code
@@ -161 +165 @@
 
                 (void) ui_paint(ui);
+        } else if (ws == ui_ws_null) {
+                rc = ui_create_disp(NULL, &ui);
+                if (rc != EOK)
+                        return rc;
         } else {
                 return EINVAL;

uspace/lib/ui/src/window.c

@@ -601 +601 @@
 }
 
+/** Get window's containing UI.
+ *
+ * @param window Window
+ * @return Containing UI
+ */
+ui_t *ui_window_get_ui(ui_window_t *window)
+{
+        return window->ui;
+}
+
 /** Get UI resource from window.
  *

uspace/lib/ui/test/window.c

@@ -258 +258 @@
 }
 
+/** ui_window_get_ui() returns containing UI */
+PCUT_TEST(get_ui)
+{
+        errno_t rc;
+        ui_t *ui = NULL;
+        ui_t *rui;
+        ui_wnd_params_t params;
+        ui_window_t *window = NULL;
+
+        rc = ui_create_disp(NULL, &ui);
+        PCUT_ASSERT_ERRNO_VAL(EOK, rc);
+
+        ui_wnd_params_init(&params);
+        params.caption = "Hello";
+
+        rc = ui_window_create(ui, &params, &window);
+        PCUT_ASSERT_ERRNO_VAL(EOK, rc);
+        PCUT_ASSERT_NOT_NULL(window);
+
+        rui = ui_window_get_ui(window);
+        PCUT_ASSERT_EQUALS(ui, rui);
+
+        ui_window_destroy(window);
+        ui_destroy(ui);
+}
+
 /** ui_window_get_res/gc/rect() return valid objects */
 PCUT_TEST(get_res_gc_rect)