* [PATCH v6 1/8] edit: Initial revision.
2025-04-06 22:12 [PATCH v6 0/8] Line Editor Grant Erickson
@ 2025-04-06 22:12 ` Grant Erickson
2025-04-06 22:12 ` [PATCH v6 2/8] ell: Add include directive for 'ell/edit.h' Grant Erickson
` (6 subsequent siblings)
7 siblings, 0 replies; 9+ messages in thread
From: Grant Erickson @ 2025-04-06 22:12 UTC (permalink / raw)
To: ell
Initial revision of 'edit.[hc]', a line editor.
---
ell/edit.c | 785 +++++++++++++++++++++++++++++++++++++++++++++++++++++
ell/edit.h | 59 ++++
2 files changed, 844 insertions(+)
create mode 100644 ell/edit.c
create mode 100644 ell/edit.h
diff --git a/ell/edit.c b/ell/edit.c
new file mode 100644
index 000000000000..899fea4da830
--- /dev/null
+++ b/ell/edit.c
@@ -0,0 +1,785 @@
+/*
+ * Embedded Linux library
+ * Copyright (C) 2023 Intel Corporation
+ *
+ * SPDX-License-Identifier: LGPL-2.1-or-later
+ */
+
+#ifdef HAVE_CONFIG_H
+#include <config.h>
+#endif
+
+#include <stdio.h>
+#include <fcntl.h>
+#include <unistd.h>
+#include <stdlib.h>
+
+#include "private.h"
+#include "string.h"
+#include "edit.h"
+
+#define DEFAULT_BUFFER_SIZE (15)
+
+struct input_buf {
+ wchar_t *buf;
+ size_t size;
+ size_t len;
+ size_t pos;
+ struct input_buf *next;
+};
+
+struct l_edit {
+ struct input_buf *head;
+ struct input_buf *main;
+ size_t list_count;
+ size_t max_list_size;
+ size_t max_input_len;
+ size_t max_display_len;
+ l_edit_display_func_t display_handler;
+ void *display_data;
+ l_edit_debug_func_t debug_handler;
+ void *debug_data;
+};
+
+static inline size_t next_power(size_t len)
+{
+ size_t n = 1;
+
+ if (len > SIZE_MAX / 2)
+ return SIZE_MAX;
+
+ while (n < len)
+ n = n << 1;
+
+ return n;
+}
+
+static void grow_input_buf(struct input_buf *buf, size_t extra)
+{
+ if (buf->len + extra < buf->size)
+ return;
+
+ buf->size = next_power(buf->len + extra + 1);
+ buf->buf = l_realloc(buf->buf, sizeof(wchar_t) * buf->size);
+}
+
+static struct input_buf *alloc_sized_input_buf(size_t initial_size)
+{
+ struct input_buf *buf;
+
+ buf = l_new(struct input_buf, 1);
+
+ /* Set up new input buffer with initial size */
+ buf->size = initial_size + 1;
+ buf->buf = l_malloc(sizeof(wchar_t) * buf->size);
+ buf->buf[0] = L'\0';
+ buf->pos = 0;
+ buf->len = 0;
+ buf->next = NULL;
+
+ return buf;
+}
+
+static struct input_buf *alloc_duplicate_input_buf(struct input_buf *ref)
+{
+ struct input_buf *buf;
+
+ if (!ref)
+ return NULL;
+
+ buf = l_new(struct input_buf, 1);
+
+ /* Set up new input buffer and copy from the reference */
+ buf->size = ref->len;
+ buf->buf = wcsdup(ref->buf);
+ buf->pos = ref->len;
+ buf->len = ref->len;
+ buf->next = NULL;
+
+ return buf;
+}
+
+static void reset_input_buf(struct input_buf *buf, const char *input)
+{
+ if (input) {
+ size_t len;
+
+ /* Calculate the required size of the wide character string
+ * including its terminating null character.
+ */
+ len = mbstowcs(NULL, input, 0) + 1;
+
+ /* If the current buffer is to small, then allocate a new
+ * one and free the previous one. Since in most cases the
+ * data is different, there is no need for using re-alloc
+ * procedure here.
+ */
+ if (len > buf->size) {
+ l_free(buf->buf);
+
+ buf->size = len;
+ buf->buf = l_malloc(sizeof(wchar_t) * buf->size);
+ }
+
+ /* Convert the multibyte input into a wide character string
+ * and then move the cursor to the end.
+ */
+ buf->len = mbstowcs(buf->buf, input, buf->size);
+ buf->pos = buf->len;
+ } else {
+ /* Reset the main item to an empty string */
+ buf->buf[0] = L'\0';
+ buf->pos = 0;
+ buf->len = 0;
+ }
+}
+
+static void enforce_max_input_len(struct input_buf *buf, size_t max_len)
+{
+ /* When no limit is set, then nothing to do here */
+ if (max_len == 0)
+ return;
+
+ /* If the current buffer is to large, then truncate it and move
+ * the cursor to the end if needed.
+ */
+ if (buf->len > max_len) {
+ buf->len = max_len;
+ if (buf->pos > buf->len)
+ buf->pos = buf->len;
+ buf->buf[buf->len] = L'\0';
+ }
+}
+
+static void free_input_buf(struct input_buf *buf)
+{
+ l_free(buf->buf);
+ l_free(buf);
+}
+
+LIB_EXPORT struct l_edit *l_edit_new(void)
+{
+ static size_t initial_size = 15;
+ struct l_edit *edit;
+
+ edit = l_new(struct l_edit, 1);
+
+ edit->head = alloc_sized_input_buf(initial_size);
+ edit->main = edit->head;
+ edit->list_count = 0;
+ edit->max_list_size = 0;
+ edit->max_input_len = 0;
+ edit->max_display_len = 0;
+
+ return edit;
+}
+
+LIB_EXPORT void l_edit_free(struct l_edit *edit)
+{
+ struct input_buf *buf;
+
+ if (!edit)
+ return;
+
+ buf = edit->head;
+ while (buf) {
+ struct input_buf *tmp = buf->next;
+ free_input_buf(buf);
+ buf = tmp;
+ }
+
+ l_free(edit);
+}
+
+static void update_debug(struct l_edit *edit)
+{
+ struct input_buf *buf;
+ struct l_string *str;
+ char *tmp;
+ size_t len;
+ unsigned int pos = 0;
+
+ if (!edit->debug_handler)
+ return;
+
+ str = l_string_new(edit->head->len + 32);
+
+ l_string_append_printf(str, "Display : %zu\n", edit->max_display_len);
+ l_string_append_printf(str, "Buffer : %zu\n", edit->main->size);
+ if (edit->max_input_len)
+ l_string_append_printf(str, "Input : %zu/%zu\n",
+ edit->main->len, edit->max_input_len);
+ else
+ l_string_append_printf(str, "Input : %zu/unlimited\n",
+ edit->main->len);
+ l_string_append_printf(str, "Cursor : %zu\n", edit->main->pos);
+ l_string_append_printf(str, "History : %zu/%zu\n",
+ edit->list_count, edit->max_list_size);
+
+ buf = edit->head;
+ while (buf) {
+ len = wcstombs(NULL, buf->buf, 0) + 1;
+ tmp = l_malloc(len);
+ wcstombs(tmp, buf->buf, len);
+ l_string_append_printf(str, "%3u %s\n", pos, tmp);
+ l_free(tmp);
+ pos++;
+ buf = buf->next;
+ }
+
+ tmp = l_string_unwrap(str);
+
+ edit->debug_handler(tmp, edit->debug_data);
+
+ l_free(tmp);
+}
+
+LIB_EXPORT bool l_edit_set_debug_handler(struct l_edit *edit,
+ l_edit_debug_func_t handler, void *user_data)
+{
+ if (!edit)
+ return false;
+
+ edit->debug_handler = handler;
+ edit->debug_data = user_data;
+
+ update_debug(edit);
+
+ return true;
+}
+
+static void update_display(struct l_edit *edit)
+{
+ const wchar_t *buf = edit->main->buf;
+ size_t len = edit->main->len;
+ size_t pos = edit->main->pos;
+
+ if (!edit->display_handler)
+ return;
+
+ if (edit->max_display_len > 0) {
+ /* Move buffer until current position is in display size */
+ while (pos >= edit->max_display_len) {
+ buf++;
+ len--;
+ pos--;
+ }
+
+ /* Reduce the length until it fits in display size */
+ while (len > edit->max_display_len)
+ len--;
+ }
+
+ edit->display_handler(buf, len, pos, edit->display_data);
+
+ update_debug(edit);
+}
+
+LIB_EXPORT bool l_edit_set_display_handler(struct l_edit *edit,
+ l_edit_display_func_t handler, void *user_data)
+{
+ if (!edit)
+ return false;
+
+ edit->display_handler = handler;
+ edit->display_data = user_data;
+
+ update_display(edit);
+
+ return true;
+}
+
+LIB_EXPORT bool l_edit_set_max_display_length(struct l_edit *edit, size_t len)
+{
+ if (!edit)
+ return false;
+
+ edit->max_display_len= len;
+
+ update_display(edit);
+
+ return true;
+}
+
+LIB_EXPORT bool l_edit_set_max_input_length(struct l_edit *edit, size_t len)
+{
+ if (!edit)
+ return false;
+
+ /* When switching to unlimited input length, then nothing is there
+ * do to, except storing the value. Refreshing the display is not
+ * needed since everything is already present.
+ */
+ if (len == 0) {
+ edit->max_input_len = 0;
+ update_debug(edit);
+ return true;
+ }
+
+ edit->max_input_len = len;
+
+ if (edit->main->len > edit->max_input_len) {
+ /* If the current length is longer, then it is required to
+ * truncate and if needed move the cursor to the end.
+ */
+ edit->main->len = edit->max_input_len;
+ if (edit->main->pos > edit->main->len)
+ edit->main->pos = edit->main->len;
+ edit->main->buf[edit->main->len] = L'\0';
+ update_display(edit);
+ } else {
+ /* Since nothing has to be updated for the display, make
+ * sure the debug output is updated manually.
+ */
+ update_debug(edit);
+ }
+
+ return true;
+}
+
+LIB_EXPORT bool l_edit_set_history_size(struct l_edit *edit, unsigned int size)
+{
+ if (!edit)
+ return false;
+
+ edit->max_list_size = size;
+
+ if (edit->list_count > edit->max_list_size) {
+ struct input_buf *buf = edit->head;
+ struct input_buf *last;
+ size_t count = 0;
+
+ /* Truncating the history means, thattthe last still valid
+ * entry needs to be found.
+ */
+ while (count < edit->max_list_size) {
+ if (!buf->next)
+ break;
+ count++;
+ buf = buf->next;
+ }
+
+ /* Terminate the list on the last item and store it for
+ * later use.
+ */
+ last = buf;
+ buf = last->next;
+ last->next = NULL;
+
+ /* Now free the tail of the list. In case the history index
+ * was present in the tail, move it to the last item.
+ */
+ while (buf) {
+ struct input_buf *tmp = buf->next;
+ if (buf == edit->main)
+ edit->main = last;
+ free_input_buf(buf);
+ buf = tmp;
+ }
+
+ edit->list_count = count;
+ }
+
+ update_display(edit);
+
+ return true;
+}
+
+LIB_EXPORT bool l_edit_refresh(struct l_edit *edit)
+{
+ if (!edit)
+ return false;
+
+ update_display(edit);
+
+ return true;
+}
+
+LIB_EXPORT bool l_edit_is_empty(struct l_edit *edit)
+{
+ if (!edit)
+ return true;
+
+ return (edit->main->len == 0);
+}
+
+LIB_EXPORT char *l_edit_enter(struct l_edit *edit)
+{
+ struct input_buf *buf;
+ char *str;
+ size_t len;
+
+ if (!edit)
+ return NULL;
+
+ /* Convert the wide character string into the multibyte string
+ * representation like UTF-8 for example.
+ */
+ len = wcstombs(NULL, edit->main->buf, 0) + 1;
+ str = l_malloc(len);
+ wcstombs(str, edit->main->buf, len);
+
+ if (edit->main->len > 0) {
+ /* If the current entered item is different from the first
+ * one in history (if history is present), then allocate
+ * a copy of that item and push it to the head of the
+ * history list.
+ */
+ if (!edit->head->next || wcscmp(edit->main->buf,
+ edit->head->next->buf)) {
+ buf = alloc_duplicate_input_buf(edit->main);
+ buf->next = edit->head->next;
+ edit->head->next = buf;
+ edit->list_count++;
+ }
+
+ /* Reset the head item, since that becomes the next
+ * main input item.
+ */
+ edit->head->buf[0] = L'\0';
+ edit->head->pos = 0;
+ edit->head->len = 0;
+
+ /* If the history size has grown to large, remove the
+ * last item from the list.
+ */
+ if (edit->list_count > edit->max_list_size) {
+ buf = edit->head;
+ while (buf->next) {
+ if (!buf->next->next) {
+ free_input_buf(buf->next);
+ buf->next = NULL;
+ edit->list_count--;
+ break;
+ }
+ buf = buf->next;
+ }
+ }
+ }
+
+ edit->main = edit->head;
+ update_display(edit);
+
+ return str;
+}
+
+LIB_EXPORT bool l_edit_reset(struct l_edit *edit, const char *input)
+{
+ if (!edit)
+ return false;
+
+ /* Reset the main item back to the head of the history before
+ * resetting it or overwriting it with the provided input.
+ */
+ edit->main = edit->head;
+
+ reset_input_buf(edit->main, input);
+ update_display(edit);
+
+ return true;
+}
+
+LIB_EXPORT bool l_edit_insert(struct l_edit *edit, wint_t ch)
+{
+ if (!edit)
+ return false;
+
+ /* Check if the max input length has already been reached */
+ if (edit->max_input_len && edit->main->len >= edit->max_input_len)
+ return false;
+
+ /* This will magically grow the buffer to make room for at least
+ * one wide character.
+ */
+ grow_input_buf(edit->main, 1);
+
+ /* If length is already the same as the max size of a possible
+ * string, there is nothing more to add.
+ */
+ if (edit->main->len == SIZE_MAX)
+ return false;
+
+ /* If the cursor is not at the end, the new character has to be
+ * inserted and for thus the tail portion needs to move one
+ * character back.
+ */
+ if (edit->main->len != edit->main->pos)
+ wmemmove(edit->main->buf + edit->main->pos + 1,
+ edit->main->buf + edit->main->pos,
+ edit->main->len - edit->main->pos);
+ edit->main->buf[edit->main->pos] = ch;
+ edit->main->pos++;
+ edit->main->len++;
+ edit->main->buf[edit->main->len] = L'\0';
+ update_display(edit);
+
+ return true;
+}
+
+LIB_EXPORT bool l_edit_delete(struct l_edit *edit)
+{
+ if (!edit)
+ return false;
+
+ /* If the cursor is not at the end, deletion of a character means
+ * that the tail moves one character forward.
+ */
+ if (edit->main->len > 0 && edit->main->pos < edit->main->len) {
+ wmemmove(edit->main->buf + edit->main->pos,
+ edit->main->buf + edit->main->pos + 1,
+ edit->main->len - edit->main->pos - 1);
+ edit->main->len--;
+ edit->main->buf[edit->main->len] = L'\0';
+ update_display(edit);
+ }
+
+ return true;
+}
+
+LIB_EXPORT bool l_edit_delete_all(struct l_edit *edit)
+{
+ if (!edit)
+ return false;
+
+ /* Keep the buffer allocated, but reset it to an empty string */
+ edit->main->buf[0] = L'\0';
+ edit->main->pos = 0;
+ edit->main->len = 0;
+ update_display(edit);
+
+ return true;
+}
+
+LIB_EXPORT bool l_edit_truncate(struct l_edit *edit)
+{
+ if (!edit)
+ return false;
+
+ /* Keep the buffer allocated, but truncate after the cursor */
+ edit->main->buf[edit->main->pos] = L'\0';
+ edit->main->len = edit->main->pos;
+ update_display(edit);
+
+ return true;
+}
+
+LIB_EXPORT bool l_edit_backspace(struct l_edit *edit)
+{
+ if (!edit)
+ return false;
+
+ /* If the cursor is not at the beginning, the backspace operation
+ * means that tail has to move one character forward.
+ */
+ if (edit->main->pos > 0 && edit->main->len > 0) {
+ wmemmove(edit->main->buf + edit->main->pos - 1,
+ edit->main->buf + edit->main->pos,
+ edit->main->len - edit->main->pos);
+ edit->main->pos--;
+ edit->main->len--;
+ edit->main->buf[edit->main->len] = L'\0';
+ update_display(edit);
+ }
+
+ return true;
+}
+
+LIB_EXPORT bool l_edit_move_left(struct l_edit *edit)
+{
+ if (!edit)
+ return false;
+
+ /* If the cursor is not at the beginning, then move it one back */
+ if (edit->main->pos > 0) {
+ edit->main->pos--;
+ update_display(edit);
+ }
+
+ return true;
+}
+
+LIB_EXPORT bool l_edit_move_right(struct l_edit *edit)
+{
+ if (!edit)
+ return false;
+
+ /* If the cursor is not at the end, then move it one forward */
+ if (edit->main->pos != edit->main->len) {
+ edit->main->pos++;
+ update_display(edit);
+ }
+
+ return true;
+}
+
+LIB_EXPORT bool l_edit_move_home(struct l_edit *edit)
+{
+ if (!edit)
+ return false;
+
+ /* If the cursor is not at the beginning, move it there */
+ if (edit->main->pos != 0) {
+ edit->main->pos = 0;
+ update_display(edit);
+ }
+
+ return true;
+}
+
+LIB_EXPORT bool l_edit_move_end(struct l_edit *edit)
+{
+ if (!edit)
+ return false;
+
+ /* If the cursor is not at the end, move it there */
+ if (edit->main->pos != edit->main->len) {
+ edit->main->pos = edit->main->len;
+ update_display(edit);
+ }
+
+ return true;
+}
+
+LIB_EXPORT bool l_edit_history_backward(struct l_edit *edit)
+{
+ if (!edit)
+ return false;
+
+ /* If there is another item in the history list, move the main
+ * item to that and enforce the max input length on the new item.
+ */
+ if (edit->main->next) {
+ edit->main = edit->main->next;
+ enforce_max_input_len(edit->main, edit->max_input_len);
+ update_display(edit);
+ }
+
+ return true;
+}
+
+LIB_EXPORT bool l_edit_history_forward(struct l_edit *edit)
+{
+ struct input_buf *buf;
+
+ if (!edit)
+ return false;
+
+ /* Walk the list of history items until the current main item
+ * matches the next item, then move the main item to current
+ * item and ensure that the max input length requirement is met.
+ */
+ for (buf = edit->head; buf; buf = buf->next) {
+ if (buf->next == edit->main) {
+ edit->main = buf;
+ enforce_max_input_len(edit->main, edit->max_input_len);
+ update_display(edit);
+ break;
+ }
+ }
+
+ return true;
+}
+
+LIB_EXPORT bool l_edit_history_load(struct l_edit *edit, const char *pathname)
+{
+ static size_t initial_line_size = 16;
+ struct input_buf *buf;
+ struct l_string *str;
+ size_t count;
+ int fd;
+
+ if (!edit)
+ return false;
+
+ if (!pathname)
+ return false;
+
+ if (!edit->max_list_size)
+ return true;
+
+ fd = open(pathname, O_RDONLY);
+ if (fd < 0)
+ return false;
+
+ str = l_string_new(initial_line_size);
+
+ buf = edit->head;
+ count = 0;
+
+ while (count < edit->max_list_size) {
+ char *tmp;
+ char ch;
+ int res;
+
+ res = read(fd, &ch, 1);
+ if (res != 1)
+ break;
+
+ if (ch != '\n') {
+ l_string_append_c(str, ch);
+ continue;
+ }
+
+ tmp = l_string_unwrap(str);
+
+ /* If there is not next item, but max count has not yet
+ * reached a new items is created. Otherwise the existing
+ * item is overwritten.
+ */
+ if (!buf->next)
+ buf->next = alloc_sized_input_buf(0);
+
+ /* Fill the item with input from the history file */
+ reset_input_buf(buf->next, tmp);
+ buf = buf->next;
+ count++;
+
+ l_free(tmp);
+
+ str = l_string_new(initial_line_size);
+ }
+
+ l_string_free(str);
+
+ close(fd);
+
+ edit->list_count = count;
+ update_display(edit);
+
+ return true;
+}
+
+LIB_EXPORT bool l_edit_history_save(struct l_edit *edit, const char *pathname)
+{
+ struct input_buf *buf;
+ int fd;
+
+ if (!edit)
+ return false;
+
+ if (!pathname)
+ return false;
+
+ fd = open(pathname, O_CREAT|O_WRONLY|O_TRUNC, S_IRUSR|S_IWUSR);
+ if (fd < 0)
+ return false;
+
+ buf = edit->head->next;
+
+ while (buf) {
+ char *tmp;
+ size_t len;
+
+ len = wcstombs(NULL, buf->buf, 0) + 1;
+ tmp = l_malloc(len);
+ wcstombs(tmp, buf->buf, len);
+ dprintf(fd, "%s\n", tmp);
+ l_free(tmp);
+
+ buf = buf->next;
+ }
+
+ close(fd);
+
+ return true;
+}
diff --git a/ell/edit.h b/ell/edit.h
new file mode 100644
index 000000000000..45ad2e657156
--- /dev/null
+++ b/ell/edit.h
@@ -0,0 +1,59 @@
+/*
+ * Embedded Linux library
+ * Copyright (C) 2023 Intel Corporation
+ *
+ * SPDX-License-Identifier: LGPL-2.1-or-later
+ */
+
+#ifndef __ELL_EDIT_H
+#define __ELL_EDIT_H
+
+#include <stdbool.h>
+#include <wchar.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+struct l_edit;
+
+struct l_edit *l_edit_new(void);
+void l_edit_free(struct l_edit *edit);
+
+typedef void (*l_edit_debug_func_t) (const char *str, void *user_data);
+
+bool l_edit_set_debug_handler(struct l_edit *edit,
+ l_edit_debug_func_t handler, void *user_data);
+
+typedef void (*l_edit_display_func_t) (const wchar_t *wstr, size_t wlen,
+ size_t pos, void *user_data);
+
+bool l_edit_set_display_handler(struct l_edit *edit,
+ l_edit_display_func_t handler, void *user_data);
+
+bool l_edit_set_max_display_length(struct l_edit *edit, size_t len);
+bool l_edit_set_max_input_length(struct l_edit *edit, size_t len);
+bool l_edit_set_history_size(struct l_edit *edit, unsigned int size);
+bool l_edit_refresh(struct l_edit *edit);
+bool l_edit_is_empty(struct l_edit *edit);
+char *l_edit_enter(struct l_edit *edit);
+bool l_edit_reset(struct l_edit *edit, const char *input);
+bool l_edit_insert(struct l_edit *edit, wint_t ch);
+bool l_edit_delete(struct l_edit *edit);
+bool l_edit_delete_all(struct l_edit *edit);
+bool l_edit_truncate(struct l_edit *edit);
+bool l_edit_backspace(struct l_edit *edit);
+bool l_edit_move_left(struct l_edit *edit);
+bool l_edit_move_right(struct l_edit *edit);
+bool l_edit_move_home(struct l_edit *edit);
+bool l_edit_move_end(struct l_edit *edit);
+bool l_edit_history_backward(struct l_edit *edit);
+bool l_edit_history_forward(struct l_edit *edit);
+bool l_edit_history_load(struct l_edit *edit, const char *pathname);
+bool l_edit_history_save(struct l_edit *edit, const char *pathname);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* __ELL_EDIT_H */
--
2.45.0
^ permalink raw reply related [flat|nested] 9+ messages in thread* [PATCH v6 2/8] ell: Add include directive for 'ell/edit.h'.
2025-04-06 22:12 [PATCH v6 0/8] Line Editor Grant Erickson
2025-04-06 22:12 ` [PATCH v6 1/8] edit: Initial revision Grant Erickson
@ 2025-04-06 22:12 ` Grant Erickson
2025-04-06 22:12 ` [PATCH v6 3/8] ell/Makefile: Added 'edit.[ch]' to HEADERS and SOURCES Grant Erickson
` (5 subsequent siblings)
7 siblings, 0 replies; 9+ messages in thread
From: Grant Erickson @ 2025-04-06 22:12 UTC (permalink / raw)
To: ell
---
ell/ell.h | 1 +
1 file changed, 1 insertion(+)
diff --git a/ell/ell.h b/ell/ell.h
index 7a263e9376de..6db35b9cfb6b 100644
--- a/ell/ell.h
+++ b/ell/ell.h
@@ -46,6 +46,7 @@
#include <ell/ecc.h>
#include <ell/ecdh.h>
#include <ell/time.h>
+#include <ell/edit.h>
#include <ell/gpio.h>
#include <ell/path.h>
#include <ell/acd.h>
--
2.45.0
^ permalink raw reply related [flat|nested] 9+ messages in thread* [PATCH v6 3/8] ell/Makefile: Added 'edit.[ch]' to HEADERS and SOURCES.
2025-04-06 22:12 [PATCH v6 0/8] Line Editor Grant Erickson
2025-04-06 22:12 ` [PATCH v6 1/8] edit: Initial revision Grant Erickson
2025-04-06 22:12 ` [PATCH v6 2/8] ell: Add include directive for 'ell/edit.h' Grant Erickson
@ 2025-04-06 22:12 ` Grant Erickson
2025-04-06 22:12 ` [PATCH v6 4/8] edit: Added 'l_edit_*' symbols Grant Erickson
` (4 subsequent siblings)
7 siblings, 0 replies; 9+ messages in thread
From: Grant Erickson @ 2025-04-06 22:12 UTC (permalink / raw)
To: ell
---
Makefile.am | 2 ++
1 file changed, 2 insertions(+)
diff --git a/Makefile.am b/Makefile.am
index 84d008febe0c..ae2612f4b770 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -55,6 +55,7 @@ pkginclude_HEADERS = ell/ell.h \
ell/ecc.h \
ell/ecdh.h \
ell/time.h \
+ ell/edit.h \
ell/gpio.h \
ell/path.h \
ell/icmp6.h \
@@ -148,6 +149,7 @@ ell_libell_la_SOURCES = $(linux_headers) \
ell/ecdh.c \
ell/time.c \
ell/time-private.h \
+ ell/edit.c \
ell/gpio.c \
ell/path.c \
ell/icmp6.c \
--
2.45.0
^ permalink raw reply related [flat|nested] 9+ messages in thread* [PATCH v6 4/8] edit: Added 'l_edit_*' symbols.
2025-04-06 22:12 [PATCH v6 0/8] Line Editor Grant Erickson
` (2 preceding siblings ...)
2025-04-06 22:12 ` [PATCH v6 3/8] ell/Makefile: Added 'edit.[ch]' to HEADERS and SOURCES Grant Erickson
@ 2025-04-06 22:12 ` Grant Erickson
2025-04-06 22:12 ` [PATCH v6 5/8] edit: pass the l_edit instance to the display and debug handlers Grant Erickson
` (3 subsequent siblings)
7 siblings, 0 replies; 9+ messages in thread
From: Grant Erickson @ 2025-04-06 22:12 UTC (permalink / raw)
To: ell
---
ell/ell.sym | 25 +++++++++++++++++++++++++
1 file changed, 25 insertions(+)
diff --git a/ell/ell.sym b/ell/ell.sym
index f192c471a40c..3c31fd608e3a 100644
--- a/ell/ell.sym
+++ b/ell/ell.sym
@@ -643,6 +643,31 @@ global:
l_ecdh_generate_shared_secret;
/* time */
l_time_now;
+ /* edit */
+ l_edit_new;
+ l_edit_free;
+ l_edit_set_debug_handler;
+ l_edit_set_display_handler;
+ l_edit_set_max_display_length;
+ l_edit_set_max_input_length;
+ l_edit_set_history_size;
+ l_edit_refresh;
+ l_edit_is_empty;
+ l_edit_enter;
+ l_edit_reset;
+ l_edit_insert;
+ l_edit_delete;
+ l_edit_delete_all;
+ l_edit_truncate;
+ l_edit_backspace;
+ l_edit_move_left;
+ l_edit_move_right;
+ l_edit_move_home;
+ l_edit_move_end;
+ l_edit_history_backward;
+ l_edit_history_forward;
+ l_edit_history_load;
+ l_edit_history_save;
/* gpio */
l_gpio_chips_with_line_label;
l_gpio_chip_new;
--
2.45.0
^ permalink raw reply related [flat|nested] 9+ messages in thread* [PATCH v6 5/8] edit: pass the l_edit instance to the display and debug handlers.
2025-04-06 22:12 [PATCH v6 0/8] Line Editor Grant Erickson
` (3 preceding siblings ...)
2025-04-06 22:12 ` [PATCH v6 4/8] edit: Added 'l_edit_*' symbols Grant Erickson
@ 2025-04-06 22:12 ` Grant Erickson
2025-04-06 22:12 ` [PATCH v6 6/8] edit: change return signatures from 'bool' to 'int' Grant Erickson
` (2 subsequent siblings)
7 siblings, 0 replies; 9+ messages in thread
From: Grant Erickson @ 2025-04-06 22:12 UTC (permalink / raw)
To: ell
l_edit integrations are made easier when they have access to the
instance pointer in their callbacks.
---
ell/edit.c | 4 ++--
ell/edit.h | 4 ++--
2 files changed, 4 insertions(+), 4 deletions(-)
diff --git a/ell/edit.c b/ell/edit.c
index 899fea4da830..54cfc566c4ad 100644
--- a/ell/edit.c
+++ b/ell/edit.c
@@ -229,7 +229,7 @@ static void update_debug(struct l_edit *edit)
tmp = l_string_unwrap(str);
- edit->debug_handler(tmp, edit->debug_data);
+ edit->debug_handler(edit, tmp, edit->debug_data);
l_free(tmp);
}
@@ -270,7 +270,7 @@ static void update_display(struct l_edit *edit)
len--;
}
- edit->display_handler(buf, len, pos, edit->display_data);
+ edit->display_handler(edit, buf, len, pos, edit->display_data);
update_debug(edit);
}
diff --git a/ell/edit.h b/ell/edit.h
index 45ad2e657156..decf261c7b9e 100644
--- a/ell/edit.h
+++ b/ell/edit.h
@@ -20,12 +20,12 @@ struct l_edit;
struct l_edit *l_edit_new(void);
void l_edit_free(struct l_edit *edit);
-typedef void (*l_edit_debug_func_t) (const char *str, void *user_data);
+typedef void (*l_edit_debug_func_t) (struct l_edit *edit, const char *str, void *user_data);
bool l_edit_set_debug_handler(struct l_edit *edit,
l_edit_debug_func_t handler, void *user_data);
-typedef void (*l_edit_display_func_t) (const wchar_t *wstr, size_t wlen,
+typedef void (*l_edit_display_func_t) (struct l_edit *edit, const wchar_t *wstr, size_t wlen,
size_t pos, void *user_data);
bool l_edit_set_display_handler(struct l_edit *edit,
--
2.45.0
^ permalink raw reply related [flat|nested] 9+ messages in thread* [PATCH v6 6/8] edit: change return signatures from 'bool' to 'int'
2025-04-06 22:12 [PATCH v6 0/8] Line Editor Grant Erickson
` (4 preceding siblings ...)
2025-04-06 22:12 ` [PATCH v6 5/8] edit: pass the l_edit instance to the display and debug handlers Grant Erickson
@ 2025-04-06 22:12 ` Grant Erickson
2025-04-06 22:12 ` [PATCH v6 7/8] edit: change the 'l_edit_enter' return signature from 'char *' " Grant Erickson
2025-04-06 22:12 ` [PATCH v6 8/8] edit: improve error handling of 'mbstowcs' and 'wcstombs' functions Grant Erickson
7 siblings, 0 replies; 9+ messages in thread
From: Grant Erickson @ 2025-04-06 22:12 UTC (permalink / raw)
To: ell
Using an 'int' signature with 0 for success and < 0 for failure with
failure enumerations sources from the negated POSIX errors from errno.h
eases system integration by precluding system integrators from having
to synthesize their own errors on the prior 'false' returns.
---
ell/edit.c | 136 ++++++++++++++++++++++++++---------------------------
ell/edit.h | 40 ++++++++--------
2 files changed, 88 insertions(+), 88 deletions(-)
diff --git a/ell/edit.c b/ell/edit.c
index 54cfc566c4ad..d6329d063c78 100644
--- a/ell/edit.c
+++ b/ell/edit.c
@@ -234,18 +234,18 @@ static void update_debug(struct l_edit *edit)
l_free(tmp);
}
-LIB_EXPORT bool l_edit_set_debug_handler(struct l_edit *edit,
+LIB_EXPORT int l_edit_set_debug_handler(struct l_edit *edit,
l_edit_debug_func_t handler, void *user_data)
{
if (!edit)
- return false;
+ return -EINVAL;
edit->debug_handler = handler;
edit->debug_data = user_data;
update_debug(edit);
- return true;
+ return 0;
}
static void update_display(struct l_edit *edit)
@@ -275,36 +275,36 @@ static void update_display(struct l_edit *edit)
update_debug(edit);
}
-LIB_EXPORT bool l_edit_set_display_handler(struct l_edit *edit,
+LIB_EXPORT int l_edit_set_display_handler(struct l_edit *edit,
l_edit_display_func_t handler, void *user_data)
{
if (!edit)
- return false;
+ return -EINVAL;
edit->display_handler = handler;
edit->display_data = user_data;
update_display(edit);
- return true;
+ return 0;
}
-LIB_EXPORT bool l_edit_set_max_display_length(struct l_edit *edit, size_t len)
+LIB_EXPORT int l_edit_set_max_display_length(struct l_edit *edit, size_t len)
{
if (!edit)
- return false;
+ return -EINVAL;
edit->max_display_len= len;
update_display(edit);
- return true;
+ return 0;
}
-LIB_EXPORT bool l_edit_set_max_input_length(struct l_edit *edit, size_t len)
+LIB_EXPORT int l_edit_set_max_input_length(struct l_edit *edit, size_t len)
{
if (!edit)
- return false;
+ return -EINVAL;
/* When switching to unlimited input length, then nothing is there
* do to, except storing the value. Refreshing the display is not
@@ -313,7 +313,7 @@ LIB_EXPORT bool l_edit_set_max_input_length(struct l_edit *edit, size_t len)
if (len == 0) {
edit->max_input_len = 0;
update_debug(edit);
- return true;
+ return 0;
}
edit->max_input_len = len;
@@ -334,13 +334,13 @@ LIB_EXPORT bool l_edit_set_max_input_length(struct l_edit *edit, size_t len)
update_debug(edit);
}
- return true;
+ return 0;
}
-LIB_EXPORT bool l_edit_set_history_size(struct l_edit *edit, unsigned int size)
+LIB_EXPORT int l_edit_set_history_size(struct l_edit *edit, unsigned int size)
{
if (!edit)
- return false;
+ return -EINVAL;
edit->max_list_size = size;
@@ -382,17 +382,17 @@ LIB_EXPORT bool l_edit_set_history_size(struct l_edit *edit, unsigned int size)
update_display(edit);
- return true;
+ return 0;
}
-LIB_EXPORT bool l_edit_refresh(struct l_edit *edit)
+LIB_EXPORT int l_edit_refresh(struct l_edit *edit)
{
if (!edit)
- return false;
+ return -EINVAL;
update_display(edit);
- return true;
+ return 0;
}
LIB_EXPORT bool l_edit_is_empty(struct l_edit *edit)
@@ -463,10 +463,10 @@ LIB_EXPORT char *l_edit_enter(struct l_edit *edit)
return str;
}
-LIB_EXPORT bool l_edit_reset(struct l_edit *edit, const char *input)
+LIB_EXPORT int l_edit_reset(struct l_edit *edit, const char *input)
{
if (!edit)
- return false;
+ return -EINVAL;
/* Reset the main item back to the head of the history before
* resetting it or overwriting it with the provided input.
@@ -476,17 +476,17 @@ LIB_EXPORT bool l_edit_reset(struct l_edit *edit, const char *input)
reset_input_buf(edit->main, input);
update_display(edit);
- return true;
+ return 0;
}
-LIB_EXPORT bool l_edit_insert(struct l_edit *edit, wint_t ch)
+LIB_EXPORT int l_edit_insert(struct l_edit *edit, wint_t ch)
{
if (!edit)
- return false;
+ return -EINVAL;
/* Check if the max input length has already been reached */
if (edit->max_input_len && edit->main->len >= edit->max_input_len)
- return false;
+ return -EALREADY;
/* This will magically grow the buffer to make room for at least
* one wide character.
@@ -497,7 +497,7 @@ LIB_EXPORT bool l_edit_insert(struct l_edit *edit, wint_t ch)
* string, there is nothing more to add.
*/
if (edit->main->len == SIZE_MAX)
- return false;
+ return -ENOBUFS;
/* If the cursor is not at the end, the new character has to be
* inserted and for thus the tail portion needs to move one
@@ -513,13 +513,13 @@ LIB_EXPORT bool l_edit_insert(struct l_edit *edit, wint_t ch)
edit->main->buf[edit->main->len] = L'\0';
update_display(edit);
- return true;
+ return 0;
}
-LIB_EXPORT bool l_edit_delete(struct l_edit *edit)
+LIB_EXPORT int l_edit_delete(struct l_edit *edit)
{
if (!edit)
- return false;
+ return -EINVAL;
/* If the cursor is not at the end, deletion of a character means
* that the tail moves one character forward.
@@ -533,13 +533,13 @@ LIB_EXPORT bool l_edit_delete(struct l_edit *edit)
update_display(edit);
}
- return true;
+ return 0;
}
-LIB_EXPORT bool l_edit_delete_all(struct l_edit *edit)
+LIB_EXPORT int l_edit_delete_all(struct l_edit *edit)
{
if (!edit)
- return false;
+ return -EINVAL;
/* Keep the buffer allocated, but reset it to an empty string */
edit->main->buf[0] = L'\0';
@@ -547,26 +547,26 @@ LIB_EXPORT bool l_edit_delete_all(struct l_edit *edit)
edit->main->len = 0;
update_display(edit);
- return true;
+ return 0;
}
-LIB_EXPORT bool l_edit_truncate(struct l_edit *edit)
+LIB_EXPORT int l_edit_truncate(struct l_edit *edit)
{
if (!edit)
- return false;
+ return -EINVAL;
/* Keep the buffer allocated, but truncate after the cursor */
edit->main->buf[edit->main->pos] = L'\0';
edit->main->len = edit->main->pos;
update_display(edit);
- return true;
+ return 0;
}
-LIB_EXPORT bool l_edit_backspace(struct l_edit *edit)
+LIB_EXPORT int l_edit_backspace(struct l_edit *edit)
{
if (!edit)
- return false;
+ return -EINVAL;
/* If the cursor is not at the beginning, the backspace operation
* means that tail has to move one character forward.
@@ -581,13 +581,13 @@ LIB_EXPORT bool l_edit_backspace(struct l_edit *edit)
update_display(edit);
}
- return true;
+ return 0;
}
-LIB_EXPORT bool l_edit_move_left(struct l_edit *edit)
+LIB_EXPORT int l_edit_move_left(struct l_edit *edit)
{
if (!edit)
- return false;
+ return -EINVAL;
/* If the cursor is not at the beginning, then move it one back */
if (edit->main->pos > 0) {
@@ -595,13 +595,13 @@ LIB_EXPORT bool l_edit_move_left(struct l_edit *edit)
update_display(edit);
}
- return true;
+ return 0;
}
-LIB_EXPORT bool l_edit_move_right(struct l_edit *edit)
+LIB_EXPORT int l_edit_move_right(struct l_edit *edit)
{
if (!edit)
- return false;
+ return -EINVAL;
/* If the cursor is not at the end, then move it one forward */
if (edit->main->pos != edit->main->len) {
@@ -609,13 +609,13 @@ LIB_EXPORT bool l_edit_move_right(struct l_edit *edit)
update_display(edit);
}
- return true;
+ return 0;
}
-LIB_EXPORT bool l_edit_move_home(struct l_edit *edit)
+LIB_EXPORT int l_edit_move_home(struct l_edit *edit)
{
if (!edit)
- return false;
+ return -EINVAL;
/* If the cursor is not at the beginning, move it there */
if (edit->main->pos != 0) {
@@ -623,13 +623,13 @@ LIB_EXPORT bool l_edit_move_home(struct l_edit *edit)
update_display(edit);
}
- return true;
+ return 0;
}
-LIB_EXPORT bool l_edit_move_end(struct l_edit *edit)
+LIB_EXPORT int l_edit_move_end(struct l_edit *edit)
{
if (!edit)
- return false;
+ return -EINVAL;
/* If the cursor is not at the end, move it there */
if (edit->main->pos != edit->main->len) {
@@ -637,13 +637,13 @@ LIB_EXPORT bool l_edit_move_end(struct l_edit *edit)
update_display(edit);
}
- return true;
+ return 0;
}
-LIB_EXPORT bool l_edit_history_backward(struct l_edit *edit)
+LIB_EXPORT int l_edit_history_backward(struct l_edit *edit)
{
if (!edit)
- return false;
+ return -EINVAL;
/* If there is another item in the history list, move the main
* item to that and enforce the max input length on the new item.
@@ -654,15 +654,15 @@ LIB_EXPORT bool l_edit_history_backward(struct l_edit *edit)
update_display(edit);
}
- return true;
+ return 0;
}
-LIB_EXPORT bool l_edit_history_forward(struct l_edit *edit)
+LIB_EXPORT int l_edit_history_forward(struct l_edit *edit)
{
struct input_buf *buf;
if (!edit)
- return false;
+ return -EINVAL;
/* Walk the list of history items until the current main item
* matches the next item, then move the main item to current
@@ -677,10 +677,10 @@ LIB_EXPORT bool l_edit_history_forward(struct l_edit *edit)
}
}
- return true;
+ return 0;
}
-LIB_EXPORT bool l_edit_history_load(struct l_edit *edit, const char *pathname)
+LIB_EXPORT int l_edit_history_load(struct l_edit *edit, const char *pathname)
{
static size_t initial_line_size = 16;
struct input_buf *buf;
@@ -689,17 +689,17 @@ LIB_EXPORT bool l_edit_history_load(struct l_edit *edit, const char *pathname)
int fd;
if (!edit)
- return false;
+ return -EINVAL;
if (!pathname)
- return false;
+ return -EINVAL;
if (!edit->max_list_size)
- return true;
+ return 0;
fd = open(pathname, O_RDONLY);
if (fd < 0)
- return false;
+ return -errno;
str = l_string_new(initial_line_size);
@@ -746,23 +746,23 @@ LIB_EXPORT bool l_edit_history_load(struct l_edit *edit, const char *pathname)
edit->list_count = count;
update_display(edit);
- return true;
+ return 0;
}
-LIB_EXPORT bool l_edit_history_save(struct l_edit *edit, const char *pathname)
+LIB_EXPORT int l_edit_history_save(struct l_edit *edit, const char *pathname)
{
struct input_buf *buf;
int fd;
if (!edit)
- return false;
+ return -EINVAL;
if (!pathname)
- return false;
+ return -EINVAL;
fd = open(pathname, O_CREAT|O_WRONLY|O_TRUNC, S_IRUSR|S_IWUSR);
if (fd < 0)
- return false;
+ return -errno;
buf = edit->head->next;
@@ -781,5 +781,5 @@ LIB_EXPORT bool l_edit_history_save(struct l_edit *edit, const char *pathname)
close(fd);
- return true;
+ return 0;
}
diff --git a/ell/edit.h b/ell/edit.h
index decf261c7b9e..811246578894 100644
--- a/ell/edit.h
+++ b/ell/edit.h
@@ -22,35 +22,35 @@ void l_edit_free(struct l_edit *edit);
typedef void (*l_edit_debug_func_t) (struct l_edit *edit, const char *str, void *user_data);
-bool l_edit_set_debug_handler(struct l_edit *edit,
+int l_edit_set_debug_handler(struct l_edit *edit,
l_edit_debug_func_t handler, void *user_data);
typedef void (*l_edit_display_func_t) (struct l_edit *edit, const wchar_t *wstr, size_t wlen,
size_t pos, void *user_data);
-bool l_edit_set_display_handler(struct l_edit *edit,
+int l_edit_set_display_handler(struct l_edit *edit,
l_edit_display_func_t handler, void *user_data);
-bool l_edit_set_max_display_length(struct l_edit *edit, size_t len);
-bool l_edit_set_max_input_length(struct l_edit *edit, size_t len);
-bool l_edit_set_history_size(struct l_edit *edit, unsigned int size);
-bool l_edit_refresh(struct l_edit *edit);
+int l_edit_set_max_display_length(struct l_edit *edit, size_t len);
+int l_edit_set_max_input_length(struct l_edit *edit, size_t len);
+int l_edit_set_history_size(struct l_edit *edit, unsigned int size);
+int l_edit_refresh(struct l_edit *edit);
bool l_edit_is_empty(struct l_edit *edit);
char *l_edit_enter(struct l_edit *edit);
-bool l_edit_reset(struct l_edit *edit, const char *input);
-bool l_edit_insert(struct l_edit *edit, wint_t ch);
-bool l_edit_delete(struct l_edit *edit);
-bool l_edit_delete_all(struct l_edit *edit);
-bool l_edit_truncate(struct l_edit *edit);
-bool l_edit_backspace(struct l_edit *edit);
-bool l_edit_move_left(struct l_edit *edit);
-bool l_edit_move_right(struct l_edit *edit);
-bool l_edit_move_home(struct l_edit *edit);
-bool l_edit_move_end(struct l_edit *edit);
-bool l_edit_history_backward(struct l_edit *edit);
-bool l_edit_history_forward(struct l_edit *edit);
-bool l_edit_history_load(struct l_edit *edit, const char *pathname);
-bool l_edit_history_save(struct l_edit *edit, const char *pathname);
+int l_edit_reset(struct l_edit *edit, const char *input);
+int l_edit_insert(struct l_edit *edit, wint_t ch);
+int l_edit_delete(struct l_edit *edit);
+int l_edit_delete_all(struct l_edit *edit);
+int l_edit_truncate(struct l_edit *edit);
+int l_edit_backspace(struct l_edit *edit);
+int l_edit_move_left(struct l_edit *edit);
+int l_edit_move_right(struct l_edit *edit);
+int l_edit_move_home(struct l_edit *edit);
+int l_edit_move_end(struct l_edit *edit);
+int l_edit_history_backward(struct l_edit *edit);
+int l_edit_history_forward(struct l_edit *edit);
+int l_edit_history_load(struct l_edit *edit, const char *pathname);
+int l_edit_history_save(struct l_edit *edit, const char *pathname);
#ifdef __cplusplus
}
--
2.45.0
^ permalink raw reply related [flat|nested] 9+ messages in thread* [PATCH v6 7/8] edit: change the 'l_edit_enter' return signature from 'char *' to 'int'
2025-04-06 22:12 [PATCH v6 0/8] Line Editor Grant Erickson
` (5 preceding siblings ...)
2025-04-06 22:12 ` [PATCH v6 6/8] edit: change return signatures from 'bool' to 'int' Grant Erickson
@ 2025-04-06 22:12 ` Grant Erickson
2025-04-06 22:12 ` [PATCH v6 8/8] edit: improve error handling of 'mbstowcs' and 'wcstombs' functions Grant Erickson
7 siblings, 0 replies; 9+ messages in thread
From: Grant Erickson @ 2025-04-06 22:12 UTC (permalink / raw)
To: ell
Using an 'int' signature with 0 for success and < 0 for failure with
failure enumerations sources from the negated POSIX errors from errno.h
eases system integration by precluding system integrators from having
to synthesize their own errors on the prior 'false' returns.
In addition, this sets the stage for better error handling of the
'wcstombs' and 'mbstowcs' functions.
The entered line is now returned via a return parameter.
---
ell/edit.c | 12 +++++++++---
ell/edit.h | 2 +-
2 files changed, 10 insertions(+), 4 deletions(-)
diff --git a/ell/edit.c b/ell/edit.c
index d6329d063c78..6747f92e289e 100644
--- a/ell/edit.c
+++ b/ell/edit.c
@@ -403,14 +403,14 @@ LIB_EXPORT bool l_edit_is_empty(struct l_edit *edit)
return (edit->main->len == 0);
}
-LIB_EXPORT char *l_edit_enter(struct l_edit *edit)
+LIB_EXPORT int l_edit_enter(struct l_edit *edit, char **line)
{
struct input_buf *buf;
char *str;
size_t len;
if (!edit)
- return NULL;
+ return -EINVAL;
/* Convert the wide character string into the multibyte string
* representation like UTF-8 for example.
@@ -458,9 +458,15 @@ LIB_EXPORT char *l_edit_enter(struct l_edit *edit)
}
edit->main = edit->head;
+
update_display(edit);
- return str;
+ if (line)
+ *line = str;
+ else
+ l_free(str);
+
+ return 0;
}
LIB_EXPORT int l_edit_reset(struct l_edit *edit, const char *input)
diff --git a/ell/edit.h b/ell/edit.h
index 811246578894..425039733ad0 100644
--- a/ell/edit.h
+++ b/ell/edit.h
@@ -36,7 +36,7 @@ int l_edit_set_max_input_length(struct l_edit *edit, size_t len);
int l_edit_set_history_size(struct l_edit *edit, unsigned int size);
int l_edit_refresh(struct l_edit *edit);
bool l_edit_is_empty(struct l_edit *edit);
-char *l_edit_enter(struct l_edit *edit);
+int l_edit_enter(struct l_edit *edit, char **line);
int l_edit_reset(struct l_edit *edit, const char *input);
int l_edit_insert(struct l_edit *edit, wint_t ch);
int l_edit_delete(struct l_edit *edit);
--
2.45.0
^ permalink raw reply related [flat|nested] 9+ messages in thread* [PATCH v6 8/8] edit: improve error handling of 'mbstowcs' and 'wcstombs' functions.
2025-04-06 22:12 [PATCH v6 0/8] Line Editor Grant Erickson
` (6 preceding siblings ...)
2025-04-06 22:12 ` [PATCH v6 7/8] edit: change the 'l_edit_enter' return signature from 'char *' " Grant Erickson
@ 2025-04-06 22:12 ` Grant Erickson
7 siblings, 0 replies; 9+ messages in thread
From: Grant Erickson @ 2025-04-06 22:12 UTC (permalink / raw)
To: ell
On error, the 'mbstowcs' and 'wcstombs' functions could return
'SIZE_MAX' when uncountering unconvertable character sequences.
Ensure that such errors are not obscured and are passed along to the
caller.
---
ell/edit.c | 53 ++++++++++++++++++++++++++++++++++++++++++++---------
1 file changed, 44 insertions(+), 9 deletions(-)
diff --git a/ell/edit.c b/ell/edit.c
index 6747f92e289e..5551ae52bfdb 100644
--- a/ell/edit.c
+++ b/ell/edit.c
@@ -104,10 +104,16 @@ static void reset_input_buf(struct input_buf *buf, const char *input)
if (input) {
size_t len;
- /* Calculate the required size of the wide character string
- * including its terminating null character.
+ /* Calculate the required size of the wide character string.
*/
- len = mbstowcs(NULL, input, 0) + 1;
+ len = mbstowcs(NULL, input, 0);
+ if (len == SIZE_MAX)
+ return;
+
+ /* Increase the size of the wide character string by one to
+ * cover its terminating null character.
+ */
+ len += 1;
/* If the current buffer is to small, then allocate a new
* one and free the previous one. Since in most cases the
@@ -125,6 +131,9 @@ static void reset_input_buf(struct input_buf *buf, const char *input)
* and then move the cursor to the end.
*/
buf->len = mbstowcs(buf->buf, input, buf->size);
+ if (buf->len == SIZE_MAX)
+ return;
+
buf->pos = buf->len;
} else {
/* Reset the main item to an empty string */
@@ -197,6 +206,7 @@ static void update_debug(struct l_edit *edit)
struct l_string *str;
char *tmp;
size_t len;
+ size_t status;
unsigned int pos = 0;
if (!edit->debug_handler)
@@ -218,9 +228,14 @@ static void update_debug(struct l_edit *edit)
buf = edit->head;
while (buf) {
- len = wcstombs(NULL, buf->buf, 0) + 1;
+ len = wcstombs(NULL, buf->buf, 0);
+ if (len == SIZE_MAX)
+ return;
+ len += 1;
tmp = l_malloc(len);
- wcstombs(tmp, buf->buf, len);
+ status = wcstombs(tmp, buf->buf, len);
+ if (status == SIZE_MAX)
+ return;
l_string_append_printf(str, "%3u %s\n", pos, tmp);
l_free(tmp);
pos++;
@@ -415,9 +430,18 @@ LIB_EXPORT int l_edit_enter(struct l_edit *edit, char **line)
/* Convert the wide character string into the multibyte string
* representation like UTF-8 for example.
*/
- len = wcstombs(NULL, edit->main->buf, 0) + 1;
+ len = wcstombs(NULL, edit->main->buf, 0);
+ if (len == SIZE_MAX)
+ return -EILSEQ;
+
+ len += 1;
+
str = l_malloc(len);
- wcstombs(str, edit->main->buf, len);
+ if (!str)
+ return -ENOMEM;
+
+ if (wcstombs(str, edit->main->buf, len) == SIZE_MAX)
+ return -EILSEQ;
if (edit->main->len > 0) {
/* If the current entered item is different from the first
@@ -775,10 +799,21 @@ LIB_EXPORT int l_edit_history_save(struct l_edit *edit, const char *pathname)
while (buf) {
char *tmp;
size_t len;
+ size_t status;
- len = wcstombs(NULL, buf->buf, 0) + 1;
+ len = wcstombs(NULL, buf->buf, 0);
+ if (len == SIZE_MAX) {
+ close(fd);
+ return -EILSEQ;
+ }
+ len += 1;
tmp = l_malloc(len);
- wcstombs(tmp, buf->buf, len);
+ status = wcstombs(tmp, buf->buf, len);
+ if (status == SIZE_MAX) {
+ l_free(tmp);
+ close(fd);
+ return -EILSEQ;
+ }
dprintf(fd, "%s\n", tmp);
l_free(tmp);
--
2.45.0
^ permalink raw reply related [flat|nested] 9+ messages in thread