[hci] Split out msg() and alert() from settings UI code

The msg() and alert() functions currently defined in settings_ui.c
provide a general-purpose facility for printing messages centred on
the screen.

Split this out to a separate file to allow for reuse by the form
presentation code.

Signed-off-by: Michael Brown <mcb30@ipxe.org>

diff --git a/src/hci/tui/message.c b/src/hci/tui/message.c
new file mode 100644 (file)
index 0000000..e3331d6
--- /dev/null
+++ b/src/hci/tui/message.c
@@ -0,0 +1,109 @@
+/*
+ * Copyright (C) 2024 Michael Brown <mbrown@fensystems.co.uk>.
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License as
+ * published by the Free Software Foundation; either version 2 of the
+ * License, or any later version.
+ *
+ * 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, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+ * 02110-1301, USA.
+ *
+ * You can also choose to distribute this program under the terms of
+ * the Unmodified Binary Distribution Licence (as given in the file
+ * COPYING.UBDL), provided that you have satisfied its requirements.
+ */
+
+FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+
+/** @file
+ *
+ * Message printing
+ *
+ */
+
+#include <stddef.h>
+#include <stdint.h>
+#include <stdarg.h>
+#include <unistd.h>
+#include <ipxe/ansicol.h>
+#include <ipxe/message.h>
+
+/**
+ * Print message centred on specified row
+ *
+ * @v row              Row
+ * @v fmt              printf() format string
+ * @v args             printf() argument list
+ */
+static void vmsg ( unsigned int row, const char *fmt, va_list args ) {
+       char buf[COLS];
+       size_t len;
+
+       len = vsnprintf ( buf, sizeof ( buf ), fmt, args );
+       mvprintw ( row, ( ( COLS - len ) / 2 ), "%s", buf );
+}
+
+/**
+ * Print message centred on specified row
+ *
+ * @v row              Row
+ * @v fmt              printf() format string
+ * @v ..               printf() arguments
+ */
+void msg ( unsigned int row, const char *fmt, ... ) {
+       va_list args;
+
+       va_start ( args, fmt );
+       vmsg ( row, fmt, args );
+       va_end ( args );
+}
+
+/**
+ * Clear message on specified row
+ *
+ * @v row              Row
+ */
+void clearmsg ( unsigned int row ) {
+       move ( row, 0 );
+       clrtoeol();
+}
+
+/**
+ * Show alert message
+ *
+ * @v row              Row
+ * @v fmt              printf() format string
+ * @v args             printf() argument list
+ */
+static void valert ( unsigned int row, const char *fmt, va_list args ) {
+
+       clearmsg ( row );
+       color_set ( CPAIR_ALERT, NULL );
+       vmsg ( row, fmt, args );
+       sleep ( 2 );
+       color_set ( CPAIR_NORMAL, NULL );
+       clearmsg ( row );
+}
+
+/**
+ * Show alert message
+ *
+ * @v row              Row
+ * @v fmt              printf() format string
+ * @v ...              printf() arguments
+ */
+void alert ( unsigned int row, const char *fmt, ... ) {
+       va_list args;
+
+       va_start ( args, fmt );
+       valert ( row, fmt, args );
+       va_end ( args );
+}

diff --git a/src/hci/tui/settings_ui.c b/src/hci/tui/settings_ui.c
index 045d9785376feeb1e34eda1eb7a19a7b1144dedd..10c942321920cba7076079efedc295aaec4f3a90 100644 (file)
--- a/src/hci/tui/settings_ui.c
+++ b/src/hci/tui/settings_ui.c
@@ -35,6 +35,7 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 #include <ipxe/keys.h>
 #include <ipxe/ansicol.h>
 #include <ipxe/jumpscroll.h>
+#include <ipxe/message.h>
 #include <ipxe/settings_ui.h>
 #include <config/branding.h>
 
@@ -266,75 +267,6 @@ static int save_setting ( struct settings_ui *ui ) {
        return storef_setting ( ui->settings, &ui->row.setting, ui->row.buf );
 }
 
-/**
- * Print message centred on specified row
- *
- * @v row              Row
- * @v fmt              printf() format string
- * @v args             printf() argument list
- */
-static void vmsg ( unsigned int row, const char *fmt, va_list args ) {
-       char buf[COLS];
-       size_t len;
-
-       len = vsnprintf ( buf, sizeof ( buf ), fmt, args );
-       mvprintw ( row, ( ( COLS - len ) / 2 ), "%s", buf );
-}
-
-/**
- * Print message centred on specified row
- *
- * @v row              Row
- * @v fmt              printf() format string
- * @v ..               printf() arguments
- */
-static void msg ( unsigned int row, const char *fmt, ... ) {
-       va_list args;
-
-       va_start ( args, fmt );
-       vmsg ( row, fmt, args );
-       va_end ( args );
-}
-
-/**
- * Clear message on specified row
- *
- * @v row              Row
- */
-static void clearmsg ( unsigned int row ) {
-       move ( row, 0 );
-       clrtoeol();
-}
-
-/**
- * Print alert message
- *
- * @v fmt              printf() format string
- * @v args             printf() argument list
- */
-static void valert ( const char *fmt, va_list args ) {
-       clearmsg ( ALERT_ROW );
-       color_set ( CPAIR_ALERT, NULL );
-       vmsg ( ALERT_ROW, fmt, args );
-       sleep ( 2 );
-       color_set ( CPAIR_NORMAL, NULL );
-       clearmsg ( ALERT_ROW );
-}
-
-/**
- * Print alert message
- *
- * @v fmt              printf() format string
- * @v ...              printf() arguments
- */
-static void alert ( const char *fmt, ... ) {
-       va_list args;
-
-       va_start ( args, fmt );
-       valert ( fmt, args );
-       va_end ( args );
-}
-
 /**
  * Draw title row
  *
@@ -488,8 +420,10 @@ static int main_loop ( struct settings *settings ) {
                        switch ( key ) {
                        case CR:
                        case LF:
-                               if ( ( rc = save_setting ( &ui ) ) != 0 )
-                                       alert ( " %s ", strerror ( rc ) );
+                               if ( ( rc = save_setting ( &ui ) ) != 0 ) {
+                                       alert ( ALERT_ROW, " %s ",
+                                               strerror ( rc ) );
+                               }
                                /* Fall through */
                        case CTRL_C:
                                select_setting_row ( &ui, ui.scroll.current );
@@ -526,7 +460,7 @@ static int main_loop ( struct settings *settings ) {
                                break;
                        if ( ( rc = delete_setting ( ui.settings,
                                                     &ui.row.setting ) ) != 0 ){
-                               alert ( " %s ", strerror ( rc ) );
+                               alert ( ALERT_ROW, " %s ", strerror ( rc ) );
                        }
                        select_setting_row ( &ui, ui.scroll.current );
                        redraw = 1;

diff --git a/src/include/ipxe/message.h b/src/include/ipxe/message.h
new file mode 100644 (file)
index 0000000..e2e7837
--- /dev/null
+++ b/src/include/ipxe/message.h
@@ -0,0 +1,16 @@
+#ifndef _IPXE_MESSAGE_H
+#define _IPXE_MESSAGE_H
+
+/** @file
+ *
+ * Message printing
+ *
+ */
+
+FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+
+extern void msg ( unsigned int row, const char *fmt, ... );
+extern void clearmsg ( unsigned int row );
+extern void alert ( unsigned int row, const char *fmt, ... );
+
+#endif /* _IPXE_MESSAGE_H */