summaryrefslogtreecommitdiff
path: root/lib
diff options
context:
space:
mode:
authorjacqueline <me@jacqueline.id.au>2024-06-27 16:12:18 +1000
committerjacqueline <me@jacqueline.id.au>2024-06-27 16:12:18 +1000
commit1036f1b00efe2bbd2467cbfa3a4a97ab7f56591e (patch)
treecc3aa8683daa30e36f3777699e32aaf93e211f95 /lib
parent1daa1e9b0fe737ea5dac99f42fdf3c217873443f (diff)
downloadtangara-fw-1036f1b00efe2bbd2467cbfa3a4a97ab7f56591e.tar.gz
fork esp-idf's dev console, in order to add some hooks
Diffstat (limited to 'lib')
-rw-r--r--lib/console/CMakeLists.txt31
-rw-r--r--lib/console/argtable3/LICENSE167
-rw-r--r--lib/console/argtable3/arg_cmd.c285
-rw-r--r--lib/console/argtable3/arg_date.c575
-rw-r--r--lib/console/argtable3/arg_dbl.c164
-rw-r--r--lib/console/argtable3/arg_dstr.c344
-rw-r--r--lib/console/argtable3/arg_end.c135
-rw-r--r--lib/console/argtable3/arg_file.c213
-rw-r--r--lib/console/argtable3/arg_hashtable.c428
-rw-r--r--lib/console/argtable3/arg_int.c294
-rw-r--r--lib/console/argtable3/arg_lit.c124
-rw-r--r--lib/console/argtable3/arg_rem.c64
-rw-r--r--lib/console/argtable3/arg_rex.c1014
-rw-r--r--lib/console/argtable3/arg_str.c151
-rw-r--r--lib/console/argtable3/arg_utils.c183
-rw-r--r--lib/console/argtable3/argtable3.c1111
-rw-r--r--lib/console/argtable3/argtable3.h279
-rw-r--r--lib/console/argtable3/argtable3_private.h245
-rw-r--r--lib/console/commands.c302
-rw-r--r--lib/console/esp_console.h397
-rw-r--r--lib/console/esp_console_repl.c550
-rw-r--r--lib/console/linenoise/LICENSE25
-rw-r--r--lib/console/linenoise/linenoise.c1318
-rw-r--r--lib/console/linenoise/linenoise.h82
-rw-r--r--lib/console/split_argv.c112
-rw-r--r--lib/console/test_apps/console/CMakeLists.txt12
-rw-r--r--lib/console/test_apps/console/README.md2
-rw-r--r--lib/console/test_apps/console/main/CMakeLists.txt4
-rw-r--r--lib/console/test_apps/console/main/test_app_main.c51
-rw-r--r--lib/console/test_apps/console/main/test_console.c104
-rw-r--r--lib/console/test_apps/console/pytest_console.py96
-rw-r--r--lib/console/test_apps/console/sdkconfig.defaults3
32 files changed, 8865 insertions, 0 deletions
diff --git a/lib/console/CMakeLists.txt b/lib/console/CMakeLists.txt
new file mode 100644
index 00000000..5904ac5a
--- /dev/null
+++ b/lib/console/CMakeLists.txt
@@ -0,0 +1,31 @@
+idf_build_get_property(target IDF_TARGET)
+
+if(${target} STREQUAL "linux")
+ return() # This component is currently not supported by the POSIX/Linux simulator, but we may support it in the
+ # future (TODO: IDF-8103)
+endif()
+
+set(argtable_srcs argtable3/arg_cmd.c
+ argtable3/arg_date.c
+ argtable3/arg_dbl.c
+ argtable3/arg_dstr.c
+ argtable3/arg_end.c
+ argtable3/arg_file.c
+ argtable3/arg_hashtable.c
+ argtable3/arg_int.c
+ argtable3/arg_lit.c
+ argtable3/arg_rem.c
+ argtable3/arg_rex.c
+ argtable3/arg_str.c
+ argtable3/arg_utils.c
+ argtable3/argtable3.c)
+
+
+idf_component_register(SRCS "commands.c"
+ "esp_console_repl.c"
+ "split_argv.c"
+ "linenoise/linenoise.c"
+ ${argtable_srcs}
+ INCLUDE_DIRS ${CMAKE_CURRENT_SOURCE_DIR}
+ REQUIRES vfs
+ PRIV_REQUIRES driver)
diff --git a/lib/console/argtable3/LICENSE b/lib/console/argtable3/LICENSE
new file mode 100644
index 00000000..63c7a7fb
--- /dev/null
+++ b/lib/console/argtable3/LICENSE
@@ -0,0 +1,167 @@
+Copyright (C) 1998-2001,2003-2011,2013 Stewart Heitmann
+<sheitmann@users.sourceforge.net>
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+ * Redistributions of source code must retain the above copyright
+ notice, this list of conditions and the following disclaimer.
+ * Redistributions in binary form must reproduce the above copyright
+ notice, this list of conditions and the following disclaimer in the
+ documentation and/or other materials provided with the distribution.
+ * Neither the name of STEWART HEITMANN nor the names of its contributors
+ may be used to endorse or promote products derived from this software
+ without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED. IN NO EVENT SHALL STEWART HEITMANN BE LIABLE FOR ANY DIRECT,
+INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+
+FreeBSD getopt library
+======================
+
+Copyright (c) 2000 The NetBSD Foundation, Inc.
+All rights reserved.
+
+This code is derived from software contributed to The NetBSD Foundation
+by Dieter Baron and Thomas Klausner.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+1. Redistributions of source code must retain the above copyright
+ notice, this list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright
+ notice, this list of conditions and the following disclaimer in the
+ documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
+``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
+TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
+BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.
+
+
+Tcl library
+===========
+
+This software is copyrighted by the Regents of the University of
+California, Sun Microsystems, Inc., Scriptics Corporation, ActiveState
+Corporation and other parties. The following terms apply to all files
+associated with the software unless explicitly disclaimed in
+individual files.
+
+The authors hereby grant permission to use, copy, modify, distribute,
+and license this software and its documentation for any purpose, provided
+that existing copyright notices are retained in all copies and that this
+notice is included verbatim in any distributions. No written agreement,
+license, or royalty fee is required for any of the authorized uses.
+Modifications to this software may be copyrighted by their authors
+and need not follow the licensing terms described here, provided that
+the new terms are clearly indicated on the first page of each file where
+they apply.
+
+IN NO EVENT SHALL THE AUTHORS OR DISTRIBUTORS BE LIABLE TO ANY PARTY
+FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
+ARISING OUT OF THE USE OF THIS SOFTWARE, ITS DOCUMENTATION, OR ANY
+DERIVATIVES THEREOF, EVEN IF THE AUTHORS HAVE BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.
+
+THE AUTHORS AND DISTRIBUTORS SPECIFICALLY DISCLAIM ANY WARRANTIES,
+INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE, AND NON-INFRINGEMENT. THIS SOFTWARE
+IS PROVIDED ON AN "AS IS" BASIS, AND THE AUTHORS AND DISTRIBUTORS HAVE
+NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR
+MODIFICATIONS.
+
+GOVERNMENT USE: If you are acquiring this software on behalf of the
+U.S. government, the Government shall have only "Restricted Rights"
+in the software and related documentation as defined in the Federal
+Acquisition Regulations (FARs) in Clause 52.227.19 (c) (2). If you
+are acquiring the software on behalf of the Department of Defense, the
+software shall be classified as "Commercial Computer Software" and the
+Government shall have only "Restricted Rights" as defined in Clause
+252.227-7014 (b) (3) of DFARs. Notwithstanding the foregoing, the
+authors grant the U.S. Government and others acting in its behalf
+permission to use and distribute the software in accordance with the
+terms specified in this license.
+
+
+C Hash Table library
+====================
+
+Copyright (c) 2002, Christopher Clark
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+
+* Redistributions of source code must retain the above copyright
+ notice, this list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright
+ notice, this list of conditions and the following disclaimer in the
+ documentation and/or other materials provided with the distribution.
+
+* Neither the name of the original author; nor the names of any contributors
+ may be used to endorse or promote products derived from this software
+ without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
+OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+
+The Better String library
+=========================
+
+Copyright (c) 2014, Paul Hsieh
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+ list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+ this list of conditions and the following disclaimer in the documentation
+ and/or other materials provided with the distribution.
+
+* Neither the name of bstrlib nor the names of its
+ contributors may be used to endorse or promote products derived from
+ this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
diff --git a/lib/console/argtable3/arg_cmd.c b/lib/console/argtable3/arg_cmd.c
new file mode 100644
index 00000000..55e3f7ad
--- /dev/null
+++ b/lib/console/argtable3/arg_cmd.c
@@ -0,0 +1,285 @@
+/*
+ * SPDX-FileCopyrightText: 2013-2019 Tom G. Huang
+ *
+ * SPDX-License-Identifier: BSD-3-Clause
+ */
+/*******************************************************************************
+ * arg_cmd: Provides the sub-command mechanism
+ *
+ * This file is part of the argtable3 library.
+ *
+ * Copyright (C) 2013-2019 Tom G. Huang
+ * <tomghuang@gmail.com>
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ * * Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ * * Redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in the
+ * documentation and/or other materials provided with the distribution.
+ * * Neither the name of STEWART HEITMANN nor the names of its contributors
+ * may be used to endorse or promote products derived from this software
+ * without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL STEWART HEITMANN BE LIABLE FOR ANY DIRECT,
+ * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ ******************************************************************************/
+
+#include "argtable3.h"
+
+#ifndef ARG_AMALGAMATION
+#include "argtable3_private.h"
+#endif
+
+#include <assert.h>
+#include <stdlib.h>
+#include <string.h>
+
+#define MAX_MODULE_VERSION_SIZE 128
+
+static arg_hashtable_t* s_hashtable = NULL;
+static char* s_module_name = NULL;
+static int s_mod_ver_major = 0;
+static int s_mod_ver_minor = 0;
+static int s_mod_ver_patch = 0;
+static char* s_mod_ver_tag = NULL;
+static char* s_mod_ver = NULL;
+
+void arg_set_module_name(const char* name) {
+ size_t slen;
+
+ xfree(s_module_name);
+ slen = strlen(name);
+ s_module_name = (char*)xmalloc(slen + 1);
+ memset(s_module_name, 0, slen + 1);
+
+#if (defined(__STDC_LIB_EXT1__) && defined(__STDC_WANT_LIB_EXT1__)) || (defined(__STDC_SECURE_LIB__) && defined(__STDC_WANT_SECURE_LIB__))
+ strncpy_s(s_module_name, slen + 1, name, slen);
+#else
+ memcpy(s_module_name, name, slen);
+#endif
+}
+
+void arg_set_module_version(int major, int minor, int patch, const char* tag) {
+ size_t slen_tag, slen_ds;
+ arg_dstr_t ds;
+
+ s_mod_ver_major = major;
+ s_mod_ver_minor = minor;
+ s_mod_ver_patch = patch;
+
+ xfree(s_mod_ver_tag);
+ slen_tag = strlen(tag);
+ s_mod_ver_tag = (char*)xmalloc(slen_tag + 1);
+ memset(s_mod_ver_tag, 0, slen_tag + 1);
+
+#if (defined(__STDC_LIB_EXT1__) && defined(__STDC_WANT_LIB_EXT1__)) || (defined(__STDC_SECURE_LIB__) && defined(__STDC_WANT_SECURE_LIB__))
+ strncpy_s(s_mod_ver_tag, slen_tag + 1, tag, slen_tag);
+#else
+ memcpy(s_mod_ver_tag, tag, slen_tag);
+#endif
+
+ ds = arg_dstr_create();
+ arg_dstr_catf(ds, "%d.", s_mod_ver_major);
+ arg_dstr_catf(ds, "%d.", s_mod_ver_minor);
+ arg_dstr_catf(ds, "%d.", s_mod_ver_patch);
+ arg_dstr_cat(ds, s_mod_ver_tag);
+
+ xfree(s_mod_ver);
+ slen_ds = strlen(arg_dstr_cstr(ds));
+ s_mod_ver = (char*)xmalloc(slen_ds + 1);
+ memset(s_mod_ver, 0, slen_ds + 1);
+
+#if (defined(__STDC_LIB_EXT1__) && defined(__STDC_WANT_LIB_EXT1__)) || (defined(__STDC_SECURE_LIB__) && defined(__STDC_WANT_SECURE_LIB__))
+ strncpy_s(s_mod_ver, slen_ds + 1, arg_dstr_cstr(ds), slen_ds);
+#else
+ memcpy(s_mod_ver, arg_dstr_cstr(ds), slen_ds);
+#endif
+
+ arg_dstr_destroy(ds);
+}
+
+static unsigned int hash_key(const void* key) {
+ const char* str = (const char*)key;
+ int c;
+ unsigned int hash = 5381;
+
+ while ((c = *str++) != 0)
+ hash = ((hash << 5) + hash) + (unsigned int)c; /* hash * 33 + c */
+
+ return hash;
+}
+
+static int equal_keys(const void* key1, const void* key2) {
+ char* k1 = (char*)key1;
+ char* k2 = (char*)key2;
+ return (0 == strcmp(k1, k2));
+}
+
+void arg_cmd_init(void) {
+ s_hashtable = arg_hashtable_create(32, hash_key, equal_keys);
+}
+
+void arg_cmd_uninit(void) {
+ arg_hashtable_destroy(s_hashtable, 1);
+}
+
+void arg_cmd_register(const char* name, arg_cmdfn* proc, const char* description) {
+ arg_cmd_info_t* cmd_info;
+ size_t slen_name;
+ void* k;
+
+ assert(strlen(name) < ARG_CMD_NAME_LEN);
+ assert(strlen(description) < ARG_CMD_DESCRIPTION_LEN);
+
+ /* Check if the command already exists. */
+ /* If the command exists, replace the existing command. */
+ /* If the command doesn't exist, insert the command. */
+ cmd_info = (arg_cmd_info_t*)arg_hashtable_search(s_hashtable, name);
+ if (cmd_info) {
+ arg_hashtable_remove(s_hashtable, name);
+ cmd_info = NULL;
+ }
+
+ cmd_info = (arg_cmd_info_t*)xmalloc(sizeof(arg_cmd_info_t));
+ memset(cmd_info, 0, sizeof(arg_cmd_info_t));
+
+#if (defined(__STDC_LIB_EXT1__) && defined(__STDC_WANT_LIB_EXT1__)) || (defined(__STDC_SECURE_LIB__) && defined(__STDC_WANT_SECURE_LIB__))
+ strncpy_s(cmd_info->name, ARG_CMD_NAME_LEN, name, strlen(name));
+ strncpy_s(cmd_info->description, ARG_CMD_DESCRIPTION_LEN, description, strlen(description));
+#else
+ memcpy(cmd_info->name, name, strlen(name));
+ memcpy(cmd_info->description, description, strlen(description));
+#endif
+
+ cmd_info->proc = proc;
+
+ slen_name = strlen(name);
+ k = xmalloc(slen_name + 1);
+ memset(k, 0, slen_name + 1);
+
+#if (defined(__STDC_LIB_EXT1__) && defined(__STDC_WANT_LIB_EXT1__)) || (defined(__STDC_SECURE_LIB__) && defined(__STDC_WANT_SECURE_LIB__))
+ strncpy_s((char*)k, slen_name + 1, name, slen_name);
+#else
+ memcpy((char*)k, name, slen_name);
+#endif
+
+ arg_hashtable_insert(s_hashtable, k, cmd_info);
+}
+
+void arg_cmd_unregister(const char* name) {
+ arg_hashtable_remove(s_hashtable, name);
+}
+
+int arg_cmd_dispatch(const char* name, int argc, char* argv[], arg_dstr_t res) {
+ arg_cmd_info_t* cmd_info = arg_cmd_info(name);
+
+ assert(cmd_info != NULL);
+ assert(cmd_info->proc != NULL);
+
+ return cmd_info->proc(argc, argv, res);
+}
+
+arg_cmd_info_t* arg_cmd_info(const char* name) {
+ return (arg_cmd_info_t*)arg_hashtable_search(s_hashtable, name);
+}
+
+unsigned int arg_cmd_count(void) {
+ return arg_hashtable_count(s_hashtable);
+}
+
+arg_cmd_itr_t arg_cmd_itr_create(void) {
+ return (arg_cmd_itr_t)arg_hashtable_itr_create(s_hashtable);
+}
+
+int arg_cmd_itr_advance(arg_cmd_itr_t itr) {
+ return arg_hashtable_itr_advance((arg_hashtable_itr_t*)itr);
+}
+
+char* arg_cmd_itr_key(arg_cmd_itr_t itr) {
+ return (char*)arg_hashtable_itr_key((arg_hashtable_itr_t*)itr);
+}
+
+arg_cmd_info_t* arg_cmd_itr_value(arg_cmd_itr_t itr) {
+ return (arg_cmd_info_t*)arg_hashtable_itr_value((arg_hashtable_itr_t*)itr);
+}
+
+void arg_cmd_itr_destroy(arg_cmd_itr_t itr) {
+ arg_hashtable_itr_destroy((arg_hashtable_itr_t*)itr);
+}
+
+int arg_cmd_itr_search(arg_cmd_itr_t itr, void* k) {
+ return arg_hashtable_itr_search((arg_hashtable_itr_t*)itr, s_hashtable, k);
+}
+
+static const char* module_name(void) {
+ if (s_module_name == NULL || strlen(s_module_name) == 0)
+ return "<name>";
+
+ return s_module_name;
+}
+
+static const char* module_version(void) {
+ if (s_mod_ver == NULL || strlen(s_mod_ver) == 0)
+ return "0.0.0.0";
+
+ return s_mod_ver;
+}
+
+void arg_make_get_help_msg(arg_dstr_t res) {
+ arg_dstr_catf(res, "%s v%s\n", module_name(), module_version());
+ arg_dstr_catf(res, "Please type '%s help' to get more information.\n", module_name());
+}
+
+void arg_make_help_msg(arg_dstr_t ds, char* cmd_name, void** argtable) {
+ arg_cmd_info_t* cmd_info = (arg_cmd_info_t*)arg_hashtable_search(s_hashtable, cmd_name);
+ if (cmd_info) {
+ arg_dstr_catf(ds, "%s: %s\n", cmd_name, cmd_info->description);
+ }
+
+ arg_dstr_cat(ds, "Usage:\n");
+ arg_dstr_catf(ds, " %s", module_name());
+
+ arg_print_syntaxv_ds(ds, argtable, "\n \nAvailable options:\n");
+ arg_print_glossary_ds(ds, argtable, " %-23s %s\n");
+
+ arg_dstr_cat(ds, "\n");
+}
+
+void arg_make_syntax_err_msg(arg_dstr_t ds, void** argtable, struct arg_end* end) {
+ arg_print_errors_ds(ds, end, module_name());
+ arg_dstr_cat(ds, "Usage: \n");
+ arg_dstr_catf(ds, " %s", module_name());
+ arg_print_syntaxv_ds(ds, argtable, "\n");
+ arg_dstr_cat(ds, "\n");
+}
+
+int arg_make_syntax_err_help_msg(arg_dstr_t ds, char* name, int help, int nerrors, void** argtable, struct arg_end* end, int* exitcode) {
+ /* help handling
+ * note: '-h|--help' takes precedence over error reporting
+ */
+ if (help > 0) {
+ arg_make_help_msg(ds, name, argtable);
+ *exitcode = EXIT_SUCCESS;
+ return 1;
+ }
+
+ /* syntax error handling */
+ if (nerrors > 0) {
+ arg_make_syntax_err_msg(ds, argtable, end);
+ *exitcode = EXIT_FAILURE;
+ return 1;
+ }
+
+ return 0;
+}
diff --git a/lib/console/argtable3/arg_date.c b/lib/console/argtable3/arg_date.c
new file mode 100644
index 00000000..7b6afcf9
--- /dev/null
+++ b/lib/console/argtable3/arg_date.c
@@ -0,0 +1,575 @@
+/*
+ * SPDX-FileCopyrightText: 1998-2001,2003-2011,2013 Stewart Heitmann
+ *
+ * SPDX-License-Identifier: BSD-3-Clause
+ */
+/*******************************************************************************
+ * arg_date: Implements the date command-line option
+ *
+ * This file is part of the argtable3 library.
+ *
+ * Copyright (C) 1998-2001,2003-2011,2013 Stewart Heitmann
+ * <sheitmann@users.sourceforge.net>
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ * * Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ * * Redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in the
+ * documentation and/or other materials provided with the distribution.
+ * * Neither the name of STEWART HEITMANN nor the names of its contributors
+ * may be used to endorse or promote products derived from this software
+ * without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL STEWART HEITMANN BE LIABLE FOR ANY DIRECT,
+ * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ ******************************************************************************/
+
+#include "argtable3.h"
+
+#ifndef ARG_AMALGAMATION
+#include "argtable3_private.h"
+#endif
+
+#include <stdlib.h>
+#include <string.h>
+
+char* arg_strptime(const char* buf, const char* fmt, struct tm* tm);
+
+static void arg_date_resetfn(struct arg_date* parent) {
+ ARG_TRACE(("%s:resetfn(%p)\n", __FILE__, parent));
+ parent->count = 0;
+}
+
+static int arg_date_scanfn(struct arg_date* parent, const char* argval) {
+ int errorcode = 0;
+
+ if (parent->count == parent->hdr.maxcount) {
+ errorcode = ARG_ERR_MAXCOUNT;
+ } else if (!argval) {
+ /* no argument value was given, leave parent->tmval[] unaltered but still count it */
+ parent->count++;
+ } else {
+ const char* pend;
+ struct tm tm = parent->tmval[parent->count];
+
+ /* parse the given argument value, store result in parent->tmval[] */
+ pend = arg_strptime(argval, parent->format, &tm);
+ if (pend && pend[0] == '\0')
+ parent->tmval[parent->count++] = tm;
+ else
+ errorcode = ARG_ERR_BADDATE;
+ }
+
+ ARG_TRACE(("%s:scanfn(%p) returns %d\n", __FILE__, parent, errorcode));
+ return errorcode;
+}
+
+static int arg_date_checkfn(struct arg_date* parent) {
+ int errorcode = (parent->count < parent->hdr.mincount) ? ARG_ERR_MINCOUNT : 0;
+
+ ARG_TRACE(("%s:checkfn(%p) returns %d\n", __FILE__, parent, errorcode));
+ return errorcode;
+}
+
+static void arg_date_errorfn(struct arg_date* parent, arg_dstr_t ds, int errorcode, const char* argval, const char* progname) {
+ const char* shortopts = parent->hdr.shortopts;
+ const char* longopts = parent->hdr.longopts;
+ const char* datatype = parent->hdr.datatype;
+
+ /* make argval NULL safe */
+ argval = argval ? argval : "";
+
+ arg_dstr_catf(ds, "%s: ", progname);
+ switch (errorcode) {
+ case ARG_ERR_MINCOUNT:
+ arg_dstr_cat(ds, "missing option ");
+ arg_print_option_ds(ds, shortopts, longopts, datatype, "\n");
+ break;
+
+ case ARG_ERR_MAXCOUNT:
+ arg_dstr_cat(ds, "excess option ");
+ arg_print_option_ds(ds, shortopts, longopts, argval, "\n");
+ break;
+
+ case ARG_ERR_BADDATE: {
+ struct tm tm;
+ char buff[200];
+
+ arg_dstr_catf(ds, "illegal timestamp format \"%s\"\n", argval);
+ memset(&tm, 0, sizeof(tm));
+ arg_strptime("1999-12-31 23:59:59", "%F %H:%M:%S", &tm);
+ strftime(buff, sizeof(buff), parent->format, &tm);
+ arg_dstr_catf(ds, "correct format is \"%s\"\n", buff);
+ break;
+ }
+ }
+}
+
+struct arg_date* arg_date0(const char* shortopts, const char* longopts, const char* format, const char* datatype, const char* glossary) {
+ return arg_daten(shortopts, longopts, format, datatype, 0, 1, glossary);
+}
+
+struct arg_date* arg_date1(const char* shortopts, const char* longopts, const char* format, const char* datatype, const char* glossary) {
+ return arg_daten(shortopts, longopts, format, datatype, 1, 1, glossary);
+}
+
+struct arg_date*
+arg_daten(const char* shortopts, const char* longopts, const char* format, const char* datatype, int mincount, int maxcount, const char* glossary) {
+ size_t nbytes;
+ struct arg_date* result;
+
+ /* foolproof things by ensuring maxcount is not less than mincount */
+ maxcount = (maxcount < mincount) ? mincount : maxcount;
+
+ /* default time format is the national date format for the locale */
+ if (!format)
+ format = "%x";
+
+ nbytes = sizeof(struct arg_date) /* storage for struct arg_date */
+ + (size_t)maxcount * sizeof(struct tm); /* storage for tmval[maxcount] array */
+
+ /* allocate storage for the arg_date struct + tmval[] array. */
+ /* we use calloc because we want the tmval[] array zero filled. */
+ result = (struct arg_date*)xcalloc(1, nbytes);
+
+ /* init the arg_hdr struct */
+ result->hdr.flag = ARG_HASVALUE;
+ result->hdr.shortopts = shortopts;
+ result->hdr.longopts = longopts;
+ result->hdr.datatype = datatype ? datatype : format;
+ result->hdr.glossary = glossary;
+ result->hdr.mincount = mincount;
+ result->hdr.maxcount = maxcount;
+ result->hdr.parent = result;
+ result->hdr.resetfn = (arg_resetfn*)arg_date_resetfn;
+ result->hdr.scanfn = (arg_scanfn*)arg_date_scanfn;
+ result->hdr.checkfn = (arg_checkfn*)arg_date_checkfn;
+ result->hdr.errorfn = (arg_errorfn*)arg_date_errorfn;
+
+ /* store the tmval[maxcount] array immediately after the arg_date struct */
+ result->tmval = (struct tm*)(result + 1);
+
+ /* init the remaining arg_date member variables */
+ result->count = 0;
+ result->format = format;
+
+ ARG_TRACE(("arg_daten() returns %p\n", result));
+ return result;
+}
+
+/*-
+ * Copyright (c) 1997, 1998, 2005, 2008 The NetBSD Foundation, Inc.
+ * All rights reserved.
+ *
+ * This code was contributed to The NetBSD Foundation by Klaus Klein.
+ * Heavily optimised by David Laight
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1. Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in the
+ * documentation and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
+ * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
+ * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+ * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
+ * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#include <ctype.h>
+#include <string.h>
+#include <time.h>
+
+/*
+ * We do not implement alternate representations. However, we always
+ * check whether a given modifier is allowed for a certain conversion.
+ */
+#define ALT_E 0x01
+#define ALT_O 0x02
+#define LEGAL_ALT(x) \
+ { \
+ if (alt_format & ~(x)) \
+ return (0); \
+ }
+#define TM_YEAR_BASE (1900)
+
+static int conv_num(const char**, int*, int, int);
+
+static const char* day[7] = {"Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday"};
+
+static const char* abday[7] = {"Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat"};
+
+static const char* mon[12] = {"January", "February", "March", "April", "May", "June",
+ "July", "August", "September", "October", "November", "December"};
+
+static const char* abmon[12] = {"Jan", "Feb", "Mar", "Apr", "May", "Jun", "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"};
+
+static const char* am_pm[2] = {"AM", "PM"};
+
+static int arg_strcasecmp(const char* s1, const char* s2) {
+ const unsigned char* us1 = (const unsigned char*)s1;
+ const unsigned char* us2 = (const unsigned char*)s2;
+ while (tolower(*us1) == tolower(*us2++))
+ if (*us1++ == '\0')
+ return 0;
+
+ return tolower(*us1) - tolower(*--us2);
+}
+
+static int arg_strncasecmp(const char* s1, const char* s2, size_t n) {
+ if (n != 0) {
+ const unsigned char* us1 = (const unsigned char*)s1;
+ const unsigned char* us2 = (const unsigned char*)s2;
+ do {
+ if (tolower(*us1) != tolower(*us2++))
+ return tolower(*us1) - tolower(*--us2);
+
+ if (*us1++ == '\0')
+ break;
+ } while (--n != 0);
+ }
+
+ return 0;
+}
+
+char* arg_strptime(const char* buf, const char* fmt, struct tm* tm) {
+ char c;
+ const char* bp;
+ size_t len = 0;
+ int alt_format, i, split_year = 0;
+
+ bp = buf;
+
+ while ((c = *fmt) != '\0') {
+ /* Clear `alternate' modifier prior to new conversion. */
+ alt_format = 0;
+
+ /* Eat up white-space. */
+ if (isspace(c)) {
+ while (isspace((int)(*bp)))
+ bp++;
+
+ fmt++;
+ continue;
+ }
+
+ if ((c = *fmt++) != '%')
+ goto literal;
+
+ again:
+ switch (c = *fmt++) {
+ case '%': /* "%%" is converted to "%". */
+ literal:
+ if (c != *bp++)
+ return (0);
+ break;
+
+ /*
+ * "Alternative" modifiers. Just set the appropriate flag
+ * and start over again.
+ */
+ case 'E': /* "%E?" alternative conversion modifier. */
+ LEGAL_ALT(0);
+ alt_format |= ALT_E;
+ goto again;
+
+ case 'O': /* "%O?" alternative conversion modifier. */
+ LEGAL_ALT(0);
+ alt_format |= ALT_O;
+ goto again;
+
+ /*
+ * "Complex" conversion rules, implemented through recursion.
+ */
+ case 'c': /* Date and time, using the locale's format. */
+ LEGAL_ALT(ALT_E);
+ bp = arg_strptime(bp, "%x %X", tm);
+ if (!bp)
+ return (0);
+ break;
+
+ case 'D': /* The date as "%m/%d/%y". */
+ LEGAL_ALT(0);
+ bp = arg_strptime(bp, "%m/%d/%y", tm);
+ if (!bp)
+ return (0);
+ break;
+
+ case 'R': /* The time as "%H:%M". */
+ LEGAL_ALT(0);
+ bp = arg_strptime(bp, "%H:%M", tm);
+ if (!bp)
+ return (0);
+ break;
+
+ case 'r': /* The time in 12-hour clock representation. */
+ LEGAL_ALT(0);
+ bp = arg_strptime(bp, "%I:%M:%S %p", tm);
+ if (!bp)
+ return (0);
+ break;
+
+ case 'T': /* The time as "%H:%M:%S". */
+ LEGAL_ALT(0);
+ bp = arg_strptime(bp, "%H:%M:%S", tm);
+ if (!bp)
+ return (0);
+ break;
+
+ case 'X': /* The time, using the locale's format. */
+ LEGAL_ALT(ALT_E);
+ bp = arg_strptime(bp, "%H:%M:%S", tm);
+ if (!bp)
+ return (0);
+ break;
+
+ case 'x': /* The date, using the locale's format. */
+ LEGAL_ALT(ALT_E);
+ bp = arg_strptime(bp, "%m/%d/%y", tm);
+ if (!bp)
+ return (0);
+ break;
+
+ /*
+ * "Elementary" conversion rules.
+ */
+ case 'A': /* The day of week, using the locale's form. */
+ case 'a':
+ LEGAL_ALT(0);
+ for (i = 0; i < 7; i++) {
+ /* Full name. */
+ len = strlen(day[i]);
+ if (arg_strncasecmp(day[i], bp, len) == 0)
+ break;
+
+ /* Abbreviated name. */
+ len = strlen(abday[i]);
+ if (arg_strncasecmp(abday[i], bp, len) == 0)
+ break;
+ }
+
+ /* Nothing matched. */
+ if (i == 7)
+ return (0);
+
+ tm->tm_wday = i;
+ bp += len;
+ break;
+
+ case 'B': /* The month, using the locale's form. */
+ case 'b':
+ case 'h':
+ LEGAL_ALT(0);
+ for (i = 0; i < 12; i++) {
+ /* Full name. */
+ len = strlen(mon[i]);
+ if (arg_strncasecmp(mon[i], bp, len) == 0)
+ break;
+
+ /* Abbreviated name. */
+ len = strlen(abmon[i]);
+ if (arg_strncasecmp(abmon[i], bp, len) == 0)
+ break;
+ }
+
+ /* Nothing matched. */
+ if (i == 12)
+ return (0);
+
+ tm->tm_mon = i;
+ bp += len;
+ break;
+
+ case 'C': /* The century number. */
+ LEGAL_ALT(ALT_E);
+ if (!(conv_num(&bp, &i, 0, 99)))
+ return (0);
+
+ if (split_year) {
+ tm->tm_year = (tm->tm_year % 100) + (i * 100);
+ } else {
+ tm->tm_year = i * 100;
+ split_year = 1;
+ }
+ break;
+
+ case 'd': /* The day of month. */
+ case 'e':
+ LEGAL_ALT(ALT_O);
+ if (!(conv_num(&bp, &tm->tm_mday, 1, 31)))
+ return (0);
+ break;
+
+ case 'k': /* The hour (24-hour clock representation). */
+ LEGAL_ALT(0);
+ /* FALLTHROUGH */
+ case 'H':
+ LEGAL_ALT(ALT_O);
+ if (!(conv_num(&bp, &tm->tm_hour, 0, 23)))
+ return (0);
+ break;
+
+ case 'l': /* The hour (12-hour clock representation). */
+ LEGAL_ALT(0);
+ /* FALLTHROUGH */
+ case 'I':
+ LEGAL_ALT(ALT_O);
+ if (!(conv_num(&bp, &tm->tm_hour, 1, 12)))
+ return (0);
+ if (tm->tm_hour == 12)
+ tm->tm_hour = 0;
+ break;
+
+ case 'j': /* The day of year. */
+ LEGAL_ALT(0);
+ if (!(conv_num(&bp, &i, 1, 366)))
+ return (0);
+ tm->tm_yday = i - 1;
+ break;
+
+ case 'M': /* The minute. */
+ LEGAL_ALT(ALT_O);
+ if (!(conv_num(&bp, &tm->tm_min, 0, 59)))
+ return (0);
+ break;
+
+ case 'm': /* The month. */
+ LEGAL_ALT(ALT_O);
+ if (!(conv_num(&bp, &i, 1, 12)))
+ return (0);
+ tm->tm_mon = i - 1;
+ break;
+
+ case 'p': /* The locale's equivalent of AM/PM. */
+ LEGAL_ALT(0);
+ /* AM? */
+ if (arg_strcasecmp(am_pm[0], bp) == 0) {
+ if (tm->tm_hour > 11)
+ return (0);
+
+ bp += strlen(am_pm[0]);
+ break;
+ }
+ /* PM? */
+ else if (arg_strcasecmp(am_pm[1], bp) == 0) {
+ if (tm->tm_hour > 11)
+ return (0);
+
+ tm->tm_hour += 12;
+ bp += strlen(am_pm[1]);
+ break;
+ }
+
+ /* Nothing matched. */
+ return (0);
+
+ case 'S': /* The seconds. */
+ LEGAL_ALT(ALT_O);
+ if (!(conv_num(&bp, &tm->tm_sec, 0, 61)))
+ return (0);
+ break;
+
+ case 'U': /* The week of year, beginning on sunday. */
+ case 'W': /* The week of year, beginning on monday. */
+ LEGAL_ALT(ALT_O);
+ /*
+ * XXX This is bogus, as we can not assume any valid
+ * information present in the tm structure at this
+ * point to calculate a real value, so just check the
+ * range for now.
+ */
+ if (!(conv_num(&bp, &i, 0, 53)))
+ return (0);
+ break;
+
+ case 'w': /* The day of week, beginning on sunday. */
+ LEGAL_ALT(ALT_O);
+ if (!(conv_num(&bp, &tm->tm_wday, 0, 6)))
+ return (0);
+ break;
+
+ case 'Y': /* The year. */
+ LEGAL_ALT(ALT_E);
+ if (!(conv_num(&bp, &i, 0, 9999)))
+ return (0);
+
+ tm->tm_year = i - TM_YEAR_BASE;
+ break;
+
+ case 'y': /* The year within 100 years of the epoch. */
+ LEGAL_ALT(ALT_E | ALT_O);
+ if (!(conv_num(&bp, &i, 0, 99)))
+ return (0);
+
+ if (split_year) {
+ tm->tm_year = ((tm->tm_year / 100) * 100) + i;
+ break;
+ }
+ split_year = 1;
+ if (i <= 68)
+ tm->tm_year = i + 2000 - TM_YEAR_BASE;
+ else
+ tm->tm_year = i + 1900 - TM_YEAR_BASE;
+ break;
+
+ /*
+ * Miscellaneous conversions.
+ */
+ case 'n': /* Any kind of white-space. */
+ case 't':
+ LEGAL_ALT(0);
+ while (isspace((int)(*bp)))
+ bp++;
+ break;
+
+ default: /* Unknown/unsupported conversion. */
+ return (0);
+ }
+ }
+
+ /* LINTED functional specification */
+ return ((char*)bp);
+}
+
+static int conv_num(const char** buf, int* dest, int llim, int ulim) {
+ int result = 0;
+
+ /* The limit also determines the number of valid digits. */
+ int rulim = ulim;
+
+ if (**buf < '0' || **buf > '9')
+ return (0);
+
+ do {
+ result *= 10;
+ result += *(*buf)++ - '0';
+ rulim /= 10;
+ } while ((result * 10 <= ulim) && rulim && **buf >= '0' && **buf <= '9');
+
+ if (result < llim || result > ulim)
+ return (0);
+
+ *dest = result;
+ return (1);
+}
diff --git a/lib/console/argtable3/arg_dbl.c b/lib/console/argtable3/arg_dbl.c
new file mode 100644
index 00000000..a1c08b75
--- /dev/null
+++ b/lib/console/argtable3/arg_dbl.c
@@ -0,0 +1,164 @@
+/*
+ * SPDX-FileCopyrightText: 1998-2001,2003-2011,2013 Stewart Heitmann
+ *
+ * SPDX-License-Identifier: BSD-3-Clause
+ */
+/*******************************************************************************
+ * arg_dbl: Implements the double command-line option
+ *
+ * This file is part of the argtable3 library.
+ *
+ * Copyright (C) 1998-2001,2003-2011,2013 Stewart Heitmann
+ * <sheitmann@users.sourceforge.net>
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ * * Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ * * Redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in the
+ * documentation and/or other materials provided with the distribution.
+ * * Neither the name of STEWART HEITMANN nor the names of its contributors
+ * may be used to endorse or promote products derived from this software
+ * without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL STEWART HEITMANN BE LIABLE FOR ANY DIRECT,
+ * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ ******************************************************************************/
+
+#include "argtable3.h"
+
+#ifndef ARG_AMALGAMATION
+#include "argtable3_private.h"
+#endif
+
+#include <stdlib.h>
+
+static void arg_dbl_resetfn(struct arg_dbl* parent) {
+ ARG_TRACE(("%s:resetfn(%p)\n", __FILE__, parent));
+ parent->count = 0;
+}
+
+static int arg_dbl_scanfn(struct arg_dbl* parent, const char* argval) {
+ int errorcode = 0;
+
+ if (parent->count == parent->hdr.maxcount) {
+ /* maximum number of arguments exceeded */
+ errorcode = ARG_ERR_MAXCOUNT;
+ } else if (!argval) {
+ /* a valid argument with no argument value was given. */
+ /* This happens when an optional argument value was invoked. */
+ /* leave parent argument value unaltered but still count the argument. */
+ parent->count++;
+ } else {
+ double val;
+ char* end;
+
+ /* extract double from argval into val */
+ val = strtod(argval, &end);
+
+ /* if success then store result in parent->dval[] array otherwise return error*/
+ if (*end == 0)
+ parent->dval[parent->count++] = val;
+ else
+ errorcode = ARG_ERR_BADDOUBLE;
+ }
+
+ ARG_TRACE(("%s:scanfn(%p) returns %d\n", __FILE__, parent, errorcode));
+ return errorcode;
+}
+
+static int arg_dbl_checkfn(struct arg_dbl* parent) {
+ int errorcode = (parent->count < parent->hdr.mincount) ? ARG_ERR_MINCOUNT : 0;
+
+ ARG_TRACE(("%s:checkfn(%p) returns %d\n", __FILE__, parent, errorcode));
+ return errorcode;
+}
+
+static void arg_dbl_errorfn(struct arg_dbl* parent, arg_dstr_t ds, int errorcode, const char* argval, const char* progname) {
+ const char* shortopts = parent->hdr.shortopts;
+ const char* longopts = parent->hdr.longopts;
+ const char* datatype = parent->hdr.datatype;
+
+ /* make argval NULL safe */
+ argval = argval ? argval : "";
+
+ arg_dstr_catf(ds, "%s: ", progname);
+ switch (errorcode) {
+ case ARG_ERR_MINCOUNT:
+ arg_dstr_cat(ds, "missing option ");
+ arg_print_option_ds(ds, shortopts, longopts, datatype, "\n");
+ break;
+
+ case ARG_ERR_MAXCOUNT:
+ arg_dstr_cat(ds, "excess option ");
+ arg_print_option_ds(ds, shortopts, longopts, argval, "\n");
+ break;
+
+ case ARG_ERR_BADDOUBLE:
+ arg_dstr_catf(ds, "invalid argument \"%s\" to option ", argval);
+ arg_print_option_ds(ds, shortopts, longopts, datatype, "\n");
+ break;
+ }
+}
+
+struct arg_dbl* arg_dbl0(const char* shortopts, const char* longopts, const char* datatype, const char* glossary) {
+ return arg_dbln(shortopts, longopts, datatype, 0, 1, glossary);
+}
+
+struct arg_dbl* arg_dbl1(const char* shortopts, const char* longopts, const char* datatype, const char* glossary) {
+ return arg_dbln(shortopts, longopts, datatype, 1, 1, glossary);
+}
+
+struct arg_dbl* arg_dbln(const char* shortopts, const char* longopts, const char* datatype, int mincount, int maxcount, const char* glossary) {
+ size_t nbytes;
+ struct arg_dbl* result;
+ size_t addr;
+ size_t rem;
+
+ /* foolproof things by ensuring maxcount is not less than mincount */
+ maxcount = (maxcount < mincount) ? mincount : maxcount;
+
+ nbytes = sizeof(struct arg_dbl) /* storage for struct arg_dbl */
+ + (size_t)(maxcount + 1) * sizeof(double); /* storage for dval[maxcount] array plus one extra for padding to memory boundary */
+
+ result = (struct arg_dbl*)xmalloc(nbytes);
+
+ /* init the arg_hdr struct */
+ result->hdr.flag = ARG_HASVALUE;
+ result->hdr.shortopts = shortopts;
+ result->hdr.longopts = longopts;
+ result->hdr.datatype = datatype ? datatype : "<double>";
+ result->hdr.glossary = glossary;
+ result->hdr.mincount = mincount;
+ result->hdr.maxcount = maxcount;
+ result->hdr.parent = result;
+ result->hdr.resetfn = (arg_resetfn*)arg_dbl_resetfn;
+ result->hdr.scanfn = (arg_scanfn*)arg_dbl_scanfn;
+ result->hdr.checkfn = (arg_checkfn*)arg_dbl_checkfn;
+ result->hdr.errorfn = (arg_errorfn*)arg_dbl_errorfn;
+
+ /* Store the dval[maxcount] array on the first double boundary that
+ * immediately follows the arg_dbl struct. We do the memory alignment
+ * purely for SPARC and Motorola systems. They require floats and
+ * doubles to be aligned on natural boundaries.
+ */
+ addr = (size_t)(result + 1);
+ rem = addr % sizeof(double);
+ result->dval = (double*)(addr + sizeof(double) - rem);
+ ARG_TRACE(("addr=%p, dval=%p, sizeof(double)=%d rem=%d\n", addr, result->dval, (int)sizeof(double), (int)rem));
+
+ result->count = 0;
+
+ ARG_TRACE(("arg_dbln() returns %p\n", result));
+ return result;
+}
diff --git a/lib/console/argtable3/arg_dstr.c b/lib/console/argtable3/arg_dstr.c
new file mode 100644
index 00000000..6e6cf6b0
--- /dev/null
+++ b/lib/console/argtable3/arg_dstr.c
@@ -0,0 +1,344 @@
+/*
+ * SPDX-FileCopyrightText: 2013-2019 Tom G. Huang
+ *
+ * SPDX-License-Identifier: BSD-3-Clause
+ */
+/*******************************************************************************
+ * arg_dstr: Implements the dynamic string utilities
+ *
+ * This file is part of the argtable3 library.
+ *
+ * Copyright (C) 2013-2019 Tom G. Huang
+ * <tomghuang@gmail.com>
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ * * Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ * * Redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in the
+ * documentation and/or other materials provided with the distribution.
+ * * Neither the name of STEWART HEITMANN nor the names of its contributors
+ * may be used to endorse or promote products derived from this software
+ * without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL STEWART HEITMANN BE LIABLE FOR ANY DIRECT,
+ * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ ******************************************************************************/
+
+#include "argtable3.h"
+
+#ifndef ARG_AMALGAMATION
+#include "argtable3_private.h"
+#endif
+
+#include <stdarg.h>
+#include <stdlib.h>
+#include <string.h>
+
+#if defined(_MSC_VER)
+#pragma warning(push)
+#pragma warning(disable : 4996)
+#endif
+
+#define START_VSNBUFF 16
+
+/*
+ * This dynamic string module is adapted from TclResult.c in the Tcl library.
+ * Here is the copyright notice from the library:
+ *
+ * This software is copyrighted by the Regents of the University of
+ * California, Sun Microsystems, Inc., Scriptics Corporation, ActiveState
+ * Corporation and other parties. The following terms apply to all files
+ * associated with the software unless explicitly disclaimed in
+ * individual files.
+ *
+ * The authors hereby grant permission to use, copy, modify, distribute,
+ * and license this software and its documentation for any purpose, provided
+ * that existing copyright notices are retained in all copies and that this
+ * notice is included verbatim in any distributions. No written agreement,
+ * license, or royalty fee is required for any of the authorized uses.
+ * Modifications to this software may be copyrighted by their authors
+ * and need not follow the licensing terms described here, provided that
+ * the new terms are clearly indicated on the first page of each file where
+ * they apply.
+ *
+ * IN NO EVENT SHALL THE AUTHORS OR DISTRIBUTORS BE LIABLE TO ANY PARTY
+ * FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
+ * ARISING OUT OF THE USE OF THIS SOFTWARE, ITS DOCUMENTATION, OR ANY
+ * DERIVATIVES THEREOF, EVEN IF THE AUTHORS HAVE BEEN ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ *
+ * THE AUTHORS AND DISTRIBUTORS SPECIFICALLY DISCLAIM ANY WARRANTIES,
+ * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE, AND NON-INFRINGEMENT. THIS SOFTWARE
+ * IS PROVIDED ON AN "AS IS" BASIS, AND THE AUTHORS AND DISTRIBUTORS HAVE
+ * NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR
+ * MODIFICATIONS.
+ *
+ * GOVERNMENT USE: If you are acquiring this software on behalf of the
+ * U.S. government, the Government shall have only "Restricted Rights"
+ * in the software and related documentation as defined in the Federal
+ * Acquisition Regulations (FARs) in Clause 52.227.19 (c) (2). If you
+ * are acquiring the software on behalf of the Department of Defense, the
+ * software shall be classified as "Commercial Computer Software" and the
+ * Government shall have only "Restricted Rights" as defined in Clause
+ * 252.227-7014 (b) (3) of DFARs. Notwithstanding the foregoing, the
+ * authors grant the U.S. Government and others acting in its behalf
+ * permission to use and distribute the software in accordance with the
+ * terms specified in this license.
+ */
+
+typedef struct _internal_arg_dstr {
+ char* data;
+ arg_dstr_freefn* free_proc;
+ char sbuf[ARG_DSTR_SIZE + 1];
+ char* append_data;
+ int append_data_size;
+ int append_used;
+} _internal_arg_dstr_t;
+
+static void setup_append_buf(arg_dstr_t res, int newSpace);
+
+arg_dstr_t arg_dstr_create(void) {
+ _internal_arg_dstr_t* h = (_internal_arg_dstr_t*)xmalloc(sizeof(_internal_arg_dstr_t));
+ memset(h, 0, sizeof(_internal_arg_dstr_t));
+ h->sbuf[0] = 0;
+ h->data = h->sbuf;
+ h->free_proc = ARG_DSTR_STATIC;
+ return h;
+}
+
+void arg_dstr_destroy(arg_dstr_t ds) {
+ if (ds == NULL)
+ return;
+
+ arg_dstr_reset(ds);
+ xfree(ds);
+ return;
+}
+
+void arg_dstr_set(arg_dstr_t ds, char* str, arg_dstr_freefn* free_proc) {
+ int length;
+ register arg_dstr_freefn* old_free_proc = ds->free_proc;
+ char* old_result = ds->data;
+
+ if (str == NULL) {
+ ds->sbuf[0] = 0;
+ ds->data = ds->sbuf;
+ ds->free_proc = ARG_DSTR_STATIC;
+ } else if (free_proc == ARG_DSTR_VOLATILE) {
+ length = (int)strlen(str);
+ if (length > ARG_DSTR_SIZE) {
+ ds->data = (char*)xmalloc((unsigned)length + 1);
+ ds->free_proc = ARG_DSTR_DYNAMIC;
+ } else {
+ ds->data = ds->sbuf;
+ ds->free_proc = ARG_DSTR_STATIC;
+ }
+ strcpy(ds->data, str);
+ } else {
+ ds->data = str;
+ ds->free_proc = free_proc;
+ }
+
+ /*
+ * If the old result was dynamically-allocated, free it up. Do it here,
+ * rather than at the beginning, in case the new result value was part of
+ * the old result value.
+ */
+
+ if ((old_free_proc != 0) && (old_result != ds->data)) {
+ if (old_free_proc == ARG_DSTR_DYNAMIC) {
+ xfree(old_result);
+ } else {
+ (*old_free_proc)(old_result);
+ }
+ }
+
+ if ((ds->append_data != NULL) && (ds->append_data_size > 0)) {
+ xfree(ds->append_data);
+ ds->append_data = NULL;
+ ds->append_data_size = 0;
+ }
+}
+
+char* arg_dstr_cstr(arg_dstr_t ds) /* Interpreter whose result to return. */
+{
+ return ds->data;
+}
+
+void arg_dstr_cat(arg_dstr_t ds, const char* str) {
+ setup_append_buf(ds, (int)strlen(str) + 1);
+ memcpy(ds->data + strlen(ds->data), str, strlen(str));
+}
+
+void arg_dstr_catc(arg_dstr_t ds, char c) {
+ setup_append_buf(ds, 2);
+ memcpy(ds->data + strlen(ds->data), &c, 1);
+}
+
+/*
+ * The logic of the `arg_dstr_catf` function is adapted from the `bformat`
+ * function in The Better String Library by Paul Hsieh. Here is the copyright
+ * notice from the library:
+ *
+ * Copyright (c) 2014, Paul Hsieh
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * * Redistributions of source code must retain the above copyright notice, this
+ * list of conditions and the following disclaimer.
+ *
+ * * Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following disclaimer in the documentation
+ * and/or other materials provided with the distribution.
+ *
+ * * Neither the name of bstrlib nor the names of its
+ * contributors may be used to endorse or promote products derived from
+ * this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+void arg_dstr_catf(arg_dstr_t ds, const char* fmt, ...) {
+ va_list arglist;
+ char* buff;
+ int n, r;
+ size_t slen;
+
+ if (fmt == NULL)
+ return;
+
+ /* Since the length is not determinable beforehand, a search is
+ performed using the truncating "vsnprintf" call (to avoid buffer
+ overflows) on increasing potential sizes for the output result. */
+
+ if ((n = (int)(2 * strlen(fmt))) < START_VSNBUFF)
+ n = START_VSNBUFF;
+
+ buff = (char*)xmalloc((size_t)(n + 2));
+ memset(buff, 0, (size_t)(n + 2));
+
+ for (;;) {
+ va_start(arglist, fmt);
+ r = vsnprintf(buff, (size_t)(n + 1), fmt, arglist);
+ va_end(arglist);
+
+ slen = strlen(buff);
+ if (slen < (size_t)n)
+ break;
+
+ if (r > n)
+ n = r;
+ else
+ n += n;
+
+ xfree(buff);
+ buff = (char*)xmalloc((size_t)(n + 2));
+ memset(buff, 0, (size_t)(n + 2));
+ }
+
+ arg_dstr_cat(ds, buff);
+ xfree(buff);
+}
+
+static void setup_append_buf(arg_dstr_t ds, int new_space) {
+ int total_space;
+
+ /*
+ * Make the append buffer larger, if that's necessary, then copy the
+ * data into the append buffer and make the append buffer the official
+ * data.
+ */
+ if (ds->data != ds->append_data) {
+ /*
+ * If the buffer is too big, then free it up so we go back to a
+ * smaller buffer. This avoids tying up memory forever after a large
+ * operation.
+ */
+ if (ds->append_data_size > 500) {
+ xfree(ds->append_data);
+ ds->append_data = NULL;
+ ds->append_data_size = 0;
+ }
+ ds->append_used = (int)strlen(ds->data);
+ } else if (ds->data[ds->append_used] != 0) {
+ /*
+ * Most likely someone has modified a result created by
+ * arg_dstr_cat et al. so that it has a different size. Just
+ * recompute the size.
+ */
+ ds->append_used = (int)strlen(ds->data);
+ }
+
+ total_space = new_space + ds->append_used;
+ if (total_space >= ds->append_data_size) {
+ char* newbuf;
+
+ if (total_space < 100) {
+ total_space = 200;
+ } else {
+ total_space *= 2;
+ }
+ newbuf = (char*)xmalloc((unsigned)total_space);
+ memset(newbuf, 0, (size_t)total_space);
+ strcpy(newbuf, ds->data);
+ if (ds->append_data != NULL) {
+ xfree(ds->append_data);
+ }
+ ds->append_data = newbuf;
+ ds->append_data_size = total_space;
+ } else if (ds->data != ds->append_data) {
+ strcpy(ds->append_data, ds->data);
+ }
+
+ arg_dstr_free(ds);
+ ds->data = ds->append_data;
+}
+
+void arg_dstr_free(arg_dstr_t ds) {
+ if (ds->free_proc != NULL) {
+ if (ds->free_proc == ARG_DSTR_DYNAMIC) {
+ xfree(ds->data);
+ } else {
+ (*ds->free_proc)(ds->data);
+ }
+ ds->free_proc = NULL;
+ }
+}
+
+void arg_dstr_reset(arg_dstr_t ds) {
+ arg_dstr_free(ds);
+ if ((ds->append_data != NULL) && (ds->append_data_size > 0)) {
+ xfree(ds->append_data);
+ ds->append_data = NULL;
+ ds->append_data_size = 0;
+ }
+
+ ds->data = ds->sbuf;
+ ds->sbuf[0] = 0;
+}
+
+#if defined(_MSC_VER)
+#pragma warning(pop)
+#endif
diff --git a/lib/console/argtable3/arg_end.c b/lib/console/argtable3/arg_end.c
new file mode 100644
index 00000000..2d1fd487
--- /dev/null
+++ b/lib/console/argtable3/arg_end.c
@@ -0,0 +1,135 @@
+/*
+ * SPDX-FileCopyrightText: 1998-2001,2003-2011,2013 Stewart Heitmann
+ *
+ * SPDX-License-Identifier: BSD-3-Clause
+ */
+/*******************************************************************************
+ * arg_end: Implements the error handling utilities
+ *
+ * This file is part of the argtable3 library.
+ *
+ * Copyright (C) 1998-2001,2003-2011,2013 Stewart Heitmann
+ * <sheitmann@users.sourceforge.net>
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ * * Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ * * Redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in the
+ * documentation and/or other materials provided with the distribution.
+ * * Neither the name of STEWART HEITMANN nor the names of its contributors
+ * may be used to endorse or promote products derived from this software
+ * without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL STEWART HEITMANN BE LIABLE FOR ANY DIRECT,
+ * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ ******************************************************************************/
+
+#include "argtable3.h"
+
+#ifndef ARG_AMALGAMATION
+#include "argtable3_private.h"
+#endif
+
+#include <stdlib.h>
+
+static void arg_end_resetfn(struct arg_end* parent) {
+ ARG_TRACE(("%s:resetfn(%p)\n", __FILE__, parent));
+ parent->count = 0;
+}
+
+static void arg_end_errorfn(void* parent, arg_dstr_t ds, int error, const char* argval, const char* progname) {
+ /* suppress unreferenced formal parameter warning */
+ (void)parent;
+
+ progname = progname ? progname : "";
+ argval = argval ? argval : "";
+
+ arg_dstr_catf(ds, "%s: ", progname);
+ switch (error) {
+ case ARG_ELIMIT:
+ arg_dstr_cat(ds, "too many errors to display");
+ break;
+ case ARG_EMALLOC:
+ arg_dstr_cat(ds, "insufficient memory");
+ break;
+ case ARG_ENOMATCH:
+ arg_dstr_catf(ds, "unexpected argument \"%s\"", argval);
+ break;
+ case ARG_EMISSARG:
+ arg_dstr_catf(ds, "option \"%s\" requires an argument", argval);
+ break;
+ case ARG_ELONGOPT:
+ arg_dstr_catf(ds, "invalid option \"%s\"", argval);
+ break;
+ default:
+ arg_dstr_catf(ds, "invalid option \"-%c\"", error);
+ break;
+ }
+
+ arg_dstr_cat(ds, "\n");
+}
+
+struct arg_end* arg_end(int maxcount) {
+ size_t nbytes;
+ struct arg_end* result;
+
+ nbytes = sizeof(struct arg_end) + (size_t)maxcount * sizeof(int) /* storage for int error[maxcount] array*/
+ + (size_t)maxcount * sizeof(void*) /* storage for void* parent[maxcount] array */
+ + (size_t)maxcount * sizeof(char*); /* storage for char* argval[maxcount] array */
+
+ result = (struct arg_end*)xmalloc(nbytes);
+
+ /* init the arg_hdr struct */
+ result->hdr.flag = ARG_TERMINATOR;
+ result->hdr.shortopts = NULL;
+ result->hdr.longopts = NULL;
+ result->hdr.datatype = NULL;
+ result->hdr.glossary = NULL;
+ result->hdr.mincount = 1;
+ result->hdr.maxcount = maxcount;
+ result->hdr.parent = result;
+ result->hdr.resetfn = (arg_resetfn*)arg_end_resetfn;
+ result->hdr.scanfn = NULL;
+ result->hdr.checkfn = NULL;
+ result->hdr.errorfn = (arg_errorfn*)arg_end_errorfn;
+
+ /* store error[maxcount] array immediately after struct arg_end */
+ result->error = (int*)(result + 1);
+
+ /* store parent[maxcount] array immediately after error[] array */
+ result->parent = (void**)(result->error + maxcount);
+
+ /* store argval[maxcount] array immediately after parent[] array */
+ result->argval = (const char**)(result->parent + maxcount);
+
+ ARG_TRACE(("arg_end(%d) returns %p\n", maxcount, result));
+ return result;
+}
+
+void arg_print_errors_ds(arg_dstr_t ds, struct arg_end* end, const char* progname) {
+ int i;
+ ARG_TRACE(("arg_errors()\n"));
+ for (i = 0; i < end->count; i++) {
+ struct arg_hdr* errorparent = (struct arg_hdr*)(end->parent[i]);
+ if (errorparent->errorfn)
+ errorparent->errorfn(end->parent[i], ds, end->error[i], end->argval[i], progname);
+ }
+}
+
+void arg_print_errors(FILE* fp, struct arg_end* end, const char* progname) {
+ arg_dstr_t ds = arg_dstr_create();
+ arg_print_errors_ds(ds, end, progname);
+ fputs(arg_dstr_cstr(ds), fp);
+ arg_dstr_destroy(ds);
+}
diff --git a/lib/console/argtable3/arg_file.c b/lib/console/argtable3/arg_file.c
new file mode 100644
index 00000000..72111fdf
--- /dev/null
+++ b/lib/console/argtable3/arg_file.c
@@ -0,0 +1,213 @@
+/*
+ * SPDX-FileCopyrightText: 1998-2001,2003-2011,2013 Stewart Heitmann
+ *
+ * SPDX-License-Identifier: BSD-3-Clause
+ */
+/*******************************************************************************
+ * arg_file: Implements the file command-line option
+ *
+ * This file is part of the argtable3 library.
+ *
+ * Copyright (C) 1998-2001,2003-2011,2013 Stewart Heitmann
+ * <sheitmann@users.sourceforge.net>
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ * * Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ * * Redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in the
+ * documentation and/or other materials provided with the distribution.
+ * * Neither the name of STEWART HEITMANN nor the names of its contributors
+ * may be used to endorse or promote products derived from this software
+ * without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL STEWART HEITMANN BE LIABLE FOR ANY DIRECT,
+ * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ ******************************************************************************/
+
+#include "argtable3.h"
+
+#ifndef ARG_AMALGAMATION
+#include "argtable3_private.h"
+#endif
+
+#include <stdlib.h>
+#include <string.h>
+
+#ifdef WIN32
+#define FILESEPARATOR1 '\\'
+#define FILESEPARATOR2 '/'
+#else
+#define FILESEPARATOR1 '/'
+#define FILESEPARATOR2 '/'
+#endif
+
+static void arg_file_resetfn(struct arg_file* parent) {
+ ARG_TRACE(("%s:resetfn(%p)\n", __FILE__, parent));
+ parent->count = 0;
+}
+
+/* Returns ptr to the base filename within *filename */
+static const char* arg_basename(const char* filename) {
+ const char *result = NULL, *result1, *result2;
+
+ /* Find the last occurrence of eother file separator character. */
+ /* Two alternative file separator chars are supported as legal */
+ /* file separators but not both together in the same filename. */
+ result1 = (filename ? strrchr(filename, FILESEPARATOR1) : NULL);
+ result2 = (filename ? strrchr(filename, FILESEPARATOR2) : NULL);
+
+ if (result2)
+ result = result2 + 1; /* using FILESEPARATOR2 (the alternative file separator) */
+
+ if (result1)
+ result = result1 + 1; /* using FILESEPARATOR1 (the preferred file separator) */
+
+ if (!result)
+ result = filename; /* neither file separator was found so basename is the whole filename */
+
+ /* special cases of "." and ".." are not considered basenames */
+ if (result && (strcmp(".", result) == 0 || strcmp("..", result) == 0))
+ result = filename + strlen(filename);
+
+ return result;
+}
+
+/* Returns ptr to the file extension within *basename */
+static const char* arg_extension(const char* basename) {
+ /* find the last occurrence of '.' in basename */
+ const char* result = (basename ? strrchr(basename, '.') : NULL);
+
+ /* if no '.' was found then return pointer to end of basename */
+ if (basename && !result)
+ result = basename + strlen(basename);
+
+ /* special case: basenames with a single leading dot (eg ".foo") are not considered as true extensions */
+ if (basename && result == basename)
+ result = basename + strlen(basename);
+
+ /* special case: empty extensions (eg "foo.","foo..") are not considered as true extensions */
+ if (basename && result && strlen(result) == 1)
+ result = basename + strlen(basename);
+
+ return result;
+}
+
+static int arg_file_scanfn(struct arg_file* parent, const char* argval) {
+ int errorcode = 0;
+
+ if (parent->count == parent->hdr.maxcount) {
+ /* maximum number of arguments exceeded */
+ errorcode = ARG_ERR_MAXCOUNT;
+ } else if (!argval) {
+ /* a valid argument with no argument value was given. */
+ /* This happens when an optional argument value was invoked. */
+ /* leave parent arguiment value unaltered but still count the argument. */
+ parent->count++;
+ } else {
+ parent->filename[parent->count] = argval;
+ parent->basename[parent->count] = arg_basename(argval);
+ parent->extension[parent->count] =
+ arg_extension(parent->basename[parent->count]); /* only seek extensions within the basename (not the file path)*/
+ parent->count++;
+ }
+
+ ARG_TRACE(("%s4:scanfn(%p) returns %d\n", __FILE__, parent, errorcode));
+ return errorcode;
+}
+
+static int arg_file_checkfn(struct arg_file* parent) {
+ int errorcode = (parent->count < parent->hdr.mincount) ? ARG_ERR_MINCOUNT : 0;
+
+ ARG_TRACE(("%s:checkfn(%p) returns %d\n", __FILE__, parent, errorcode));
+ return errorcode;
+}
+
+static void arg_file_errorfn(struct arg_file* parent, arg_dstr_t ds, int errorcode, const char* argval, const char* progname) {
+ const char* shortopts = parent->hdr.shortopts;
+ const char* longopts = parent->hdr.longopts;
+ const char* datatype = parent->hdr.datatype;
+
+ /* make argval NULL safe */
+ argval = argval ? argval : "";
+
+ arg_dstr_catf(ds, "%s: ", progname);
+ switch (errorcode) {
+ case ARG_ERR_MINCOUNT:
+ arg_dstr_cat(ds, "missing option ");
+ arg_print_option_ds(ds, shortopts, longopts, datatype, "\n");
+ break;
+
+ case ARG_ERR_MAXCOUNT:
+ arg_dstr_cat(ds, "excess option ");
+ arg_print_option_ds(ds, shortopts, longopts, argval, "\n");
+ break;
+
+ default:
+ arg_dstr_catf(ds, "unknown error at \"%s\"\n", argval);
+ }
+}
+
+struct arg_file* arg_file0(const char* shortopts, const char* longopts, const char* datatype, const char* glossary) {
+ return arg_filen(shortopts, longopts, datatype, 0, 1, glossary);
+}
+
+struct arg_file* arg_file1(const char* shortopts, const char* longopts, const char* datatype, const char* glossary) {
+ return arg_filen(shortopts, longopts, datatype, 1, 1, glossary);
+}
+
+struct arg_file* arg_filen(const char* shortopts, const char* longopts, const char* datatype, int mincount, int maxcount, const char* glossary) {
+ size_t nbytes;
+ struct arg_file* result;
+ int i;
+
+ /* foolproof things by ensuring maxcount is not less than mincount */
+ maxcount = (maxcount < mincount) ? mincount : maxcount;
+
+ nbytes = sizeof(struct arg_file) /* storage for struct arg_file */
+ + sizeof(char*) * (size_t)maxcount /* storage for filename[maxcount] array */
+ + sizeof(char*) * (size_t)maxcount /* storage for basename[maxcount] array */
+ + sizeof(char*) * (size_t)maxcount; /* storage for extension[maxcount] array */
+
+ result = (struct arg_file*)xmalloc(nbytes);
+
+ /* init the arg_hdr struct */
+ result->hdr.flag = ARG_HASVALUE;
+ result->hdr.shortopts = shortopts;
+ result->hdr.longopts = longopts;
+ result->hdr.glossary = glossary;
+ result->hdr.datatype = datatype ? datatype : "<file>";
+ result->hdr.mincount = mincount;
+ result->hdr.maxcount = maxcount;
+ result->hdr.parent = result;
+ result->hdr.resetfn = (arg_resetfn*)arg_file_resetfn;
+ result->hdr.scanfn = (arg_scanfn*)arg_file_scanfn;
+ result->hdr.checkfn = (arg_checkfn*)arg_file_checkfn;
+ result->hdr.errorfn = (arg_errorfn*)arg_file_errorfn;
+
+ /* store the filename,basename,extension arrays immediately after the arg_file struct */
+ result->filename = (const char**)(result + 1);
+ result->basename = result->filename + maxcount;
+ result->extension = result->basename + maxcount;
+ result->count = 0;
+
+ /* foolproof the string pointers by initialising them with empty strings */
+ for (i = 0; i < maxcount; i++) {
+ result->filename[i] = "";
+ result->basename[i] = "";
+ result->extension[i] = "";
+ }
+
+ ARG_TRACE(("arg_filen() returns %p\n", result));
+ return result;
+}
diff --git a/lib/console/argtable3/arg_hashtable.c b/lib/console/argtable3/arg_hashtable.c
new file mode 100644
index 00000000..1e8a2d38
--- /dev/null
+++ b/lib/console/argtable3/arg_hashtable.c
@@ -0,0 +1,428 @@
+/*
+ * SPDX-FileCopyrightText: 2013-2019 Tom G. Huang
+ *
+ * SPDX-License-Identifier: BSD-3-Clause
+ */
+/*******************************************************************************
+ * arg_hashtable: Implements the hash table utilities
+ *
+ * This file is part of the argtable3 library.
+ *
+ * Copyright (C) 2013-2019 Tom G. Huang
+ * <tomghuang@gmail.com>
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ * * Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ * * Redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in the
+ * documentation and/or other materials provided with the distribution.
+ * * Neither the name of STEWART HEITMANN nor the names of its contributors
+ * may be used to endorse or promote products derived from this software
+ * without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL STEWART HEITMANN BE LIABLE FOR ANY DIRECT,
+ * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ ******************************************************************************/
+
+#ifndef ARG_AMALGAMATION
+#include "argtable3_private.h"
+#endif
+
+#include <math.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+
+/*
+ * This hash table module is adapted from the C hash table implementation by
+ * Christopher Clark. Here is the copyright notice from the library:
+ *
+ * Copyright (c) 2002, Christopher Clark
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ *
+ * * Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ *
+ * * Redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in the
+ * documentation and/or other materials provided with the distribution.
+ *
+ * * Neither the name of the original author; nor the names of any contributors
+ * may be used to endorse or promote products derived from this software
+ * without specific prior written permission.
+ *
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
+ * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+ * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+ * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+ * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+ * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+ * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+/*
+ * Credit for primes table: Aaron Krowne
+ * http://br.endernet.org/~akrowne/
+ * http://planetmath.org/encyclopedia/GoodHashTablePrimes.html
+ */
+static const unsigned int primes[] = {53, 97, 193, 389, 769, 1543, 3079, 6151, 12289,
+ 24593, 49157, 98317, 196613, 393241, 786433, 1572869, 3145739, 6291469,
+ 12582917, 25165843, 50331653, 100663319, 201326611, 402653189, 805306457, 1610612741};
+const unsigned int prime_table_length = sizeof(primes) / sizeof(primes[0]);
+const float max_load_factor = (float)0.65;
+
+static unsigned int enhanced_hash(arg_hashtable_t* h, const void* k) {
+ /*
+ * Aim to protect against poor hash functions by adding logic here.
+ * The logic is taken from Java 1.4 hash table source.
+ */
+ unsigned int i = h->hashfn(k);
+ i += ~(i << 9);
+ i ^= ((i >> 14) | (i << 18)); /* >>> */
+ i += (i << 4);
+ i ^= ((i >> 10) | (i << 22)); /* >>> */
+ return i;
+}
+
+static unsigned int index_for(unsigned int tablelength, unsigned int hashvalue) {
+ return (hashvalue % tablelength);
+}
+
+arg_hashtable_t* arg_hashtable_create(unsigned int minsize, unsigned int (*hashfn)(const void*), int (*eqfn)(const void*, const void*)) {
+ arg_hashtable_t* h;
+ unsigned int pindex;
+ unsigned int size = primes[0];
+
+ /* Check requested hash table isn't too large */
+ if (minsize > (1u << 30))
+ return NULL;
+
+ /*
+ * Enforce size as prime. The reason is to avoid clustering of values
+ * into a small number of buckets (yes, distribution). A more even
+ * distributed hash table will perform more consistently.
+ */
+ for (pindex = 0; pindex < prime_table_length; pindex++) {
+ if (primes[pindex] > minsize) {
+ size = primes[pindex];
+ break;
+ }
+ }
+
+ h = (arg_hashtable_t*)xmalloc(sizeof(arg_hashtable_t));
+ h->table = (struct arg_hashtable_entry**)xmalloc(sizeof(struct arg_hashtable_entry*) * size);
+ memset(h->table, 0, size * sizeof(struct arg_hashtable_entry*));
+ h->tablelength = size;
+ h->primeindex = pindex;
+ h->entrycount = 0;
+ h->hashfn = hashfn;
+ h->eqfn = eqfn;
+ h->loadlimit = (unsigned int)ceil(size * (double)max_load_factor);
+ return h;
+}
+
+static int arg_hashtable_expand(arg_hashtable_t* h) {
+ /* Double the size of the table to accommodate more entries */
+ struct arg_hashtable_entry** newtable;
+ struct arg_hashtable_entry* e;
+ unsigned int newsize;
+ unsigned int i;
+ unsigned int index;
+
+ /* Check we're not hitting max capacity */
+ if (h->primeindex == (prime_table_length - 1))
+ return 0;
+ newsize = primes[++(h->primeindex)];
+
+ newtable = (struct arg_hashtable_entry**)xmalloc(sizeof(struct arg_hashtable_entry*) * newsize);
+ memset(newtable, 0, newsize * sizeof(struct arg_hashtable_entry*));
+ /*
+ * This algorithm is not 'stable': it reverses the list
+ * when it transfers entries between the tables
+ */
+ for (i = 0; i < h->tablelength; i++) {
+ while (NULL != (e = h->table[i])) {
+ h->table[i] = e->next;
+ index = index_for(newsize, e->h);
+ e->next = newtable[index];
+ newtable[index] = e;
+ }
+ }
+
+ xfree(h->table);
+ h->table = newtable;
+ h->tablelength = newsize;
+ h->loadlimit = (unsigned int)ceil(newsize * (double)max_load_factor);
+ return -1;
+}
+
+unsigned int arg_hashtable_count(arg_hashtable_t* h) {
+ return h->entrycount;
+}
+
+void arg_hashtable_insert(arg_hashtable_t* h, void* k, void* v) {
+ /* This method allows duplicate keys - but they shouldn't be used */
+ unsigned int index;
+ struct arg_hashtable_entry* e;
+ if ((h->entrycount + 1) > h->loadlimit) {
+ /*
+ * Ignore the return value. If expand fails, we should
+ * still try cramming just this value into the existing table
+ * -- we may not have memory for a larger table, but one more
+ * element may be ok. Next time we insert, we'll try expanding again.
+ */
+ arg_hashtable_expand(h);
+ }
+ e = (struct arg_hashtable_entry*)xmalloc(sizeof(struct arg_hashtable_entry));
+ e->h = enhanced_hash(h, k);
+ index = index_for(h->tablelength, e->h);
+ e->k = k;
+ e->v = v;
+ e->next = h->table[index];
+ h->table[index] = e;
+ h->entrycount++;
+}
+
+void* arg_hashtable_search(arg_hashtable_t* h, const void* k) {
+ struct arg_hashtable_entry* e;
+ unsigned int hashvalue;
+ unsigned int index;
+
+ hashvalue = enhanced_hash(h, k);
+ index = index_for(h->tablelength, hashvalue);
+ e = h->table[index];
+ while (e != NULL) {
+ /* Check hash value to short circuit heavier comparison */
+ if ((hashvalue == e->h) && (h->eqfn(k, e->k)))
+ return e->v;
+ e = e->next;
+ }
+ return NULL;
+}
+
+void arg_hashtable_remove(arg_hashtable_t* h, const void* k) {
+ /*
+ * TODO: consider compacting the table when the load factor drops enough,
+ * or provide a 'compact' method.
+ */
+
+ struct arg_hashtable_entry* e;
+ struct arg_hashtable_entry** pE;
+ unsigned int hashvalue;
+ unsigned int index;
+
+ hashvalue = enhanced_hash(h, k);
+ index = index_for(h->tablelength, hashvalue);
+ pE = &(h->table[index]);
+ e = *pE;
+ while (NULL != e) {
+ /* Check hash value to short circuit heavier comparison */
+ if ((hashvalue == e->h) && (h->eqfn(k, e->k))) {
+ *pE = e->next;
+ h->entrycount--;
+ xfree(e->k);
+ xfree(e->v);
+ xfree(e);
+ return;
+ }
+ pE = &(e->next);
+ e = e->next;
+ }
+}
+
+void arg_hashtable_destroy(arg_hashtable_t* h, int free_values) {
+ unsigned int i;
+ struct arg_hashtable_entry *e, *f;
+ struct arg_hashtable_entry** table = h->table;
+ if (free_values) {
+ for (i = 0; i < h->tablelength; i++) {
+ e = table[i];
+ while (NULL != e) {
+ f = e;
+ e = e->next;
+ xfree(f->k);
+ xfree(f->v);
+ xfree(f);
+ }
+ }
+ } else {
+ for (i = 0; i < h->tablelength; i++) {
+ e = table[i];
+ while (NULL != e) {
+ f = e;
+ e = e->next;
+ xfree(f->k);
+ xfree(f);
+ }
+ }
+ }
+ xfree(h->table);
+ xfree(h);
+}
+
+arg_hashtable_itr_t* arg_hashtable_itr_create(arg_hashtable_t* h) {
+ unsigned int i;
+ unsigned int tablelength;
+
+ arg_hashtable_itr_t* itr = (arg_hashtable_itr_t*)xmalloc(sizeof(arg_hashtable_itr_t));
+ itr->h = h;
+ itr->e = NULL;
+ itr->parent = NULL;
+ tablelength = h->tablelength;
+ itr->index = tablelength;
+ if (0 == h->entrycount)
+ return itr;
+
+ for (i = 0; i < tablelength; i++) {
+ if (h->table[i] != NULL) {
+ itr->e = h->table[i];
+ itr->index = i;
+ break;
+ }
+ }
+ return itr;
+}
+
+void arg_hashtable_itr_destroy(arg_hashtable_itr_t* itr) {
+ xfree(itr);
+}
+
+void* arg_hashtable_itr_key(arg_hashtable_itr_t* i) {
+ return i->e->k;
+}
+
+void* arg_hashtable_itr_value(arg_hashtable_itr_t* i) {
+ return i->e->v;
+}
+
+int arg_hashtable_itr_advance(arg_hashtable_itr_t* itr) {
+ unsigned int j;
+ unsigned int tablelength;
+ struct arg_hashtable_entry** table;
+ struct arg_hashtable_entry* next;
+
+ if (itr->e == NULL)
+ return 0; /* stupidity check */
+
+ next = itr->e->next;
+ if (NULL != next) {
+ itr->parent = itr->e;
+ itr->e = next;
+ return -1;
+ }
+
+ tablelength = itr->h->tablelength;
+ itr->parent = NULL;
+ if (tablelength <= (j = ++(itr->index))) {
+ itr->e = NULL;
+ return 0;
+ }
+
+ table = itr->h->table;
+ while (NULL == (next = table[j])) {
+ if (++j >= tablelength) {
+ itr->index = tablelength;
+ itr->e = NULL;
+ return 0;
+ }
+ }
+
+ itr->index = j;
+ itr->e = next;
+ return -1;
+}
+
+int arg_hashtable_itr_remove(arg_hashtable_itr_t* itr) {
+ struct arg_hashtable_entry* remember_e;
+ struct arg_hashtable_entry* remember_parent;
+ int ret;
+
+ /* Do the removal */
+ if ((itr->parent) == NULL) {
+ /* element is head of a chain */
+ itr->h->table[itr->index] = itr->e->next;
+ } else {
+ /* element is mid-chain */
+ itr->parent->next = itr->e->next;
+ }
+ /* itr->e is now outside the hashtable */
+ remember_e = itr->e;
+ itr->h->entrycount--;
+ xfree(remember_e->k);
+ xfree(remember_e->v);
+
+ /* Advance the iterator, correcting the parent */
+ remember_parent = itr->parent;
+ ret = arg_hashtable_itr_advance(itr);
+ if (itr->parent == remember_e) {
+ itr->parent = remember_parent;
+ }
+ xfree(remember_e);
+ return ret;
+}
+
+int arg_hashtable_itr_search(arg_hashtable_itr_t* itr, arg_hashtable_t* h, void* k) {
+ struct arg_hashtable_entry* e;
+ struct arg_hashtable_entry* parent;
+ unsigned int hashvalue;
+ unsigned int index;
+
+ hashvalue = enhanced_hash(h, k);
+ index = index_for(h->tablelength, hashvalue);
+
+ e = h->table[index];
+ parent = NULL;
+ while (e != NULL) {
+ /* Check hash value to short circuit heavier comparison */
+ if ((hashvalue == e->h) && (h->eqfn(k, e->k))) {
+ itr->index = index;
+ itr->e = e;
+ itr->parent = parent;
+ itr->h = h;
+ return -1;
+ }
+ parent = e;
+ e = e->next;
+ }
+ return 0;
+}
+
+int arg_hashtable_change(arg_hashtable_t* h, void* k, void* v) {
+ struct arg_hashtable_entry* e;
+ unsigned int hashvalue;
+ unsigned int index;
+
+ hashvalue = enhanced_hash(h, k);
+ index = index_for(h->tablelength, hashvalue);
+ e = h->table[index];
+ while (e != NULL) {
+ /* Check hash value to short circuit heavier comparison */
+ if ((hashvalue == e->h) && (h->eqfn(k, e->k))) {
+ xfree(e->v);
+ e->v = v;
+ return -1;
+ }
+ e = e->next;
+ }
+ return 0;
+}
diff --git a/lib/console/argtable3/arg_int.c b/lib/console/argtable3/arg_int.c
new file mode 100644
index 00000000..5be40e12
--- /dev/null
+++ b/lib/console/argtable3/arg_int.c
@@ -0,0 +1,294 @@
+/*
+ * SPDX-FileCopyrightText: 1998-2001,2003-2011,2013 Stewart Heitmann
+ *
+ * SPDX-License-Identifier: BSD-3-Clause
+ */
+/*******************************************************************************
+ * arg_int: Implements the int command-line option
+ *
+ * This file is part of the argtable3 library.
+ *
+ * Copyright (C) 1998-2001,2003-2011,2013 Stewart Heitmann
+ * <sheitmann@users.sourceforge.net>
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ * * Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ * * Redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in the
+ * documentation and/or other materials provided with the distribution.
+ * * Neither the name of STEWART HEITMANN nor the names of its contributors
+ * may be used to endorse or promote products derived from this software
+ * without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL STEWART HEITMANN BE LIABLE FOR ANY DIRECT,
+ * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ ******************************************************************************/
+
+#include "argtable3.h"
+
+#ifndef ARG_AMALGAMATION
+#include "argtable3_private.h"
+#endif
+
+#include <ctype.h>
+#include <limits.h>
+#include <stdlib.h>
+
+static void arg_int_resetfn(struct arg_int* parent) {
+ ARG_TRACE(("%s:resetfn(%p)\n", __FILE__, parent));
+ parent->count = 0;
+}
+
+/* strtol0x() is like strtol() except that the numeric string is */
+/* expected to be prefixed by "0X" where X is a user supplied char. */
+/* The string may optionally be prefixed by white space and + or - */
+/* as in +0X123 or -0X123. */
+/* Once the prefix has been scanned, the remainder of the numeric */
+/* string is converted using strtol() with the given base. */
+/* eg: to parse hex str="-0X12324", specify X='X' and base=16. */
+/* eg: to parse oct str="+0o12324", specify X='O' and base=8. */
+/* eg: to parse bin str="-0B01010", specify X='B' and base=2. */
+/* Failure of conversion is indicated by result where *endptr==str. */
+static long int strtol0X(const char* str, const char** endptr, char X, int base) {
+ long int val; /* stores result */
+ int s = 1; /* sign is +1 or -1 */
+ const char* ptr = str; /* ptr to current position in str */
+
+ /* skip leading whitespace */
+ while (isspace((int)(*ptr)))
+ ptr++;
+ /* printf("1) %s\n",ptr); */
+
+ /* scan optional sign character */
+ switch (*ptr) {
+ case '+':
+ ptr++;
+ s = 1;
+ break;
+ case '-':
+ ptr++;
+ s = -1;
+ break;
+ default:
+ s = 1;
+ break;
+ }
+ /* printf("2) %s\n",ptr); */
+
+ /* '0X' prefix */
+ if ((*ptr++) != '0') {
+ /* printf("failed to detect '0'\n"); */
+ *endptr = str;
+ return 0;
+ }
+ /* printf("3) %s\n",ptr); */
+ if (toupper(*ptr++) != toupper(X)) {
+ /* printf("failed to detect '%c'\n",X); */
+ *endptr = str;
+ return 0;
+ }
+ /* printf("4) %s\n",ptr); */
+
+ /* attempt conversion on remainder of string using strtol() */
+ val = strtol(ptr, (char**)endptr, base);
+ if (*endptr == ptr) {
+ /* conversion failed */
+ *endptr = str;
+ return 0;
+ }
+
+ /* success */
+ return s * val;
+}
+
+/* Returns 1 if str matches suffix (case insensitive). */
+/* Str may contain trailing whitespace, but nothing else. */
+static int detectsuffix(const char* str, const char* suffix) {
+ /* scan pairwise through strings until mismatch detected */
+ while (toupper(*str) == toupper(*suffix)) {
+ /* printf("'%c' '%c'\n", *str, *suffix); */
+
+ /* return 1 (success) if match persists until the string terminator */
+ if (*str == '\0')
+ return 1;
+
+ /* next chars */
+ str++;
+ suffix++;
+ }
+ /* printf("'%c' '%c' mismatch\n", *str, *suffix); */
+
+ /* return 0 (fail) if the matching did not consume the entire suffix */
+ if (*suffix != 0)
+ return 0; /* failed to consume entire suffix */
+
+ /* skip any remaining whitespace in str */
+ while (isspace((int)(*str)))
+ str++;
+
+ /* return 1 (success) if we have reached end of str else return 0 (fail) */
+ return (*str == '\0') ? 1 : 0;
+}
+
+static int arg_int_scanfn(struct arg_int* parent, const char* argval) {
+ int errorcode = 0;
+
+ if (parent->count == parent->hdr.maxcount) {
+ /* maximum number of arguments exceeded */
+ errorcode = ARG_ERR_MAXCOUNT;
+ } else if (!argval) {
+ /* a valid argument with no argument value was given. */
+ /* This happens when an optional argument value was invoked. */
+ /* leave parent arguiment value unaltered but still count the argument. */
+ parent->count++;
+ } else {
+ long int val;
+ const char* end;
+
+ /* attempt to extract hex integer (eg: +0x123) from argval into val conversion */
+ val = strtol0X(argval, &end, 'X', 16);
+ if (end == argval) {
+ /* hex failed, attempt octal conversion (eg +0o123) */
+ val = strtol0X(argval, &end, 'O', 8);
+ if (end == argval) {
+ /* octal failed, attempt binary conversion (eg +0B101) */
+ val = strtol0X(argval, &end, 'B', 2);
+ if (end == argval) {
+ /* binary failed, attempt decimal conversion with no prefix (eg 1234) */
+ val = strtol(argval, (char**)&end, 10);
+ if (end == argval) {
+ /* all supported number formats failed */
+ return ARG_ERR_BADINT;
+ }
+ }
+ }
+ }
+
+ /* Safety check for integer overflow. WARNING: this check */
+ /* achieves nothing on machines where size(int)==size(long). */
+ if (val > INT_MAX || val < INT_MIN)
+ errorcode = ARG_ERR_OVERFLOW;
+
+ /* Detect any suffixes (KB,MB,GB) and multiply argument value appropriately. */
+ /* We need to be mindful of integer overflows when using such big numbers. */
+ if (detectsuffix(end, "KB")) /* kilobytes */
+ {
+ if (val > (INT_MAX / 1024) || val < (INT_MIN / 1024))
+ errorcode = ARG_ERR_OVERFLOW; /* Overflow would occur if we proceed */
+ else
+ val *= 1024; /* 1KB = 1024 */
+ } else if (detectsuffix(end, "MB")) /* megabytes */
+ {
+ if (val > (INT_MAX / 1048576) || val < (INT_MIN / 1048576))
+ errorcode = ARG_ERR_OVERFLOW; /* Overflow would occur if we proceed */
+ else
+ val *= 1048576; /* 1MB = 1024*1024 */
+ } else if (detectsuffix(end, "GB")) /* gigabytes */
+ {
+ if (val > (INT_MAX / 1073741824) || val < (INT_MIN / 1073741824))
+ errorcode = ARG_ERR_OVERFLOW; /* Overflow would occur if we proceed */
+ else
+ val *= 1073741824; /* 1GB = 1024*1024*1024 */
+ } else if (!detectsuffix(end, ""))
+ errorcode = ARG_ERR_BADINT; /* invalid suffix detected */
+
+ /* if success then store result in parent->ival[] array */
+ if (errorcode == 0)
+ parent->ival[parent->count++] = (int)val;
+ }
+
+ /* printf("%s:scanfn(%p,%p) returns %d\n",__FILE__,parent,argval,errorcode); */
+ return errorcode;
+}
+
+static int arg_int_checkfn(struct arg_int* parent) {
+ int errorcode = (parent->count < parent->hdr.mincount) ? ARG_ERR_MINCOUNT : 0;
+ /*printf("%s:checkfn(%p) returns %d\n",__FILE__,parent,errorcode);*/
+ return errorcode;
+}
+
+static void arg_int_errorfn(struct arg_int* parent, arg_dstr_t ds, int errorcode, const char* argval, const char* progname) {
+ const char* shortopts = parent->hdr.shortopts;
+ const char* longopts = parent->hdr.longopts;
+ const char* datatype = parent->hdr.datatype;
+
+ /* make argval NULL safe */
+ argval = argval ? argval : "";
+
+ arg_dstr_catf(ds, "%s: ", progname);
+ switch (errorcode) {
+ case ARG_ERR_MINCOUNT:
+ arg_dstr_cat(ds, "missing option ");
+ arg_print_option_ds(ds, shortopts, longopts, datatype, "\n");
+ break;
+
+ case ARG_ERR_MAXCOUNT:
+ arg_dstr_cat(ds, "excess option ");
+ arg_print_option_ds(ds, shortopts, longopts, argval, "\n");
+ break;
+
+ case ARG_ERR_BADINT:
+ arg_dstr_catf(ds, "invalid argument \"%s\" to option ", argval);
+ arg_print_option_ds(ds, shortopts, longopts, datatype, "\n");
+ break;
+
+ case ARG_ERR_OVERFLOW:
+ arg_dstr_cat(ds, "integer overflow at option ");
+ arg_print_option_ds(ds, shortopts, longopts, datatype, " ");
+ arg_dstr_catf(ds, "(%s is too large)\n", argval);
+ break;
+ }
+}
+
+struct arg_int* arg_int0(const char* shortopts, const char* longopts, const char* datatype, const char* glossary) {
+ return arg_intn(shortopts, longopts, datatype, 0, 1, glossary);
+}
+
+struct arg_int* arg_int1(const char* shortopts, const char* longopts, const char* datatype, const char* glossary) {
+ return arg_intn(shortopts, longopts, datatype, 1, 1, glossary);
+}
+
+struct arg_int* arg_intn(const char* shortopts, const char* longopts, const char* datatype, int mincount, int maxcount, const char* glossary) {
+ size_t nbytes;
+ struct arg_int* result;
+
+ /* foolproof things by ensuring maxcount is not less than mincount */
+ maxcount = (maxcount < mincount) ? mincount : maxcount;
+
+ nbytes = sizeof(struct arg_int) /* storage for struct arg_int */
+ + (size_t)maxcount * sizeof(int); /* storage for ival[maxcount] array */
+
+ result = (struct arg_int*)xmalloc(nbytes);
+
+ /* init the arg_hdr struct */
+ result->hdr.flag = ARG_HASVALUE;
+ result->hdr.shortopts = shortopts;
+ result->hdr.longopts = longopts;
+ result->hdr.datatype = datatype ? datatype : "<int>";
+ result->hdr.glossary = glossary;
+ result->hdr.mincount = mincount;
+ result->hdr.maxcount = maxcount;
+ result->hdr.parent = result;
+ result->hdr.resetfn = (arg_resetfn*)arg_int_resetfn;
+ result->hdr.scanfn = (arg_scanfn*)arg_int_scanfn;
+ result->hdr.checkfn = (arg_checkfn*)arg_int_checkfn;
+ result->hdr.errorfn = (arg_errorfn*)arg_int_errorfn;
+
+ /* store the ival[maxcount] array immediately after the arg_int struct */
+ result->ival = (int*)(result + 1);
+ result->count = 0;
+
+ ARG_TRACE(("arg_intn() returns %p\n", result));
+ return result;
+}
diff --git a/lib/console/argtable3/arg_lit.c b/lib/console/argtable3/arg_lit.c
new file mode 100644
index 00000000..8e2db1dd
--- /dev/null
+++ b/lib/console/argtable3/arg_lit.c
@@ -0,0 +1,124 @@
+/*
+ * SPDX-FileCopyrightText: 1998-2001,2003-2011,2013 Stewart Heitmann
+ *
+ * SPDX-License-Identifier: BSD-3-Clause
+ */
+/*******************************************************************************
+ * arg_lit: Implements the literature command-line option
+ *
+ * This file is part of the argtable3 library.
+ *
+ * Copyright (C) 1998-2001,2003-2011,2013 Stewart Heitmann
+ * <sheitmann@users.sourceforge.net>
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ * * Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ * * Redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in the
+ * documentation and/or other materials provided with the distribution.
+ * * Neither the name of STEWART HEITMANN nor the names of its contributors
+ * may be used to endorse or promote products derived from this software
+ * without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL STEWART HEITMANN BE LIABLE FOR ANY DIRECT,
+ * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ ******************************************************************************/
+
+#include "argtable3.h"
+
+#ifndef ARG_AMALGAMATION
+#include "argtable3_private.h"
+#endif
+
+#include <stdlib.h>
+
+static void arg_lit_resetfn(struct arg_lit* parent) {
+ ARG_TRACE(("%s:resetfn(%p)\n", __FILE__, parent));
+ parent->count = 0;
+}
+
+static int arg_lit_scanfn(struct arg_lit* parent, const char* argval) {
+ int errorcode = 0;
+ if (parent->count < parent->hdr.maxcount)
+ parent->count++;
+ else
+ errorcode = ARG_ERR_MAXCOUNT;
+
+ ARG_TRACE(("%s:scanfn(%p,%s) returns %d\n", __FILE__, parent, argval, errorcode));
+ return errorcode;
+}
+
+static int arg_lit_checkfn(struct arg_lit* parent) {
+ int errorcode = (parent->count < parent->hdr.mincount) ? ARG_ERR_MINCOUNT : 0;
+ ARG_TRACE(("%s:checkfn(%p) returns %d\n", __FILE__, parent, errorcode));
+ return errorcode;
+}
+
+static void arg_lit_errorfn(struct arg_lit* parent, arg_dstr_t ds, int errorcode, const char* argval, const char* progname) {
+ const char* shortopts = parent->hdr.shortopts;
+ const char* longopts = parent->hdr.longopts;
+ const char* datatype = parent->hdr.datatype;
+
+ switch (errorcode) {
+ case ARG_ERR_MINCOUNT:
+ arg_dstr_catf(ds, "%s: missing option ", progname);
+ arg_print_option_ds(ds, shortopts, longopts, datatype, "\n");
+ arg_dstr_cat(ds, "\n");
+ break;
+
+ case ARG_ERR_MAXCOUNT:
+ arg_dstr_catf(ds, "%s: extraneous option ", progname);
+ arg_print_option_ds(ds, shortopts, longopts, datatype, "\n");
+ break;
+ }
+
+ ARG_TRACE(("%s:errorfn(%p, %p, %d, %s, %s)\n", __FILE__, parent, ds, errorcode, argval, progname));
+}
+
+struct arg_lit* arg_lit0(const char* shortopts, const char* longopts, const char* glossary) {
+ return arg_litn(shortopts, longopts, 0, 1, glossary);
+}
+
+struct arg_lit* arg_lit1(const char* shortopts, const char* longopts, const char* glossary) {
+ return arg_litn(shortopts, longopts, 1, 1, glossary);
+}
+
+struct arg_lit* arg_litn(const char* shortopts, const char* longopts, int mincount, int maxcount, const char* glossary) {
+ struct arg_lit* result;
+
+ /* foolproof things by ensuring maxcount is not less than mincount */
+ maxcount = (maxcount < mincount) ? mincount : maxcount;
+
+ result = (struct arg_lit*)xmalloc(sizeof(struct arg_lit));
+
+ /* init the arg_hdr struct */
+ result->hdr.flag = 0;
+ result->hdr.shortopts = shortopts;
+ result->hdr.longopts = longopts;
+ result->hdr.datatype = NULL;
+ result->hdr.glossary = glossary;
+ result->hdr.mincount = mincount;
+ result->hdr.maxcount = maxcount;
+ result->hdr.parent = result;
+ result->hdr.resetfn = (arg_resetfn*)arg_lit_resetfn;
+ result->hdr.scanfn = (arg_scanfn*)arg_lit_scanfn;
+ result->hdr.checkfn = (arg_checkfn*)arg_lit_checkfn;
+ result->hdr.errorfn = (arg_errorfn*)arg_lit_errorfn;
+
+ /* init local variables */
+ result->count = 0;
+
+ ARG_TRACE(("arg_litn() returns %p\n", result));
+ return result;
+}
diff --git a/lib/console/argtable3/arg_rem.c b/lib/console/argtable3/arg_rem.c
new file mode 100644
index 00000000..679b5d52
--- /dev/null
+++ b/lib/console/argtable3/arg_rem.c
@@ -0,0 +1,64 @@
+/*
+ * SPDX-FileCopyrightText: 1998-2001,2003-2011,2013 Stewart Heitmann
+ *
+ * SPDX-License-Identifier: BSD-3-Clause
+ */
+/*******************************************************************************
+ * arg_rem: Implements the rem command-line option
+ *
+ * This file is part of the argtable3 library.
+ *
+ * Copyright (C) 1998-2001,2003-2011,2013 Stewart Heitmann
+ * <sheitmann@users.sourceforge.net>
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ * * Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ * * Redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in the
+ * documentation and/or other materials provided with the distribution.
+ * * Neither the name of STEWART HEITMANN nor the names of its contributors
+ * may be used to endorse or promote products derived from this software
+ * without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL STEWART HEITMANN BE LIABLE FOR ANY DIRECT,
+ * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ ******************************************************************************/
+
+#include "argtable3.h"
+
+#ifndef ARG_AMALGAMATION
+#include "argtable3_private.h"
+#endif
+
+#include <stdlib.h>
+
+struct arg_rem* arg_rem(const char* datatype, const char* glossary) {
+ struct arg_rem* result = (struct arg_rem*)xmalloc(sizeof(struct arg_rem));
+
+ result->hdr.flag = 0;
+ result->hdr.shortopts = NULL;
+ result->hdr.longopts = NULL;
+ result->hdr.datatype = datatype;
+ result->hdr.glossary = glossary;
+ result->hdr.mincount = 1;
+ result->hdr.maxcount = 1;
+ result->hdr.parent = result;
+ result->hdr.resetfn = NULL;
+ result->hdr.scanfn = NULL;
+ result->hdr.checkfn = NULL;
+ result->hdr.errorfn = NULL;
+
+ ARG_TRACE(("arg_rem() returns %p\n", result));
+ return result;
+}
diff --git a/lib/console/argtable3/arg_rex.c b/lib/console/argtable3/arg_rex.c
new file mode 100644
index 00000000..8a7aa181
--- /dev/null
+++ b/lib/console/argtable3/arg_rex.c
@@ -0,0 +1,1014 @@
+/*
+ * SPDX-FileCopyrightText: 1998-2001,2003-2011,2013 Stewart Heitmann
+ *
+ * SPDX-License-Identifier: BSD-3-Clause
+ */
+/*******************************************************************************
+ * arg_rex: Implements the regex command-line option
+ *
+ * This file is part of the argtable3 library.
+ *
+ * Copyright (C) 1998-2001,2003-2011,2013 Stewart Heitmann
+ * <sheitmann@users.sourceforge.net>
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ * * Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ * * Redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in the
+ * documentation and/or other materials provided with the distribution.
+ * * Neither the name of STEWART HEITMANN nor the names of its contributors
+ * may be used to endorse or promote products derived from this software
+ * without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL STEWART HEITMANN BE LIABLE FOR ANY DIRECT,
+ * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ ******************************************************************************/
+
+#include "argtable3.h"
+
+#ifndef ARG_AMALGAMATION
+#include "argtable3_private.h"
+#endif
+
+#include <stdlib.h>
+#include <string.h>
+
+#ifndef _TREX_H_
+#define _TREX_H_
+
+/*
+ * This module uses the T-Rex regular expression library to implement the regex
+ * logic. Here is the copyright notice of the library:
+ *
+ * Copyright (C) 2003-2006 Alberto Demichelis
+ *
+ * This software is provided 'as-is', without any express
+ * or implied warranty. In no event will the authors be held
+ * liable for any damages arising from the use of this software.
+ *
+ * Permission is granted to anyone to use this software for
+ * any purpose, including commercial applications, and to alter
+ * it and redistribute it freely, subject to the following restrictions:
+ *
+ * 1. The origin of this software must not be misrepresented;
+ * you must not claim that you wrote the original software.
+ * If you use this software in a product, an acknowledgment
+ * in the product documentation would be appreciated but
+ * is not required.
+ *
+ * 2. Altered source versions must be plainly marked as such,
+ * and must not be misrepresented as being the original software.
+ *
+ * 3. This notice may not be removed or altered from any
+ * source distribution.
+ */
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+#define TRexChar char
+#define MAX_CHAR 0xFF
+#define _TREXC(c) (c)
+#define trex_strlen strlen
+#define trex_printf printf
+
+#ifndef TREX_API
+#define TREX_API extern
+#endif
+
+#define TRex_True 1
+#define TRex_False 0
+
+#define TREX_ICASE ARG_REX_ICASE
+
+typedef unsigned int TRexBool;
+typedef struct TRex TRex;
+
+typedef struct {
+ const TRexChar* begin;
+ int len;
+} TRexMatch;
+
+#if defined(__clang__)
+TREX_API TRex* trex_compile(const TRexChar* pattern, const TRexChar** error, int flags) __attribute__((optnone));
+#elif defined(__GNUC__)
+TREX_API TRex* trex_compile(const TRexChar* pattern, const TRexChar** error, int flags) __attribute__((optimize(0)));
+#else
+TREX_API TRex* trex_compile(const TRexChar* pattern, const TRexChar** error, int flags);
+#endif
+TREX_API void trex_free(TRex* exp);
+TREX_API TRexBool trex_match(TRex* exp, const TRexChar* text);
+TREX_API TRexBool trex_search(TRex* exp, const TRexChar* text, const TRexChar** out_begin, const TRexChar** out_end);
+TREX_API TRexBool
+trex_searchrange(TRex* exp, const TRexChar* text_begin, const TRexChar* text_end, const TRexChar** out_begin, const TRexChar** out_end);
+TREX_API int trex_getsubexpcount(TRex* exp);
+TREX_API TRexBool trex_getsubexp(TRex* exp, int n, TRexMatch* subexp);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif
+
+struct privhdr {
+ const char* pattern;
+ int flags;
+};
+
+static void arg_rex_resetfn(struct arg_rex* parent) {
+ ARG_TRACE(("%s:resetfn(%p)\n", __FILE__, parent));
+ parent->count = 0;
+}
+
+static int arg_rex_scanfn(struct arg_rex* parent, const char* argval) {
+ int errorcode = 0;
+ const TRexChar* error = NULL;
+ TRex* rex = NULL;
+ TRexBool is_match = TRex_False;
+
+ if (parent->count == parent->hdr.maxcount) {
+ /* maximum number of arguments exceeded */
+ errorcode = ARG_ERR_MAXCOUNT;
+ } else if (!argval) {
+ /* a valid argument with no argument value was given. */
+ /* This happens when an optional argument value was invoked. */
+ /* leave parent argument value unaltered but still count the argument. */
+ parent->count++;
+ } else {
+ struct privhdr* priv = (struct privhdr*)parent->hdr.priv;
+
+ /* test the current argument value for a match with the regular expression */
+ /* if a match is detected, record the argument value in the arg_rex struct */
+
+ rex = trex_compile(priv->pattern, &error, priv->flags);
+ is_match = trex_match(rex, argval);
+ if (!is_match)
+ errorcode = ARG_ERR_REGNOMATCH;
+ else
+ parent->sval[parent->count++] = argval;
+
+ trex_free(rex);
+ }
+
+ ARG_TRACE(("%s:scanfn(%p) returns %d\n", __FILE__, parent, errorcode));
+ return errorcode;
+}
+
+static int arg_rex_checkfn(struct arg_rex* parent) {
+ int errorcode = (parent->count < parent->hdr.mincount) ? ARG_ERR_MINCOUNT : 0;
+#if 0
+ struct privhdr *priv = (struct privhdr*)parent->hdr.priv;
+
+ /* free the regex "program" we constructed in resetfn */
+ regfree(&(priv->regex));
+
+ /*printf("%s:checkfn(%p) returns %d\n",__FILE__,parent,errorcode);*/
+#endif
+ return errorcode;
+}
+
+static void arg_rex_errorfn(struct arg_rex* parent, arg_dstr_t ds, int errorcode, const char* argval, const char* progname) {
+ const char* shortopts = parent->hdr.shortopts;
+ const char* longopts = parent->hdr.longopts;
+ const char* datatype = parent->hdr.datatype;
+
+ /* make argval NULL safe */
+ argval = argval ? argval : "";
+
+ arg_dstr_catf(ds, "%s: ", progname);
+ switch (errorcode) {
+ case ARG_ERR_MINCOUNT:
+ arg_dstr_cat(ds, "missing option ");
+ arg_print_option_ds(ds, shortopts, longopts, datatype, "\n");
+ break;
+
+ case ARG_ERR_MAXCOUNT:
+ arg_dstr_cat(ds, "excess option ");
+ arg_print_option_ds(ds, shortopts, longopts, argval, "\n");
+ break;
+
+ case ARG_ERR_REGNOMATCH:
+ arg_dstr_cat(ds, "illegal value ");
+ arg_print_option_ds(ds, shortopts, longopts, argval, "\n");
+ break;
+
+ default: {
+ #if 0
+ char errbuff[256];
+ regerror(errorcode, NULL, errbuff, sizeof(errbuff));
+ printf("%s\n", errbuff);
+ #endif
+ } break;
+ }
+}
+
+struct arg_rex* arg_rex0(const char* shortopts, const char* longopts, const char* pattern, const char* datatype, int flags, const char* glossary) {
+ return arg_rexn(shortopts, longopts, pattern, datatype, 0, 1, flags, glossary);
+}
+
+struct arg_rex* arg_rex1(const char* shortopts, const char* longopts, const char* pattern, const char* datatype, int flags, const char* glossary) {
+ return arg_rexn(shortopts, longopts, pattern, datatype, 1, 1, flags, glossary);
+}
+
+struct arg_rex* arg_rexn(const char* shortopts,
+ const char* longopts,
+ const char* pattern,
+ const char* datatype,
+ int mincount,
+ int maxcount,
+ int flags,
+ const char* glossary) {
+ size_t nbytes;
+ struct arg_rex* result;
+ struct privhdr* priv;
+ int i;
+ const TRexChar* error = NULL;
+ TRex* rex = NULL;
+
+ if (!pattern) {
+ printf("argtable: ERROR - illegal regular expression pattern \"(NULL)\"\n");
+ printf("argtable: Bad argument table.\n");
+ return NULL;
+ }
+
+ /* foolproof things by ensuring maxcount is not less than mincount */
+ maxcount = (maxcount < mincount) ? mincount : maxcount;
+
+ nbytes = sizeof(struct arg_rex) /* storage for struct arg_rex */
+ + sizeof(struct privhdr) /* storage for private arg_rex data */
+ + (size_t)maxcount * sizeof(char*); /* storage for sval[maxcount] array */
+
+ /* init the arg_hdr struct */
+ result = (struct arg_rex*)xmalloc(nbytes);
+ result->hdr.flag = ARG_HASVALUE;
+ result->hdr.shortopts = shortopts;
+ result->hdr.longopts = longopts;
+ result->hdr.datatype = datatype ? datatype : pattern;
+ result->hdr.glossary = glossary;
+ result->hdr.mincount = mincount;
+ result->hdr.maxcount = maxcount;
+ result->hdr.parent = result;
+ result->hdr.resetfn = (arg_resetfn*)arg_rex_resetfn;
+ result->hdr.scanfn = (arg_scanfn*)arg_rex_scanfn;
+ result->hdr.checkfn = (arg_checkfn*)arg_rex_checkfn;
+ result->hdr.errorfn = (arg_errorfn*)arg_rex_errorfn;
+
+ /* store the arg_rex_priv struct immediately after the arg_rex struct */
+ result->hdr.priv = result + 1;
+ priv = (struct privhdr*)(result->hdr.priv);
+ priv->pattern = pattern;
+ priv->flags = flags;
+
+ /* store the sval[maxcount] array immediately after the arg_rex_priv struct */
+ result->sval = (const char**)(priv + 1);
+ result->count = 0;
+
+ /* foolproof the string pointers by initializing them to reference empty strings */
+ for (i = 0; i < maxcount; i++)
+ result->sval[i] = "";
+
+ /* here we construct and destroy a regex representation of the regular
+ * expression for no other reason than to force any regex errors to be
+ * trapped now rather than later. If we don't, then errors may go undetected
+ * until an argument is actually parsed.
+ */
+
+ rex = trex_compile(priv->pattern, &error, priv->flags);
+ if (rex == NULL) {
+ ARG_LOG(("argtable: %s \"%s\"\n", error ? error : _TREXC("undefined"), priv->pattern));
+ ARG_LOG(("argtable: Bad argument table.\n"));
+ }
+
+ trex_free(rex);
+
+ ARG_TRACE(("arg_rexn() returns %p\n", result));
+ return result;
+}
+
+/* see copyright notice in trex.h */
+#include <ctype.h>
+#include <setjmp.h>
+#include <stdlib.h>
+#include <string.h>
+
+#ifdef _UINCODE
+#define scisprint iswprint
+#define scstrlen wcslen
+#define scprintf wprintf
+#define _SC(x) L(x)
+#else
+#define scisprint isprint
+#define scstrlen strlen
+#define scprintf printf
+#define _SC(x) (x)
+#endif
+
+#ifdef ARG_REX_DEBUG
+#include <stdio.h>
+
+static const TRexChar* g_nnames[] = {_SC("NONE"), _SC("OP_GREEDY"), _SC("OP_OR"), _SC("OP_EXPR"), _SC("OP_NOCAPEXPR"),
+ _SC("OP_DOT"), _SC("OP_CLASS"), _SC("OP_CCLASS"), _SC("OP_NCLASS"), _SC("OP_RANGE"),
+ _SC("OP_CHAR"), _SC("OP_EOL"), _SC("OP_BOL"), _SC("OP_WB")};
+
+#endif
+#define OP_GREEDY (MAX_CHAR + 1) /* * + ? {n} */
+#define OP_OR (MAX_CHAR + 2)
+#define OP_EXPR (MAX_CHAR + 3) /* parentesis () */
+#define OP_NOCAPEXPR (MAX_CHAR + 4) /* parentesis (?:) */
+#define OP_DOT (MAX_CHAR + 5)
+#define OP_CLASS (MAX_CHAR + 6)
+#define OP_CCLASS (MAX_CHAR + 7)
+#define OP_NCLASS (MAX_CHAR + 8) /* negates class the [^ */
+#define OP_RANGE (MAX_CHAR + 9)
+#define OP_CHAR (MAX_CHAR + 10)
+#define OP_EOL (MAX_CHAR + 11)
+#define OP_BOL (MAX_CHAR + 12)
+#define OP_WB (MAX_CHAR + 13)
+
+#define TREX_SYMBOL_ANY_CHAR ('.')
+#define TREX_SYMBOL_GREEDY_ONE_OR_MORE ('+')
+#define TREX_SYMBOL_GREEDY_ZERO_OR_MORE ('*')
+#define TREX_SYMBOL_GREEDY_ZERO_OR_ONE ('?')
+#define TREX_SYMBOL_BRANCH ('|')
+#define TREX_SYMBOL_END_OF_STRING ('$')
+#define TREX_SYMBOL_BEGINNING_OF_STRING ('^')
+#define TREX_SYMBOL_ESCAPE_CHAR ('\\')
+
+typedef int TRexNodeType;
+
+typedef struct tagTRexNode {
+ TRexNodeType type;
+ int left;
+ int right;
+ int next;
+} TRexNode;
+
+struct TRex {
+ const TRexChar* _eol;
+ const TRexChar* _bol;
+ const TRexChar* _p;
+ int _first;
+ int _op;
+ TRexNode* _nodes;
+ int _nallocated;
+ int _nsize;
+ int _nsubexpr;
+ TRexMatch* _matches;
+ int _currsubexp;
+ void* _jmpbuf;
+ const TRexChar** _error;
+ int _flags;
+};
+
+static int trex_list(TRex* exp);
+
+static int trex_newnode(TRex* exp, TRexNodeType type) {
+ TRexNode n;
+ int newid;
+ n.type = type;
+ n.next = n.right = n.left = -1;
+ if (type == OP_EXPR)
+ n.right = exp->_nsubexpr++;
+ if (exp->_nallocated < (exp->_nsize + 1)) {
+ exp->_nallocated *= 2;
+ exp->_nodes = (TRexNode*)xrealloc(exp->_nodes, (size_t)exp->_nallocated * sizeof(TRexNode));
+ }
+ exp->_nodes[exp->_nsize++] = n;
+ newid = exp->_nsize - 1;
+ return (int)newid;
+}
+
+static void trex_error(TRex* exp, const TRexChar* error) {
+ if (exp->_error)
+ *exp->_error = error;
+ longjmp(*((jmp_buf*)exp->_jmpbuf), -1);
+}
+
+static void trex_expect(TRex* exp, int n) {
+ if ((*exp->_p) != n)
+ trex_error(exp, _SC("expected paren"));
+ exp->_p++;
+}
+
+static TRexChar trex_escapechar(TRex* exp) {
+ if (*exp->_p == TREX_SYMBOL_ESCAPE_CHAR) {
+ exp->_p++;
+ switch (*exp->_p) {
+ case 'v':
+ exp->_p++;
+ return '\v';
+ case 'n':
+ exp->_p++;
+ return '\n';
+ case 't':
+ exp->_p++;
+ return '\t';
+ case 'r':
+ exp->_p++;
+ return '\r';
+ case 'f':
+ exp->_p++;
+ return '\f';
+ default:
+ return (*exp->_p++);
+ }
+ } else if (!scisprint((int)(*exp->_p)))
+ trex_error(exp, _SC("letter expected"));
+ return (*exp->_p++);
+}
+
+static int trex_charclass(TRex* exp, int classid) {
+ int n = trex_newnode(exp, OP_CCLASS);
+ exp->_nodes[n].left = classid;
+ return n;
+}
+
+static int trex_charnode(TRex* exp, TRexBool isclass) {
+ TRexChar t;
+ if (*exp->_p == TREX_SYMBOL_ESCAPE_CHAR) {
+ exp->_p++;
+ switch (*exp->_p) {
+ case 'n':
+ exp->_p++;
+ return trex_newnode(exp, '\n');
+ case 't':
+ exp->_p++;
+ return trex_newnode(exp, '\t');
+ case 'r':
+ exp->_p++;
+ return trex_newnode(exp, '\r');
+ case 'f':
+ exp->_p++;
+ return trex_newnode(exp, '\f');
+ case 'v':
+ exp->_p++;
+ return trex_newnode(exp, '\v');
+ case 'a':
+ case 'A':
+ case 'w':
+ case 'W':
+ case 's':
+ case 'S':
+ case 'd':
+ case 'D':
+ case 'x':
+ case 'X':
+ case 'c':
+ case 'C':
+ case 'p':
+ case 'P':
+ case 'l':
+ case 'u': {
+ t = *exp->_p;
+ exp->_p++;
+ return trex_charclass(exp, t);
+ }
+ case 'b':
+ case 'B':
+ if (!isclass) {
+ int node = trex_newnode(exp, OP_WB);
+ exp->_nodes[node].left = *exp->_p;
+ exp->_p++;
+ return node;
+ }
+ /* fall through */
+ default:
+ t = *exp->_p;
+ exp->_p++;
+ return trex_newnode(exp, t);
+ }
+ } else if (!scisprint((int)(*exp->_p))) {
+ trex_error(exp, _SC("letter expected"));
+ }
+ t = *exp->_p;
+ exp->_p++;
+ return trex_newnode(exp, t);
+}
+static int trex_class(TRex* exp) {
+ int ret = -1;
+ int first = -1, chain;
+ if (*exp->_p == TREX_SYMBOL_BEGINNING_OF_STRING) {
+ ret = trex_newnode(exp, OP_NCLASS);
+ exp->_p++;
+ } else
+ ret = trex_newnode(exp, OP_CLASS);
+
+ if (*exp->_p == ']')
+ trex_error(exp, _SC("empty class"));
+ chain = ret;
+ while (*exp->_p != ']' && exp->_p != exp->_eol) {
+ if (*exp->_p == '-' && first != -1) {
+ int r, t;
+ if (*exp->_p++ == ']')
+ trex_error(exp, _SC("unfinished range"));
+ r = trex_newnode(exp, OP_RANGE);
+ if (first > *exp->_p)
+ trex_error(exp, _SC("invalid range"));
+ if (exp->_nodes[first].type == OP_CCLASS)
+ trex_error(exp, _SC("cannot use character classes in ranges"));
+ exp->_nodes[r].left = exp->_nodes[first].type;
+ t = trex_escapechar(exp);
+ exp->_nodes[r].right = t;
+ exp->_nodes[chain].next = r;
+ chain = r;
+ first = -1;
+ } else {
+ if (first != -1) {
+ int c = first;
+ exp->_nodes[chain].next = c;
+ chain = c;
+ first = trex_charnode(exp, TRex_True);
+ } else {
+ first = trex_charnode(exp, TRex_True);
+ }
+ }
+ }
+ if (first != -1) {
+ int c = first;
+ exp->_nodes[chain].next = c;
+ chain = c;
+ first = -1;
+ }
+ /* hack? */
+ exp->_nodes[ret].left = exp->_nodes[ret].next;
+ exp->_nodes[ret].next = -1;
+ return ret;
+}
+
+static int trex_parsenumber(TRex* exp) {
+ int ret = *exp->_p - '0';
+ int positions = 10;
+ exp->_p++;
+ while (isdigit((int)(*exp->_p))) {
+ ret = ret * 10 + (*exp->_p++ - '0');
+ if (positions == 1000000000)
+ trex_error(exp, _SC("overflow in numeric constant"));
+ positions *= 10;
+ };
+ return ret;
+}
+
+static int trex_element(TRex* exp) {
+ int ret = -1;
+ switch (*exp->_p) {
+ case '(': {
+ int expr, newn;
+ exp->_p++;
+
+ if (*exp->_p == '?') {
+ exp->_p++;
+ trex_expect(exp, ':');
+ expr = trex_newnode(exp, OP_NOCAPEXPR);
+ } else
+ expr = trex_newnode(exp, OP_EXPR);
+ newn = trex_list(exp);
+ exp->_nodes[expr].left = newn;
+ ret = expr;
+ trex_expect(exp, ')');
+ } break;
+ case '[':
+ exp->_p++;
+ ret = trex_class(exp);
+ trex_expect(exp, ']');
+ break;
+ case TREX_SYMBOL_END_OF_STRING:
+ exp->_p++;
+ ret = trex_newnode(exp, OP_EOL);
+ break;
+ case TREX_SYMBOL_ANY_CHAR:
+ exp->_p++;
+ ret = trex_newnode(exp, OP_DOT);
+ break;
+ default:
+ ret = trex_charnode(exp, TRex_False);
+ break;
+ }
+
+ {
+ TRexBool isgreedy = TRex_False;
+ unsigned short p0 = 0, p1 = 0;
+ switch (*exp->_p) {
+ case TREX_SYMBOL_GREEDY_ZERO_OR_MORE:
+ p0 = 0;
+ p1 = 0xFFFF;
+ exp->_p++;
+ isgreedy = TRex_True;
+ break;
+ case TREX_SYMBOL_GREEDY_ONE_OR_MORE:
+ p0 = 1;
+ p1 = 0xFFFF;
+ exp->_p++;
+ isgreedy = TRex_True;
+ break;
+ case TREX_SYMBOL_GREEDY_ZERO_OR_ONE:
+ p0 = 0;
+ p1 = 1;
+ exp->_p++;
+ isgreedy = TRex_True;
+ break;
+ case '{':
+ exp->_p++;
+ if (!isdigit((int)(*exp->_p)))
+ trex_error(exp, _SC("number expected"));
+ p0 = (unsigned short)trex_parsenumber(exp);
+ /*******************************/
+ switch (*exp->_p) {
+ case '}':
+ p1 = p0;
+ exp->_p++;
+ break;
+ case ',':
+ exp->_p++;
+ p1 = 0xFFFF;
+ if (isdigit((int)(*exp->_p))) {
+ p1 = (unsigned short)trex_parsenumber(exp);
+ }
+ trex_expect(exp, '}');
+ break;
+ default:
+ trex_error(exp, _SC(", or } expected"));
+ }
+ /*******************************/
+ isgreedy = TRex_True;
+ break;
+ }
+ if (isgreedy) {
+ int nnode = trex_newnode(exp, OP_GREEDY);
+ exp->_nodes[nnode].left = ret;
+ exp->_nodes[nnode].right = ((p0) << 16) | p1;
+ ret = nnode;
+ }
+ }
+ if ((*exp->_p != TREX_SYMBOL_BRANCH) && (*exp->_p != ')') && (*exp->_p != TREX_SYMBOL_GREEDY_ZERO_OR_MORE) &&
+ (*exp->_p != TREX_SYMBOL_GREEDY_ONE_OR_MORE) && (*exp->_p != '\0')) {
+ int nnode = trex_element(exp);
+ exp->_nodes[ret].next = nnode;
+ }
+
+ return ret;
+}
+
+static int trex_list(TRex* exp) {
+ int ret = -1, e;
+ if (*exp->_p == TREX_SYMBOL_BEGINNING_OF_STRING) {
+ exp->_p++;
+ ret = trex_newnode(exp, OP_BOL);
+ }
+ e = trex_element(exp);
+ if (ret != -1) {
+ exp->_nodes[ret].next = e;
+ } else
+ ret = e;
+
+ if (*exp->_p == TREX_SYMBOL_BRANCH) {
+ int temp, tright;
+ exp->_p++;
+ temp = trex_newnode(exp, OP_OR);
+ exp->_nodes[temp].left = ret;
+ tright = trex_list(exp);
+ exp->_nodes[temp].right = tright;
+ ret = temp;
+ }
+ return ret;
+}
+
+static TRexBool trex_matchcclass(int cclass, TRexChar c) {
+ switch (cclass) {
+ case 'a':
+ return isalpha(c) ? TRex_True : TRex_False;
+ case 'A':
+ return !isalpha(c) ? TRex_True : TRex_False;
+ case 'w':
+ return (isalnum(c) || c == '_') ? TRex_True : TRex_False;
+ case 'W':
+ return (!isalnum(c) && c != '_') ? TRex_True : TRex_False;
+ case 's':
+ return isspace(c) ? TRex_True : TRex_False;
+ case 'S':
+ return !isspace(c) ? TRex_True : TRex_False;
+ case 'd':
+ return isdigit(c) ? TRex_True : TRex_False;
+ case 'D':
+ return !isdigit(c) ? TRex_True : TRex_False;
+ case 'x':
+ return isxdigit(c) ? TRex_True : TRex_False;
+ case 'X':
+ return !isxdigit(c) ? TRex_True : TRex_False;
+ case 'c':
+ return iscntrl(c) ? TRex_True : TRex_False;
+ case 'C':
+ return !iscntrl(c) ? TRex_True : TRex_False;
+ case 'p':
+ return ispunct(c) ? TRex_True : TRex_False;
+ case 'P':
+ return !ispunct(c) ? TRex_True : TRex_False;
+ case 'l':
+ return islower(c) ? TRex_True : TRex_False;
+ case 'u':
+ return isupper(c) ? TRex_True : TRex_False;
+ }
+ return TRex_False; /*cannot happen*/
+}
+
+static TRexBool trex_matchclass(TRex* exp, TRexNode* node, TRexChar c) {
+ do {
+ switch (node->type) {
+ case OP_RANGE:
+ if (exp->_flags & TREX_ICASE) {
+ if (c >= toupper(node->left) && c <= toupper(node->right))
+ return TRex_True;
+ if (c >= tolower(node->left) && c <= tolower(node->right))
+ return TRex_True;
+ } else {
+ if (c >= node->left && c <= node->right)
+ return TRex_True;
+ }
+ break;
+ case OP_CCLASS:
+ if (trex_matchcclass(node->left, c))
+ return TRex_True;
+ break;
+ default:
+ if (exp->_flags & TREX_ICASE) {
+ if (c == tolower(node->type) || c == toupper(node->type))
+ return TRex_True;
+ } else {
+ if (c == node->type)
+ return TRex_True;
+ }
+ }
+ } while ((node->next != -1) && ((node = &exp->_nodes[node->next]) != NULL));
+ return TRex_False;
+}
+
+static const TRexChar* trex_matchnode(TRex* exp, TRexNode* node, const TRexChar* str, TRexNode* next) {
+ TRexNodeType type = node->type;
+ switch (type) {
+ case OP_GREEDY: {
+ /* TRexNode *greedystop = (node->next != -1) ? &exp->_nodes[node->next] : NULL; */
+ TRexNode* greedystop = NULL;
+ int p0 = (node->right >> 16) & 0x0000FFFF, p1 = node->right & 0x0000FFFF, nmaches = 0;
+ const TRexChar *s = str, *good = str;
+
+ if (node->next != -1) {
+ greedystop = &exp->_nodes[node->next];
+ } else {
+ greedystop = next;
+ }
+
+ while ((nmaches == 0xFFFF || nmaches < p1)) {
+ const TRexChar* stop;
+ if ((s = trex_matchnode(exp, &exp->_nodes[node->left], s, greedystop)) == NULL)
+ break;
+ nmaches++;
+ good = s;
+ if (greedystop) {
+ /* checks that 0 matches satisfy the expression(if so skips) */
+ /* if not would always stop(for instance if is a '?') */
+ if (greedystop->type != OP_GREEDY || (greedystop->type == OP_GREEDY && ((greedystop->right >> 16) & 0x0000FFFF) != 0)) {
+ TRexNode* gnext = NULL;
+ if (greedystop->next != -1) {
+ gnext = &exp->_nodes[greedystop->next];
+ } else if (next && next->next != -1) {
+ gnext = &exp->_nodes[next->next];
+ }
+ stop = trex_matchnode(exp, greedystop, s, gnext);
+ if (stop) {
+ /* if satisfied stop it */
+ if (p0 == p1 && p0 == nmaches)
+ break;
+ else if (nmaches >= p0 && p1 == 0xFFFF)
+ break;
+ else if (nmaches >= p0 && nmaches <= p1)
+ break;
+ }
+ }
+ }
+
+ if (s >= exp->_eol)
+ break;
+ }
+ if (p0 == p1 && p0 == nmaches)
+ return good;
+ else if (nmaches >= p0 && p1 == 0xFFFF)
+ return good;
+ else if (nmaches >= p0 && nmaches <= p1)
+ return good;
+ return NULL;
+ }
+ case OP_OR: {
+ const TRexChar* asd = str;
+ TRexNode* temp = &exp->_nodes[node->left];
+ while ((asd = trex_matchnode(exp, temp, asd, NULL)) != NULL) {
+ if (temp->next != -1)
+ temp = &exp->_nodes[temp->next];
+ else
+ return asd;
+ }
+ asd = str;
+ temp = &exp->_nodes[node->right];
+ while ((asd = trex_matchnode(exp, temp, asd, NULL)) != NULL) {
+ if (temp->next != -1)
+ temp = &exp->_nodes[temp->next];
+ else
+ return asd;
+ }
+ return NULL;
+ break;
+ }
+ case OP_EXPR:
+ case OP_NOCAPEXPR: {
+ TRexNode* n = &exp->_nodes[node->left];
+ const TRexChar* cur = str;
+ int capture = -1;
+ if (node->type != OP_NOCAPEXPR && node->right == exp->_currsubexp) {
+ capture = exp->_currsubexp;
+ exp->_matches[capture].begin = cur;
+ exp->_currsubexp++;
+ }
+
+ do {
+ TRexNode* subnext = NULL;
+ if (n->next != -1) {
+ subnext = &exp->_nodes[n->next];
+ } else {
+ subnext = next;
+ }
+ if ((cur = trex_matchnode(exp, n, cur, subnext)) == NULL) {
+ if (capture != -1) {
+ exp->_matches[capture].begin = 0;
+ exp->_matches[capture].len = 0;
+ }
+ return NULL;
+ }
+ } while ((n->next != -1) && ((n = &exp->_nodes[n->next]) != NULL));
+
+ if (capture != -1)
+ exp->_matches[capture].len = (int)(cur - exp->_matches[capture].begin);
+ return cur;
+ }
+ case OP_WB:
+ if ((str == exp->_bol && !isspace((int)(*str))) || (str == exp->_eol && !isspace((int)(*(str - 1)))) || (!isspace((int)(*str)) && isspace((int)(*(str + 1)))) ||
+ (isspace((int)(*str)) && !isspace((int)(*(str + 1))))) {
+ return (node->left == 'b') ? str : NULL;
+ }
+ return (node->left == 'b') ? NULL : str;
+ case OP_BOL:
+ if (str == exp->_bol)
+ return str;
+ return NULL;
+ case OP_EOL:
+ if (str == exp->_eol)
+ return str;
+ return NULL;
+ case OP_DOT: {
+ str++;
+ }
+ return str;
+ case OP_NCLASS:
+ case OP_CLASS:
+ if (trex_matchclass(exp, &exp->_nodes[node->left], *str) ? (type == OP_CLASS ? TRex_True : TRex_False)
+ : (type == OP_NCLASS ? TRex_True : TRex_False)) {
+ str++;
+ return str;
+ }
+ return NULL;
+ case OP_CCLASS:
+ if (trex_matchcclass(node->left, *str)) {
+ str++;
+ return str;
+ }
+ return NULL;
+ default: /* char */
+ if (exp->_flags & TREX_ICASE) {
+ if (*str != tolower(node->type) && *str != toupper(node->type))
+ return NULL;
+ } else {
+ if (*str != node->type)
+ return NULL;
+ }
+ str++;
+ return str;
+ }
+}
+
+/* public api */
+TRex* trex_compile(const TRexChar* pattern, const TRexChar** error, int flags) {
+ TRex* exp = (TRex*)xmalloc(sizeof(TRex));
+ exp->_eol = exp->_bol = NULL;
+ exp->_p = pattern;
+ exp->_nallocated = (int)(scstrlen(pattern) * sizeof(TRexChar));
+ exp->_nodes = (TRexNode*)xmalloc((size_t)exp->_nallocated * sizeof(TRexNode));
+ exp->_nsize = 0;
+ exp->_matches = 0;
+ exp->_nsubexpr = 0;
+ exp->_first = trex_newnode(exp, OP_EXPR);
+ exp->_error = error;
+ exp->_jmpbuf = xmalloc(sizeof(jmp_buf));
+ exp->_flags = flags;
+ if (setjmp(*((jmp_buf*)exp->_jmpbuf)) == 0) {
+ int res = trex_list(exp);
+ exp->_nodes[exp->_first].left = res;
+ if (*exp->_p != '\0')
+ trex_error(exp, _SC("unexpected character"));
+#ifdef ARG_REX_DEBUG
+ {
+ int nsize, i;
+ nsize = exp->_nsize;
+ scprintf(_SC("\n"));
+ for (i = 0; i < nsize; i++) {
+ if (exp->_nodes[i].type > MAX_CHAR)
+ scprintf(_SC("[%02d] %10s "), i, g_nnames[exp->_nodes[i].type - MAX_CHAR]);
+ else
+ scprintf(_SC("[%02d] %10c "), i, exp->_nodes[i].type);
+ scprintf(_SC("left %02d right %02d next %02d\n"), exp->_nodes[i].left, exp->_nodes[i].right, exp->_nodes[i].next);
+ }
+ scprintf(_SC("\n"));
+ }
+#endif
+ exp->_matches = (TRexMatch*)xmalloc((size_t)exp->_nsubexpr * sizeof(TRexMatch));
+ memset(exp->_matches, 0, (size_t)exp->_nsubexpr * sizeof(TRexMatch));
+ } else {
+ trex_free(exp);
+ return NULL;
+ }
+ return exp;
+}
+
+void trex_free(TRex* exp) {
+ if (exp) {
+ xfree(exp->_nodes);
+ xfree(exp->_jmpbuf);
+ xfree(exp->_matches);
+ xfree(exp);
+ }
+}
+
+TRexBool trex_match(TRex* exp, const TRexChar* text) {
+ const TRexChar* res = NULL;
+ exp->_bol = text;
+ exp->_eol = text + scstrlen(text);
+ exp->_currsubexp = 0;
+ res = trex_matchnode(exp, exp->_nodes, text, NULL);
+ if (res == NULL || res != exp->_eol)
+ return TRex_False;
+ return TRex_True;
+}
+
+TRexBool trex_searchrange(TRex* exp, const TRexChar* text_begin, const TRexChar* text_end, const TRexChar** out_begin, const TRexChar** out_end) {
+ const TRexChar* cur = NULL;
+ int node = exp->_first;
+ if (text_begin >= text_end)
+ return TRex_False;
+ exp->_bol = text_begin;
+ exp->_eol = text_end;
+ do {
+ cur = text_begin;
+ while (node != -1) {
+ exp->_currsubexp = 0;
+ cur = trex_matchnode(exp, &exp->_nodes[node], cur, NULL);
+ if (!cur)
+ break;
+ node = exp->_nodes[node].next;
+ }
+ text_begin++;
+ } while (cur == NULL && text_begin != text_end);
+
+ if (cur == NULL)
+ return TRex_False;
+
+ --text_begin;
+
+ if (out_begin)
+ *out_begin = text_begin;
+ if (out_end)
+ *out_end = cur;
+ return TRex_True;
+}
+
+TRexBool trex_search(TRex* exp, const TRexChar* text, const TRexChar** out_begin, const TRexChar** out_end) {
+ return trex_searchrange(exp, text, text + scstrlen(text), out_begin, out_end);
+}
+
+int trex_getsubexpcount(TRex* exp) {
+ return exp->_nsubexpr;
+}
+
+TRexBool trex_getsubexp(TRex* exp, int n, TRexMatch* subexp) {
+ if (n < 0 || n >= exp->_nsubexpr)
+ return TRex_False;
+ *subexp = exp->_matches[n];
+ return TRex_True;
+}
diff --git a/lib/console/argtable3/arg_str.c b/lib/console/argtable3/arg_str.c
new file mode 100644
index 00000000..a50ae802
--- /dev/null
+++ b/lib/console/argtable3/arg_str.c
@@ -0,0 +1,151 @@
+/*
+ * SPDX-FileCopyrightText: 1998-2001,2003-2011,2013 Stewart Heitmann
+ *
+ * SPDX-License-Identifier: BSD-3-Clause
+ */
+/*******************************************************************************
+ * arg_str: Implements the str command-line option
+ *
+ * This file is part of the argtable3 library.
+ *
+ * Copyright (C) 1998-2001,2003-2011,2013 Stewart Heitmann
+ * <sheitmann@users.sourceforge.net>
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ * * Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ * * Redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in the
+ * documentation and/or other materials provided with the distribution.
+ * * Neither the name of STEWART HEITMANN nor the names of its contributors
+ * may be used to endorse or promote products derived from this software
+ * without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL STEWART HEITMANN BE LIABLE FOR ANY DIRECT,
+ * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ ******************************************************************************/
+
+#include "argtable3.h"
+
+#ifndef ARG_AMALGAMATION
+#include "argtable3_private.h"
+#endif
+
+#include <stdlib.h>
+
+static void arg_str_resetfn(struct arg_str* parent) {
+ int i;
+
+ ARG_TRACE(("%s:resetfn(%p)\n", __FILE__, parent));
+ for (i = 0; i < parent->count; i++) {
+ parent->sval[i] = "";
+ }
+ parent->count = 0;
+}
+
+static int arg_str_scanfn(struct arg_str* parent, const char* argval) {
+ int errorcode = 0;
+
+ if (parent->count == parent->hdr.maxcount) {
+ /* maximum number of arguments exceeded */
+ errorcode = ARG_ERR_MAXCOUNT;
+ } else if (!argval) {
+ /* a valid argument with no argument value was given. */
+ /* This happens when an optional argument value was invoked. */
+ /* leave parent argument value unaltered but still count the argument. */
+ parent->count++;
+ } else {
+ parent->sval[parent->count++] = argval;
+ }
+
+ ARG_TRACE(("%s:scanfn(%p) returns %d\n", __FILE__, parent, errorcode));
+ return errorcode;
+}
+
+static int arg_str_checkfn(struct arg_str* parent) {
+ int errorcode = (parent->count < parent->hdr.mincount) ? ARG_ERR_MINCOUNT : 0;
+
+ ARG_TRACE(("%s:checkfn(%p) returns %d\n", __FILE__, parent, errorcode));
+ return errorcode;
+}
+
+static void arg_str_errorfn(struct arg_str* parent, arg_dstr_t ds, int errorcode, const char* argval, const char* progname) {
+ const char* shortopts = parent->hdr.shortopts;
+ const char* longopts = parent->hdr.longopts;
+ const char* datatype = parent->hdr.datatype;
+
+ /* make argval NULL safe */
+ argval = argval ? argval : "";
+
+ arg_dstr_catf(ds, "%s: ", progname);
+ switch (errorcode) {
+ case ARG_ERR_MINCOUNT:
+ arg_dstr_cat(ds, "missing option ");
+ arg_print_option_ds(ds, shortopts, longopts, datatype, "\n");
+ break;
+
+ case ARG_ERR_MAXCOUNT:
+ arg_dstr_cat(ds, "excess option ");
+ arg_print_option_ds(ds, shortopts, longopts, argval, "\n");
+ break;
+ }
+}
+
+struct arg_str* arg_str0(const char* shortopts, const char* longopts, const char* datatype, const char* glossary) {
+ return arg_strn(shortopts, longopts, datatype, 0, 1, glossary);
+}
+
+struct arg_str* arg_str1(const char* shortopts, const char* longopts, const char* datatype, const char* glossary) {
+ return arg_strn(shortopts, longopts, datatype, 1, 1, glossary);
+}
+
+struct arg_str* arg_strn(const char* shortopts, const char* longopts, const char* datatype, int mincount, int maxcount, const char* glossary) {
+ size_t nbytes;
+ struct arg_str* result;
+ int i;
+
+ /* should not allow this stupid error */
+ /* we should return an error code warning this logic error */
+ /* foolproof things by ensuring maxcount is not less than mincount */
+ maxcount = (maxcount < mincount) ? mincount : maxcount;
+
+ nbytes = sizeof(struct arg_str) /* storage for struct arg_str */
+ + (size_t)maxcount * sizeof(char*); /* storage for sval[maxcount] array */
+
+ result = (struct arg_str*)xmalloc(nbytes);
+
+ /* init the arg_hdr struct */
+ result->hdr.flag = ARG_HASVALUE;
+ result->hdr.shortopts = shortopts;
+ result->hdr.longopts = longopts;
+ result->hdr.datatype = datatype ? datatype : "<string>";
+ result->hdr.glossary = glossary;
+ result->hdr.mincount = mincount;
+ result->hdr.maxcount = maxcount;
+ result->hdr.parent = result;
+ result->hdr.resetfn = (arg_resetfn*)arg_str_resetfn;
+ result->hdr.scanfn = (arg_scanfn*)arg_str_scanfn;
+ result->hdr.checkfn = (arg_checkfn*)arg_str_checkfn;
+ result->hdr.errorfn = (arg_errorfn*)arg_str_errorfn;
+
+ /* store the sval[maxcount] array immediately after the arg_str struct */
+ result->sval = (const char**)(result + 1);
+ result->count = 0;
+
+ /* foolproof the string pointers by initializing them to reference empty strings */
+ for (i = 0; i < maxcount; i++)
+ result->sval[i] = "";
+
+ ARG_TRACE(("arg_strn() returns %p\n", result));
+ return result;
+}
diff --git a/lib/console/argtable3/arg_utils.c b/lib/console/argtable3/arg_utils.c
new file mode 100644
index 00000000..f10034fd
--- /dev/null
+++ b/lib/console/argtable3/arg_utils.c
@@ -0,0 +1,183 @@
+/*
+ * SPDX-FileCopyrightText: 2013-2019 Tom G. Huang
+ *
+ * SPDX-License-Identifier: BSD-3-Clause
+ */
+/*******************************************************************************
+ * arg_utils: Implements memory, panic, and other utility functions
+ *
+ * This file is part of the argtable3 library.
+ *
+ * Copyright (C) 2013-2019 Tom G. Huang
+ * <tomghuang@gmail.com>
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ * * Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ * * Redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in the
+ * documentation and/or other materials provided with the distribution.
+ * * Neither the name of STEWART HEITMANN nor the names of its contributors
+ * may be used to endorse or promote products derived from this software
+ * without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL STEWART HEITMANN BE LIABLE FOR ANY DIRECT,
+ * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ ******************************************************************************/
+
+#include "argtable3.h"
+
+#ifndef ARG_AMALGAMATION
+#include "argtable3_private.h"
+#endif
+
+#include <stdarg.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+
+static void panic(const char* fmt, ...);
+static arg_panicfn* s_panic = panic;
+
+void dbg_printf(const char* fmt, ...) {
+ va_list args;
+ va_start(args, fmt);
+ vfprintf(stderr, fmt, args);
+ va_end(args);
+}
+
+static void panic(const char* fmt, ...) {
+ va_list args;
+ char* s;
+
+ va_start(args, fmt);
+ vfprintf(stderr, fmt, args);
+ va_end(args);
+
+#if defined(_MSC_VER)
+#pragma warning(push)
+#pragma warning(disable : 4996)
+#endif
+ s = getenv("EF_DUMPCORE");
+#if defined(_MSC_VER)
+#pragma warning(pop)
+#endif
+
+ if (s != NULL && *s != '\0') {
+ abort();
+ } else {
+ exit(EXIT_FAILURE);
+ }
+}
+
+void arg_set_panic(arg_panicfn* proc) {
+ s_panic = proc;
+}
+
+void* xmalloc(size_t size) {
+ void* ret = malloc(size);
+ if (!ret) {
+ s_panic("Out of memory!\n");
+ }
+ return ret;
+}
+
+void* xcalloc(size_t count, size_t size) {
+ size_t allocated_count = count && size ? count : 1;
+ size_t allocated_size = count && size ? size : 1;
+ void* ret = calloc(allocated_count, allocated_size);
+ if (!ret) {
+ s_panic("Out of memory!\n");
+ }
+ return ret;
+}
+
+void* xrealloc(void* ptr, size_t size) {
+ size_t allocated_size = size ? size : 1;
+ void* ret = realloc(ptr, allocated_size);
+ if (!ret) {
+ s_panic("Out of memory!\n");
+ }
+ return ret;
+}
+
+void xfree(void* ptr) {
+ free(ptr);
+}
+
+static void merge(void* data, int esize, int i, int j, int k, arg_comparefn* comparefn) {
+ char* a = (char*)data;
+ char* m;
+ int ipos, jpos, mpos;
+
+ /* Initialize the counters used in merging. */
+ ipos = i;
+ jpos = j + 1;
+ mpos = 0;
+
+ /* Allocate storage for the merged elements. */
+ m = (char*)xmalloc((size_t)(esize * ((k - i) + 1)));
+
+ /* Continue while either division has elements to merge. */
+ while (ipos <= j || jpos <= k) {
+ if (ipos > j) {
+ /* The left division has no more elements to merge. */
+ while (jpos <= k) {
+ memcpy(&m[mpos * esize], &a[jpos * esize], (size_t)esize);
+ jpos++;
+ mpos++;
+ }
+
+ continue;
+ } else if (jpos > k) {
+ /* The right division has no more elements to merge. */
+ while (ipos <= j) {
+ memcpy(&m[mpos * esize], &a[ipos * esize], (size_t)esize);
+ ipos++;
+ mpos++;
+ }
+
+ continue;
+ }
+
+ /* Append the next ordered element to the merged elements. */
+ if (comparefn(&a[ipos * esize], &a[jpos * esize]) < 0) {
+ memcpy(&m[mpos * esize], &a[ipos * esize], (size_t)esize);
+ ipos++;
+ mpos++;
+ } else {
+ memcpy(&m[mpos * esize], &a[jpos * esize], (size_t)esize);
+ jpos++;
+ mpos++;
+ }
+ }
+
+ /* Prepare to pass back the merged data. */
+ memcpy(&a[i * esize], m, (size_t)(esize * ((k - i) + 1)));
+ xfree(m);
+}
+
+void arg_mgsort(void* data, int size, int esize, int i, int k, arg_comparefn* comparefn) {
+ int j;
+
+ /* Stop the recursion when no more divisions can be made. */
+ if (i < k) {
+ /* Determine where to divide the elements. */
+ j = (int)(((i + k - 1)) / 2);
+
+ /* Recursively sort the two divisions. */
+ arg_mgsort(data, size, esize, i, j, comparefn);
+ arg_mgsort(data, size, esize, j + 1, k, comparefn);
+ merge(data, esize, i, j, k, comparefn);
+ }
+}
diff --git a/lib/console/argtable3/argtable3.c b/lib/console/argtable3/argtable3.c
new file mode 100644
index 00000000..968b5615
--- /dev/null
+++ b/lib/console/argtable3/argtable3.c
@@ -0,0 +1,1111 @@
+/*
+ * SPDX-FileCopyrightText: 1998-2001,2003-2011,2013 Stewart Heitmann
+ *
+ * SPDX-License-Identifier: BSD-3-Clause
+ */
+/*******************************************************************************
+ * argtable3: Implements the main interfaces of the library
+ *
+ * This file is part of the argtable3 library.
+ *
+ * Copyright (C) 1998-2001,2003-2011,2013 Stewart Heitmann
+ * <sheitmann@users.sourceforge.net>
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ * * Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ * * Redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in the
+ * documentation and/or other materials provided with the distribution.
+ * * Neither the name of STEWART HEITMANN nor the names of its contributors
+ * may be used to endorse or promote products derived from this software
+ * without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL STEWART HEITMANN BE LIABLE FOR ANY DIRECT,
+ * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ ******************************************************************************/
+
+#include "argtable3.h"
+
+#ifndef ARG_AMALGAMATION
+#include "argtable3_private.h"
+#if ARG_REPLACE_GETOPT == 1
+#include "arg_getopt.h"
+#else
+#include <getopt.h>
+#endif
+#else
+#if ARG_REPLACE_GETOPT == 0
+#include <getopt.h>
+#endif
+#endif
+
+#ifdef _WIN32
+#define WIN32_LEAN_AND_MEAN
+#include <windows.h>
+#undef WIN32_LEAN_AND_MEAN
+#endif
+
+#include <assert.h>
+#include <ctype.h>
+#include <limits.h>
+#include <stdlib.h>
+#include <string.h>
+
+static void arg_register_error(struct arg_end* end, void* parent, int error, const char* argval) {
+ /* printf("arg_register_error(%p,%p,%d,%s)\n",end,parent,error,argval); */
+ if (end->count < end->hdr.maxcount) {
+ end->error[end->count] = error;
+ end->parent[end->count] = parent;
+ end->argval[end->count] = argval;
+ end->count++;
+ } else {
+ end->error[end->hdr.maxcount - 1] = ARG_ELIMIT;
+ end->parent[end->hdr.maxcount - 1] = end;
+ end->argval[end->hdr.maxcount - 1] = NULL;
+ }
+}
+
+/*
+ * Return index of first table entry with a matching short option
+ * or -1 if no match was found.
+ */
+static int find_shortoption(struct arg_hdr** table, char shortopt) {
+ int tabindex;
+ for (tabindex = 0; !(table[tabindex]->flag & ARG_TERMINATOR); tabindex++) {
+ if (table[tabindex]->shortopts && strchr(table[tabindex]->shortopts, shortopt))
+ return tabindex;
+ }
+ return -1;
+}
+
+struct longoptions {
+ int getoptval;
+ int noptions;
+ struct option* options;
+};
+
+#if 0
+static
+void dump_longoptions(struct longoptions * longoptions)
+{
+ int i;
+ printf("getoptval = %d\n", longoptions->getoptval);
+ printf("noptions = %d\n", longoptions->noptions);
+ for (i = 0; i < longoptions->noptions; i++)
+ {
+ printf("options[%d].name = \"%s\"\n",
+ i,
+ longoptions->options[i].name);
+ printf("options[%d].has_arg = %d\n", i, longoptions->options[i].has_arg);
+ printf("options[%d].flag = %p\n", i, longoptions->options[i].flag);
+ printf("options[%d].val = %d\n", i, longoptions->options[i].val);
+ }
+}
+#endif
+
+static struct longoptions* alloc_longoptions(struct arg_hdr** table) {
+ struct longoptions* result;
+ size_t nbytes;
+ int noptions = 1;
+ size_t longoptlen = 0;
+ int tabindex;
+ int option_index = 0;
+ char* store;
+
+ /*
+ * Determine the total number of option structs required
+ * by counting the number of comma separated long options
+ * in all table entries and return the count in noptions.
+ * note: noptions starts at 1 not 0 because we getoptlong
+ * requires a NULL option entry to terminate the option array.
+ * While we are at it, count the number of chars required
+ * to store private copies of all the longoption strings
+ * and return that count in logoptlen.
+ */
+ tabindex = 0;
+ do {
+ const char* longopts = table[tabindex]->longopts;
+ longoptlen += (longopts ? strlen(longopts) : 0) + 1;
+ while (longopts) {
+ noptions++;
+ longopts = strchr(longopts + 1, ',');
+ }
+ } while (!(table[tabindex++]->flag & ARG_TERMINATOR));
+ /*printf("%d long options consuming %d chars in total\n",noptions,longoptlen);*/
+
+ /* allocate storage for return data structure as: */
+ /* (struct longoptions) + (struct options)[noptions] + char[longoptlen] */
+ nbytes = sizeof(struct longoptions) + sizeof(struct option) * (size_t)noptions + longoptlen;
+ result = (struct longoptions*)xmalloc(nbytes);
+
+ result->getoptval = 0;
+ result->noptions = noptions;
+ result->options = (struct option*)(result + 1);
+ store = (char*)(result->options + noptions);
+
+ for (tabindex = 0; !(table[tabindex]->flag & ARG_TERMINATOR); tabindex++) {
+ const char* longopts = table[tabindex]->longopts;
+
+ while (longopts && *longopts) {
+ char* storestart = store;
+
+ /* copy progressive longopt strings into the store */
+ while (*longopts != 0 && *longopts != ',')
+ *store++ = *longopts++;
+ *store++ = 0;
+ if (*longopts == ',')
+ longopts++;
+ /*fprintf(stderr,"storestart=\"%s\"\n",storestart);*/
+
+ result->options[option_index].name = storestart;
+ result->options[option_index].flag = &(result->getoptval);
+ result->options[option_index].val = tabindex;
+ if (table[tabindex]->flag & ARG_HASOPTVALUE)
+ result->options[option_index].has_arg = 2;
+ else if (table[tabindex]->flag & ARG_HASVALUE)
+ result->options[option_index].has_arg = 1;
+ else
+ result->options[option_index].has_arg = 0;
+
+ option_index++;
+ }
+ }
+ /* terminate the options array with a zero-filled entry */
+ result->options[option_index].name = 0;
+ result->options[option_index].has_arg = 0;
+ result->options[option_index].flag = 0;
+ result->options[option_index].val = 0;
+
+ /*dump_longoptions(result);*/
+ return result;
+}
+
+static char* alloc_shortoptions(struct arg_hdr** table) {
+ char* result;
+ size_t len = 2;
+ int tabindex;
+ char* res;
+
+ /* determine the total number of option chars required */
+ for (tabindex = 0; !(table[tabindex]->flag & ARG_TERMINATOR); tabindex++) {
+ struct arg_hdr* hdr = table[tabindex];
+ len += 3 * (hdr->shortopts ? strlen(hdr->shortopts) : 0);
+ }
+
+ result = xmalloc(len);
+
+ res = result;
+
+ /* add a leading ':' so getopt return codes distinguish */
+ /* unrecognised option and options missing argument values */
+ *res++ = ':';
+
+ for (tabindex = 0; !(table[tabindex]->flag & ARG_TERMINATOR); tabindex++) {
+ struct arg_hdr* hdr = table[tabindex];
+ const char* shortopts = hdr->shortopts;
+ while (shortopts && *shortopts) {
+ *res++ = *shortopts++;
+ if (hdr->flag & ARG_HASVALUE)
+ *res++ = ':';
+ if (hdr->flag & ARG_HASOPTVALUE)
+ *res++ = ':';
+ }
+ }
+ /* null terminate the string */
+ *res = 0;
+
+ /*printf("alloc_shortoptions() returns \"%s\"\n",(result?result:"NULL"));*/
+ return result;
+}
+
+/* return index of the table terminator entry */
+static int arg_endindex(struct arg_hdr** table) {
+ int tabindex = 0;
+ while (!(table[tabindex]->flag & ARG_TERMINATOR))
+ tabindex++;
+ return tabindex;
+}
+
+static void arg_parse_tagged(int argc, char** argv, struct arg_hdr** table, struct arg_end* endtable) {
+ struct longoptions* longoptions;
+ char* shortoptions;
+ int copt;
+
+ /*printf("arg_parse_tagged(%d,%p,%p,%p)\n",argc,argv,table,endtable);*/
+
+ /* allocate short and long option arrays for the given opttable[]. */
+ /* if the allocs fail then put an error msg in the last table entry. */
+ longoptions = alloc_longoptions(table);
+ shortoptions = alloc_shortoptions(table);
+
+ /*dump_longoptions(longoptions);*/
+
+ /* reset getopts internal option-index to zero, and disable error reporting */
+ optind = 0;
+ opterr = 0;
+
+ /* fetch and process args using getopt_long */
+#ifdef ARG_LONG_ONLY
+ while ((copt = getopt_long_only(argc, argv, shortoptions, longoptions->options, NULL)) != -1) {
+#else
+ while ((copt = getopt_long(argc, argv, shortoptions, longoptions->options, NULL)) != -1) {
+#endif
+ /*
+ printf("optarg='%s'\n",optarg);
+ printf("optind=%d\n",optind);
+ printf("copt=%c\n",(char)copt);
+ printf("optopt=%c (%d)\n",optopt, (int)(optopt));
+ */
+ switch (copt) {
+ case 0: {
+ int tabindex = longoptions->getoptval;
+ void* parent = table[tabindex]->parent;
+ /*printf("long option detected from argtable[%d]\n", tabindex);*/
+ if (optarg && optarg[0] == 0 && (table[tabindex]->flag & ARG_HASVALUE)) {
+ /* printf(": long option %s requires an argument\n",argv[optind-1]); */
+ arg_register_error(endtable, endtable, ARG_EMISSARG, argv[optind - 1]);
+ /* continue to scan the (empty) argument value to enforce argument count checking */
+ }
+ if (table[tabindex]->scanfn) {
+ int errorcode = table[tabindex]->scanfn(parent, optarg);
+ if (errorcode != 0)
+ arg_register_error(endtable, parent, errorcode, optarg);
+ }
+ } break;
+
+ case '?':
+ /*
+ * getopt_long() found an unrecognised short option.
+ * if it was a short option its value is in optopt
+ * if it was a long option then optopt=0
+ */
+ switch (optopt) {
+ case 0:
+ /*printf("?0 unrecognised long option %s\n",argv[optind-1]);*/
+ arg_register_error(endtable, endtable, ARG_ELONGOPT, argv[optind - 1]);
+ break;
+ default:
+ /*printf("?* unrecognised short option '%c'\n",optopt);*/
+ arg_register_error(endtable, endtable, optopt, NULL);
+ break;
+ }
+ break;
+
+ case ':':
+ /*
+ * getopt_long() found an option with its argument missing.
+ */
+ /*printf(": option %s requires an argument\n",argv[optind-1]); */
+ arg_register_error(endtable, endtable, ARG_EMISSARG, argv[optind - 1]);
+ break;
+
+ default: {
+ /* getopt_long() found a valid short option */
+ int tabindex = find_shortoption(table, (char)copt);
+ /*printf("short option detected from argtable[%d]\n", tabindex);*/
+ if (tabindex == -1) {
+ /* should never get here - but handle it just in case */
+ /*printf("unrecognised short option %d\n",copt);*/
+ arg_register_error(endtable, endtable, copt, NULL);
+ } else {
+ if (table[tabindex]->scanfn) {
+ void* parent = table[tabindex]->parent;
+ int errorcode = table[tabindex]->scanfn(parent, optarg);
+ if (errorcode != 0)
+ arg_register_error(endtable, parent, errorcode, optarg);
+ }
+ }
+ break;
+ }
+ }
+ }
+
+ xfree(shortoptions);
+ xfree(longoptions);
+}
+
+static void arg_parse_untagged(int argc, char** argv, struct arg_hdr** table, struct arg_end* endtable) {
+ int tabindex = 0;
+ int errorlast = 0;
+ const char* optarglast = NULL;
+ void* parentlast = NULL;
+
+ /*printf("arg_parse_untagged(%d,%p,%p,%p)\n",argc,argv,table,endtable);*/
+ while (!(table[tabindex]->flag & ARG_TERMINATOR)) {
+ void* parent;
+ int errorcode;
+
+ /* if we have exhausted our argv[optind] entries then we have finished */
+ if (optind >= argc) {
+ /*printf("arg_parse_untagged(): argv[] exhausted\n");*/
+ return;
+ }
+
+ /* skip table entries with non-null long or short options (they are not untagged entries) */
+ if (table[tabindex]->longopts || table[tabindex]->shortopts) {
+ /*printf("arg_parse_untagged(): skipping argtable[%d] (tagged argument)\n",tabindex);*/
+ tabindex++;
+ continue;
+ }
+
+ /* skip table entries with NULL scanfn */
+ if (!(table[tabindex]->scanfn)) {
+ /*printf("arg_parse_untagged(): skipping argtable[%d] (NULL scanfn)\n",tabindex);*/
+ tabindex++;
+ continue;
+ }
+
+ /* attempt to scan the current argv[optind] with the current */
+ /* table[tabindex] entry. If it succeeds then keep it, otherwise */
+ /* try again with the next table[] entry. */
+ parent = table[tabindex]->parent;
+ errorcode = table[tabindex]->scanfn(parent, argv[optind]);
+ if (errorcode == 0) {
+ /* success, move onto next argv[optind] but stay with same table[tabindex] */
+ /*printf("arg_parse_untagged(): argtable[%d] successfully matched\n",tabindex);*/
+ optind++;
+
+ /* clear the last tentative error */
+ errorlast = 0;
+ } else {
+ /* failure, try same argv[optind] with next table[tabindex] entry */
+ /*printf("arg_parse_untagged(): argtable[%d] failed match\n",tabindex);*/
+ tabindex++;
+
+ /* remember this as a tentative error we may wish to reinstate later */
+ errorlast = errorcode;
+ optarglast = argv[optind];
+ parentlast = parent;
+ }
+ }
+
+ /* if a tenative error still remains at this point then register it as a proper error */
+ if (errorlast) {
+ arg_register_error(endtable, parentlast, errorlast, optarglast);
+ optind++;
+ }
+
+ /* only get here when not all argv[] entries were consumed */
+ /* register an error for each unused argv[] entry */
+ while (optind < argc) {
+ /*printf("arg_parse_untagged(): argv[%d]=\"%s\" not consumed\n",optind,argv[optind]);*/
+ arg_register_error(endtable, endtable, ARG_ENOMATCH, argv[optind++]);
+ }
+
+ return;
+}
+
+static void arg_parse_check(struct arg_hdr** table, struct arg_end* endtable) {
+ int tabindex = 0;
+ /* printf("arg_parse_check()\n"); */
+ do {
+ if (table[tabindex]->checkfn) {
+ void* parent = table[tabindex]->parent;
+ int errorcode = table[tabindex]->checkfn(parent);
+ if (errorcode != 0)
+ arg_register_error(endtable, parent, errorcode, NULL);
+ }
+ } while (!(table[tabindex++]->flag & ARG_TERMINATOR));
+}
+
+static void arg_reset(void** argtable) {
+ struct arg_hdr** table = (struct arg_hdr**)argtable;
+ int tabindex = 0;
+ /*printf("arg_reset(%p)\n",argtable);*/
+ do {
+ if (table[tabindex]->resetfn)
+ table[tabindex]->resetfn(table[tabindex]->parent);
+ } while (!(table[tabindex++]->flag & ARG_TERMINATOR));
+}
+
+int arg_parse(int argc, char** argv, void** argtable) {
+ struct arg_hdr** table = (struct arg_hdr**)argtable;
+ struct arg_end* endtable;
+ int endindex;
+ char** argvcopy = NULL;
+ int i;
+
+ /*printf("arg_parse(%d,%p,%p)\n",argc,argv,argtable);*/
+
+ /* reset any argtable data from previous invocations */
+ arg_reset(argtable);
+
+ /* locate the first end-of-table marker within the array */
+ endindex = arg_endindex(table);
+ endtable = (struct arg_end*)table[endindex];
+
+ /* Special case of argc==0. This can occur on Texas Instruments DSP. */
+ /* Failure to trap this case results in an unwanted NULL result from */
+ /* the malloc for argvcopy (next code block). */
+ if (argc == 0) {
+ /* We must still perform post-parse checks despite the absence of command line arguments */
+ arg_parse_check(table, endtable);
+
+ /* Now we are finished */
+ return endtable->count;
+ }
+
+ argvcopy = (char**)xmalloc(sizeof(char*) * (size_t)(argc + 1));
+
+ /*
+ Fill in the local copy of argv[]. We need a local copy
+ because getopt rearranges argv[] which adversely affects
+ susbsequent parsing attempts.
+ */
+ for (i = 0; i < argc; i++)
+ argvcopy[i] = argv[i];
+
+ argvcopy[argc] = NULL;
+
+ /* parse the command line (local copy) for tagged options */
+ arg_parse_tagged(argc, argvcopy, table, endtable);
+
+ /* parse the command line (local copy) for untagged options */
+ arg_parse_untagged(argc, argvcopy, table, endtable);
+
+ /* if no errors so far then perform post-parse checks otherwise dont bother */
+ if (endtable->count == 0)
+ arg_parse_check(table, endtable);
+
+ /* release the local copt of argv[] */
+ xfree(argvcopy);
+
+ return endtable->count;
+}
+
+/*
+ * Concatenate contents of src[] string onto *pdest[] string.
+ * The *pdest pointer is altered to point to the end of the
+ * target string and *pndest is decremented by the same number
+ * of chars.
+ * Does not append more than *pndest chars into *pdest[]
+ * so as to prevent buffer overruns.
+ * Its something like strncat() but more efficient for repeated
+ * calls on the same destination string.
+ * Example of use:
+ * char dest[30] = "good"
+ * size_t ndest = sizeof(dest);
+ * char *pdest = dest;
+ * arg_char(&pdest,"bye ",&ndest);
+ * arg_char(&pdest,"cruel ",&ndest);
+ * arg_char(&pdest,"world!",&ndest);
+ * Results in:
+ * dest[] == "goodbye cruel world!"
+ * ndest == 10
+ */
+static void arg_cat(char** pdest, const char* src, size_t* pndest) {
+ char* dest = *pdest;
+ char* end = dest + *pndest;
+
+ /*locate null terminator of dest string */
+ while (dest < end-1 && *dest != 0)
+ dest++;
+
+ /* concat src string to dest string */
+ while (dest < end-1 && *src != 0)
+ *dest++ = *src++;
+
+ /* null terminate dest string */
+ *dest = 0;
+
+ /* update *pdest and *pndest */
+ *pndest = (size_t)(end - dest);
+ *pdest = dest;
+}
+
+static void arg_cat_option(char* dest, size_t ndest, const char* shortopts, const char* longopts, const char* datatype, int optvalue) {
+ if (shortopts) {
+ char option[3];
+
+ /* note: option array[] is initialiazed dynamically here to satisfy */
+ /* a deficiency in the watcom compiler wrt static array initializers. */
+ option[0] = '-';
+ option[1] = shortopts[0];
+ option[2] = 0;
+
+ arg_cat(&dest, option, &ndest);
+ if (datatype) {
+ arg_cat(&dest, " ", &ndest);
+ if (optvalue) {
+ arg_cat(&dest, "[", &ndest);
+ arg_cat(&dest, datatype, &ndest);
+ arg_cat(&dest, "]", &ndest);
+ } else
+ arg_cat(&dest, datatype, &ndest);
+ }
+ } else if (longopts) {
+ size_t ncspn;
+
+ /* add "--" tag prefix */
+ arg_cat(&dest, "--", &ndest);
+
+ /* add comma separated option tag */
+ ncspn = strcspn(longopts, ",");
+#if (defined(__STDC_LIB_EXT1__) && defined(__STDC_WANT_LIB_EXT1__)) || (defined(__STDC_SECURE_LIB__) && defined(__STDC_WANT_SECURE_LIB__))
+ strncat_s(dest, ndest, longopts, (ncspn < ndest) ? ncspn : ndest);
+#else
+ strncat(dest, longopts, (ncspn < ndest) ? ncspn : ndest);
+#endif
+
+ if (datatype) {
+ arg_cat(&dest, "=", &ndest);
+ if (optvalue) {
+ arg_cat(&dest, "[", &ndest);
+ arg_cat(&dest, datatype, &ndest);
+ arg_cat(&dest, "]", &ndest);
+ } else
+ arg_cat(&dest, datatype, &ndest);
+ }
+ } else if (datatype) {
+ if (optvalue) {
+ arg_cat(&dest, "[", &ndest);
+ arg_cat(&dest, datatype, &ndest);
+ arg_cat(&dest, "]", &ndest);
+ } else
+ arg_cat(&dest, datatype, &ndest);
+ }
+}
+
+static void arg_cat_optionv(char* dest, size_t ndest, const char* shortopts, const char* longopts, const char* datatype, int optvalue, const char* separator) {
+ separator = separator ? separator : "";
+
+ if (shortopts) {
+ const char* c = shortopts;
+ while (*c) {
+ /* "-a|-b|-c" */
+ char shortopt[3];
+
+ /* note: shortopt array[] is initialiazed dynamically here to satisfy */
+ /* a deficiency in the watcom compiler wrt static array initializers. */
+ shortopt[0] = '-';
+ shortopt[1] = *c;
+ shortopt[2] = 0;
+
+ arg_cat(&dest, shortopt, &ndest);
+ if (*++c)
+ arg_cat(&dest, separator, &ndest);
+ }
+ }
+
+ /* put separator between long opts and short opts */
+ if (shortopts && longopts)
+ arg_cat(&dest, separator, &ndest);
+
+ if (longopts) {
+ const char* c = longopts;
+ while (*c) {
+ size_t ncspn;
+
+ /* add "--" tag prefix */
+ arg_cat(&dest, "--", &ndest);
+
+ /* add comma separated option tag */
+ ncspn = strcspn(c, ",");
+#if (defined(__STDC_LIB_EXT1__) && defined(__STDC_WANT_LIB_EXT1__)) || (defined(__STDC_SECURE_LIB__) && defined(__STDC_WANT_SECURE_LIB__))
+ strncat_s(dest, ndest, c, (ncspn < ndest) ? ncspn : ndest);
+#else
+ strncat(dest, c, (ncspn < ndest) ? ncspn : ndest);
+#endif
+ c += ncspn;
+
+ /* add given separator in place of comma */
+ if (*c == ',') {
+ arg_cat(&dest, separator, &ndest);
+ c++;
+ }
+ }
+ }
+
+ if (datatype) {
+ if (longopts)
+ arg_cat(&dest, "=", &ndest);
+ else if (shortopts)
+ arg_cat(&dest, " ", &ndest);
+
+ if (optvalue) {
+ arg_cat(&dest, "[", &ndest);
+ arg_cat(&dest, datatype, &ndest);
+ arg_cat(&dest, "]", &ndest);
+ } else
+ arg_cat(&dest, datatype, &ndest);
+ }
+}
+
+void arg_print_option_ds(arg_dstr_t ds, const char* shortopts, const char* longopts, const char* datatype, const char* suffix) {
+ char syntax[200] = "";
+ suffix = suffix ? suffix : "";
+
+ /* there is no way of passing the proper optvalue for optional argument values here, so we must ignore it */
+ arg_cat_optionv(syntax, sizeof(syntax) - 1, shortopts, longopts, datatype, 0, "|");
+
+ arg_dstr_cat(ds, syntax);
+ arg_dstr_cat(ds, (char*)suffix);
+}
+
+/* this function should be deprecated because it doesn't consider optional argument values (ARG_HASOPTVALUE) */
+void arg_print_option(FILE* fp, const char* shortopts, const char* longopts, const char* datatype, const char* suffix) {
+ arg_dstr_t ds = arg_dstr_create();
+ arg_print_option_ds(ds, shortopts, longopts, datatype, suffix);
+ fputs(arg_dstr_cstr(ds), fp);
+ arg_dstr_destroy(ds);
+}
+
+/*
+ * Print a GNU style [OPTION] string in which all short options that
+ * do not take argument values are presented in abbreviated form, as
+ * in: -xvfsd, or -xvf[sd], or [-xvsfd]
+ */
+static void arg_print_gnuswitch_ds(arg_dstr_t ds, struct arg_hdr** table) {
+ int tabindex;
+ const char* format1 = " -%c";
+ const char* format2 = " [-%c";
+ const char* suffix = "";
+
+ /* print all mandatory switches that are without argument values */
+ for (tabindex = 0; table[tabindex] && !(table[tabindex]->flag & ARG_TERMINATOR); tabindex++) {
+ /* skip optional options */
+ if (table[tabindex]->mincount < 1)
+ continue;
+
+ /* skip non-short options */
+ if (table[tabindex]->shortopts == NULL)
+ continue;
+
+ /* skip options that take argument values */
+ if (table[tabindex]->flag & ARG_HASVALUE)
+ continue;
+
+ /* print the short option (only the first short option char, ignore multiple choices)*/
+ arg_dstr_catf(ds, format1, table[tabindex]->shortopts[0]);
+ format1 = "%c";
+ format2 = "[%c";
+ }
+
+ /* print all optional switches that are without argument values */
+ for (tabindex = 0; table[tabindex] && !(table[tabindex]->flag & ARG_TERMINATOR); tabindex++) {
+ /* skip mandatory args */
+ if (table[tabindex]->mincount > 0)
+ continue;
+
+ /* skip args without short options */
+ if (table[tabindex]->shortopts == NULL)
+ continue;
+
+ /* skip args with values */
+ if (table[tabindex]->flag & ARG_HASVALUE)
+ continue;
+
+ /* print first short option */
+ arg_dstr_catf(ds, format2, table[tabindex]->shortopts[0]);
+ format2 = "%c";
+ suffix = "]";
+ }
+
+ arg_dstr_catf(ds, "%s", suffix);
+}
+
+void arg_print_syntax_ds(arg_dstr_t ds, void** argtable, const char* suffix) {
+ struct arg_hdr** table = (struct arg_hdr**)argtable;
+ int i, tabindex;
+
+ /* print GNU style [OPTION] string */
+ arg_print_gnuswitch_ds(ds, table);
+
+ /* print remaining options in abbreviated style */
+ for (tabindex = 0; table[tabindex] && !(table[tabindex]->flag & ARG_TERMINATOR); tabindex++) {
+ char syntax[200] = "";
+ const char *shortopts, *longopts, *datatype;
+
+ /* skip short options without arg values (they were printed by arg_print_gnu_switch) */
+ if (table[tabindex]->shortopts && !(table[tabindex]->flag & ARG_HASVALUE))
+ continue;
+
+ shortopts = table[tabindex]->shortopts;
+ longopts = table[tabindex]->longopts;
+ datatype = table[tabindex]->datatype;
+ arg_cat_option(syntax, sizeof(syntax) - 1, shortopts, longopts, datatype, table[tabindex]->flag & ARG_HASOPTVALUE);
+
+ if (strlen(syntax) > 0) {
+ /* print mandatory instances of this option */
+ for (i = 0; i < table[tabindex]->mincount; i++) {
+ arg_dstr_cat(ds, " ");
+ arg_dstr_cat(ds, syntax);
+ }
+
+ /* print optional instances enclosed in "[..]" */
+ switch (table[tabindex]->maxcount - table[tabindex]->mincount) {
+ case 0:
+ break;
+ case 1:
+ arg_dstr_cat(ds, " [");
+ arg_dstr_cat(ds, syntax);
+ arg_dstr_cat(ds, "]");
+ break;
+ case 2:
+ arg_dstr_cat(ds, " [");
+ arg_dstr_cat(ds, syntax);
+ arg_dstr_cat(ds, "]");
+ arg_dstr_cat(ds, " [");
+ arg_dstr_cat(ds, syntax);
+ arg_dstr_cat(ds, "]");
+ break;
+ default:
+ arg_dstr_cat(ds, " [");
+ arg_dstr_cat(ds, syntax);
+ arg_dstr_cat(ds, "]...");
+ break;
+ }
+ }
+ }
+
+ if (suffix) {
+ arg_dstr_cat(ds, (char*)suffix);
+ }
+}
+
+void arg_print_syntax(FILE* fp, void** argtable, const char* suffix) {
+ arg_dstr_t ds = arg_dstr_create();
+ arg_print_syntax_ds(ds, argtable, suffix);
+ fputs(arg_dstr_cstr(ds), fp);
+ arg_dstr_destroy(ds);
+}
+
+void arg_print_syntaxv_ds(arg_dstr_t ds, void** argtable, const char* suffix) {
+ struct arg_hdr** table = (struct arg_hdr**)argtable;
+ int i, tabindex;
+
+ /* print remaining options in abbreviated style */
+ for (tabindex = 0; table[tabindex] && !(table[tabindex]->flag & ARG_TERMINATOR); tabindex++) {
+ char syntax[200] = "";
+ const char *shortopts, *longopts, *datatype;
+
+ shortopts = table[tabindex]->shortopts;
+ longopts = table[tabindex]->longopts;
+ datatype = table[tabindex]->datatype;
+ arg_cat_optionv(syntax, sizeof(syntax) - 1, shortopts, longopts, datatype, table[tabindex]->flag & ARG_HASOPTVALUE, "|");
+
+ /* print mandatory options */
+ for (i = 0; i < table[tabindex]->mincount; i++) {
+ arg_dstr_cat(ds, " ");
+ arg_dstr_cat(ds, syntax);
+ }
+
+ /* print optional args enclosed in "[..]" */
+ switch (table[tabindex]->maxcount - table[tabindex]->mincount) {
+ case 0:
+ break;
+ case 1:
+ arg_dstr_cat(ds, " [");
+ arg_dstr_cat(ds, syntax);
+ arg_dstr_cat(ds, "]");
+ break;
+ case 2:
+ arg_dstr_cat(ds, " [");
+ arg_dstr_cat(ds, syntax);
+ arg_dstr_cat(ds, "]");
+ arg_dstr_cat(ds, " [");
+ arg_dstr_cat(ds, syntax);
+ arg_dstr_cat(ds, "]");
+ break;
+ default:
+ arg_dstr_cat(ds, " [");
+ arg_dstr_cat(ds, syntax);
+ arg_dstr_cat(ds, "]...");
+ break;
+ }
+ }
+
+ if (suffix) {
+ arg_dstr_cat(ds, (char*)suffix);
+ }
+}
+
+void arg_print_syntaxv(FILE* fp, void** argtable, const char* suffix) {
+ arg_dstr_t ds = arg_dstr_create();
+ arg_print_syntaxv_ds(ds, argtable, suffix);
+ fputs(arg_dstr_cstr(ds), fp);
+ arg_dstr_destroy(ds);
+}
+
+void arg_print_glossary_ds(arg_dstr_t ds, void** argtable, const char* format) {
+ struct arg_hdr** table = (struct arg_hdr**)argtable;
+ int tabindex;
+
+ format = format ? format : " %-20s %s\n";
+ for (tabindex = 0; !(table[tabindex]->flag & ARG_TERMINATOR); tabindex++) {
+ if (table[tabindex]->glossary) {
+ char syntax[200] = "";
+ const char* shortopts = table[tabindex]->shortopts;
+ const char* longopts = table[tabindex]->longopts;
+ const char* datatype = table[tabindex]->datatype;
+ const char* glossary = table[tabindex]->glossary;
+ arg_cat_optionv(syntax, sizeof(syntax) - 1, shortopts, longopts, datatype, table[tabindex]->flag & ARG_HASOPTVALUE, ", ");
+ arg_dstr_catf(ds, format, syntax, glossary);
+ }
+ }
+}
+
+void arg_print_glossary(FILE* fp, void** argtable, const char* format) {
+ arg_dstr_t ds = arg_dstr_create();
+ arg_print_glossary_ds(ds, argtable, format);
+ fputs(arg_dstr_cstr(ds), fp);
+ arg_dstr_destroy(ds);
+}
+
+/**
+ * Print a piece of text formatted, which means in a column with a
+ * left and a right margin. The lines are wrapped at whitspaces next
+ * to right margin. The function does not indent the first line, but
+ * only the following ones.
+ *
+ * See description of arg_print_formatted below.
+ */
+static void arg_print_formatted_ds(arg_dstr_t ds, const unsigned lmargin, const unsigned rmargin, const char* text) {
+ const unsigned int textlen = (unsigned int)strlen(text);
+ unsigned int line_start = 0;
+ unsigned int line_end = textlen;
+ const unsigned int colwidth = (rmargin - lmargin) + 1;
+
+ assert(strlen(text) < UINT_MAX);
+
+ /* Someone doesn't like us... */
+ if (line_end < line_start) {
+ arg_dstr_catf(ds, "%s\n", text);
+ }
+
+ while (line_end > line_start) {
+ /* Eat leading white spaces. This is essential because while
+ wrapping lines, there will often be a whitespace at beginning
+ of line. Preserve newlines */
+ while (isspace((int)(*(text + line_start))) && *(text + line_start) != '\n') {
+ line_start++;
+ }
+
+ /* Find last whitespace, that fits into line */
+ if (line_end - line_start > colwidth) {
+ line_end = line_start + colwidth;
+
+ while ((line_end > line_start) && !isspace((int)(*(text + line_end)))) {
+ line_end--;
+ }
+
+ /* If no whitespace could be found, eg. the text is one long word, break the word */
+ if (line_end == line_start) {
+ /* Set line_end to previous value */
+ line_end = line_start + colwidth;
+ } else {
+ /* Consume trailing spaces, except newlines */
+ while ((line_end > line_start) && isspace((int)(*(text + line_end))) && *(text + line_start) != '\n') {
+ line_end--;
+ }
+
+ /* Restore the last non-space character */
+ line_end++;
+ }
+ }
+
+ /* Output line of text */
+ while (line_start < line_end) {
+ char c = *(text + line_start);
+
+ /* If character is newline stop printing, skip this character, as a newline will be printed below. */
+ if (c == '\n') {
+ line_start++;
+ break;
+ }
+
+ arg_dstr_catc(ds, c);
+ line_start++;
+ }
+ arg_dstr_cat(ds, "\n");
+
+ /* Initialize another line */
+ if (line_end < textlen) {
+ unsigned i;
+
+ for (i = 0; i < lmargin; i++) {
+ arg_dstr_cat(ds, " ");
+ }
+
+ line_end = textlen;
+ }
+ } /* lines of text */
+}
+
+/**
+ * Print a piece of text formatted, which means in a column with a
+ * left and a right margin. The lines are wrapped at whitspaces next
+ * to right margin. The function does not indent the first line, but
+ * only the following ones.
+ *
+ * Example:
+ * arg_print_formatted( fp, 0, 5, "Some text that doesn't fit." )
+ * will result in the following output:
+ *
+ * Some
+ * text
+ * that
+ * doesn'
+ * t fit.
+ *
+ * Too long lines will be wrapped in the middle of a word.
+ *
+ * arg_print_formatted( fp, 2, 7, "Some text that doesn't fit." )
+ * will result in the following output:
+ *
+ * Some
+ * text
+ * that
+ * doesn'
+ * t fit.
+ *
+ * As you see, the first line is not indented. This enables output of
+ * lines, which start in a line where output already happened.
+ *
+ * Author: Uli Fouquet
+ */
+void arg_print_formatted(FILE* fp, const unsigned lmargin, const unsigned rmargin, const char* text) {
+ arg_dstr_t ds = arg_dstr_create();
+ arg_print_formatted_ds(ds, lmargin, rmargin, text);
+ fputs(arg_dstr_cstr(ds), fp);
+ arg_dstr_destroy(ds);
+}
+
+/**
+ * Prints the glossary in strict GNU format.
+ * Differences to arg_print_glossary() are:
+ * - wraps lines after 80 chars
+ * - indents lines without shortops
+ * - does not accept formatstrings
+ *
+ * Contributed by Uli Fouquet
+ */
+void arg_print_glossary_gnu_ds(arg_dstr_t ds, void** argtable) {
+ struct arg_hdr** table = (struct arg_hdr**)argtable;
+ int tabindex;
+
+ for (tabindex = 0; !(table[tabindex]->flag & ARG_TERMINATOR); tabindex++) {
+ if (table[tabindex]->glossary) {
+ char syntax[200] = "";
+ const char* shortopts = table[tabindex]->shortopts;
+ const char* longopts = table[tabindex]->longopts;
+ const char* datatype = table[tabindex]->datatype;
+ const char* glossary = table[tabindex]->glossary;
+
+ if (!shortopts && longopts) {
+ /* Indent trailing line by 4 spaces... */
+ memset(syntax, ' ', 4);
+ *(syntax + 4) = '\0';
+ }
+
+ arg_cat_optionv(syntax, sizeof(syntax) - 1, shortopts, longopts, datatype, table[tabindex]->flag & ARG_HASOPTVALUE, ", ");
+
+ /* If syntax fits not into column, print glossary in new line... */
+ if (strlen(syntax) > 25) {
+ arg_dstr_catf(ds, " %-25s %s\n", syntax, "");
+ *syntax = '\0';
+ }
+
+ arg_dstr_catf(ds, " %-25s ", syntax);
+ arg_print_formatted_ds(ds, 28, 79, glossary);
+ }
+ } /* for each table entry */
+
+ arg_dstr_cat(ds, "\n");
+}
+
+void arg_print_glossary_gnu(FILE* fp, void** argtable) {
+ arg_dstr_t ds = arg_dstr_create();
+ arg_print_glossary_gnu_ds(ds, argtable);
+ fputs(arg_dstr_cstr(ds), fp);
+ arg_dstr_destroy(ds);
+}
+
+/**
+ * Checks the argtable[] array for NULL entries and returns 1
+ * if any are found, zero otherwise.
+ */
+int arg_nullcheck(void** argtable) {
+ struct arg_hdr** table = (struct arg_hdr**)argtable;
+ int tabindex;
+ /*printf("arg_nullcheck(%p)\n",argtable);*/
+
+ if (!table)
+ return 1;
+
+ tabindex = 0;
+ do {
+ /*printf("argtable[%d]=%p\n",tabindex,argtable[tabindex]);*/
+ if (!table[tabindex])
+ return 1;
+ } while (!(table[tabindex++]->flag & ARG_TERMINATOR));
+
+ return 0;
+}
+
+/*
+ * arg_free() is deprecated in favour of arg_freetable() due to a flaw in its design.
+ * The flaw results in memory leak in the (very rare) case that an intermediate
+ * entry in the argtable array failed its memory allocation while others following
+ * that entry were still allocated ok. Those subsequent allocations will not be
+ * deallocated by arg_free().
+ * Despite the unlikeliness of the problem occurring, and the even unlikelier event
+ * that it has any deliterious effect, it is fixed regardless by replacing arg_free()
+ * with the newer arg_freetable() function.
+ * We still keep arg_free() for backwards compatibility.
+ */
+void arg_free(void** argtable) {
+ struct arg_hdr** table = (struct arg_hdr**)argtable;
+ int tabindex = 0;
+ int flag;
+ /*printf("arg_free(%p)\n",argtable);*/
+ do {
+ /*
+ if we encounter a NULL entry then somewhat incorrectly we presume
+ we have come to the end of the array. It isnt strictly true because
+ an intermediate entry could be NULL with other non-NULL entries to follow.
+ The subsequent argtable entries would then not be freed as they should.
+ */
+ if (table[tabindex] == NULL)
+ break;
+
+ flag = table[tabindex]->flag;
+ xfree(table[tabindex]);
+ table[tabindex++] = NULL;
+
+ } while (!(flag & ARG_TERMINATOR));
+}
+
+/* frees each non-NULL element of argtable[], where n is the size of the number of entries in the array */
+void arg_freetable(void** argtable, size_t n) {
+ struct arg_hdr** table = (struct arg_hdr**)argtable;
+ size_t tabindex = 0;
+ /*printf("arg_freetable(%p)\n",argtable);*/
+ for (tabindex = 0; tabindex < n; tabindex++) {
+ if (table[tabindex] == NULL)
+ continue;
+
+ xfree(table[tabindex]);
+ table[tabindex] = NULL;
+ };
+}
+
+#ifdef _WIN32
+BOOL WINAPI DllMain(HINSTANCE hinstDLL, DWORD fdwReason, LPVOID lpvReserved) {
+ return TRUE;
+ UNREFERENCED_PARAMETER(hinstDLL);
+ UNREFERENCED_PARAMETER(fdwReason);
+ UNREFERENCED_PARAMETER(lpvReserved);
+}
+#endif
diff --git a/lib/console/argtable3/argtable3.h b/lib/console/argtable3/argtable3.h
new file mode 100644
index 00000000..95715b19
--- /dev/null
+++ b/lib/console/argtable3/argtable3.h
@@ -0,0 +1,279 @@
+/*
+ * SPDX-FileCopyrightText: 1998-2001,2003-2011,2013 Stewart Heitmann
+ *
+ * SPDX-License-Identifier: BSD-3-Clause
+ */
+/*******************************************************************************
+ * argtable3: Declares the main interfaces of the library
+ *
+ * This file is part of the argtable3 library.
+ *
+ * Copyright (C) 1998-2001,2003-2011,2013 Stewart Heitmann
+ * <sheitmann@users.sourceforge.net>
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ * * Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ * * Redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in the
+ * documentation and/or other materials provided with the distribution.
+ * * Neither the name of STEWART HEITMANN nor the names of its contributors
+ * may be used to endorse or promote products derived from this software
+ * without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL STEWART HEITMANN BE LIABLE FOR ANY DIRECT,
+ * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ ******************************************************************************/
+
+#ifndef ARGTABLE3
+#define ARGTABLE3
+
+#include <stdio.h> /* FILE */
+#include <time.h> /* struct tm */
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+#define ARG_REX_ICASE 1
+#define ARG_DSTR_SIZE 200
+#define ARG_CMD_NAME_LEN 100
+#define ARG_CMD_DESCRIPTION_LEN 256
+
+#ifndef ARG_REPLACE_GETOPT
+#define ARG_REPLACE_GETOPT 0 /* ESP-IDF-specific: use newlib-provided getopt instead of the embedded one */
+#endif /* ARG_REPLACE_GETOPT */
+
+/* bit masks for arg_hdr.flag */
+enum { ARG_TERMINATOR = 0x1, ARG_HASVALUE = 0x2, ARG_HASOPTVALUE = 0x4 };
+
+#if defined(_WIN32)
+ #if defined(argtable3_EXPORTS)
+ #define ARG_EXTERN __declspec(dllexport)
+ #elif defined(argtable3_IMPORTS)
+ #define ARG_EXTERN __declspec(dllimport)
+ #else
+ #define ARG_EXTERN
+ #endif
+#else
+ #define ARG_EXTERN
+#endif
+
+typedef struct _internal_arg_dstr* arg_dstr_t;
+typedef void* arg_cmd_itr_t;
+
+typedef void(arg_resetfn)(void* parent);
+typedef int(arg_scanfn)(void* parent, const char* argval);
+typedef int(arg_checkfn)(void* parent);
+typedef void(arg_errorfn)(void* parent, arg_dstr_t ds, int error, const char* argval, const char* progname);
+typedef void(arg_dstr_freefn)(char* buf);
+typedef int(arg_cmdfn)(int argc, char* argv[], arg_dstr_t res);
+typedef int(arg_comparefn)(const void* k1, const void* k2);
+
+/*
+ * The arg_hdr struct defines properties that are common to all arg_xxx structs.
+ * The argtable library requires each arg_xxx struct to have an arg_hdr
+ * struct as its first data member.
+ * The argtable library functions then use this data to identify the
+ * properties of the command line option, such as its option tags,
+ * datatype string, and glossary strings, and so on.
+ * Moreover, the arg_hdr struct contains pointers to custom functions that
+ * are provided by each arg_xxx struct which perform the tasks of parsing
+ * that particular arg_xxx arguments, performing post-parse checks, and
+ * reporting errors.
+ * These functions are private to the individual arg_xxx source code
+ * and are the pointer to them are initiliased by that arg_xxx struct's
+ * constructor function. The user could alter them after construction
+ * if desired, but the original intention is for them to be set by the
+ * constructor and left unaltered.
+ */
+typedef struct arg_hdr {
+ char flag; /* Modifier flags: ARG_TERMINATOR, ARG_HASVALUE. */
+ const char* shortopts; /* String defining the short options */
+ const char* longopts; /* String defiing the long options */
+ const char* datatype; /* Description of the argument data type */
+ const char* glossary; /* Description of the option as shown by arg_print_glossary function */
+ int mincount; /* Minimum number of occurences of this option accepted */
+ int maxcount; /* Maximum number of occurences if this option accepted */
+ void* parent; /* Pointer to parent arg_xxx struct */
+ arg_resetfn* resetfn; /* Pointer to parent arg_xxx reset function */
+ arg_scanfn* scanfn; /* Pointer to parent arg_xxx scan function */
+ arg_checkfn* checkfn; /* Pointer to parent arg_xxx check function */
+ arg_errorfn* errorfn; /* Pointer to parent arg_xxx error function */
+ void* priv; /* Pointer to private header data for use by arg_xxx functions */
+} arg_hdr_t;
+
+typedef struct arg_rem {
+ struct arg_hdr hdr; /* The mandatory argtable header struct */
+} arg_rem_t;
+
+typedef struct arg_lit {
+ struct arg_hdr hdr; /* The mandatory argtable header struct */
+ int count; /* Number of matching command line args */
+} arg_lit_t;
+
+typedef struct arg_int {
+ struct arg_hdr hdr; /* The mandatory argtable header struct */
+ int count; /* Number of matching command line args */
+ int* ival; /* Array of parsed argument values */
+} arg_int_t;
+
+typedef struct arg_dbl {
+ struct arg_hdr hdr; /* The mandatory argtable header struct */
+ int count; /* Number of matching command line args */
+ double* dval; /* Array of parsed argument values */
+} arg_dbl_t;
+
+typedef struct arg_str {
+ struct arg_hdr hdr; /* The mandatory argtable header struct */
+ int count; /* Number of matching command line args */
+ const char** sval; /* Array of parsed argument values */
+} arg_str_t;
+
+typedef struct arg_rex {
+ struct arg_hdr hdr; /* The mandatory argtable header struct */
+ int count; /* Number of matching command line args */
+ const char** sval; /* Array of parsed argument values */
+} arg_rex_t;
+
+typedef struct arg_file {
+ struct arg_hdr hdr; /* The mandatory argtable header struct */
+ int count; /* Number of matching command line args*/
+ const char** filename; /* Array of parsed filenames (eg: /home/foo.bar) */
+ const char** basename; /* Array of parsed basenames (eg: foo.bar) */
+ const char** extension; /* Array of parsed extensions (eg: .bar) */
+} arg_file_t;
+
+typedef struct arg_date {
+ struct arg_hdr hdr; /* The mandatory argtable header struct */
+ const char* format; /* strptime format string used to parse the date */
+ int count; /* Number of matching command line args */
+ struct tm* tmval; /* Array of parsed time values */
+} arg_date_t;
+
+enum { ARG_ELIMIT = 1, ARG_EMALLOC, ARG_ENOMATCH, ARG_ELONGOPT, ARG_EMISSARG };
+typedef struct arg_end {
+ struct arg_hdr hdr; /* The mandatory argtable header struct */
+ int count; /* Number of errors encountered */
+ int* error; /* Array of error codes */
+ void** parent; /* Array of pointers to offending arg_xxx struct */
+ const char** argval; /* Array of pointers to offending argv[] string */
+} arg_end_t;
+
+typedef struct arg_cmd_info {
+ char name[ARG_CMD_NAME_LEN];
+ char description[ARG_CMD_DESCRIPTION_LEN];
+ arg_cmdfn* proc;
+} arg_cmd_info_t;
+
+/**** arg_xxx constructor functions *********************************/
+
+ARG_EXTERN struct arg_rem* arg_rem(const char* datatype, const char* glossary);
+
+ARG_EXTERN struct arg_lit* arg_lit0(const char* shortopts, const char* longopts, const char* glossary);
+ARG_EXTERN struct arg_lit* arg_lit1(const char* shortopts, const char* longopts, const char* glossary);
+ARG_EXTERN struct arg_lit* arg_litn(const char* shortopts, const char* longopts, int mincount, int maxcount, const char* glossary);
+
+ARG_EXTERN struct arg_int* arg_int0(const char* shortopts, const char* longopts, const char* datatype, const char* glossary);
+ARG_EXTERN struct arg_int* arg_int1(const char* shortopts, const char* longopts, const char* datatype, const char* glossary);
+ARG_EXTERN struct arg_int* arg_intn(const char* shortopts, const char* longopts, const char* datatype, int mincount, int maxcount, const char* glossary);
+
+ARG_EXTERN struct arg_dbl* arg_dbl0(const char* shortopts, const char* longopts, const char* datatype, const char* glossary);
+ARG_EXTERN struct arg_dbl* arg_dbl1(const char* shortopts, const char* longopts, const char* datatype, const char* glossary);
+ARG_EXTERN struct arg_dbl* arg_dbln(const char* shortopts, const char* longopts, const char* datatype, int mincount, int maxcount, const char* glossary);
+
+ARG_EXTERN struct arg_str* arg_str0(const char* shortopts, const char* longopts, const char* datatype, const char* glossary);
+ARG_EXTERN struct arg_str* arg_str1(const char* shortopts, const char* longopts, const char* datatype, const char* glossary);
+ARG_EXTERN struct arg_str* arg_strn(const char* shortopts, const char* longopts, const char* datatype, int mincount, int maxcount, const char* glossary);
+
+ARG_EXTERN struct arg_rex* arg_rex0(const char* shortopts, const char* longopts, const char* pattern, const char* datatype, int flags, const char* glossary);
+ARG_EXTERN struct arg_rex* arg_rex1(const char* shortopts, const char* longopts, const char* pattern, const char* datatype, int flags, const char* glossary);
+ARG_EXTERN struct arg_rex* arg_rexn(const char* shortopts,
+ const char* longopts,
+ const char* pattern,
+ const char* datatype,
+ int mincount,
+ int maxcount,
+ int flags,
+ const char* glossary);
+
+ARG_EXTERN struct arg_file* arg_file0(const char* shortopts, const char* longopts, const char* datatype, const char* glossary);
+ARG_EXTERN struct arg_file* arg_file1(const char* shortopts, const char* longopts, const char* datatype, const char* glossary);
+ARG_EXTERN struct arg_file* arg_filen(const char* shortopts, const char* longopts, const char* datatype, int mincount, int maxcount, const char* glossary);
+
+ARG_EXTERN struct arg_date* arg_date0(const char* shortopts, const char* longopts, const char* format, const char* datatype, const char* glossary);
+ARG_EXTERN struct arg_date* arg_date1(const char* shortopts, const char* longopts, const char* format, const char* datatype, const char* glossary);
+ARG_EXTERN struct arg_date* arg_daten(const char* shortopts, const char* longopts, const char* format, const char* datatype, int mincount, int maxcount, const char* glossary);
+
+ARG_EXTERN struct arg_end* arg_end(int maxcount);
+
+#define ARG_DSTR_STATIC ((arg_dstr_freefn*)0)
+#define ARG_DSTR_VOLATILE ((arg_dstr_freefn*)1)
+#define ARG_DSTR_DYNAMIC ((arg_dstr_freefn*)3)
+
+/**** other functions *******************************************/
+ARG_EXTERN int arg_nullcheck(void** argtable);
+ARG_EXTERN int arg_parse(int argc, char** argv, void** argtable);
+ARG_EXTERN void arg_print_option(FILE* fp, const char* shortopts, const char* longopts, const char* datatype, const char* suffix);
+ARG_EXTERN void arg_print_syntax(FILE* fp, void** argtable, const char* suffix);
+ARG_EXTERN void arg_print_syntaxv(FILE* fp, void** argtable, const char* suffix);
+ARG_EXTERN void arg_print_glossary(FILE* fp, void** argtable, const char* format);
+ARG_EXTERN void arg_print_glossary_gnu(FILE* fp, void** argtable);
+ARG_EXTERN void arg_print_formatted(FILE *fp, const unsigned lmargin, const unsigned rmargin, const char *text);
+ARG_EXTERN void arg_print_errors(FILE* fp, struct arg_end* end, const char* progname);
+ARG_EXTERN void arg_print_option_ds(arg_dstr_t ds, const char* shortopts, const char* longopts, const char* datatype, const char* suffix);
+ARG_EXTERN void arg_print_syntax_ds(arg_dstr_t ds, void** argtable, const char* suffix);
+ARG_EXTERN void arg_print_syntaxv_ds(arg_dstr_t ds, void** argtable, const char* suffix);
+ARG_EXTERN void arg_print_glossary_ds(arg_dstr_t ds, void** argtable, const char* format);
+ARG_EXTERN void arg_print_glossary_gnu_ds(arg_dstr_t ds, void** argtable);
+ARG_EXTERN void arg_print_errors_ds(arg_dstr_t ds, struct arg_end* end, const char* progname);
+ARG_EXTERN void arg_freetable(void** argtable, size_t n);
+
+ARG_EXTERN arg_dstr_t arg_dstr_create(void);
+ARG_EXTERN void arg_dstr_destroy(arg_dstr_t ds);
+ARG_EXTERN void arg_dstr_reset(arg_dstr_t ds);
+ARG_EXTERN void arg_dstr_free(arg_dstr_t ds);
+ARG_EXTERN void arg_dstr_set(arg_dstr_t ds, char* str, arg_dstr_freefn* free_proc);
+ARG_EXTERN void arg_dstr_cat(arg_dstr_t ds, const char* str);
+ARG_EXTERN void arg_dstr_catc(arg_dstr_t ds, char c);
+ARG_EXTERN void arg_dstr_catf(arg_dstr_t ds, const char* fmt, ...);
+ARG_EXTERN char* arg_dstr_cstr(arg_dstr_t ds);
+
+ARG_EXTERN void arg_cmd_init(void);
+ARG_EXTERN void arg_cmd_uninit(void);
+ARG_EXTERN void arg_cmd_register(const char* name, arg_cmdfn* proc, const char* description);
+ARG_EXTERN void arg_cmd_unregister(const char* name);
+ARG_EXTERN int arg_cmd_dispatch(const char* name, int argc, char* argv[], arg_dstr_t res);
+ARG_EXTERN unsigned int arg_cmd_count(void);
+ARG_EXTERN arg_cmd_info_t* arg_cmd_info(const char* name);
+ARG_EXTERN arg_cmd_itr_t arg_cmd_itr_create(void);
+ARG_EXTERN void arg_cmd_itr_destroy(arg_cmd_itr_t itr);
+ARG_EXTERN int arg_cmd_itr_advance(arg_cmd_itr_t itr);
+ARG_EXTERN char* arg_cmd_itr_key(arg_cmd_itr_t itr);
+ARG_EXTERN arg_cmd_info_t* arg_cmd_itr_value(arg_cmd_itr_t itr);
+ARG_EXTERN int arg_cmd_itr_search(arg_cmd_itr_t itr, void* k);
+ARG_EXTERN void arg_mgsort(void* data, int size, int esize, int i, int k, arg_comparefn* comparefn);
+ARG_EXTERN void arg_make_get_help_msg(arg_dstr_t res);
+ARG_EXTERN void arg_make_help_msg(arg_dstr_t ds, char* cmd_name, void** argtable);
+ARG_EXTERN void arg_make_syntax_err_msg(arg_dstr_t ds, void** argtable, struct arg_end* end);
+ARG_EXTERN int arg_make_syntax_err_help_msg(arg_dstr_t ds, char* name, int help, int nerrors, void** argtable, struct arg_end* end, int* exitcode);
+ARG_EXTERN void arg_set_module_name(const char* name);
+ARG_EXTERN void arg_set_module_version(int major, int minor, int patch, const char* tag);
+
+/**** deprecated functions, for back-compatibility only ********/
+ARG_EXTERN void arg_free(void** argtable);
+
+#ifdef __cplusplus
+}
+#endif
+#endif
diff --git a/lib/console/argtable3/argtable3_private.h b/lib/console/argtable3/argtable3_private.h
new file mode 100644
index 00000000..5589fc7f
--- /dev/null
+++ b/lib/console/argtable3/argtable3_private.h
@@ -0,0 +1,245 @@
+/*
+ * SPDX-FileCopyrightText: 2013-2019 Tom G. Huang
+ *
+ * SPDX-License-Identifier: BSD-3-Clause
+ */
+/*******************************************************************************
+ * argtable3_private: Declares private types, constants, and interfaces
+ *
+ * This file is part of the argtable3 library.
+ *
+ * Copyright (C) 2013-2019 Tom G. Huang
+ * <tomghuang@gmail.com>
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ * * Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ * * Redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in the
+ * documentation and/or other materials provided with the distribution.
+ * * Neither the name of STEWART HEITMANN nor the names of its contributors
+ * may be used to endorse or promote products derived from this software
+ * without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL STEWART HEITMANN BE LIABLE FOR ANY DIRECT,
+ * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ ******************************************************************************/
+
+#ifndef ARG_UTILS_H
+#define ARG_UTILS_H
+
+#include <stdlib.h>
+
+#define ARG_ENABLE_TRACE 0
+#define ARG_ENABLE_LOG 0
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+enum { ARG_ERR_MINCOUNT = 1, ARG_ERR_MAXCOUNT, ARG_ERR_BADINT, ARG_ERR_OVERFLOW, ARG_ERR_BADDOUBLE, ARG_ERR_BADDATE, ARG_ERR_REGNOMATCH };
+
+typedef void(arg_panicfn)(const char* fmt, ...);
+
+#if defined(_MSC_VER)
+#define ARG_TRACE(x) \
+ __pragma(warning(push)) __pragma(warning(disable : 4127)) do { \
+ if (ARG_ENABLE_TRACE) \
+ dbg_printf x; \
+ } \
+ while (0) \
+ __pragma(warning(pop))
+
+#define ARG_LOG(x) \
+ __pragma(warning(push)) __pragma(warning(disable : 4127)) do { \
+ if (ARG_ENABLE_LOG) \
+ dbg_printf x; \
+ } \
+ while (0) \
+ __pragma(warning(pop))
+#else
+#define ARG_TRACE(x) \
+ do { \
+ if (ARG_ENABLE_TRACE) \
+ dbg_printf x; \
+ } while (0)
+
+#define ARG_LOG(x) \
+ do { \
+ if (ARG_ENABLE_LOG) \
+ dbg_printf x; \
+ } while (0)
+#endif
+
+/*
+ * Rename a few generic names to unique names.
+ * They can be a problem for the platforms like NuttX, where
+ * the namespace is flat for everything including apps and libraries.
+ */
+#define xmalloc argtable3_xmalloc
+#define xcalloc argtable3_xcalloc
+#define xrealloc argtable3_xrealloc
+#define xfree argtable3_xfree
+
+extern void dbg_printf(const char* fmt, ...);
+extern void arg_set_panic(arg_panicfn* proc);
+extern void* xmalloc(size_t size);
+extern void* xcalloc(size_t count, size_t size);
+extern void* xrealloc(void* ptr, size_t size);
+extern void xfree(void* ptr);
+
+struct arg_hashtable_entry {
+ void *k, *v;
+ unsigned int h;
+ struct arg_hashtable_entry* next;
+};
+
+typedef struct arg_hashtable {
+ unsigned int tablelength;
+ struct arg_hashtable_entry** table;
+ unsigned int entrycount;
+ unsigned int loadlimit;
+ unsigned int primeindex;
+ unsigned int (*hashfn)(const void* k);
+ int (*eqfn)(const void* k1, const void* k2);
+} arg_hashtable_t;
+
+/**
+ * @brief Create a hash table.
+ *
+ * @param minsize minimum initial size of hash table
+ * @param hashfn function for hashing keys
+ * @param eqfn function for determining key equality
+ * @return newly created hash table or NULL on failure
+ */
+arg_hashtable_t* arg_hashtable_create(unsigned int minsize, unsigned int (*hashfn)(const void*), int (*eqfn)(const void*, const void*));
+
+/**
+ * @brief This function will cause the table to expand if the insertion would take
+ * the ratio of entries to table size over the maximum load factor.
+ *
+ * This function does not check for repeated insertions with a duplicate key.
+ * The value returned when using a duplicate key is undefined -- when
+ * the hash table changes size, the order of retrieval of duplicate key
+ * entries is reversed.
+ * If in doubt, remove before insert.
+ *
+ * @param h the hash table to insert into
+ * @param k the key - hash table claims ownership and will free on removal
+ * @param v the value - does not claim ownership
+ * @return non-zero for successful insertion
+ */
+void arg_hashtable_insert(arg_hashtable_t* h, void* k, void* v);
+
+#define ARG_DEFINE_HASHTABLE_INSERT(fnname, keytype, valuetype) \
+ int fnname(arg_hashtable_t* h, keytype* k, valuetype* v) { return arg_hashtable_insert(h, k, v); }
+
+/**
+ * @brief Search the specified key in the hash table.
+ *
+ * @param h the hash table to search
+ * @param k the key to search for - does not claim ownership
+ * @return the value associated with the key, or NULL if none found
+ */
+void* arg_hashtable_search(arg_hashtable_t* h, const void* k);
+
+#define ARG_DEFINE_HASHTABLE_SEARCH(fnname, keytype, valuetype) \
+ valuetype* fnname(arg_hashtable_t* h, keytype* k) { return (valuetype*)(arg_hashtable_search(h, k)); }
+
+/**
+ * @brief Remove the specified key from the hash table.
+ *
+ * @param h the hash table to remove the item from
+ * @param k the key to search for - does not claim ownership
+ */
+void arg_hashtable_remove(arg_hashtable_t* h, const void* k);
+
+#define ARG_DEFINE_HASHTABLE_REMOVE(fnname, keytype, valuetype) \
+ void fnname(arg_hashtable_t* h, keytype* k) { arg_hashtable_remove(h, k); }
+
+/**
+ * @brief Return the number of keys in the hash table.
+ *
+ * @param h the hash table
+ * @return the number of items stored in the hash table
+ */
+unsigned int arg_hashtable_count(arg_hashtable_t* h);
+
+/**
+ * @brief Change the value associated with the key.
+ *
+ * function to change the value associated with a key, where there already
+ * exists a value bound to the key in the hash table.
+ * Source due to Holger Schemel.
+ *
+ * @name hashtable_change
+ * @param h the hash table
+ * @param key
+ * @param value
+ */
+int arg_hashtable_change(arg_hashtable_t* h, void* k, void* v);
+
+/**
+ * @brief Free the hash table and the memory allocated for each key-value pair.
+ *
+ * @param h the hash table
+ * @param free_values whether to call 'free' on the remaining values
+ */
+void arg_hashtable_destroy(arg_hashtable_t* h, int free_values);
+
+typedef struct arg_hashtable_itr {
+ arg_hashtable_t* h;
+ struct arg_hashtable_entry* e;
+ struct arg_hashtable_entry* parent;
+ unsigned int index;
+} arg_hashtable_itr_t;
+
+arg_hashtable_itr_t* arg_hashtable_itr_create(arg_hashtable_t* h);
+
+void arg_hashtable_itr_destroy(arg_hashtable_itr_t* itr);
+
+/**
+ * @brief Return the value of the (key,value) pair at the current position.
+ */
+extern void* arg_hashtable_itr_key(arg_hashtable_itr_t* i);
+
+/**
+ * @brief Return the value of the (key,value) pair at the current position.
+ */
+extern void* arg_hashtable_itr_value(arg_hashtable_itr_t* i);
+
+/**
+ * @brief Advance the iterator to the next element. Returns zero if advanced to end of table.
+ */
+int arg_hashtable_itr_advance(arg_hashtable_itr_t* itr);
+
+/**
+ * @brief Remove current element and advance the iterator to the next element.
+ */
+int arg_hashtable_itr_remove(arg_hashtable_itr_t* itr);
+
+/**
+ * @brief Search and overwrite the supplied iterator, to point to the entry matching the supplied key.
+ *
+ * @return Zero if not found.
+ */
+int arg_hashtable_itr_search(arg_hashtable_itr_t* itr, arg_hashtable_t* h, void* k);
+
+#define ARG_DEFINE_HASHTABLE_ITERATOR_SEARCH(fnname, keytype) \
+ int fnname(arg_hashtable_itr_t* i, arg_hashtable_t* h, keytype* k) { return (arg_hashtable_iterator_search(i, h, k)); }
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif
diff --git a/lib/console/commands.c b/lib/console/commands.c
new file mode 100644
index 00000000..5e63db87
--- /dev/null
+++ b/lib/console/commands.c
@@ -0,0 +1,302 @@
+/*
+ * SPDX-FileCopyrightText: 2016-2021 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#include <stdio.h>
+#include <string.h>
+#include <stdlib.h>
+#include <sys/param.h>
+#include "esp_heap_caps.h"
+#include "esp_log.h"
+#include "esp_console.h"
+#include "esp_system.h"
+#include "linenoise/linenoise.h"
+#include "argtable3/argtable3.h"
+#include "sys/queue.h"
+
+#define ANSI_COLOR_DEFAULT 39 /** Default foreground color */
+
+typedef struct cmd_item_ {
+ /**
+ * Command name (statically allocated by application)
+ */
+ const char *command;
+ /**
+ * Help text (statically allocated by application), may be NULL.
+ */
+ const char *help;
+ /**
+ * Hint text, usually lists possible arguments, dynamically allocated.
+ * May be NULL.
+ */
+ char *hint;
+ esp_console_cmd_func_t func; //!< pointer to the command handler
+ void *argtable; //!< optional pointer to arg table
+ SLIST_ENTRY(cmd_item_) next; //!< next command in the list
+} cmd_item_t;
+
+/** linked list of command structures */
+static SLIST_HEAD(cmd_list_, cmd_item_) s_cmd_list;
+
+/** run-time configuration options */
+static esp_console_config_t s_config = {
+ .heap_alloc_caps = MALLOC_CAP_DEFAULT
+};
+
+/** temporary buffer used for command line parsing */
+static char *s_tmp_line_buf;
+
+static const cmd_item_t *find_command_by_name(const char *name);
+
+esp_err_t esp_console_init(const esp_console_config_t *config)
+{
+ if (!config) {
+ return ESP_ERR_INVALID_ARG;
+ }
+ if (s_tmp_line_buf) {
+ return ESP_ERR_INVALID_STATE;
+ }
+ memcpy(&s_config, config, sizeof(s_config));
+ if (s_config.hint_color == 0) {
+ s_config.hint_color = ANSI_COLOR_DEFAULT;
+ }
+ if (s_config.heap_alloc_caps == 0) {
+ s_config.heap_alloc_caps = MALLOC_CAP_DEFAULT;
+ }
+ s_tmp_line_buf = heap_caps_calloc(1, config->max_cmdline_length, s_config.heap_alloc_caps);
+ if (s_tmp_line_buf == NULL) {
+ return ESP_ERR_NO_MEM;
+ }
+ return ESP_OK;
+}
+
+esp_err_t esp_console_deinit(void)
+{
+ if (!s_tmp_line_buf) {
+ return ESP_ERR_INVALID_STATE;
+ }
+ free(s_tmp_line_buf);
+ s_tmp_line_buf = NULL;
+ cmd_item_t *it, *tmp;
+ SLIST_FOREACH_SAFE(it, &s_cmd_list, next, tmp) {
+ SLIST_REMOVE(&s_cmd_list, it, cmd_item_, next);
+ free(it->hint);
+ free(it);
+ }
+ return ESP_OK;
+}
+
+esp_err_t esp_console_cmd_register(const esp_console_cmd_t *cmd)
+{
+ cmd_item_t *item = NULL;
+ if (!cmd || cmd->command == NULL) {
+ return ESP_ERR_INVALID_ARG;
+ }
+ if (strchr(cmd->command, ' ') != NULL) {
+ return ESP_ERR_INVALID_ARG;
+ }
+ item = (cmd_item_t *)find_command_by_name(cmd->command);
+ if (!item) {
+ // not registered before
+ item = heap_caps_calloc(1, sizeof(*item), s_config.heap_alloc_caps);
+ if (item == NULL) {
+ return ESP_ERR_NO_MEM;
+ }
+ } else {
+ // remove from list and free the old hint, because we will alloc new hint for the command
+ SLIST_REMOVE(&s_cmd_list, item, cmd_item_, next);
+ free(item->hint);
+ }
+ item->command = cmd->command;
+ item->help = cmd->help;
+ if (cmd->hint) {
+ /* Prepend a space before the hint. It separates command name and
+ * the hint. arg_print_syntax below adds this space as well.
+ */
+ int unused __attribute__((unused));
+ unused = asprintf(&item->hint, " %s", cmd->hint);
+ } else if (cmd->argtable) {
+ /* Generate hint based on cmd->argtable */
+ char *buf = NULL;
+ size_t buf_size = 0;
+ FILE *f = open_memstream(&buf, &buf_size);
+ if (f != NULL) {
+ arg_print_syntax(f, cmd->argtable, NULL);
+ fclose(f);
+ }
+ item->hint = buf;
+ }
+ item->argtable = cmd->argtable;
+ item->func = cmd->func;
+ cmd_item_t *last = SLIST_FIRST(&s_cmd_list);
+ if (last == NULL) {
+ SLIST_INSERT_HEAD(&s_cmd_list, item, next);
+ } else {
+ cmd_item_t *it;
+ while ((it = SLIST_NEXT(last, next)) != NULL) {
+ last = it;
+ }
+ SLIST_INSERT_AFTER(last, item, next);
+ }
+ return ESP_OK;
+}
+
+void esp_console_get_completion(const char *buf, linenoiseCompletions *lc)
+{
+ size_t len = strlen(buf);
+ if (len == 0) {
+ return;
+ }
+ cmd_item_t *it;
+ SLIST_FOREACH(it, &s_cmd_list, next) {
+ /* Check if command starts with buf */
+ if (strncmp(buf, it->command, len) == 0) {
+ linenoiseAddCompletion(lc, it->command);
+ }
+ }
+}
+
+const char *esp_console_get_hint(const char *buf, int *color, int *bold)
+{
+ size_t len = strlen(buf);
+ cmd_item_t *it;
+ SLIST_FOREACH(it, &s_cmd_list, next) {
+ if (strlen(it->command) == len &&
+ strncmp(buf, it->command, len) == 0) {
+ *color = s_config.hint_color;
+ *bold = s_config.hint_bold;
+ return it->hint;
+ }
+ }
+ return NULL;
+}
+
+static const cmd_item_t *find_command_by_name(const char *name)
+{
+ const cmd_item_t *cmd = NULL;
+ cmd_item_t *it;
+ size_t len = strlen(name);
+ SLIST_FOREACH(it, &s_cmd_list, next) {
+ if (strlen(it->command) == len &&
+ strcmp(name, it->command) == 0) {
+ cmd = it;
+ break;
+ }
+ }
+ return cmd;
+}
+
+esp_err_t esp_console_run(const char *cmdline, int *cmd_ret)
+{
+ if (s_tmp_line_buf == NULL) {
+ return ESP_ERR_INVALID_STATE;
+ }
+ char **argv = (char **) heap_caps_calloc(s_config.max_cmdline_args, sizeof(char *), s_config.heap_alloc_caps);
+ if (argv == NULL) {
+ return ESP_ERR_NO_MEM;
+ }
+ strlcpy(s_tmp_line_buf, cmdline, s_config.max_cmdline_length);
+
+ size_t argc = esp_console_split_argv(s_tmp_line_buf, argv,
+ s_config.max_cmdline_args);
+ if (argc == 0) {
+ free(argv);
+ return ESP_ERR_INVALID_ARG;
+ }
+ const cmd_item_t *cmd = find_command_by_name(argv[0]);
+ if (cmd == NULL) {
+ free(argv);
+ return ESP_ERR_NOT_FOUND;
+ }
+ *cmd_ret = (*cmd->func)(argc, argv);
+ free(argv);
+ return ESP_OK;
+}
+
+static struct {
+ struct arg_str *help_cmd;
+ struct arg_end *end;
+} help_args;
+
+static void print_arg_help(cmd_item_t *it)
+{
+ /* First line: command name and hint
+ * Pad all the hints to the same column
+ */
+ const char *hint = (it->hint) ? it->hint : "";
+ printf("%-s %s\n", it->command, hint);
+ /* Second line: print help.
+ * Argtable has a nice helper function for this which does line
+ * wrapping.
+ */
+ printf(" "); // arg_print_formatted does not indent the first line
+ arg_print_formatted(stdout, 2, 78, it->help);
+ /* Finally, print the list of arguments */
+ if (it->argtable) {
+ arg_print_glossary(stdout, (void **) it->argtable, " %12s %s\n");
+ }
+ printf("\n");
+}
+
+static int help_command(int argc, char **argv)
+{
+ int nerrors = arg_parse(argc, argv, (void **) &help_args);
+
+ if (nerrors != 0) {
+ arg_print_errors(stderr, help_args.end, argv[0]);
+ return 1;
+ }
+
+ cmd_item_t *it;
+ int ret_value = 1;
+
+ if (help_args.help_cmd->count == 0) {
+ /* Print summary of each command */
+ SLIST_FOREACH(it, &s_cmd_list, next) {
+ if (it->help == NULL) {
+ continue;
+ }
+ print_arg_help(it);
+ }
+ ret_value = 0;
+ } else {
+ /* Print summary of given command */
+ bool found_command = false;
+ SLIST_FOREACH(it, &s_cmd_list, next) {
+ if (it->help == NULL) {
+ continue;
+ }
+ if (strcmp(help_args.help_cmd->sval[0], it->command) == 0) {
+ print_arg_help(it);
+ found_command = true;
+ ret_value = 0;
+ break;
+ }
+ }
+
+ /* If given command has not been found, print error message*/
+ if (!found_command) {
+ printf("help: Unrecognized option '%s'. Please use correct command as argument "
+ "or type 'help' only to print help for all commands\n", help_args.help_cmd->sval[0]);
+ }
+ }
+
+ return ret_value;
+}
+
+esp_err_t esp_console_register_help_command(void)
+{
+ help_args.help_cmd = arg_str0(NULL, NULL, "<string>", "Name of command");
+ help_args.end = arg_end(1);
+
+ esp_console_cmd_t command = {
+ .command = "help",
+ .help = "Print the summary of all registered commands if no arguments "
+ "are given, otherwise print summary of given command.",
+ .func = &help_command,
+ .argtable = &help_args
+ };
+ return esp_console_cmd_register(&command);
+}
diff --git a/lib/console/esp_console.h b/lib/console/esp_console.h
new file mode 100644
index 00000000..0d45f928
--- /dev/null
+++ b/lib/console/esp_console.h
@@ -0,0 +1,397 @@
+/*
+ * SPDX-FileCopyrightText: 2016-2021 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+#pragma once
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+#include <stddef.h>
+#include "sdkconfig.h"
+#include "esp_heap_caps.h"
+#include "esp_err.h"
+
+// Forward declaration. Definition in linenoise/linenoise.h.
+typedef struct linenoiseCompletions linenoiseCompletions;
+
+/**
+ * @brief Parameters for console initialization
+ */
+typedef struct {
+ size_t max_cmdline_length; //!< length of command line buffer, in bytes
+ size_t max_cmdline_args; //!< maximum number of command line arguments to parse
+ uint32_t heap_alloc_caps; //!< where to (e.g. MALLOC_CAP_SPIRAM) allocate heap objects such as cmds used by esp_console
+ int hint_color; //!< ASCII color code of hint text
+ int hint_bold; //!< Set to 1 to print hint text in bold
+} esp_console_config_t;
+
+/**
+ * @brief Default console configuration value
+ *
+ */
+#define ESP_CONSOLE_CONFIG_DEFAULT() \
+ { \
+ .max_cmdline_length = 256, \
+ .max_cmdline_args = 32, \
+ .heap_alloc_caps = MALLOC_CAP_DEFAULT, \
+ .hint_color = 39, \
+ .hint_bold = 0 \
+ }
+
+/**
+ * @brief Parameters for console REPL (Read Eval Print Loop)
+ *
+ */
+typedef struct {
+ uint32_t max_history_len; //!< maximum length for the history
+ const char *history_save_path; //!< file path used to save history commands, set to NULL won't save to file system
+ uint32_t task_stack_size; //!< repl task stack size
+ uint32_t task_priority; //!< repl task priority
+ const char *prompt; //!< prompt (NULL represents default: "esp> ")
+ size_t max_cmdline_length; //!< maximum length of a command line. If 0, default value will be used
+ void (*prerun_cb)(void);
+} esp_console_repl_config_t;
+
+/**
+ * @brief Default console repl configuration value
+ *
+ */
+#define ESP_CONSOLE_REPL_CONFIG_DEFAULT() \
+{ \
+ .max_history_len = 32, \
+ .history_save_path = NULL, \
+ .task_stack_size = 4096, \
+ .task_priority = 2, \
+ .prompt = NULL, \
+ .max_cmdline_length = 0, \
+}
+
+#if CONFIG_ESP_CONSOLE_UART_DEFAULT || CONFIG_ESP_CONSOLE_UART_CUSTOM
+/**
+ * @brief Parameters for console device: UART
+ *
+ */
+typedef struct {
+ int channel; //!< UART channel number (count from zero)
+ int baud_rate; //!< Comunication baud rate
+ int tx_gpio_num; //!< GPIO number for TX path, -1 means using default one
+ int rx_gpio_num; //!< GPIO number for RX path, -1 means using default one
+} esp_console_dev_uart_config_t;
+
+#if CONFIG_ESP_CONSOLE_UART_CUSTOM
+#define ESP_CONSOLE_DEV_UART_CONFIG_DEFAULT() \
+{ \
+ .channel = CONFIG_ESP_CONSOLE_UART_NUM, \
+ .baud_rate = CONFIG_ESP_CONSOLE_UART_BAUDRATE, \
+ .tx_gpio_num = CONFIG_ESP_CONSOLE_UART_TX_GPIO, \
+ .rx_gpio_num = CONFIG_ESP_CONSOLE_UART_RX_GPIO, \
+}
+#else
+#define ESP_CONSOLE_DEV_UART_CONFIG_DEFAULT() \
+{ \
+ .channel = CONFIG_ESP_CONSOLE_UART_NUM, \
+ .baud_rate = CONFIG_ESP_CONSOLE_UART_BAUDRATE, \
+ .tx_gpio_num = -1, \
+ .rx_gpio_num = -1, \
+}
+#endif // CONFIG_ESP_CONSOLE_UART_CUSTOM
+#endif // CONFIG_ESP_CONSOLE_UART_DEFAULT || CONFIG_ESP_CONSOLE_UART_CUSTOM
+
+#if CONFIG_ESP_CONSOLE_USB_CDC || (defined __DOXYGEN__ && SOC_USB_OTG_SUPPORTED)
+/**
+ * @brief Parameters for console device: USB CDC
+ *
+ * @note It's an empty structure for now, reserved for future
+ *
+ */
+typedef struct {
+
+} esp_console_dev_usb_cdc_config_t;
+
+#define ESP_CONSOLE_DEV_CDC_CONFIG_DEFAULT() {}
+#endif // CONFIG_ESP_CONSOLE_USB_CDC || (defined __DOXYGEN__ && SOC_USB_OTG_SUPPORTED)
+
+#if CONFIG_ESP_CONSOLE_USB_SERIAL_JTAG || (defined __DOXYGEN__ && SOC_USB_SERIAL_JTAG_SUPPORTED)
+/**
+ * @brief Parameters for console device: USB-SERIAL-JTAG
+ *
+ * @note It's an empty structure for now, reserved for future
+ *
+ */
+typedef struct {
+
+} esp_console_dev_usb_serial_jtag_config_t;
+
+#define ESP_CONSOLE_DEV_USB_SERIAL_JTAG_CONFIG_DEFAULT() {}
+#endif // CONFIG_ESP_CONSOLE_USB_SERIAL_JTAG || (defined __DOXYGEN__ && SOC_USB_SERIAL_JTAG_SUPPORTED)
+
+/**
+ * @brief initialize console module
+ * @param config console configuration
+ * @note Call this once before using other console module features
+ * @return
+ * - ESP_OK on success
+ * - ESP_ERR_NO_MEM if out of memory
+ * - ESP_ERR_INVALID_STATE if already initialized
+ * - ESP_ERR_INVALID_ARG if the configuration is invalid
+ */
+esp_err_t esp_console_init(const esp_console_config_t *config);
+
+/**
+ * @brief de-initialize console module
+ * @note Call this once when done using console module functions
+ * @return
+ * - ESP_OK on success
+ * - ESP_ERR_INVALID_STATE if not initialized yet
+ */
+esp_err_t esp_console_deinit(void);
+
+/**
+ * @brief Console command main function
+ * @param argc number of arguments
+ * @param argv array with argc entries, each pointing to a zero-terminated string argument
+ * @return console command return code, 0 indicates "success"
+ */
+typedef int (*esp_console_cmd_func_t)(int argc, char **argv);
+
+/**
+ * @brief Console command description
+ */
+typedef struct {
+ /**
+ * Command name. Must not be NULL, must not contain spaces.
+ * The pointer must be valid until the call to esp_console_deinit.
+ */
+ const char *command;
+ /**
+ * Help text for the command, shown by help command.
+ * If set, the pointer must be valid until the call to esp_console_deinit.
+ * If not set, the command will not be listed in 'help' output.
+ */
+ const char *help;
+ /**
+ * Hint text, usually lists possible arguments.
+ * If set to NULL, and 'argtable' field is non-NULL, hint will be generated
+ * automatically
+ */
+ const char *hint;
+ /**
+ * Pointer to a function which implements the command.
+ */
+ esp_console_cmd_func_t func;
+ /**
+ * Array or structure of pointers to arg_xxx structures, may be NULL.
+ * Used to generate hint text if 'hint' is set to NULL.
+ * Array/structure which this field points to must end with an arg_end.
+ * Only used for the duration of esp_console_cmd_register call.
+ */
+ void *argtable;
+} esp_console_cmd_t;
+
+/**
+ * @brief Register console command
+ * @param cmd pointer to the command description; can point to a temporary value
+ * @return
+ * - ESP_OK on success
+ * - ESP_ERR_NO_MEM if out of memory
+ * - ESP_ERR_INVALID_ARG if command description includes invalid arguments
+ */
+esp_err_t esp_console_cmd_register(const esp_console_cmd_t *cmd);
+
+/**
+ * @brief Run command line
+ * @param cmdline command line (command name followed by a number of arguments)
+ * @param[out] cmd_ret return code from the command (set if command was run)
+ * @return
+ * - ESP_OK, if command was run
+ * - ESP_ERR_INVALID_ARG, if the command line is empty, or only contained
+ * whitespace
+ * - ESP_ERR_NOT_FOUND, if command with given name wasn't registered
+ * - ESP_ERR_INVALID_STATE, if esp_console_init wasn't called
+ */
+esp_err_t esp_console_run(const char *cmdline, int *cmd_ret);
+
+/**
+ * @brief Split command line into arguments in place
+ * @verbatim
+ * - This function finds whitespace-separated arguments in the given input line.
+ *
+ * 'abc def 1 20 .3' -> [ 'abc', 'def', '1', '20', '.3' ]
+ *
+ * - Argument which include spaces may be surrounded with quotes. In this case
+ * spaces are preserved and quotes are stripped.
+ *
+ * 'abc "123 456" def' -> [ 'abc', '123 456', 'def' ]
+ *
+ * - Escape sequences may be used to produce backslash, double quote, and space:
+ *
+ * 'a\ b\\c\"' -> [ 'a b\c"' ]
+ * @endverbatim
+ * @note Pointers to at most argv_size - 1 arguments are returned in argv array.
+ * The pointer after the last one (i.e. argv[argc]) is set to NULL.
+ *
+ * @param line pointer to buffer to parse; it is modified in place
+ * @param argv array where the pointers to arguments are written
+ * @param argv_size number of elements in argv_array (max. number of arguments)
+ * @return number of arguments found (argc)
+ */
+size_t esp_console_split_argv(char *line, char **argv, size_t argv_size);
+
+/**
+ * @brief Callback which provides command completion for linenoise library
+ *
+ * When using linenoise for line editing, command completion support
+ * can be enabled like this:
+ *
+ * linenoiseSetCompletionCallback(&esp_console_get_completion);
+ *
+ * @param buf the string typed by the user
+ * @param lc linenoiseCompletions to be filled in
+ */
+void esp_console_get_completion(const char *buf, linenoiseCompletions *lc);
+
+/**
+ * @brief Callback which provides command hints for linenoise library
+ *
+ * When using linenoise for line editing, hints support can be enabled as
+ * follows:
+ *
+ * linenoiseSetHintsCallback((linenoiseHintsCallback*) &esp_console_get_hint);
+ *
+ * The extra cast is needed because linenoiseHintsCallback is defined as
+ * returning a char* instead of const char*.
+ *
+ * @param buf line typed by the user
+ * @param[out] color ANSI color code to be used when displaying the hint
+ * @param[out] bold set to 1 if hint has to be displayed in bold
+ * @return string containing the hint text. This string is persistent and should
+ * not be freed (i.e. linenoiseSetFreeHintsCallback should not be used).
+ */
+const char *esp_console_get_hint(const char *buf, int *color, int *bold);
+
+/**
+ * @brief Register a 'help' command
+ *
+ * Default 'help' command prints the list of registered commands along with
+ * hints and help strings if no additional argument is given. If an additional
+ * argument is given, the help command will look for a command with the same
+ * name and only print the hints and help strings of that command.
+ *
+ * @return
+ * - ESP_OK on success
+ * - ESP_ERR_INVALID_STATE, if esp_console_init wasn't called
+ */
+esp_err_t esp_console_register_help_command(void);
+
+/******************************************************************************
+ * Console REPL
+ ******************************************************************************/
+
+/**
+ * @brief Type defined for console REPL
+ *
+ */
+typedef struct esp_console_repl_s esp_console_repl_t;
+
+/**
+ * @brief Console REPL base structure
+ *
+ */
+struct esp_console_repl_s {
+ /**
+ * @brief Delete console REPL environment
+ * @param[in] repl REPL handle returned from esp_console_new_repl_xxx
+ * @return
+ * - ESP_OK on success
+ * - ESP_FAIL on errors
+ */
+ esp_err_t (*del)(esp_console_repl_t *repl);
+};
+
+#if CONFIG_ESP_CONSOLE_UART_DEFAULT || CONFIG_ESP_CONSOLE_UART_CUSTOM
+/**
+ * @brief Establish a console REPL environment over UART driver
+ *
+ * @param[in] dev_config UART device configuration
+ * @param[in] repl_config REPL configuration
+ * @param[out] ret_repl return REPL handle after initialization succeed, return NULL otherwise
+ *
+ * @note This is an all-in-one function to establish the environment needed for REPL, includes:
+ * - Install the UART driver on the console UART (8n1, 115200, REF_TICK clock source)
+ * - Configures the stdin/stdout to go through the UART driver
+ * - Initializes linenoise
+ * - Spawn new thread to run REPL in the background
+ *
+ * @attention This function is meant to be used in the examples to make the code more compact.
+ * Applications which use console functionality should be based on
+ * the underlying linenoise and esp_console functions.
+ *
+ * @return
+ * - ESP_OK on success
+ * - ESP_FAIL Parameter error
+ */
+esp_err_t esp_console_new_repl_uart(const esp_console_dev_uart_config_t *dev_config, const esp_console_repl_config_t *repl_config, esp_console_repl_t **ret_repl);
+#endif // CONFIG_ESP_CONSOLE_UART_DEFAULT || CONFIG_ESP_CONSOLE_UART_CUSTOM
+
+#if CONFIG_ESP_CONSOLE_USB_CDC || (defined __DOXYGEN__ && SOC_USB_OTG_SUPPORTED)
+/**
+ * @brief Establish a console REPL environment over USB CDC
+ *
+ * @param[in] dev_config USB CDC configuration
+ * @param[in] repl_config REPL configuration
+ * @param[out] ret_repl return REPL handle after initialization succeed, return NULL otherwise
+ *
+ * @note This is a all-in-one function to establish the environment needed for REPL, includes:
+ * - Initializes linenoise
+ * - Spawn new thread to run REPL in the background
+ *
+ * @attention This function is meant to be used in the examples to make the code more compact.
+ * Applications which use console functionality should be based on
+ * the underlying linenoise and esp_console functions.
+ *
+ * @return
+ * - ESP_OK on success
+ * - ESP_FAIL Parameter error
+ */
+esp_err_t esp_console_new_repl_usb_cdc(const esp_console_dev_usb_cdc_config_t *dev_config, const esp_console_repl_config_t *repl_config, esp_console_repl_t **ret_repl);
+#endif // CONFIG_ESP_CONSOLE_USB_CDC || (defined __DOXYGEN__ && SOC_USB_OTG_SUPPORTED)
+
+#if CONFIG_ESP_CONSOLE_USB_SERIAL_JTAG || (defined __DOXYGEN__ && SOC_USB_SERIAL_JTAG_SUPPORTED)
+/**
+ * @brief Establish a console REPL (Read-eval-print loop) environment over USB-SERIAL-JTAG
+ *
+ * @param[in] dev_config USB-SERIAL-JTAG configuration
+ * @param[in] repl_config REPL configuration
+ * @param[out] ret_repl return REPL handle after initialization succeed, return NULL otherwise
+ *
+ * @note This is an all-in-one function to establish the environment needed for REPL, includes:
+ * - Initializes linenoise
+ * - Spawn new thread to run REPL in the background
+ *
+ * @attention This function is meant to be used in the examples to make the code more compact.
+ * Applications which use console functionality should be based on
+ * the underlying linenoise and esp_console functions.
+ *
+ * @return
+ * - ESP_OK on success
+ * - ESP_FAIL Parameter error
+ */
+esp_err_t esp_console_new_repl_usb_serial_jtag(const esp_console_dev_usb_serial_jtag_config_t *dev_config, const esp_console_repl_config_t *repl_config, esp_console_repl_t **ret_repl);
+#endif // CONFIG_ESP_CONSOLE_USB_SERIAL_JTAG || (defined __DOXYGEN__ && SOC_USB_SERIAL_JTAG_SUPPORTED)
+
+/**
+ * @brief Start REPL environment
+ * @param[in] repl REPL handle returned from esp_console_new_repl_xxx
+ * @note Once the REPL gets started, it won't be stopped until the user calls repl->del(repl) to destroy the REPL environment.
+ * @return
+ * - ESP_OK on success
+ * - ESP_ERR_INVALID_STATE, if repl has started already
+ */
+esp_err_t esp_console_start_repl(esp_console_repl_t *repl);
+
+#ifdef __cplusplus
+}
+#endif
diff --git a/lib/console/esp_console_repl.c b/lib/console/esp_console_repl.c
new file mode 100644
index 00000000..bbc49ed9
--- /dev/null
+++ b/lib/console/esp_console_repl.c
@@ -0,0 +1,550 @@
+/*
+ * SPDX-FileCopyrightText: 2016-2021 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#include <stdint.h>
+#include <stdio.h>
+#include <fcntl.h>
+#include <sys/cdefs.h>
+#include "sdkconfig.h"
+#include "esp_err.h"
+#include "esp_log.h"
+#include "esp_console.h"
+#include "esp_vfs_dev.h"
+#include "esp_vfs_cdcacm.h"
+#include "esp_vfs_usb_serial_jtag.h"
+#include "freertos/FreeRTOS.h"
+#include "freertos/task.h"
+#include "driver/uart.h"
+#include "driver/usb_serial_jtag.h"
+#include "linenoise/linenoise.h"
+
+static const char *TAG = "console.repl";
+
+#define CONSOLE_PROMPT_MAX_LEN (32)
+#define CONSOLE_PATH_MAX_LEN (ESP_VFS_PATH_MAX)
+
+typedef enum {
+ CONSOLE_REPL_STATE_DEINIT,
+ CONSOLE_REPL_STATE_INIT,
+ CONSOLE_REPL_STATE_START,
+} repl_state_t;
+
+typedef struct {
+ esp_console_repl_t repl_core; // base class
+ char prompt[CONSOLE_PROMPT_MAX_LEN]; // Prompt to be printed before each line
+ repl_state_t state;
+ const char *history_save_path;
+ TaskHandle_t task_hdl; // REPL task handle
+ size_t max_cmdline_length; // Maximum length of a command line. If 0, default value will be used.
+ void (*prerun_cb)(void);
+} esp_console_repl_com_t;
+
+typedef struct {
+ esp_console_repl_com_t repl_com; // base class
+ int uart_channel; // uart channel number
+} esp_console_repl_universal_t;
+
+static void esp_console_repl_task(void *args);
+#if CONFIG_ESP_CONSOLE_UART_DEFAULT || CONFIG_ESP_CONSOLE_UART_CUSTOM
+static esp_err_t esp_console_repl_uart_delete(esp_console_repl_t *repl);
+#endif // CONFIG_ESP_CONSOLE_UART_DEFAULT || CONFIG_ESP_CONSOLE_UART_CUSTOM
+#if CONFIG_ESP_CONSOLE_USB_CDC
+static esp_err_t esp_console_repl_usb_cdc_delete(esp_console_repl_t *repl);
+#endif // CONFIG_ESP_CONSOLE_USB_CDC
+#if CONFIG_ESP_CONSOLE_USB_SERIAL_JTAG
+static esp_err_t esp_console_repl_usb_serial_jtag_delete(esp_console_repl_t *repl);
+#endif //CONFIG_ESP_CONSOLE_USB_SERIAL_JTAG
+static esp_err_t esp_console_common_init(size_t max_cmdline_length, esp_console_repl_com_t *repl_com);
+static esp_err_t esp_console_setup_prompt(const char *prompt, esp_console_repl_com_t *repl_com);
+static esp_err_t esp_console_setup_history(const char *history_path, uint32_t max_history_len, esp_console_repl_com_t *repl_com);
+
+#if CONFIG_ESP_CONSOLE_USB_CDC
+esp_err_t esp_console_new_repl_usb_cdc(const esp_console_dev_usb_cdc_config_t *dev_config, const esp_console_repl_config_t *repl_config, esp_console_repl_t **ret_repl)
+{
+ esp_err_t ret = ESP_OK;
+ esp_console_repl_universal_t *cdc_repl = NULL;
+ if (!repl_config | !dev_config | !ret_repl) {
+ ret = ESP_ERR_INVALID_ARG;
+ goto _exit;
+ }
+ // allocate memory for console REPL context
+ cdc_repl = calloc(1, sizeof(esp_console_repl_universal_t));
+ if (!cdc_repl) {
+ ret = ESP_ERR_NO_MEM;
+ goto _exit;
+ }
+
+ /* Minicom, screen, idf_monitor send CR when ENTER key is pressed */
+ esp_vfs_dev_cdcacm_set_rx_line_endings(ESP_LINE_ENDINGS_CR);
+ /* Move the caret to the beginning of the next line on '\n' */
+ esp_vfs_dev_cdcacm_set_tx_line_endings(ESP_LINE_ENDINGS_CRLF);
+
+ /* Enable blocking mode on stdin and stdout */
+ fcntl(fileno(stdout), F_SETFL, 0);
+ fcntl(fileno(stdin), F_SETFL, 0);
+
+ // initialize console, common part
+ ret = esp_console_common_init(repl_config->max_cmdline_length, &cdc_repl->repl_com);
+ if (ret != ESP_OK) {
+ goto _exit;
+ }
+
+ // setup history
+ ret = esp_console_setup_history(repl_config->history_save_path, repl_config->max_history_len, &cdc_repl->repl_com);
+ if (ret != ESP_OK) {
+ goto _exit;
+ }
+
+ // setup prompt
+ esp_console_setup_prompt(repl_config->prompt, &cdc_repl->repl_com);
+
+ /* Fill the structure here as it will be used directly by the created task. */
+ cdc_repl->uart_channel = CONFIG_ESP_CONSOLE_UART_NUM;
+ cdc_repl->repl_com.state = CONSOLE_REPL_STATE_INIT;
+ cdc_repl->repl_com.repl_core.del = esp_console_repl_usb_cdc_delete;
+
+ /* spawn a single thread to run REPL */
+ if (xTaskCreate(esp_console_repl_task, "console_repl", repl_config->task_stack_size,
+ cdc_repl, repl_config->task_priority, &cdc_repl->repl_com.task_hdl) != pdTRUE) {
+ ret = ESP_FAIL;
+ goto _exit;
+ }
+
+ *ret_repl = &cdc_repl->repl_com.repl_core;
+ return ESP_OK;
+_exit:
+ if (cdc_repl) {
+ esp_console_deinit();
+ free(cdc_repl);
+ }
+ if (ret_repl) {
+ *ret_repl = NULL;
+ }
+ return ret;
+}
+#endif // CONFIG_ESP_CONSOLE_USB_CDC
+
+#if CONFIG_ESP_CONSOLE_USB_SERIAL_JTAG
+esp_err_t esp_console_new_repl_usb_serial_jtag(const esp_console_dev_usb_serial_jtag_config_t *dev_config, const esp_console_repl_config_t *repl_config, esp_console_repl_t **ret_repl)
+{
+ esp_console_repl_universal_t *usb_serial_jtag_repl = NULL;
+ if (!repl_config | !dev_config | !ret_repl) {
+ return ESP_ERR_INVALID_ARG;
+ }
+
+ esp_err_t ret = ESP_OK;
+ // allocate memory for console REPL context
+ usb_serial_jtag_repl = calloc(1, sizeof(esp_console_repl_universal_t));
+ if (!usb_serial_jtag_repl) {
+ ret = ESP_ERR_NO_MEM;
+ goto _exit;
+ }
+
+ /* Minicom, screen, idf_monitor send CR when ENTER key is pressed */
+ esp_vfs_dev_usb_serial_jtag_set_rx_line_endings(ESP_LINE_ENDINGS_CR);
+ /* Move the caret to the beginning of the next line on '\n' */
+ esp_vfs_dev_usb_serial_jtag_set_tx_line_endings(ESP_LINE_ENDINGS_CRLF);
+
+ /* Enable blocking mode on stdin and stdout */
+ fcntl(fileno(stdout), F_SETFL, 0);
+ fcntl(fileno(stdin), F_SETFL, 0);
+
+ usb_serial_jtag_driver_config_t usb_serial_jtag_config = USB_SERIAL_JTAG_DRIVER_CONFIG_DEFAULT();
+
+ /* Install USB-SERIAL-JTAG driver for interrupt-driven reads and writes */
+ ret = usb_serial_jtag_driver_install(&usb_serial_jtag_config);
+ if (ret != ESP_OK) {
+ goto _exit;
+ }
+
+ // initialize console, common part
+ ret = esp_console_common_init(repl_config->max_cmdline_length, &usb_serial_jtag_repl->repl_com);
+ if (ret != ESP_OK) {
+ goto _exit;
+ }
+
+ /* Tell vfs to use usb-serial-jtag driver */
+ esp_vfs_usb_serial_jtag_use_driver();
+
+ // setup history
+ ret = esp_console_setup_history(repl_config->history_save_path, repl_config->max_history_len, &usb_serial_jtag_repl->repl_com);
+ if (ret != ESP_OK) {
+ goto _exit;
+ }
+
+ // setup prompt
+ esp_console_setup_prompt(repl_config->prompt, &usb_serial_jtag_repl->repl_com);
+
+ /* Fill the structure here as it will be used directly by the created task. */
+ usb_serial_jtag_repl->uart_channel = CONFIG_ESP_CONSOLE_UART_NUM;
+ usb_serial_jtag_repl->repl_com.state = CONSOLE_REPL_STATE_INIT;
+ usb_serial_jtag_repl->repl_com.repl_core.del = esp_console_repl_usb_serial_jtag_delete;
+
+ /* spawn a single thread to run REPL */
+ if (xTaskCreate(esp_console_repl_task, "console_repl", repl_config->task_stack_size,
+ usb_serial_jtag_repl, repl_config->task_priority, &usb_serial_jtag_repl->repl_com.task_hdl) != pdTRUE) {
+ ret = ESP_FAIL;
+ goto _exit;
+ }
+
+ *ret_repl = &usb_serial_jtag_repl->repl_com.repl_core;
+ return ESP_OK;
+_exit:
+ if (usb_serial_jtag_repl) {
+ esp_console_deinit();
+ free(usb_serial_jtag_repl);
+ }
+ if (ret_repl) {
+ *ret_repl = NULL;
+ }
+ return ret;
+}
+#endif // CONFIG_ESP_CONSOLE_USB_SERIAL_JTAG
+
+#if CONFIG_ESP_CONSOLE_UART_DEFAULT || CONFIG_ESP_CONSOLE_UART_CUSTOM
+esp_err_t esp_console_new_repl_uart(const esp_console_dev_uart_config_t *dev_config, const esp_console_repl_config_t *repl_config, esp_console_repl_t **ret_repl)
+{
+ esp_err_t ret = ESP_OK;
+ esp_console_repl_universal_t *uart_repl = NULL;
+ if (!repl_config | !dev_config | !ret_repl) {
+ ret = ESP_ERR_INVALID_ARG;
+ goto _exit;
+ }
+ // allocate memory for console REPL context
+ uart_repl = calloc(1, sizeof(esp_console_repl_universal_t));
+ if (!uart_repl) {
+ ret = ESP_ERR_NO_MEM;
+ goto _exit;
+ }
+
+ /* Drain stdout before reconfiguring it */
+ fflush(stdout);
+ fsync(fileno(stdout));
+
+ /* Minicom, screen, idf_monitor send CR when ENTER key is pressed */
+ esp_vfs_dev_uart_port_set_rx_line_endings(dev_config->channel, ESP_LINE_ENDINGS_CR);
+ /* Move the caret to the beginning of the next line on '\n' */
+ esp_vfs_dev_uart_port_set_tx_line_endings(dev_config->channel, ESP_LINE_ENDINGS_CRLF);
+
+ /* Configure UART. Note that REF_TICK/XTAL is used so that the baud rate remains
+ * correct while APB frequency is changing in light sleep mode.
+ */
+#if SOC_UART_SUPPORT_REF_TICK
+ uart_sclk_t clk_source = UART_SCLK_REF_TICK;
+ // REF_TICK clock can't provide a high baudrate
+ if (dev_config->baud_rate > 1 * 1000 * 1000) {
+ clk_source = UART_SCLK_DEFAULT;
+ ESP_LOGW(TAG, "light sleep UART wakeup might not work at the configured baud rate");
+ }
+#elif SOC_UART_SUPPORT_XTAL_CLK
+ uart_sclk_t clk_source = UART_SCLK_XTAL;
+#else
+ #error "No UART clock source is aware of DFS"
+#endif // SOC_UART_SUPPORT_xxx
+ const uart_config_t uart_config = {
+ .baud_rate = dev_config->baud_rate,
+ .data_bits = UART_DATA_8_BITS,
+ .parity = UART_PARITY_DISABLE,
+ .stop_bits = UART_STOP_BITS_1,
+ .source_clk = clk_source,
+ };
+
+ uart_param_config(dev_config->channel, &uart_config);
+ uart_set_pin(dev_config->channel, dev_config->tx_gpio_num, dev_config->rx_gpio_num, -1, -1);
+
+ /* Install UART driver for interrupt-driven reads and writes */
+ ret = uart_driver_install(dev_config->channel, 256, 0, 0, NULL, 0);
+ if (ret != ESP_OK) {
+ goto _exit;
+ }
+
+ /* Tell VFS to use UART driver */
+ esp_vfs_dev_uart_use_driver(dev_config->channel);
+
+ // initialize console, common part
+ ret = esp_console_common_init(repl_config->max_cmdline_length, &uart_repl->repl_com);
+ if (ret != ESP_OK) {
+ goto _exit;
+ }
+
+ // setup history
+ ret = esp_console_setup_history(repl_config->history_save_path, repl_config->max_history_len, &uart_repl->repl_com);
+ if (ret != ESP_OK) {
+ goto _exit;
+ }
+
+ // setup prompt
+ esp_console_setup_prompt(repl_config->prompt, &uart_repl->repl_com);
+
+ uart_repl->repl_com.prerun_cb = repl_config->prerun_cb;
+
+ /* Fill the structure here as it will be used directly by the created task. */
+ uart_repl->uart_channel = dev_config->channel;
+ uart_repl->repl_com.state = CONSOLE_REPL_STATE_INIT;
+ uart_repl->repl_com.repl_core.del = esp_console_repl_uart_delete;
+
+ /* Spawn a single thread to run REPL, we need to pass `uart_repl` to it as
+ * it also requires the uart channel. */
+ if (xTaskCreate(esp_console_repl_task, "console_repl", repl_config->task_stack_size,
+ uart_repl, repl_config->task_priority, &uart_repl->repl_com.task_hdl) != pdTRUE) {
+ ret = ESP_FAIL;
+ goto _exit;
+ }
+
+ *ret_repl = &uart_repl->repl_com.repl_core;
+ return ESP_OK;
+_exit:
+ if (uart_repl) {
+ esp_console_deinit();
+ uart_driver_delete(dev_config->channel);
+ free(uart_repl);
+ }
+ if (ret_repl) {
+ *ret_repl = NULL;
+ }
+ return ret;
+}
+#endif // CONFIG_ESP_CONSOLE_UART_DEFAULT || CONFIG_ESP_CONSOLE_UART_CUSTOM
+
+esp_err_t esp_console_start_repl(esp_console_repl_t *repl)
+{
+ esp_err_t ret = ESP_OK;
+ esp_console_repl_com_t *repl_com = __containerof(repl, esp_console_repl_com_t, repl_core);
+ // check if already initialized
+ if (repl_com->state != CONSOLE_REPL_STATE_INIT) {
+ ret = ESP_ERR_INVALID_STATE;
+ goto _exit;
+ }
+
+ repl_com->state = CONSOLE_REPL_STATE_START;
+ xTaskNotifyGive(repl_com->task_hdl);
+ return ESP_OK;
+_exit:
+ return ret;
+}
+
+static esp_err_t esp_console_setup_prompt(const char *prompt, esp_console_repl_com_t *repl_com)
+{
+ /* set command line prompt */
+ const char *prompt_temp = "esp>";
+ if (prompt) {
+ prompt_temp = prompt;
+ }
+ snprintf(repl_com->prompt, CONSOLE_PROMPT_MAX_LEN - 1, LOG_COLOR_I "%s " LOG_RESET_COLOR, prompt_temp);
+
+ return ESP_OK;
+}
+
+static esp_err_t esp_console_setup_history(const char *history_path, uint32_t max_history_len, esp_console_repl_com_t *repl_com)
+{
+ esp_err_t ret = ESP_OK;
+
+ repl_com->history_save_path = history_path;
+ if (history_path) {
+ /* Load command history from filesystem */
+ linenoiseHistoryLoad(history_path);
+ }
+
+ /* Set command history size */
+ if (linenoiseHistorySetMaxLen(max_history_len) != 1) {
+ ESP_LOGE(TAG, "set max history length to %"PRIu32" failed", max_history_len);
+ ret = ESP_FAIL;
+ goto _exit;
+ }
+ return ESP_OK;
+_exit:
+ return ret;
+}
+
+static esp_err_t esp_console_common_init(size_t max_cmdline_length, esp_console_repl_com_t *repl_com)
+{
+ esp_err_t ret = ESP_OK;
+ /* Initialize the console */
+ esp_console_config_t console_config = ESP_CONSOLE_CONFIG_DEFAULT();
+ repl_com->max_cmdline_length = console_config.max_cmdline_length;
+ /* Replace the default command line length if passed as a parameter */
+ if (max_cmdline_length != 0) {
+ console_config.max_cmdline_length = max_cmdline_length;
+ repl_com->max_cmdline_length = max_cmdline_length;
+ }
+
+#if CONFIG_LOG_COLORS
+ console_config.hint_color = atoi(LOG_COLOR_CYAN);
+#else
+ console_config.hint_color = -1;
+#endif
+ ret = esp_console_init(&console_config);
+ if (ret != ESP_OK) {
+ goto _exit;
+ }
+
+ ret = esp_console_register_help_command();
+ if (ret != ESP_OK) {
+ goto _exit;
+ }
+
+ /* Configure linenoise line completion library */
+ /* Enable multiline editing. If not set, long commands will scroll within single line */
+ linenoiseSetMultiLine(1);
+
+ /* Tell linenoise where to get command completions and hints */
+ linenoiseSetCompletionCallback(&esp_console_get_completion);
+ linenoiseSetHintsCallback((linenoiseHintsCallback *)&esp_console_get_hint);
+
+ return ESP_OK;
+_exit:
+ return ret;
+}
+
+#if CONFIG_ESP_CONSOLE_UART_DEFAULT || CONFIG_ESP_CONSOLE_UART_CUSTOM
+static esp_err_t esp_console_repl_uart_delete(esp_console_repl_t *repl)
+{
+ esp_err_t ret = ESP_OK;
+ esp_console_repl_com_t *repl_com = __containerof(repl, esp_console_repl_com_t, repl_core);
+ esp_console_repl_universal_t *uart_repl = __containerof(repl_com, esp_console_repl_universal_t, repl_com);
+ // check if already de-initialized
+ if (repl_com->state == CONSOLE_REPL_STATE_DEINIT) {
+ ESP_LOGE(TAG, "already de-initialized");
+ ret = ESP_ERR_INVALID_STATE;
+ goto _exit;
+ }
+ repl_com->state = CONSOLE_REPL_STATE_DEINIT;
+ esp_console_deinit();
+ esp_vfs_dev_uart_use_nonblocking(uart_repl->uart_channel);
+ uart_driver_delete(uart_repl->uart_channel);
+ free(uart_repl);
+_exit:
+ return ret;
+}
+#endif // CONFIG_ESP_CONSOLE_UART_DEFAULT || CONFIG_ESP_CONSOLE_UART_CUSTOM
+
+#if CONFIG_ESP_CONSOLE_USB_CDC
+static esp_err_t esp_console_repl_usb_cdc_delete(esp_console_repl_t *repl)
+{
+ esp_err_t ret = ESP_OK;
+ esp_console_repl_com_t *repl_com = __containerof(repl, esp_console_repl_com_t, repl_core);
+ esp_console_repl_universal_t *cdc_repl = __containerof(repl_com, esp_console_repl_universal_t, repl_com);
+ // check if already de-initialized
+ if (repl_com->state == CONSOLE_REPL_STATE_DEINIT) {
+ ESP_LOGE(TAG, "already de-initialized");
+ ret = ESP_ERR_INVALID_STATE;
+ goto _exit;
+ }
+ repl_com->state = CONSOLE_REPL_STATE_DEINIT;
+ esp_console_deinit();
+ free(cdc_repl);
+_exit:
+ return ret;
+}
+#endif // CONFIG_ESP_CONSOLE_USB_CDC
+
+#if CONFIG_ESP_CONSOLE_USB_SERIAL_JTAG
+static esp_err_t esp_console_repl_usb_serial_jtag_delete(esp_console_repl_t *repl)
+{
+ esp_err_t ret = ESP_OK;
+ esp_console_repl_com_t *repl_com = __containerof(repl, esp_console_repl_com_t, repl_core);
+ esp_console_repl_universal_t *usb_serial_jtag_repl = __containerof(repl_com, esp_console_repl_universal_t, repl_com);
+ // check if already de-initialized
+ if (repl_com->state == CONSOLE_REPL_STATE_DEINIT) {
+ ESP_LOGE(TAG, "already de-initialized");
+ ret = ESP_ERR_INVALID_STATE;
+ goto _exit;
+ }
+ repl_com->state = CONSOLE_REPL_STATE_DEINIT;
+ esp_console_deinit();
+ esp_vfs_usb_serial_jtag_use_nonblocking();
+ usb_serial_jtag_driver_uninstall();
+ free(usb_serial_jtag_repl);
+_exit:
+ return ret;
+}
+#endif // CONFIG_ESP_CONSOLE_USB_SERIAL_JTAG
+
+static void esp_console_repl_task(void *args)
+{
+ esp_console_repl_universal_t *repl_conf = (esp_console_repl_universal_t *) args;
+ esp_console_repl_com_t *repl_com = &repl_conf->repl_com;
+ const int uart_channel = repl_conf->uart_channel;
+
+ /* Waiting for task notify. This happens when `esp_console_start_repl()`
+ * function is called. */
+ ulTaskNotifyTake(pdTRUE, portMAX_DELAY);
+
+ if (repl_conf->repl_com.prerun_cb) {
+ repl_conf->repl_com.prerun_cb();
+ }
+
+ /* Figure out if the terminal supports escape sequences */
+ int probe_status = linenoiseProbe();
+ if (probe_status) {
+ /* zero indicates success */
+ linenoiseSetDumbMode(1);
+ }
+
+ /* Change standard input and output of the task if the requested UART is
+ * NOT the default one. This block will replace stdin, stdout and stderr.
+ */
+ if (uart_channel != CONFIG_ESP_CONSOLE_UART_NUM) {
+ char path[CONSOLE_PATH_MAX_LEN] = { 0 };
+ snprintf(path, CONSOLE_PATH_MAX_LEN, "/dev/uart/%d", uart_channel);
+
+ stdin = fopen(path, "r");
+ stdout = fopen(path, "w");
+ stderr = stdout;
+ }
+
+ /* Disable buffering on stdin of the current task.
+ * If the console is ran on a different UART than the default one,
+ * buffering shall only be disabled for the current one. */
+ setvbuf(stdin, NULL, _IONBF, 0);
+
+ /* This message shall be printed here and not earlier as the stdout
+ * has just been set above. */
+ printf("\r\n"
+ "Type 'help' to get the list of commands.\r\n"
+ "Use UP/DOWN arrows to navigate through command history.\r\n"
+ "Press TAB when typing command name to auto-complete.\r\n");
+
+ if (linenoiseIsDumbMode()) {
+ printf("\r\n"
+ "Your terminal application does not support escape sequences.\n\n"
+ "Line editing and history features are disabled.\n\n"
+ "On Windows, try using Putty instead.\r\n");
+ }
+
+ linenoiseSetMaxLineLen(repl_com->max_cmdline_length);
+ while (repl_com->state == CONSOLE_REPL_STATE_START) {
+ char *line = linenoise(repl_com->prompt);
+ if (line == NULL) {
+ ESP_LOGD(TAG, "empty line");
+ /* Ignore empty lines */
+ continue;
+ }
+ /* Add the command to the history */
+ linenoiseHistoryAdd(line);
+ /* Save command history to filesystem */
+ if (repl_com->history_save_path) {
+ linenoiseHistorySave(repl_com->history_save_path);
+ }
+
+ /* Try to run the command */
+ int ret;
+ esp_err_t err = esp_console_run(line, &ret);
+ if (err == ESP_ERR_NOT_FOUND) {
+ printf("Unrecognized command\n");
+ } else if (err == ESP_ERR_INVALID_ARG) {
+ // command was empty
+ } else if (err == ESP_OK && ret != ESP_OK) {
+ printf("Command returned non-zero error code: 0x%x (%s)\n", ret, esp_err_to_name(ret));
+ } else if (err != ESP_OK) {
+ printf("Internal error: %s\n", esp_err_to_name(err));
+ }
+ /* linenoise allocates line buffer on the heap, so need to free it */
+ linenoiseFree(line);
+ }
+ ESP_LOGD(TAG, "The End");
+ vTaskDelete(NULL);
+}
diff --git a/lib/console/linenoise/LICENSE b/lib/console/linenoise/LICENSE
new file mode 100644
index 00000000..18e81486
--- /dev/null
+++ b/lib/console/linenoise/LICENSE
@@ -0,0 +1,25 @@
+Copyright (c) 2010-2014, Salvatore Sanfilippo <antirez at gmail dot com>
+Copyright (c) 2010-2013, Pieter Noordhuis <pcnoordhuis at gmail dot com>
+
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice,
+ this list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+ this list of conditions and the following disclaimer in the documentation
+ and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
diff --git a/lib/console/linenoise/linenoise.c b/lib/console/linenoise/linenoise.c
new file mode 100644
index 00000000..221c86c2
--- /dev/null
+++ b/lib/console/linenoise/linenoise.c
@@ -0,0 +1,1318 @@
+/* linenoise.c -- guerrilla line editing library against the idea that a
+ * line editing lib needs to be 20,000 lines of C code.
+ *
+ * You can find the latest source code at:
+ *
+ * http://github.com/antirez/linenoise
+ *
+ * Does a number of crazy assumptions that happen to be true in 99.9999% of
+ * the 2010 UNIX computers around.
+ *
+ * ------------------------------------------------------------------------
+ *
+ * Copyright (c) 2010-2016, Salvatore Sanfilippo <antirez at gmail dot com>
+ * Copyright (c) 2010-2013, Pieter Noordhuis <pcnoordhuis at gmail dot com>
+ *
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are
+ * met:
+ *
+ * * Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ *
+ * * Redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in the
+ * documentation and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * ------------------------------------------------------------------------
+ *
+ * References:
+ * - http://invisible-island.net/xterm/ctlseqs/ctlseqs.html
+ * - http://www.3waylabs.com/nw/WWW/products/wizcon/vt220.html
+ *
+ * Todo list:
+ * - Filter bogus Ctrl+<char> combinations.
+ * - Win32 support
+ *
+ * Bloat:
+ * - History search like Ctrl+r in readline?
+ *
+ * List of escape sequences used by this program, we do everything just
+ * with three sequences. In order to be so cheap we may have some
+ * flickering effect with some slow terminal, but the lesser sequences
+ * the more compatible.
+ *
+ * EL (Erase Line)
+ * Sequence: ESC [ n K
+ * Effect: if n is 0 or missing, clear from cursor to end of line
+ * Effect: if n is 1, clear from beginning of line to cursor
+ * Effect: if n is 2, clear entire line
+ *
+ * CUF (CUrsor Forward)
+ * Sequence: ESC [ n C
+ * Effect: moves cursor forward n chars
+ *
+ * CUB (CUrsor Backward)
+ * Sequence: ESC [ n D
+ * Effect: moves cursor backward n chars
+ *
+ * The following is used to get the terminal width if getting
+ * the width with the TIOCGWINSZ ioctl fails
+ *
+ * DSR (Device Status Report)
+ * Sequence: ESC [ 6 n
+ * Effect: reports the current cusor position as ESC [ n ; m R
+ * where n is the row and m is the column
+ *
+ * When multi line mode is enabled, we also use an additional escape
+ * sequence. However multi line editing is disabled by default.
+ *
+ * CUU (Cursor Up)
+ * Sequence: ESC [ n A
+ * Effect: moves cursor up of n chars.
+ *
+ * CUD (Cursor Down)
+ * Sequence: ESC [ n B
+ * Effect: moves cursor down of n chars.
+ *
+ * When linenoiseClearScreen() is called, two additional escape sequences
+ * are used in order to clear the screen and position the cursor at home
+ * position.
+ *
+ * CUP (Cursor position)
+ * Sequence: ESC [ H
+ * Effect: moves the cursor to upper left corner
+ *
+ * ED (Erase display)
+ * Sequence: ESC [ 2 J
+ * Effect: clear the whole screen
+ *
+ */
+
+#include <unistd.h>
+#include <stdlib.h>
+#include <stdio.h>
+#include <stdio_ext.h>
+#include <errno.h>
+#include <string.h>
+#include <stdlib.h>
+#include <ctype.h>
+#include <sys/stat.h>
+#include <sys/types.h>
+#include <sys/fcntl.h>
+#include <unistd.h>
+#include <assert.h>
+#include "linenoise.h"
+
+#define LINENOISE_DEFAULT_HISTORY_MAX_LEN 100
+#define LINENOISE_DEFAULT_MAX_LINE 4096
+#define LINENOISE_MINIMAL_MAX_LINE 64
+#define LINENOISE_COMMAND_MAX_LEN 32
+#define LINENOISE_PASTE_KEY_DELAY 30 /* Delay, in milliseconds, between two characters being pasted from clipboard */
+
+static linenoiseCompletionCallback *completionCallback = NULL;
+static linenoiseHintsCallback *hintsCallback = NULL;
+static linenoiseFreeHintsCallback *freeHintsCallback = NULL;
+
+static size_t max_cmdline_length = LINENOISE_DEFAULT_MAX_LINE;
+static int mlmode = 0; /* Multi line mode. Default is single line. */
+static int dumbmode = 0; /* Dumb mode where line editing is disabled. Off by default */
+static int history_max_len = LINENOISE_DEFAULT_HISTORY_MAX_LEN;
+static int history_len = 0;
+static char **history = NULL;
+static bool allow_empty = true;
+
+/* The linenoiseState structure represents the state during line editing.
+ * We pass this state to functions implementing specific editing
+ * functionalities. */
+struct linenoiseState {
+ char *buf; /* Edited line buffer. */
+ size_t buflen; /* Edited line buffer size. */
+ const char *prompt; /* Prompt to display. */
+ size_t plen; /* Prompt length. */
+ size_t pos; /* Current cursor position. */
+ size_t oldpos; /* Previous refresh cursor position. */
+ size_t len; /* Current edited line length. */
+ size_t cols; /* Number of columns in terminal. */
+ size_t maxrows; /* Maximum num of rows used so far (multiline mode) */
+ int history_index; /* The history index we are currently editing. */
+};
+
+enum KEY_ACTION{
+ KEY_NULL = 0, /* NULL */
+ CTRL_A = 1, /* Ctrl+a */
+ CTRL_B = 2, /* Ctrl-b */
+ CTRL_C = 3, /* Ctrl-c */
+ CTRL_D = 4, /* Ctrl-d */
+ CTRL_E = 5, /* Ctrl-e */
+ CTRL_F = 6, /* Ctrl-f */
+ CTRL_H = 8, /* Ctrl-h */
+ TAB = 9, /* Tab */
+ CTRL_K = 11, /* Ctrl+k */
+ CTRL_L = 12, /* Ctrl+l */
+ ENTER = 10, /* Enter */
+ CTRL_N = 14, /* Ctrl-n */
+ CTRL_P = 16, /* Ctrl-p */
+ CTRL_T = 20, /* Ctrl-t */
+ CTRL_U = 21, /* Ctrl+u */
+ CTRL_W = 23, /* Ctrl+w */
+ ESC = 27, /* Escape */
+ BACKSPACE = 127 /* Backspace */
+};
+
+int linenoiseHistoryAdd(const char *line);
+static void refreshLine(struct linenoiseState *l);
+
+/* Debugging macro. */
+#if 0
+FILE *lndebug_fp = NULL;
+#define lndebug(...) \
+ do { \
+ if (lndebug_fp == NULL) { \
+ lndebug_fp = fopen("/tmp/lndebug.txt","a"); \
+ fprintf(lndebug_fp, \
+ "[%d %d %d] p: %d, rows: %d, rpos: %d, max: %d, oldmax: %d\n", \
+ (int)l->len,(int)l->pos,(int)l->oldpos,plen,rows,rpos, \
+ (int)l->maxrows,old_rows); \
+ } \
+ fprintf(lndebug_fp, ", " __VA_ARGS__); \
+ fflush(lndebug_fp); \
+ } while (0)
+#else
+#define lndebug(fmt, ...)
+#endif
+
+/* ======================= Low level terminal handling ====================== */
+
+/* Set if to use or not the multi line mode. */
+void linenoiseSetMultiLine(int ml) {
+ mlmode = ml;
+}
+
+/* Set if terminal does not recognize escape sequences */
+void linenoiseSetDumbMode(int set) {
+ dumbmode = set;
+}
+
+/* Returns whether the current mode is dumbmode or not. */
+bool linenoiseIsDumbMode(void) {
+ return dumbmode;
+}
+
+static void flushWrite(void) {
+ if (__fbufsize(stdout) > 0) {
+ fflush(stdout);
+ }
+ fsync(fileno(stdout));
+}
+
+/* Use the ESC [6n escape sequence to query the horizontal cursor position
+ * and return it. On error -1 is returned, on success the position of the
+ * cursor. */
+static int getCursorPosition(void) {
+ char buf[LINENOISE_COMMAND_MAX_LEN] = { 0 };
+ int cols = 0;
+ int rows = 0;
+ int i = 0;
+ const int out_fd = fileno(stdout);
+ const int in_fd = fileno(stdin);
+ /* The following ANSI escape sequence is used to get from the TTY the
+ * cursor position. */
+ const char get_cursor_cmd[] = "\x1b[6n";
+
+ /* Send the command to the TTY on the other end of the UART.
+ * Let's use unistd's write function. Thus, data sent through it are raw
+ * reducing the overhead compared to using fputs, fprintf, etc... */
+ write(out_fd, get_cursor_cmd, sizeof(get_cursor_cmd));
+
+ /* For USB CDC, it is required to flush the output. */
+ flushWrite();
+
+ /* The other end will send its response which format is ESC [ rows ; cols R
+ * We don't know exactly how many bytes we have to read, thus, perform a
+ * read for each byte.
+ * Stop right before the last character of the buffer, to be able to NULL
+ * terminate it. */
+ while (i < sizeof(buf)-1) {
+ /* Keep using unistd's functions. Here, using `read` instead of `fgets`
+ * or `fgets` guarantees us that we we can read a byte regardless on
+ * whether the sender sent end of line character(s) (CR, CRLF, LF). */
+ if (read(in_fd, buf + i, 1) != 1 || buf[i] == 'R') {
+ /* If we couldn't read a byte from STDIN or if 'R' was received,
+ * the transmission is finished. */
+ break;
+ }
+
+ /* For some reasons, it is possible that we receive new line character
+ * after querying the cursor position on some UART. Let's ignore them,
+ * this will not affect the rest of the program. */
+ if (buf[i] != '\n') {
+ i++;
+ }
+ }
+
+ /* NULL-terminate the buffer, this is required by `sscanf`. */
+ buf[i] = '\0';
+
+ /* Parse the received data to get the position of the cursor. */
+ if (buf[0] != ESC || buf[1] != '[' || sscanf(buf+2,"%d;%d",&rows,&cols) != 2) {
+ return -1;
+ }
+ return cols;
+}
+
+/* Try to get the number of columns in the current terminal, or assume 80
+ * if it fails. */
+static int getColumns(void) {
+ int start = 0;
+ int cols = 0;
+ int written = 0;
+ char seq[LINENOISE_COMMAND_MAX_LEN] = { 0 };
+ const int fd = fileno(stdout);
+
+ /* The following ANSI escape sequence is used to tell the TTY to move
+ * the cursor to the most-right position. */
+ const char move_cursor_right[] = "\x1b[999C";
+ const size_t cmd_len = sizeof(move_cursor_right);
+
+ /* This one is used to set the cursor position. */
+ const char set_cursor_pos[] = "\x1b[%dD";
+
+ /* Get the initial position so we can restore it later. */
+ start = getCursorPosition();
+ if (start == -1) {
+ goto failed;
+ }
+
+ /* Send the command to go to right margin. Use `write` function instead of
+ * `fwrite` for the same reasons explained in `getCursorPosition()` */
+ if (write(fd, move_cursor_right, cmd_len) != cmd_len) {
+ goto failed;
+ }
+ flushWrite();
+
+ /* After sending this command, we can get the new position of the cursor,
+ * we'd get the size, in columns, of the opened TTY. */
+ cols = getCursorPosition();
+ if (cols == -1) {
+ goto failed;
+ }
+
+ /* Restore the position of the cursor back. */
+ if (cols > start) {
+ /* Generate the move cursor command. */
+ written = snprintf(seq, LINENOISE_COMMAND_MAX_LEN, set_cursor_pos, cols-start);
+
+ /* If `written` is equal or bigger than LINENOISE_COMMAND_MAX_LEN, it
+ * means that the output has been truncated because the size provided
+ * is too small. */
+ assert (written < LINENOISE_COMMAND_MAX_LEN);
+
+ /* Send the command with `write`, which is not buffered. */
+ if (write(fd, seq, written) == -1) {
+ /* Can't recover... */
+ }
+ flushWrite();
+ }
+ return cols;
+
+failed:
+ return 80;
+}
+
+/* Clear the screen. Used to handle ctrl+l */
+void linenoiseClearScreen(void) {
+ fprintf(stdout,"\x1b[H\x1b[2J");
+ flushWrite();
+}
+
+/* Beep, used for completion when there is nothing to complete or when all
+ * the choices were already shown. */
+static void linenoiseBeep(void) {
+ fprintf(stdout, "\x7");
+ flushWrite();
+}
+
+/* ============================== Completion ================================ */
+
+/* Free a list of completion option populated by linenoiseAddCompletion(). */
+static void freeCompletions(linenoiseCompletions *lc) {
+ size_t i;
+ for (i = 0; i < lc->len; i++)
+ free(lc->cvec[i]);
+ if (lc->cvec != NULL)
+ free(lc->cvec);
+}
+
+/* This is an helper function for linenoiseEdit() and is called when the
+ * user types the <tab> key in order to complete the string currently in the
+ * input.
+ *
+ * The state of the editing is encapsulated into the pointed linenoiseState
+ * structure as described in the structure definition. */
+static int completeLine(struct linenoiseState *ls) {
+ linenoiseCompletions lc = { 0, NULL };
+ int nread, nwritten;
+ char c = 0;
+ int in_fd = fileno(stdin);
+
+ completionCallback(ls->buf,&lc);
+ if (lc.len == 0) {
+ linenoiseBeep();
+ } else {
+ size_t stop = 0, i = 0;
+
+ while(!stop) {
+ /* Show completion or original buffer */
+ if (i < lc.len) {
+ struct linenoiseState saved = *ls;
+
+ ls->len = ls->pos = strlen(lc.cvec[i]);
+ ls->buf = lc.cvec[i];
+ refreshLine(ls);
+ ls->len = saved.len;
+ ls->pos = saved.pos;
+ ls->buf = saved.buf;
+ } else {
+ refreshLine(ls);
+ }
+
+ nread = read(in_fd, &c, 1);
+ if (nread <= 0) {
+ freeCompletions(&lc);
+ return -1;
+ }
+
+ switch(c) {
+ case TAB: /* tab */
+ i = (i+1) % (lc.len+1);
+ if (i == lc.len) linenoiseBeep();
+ break;
+ case ESC: /* escape */
+ /* Re-show original buffer */
+ if (i < lc.len) refreshLine(ls);
+ stop = 1;
+ break;
+ default:
+ /* Update buffer and return */
+ if (i < lc.len) {
+ nwritten = snprintf(ls->buf,ls->buflen,"%s",lc.cvec[i]);
+ ls->len = ls->pos = nwritten;
+ }
+ stop = 1;
+ break;
+ }
+ }
+ }
+
+ freeCompletions(&lc);
+ return c; /* Return last read character */
+}
+
+/* Register a callback function to be called for tab-completion. */
+void linenoiseSetCompletionCallback(linenoiseCompletionCallback *fn) {
+ completionCallback = fn;
+}
+
+/* Register a hits function to be called to show hits to the user at the
+ * right of the prompt. */
+void linenoiseSetHintsCallback(linenoiseHintsCallback *fn) {
+ hintsCallback = fn;
+}
+
+/* Register a function to free the hints returned by the hints callback
+ * registered with linenoiseSetHintsCallback(). */
+void linenoiseSetFreeHintsCallback(linenoiseFreeHintsCallback *fn) {
+ freeHintsCallback = fn;
+}
+
+/* This function is used by the callback function registered by the user
+ * in order to add completion options given the input string when the
+ * user typed <tab>. See the example.c source code for a very easy to
+ * understand example. */
+void linenoiseAddCompletion(linenoiseCompletions *lc, const char *str) {
+ size_t len = strlen(str);
+ char *copy, **cvec;
+
+ copy = malloc(len+1);
+ if (copy == NULL) return;
+ memcpy(copy,str,len+1);
+ cvec = realloc(lc->cvec,sizeof(char*)*(lc->len+1));
+ if (cvec == NULL) {
+ free(copy);
+ return;
+ }
+ lc->cvec = cvec;
+ lc->cvec[lc->len++] = copy;
+}
+
+/* =========================== Line editing ================================= */
+
+/* We define a very simple "append buffer" structure, that is an heap
+ * allocated string where we can append to. This is useful in order to
+ * write all the escape sequences in a buffer and flush them to the standard
+ * output in a single call, to avoid flickering effects. */
+struct abuf {
+ char *b;
+ int len;
+};
+
+static void abInit(struct abuf *ab) {
+ ab->b = NULL;
+ ab->len = 0;
+}
+
+static void abAppend(struct abuf *ab, const char *s, int len) {
+ char *new = realloc(ab->b,ab->len+len);
+
+ if (new == NULL) return;
+ memcpy(new+ab->len,s,len);
+ ab->b = new;
+ ab->len += len;
+}
+
+static void abFree(struct abuf *ab) {
+ free(ab->b);
+}
+
+/* Helper of refreshSingleLine() and refreshMultiLine() to show hints
+ * to the right of the prompt. */
+void refreshShowHints(struct abuf *ab, struct linenoiseState *l, int plen) {
+ char seq[64];
+ if (hintsCallback && plen+l->len < l->cols) {
+ int color = -1, bold = 0;
+ char *hint = hintsCallback(l->buf,&color,&bold);
+ if (hint) {
+ int hintlen = strlen(hint);
+ int hintmaxlen = l->cols-(plen+l->len);
+ if (hintlen > hintmaxlen) hintlen = hintmaxlen;
+ if (bold == 1 && color == -1) color = 37;
+ if (color != -1 || bold != 0) {
+ snprintf(seq,64,"\033[%d;%d;49m",bold,color);
+ abAppend(ab,seq,strlen(seq));
+ }
+ abAppend(ab,hint,hintlen);
+ if (color != -1 || bold != 0)
+ abAppend(ab,"\033[0m",4);
+ /* Call the function to free the hint returned. */
+ if (freeHintsCallback) freeHintsCallback(hint);
+ }
+ }
+}
+
+/* Single line low level line refresh.
+ *
+ * Rewrite the currently edited line accordingly to the buffer content,
+ * cursor position, and number of columns of the terminal. */
+static void refreshSingleLine(struct linenoiseState *l) {
+ char seq[64];
+ size_t plen = l->plen;
+ int fd = fileno(stdout);
+ char *buf = l->buf;
+ size_t len = l->len;
+ size_t pos = l->pos;
+ struct abuf ab;
+
+ while((plen+pos) >= l->cols) {
+ buf++;
+ len--;
+ pos--;
+ }
+ while (plen+len > l->cols) {
+ len--;
+ }
+
+ abInit(&ab);
+ /* Cursor to left edge */
+ snprintf(seq,64,"\r");
+ abAppend(&ab,seq,strlen(seq));
+ /* Write the prompt and the current buffer content */
+ abAppend(&ab,l->prompt,strlen(l->prompt));
+ abAppend(&ab,buf,len);
+ /* Show hits if any. */
+ refreshShowHints(&ab,l,plen);
+ /* Erase to right */
+ snprintf(seq,64,"\x1b[0K");
+ abAppend(&ab,seq,strlen(seq));
+ /* Move cursor to original position. */
+ snprintf(seq,64,"\r\x1b[%dC", (int)(pos+plen));
+ abAppend(&ab,seq,strlen(seq));
+ if (write(fd, ab.b, ab.len) == -1) {} /* Can't recover from write error. */
+ flushWrite();
+ abFree(&ab);
+}
+
+/* Multi line low level line refresh.
+ *
+ * Rewrite the currently edited line accordingly to the buffer content,
+ * cursor position, and number of columns of the terminal. */
+static void refreshMultiLine(struct linenoiseState *l) {
+ char seq[64];
+ int plen = l->plen;
+ int rows = (plen+l->len+l->cols-1)/l->cols; /* rows used by current buf. */
+ int rpos = (plen+l->oldpos+l->cols)/l->cols; /* cursor relative row. */
+ int rpos2; /* rpos after refresh. */
+ int col; /* colum position, zero-based. */
+ int old_rows = l->maxrows;
+ int j;
+ int fd = fileno(stdout);
+ struct abuf ab;
+
+ /* Update maxrows if needed. */
+ if (rows > (int)l->maxrows) l->maxrows = rows;
+
+ /* First step: clear all the lines used before. To do so start by
+ * going to the last row. */
+ abInit(&ab);
+ if (old_rows-rpos > 0) {
+ lndebug("go down %d", old_rows-rpos);
+ snprintf(seq,64,"\x1b[%dB", old_rows-rpos);
+ abAppend(&ab,seq,strlen(seq));
+ }
+
+ /* Now for every row clear it, go up. */
+ for (j = 0; j < old_rows-1; j++) {
+ lndebug("clear+up");
+ snprintf(seq,64,"\r\x1b[0K\x1b[1A");
+ abAppend(&ab,seq,strlen(seq));
+ }
+
+ /* Clean the top line. */
+ lndebug("clear");
+ snprintf(seq,64,"\r\x1b[0K");
+ abAppend(&ab,seq,strlen(seq));
+
+ /* Write the prompt and the current buffer content */
+ abAppend(&ab,l->prompt,strlen(l->prompt));
+ abAppend(&ab,l->buf,l->len);
+
+ /* Show hits if any. */
+ refreshShowHints(&ab,l,plen);
+
+ /* If we are at the very end of the screen with our prompt, we need to
+ * emit a newline and move the prompt to the first column. */
+ if (l->pos &&
+ l->pos == l->len &&
+ (l->pos+plen) % l->cols == 0)
+ {
+ lndebug("<newline>");
+ abAppend(&ab,"\n",1);
+ snprintf(seq,64,"\r");
+ abAppend(&ab,seq,strlen(seq));
+ rows++;
+ if (rows > (int)l->maxrows) l->maxrows = rows;
+ }
+
+ /* Move cursor to right position. */
+ rpos2 = (plen+l->pos+l->cols)/l->cols; /* current cursor relative row. */
+ lndebug("rpos2 %d", rpos2);
+
+ /* Go up till we reach the expected positon. */
+ if (rows-rpos2 > 0) {
+ lndebug("go-up %d", rows-rpos2);
+ snprintf(seq,64,"\x1b[%dA", rows-rpos2);
+ abAppend(&ab,seq,strlen(seq));
+ }
+
+ /* Set column. */
+ col = (plen+(int)l->pos) % (int)l->cols;
+ lndebug("set col %d", 1+col);
+ if (col)
+ snprintf(seq,64,"\r\x1b[%dC", col);
+ else
+ snprintf(seq,64,"\r");
+ abAppend(&ab,seq,strlen(seq));
+
+ lndebug("\n");
+ l->oldpos = l->pos;
+
+ if (write(fd,ab.b,ab.len) == -1) {} /* Can't recover from write error. */
+ flushWrite();
+ abFree(&ab);
+}
+
+/* Calls the two low level functions refreshSingleLine() or
+ * refreshMultiLine() according to the selected mode. */
+static void refreshLine(struct linenoiseState *l) {
+ if (mlmode)
+ refreshMultiLine(l);
+ else
+ refreshSingleLine(l);
+}
+
+/* Insert the character 'c' at cursor current position.
+ *
+ * On error writing to the terminal -1 is returned, otherwise 0. */
+int linenoiseEditInsert(struct linenoiseState *l, char c) {
+ int fd = fileno(stdout);
+ if (l->len < l->buflen) {
+ if (l->len == l->pos) {
+ l->buf[l->pos] = c;
+ l->pos++;
+ l->len++;
+ l->buf[l->len] = '\0';
+ if ((!mlmode && l->plen+l->len < l->cols && !hintsCallback)) {
+ /* Avoid a full update of the line in the
+ * trivial case. */
+ if (write(fd, &c,1) == -1) {
+ return -1;
+ }
+ flushWrite();
+ } else {
+ refreshLine(l);
+ }
+ } else {
+ memmove(l->buf+l->pos+1,l->buf+l->pos,l->len-l->pos);
+ l->buf[l->pos] = c;
+ l->len++;
+ l->pos++;
+ l->buf[l->len] = '\0';
+ refreshLine(l);
+ }
+ }
+ return 0;
+}
+
+int linenoiseInsertPastedChar(struct linenoiseState *l, char c) {
+ int fd = fileno(stdout);
+ if (l->len < l->buflen && l->len == l->pos) {
+ l->buf[l->pos] = c;
+ l->pos++;
+ l->len++;
+ l->buf[l->len] = '\0';
+ if (write(fd, &c,1) == -1) {
+ return -1;
+ }
+ flushWrite();
+ }
+ return 0;
+}
+
+/* Move cursor on the left. */
+void linenoiseEditMoveLeft(struct linenoiseState *l) {
+ if (l->pos > 0) {
+ l->pos--;
+ refreshLine(l);
+ }
+}
+
+/* Move cursor on the right. */
+void linenoiseEditMoveRight(struct linenoiseState *l) {
+ if (l->pos != l->len) {
+ l->pos++;
+ refreshLine(l);
+ }
+}
+
+/* Move cursor to the start of the line. */
+void linenoiseEditMoveHome(struct linenoiseState *l) {
+ if (l->pos != 0) {
+ l->pos = 0;
+ refreshLine(l);
+ }
+}
+
+/* Move cursor to the end of the line. */
+void linenoiseEditMoveEnd(struct linenoiseState *l) {
+ if (l->pos != l->len) {
+ l->pos = l->len;
+ refreshLine(l);
+ }
+}
+
+/* Substitute the currently edited line with the next or previous history
+ * entry as specified by 'dir'. */
+#define LINENOISE_HISTORY_NEXT 0
+#define LINENOISE_HISTORY_PREV 1
+void linenoiseEditHistoryNext(struct linenoiseState *l, int dir) {
+ if (history_len > 1) {
+ /* Update the current history entry before to
+ * overwrite it with the next one. */
+ free(history[history_len - 1 - l->history_index]);
+ history[history_len - 1 - l->history_index] = strdup(l->buf);
+ /* Show the new entry */
+ l->history_index += (dir == LINENOISE_HISTORY_PREV) ? 1 : -1;
+ if (l->history_index < 0) {
+ l->history_index = 0;
+ return;
+ } else if (l->history_index >= history_len) {
+ l->history_index = history_len-1;
+ return;
+ }
+ strncpy(l->buf,history[history_len - 1 - l->history_index],l->buflen);
+ l->buf[l->buflen-1] = '\0';
+ l->len = l->pos = strlen(l->buf);
+ refreshLine(l);
+ }
+}
+
+/* Delete the character at the right of the cursor without altering the cursor
+ * position. Basically this is what happens with the "Delete" keyboard key. */
+void linenoiseEditDelete(struct linenoiseState *l) {
+ if (l->len > 0 && l->pos < l->len) {
+ memmove(l->buf+l->pos,l->buf+l->pos+1,l->len-l->pos-1);
+ l->len--;
+ l->buf[l->len] = '\0';
+ refreshLine(l);
+ }
+}
+
+/* Backspace implementation. */
+void linenoiseEditBackspace(struct linenoiseState *l) {
+ if (l->pos > 0 && l->len > 0) {
+ memmove(l->buf+l->pos-1,l->buf+l->pos,l->len-l->pos);
+ l->pos--;
+ l->len--;
+ l->buf[l->len] = '\0';
+ refreshLine(l);
+ }
+}
+
+/* Delete the previosu word, maintaining the cursor at the start of the
+ * current word. */
+void linenoiseEditDeletePrevWord(struct linenoiseState *l) {
+ size_t old_pos = l->pos;
+ size_t diff;
+
+ while (l->pos > 0 && l->buf[l->pos-1] == ' ')
+ l->pos--;
+ while (l->pos > 0 && l->buf[l->pos-1] != ' ')
+ l->pos--;
+ diff = old_pos - l->pos;
+ memmove(l->buf+l->pos,l->buf+old_pos,l->len-old_pos+1);
+ l->len -= diff;
+ refreshLine(l);
+}
+
+uint32_t getMillis(void) {
+ struct timeval tv = { 0 };
+ gettimeofday(&tv, NULL);
+ return tv.tv_sec * 1000 + tv.tv_usec / 1000;
+}
+
+static inline size_t prompt_len_ignore_escape_seq(const char *prompt) {
+ size_t plen = 0;
+ bool in_escape_sequence = false;
+
+ for (; *prompt != '\0'; ++prompt) {
+ if (*prompt == '\033') {
+ in_escape_sequence = true;
+ } else if (in_escape_sequence && *prompt == 'm') {
+ in_escape_sequence = false;
+ } else if (!in_escape_sequence) {
+ ++plen;
+ }
+ }
+
+ return plen;
+}
+
+/* This function is the core of the line editing capability of linenoise.
+ * It expects 'fd' to be already in "raw mode" so that every key pressed
+ * will be returned ASAP to read().
+ *
+ * The resulting string is put into 'buf' when the user type enter, or
+ * when ctrl+d is typed.
+ *
+ * The function returns the length of the current buffer. */
+static int linenoiseEdit(char *buf, size_t buflen, const char *prompt)
+{
+ uint32_t t1 = 0;
+ struct linenoiseState l;
+ int out_fd = fileno(stdout);
+ int in_fd = fileno(stdin);
+
+ /* Populate the linenoise state that we pass to functions implementing
+ * specific editing functionalities. */
+ l.buf = buf;
+ l.buflen = buflen;
+ l.prompt = prompt;
+ l.plen = strlen(prompt);
+ l.oldpos = l.pos = 0;
+ l.len = 0;
+ l.cols = getColumns();
+ l.maxrows = 0;
+ l.history_index = 0;
+
+ /* Buffer starts empty. */
+ l.buf[0] = '\0';
+ l.buflen--; /* Make sure there is always space for the nulterm */
+
+ /* The latest history entry is always our current buffer, that
+ * initially is just an empty string. */
+ linenoiseHistoryAdd("");
+
+ if (write(out_fd, prompt,l.plen) == -1) {
+ return -1;
+ }
+ flushWrite();
+
+ /* If the prompt has been registered with ANSI escape sequences
+ * for terminal colors then we remove them from the prompt length
+ * calculation. */
+ l.plen = prompt_len_ignore_escape_seq(prompt);
+
+ while(1) {
+ char c;
+ int nread;
+ char seq[3];
+
+ /**
+ * To determine whether the user is pasting data or typing itself, we
+ * need to calculate how many milliseconds elapsed between two key
+ * presses. Indeed, if there is less than LINENOISE_PASTE_KEY_DELAY
+ * (typically 30-40ms), then a paste is being performed, else, the
+ * user is typing.
+ * NOTE: pressing a key down without releasing it will also spend
+ * about 40ms (or even more)
+ */
+ t1 = getMillis();
+ nread = read(in_fd, &c, 1);
+ if (nread <= 0) return l.len;
+
+ if ( (getMillis() - t1) < LINENOISE_PASTE_KEY_DELAY && c != ENTER) {
+ /* Pasting data, insert characters without formatting.
+ * This can only be performed when the cursor is at the end of the
+ * line. */
+ if (linenoiseInsertPastedChar(&l,c)) {
+ return -1;
+ }
+ continue;
+ }
+
+ /* Only autocomplete when the callback is set. It returns < 0 when
+ * there was an error reading from fd. Otherwise it will return the
+ * character that should be handled next. */
+ if (c == 9 && completionCallback != NULL) {
+ int c2 = completeLine(&l);
+ /* Return on errors */
+ if (c2 < 0) return l.len;
+ /* Read next character when 0 */
+ if (c2 == 0) continue;
+ c = c2;
+ }
+
+ switch(c) {
+ case ENTER: /* enter */
+ history_len--;
+ free(history[history_len]);
+ if (mlmode) linenoiseEditMoveEnd(&l);
+ if (hintsCallback) {
+ /* Force a refresh without hints to leave the previous
+ * line as the user typed it after a newline. */
+ linenoiseHintsCallback *hc = hintsCallback;
+ hintsCallback = NULL;
+ refreshLine(&l);
+ hintsCallback = hc;
+ }
+ return (int)l.len;
+ case CTRL_C: /* ctrl-c */
+ errno = EAGAIN;
+ return -1;
+ case BACKSPACE: /* backspace */
+ case 8: /* ctrl-h */
+ linenoiseEditBackspace(&l);
+ break;
+ case CTRL_D: /* ctrl-d, remove char at right of cursor, or if the
+ line is empty, act as end-of-file. */
+ if (l.len > 0) {
+ linenoiseEditDelete(&l);
+ } else {
+ history_len--;
+ free(history[history_len]);
+ return -1;
+ }
+ break;
+ case CTRL_T: /* ctrl-t, swaps current character with previous. */
+ if (l.pos > 0 && l.pos < l.len) {
+ int aux = buf[l.pos-1];
+ buf[l.pos-1] = buf[l.pos];
+ buf[l.pos] = aux;
+ if (l.pos != l.len-1) l.pos++;
+ refreshLine(&l);
+ }
+ break;
+ case CTRL_B: /* ctrl-b */
+ linenoiseEditMoveLeft(&l);
+ break;
+ case CTRL_F: /* ctrl-f */
+ linenoiseEditMoveRight(&l);
+ break;
+ case CTRL_P: /* ctrl-p */
+ linenoiseEditHistoryNext(&l, LINENOISE_HISTORY_PREV);
+ break;
+ case CTRL_N: /* ctrl-n */
+ linenoiseEditHistoryNext(&l, LINENOISE_HISTORY_NEXT);
+ break;
+ case ESC: /* escape sequence */
+ /* Read the next two bytes representing the escape sequence. */
+ if (read(in_fd, seq, 2) < 2) {
+ break;
+ }
+
+ /* ESC [ sequences. */
+ if (seq[0] == '[') {
+ if (seq[1] >= '0' && seq[1] <= '9') {
+ /* Extended escape, read additional byte. */
+ if (read(in_fd, seq+2, 1) == -1) {
+ break;
+ }
+ if (seq[2] == '~') {
+ switch(seq[1]) {
+ case '3': /* Delete key. */
+ linenoiseEditDelete(&l);
+ break;
+ }
+ }
+ } else {
+ switch(seq[1]) {
+ case 'A': /* Up */
+ linenoiseEditHistoryNext(&l, LINENOISE_HISTORY_PREV);
+ break;
+ case 'B': /* Down */
+ linenoiseEditHistoryNext(&l, LINENOISE_HISTORY_NEXT);
+ break;
+ case 'C': /* Right */
+ linenoiseEditMoveRight(&l);
+ break;
+ case 'D': /* Left */
+ linenoiseEditMoveLeft(&l);
+ break;
+ case 'H': /* Home */
+ linenoiseEditMoveHome(&l);
+ break;
+ case 'F': /* End*/
+ linenoiseEditMoveEnd(&l);
+ break;
+ }
+ }
+ }
+
+ /* ESC O sequences. */
+ else if (seq[0] == 'O') {
+ switch(seq[1]) {
+ case 'H': /* Home */
+ linenoiseEditMoveHome(&l);
+ break;
+ case 'F': /* End*/
+ linenoiseEditMoveEnd(&l);
+ break;
+ }
+ }
+ break;
+ default:
+ if (linenoiseEditInsert(&l,c)) return -1;
+ break;
+ case CTRL_U: /* Ctrl+u, delete the whole line. */
+ buf[0] = '\0';
+ l.pos = l.len = 0;
+ refreshLine(&l);
+ break;
+ case CTRL_K: /* Ctrl+k, delete from current to end of line. */
+ buf[l.pos] = '\0';
+ l.len = l.pos;
+ refreshLine(&l);
+ break;
+ case CTRL_A: /* Ctrl+a, go to the start of the line */
+ linenoiseEditMoveHome(&l);
+ break;
+ case CTRL_E: /* ctrl+e, go to the end of the line */
+ linenoiseEditMoveEnd(&l);
+ break;
+ case CTRL_L: /* ctrl+l, clear screen */
+ linenoiseClearScreen();
+ refreshLine(&l);
+ break;
+ case CTRL_W: /* ctrl+w, delete previous word */
+ linenoiseEditDeletePrevWord(&l);
+ break;
+ }
+ flushWrite();
+ }
+ return l.len;
+}
+
+void linenoiseAllowEmpty(bool val) {
+ allow_empty = val;
+}
+
+int linenoiseProbe(void) {
+ /* Switch to non-blocking mode */
+ int stdin_fileno = fileno(stdin);
+ int flags = fcntl(stdin_fileno, F_GETFL);
+ flags |= O_NONBLOCK;
+ int res = fcntl(stdin_fileno, F_SETFL, flags);
+ if (res != 0) {
+ return -1;
+ }
+ /* Device status request */
+ fprintf(stdout, "\x1b[5n");
+ flushWrite();
+
+ /* Try to read response */
+ int timeout_ms = 500;
+ const int retry_ms = 10;
+ size_t read_bytes = 0;
+ while (timeout_ms > 0 && read_bytes < 4) { // response is ESC[0n or ESC[3n
+ usleep(retry_ms * 1000);
+ timeout_ms -= retry_ms;
+ char c;
+ int cb = read(stdin_fileno, &c, 1);
+ if (cb < 0) {
+ continue;
+ }
+ if (read_bytes == 0 && c != '\x1b') {
+ /* invalid response */
+ break;
+ }
+ read_bytes += cb;
+ }
+ /* Restore old mode */
+ flags &= ~O_NONBLOCK;
+ res = fcntl(stdin_fileno, F_SETFL, flags);
+ if (res != 0) {
+ return -1;
+ }
+ if (read_bytes < 4) {
+ return -2;
+ }
+ return 0;
+}
+
+static int linenoiseRaw(char *buf, size_t buflen, const char *prompt) {
+ int count;
+
+ if (buflen == 0) {
+ errno = EINVAL;
+ return -1;
+ }
+
+ count = linenoiseEdit(buf, buflen, prompt);
+ fputc('\n', stdout);
+ flushWrite();
+ return count;
+}
+
+static int linenoiseDumb(char* buf, size_t buflen, const char* prompt) {
+ /* dumb terminal, fall back to fgets */
+ fputs(prompt, stdout);
+ flushWrite();
+ size_t count = 0;
+ while (count < buflen) {
+ int c = fgetc(stdin);
+ if (c == '\n') {
+ break;
+ } else if (c >= 0x1c && c <= 0x1f){
+ continue; /* consume arrow keys */
+ } else if (c == BACKSPACE || c == 0x8) {
+ if (count > 0) {
+ buf[count - 1] = 0;
+ count --;
+ }
+ fputs("\x08 ", stdout); /* Windows CMD: erase symbol under cursor */
+ flushWrite();
+ } else {
+ buf[count] = c;
+ ++count;
+ }
+ fputc(c, stdout); /* echo */
+ flushWrite();
+ }
+ fputc('\n', stdout);
+ flushWrite();
+ return count;
+}
+
+static void sanitize(char* src) {
+ char* dst = src;
+ for (int c = *src; c != 0; src++, c = *src) {
+ if (isprint(c)) {
+ *dst = c;
+ ++dst;
+ }
+ }
+ *dst = 0;
+}
+
+/* The high level function that is the main API of the linenoise library. */
+char *linenoise(const char *prompt) {
+ char *buf = calloc(1, max_cmdline_length);
+ int count = 0;
+ if (buf == NULL) {
+ return NULL;
+ }
+ if (!dumbmode) {
+ count = linenoiseRaw(buf, max_cmdline_length, prompt);
+ } else {
+ count = linenoiseDumb(buf, max_cmdline_length, prompt);
+ }
+ if (count > 0) {
+ sanitize(buf);
+ count = strlen(buf);
+ } else if (count == 0 && allow_empty) {
+ /* will return an empty (0-length) string */
+ } else {
+ free(buf);
+ return NULL;
+ }
+ return buf;
+}
+
+/* This is just a wrapper the user may want to call in order to make sure
+ * the linenoise returned buffer is freed with the same allocator it was
+ * created with. Useful when the main program is using an alternative
+ * allocator. */
+void linenoiseFree(void *ptr) {
+ free(ptr);
+}
+
+/* ================================ History ================================= */
+
+void linenoiseHistoryFree(void) {
+ if (history) {
+ for (int j = 0; j < history_len; j++) {
+ free(history[j]);
+ }
+ free(history);
+ }
+ history = NULL;
+}
+
+/* This is the API call to add a new entry in the linenoise history.
+ * It uses a fixed array of char pointers that are shifted (memmoved)
+ * when the history max length is reached in order to remove the older
+ * entry and make room for the new one, so it is not exactly suitable for huge
+ * histories, but will work well for a few hundred of entries.
+ *
+ * Using a circular buffer is smarter, but a bit more complex to handle. */
+int linenoiseHistoryAdd(const char *line) {
+ char *linecopy;
+
+ if (history_max_len == 0) return 0;
+
+ /* Initialization on first call. */
+ if (history == NULL) {
+ history = malloc(sizeof(char*)*history_max_len);
+ if (history == NULL) return 0;
+ memset(history,0,(sizeof(char*)*history_max_len));
+ }
+
+ /* Don't add duplicated lines. */
+ if (history_len && !strcmp(history[history_len-1], line)) return 0;
+
+ /* Add an heap allocated copy of the line in the history.
+ * If we reached the max length, remove the older line. */
+ linecopy = strdup(line);
+ if (!linecopy) return 0;
+ if (history_len == history_max_len) {
+ free(history[0]);
+ memmove(history,history+1,sizeof(char*)*(history_max_len-1));
+ history_len--;
+ }
+ history[history_len] = linecopy;
+ history_len++;
+ return 1;
+}
+
+/* Set the maximum length for the history. This function can be called even
+ * if there is already some history, the function will make sure to retain
+ * just the latest 'len' elements if the new history length value is smaller
+ * than the amount of items already inside the history. */
+int linenoiseHistorySetMaxLen(int len) {
+ char **new;
+
+ if (len < 1) return 0;
+ if (history) {
+ int tocopy = history_len;
+
+ new = malloc(sizeof(char*)*len);
+ if (new == NULL) return 0;
+
+ /* If we can't copy everything, free the elements we'll not use. */
+ if (len < tocopy) {
+ int j;
+
+ for (j = 0; j < tocopy-len; j++) free(history[j]);
+ tocopy = len;
+ }
+ memset(new,0,sizeof(char*)*len);
+ memcpy(new,history+(history_len-tocopy), sizeof(char*)*tocopy);
+ free(history);
+ history = new;
+ }
+ history_max_len = len;
+ if (history_len > history_max_len)
+ history_len = history_max_len;
+ return 1;
+}
+
+/* Save the history in the specified file. On success 0 is returned
+ * otherwise -1 is returned. */
+int linenoiseHistorySave(const char *filename) {
+ FILE *fp;
+ int j;
+
+ fp = fopen(filename,"w");
+ if (fp == NULL) return -1;
+ for (j = 0; j < history_len; j++)
+ fprintf(fp,"%s\n",history[j]);
+ fclose(fp);
+ return 0;
+}
+
+/* Load the history from the specified file. If the file does not exist
+ * zero is returned and no operation is performed.
+ *
+ * If the file exists and the operation succeeded 0 is returned, otherwise
+ * on error -1 is returned. */
+int linenoiseHistoryLoad(const char *filename) {
+ FILE *fp = fopen(filename, "r");
+ if (fp == NULL) {
+ return -1;
+ }
+
+ char *buf = calloc(1, max_cmdline_length);
+ if (buf == NULL) {
+ fclose(fp);
+ return -1;
+ }
+
+ while (fgets(buf, max_cmdline_length, fp) != NULL) {
+ char *p;
+
+ p = strchr(buf,'\r');
+ if (!p) p = strchr(buf,'\n');
+ if (p) *p = '\0';
+ linenoiseHistoryAdd(buf);
+ }
+
+ free(buf);
+ fclose(fp);
+
+ return 0;
+}
+
+/* Set line maximum length. If len parameter is smaller than
+ * LINENOISE_MINIMAL_MAX_LINE, -1 is returned
+ * otherwise 0 is returned. */
+int linenoiseSetMaxLineLen(size_t len) {
+ if (len < LINENOISE_MINIMAL_MAX_LINE) {
+ return -1;
+ }
+ max_cmdline_length = len;
+ return 0;
+}
diff --git a/lib/console/linenoise/linenoise.h b/lib/console/linenoise/linenoise.h
new file mode 100644
index 00000000..98876104
--- /dev/null
+++ b/lib/console/linenoise/linenoise.h
@@ -0,0 +1,82 @@
+/* linenoise.h -- VERSION 1.0
+ *
+ * Guerrilla line editing library against the idea that a line editing lib
+ * needs to be 20,000 lines of C code.
+ *
+ * See linenoise.c for more information.
+ *
+ * ------------------------------------------------------------------------
+ *
+ * Copyright (c) 2010-2014, Salvatore Sanfilippo <antirez at gmail dot com>
+ * Copyright (c) 2010-2013, Pieter Noordhuis <pcnoordhuis at gmail dot com>
+ *
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are
+ * met:
+ *
+ * * Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ *
+ * * Redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in the
+ * documentation and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#ifndef __LINENOISE_H
+#define __LINENOISE_H
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+#include <stdbool.h>
+#include <stddef.h>
+
+typedef struct linenoiseCompletions {
+ size_t len;
+ char **cvec;
+} linenoiseCompletions;
+
+typedef void(linenoiseCompletionCallback)(const char *, linenoiseCompletions *);
+typedef char*(linenoiseHintsCallback)(const char *, int *color, int *bold);
+typedef void(linenoiseFreeHintsCallback)(void *);
+void linenoiseSetCompletionCallback(linenoiseCompletionCallback *);
+void linenoiseSetHintsCallback(linenoiseHintsCallback *);
+void linenoiseSetFreeHintsCallback(linenoiseFreeHintsCallback *);
+void linenoiseAddCompletion(linenoiseCompletions *, const char *);
+
+int linenoiseProbe(void);
+char *linenoise(const char *prompt);
+void linenoiseFree(void *ptr);
+int linenoiseHistoryAdd(const char *line);
+int linenoiseHistorySetMaxLen(int len);
+int linenoiseHistorySave(const char *filename);
+int linenoiseHistoryLoad(const char *filename);
+void linenoiseHistoryFree(void);
+void linenoiseClearScreen(void);
+void linenoiseSetMultiLine(int ml);
+void linenoiseSetDumbMode(int set);
+bool linenoiseIsDumbMode(void);
+void linenoisePrintKeyCodes(void);
+void linenoiseAllowEmpty(bool);
+int linenoiseSetMaxLineLen(size_t len);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* __LINENOISE_H */
diff --git a/lib/console/split_argv.c b/lib/console/split_argv.c
new file mode 100644
index 00000000..d2e3bd08
--- /dev/null
+++ b/lib/console/split_argv.c
@@ -0,0 +1,112 @@
+/*
+ * SPDX-FileCopyrightText: 2016-2021 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#include <stdio.h>
+#include <ctype.h>
+#include <string.h>
+
+#define SS_FLAG_ESCAPE 0x8
+
+typedef enum {
+ /* parsing the space between arguments */
+ SS_SPACE = 0x0,
+ /* parsing an argument which isn't quoted */
+ SS_ARG = 0x1,
+ /* parsing a quoted argument */
+ SS_QUOTED_ARG = 0x2,
+ /* parsing an escape sequence within unquoted argument */
+ SS_ARG_ESCAPED = SS_ARG | SS_FLAG_ESCAPE,
+ /* parsing an escape sequence within a quoted argument */
+ SS_QUOTED_ARG_ESCAPED = SS_QUOTED_ARG | SS_FLAG_ESCAPE,
+} split_state_t;
+
+/* helper macro, called when done with an argument */
+#define END_ARG() do { \
+ char_out = 0; \
+ argv[argc++] = next_arg_start; \
+ state = SS_SPACE; \
+} while(0)
+
+size_t esp_console_split_argv(char *line, char **argv, size_t argv_size)
+{
+ const int QUOTE = '"';
+ const int ESCAPE = '\\';
+ const int SPACE = ' ';
+ split_state_t state = SS_SPACE;
+ size_t argc = 0;
+ char *next_arg_start = line;
+ char *out_ptr = line;
+ for (char *in_ptr = line; argc < argv_size - 1; ++in_ptr) {
+ int char_in = (unsigned char) *in_ptr;
+ if (char_in == 0) {
+ break;
+ }
+ int char_out = -1;
+
+ switch (state) {
+ case SS_SPACE:
+ if (char_in == SPACE) {
+ /* skip space */
+ } else if (char_in == QUOTE) {
+ next_arg_start = out_ptr;
+ state = SS_QUOTED_ARG;
+ } else if (char_in == ESCAPE) {
+ next_arg_start = out_ptr;
+ state = SS_ARG_ESCAPED;
+ } else {
+ next_arg_start = out_ptr;
+ state = SS_ARG;
+ char_out = char_in;
+ }
+ break;
+
+ case SS_QUOTED_ARG:
+ if (char_in == QUOTE) {
+ END_ARG();
+ } else if (char_in == ESCAPE) {
+ state = SS_QUOTED_ARG_ESCAPED;
+ } else {
+ char_out = char_in;
+ }
+ break;
+
+ case SS_ARG_ESCAPED:
+ case SS_QUOTED_ARG_ESCAPED:
+ if (char_in == ESCAPE || char_in == QUOTE || char_in == SPACE) {
+ char_out = char_in;
+ } else {
+ /* unrecognized escape character, skip */
+ }
+ state = (split_state_t) (state & (~SS_FLAG_ESCAPE));
+ break;
+
+ case SS_ARG:
+ if (char_in == SPACE) {
+ END_ARG();
+ } else if (char_in == ESCAPE) {
+ state = SS_ARG_ESCAPED;
+ } else {
+ char_out = char_in;
+ }
+ break;
+ }
+ /* need to output anything? */
+ if (char_out >= 0) {
+ *out_ptr = char_out;
+ ++out_ptr;
+ }
+ }
+ /* make sure the final argument is terminated */
+ *out_ptr = 0;
+ /* finalize the last argument */
+ if (state != SS_SPACE && argc < argv_size - 1) {
+ argv[argc++] = next_arg_start;
+ }
+ /* add a NULL at the end of argv */
+ argv[argc] = NULL;
+
+ return argc;
+}
diff --git a/lib/console/test_apps/console/CMakeLists.txt b/lib/console/test_apps/console/CMakeLists.txt
new file mode 100644
index 00000000..12837206
--- /dev/null
+++ b/lib/console/test_apps/console/CMakeLists.txt
@@ -0,0 +1,12 @@
+# The following lines of boilerplate have to be in your project's
+# CMakeLists in this exact order for cmake to work correctly
+cmake_minimum_required(VERSION 3.16)
+
+include($ENV{IDF_PATH}/tools/cmake/project.cmake)
+
+list(PREPEND SDKCONFIG_DEFAULTS "$ENV{IDF_PATH}/tools/test_apps/configs/sdkconfig.debug_helpers" "sdkconfig.defaults")
+
+# "Trim" the build. Include the minimal set of components, main, and anything it depends on.
+set(COMPONENTS main)
+
+project(test_console)
diff --git a/lib/console/test_apps/console/README.md b/lib/console/test_apps/console/README.md
new file mode 100644
index 00000000..bf47d80e
--- /dev/null
+++ b/lib/console/test_apps/console/README.md
@@ -0,0 +1,2 @@
+| Supported Targets | ESP32 | ESP32-C2 | ESP32-C3 | ESP32-C6 | ESP32-H2 | ESP32-P4 | ESP32-S2 | ESP32-S3 |
+| ----------------- | ----- | -------- | -------- | -------- | -------- | -------- | -------- | -------- |
diff --git a/lib/console/test_apps/console/main/CMakeLists.txt b/lib/console/test_apps/console/main/CMakeLists.txt
new file mode 100644
index 00000000..b253135b
--- /dev/null
+++ b/lib/console/test_apps/console/main/CMakeLists.txt
@@ -0,0 +1,4 @@
+idf_component_register(SRCS "test_app_main.c" "test_console.c"
+ INCLUDE_DIRS "."
+ PRIV_REQUIRES unity console
+ WHOLE_ARCHIVE)
diff --git a/lib/console/test_apps/console/main/test_app_main.c b/lib/console/test_apps/console/main/test_app_main.c
new file mode 100644
index 00000000..8dffdfd3
--- /dev/null
+++ b/lib/console/test_apps/console/main/test_app_main.c
@@ -0,0 +1,51 @@
+/*
+ * SPDX-FileCopyrightText: 2022-2023 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#include "unity.h"
+#include "unity_test_runner.h"
+#include "esp_heap_caps.h"
+#include <sys/time.h>
+
+// Some resources are lazy allocated (newlib locks) in the console code, the threshold is left for that case
+#define TEST_MEMORY_LEAK_THRESHOLD (-150)
+
+static size_t before_free_8bit;
+static size_t before_free_32bit;
+
+static void check_leak(size_t before_free, size_t after_free, const char *type)
+{
+ ssize_t delta = after_free - before_free;
+ printf("MALLOC_CAP_%s: Before %u bytes free, After %u bytes free (delta %d)\n", type, before_free, after_free, delta);
+ TEST_ASSERT_MESSAGE(delta >= TEST_MEMORY_LEAK_THRESHOLD, "memory leak");
+}
+
+void setUp(void)
+{
+ before_free_8bit = heap_caps_get_free_size(MALLOC_CAP_8BIT);
+ before_free_32bit = heap_caps_get_free_size(MALLOC_CAP_32BIT);
+}
+
+
+
+void tearDown(void)
+{
+ size_t after_free_8bit = heap_caps_get_free_size(MALLOC_CAP_8BIT);
+ size_t after_free_32bit = heap_caps_get_free_size(MALLOC_CAP_32BIT);
+ check_leak(before_free_8bit, after_free_8bit, "8BIT");
+ check_leak(before_free_32bit, after_free_32bit, "32BIT");
+}
+
+void app_main(void)
+{
+ /* Preallocate some newlib locks to avoid it from
+ registering as memory leaks */
+
+ struct timeval tv = { 0 };
+ gettimeofday(&tv, NULL);
+
+ printf("Running console component tests\n");
+ unity_run_menu();
+}
diff --git a/lib/console/test_apps/console/main/test_console.c b/lib/console/test_apps/console/main/test_console.c
new file mode 100644
index 00000000..db768502
--- /dev/null
+++ b/lib/console/test_apps/console/main/test_console.c
@@ -0,0 +1,104 @@
+/*
+ * SPDX-FileCopyrightText: 2022-2023 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+#include <stdio.h>
+#include <string.h>
+#include "sdkconfig.h"
+#include "unity.h"
+#include "esp_console.h"
+#include "argtable3/argtable3.h"
+#include "linenoise/linenoise.h"
+#include "freertos/FreeRTOS.h"
+#include "freertos/task.h"
+
+static int do_hello_cmd(int argc, char **argv)
+{
+ printf("Hello World\n");
+ return 0;
+}
+
+TEST_CASE("esp console init/deinit test", "[console]")
+{
+ esp_console_config_t console_config = ESP_CONSOLE_CONFIG_DEFAULT();
+ TEST_ESP_OK(esp_console_init(&console_config));
+ const esp_console_cmd_t cmd = {
+ .command = "hello",
+ .help = "Print Hello World",
+ .hint = NULL,
+ .func = do_hello_cmd,
+ };
+ TEST_ESP_OK(esp_console_cmd_register(&cmd));
+ // re-register the same command, just for test
+ TEST_ESP_OK(esp_console_cmd_register(&cmd));
+ TEST_ESP_OK(esp_console_deinit());
+}
+
+static esp_console_repl_t *s_repl = NULL;
+
+/* handle 'quit' command */
+static int do_cmd_quit(int argc, char **argv)
+{
+ printf("ByeBye\r\n");
+ s_repl->del(s_repl);
+
+ linenoiseHistoryFree(); // Free up memory
+
+ return 0;
+}
+
+static esp_console_cmd_t s_quit_cmd = {
+ .command = "quit",
+ .help = "Quit REPL environment",
+ .func = &do_cmd_quit
+};
+
+// Enter "quit" to exit REPL environment
+/* Marked as ignore since it cannot run as a normal unity test case
+ ran separately in test_console_repl */
+TEST_CASE("esp console repl test", "[console][ignore]")
+{
+ esp_console_repl_config_t repl_config = ESP_CONSOLE_REPL_CONFIG_DEFAULT();
+ esp_console_dev_uart_config_t uart_config = ESP_CONSOLE_DEV_UART_CONFIG_DEFAULT();
+ TEST_ESP_OK(esp_console_new_repl_uart(&uart_config, &repl_config, &s_repl));
+
+ TEST_ESP_OK(esp_console_cmd_register(&s_quit_cmd));
+
+ TEST_ESP_OK(esp_console_start_repl(s_repl));
+ vTaskDelay(pdMS_TO_TICKS(2000));
+}
+
+TEST_CASE("esp console help command", "[console][ignore]")
+{
+ esp_console_repl_config_t repl_config = ESP_CONSOLE_REPL_CONFIG_DEFAULT();
+ esp_console_dev_uart_config_t uart_config = ESP_CONSOLE_DEV_UART_CONFIG_DEFAULT();
+ TEST_ESP_OK(esp_console_new_repl_uart(&uart_config, &repl_config, &s_repl));
+
+ TEST_ESP_OK(esp_console_cmd_register(&s_quit_cmd));
+ TEST_ESP_OK(esp_console_register_help_command());
+
+ TEST_ESP_OK(esp_console_start_repl(s_repl));
+ vTaskDelay(pdMS_TO_TICKS(5000));
+}
+
+TEST_CASE("esp console init/deinit test, minimal config", "[console]")
+{
+ /* Test with minimal init config */
+ esp_console_config_t console_config = {
+ .max_cmdline_length = 100,
+ };
+
+ TEST_ESP_OK(esp_console_init(&console_config));
+ const esp_console_cmd_t cmd = {
+ .command = "hello",
+ .help = "Print Hello World",
+ .hint = NULL,
+ .func = do_hello_cmd,
+ };
+
+ TEST_ESP_OK(esp_console_cmd_register(&cmd));
+ // re-register the same command, just for test
+ TEST_ESP_OK(esp_console_cmd_register(&cmd));
+ TEST_ESP_OK(esp_console_deinit());
+}
diff --git a/lib/console/test_apps/console/pytest_console.py b/lib/console/test_apps/console/pytest_console.py
new file mode 100644
index 00000000..0dfdd135
--- /dev/null
+++ b/lib/console/test_apps/console/pytest_console.py
@@ -0,0 +1,96 @@
+# SPDX-FileCopyrightText: 2022-2023 Espressif Systems (Shanghai) CO LTD
+# SPDX-License-Identifier: CC0-1.0
+
+import pytest
+from pytest_embedded import Dut
+
+
+def do_test_quit(dut: Dut) -> None:
+ dut.expect_exact('Press ENTER to see the list of tests')
+ dut.write('"esp console repl test"')
+
+ dut.expect_exact('esp>', timeout=5)
+ dut.write('quit')
+
+ dut.expect_exact('ByeBye', timeout=5)
+
+
+def do_test_help_generic(dut: Dut) -> None:
+ dut.expect_exact('Press ENTER to see the list of tests')
+ dut.write('"esp console help command"')
+
+ dut.expect_exact('esp>', timeout=5)
+ dut.write('help')
+
+ dut.expect_exact('quit', timeout=5)
+ dut.expect_exact('Quit REPL environment', timeout=5)
+
+ dut.expect(r'help\s+\[<string>\]', timeout=5)
+
+ # Note: repl seems to do the line breaks by itself, this needs to be adjusted if repl changes its line width
+ dut.expect_exact('Print the summary of all registered commands if no arguments are given,', timeout=5)
+ dut.expect_exact('otherwise print summary of given command.', timeout=5)
+ dut.expect(r'<string>\s+Name of command\s+esp>', timeout=5)
+
+
+def do_test_help_quit(dut: Dut) -> None:
+ dut.expect_exact('Press ENTER to see the list of tests')
+ dut.write('"esp console help command"')
+
+ dut.expect_exact('esp>', timeout=5)
+ dut.write('help quit')
+
+ dut.expect(r'quit\s+Quit REPL environment\s+esp>', timeout=5)
+
+
+@pytest.mark.generic
+@pytest.mark.supported_targets
+def test_console(dut: Dut) -> None:
+ dut.run_all_single_board_cases()
+
+
+@pytest.mark.generic
+@pytest.mark.supported_targets
+def test_console_repl(dut: Dut) -> None:
+ do_test_quit(dut)
+
+
+@pytest.mark.generic
+@pytest.mark.supported_targets
+def test_console_help_generic(dut: Dut) -> None:
+ do_test_help_generic(dut)
+
+
+@pytest.mark.generic
+@pytest.mark.supported_targets
+def test_console_help_quit(dut: Dut) -> None:
+ do_test_help_quit(dut)
+
+
+@pytest.mark.host_test
+@pytest.mark.qemu
+@pytest.mark.esp32
+@pytest.mark.esp32c3
+def test_console_qemu(dut: Dut) -> None:
+ dut.run_all_single_board_cases()
+
+
+@pytest.mark.host_test
+@pytest.mark.qemu
+@pytest.mark.esp32
+def test_console_repl_qemu(dut: Dut) -> None:
+ do_test_quit(dut)
+
+
+@pytest.mark.host_test
+@pytest.mark.qemu
+@pytest.mark.esp32
+def test_console_help_generic_qemu(dut: Dut) -> None:
+ do_test_help_generic(dut)
+
+
+@pytest.mark.host_test
+@pytest.mark.qemu
+@pytest.mark.esp32
+def test_console_help_quit_qemu(dut: Dut) -> None:
+ do_test_help_quit(dut)
diff --git a/lib/console/test_apps/console/sdkconfig.defaults b/lib/console/test_apps/console/sdkconfig.defaults
new file mode 100644
index 00000000..ba19fc56
--- /dev/null
+++ b/lib/console/test_apps/console/sdkconfig.defaults
@@ -0,0 +1,3 @@
+# This "default" configuration is appended to all other configurations
+# The contents of "sdkconfig.debug_helpers" is also appended to all other configurations (see CMakeLists.txt)
+CONFIG_ESP_TASK_WDT_INIT=n