include test/lib/Makefile.am
include test/parser/Makefile.am
include test/urls/Makefile.am
+include test/ui/Makefile.am
include ui/common/Makefile.am
if WITH_NCURSES
--- /dev/null
+# 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; version 2 of the License.
+#
+# 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+
+ui_TESTS = \
+ test/ui/console-sequence
+
+TESTS += $(ui_TESTS)
+check_PROGRAMS += $(ui_TESTS)
+
+test_ui_console_sequence_SOURCES = \
+ test/ui/console-sequence.c
+
+test_ui_console_sequence_CPPFLAGS = \
+ -DPETITBOOT_TEST \
+ -I$(top_srcdir)/lib
+
+test_ui_console_sequence_LDFLAGS = \
+ $(core_lib)
+
+
+
+#$(ui_TESTS): LIBS += \
+# ui/ncurses/libpbnc.la \
+# $(core_lib) \
+# @MENU_LIB@ @FORM_LIB@ @CURSES_LIB@
--- /dev/null
+/*
+ * Copyright (C) 2017 IBM Corporation
+ *
+ * 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; version 2 of the License.
+ *
+ * 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.
+ *
+ */
+
+#include <stdlib.h>
+#include <string.h>
+#include <assert.h>
+#include <stdbool.h>
+#include <stdio.h>
+
+#include "talloc/talloc.h"
+
+#define ERR (-1)
+#define pb_log(...) printf(__VA_ARGS__)
+#define pb_debug(...) printf(__VA_ARGS__)
+
+/*
+ * Several example terminal commands, see:
+ * https://vt100.net/docs/vt100-ug/chapter3.html
+ */
+static char identify_rsp[] = {033, 0133, 077, 061, 073, 060, 0143, '\0'};
+static char decdwl[] = {033, 043, 066, '\0'};
+static char attrs[] = {033, 0133, 060, 073, 064, 073, 065, 0155, '\0'};
+static char cursor[] = {033, 070, '\0'};
+static char conf_test[] = {033, 0133, 062, 073, 061, 0171, '\0'};
+static char status[] = {033, 0133, 060, 0156, '\0'};
+static char erase_screen[] = {033, 0133, 062, 0112, '\0'};
+static char status_ok_rsp[] = {033, 0133, 064, 0156, '\0'};
+static char garbage[] = {001, 002, 003, 004, '\0'};
+static char esc_garbage[] = {033, 002, 003, 004, '\0'};
+static char *ptr;
+
+static signed char getch(void)
+{
+ if (!ptr || *ptr == '\0')
+ return -ERR;
+ return *ptr++;
+}
+
+#include "ui/ncurses/console-codes.c"
+
+int main(void)
+{
+ void *ctx;
+ char *seq, *confused;
+
+ ctx = talloc_new(NULL);
+
+ ptr = &identify_rsp[1];
+ printf("Identity response\n");
+ seq = handle_control_sequence(ctx, identify_rsp[0]);
+ assert(strncmp(seq, identify_rsp, strlen(identify_rsp)) == 0);
+
+ printf("DECDWL\n");
+ ptr = &decdwl[1];
+ seq = handle_control_sequence(ctx, decdwl[0]);
+ assert(strncmp(seq, decdwl, strlen(decdwl)) == 0);
+
+ printf("Attributes\n");
+ ptr = &attrs[1];
+ seq = handle_control_sequence(ctx, attrs[0]);
+ assert(strncmp(seq, attrs, strlen(attrs)) == 0);
+
+ printf("Reset Cursor\n");
+ ptr = &cursor[1];
+ seq = handle_control_sequence(ctx, cursor[0]);
+ assert(strncmp(seq, cursor, strlen(cursor)) == 0);
+
+ printf("Confidence Test\n");
+ ptr = &conf_test[1];
+ seq = handle_control_sequence(ctx, conf_test[0]);
+ assert(strncmp(seq, conf_test, strlen(conf_test)) == 0);
+
+ printf("Status\n");
+ ptr = &status[1];
+ seq = handle_control_sequence(ctx, status[0]);
+ assert(strncmp(seq, status, strlen(status)) == 0);
+
+ printf("Erase Screen\n");
+ ptr = &erase_screen[1];
+ seq = handle_control_sequence(ctx, erase_screen[0]);
+ assert(strncmp(seq, erase_screen, strlen(erase_screen)) == 0);
+
+ printf("Status Response\n");
+ ptr = &status_ok_rsp[1];
+ seq = handle_control_sequence(ctx, status_ok_rsp[0]);
+ assert(strncmp(seq, status_ok_rsp, strlen(status_ok_rsp)) == 0);
+
+ printf("Garbage\n");
+ ptr = &garbage[1];
+ seq = handle_control_sequence(ctx, garbage[0]);
+ assert(seq == NULL);
+
+ printf("ESC then Garbage\n");
+ ptr = &esc_garbage[1];
+ confused = talloc_asprintf(ctx, "%c%c...", 033, 002);
+ seq = handle_control_sequence(ctx, esc_garbage[0]);
+ assert(strncmp(seq, confused, strlen(confused)) == 0);
+
+ talloc_free(ctx);
+ return EXIT_SUCCESS;
+}
ui/ncurses/nc-config.c \
ui/ncurses/nc-config.h \
ui/ncurses/nc-config-help.c \
+ ui/ncurses/console-codes.c \
+ ui/ncurses/console-codes.h \
ui/ncurses/nc-cui.c \
ui/ncurses/nc-cui.h \
ui/ncurses/nc-cui-help.c \
--- /dev/null
+/*
+ * Copyright (C) 2017 IBM Corporation
+ *
+ * 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; version 2 of the License.
+ *
+ * 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.
+ *
+ */
+
+#if defined(HAVE_CONFIG_H)
+#include "config.h"
+#endif
+
+#include <ctype.h>
+#include <errno.h>
+#include <stdlib.h>
+#include <string.h>
+#include <stdbool.h>
+
+#include "talloc/talloc.h"
+
+#ifndef PETITBOOT_TEST
+#include "log/log.h"
+#include "nc-scr.h"
+#endif
+
+#include "console-codes.h"
+
+#define ESC_CHAR 033
+#define CSI_CHAR '['
+#define INTER_CHAR_START 040
+#define INTER_CHAR_END 057
+#define ESC_SEQUENCE_FINAL_START 060
+#define ESC_SEQUENCE_FINAL_END 0176
+#define CTRL_SEQUENCE_FINAL_START 0100
+#define CTRL_SEQUENCE_FINAL_END 0176
+#define DEC_PARAMETER 077
+
+enum console_sequence_state {
+ CONSOLE_STATE_START,
+ CONSOLE_STATE_ESC_SEQ,
+ CONSOLE_STATE_CTRL_SEQ_START,
+ CONSOLE_STATE_CTRL_SEQ,
+ CONSOLE_STATE_DONE,
+ CONSOLE_STATE_CONFUSED,
+};
+
+static inline bool is_intermediate(signed char c)
+{
+ return c > INTER_CHAR_START && c < INTER_CHAR_END;
+}
+
+static inline bool is_parameter(signed char c)
+{
+ return (c >= 060 && c <= 071) || c == 073;
+}
+
+static inline bool is_escape_final(signed char c)
+{
+ return c >= ESC_SEQUENCE_FINAL_START && c < ESC_SEQUENCE_FINAL_END;
+}
+
+static inline bool is_control_final(signed char c)
+{
+ return c >= CTRL_SEQUENCE_FINAL_START && c <= CTRL_SEQUENCE_FINAL_END;
+}
+
+static char console_sequence_getch(char **sequence)
+{
+ signed char c = getch();
+
+ if (c != ERR)
+ *sequence = talloc_asprintf_append(*sequence, "%c", c);
+ return c;
+}
+
+/*
+ * Catch terminal control sequences that have accidentally been sent to
+ * Petitboot. These are of the form
+ * ESC I .. I F
+ * where I is an Intermediate Character and F is a Final Character, eg:
+ * ESC ^ [ ? 1 ; 0 c
+ * or ESC # 6
+ *
+ * This is based off the definitions provided by
+ * https://vt100.net/docs/vt100-ug/contents.html
+ */
+char *handle_control_sequence(void *ctx, signed char start)
+{
+ enum console_sequence_state state = CONSOLE_STATE_START;
+ bool in_sequence = true;
+ signed char c;
+ char *seq;
+
+ if (start != ESC_CHAR) {
+ pb_log("%s: Called with non-escape character: 0%o\n",
+ __func__, start);
+ return NULL;
+ }
+
+ seq = talloc_asprintf(ctx, "%c", start);
+
+ while (in_sequence) {
+ switch (state) {
+ case CONSOLE_STATE_START:
+ c = console_sequence_getch(&seq);
+ if (c == CSI_CHAR)
+ state = CONSOLE_STATE_CTRL_SEQ_START;
+ else if (is_intermediate(c))
+ state = CONSOLE_STATE_ESC_SEQ;
+ else if (is_escape_final(c))
+ state = CONSOLE_STATE_DONE;
+ else if (c != ERR) {
+ /* wait on c == ERR */
+ pb_debug("Unexpected start: \\x%x\n", c);
+ state = CONSOLE_STATE_CONFUSED;
+ }
+ break;
+ case CONSOLE_STATE_ESC_SEQ:
+ c = console_sequence_getch(&seq);
+ if (is_intermediate(c))
+ state = CONSOLE_STATE_ESC_SEQ;
+ else if (is_escape_final(c))
+ state = CONSOLE_STATE_DONE;
+ else if (c != ERR) {
+ /* wait on c == ERR */
+ pb_debug("Unexpected character after intermediate: \\x%x\n",
+ c);
+ state = CONSOLE_STATE_CONFUSED;
+ }
+ break;
+ case CONSOLE_STATE_CTRL_SEQ_START:
+ c = console_sequence_getch(&seq);
+ if (is_intermediate(c) || is_parameter(c) ||
+ c == DEC_PARAMETER)
+ state = CONSOLE_STATE_CTRL_SEQ;
+ else if (is_control_final(c))
+ state = CONSOLE_STATE_DONE;
+ else if (c != ERR) {
+ /* wait on c == ERR */
+ pb_debug("Unexpected character in param string: \\x%x\n",
+ c);
+ state = CONSOLE_STATE_CONFUSED;
+ }
+ break;
+ case CONSOLE_STATE_CTRL_SEQ:
+ c = console_sequence_getch(&seq);
+ if (is_intermediate(c) || is_parameter(c))
+ state = CONSOLE_STATE_CTRL_SEQ;
+ else if (is_control_final(c))
+ state = CONSOLE_STATE_DONE;
+ else if (c != ERR) {
+ /* wait on c == ERR */
+ pb_debug("Unexpected character in param string: \\x%x\n",
+ c);
+ state = CONSOLE_STATE_CONFUSED;
+ }
+ break;
+ case CONSOLE_STATE_DONE:
+ in_sequence = false;
+ break;
+ case CONSOLE_STATE_CONFUSED:
+ /* fall-through */
+ default:
+ pb_debug("We got lost interpreting a control sequence!\n");
+ seq = talloc_asprintf_append(seq, "...");
+ in_sequence = false;
+ break;
+ };
+ }
+
+ return seq;
+}
--- /dev/null
+/*
+ * Copyright (C) 2017 IBM Corporation
+ *
+ * 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; version 2 of the License.
+ *
+ * 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.
+ *
+ */
+
+#if !defined(_PB_UI_CONSOLE_CODES)
+#define _PB_UI_CONSOLE_CODES
+
+char *handle_control_sequence(void *ctx, signed char start);
+
+#endif
#endif
#include <assert.h>
+#include <ctype.h>
#include <errno.h>
#include <stdlib.h>
#include <string.h>
#include "nc-statuslog.h"
#include "nc-subset.h"
#include "nc-plugin.h"
+#include "console-codes.h"
extern const struct help_text main_menu_help_text;
extern const struct help_text plugin_menu_help_text;
static int cui_process_key(void *arg)
{
struct cui *cui = cui_from_arg(arg);
+ unsigned int i;
+ char *sequence;
+ int grab;
assert(cui->current);
if (c == ERR)
break;
+ if (c == 27) {
+ /*
+ * If this is a console code sequence try to parse it
+ * and don't treat this as a key press.
+ */
+ grab = getch();
+ if (grab != ERR && grab != 27) {
+ ungetch(grab);
+ pb_debug("%s: Caught unhandled command sequence\n",
+ __func__);
+ sequence = handle_control_sequence(cui, c);
+ pb_debug("Caught sequence ");
+ if (sequence) {
+ pb_debug("(%zu): ", strlen(sequence));
+ for (i = 0; i < strlen(sequence); i++)
+ pb_debug("0%o ", sequence[i]);
+ pb_debug("\n");
+ } else
+ pb_debug("(0): (none)\n");
+ continue;
+ }
+ }
+
if (!cui->has_input) {
cui->has_input = true;
if (cui->client) {
projects / petitboot / commitdiff