Skip to content

Commit 3340fc2

Browse files
mspangmspang
authored
Switch from readline to editline (project-chip#20330)
Readline is GPL'd software and may not be available in the build environment. Vendor editline which is permissively licensed and drop it in as a replacement for readline.
1 parent a9da0d8 commit 3340fc2

File tree

9 files changed

+257
-10
lines changed

9 files changed

+257
-10
lines changed

‎.gitmodules

+3
Original file line numberDiff line numberDiff line change
@@ -266,3 +266,6 @@
266266
url = https://github.com/SiliconLabs/wiseconnect-wifi-bt-sdk.git
267267
branch = master
268268
platforms = efr32
269+
[submodule "editline"]
270+
path = third_party/editline/repo
271+
url = https://github.com/troglobit/editline.git

‎build_overrides/editline.gni

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Copyright (c) 2022 Project CHIP Authors
2+
#
3+
# Licensed under the Apache License, Version 2.0 (the "License");
4+
# you may not use this file except in compliance with the License.
5+
# You may obtain a copy of the License at
6+
#
7+
# http://www.apache.org/licenses/LICENSE-2.0
8+
#
9+
# Unless required by applicable law or agreed to in writing, software
10+
# distributed under the License is distributed on an "AS IS" BASIS,
11+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
# See the License for the specific language governing permissions and
13+
# limitations under the License.
14+
15+
declare_args() {
16+
# Root directory for editline.
17+
editline_root = "//third_party/editline"
18+
}

‎examples/build_overrides/editline.gni

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Copyright (c) 2022 Project CHIP Authors
2+
#
3+
# Licensed under the Apache License, Version 2.0 (the "License");
4+
# you may not use this file except in compliance with the License.
5+
# You may obtain a copy of the License at
6+
#
7+
# http://www.apache.org/licenses/LICENSE-2.0
8+
#
9+
# Unless required by applicable law or agreed to in writing, software
10+
# distributed under the License is distributed on an "AS IS" BASIS,
11+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
# See the License for the specific language governing permissions and
13+
# limitations under the License.
14+
15+
declare_args() {
16+
# Root directory for editline.
17+
editline_root = "//third_party/connectedhomeip/third_party/editline"
18+
}

‎examples/chip-tool/BUILD.gn

+7-4
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,10 @@ import("${chip_root}/build/chip/tools.gni")
1919
import("${chip_root}/examples/chip-tool/chip-tool.gni")
2020
import("${chip_root}/src/lib/core/core.gni")
2121

22+
if (config_use_interactive_mode) {
23+
import("//build_overrides/editline.gni")
24+
}
25+
2226
assert(chip_build_tools)
2327

2428
config("config") {
@@ -37,10 +41,6 @@ config("config") {
3741
]
3842

3943
cflags = [ "-Wconversion" ]
40-
41-
if (config_use_interactive_mode) {
42-
libs = [ "readline" ]
43-
}
4444
}
4545

4646
static_library("chip-tool-utils") {
@@ -77,8 +77,11 @@ static_library("chip-tool-utils") {
7777
"config/PersistentStorage.cpp",
7878
]
7979

80+
deps = []
81+
8082
if (config_use_interactive_mode) {
8183
sources += [ "commands/interactive/InteractiveCommands.cpp" ]
84+
deps += [ "${editline_root}:editline" ]
8285
}
8386

8487
if (config_enable_yaml_tests) {

‎examples/chip-tool/commands/interactive/InteractiveCommands.cpp

+1-2
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,8 @@
1818

1919
#include "InteractiveCommands.h"
2020

21+
#include <editline.h>
2122
#include <iomanip>
22-
#include <readline/history.h>
23-
#include <readline/readline.h>
2423
#include <sstream>
2524

2625
char kInteractiveModeName[] = "";

‎examples/darwin-framework-tool/BUILD.gn

+5-4
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,10 @@ import("//build_overrides/chip.gni")
1818
import("${chip_root}/build/chip/tools.gni")
1919
import("${chip_root}/examples//chip-tool/chip-tool.gni")
2020

21+
if (config_use_interactive_mode) {
22+
import("//build_overrides/editline.gni")
23+
}
24+
2125
assert(chip_build_tools)
2226

2327
config("config") {
@@ -43,10 +47,6 @@ config("config") {
4347
"-Wconversion",
4448
"-fobjc-arc",
4549
]
46-
47-
if (config_use_interactive_mode) {
48-
libs = [ "readline" ]
49-
}
5050
}
5151

5252
executable("darwin-framework-tool") {
@@ -81,6 +81,7 @@ executable("darwin-framework-tool") {
8181

8282
if (config_use_interactive_mode) {
8383
sources += [ "commands/interactive/InteractiveCommands.mm" ]
84+
deps += [ "${editline_root}:editline" ]
8485
}
8586

8687
if (config_enable_yaml_tests) {

‎third_party/editline/BUILD.gn

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Copyright (c) 2022 Project CHIP Authors
2+
#
3+
# Licensed under the Apache License, Version 2.0 (the "License");
4+
# you may not use this file except in compliance with the License.
5+
# You may obtain a copy of the License at
6+
#
7+
# http://www.apache.org/licenses/LICENSE-2.0
8+
#
9+
# Unless required by applicable law or agreed to in writing, software
10+
# distributed under the License is distributed on an "AS IS" BASIS,
11+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
# See the License for the specific language governing permissions and
13+
# limitations under the License.
14+
15+
config("editline_config") {
16+
include_dirs = [ "repo/include" ]
17+
}
18+
19+
static_library("editline") {
20+
public = [ "repo/include/editline.h" ]
21+
22+
sources = [
23+
"repo/src/complete.c",
24+
"repo/src/editline.c",
25+
"repo/src/editline.h",
26+
"repo/src/sysunix.c",
27+
"repo/src/unix.h",
28+
]
29+
30+
public_configs = [ ":editline_config" ]
31+
32+
include_dirs = [ "include" ]
33+
}

‎third_party/editline/include/config.h

+171
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,171 @@
1+
/* config.h. Generated from config.h.in by configure. */
2+
/* config.h.in. Generated from configure.ac by autoheader. */
3+
4+
/* Define to 1 if the `closedir' function returns void instead of int. */
5+
/* #undef CLOSEDIR_VOID */
6+
7+
/* Define to include ANSI arrow keys support. */
8+
#define CONFIG_ANSI_ARROWS 1
9+
10+
/* Define to enable EOF (Ctrl-D) key. */
11+
#define CONFIG_EOF 1
12+
13+
/* Define to enable SIGINT (Ctrl-C) key. */
14+
#define CONFIG_SIGINT 1
15+
16+
/* Define to enable SIGSTOP (Ctrl-Z) key. */
17+
/* #undef CONFIG_SIGSTOP */
18+
19+
/* Define to enable terminal bell on completion. */
20+
/* #undef CONFIG_TERMINAL_BELL */
21+
22+
/* Define to skip duplicate lines in the scrollback history. */
23+
#define CONFIG_UNIQUE_HISTORY 1
24+
25+
/* Define to use the termcap library for terminal size. */
26+
/* #undef CONFIG_USE_TERMCAP */
27+
28+
/* Define to 1 if `TIOCGWINSZ' requires <sys/ioctl.h>. */
29+
#define GWINSZ_IN_SYS_IOCTL 1
30+
31+
/* Define to 1 if you have the <dirent.h> header file, and it defines `DIR'.
32+
*/
33+
#define HAVE_DIRENT_H 1
34+
35+
/* Define to 1 if you have the <dlfcn.h> header file. */
36+
#define HAVE_DLFCN_H 1
37+
38+
/* Define to 1 if you have the <inttypes.h> header file. */
39+
#define HAVE_INTTYPES_H 1
40+
41+
/* Define to 1 if you have the `curses' library (-lcurses). */
42+
/* #undef HAVE_LIBCURSES */
43+
44+
/* Define to 1 if you have the `ncurses' library (-lncurses). */
45+
/* #undef HAVE_LIBNCURSES */
46+
47+
/* Define to 1 if you have the `termcap' library (-ltermcap). */
48+
/* #undef HAVE_LIBTERMCAP */
49+
50+
/* Define to 1 if you have the `terminfo' library (-lterminfo). */
51+
/* #undef HAVE_LIBTERMINFO */
52+
53+
/* Define to 1 if you have the `tinfo' library (-ltinfo). */
54+
/* #undef HAVE_LIBTINFO */
55+
56+
/* Define to 1 if you have the <malloc.h> header file. */
57+
/* #undef HAVE_MALLOC_H */
58+
59+
/* Define to 1 if you have the <ndir.h> header file, and it defines `DIR'. */
60+
/* #undef HAVE_NDIR_H */
61+
62+
/* Define to 1 if you have the `perror' function. */
63+
#define HAVE_PERROR 1
64+
65+
/* Define to 1 if you have the <sgtty.h> header file. */
66+
#define HAVE_SGTTY_H 1
67+
68+
/* Define to 1 if you have the <signal.h> header file. */
69+
#define HAVE_SIGNAL_H 1
70+
71+
/* Define to 1 if `stat' has the bug that it succeeds when given the
72+
zero-length file name argument. */
73+
/* #undef HAVE_STAT_EMPTY_STRING_BUG */
74+
75+
/* Define to 1 if you have the <stdint.h> header file. */
76+
#define HAVE_STDINT_H 1
77+
78+
/* Define to 1 if you have the <stdio.h> header file. */
79+
#define HAVE_STDIO_H 1
80+
81+
/* Define to 1 if you have the <stdlib.h> header file. */
82+
#define HAVE_STDLIB_H 1
83+
84+
/* Define to 1 if you have the `strchr' function. */
85+
#define HAVE_STRCHR 1
86+
87+
/* Define to 1 if you have the `strdup' function. */
88+
#define HAVE_STRDUP 1
89+
90+
/* Define to 1 if you have the <strings.h> header file. */
91+
#define HAVE_STRINGS_H 1
92+
93+
/* Define to 1 if you have the <string.h> header file. */
94+
#define HAVE_STRING_H 1
95+
96+
/* Define to 1 if you have the `strrchr' function. */
97+
#define HAVE_STRRCHR 1
98+
99+
/* Define to 1 if you have the <sys/dir.h> header file, and it defines `DIR'.
100+
*/
101+
/* #undef HAVE_SYS_DIR_H */
102+
103+
/* Define to 1 if you have the <sys/ndir.h> header file, and it defines `DIR'.
104+
*/
105+
/* #undef HAVE_SYS_NDIR_H */
106+
107+
/* Define to 1 if you have the <sys/stat.h> header file. */
108+
#define HAVE_SYS_STAT_H 1
109+
110+
/* Define to 1 if you have the <sys/types.h> header file. */
111+
#define HAVE_SYS_TYPES_H 1
112+
113+
/* Define to 1 if you have the `tcgetattr' function. */
114+
#define HAVE_TCGETATTR 1
115+
116+
/* Define to 1 if you have the <termcap.h> header file. */
117+
#define HAVE_TERMCAP_H 1
118+
119+
/* Define to 1 if you have the <termios.h> header file. */
120+
#define HAVE_TERMIOS_H 1
121+
122+
/* Define to 1 if you have the <termio.h> header file. */
123+
#define HAVE_TERMIO_H 1
124+
125+
/* Define to 1 if you have the <unistd.h> header file. */
126+
#define HAVE_UNISTD_H 1
127+
128+
/* Define to 1 if `lstat' dereferences a symlink specified with a trailing
129+
slash. */
130+
#define LSTAT_FOLLOWS_SLASHED_SYMLINK 1
131+
132+
/* Define to the sub-directory where libtool stores uninstalled libraries. */
133+
#define LT_OBJDIR ".libs/"
134+
135+
/* Name of package */
136+
#define PACKAGE "editline"
137+
138+
/* Define to the address where bug reports for this package should be sent. */
139+
#define PACKAGE_BUGREPORT "https://github.com/troglobit/editline/issues"
140+
141+
/* Define to the full name of this package. */
142+
#define PACKAGE_NAME "editline"
143+
144+
/* Define to the full name and version of this package. */
145+
#define PACKAGE_STRING "editline 1.17.1"
146+
147+
/* Define to the one symbol short name of this package. */
148+
#define PACKAGE_TARNAME "editline"
149+
150+
/* Define to the home page for this package. */
151+
#define PACKAGE_URL ""
152+
153+
/* Define to the version of this package. */
154+
#define PACKAGE_VERSION "1.17.1"
155+
156+
/* Define to 1 if the `S_IS*' macros in <sys/stat.h> do not work properly. */
157+
/* #undef STAT_MACROS_BROKEN */
158+
159+
/* Define to 1 if all of the C90 standard headers exist (not just the ones
160+
required in a freestanding environment). This macro is provided for
161+
backward compatibility; new code need not use it. */
162+
#define STDC_HEADERS 1
163+
164+
/* Default to UNIX backend, should be detected. */
165+
#define SYS_UNIX 1
166+
167+
/* Version number of package */
168+
#define VERSION "1.17.1"
169+
170+
/* Define to `unsigned int' if <sys/types.h> does not define. */
171+
/* #undef size_t */

‎third_party/editline/repo

Submodule repo added at 9fa05ba

0 commit comments

Comments
 (0)