I ran into your library, which looks stunning (thank you), and was wondering if it supported line continuation. For example, my need requires that the user be able to "enter" and continue to the next line, with a numerical indicator of the line. Except for the builtin (help format, save, etc... ) commands are ended with a semi-colon ";" ... something like this ...

replxx> this
      2 is
      3 an
      4 example of 
      5 continuation lines;
replxx> this is an example of  continuation lines;

I haven't dug into the library yet, so I thought I'd ask before spending to much time. Any advice, example, or information you can provide would be greatly appreciated.

Thank you

Overview

This allows us to close #52

A few "distribution" changes are needed to upgrade the library to follow CMake's modern approach. The biggest change here is that we set whether replxx is a shared library or not via BUILD_SHARED_LIBS. We also have a few dependent options now that become enabled based on whether replxx is being built by itself or as part of a larger project.

Please let me know if you'd like more changes made to fit the previous workflow.

Changelog

This removes the "you can build both" approach, but this is considered "best practice" by modern standards

Bumped the minimum CMake version to 3.14

Fallback to C++11 if not defined

add_subdirectory usage is now safe

Compiler flags rely on generator expressions

Update options to fit REPLXX_<> naming scheme

Use find_package(Threads) for -pthread support

Add basic find_package config support

Fix potential name clash for examples if built in larger project

Fix install location for various items to fall under GNU Install Dirs

hook hints themselves seem to work, you just can't see them as the colouring isn't set, this may be because it's using VT codes and are not decoding. All other colours elsewhere work fine, it just seems to be when there's more than one hint.

The replxx.h and .hxx headers undef DELETE and ERROR, which are set to required values by Windows headers. I'm not going to justify Windows doing that (their headers are full of #defines)! One, in replxx.h is even redundant — I think these both came from the original linenoise source.

However, we have code that requires those defines that replxx masks.

I don't see a non-breaking way to fix this; locally, I have renamed them to DEL and _ERROR and then removed the undefs, which worked for me.

after some try I found the c++-api examples' tick can not run on Windows:

C:\Work\Sources\replxx>example.exe m
Welcome to Replxx
Press 'tab' to view autocompletions
Type '.help' for help
Type '.quit' or '.exit' to exit

0

Exiting Replxx

It causes by "write failed" runtime error, because WrtieConsoleA in src/windows.cxx:131 returns 6: invalid handle. it seems the logic in terminal::writeB are not correct, this is the fix.

btw I also removed the only one cout occurs in source.

What are your thoughts on adding some simple Unit Tests? I was thinking some Google Tests but another framework would work just as good.

I was thinking that taking the examples and putting them in a unit test form could be nice.

For a project I'm trying to migrate away from GNU/Readline to this library here. I encountered an issue I couldn't figure out yet.

In readline there is support for escaping characters like spaces and quotes. So when you set the work break character to a space it won't be actually recognized as a word break, allowing to auto complete strings with spaces in it, while at the same time it is possible to kind of "restart" the completion when an actual unescaped space is passed.

Does this library support this?

It'd be nice to have the option to auto-complete a line/command with the first available hint when pressing enter/return, rather than have to do it explicitly by tabbing. This would allow emulating the code completion behavior of typical IDEs (and search engine input boxes.)

It doesn't look like this is currently possible, or is it?

Thanks.

After switching clickhouse-client to use the upstream replxx, we found three missing PRs in our fork which are lost.

1. https://github.com/ClickHouse-Extras/replxx/pull/3
2. https://github.com/ClickHouse-Extras/replxx/pull/4
3. https://github.com/ClickHouse-Extras/replxx/pull/15

I wonder if it's ok to land)

On windows replxx_clear_screen causes the prompt to appear in the last line of the console window instead of the first and it appears shifted one row to the left, that is the prompt is printed without the first letter.

Before this patch replxx, while saving to the history file always reload the history from the disk and add new items from that file into the current session. This looks incovenient, if user code calls history_save() after each command (to save history ASAP, example of such program is clickhouse-client) since if you run two programs with replxx completion the completion will overlaps after each command.

Looks like at least this should be configurable.

Apply license fix from LLVM:

The code was relicensed by its owner (Unicode.org) a long time back, but we still had the old (problematic) license in our fork.

Note that the source files have not been distributed from unicode.org since 2009 (due to being buggy and unmaintained upstream), but they were given this license before that.

You may get uncaugh exception (in case of i.e. broken pipe):

terminating with uncaught exception of type std::runtime_error: write failed

On destroy:

(lldb) target create "clickhouse-22.8-release" --core "core.clickhouse-clie.402986-642410"
bt
Core file '/wrk/core.clickhouse-clie.402986-642410' (x86_64) was loaded.
(lldb) bt
* thread #1, name = 'clickhouse-clie', stop reason = signal SIGABRT
  * frame #0: 0x00007f03fb5c900b libc.so.6`raise + 203
    frame #1: 0x00007f03fb5a8859 libc.so.6`abort + 299
    frame #2: 0x000000001b703f44 clickhouse-22.8-release`::abort_message(format=<unavailable>) at abort_message.cpp:78:5
    frame #3: 0x000000001b703dd4 clickhouse-22.8-release`demangling_terminate_handler() at cxa_default_handlers.cpp:67:21
    frame #4: 0x000000001b721063 clickhouse-22.8-release`std::__terminate(func=<unavailable>)()) at cxa_handlers.cpp:59:9
    frame #5: 0x000000001b720fce clickhouse-22.8-release`std::terminate() at cxa_handlers.cpp:88:17
    frame #6: 0x000000000a3b21db clickhouse-22.8-release`__clang_call_terminate + 11
    frame #7: 0x00000000189b1bfc clickhouse-22.8-release`replxx::Replxx::ReplxxImpl::~ReplxxImpl(this=0x00007f03fa945308) at replxx_impl.cxx:336:1
    frame #8: 0x00000000189b1ce9 clickhouse-22.8-release`replxx::Replxx::ReplxxImpl::~ReplxxImpl(this=0x00007f03fa945300) at replxx_impl.cxx:334:41
    frame #9: 0x00000000188b0644 clickhouse-22.8-release`ReplxxLineReader::~ReplxxLineReader() [inlined] std::__1::unique_ptr<replxx::Replxx::ReplxxImpl, void (*)(replxx::Replxx::ReplxxImpl*)>::reset(this=<unavailable>, __p=<unavailable>) at unique_ptr.h:315:7
    frame #10: 0x00000000188b0626 clickhouse-22.8-release`ReplxxLineReader::~ReplxxLineReader() [inlined] std::__1::unique_ptr<replxx::Replxx::ReplxxImpl, void (*)(replxx::Replxx::ReplxxImpl*)>::~unique_ptr(this=<unavailable>) at unique_ptr.h:269
    frame #11: 0x00000000188b0626 clickhouse-22.8-release`ReplxxLineReader::~ReplxxLineReader() [inlined] replxx::Replxx::~Replxx(this=<unavailable>) at replxx.hxx:76
    frame #12: 0x00000000188b0626 clickhouse-22.8-release`ReplxxLineReader::~ReplxxLineReader(this=0x00007ffd10038440) at ReplxxLineReader.cpp:229
    frame #13: 0x00000000158b2100 clickhouse-22.8-release`DB::ClientBase::runInteractive(this=0x00007ffd10038620) at ClientBase.cpp:2067:1
    frame #14: 0x000000000a4de372 clickhouse-22.8-release`DB::Client::main(this=0x00007ffd10038620, (null)=<unavailable>) at Client.cpp:261:9
    frame #15: 0x0000000018923a86 clickhouse-22.8-release`Poco::Util::Application::run(this=0x00007ffd10038620) at Application.cpp:334:8
    frame #16: 0x000000000a4ed341 clickhouse-22.8-release`mainEntryClickHouseClient(argc=39, argv=0x00007f03fa8201c0) at Client.cpp:1220:23
    frame #17: 0x000000000a3b17ab clickhouse-22.8-release`main(argc_=<unavailable>, argv_=<unavailable>) at main.cpp:449:12
    frame #18: 0x00007f03fb5aa083 libc.so.6`__libc_start_main + 243
    frame #19: 0x000000000a17032e clickhouse-22.8-release`_start + 46

The following REPL session break replxx for me:

--> (+ 0.18 0.2)
0.38
-->

On the third line, after pressing arrow down (history next, while there is no next element) segfaults my program. I presume there's a guard against a common case like this missing.

GDB backtrace:

#0  __memmove_avx_unaligned_erms ()
    at ../sysdeps/x86_64/multiarch/memmove-vec-unaligned-erms.S:443
#1  0x000000000042f42a in std::__copy_move<false, true, std::random_access_iterator_tag>::__copy_m<char32_t> (__first=0x0, __result=0x4ba340 U"\xf7886c00翿\xf7886c00翿",
    __last=<optimized out>)
    at /usr/bin/../lib/gcc/x86_64-linux-gnu/11/../../../../include/c++/11/bits/stl_algobase.h:431
#2  std::__copy_move_a2<false, char32_t const*, char32_t*> (__first=0x0,
    __result=0x4ba340 U"\xf7886c00翿\xf7886c00翿", __last=<optimized out>)
    at /usr/bin/../lib/gcc/x86_64-linux-gnu/11/../../../../include/c++/11/bits/stl_algobase.h:494
#3  std::__copy_move_a1<false, char32_t const*, char32_t*> (__first=0x0,
    __result=0x4ba340 U"\xf7886c00翿\xf7886c00翿", __last=<optimized out>)
    at /usr/bin/../lib/gcc/x86_64-linux-gnu/11/../../../../include/c++/11/bits/stl_algobase.h:522
#4  std::__copy_move_a<false, __gnu_cxx::__normal_iterator<char32_t const*, std::vector<char32_t, std::allocator<char32_t> > >, char32_t*> (
    __first=non-dereferenceable iterator for std::vector,
    __result=0x4ba340 U"\xf7886c00翿\xf7886c00翿", __last=...)
    at /usr/bin/../lib/gcc/x86_64-linux-gnu/11/../../../../include/c++/11/bits/stl_algobase.h:530
#5  std::copy<__gnu_cxx::__normal_iterator<char32_t const*, std::vector<char32_t, std::allocator<char32_t> > >, char32_t*> (
    __first=non-dereferenceable iterator for std::vector,
    __result=0x4ba340 U"\xf7886c00翿\xf7886c00翿", __last=...)
    at /usr/bin/../lib/gcc/x86_64-linux-gnu/11/../../../../include/c++/11/bits/stl_algobase.h:619
#6  std::__uninitialized_copy<true>::__uninit_copy<__gnu_cxx::__normal_iterator<char32_t const*, std::vector<char32_t, std::allocator<char32_t> > >, char32_t*> (
    __first=non-dereferenceable iterator for std::vector,
    __result=0x4ba340 U"\xf7886c00翿\xf7886c00翿", __last=...)
    at /usr/bin/../lib/gcc/x86_64-linux-gnu/11/../../../../include/c++/11/bits/stl_uninitialized.h:110
#7  std::uninitialized_copy<__gnu_cxx::__normal_iterator<char32_t const*, std::vector<char32_t, std::allocator<char32_t> > >, char32_t*> (
    __first=non-dereferenceable iterator for std::vector,
--Type <RET> for more, q to quit, c to continue without paging--
    __result=0x4ba340 U"\xf7886c00翿\xf7886c00翿", __last=...)
    at /usr/bin/../lib/gcc/x86_64-linux-gnu/11/../../../../include/c++/11/bits/stl_uninitialized.h:148
#8  std::__uninitialized_copy_a<__gnu_cxx::__normal_iterator<char32_t const*, std::vector<char32_t, std::allocator<char32_t> > >, char32_t*, char32_t> (
    __first=non-dereferenceable iterator for std::vector,
    __result=0x4ba340 U"\xf7886c00翿\xf7886c00翿", __last=...)
    at /usr/bin/../lib/gcc/x86_64-linux-gnu/11/../../../../include/c++/11/bits/stl_uninitialized.h:333
#9  std::vector<char32_t, std::allocator<char32_t> >::_M_allocate_and_copy<__gnu_cxx::__normal_iterator<char32_t const*, std::vector<char32_t, std::allocator<char32_t> > > > (
    this=0x4b2f78, __n=250, __first=non-dereferenceable iterator for std::vector,
    __last=...)
    at /usr/bin/../lib/gcc/x86_64-linux-gnu/11/../../../../include/c++/11/bits/stl_vector.h:1514
#10 std::vector<char32_t, std::allocator<char32_t> >::operator= (this=0x4b2f78,
    __x=...)
    at /usr/bin/../lib/gcc/x86_64-linux-gnu/11/../../../../include/c++/11/bits/vector.tcc:226
#11 0x000000000044533f in replxx::UnicodeString::assign (this=0x4b2f78, other_=...)
    at replxx/unicodestring.hxx:93
#12 replxx::Replxx::ReplxxImpl::history_move (this=0x4b2f60, previous_=<optimized out>)
    at replxx/replxx_impl.cxx:1956
#13 0x000000000043d419 in replxx::Replxx::ReplxxImpl::line_next (this=0x4ba340)
    at replxx/replxx_impl.cxx:1932
#14 0x000000000043ce77 in replxx::Replxx::ReplxxImpl::action (this=0x4b2f60,
    actionTrait_=6, handler_=<optimized out>, code_=63712 U'')
    at replxx/replxx_impl.cxx:1408
#15 0x0000000000446b4f in replxx::Replxx::ReplxxImpl::input (this=0x4b2f60, prompt=...)
    at /usr/bin/../lib/gcc/x86_64-linux-gnu/11/../../../../include/c++/11/bits/std_function.h:590
#16 0x0000000000417444 in main (argc=<optimized out>, argv=<optimized out>)
    at replxx/replxx.cxx:150

My code is located in the kspalaiologos/kamilalisp repository. NB: I keep my own copy of replxx, since I dislike the bloaty buildsystem bundled with the official distribution.

When compiling with commands cmake -DCMAKE_INSTALL_PREFIX=replxx -DBUILD_SHARED_LIBS=ON -G "MinGW Makefiles" .. & make on windows, we will get such some errors as undefined reference to replxx::color::bold(replxx::Replxx::Color); undefined reference to replxx::Replxx::HistoryScan::next()