Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/AmokHuginnsson/replxx
A readline and libedit replacement that supports UTF-8, syntax highlighting, hints and Windows and is BSD licensed.
https://github.com/AmokHuginnsson/replxx
ansi gnu-readline libedit linenoise multiplatform readline syntax-highlighting utf-8
Last synced: about 1 month ago
JSON representation
A readline and libedit replacement that supports UTF-8, syntax highlighting, hints and Windows and is BSD licensed.
- Host: GitHub
- URL: https://github.com/AmokHuginnsson/replxx
- Owner: AmokHuginnsson
- License: other
- Created: 2017-02-22T09:10:21.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2024-04-14T16:30:32.000Z (8 months ago)
- Last Synced: 2024-08-01T15:31:33.471Z (4 months ago)
- Topics: ansi, gnu-readline, libedit, linenoise, multiplatform, readline, syntax-highlighting, utf-8
- Language: C++
- Homepage:
- Size: 891 KB
- Stars: 682
- Watchers: 32
- Forks: 106
- Open Issues: 33
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
- AwesomeCppGameDev - replxx - 8, syntax highlighting, hints and Windows and is BSD licensed. (C++)
README
# Read Evaluate Print Loop ++
A small, portable GNU readline replacement for Linux, Windows and
MacOS which is capable of handling UTF-8 characters. Unlike GNU
readline, which is GPL, this library uses a BSD license and can be
used in any kind of program.
## Origin
This replxx implementation is based on the work by
[ArangoDB Team](https://github.com/arangodb/linenoise-ng) and
[Salvatore Sanfilippo](https://github.com/antirez/linenoise) and
10gen Inc. The goal is to create a zero-config, BSD
licensed, readline replacement usable in Apache2 or BSD licensed
programs.
## Features
* single-line and multi-line editing mode with the usual key bindings implemented
* history handling
* completion
* syntax highlighting
* hints
* BSD license source code
* Only uses a subset of VT100 escapes (ANSI.SYS compatible)
* UTF8 aware
* support for Linux, MacOS and Windows
## Requirements
To build this library, you will need a C++11-enabled compiler and
some recent version of CMake.
## Build instructions
### *nix
1. Create a build directory
```bash
mkdir -p build && cd build
```
2. Build the library
```bash
cmake -DCMAKE_BUILD_TYPE=Release .. && make
```
3. Install the library at the default target location
```bash
sudo make install
```
The default installation location can be adjusted by setting the `DESTDIR`
variable when invoking `make install`:
```bash
make DESTDIR=/tmp install
```
### Windows
1. Create a build directory in MS-DOS command prompt
```
md build
cd build
```
2. Generate Visual Studio solution file with cmake
* 32 bit:
```bash
cmake -G "Visual Studio 12 2013" -DCMAKE_BUILD_TYPE=Release ..
```
* 64 bit:
```bash
cmake -G "Visual Studio 12 2013 Win64" -DCMAKE_BUILD_TYPE=Release ..
```
3. Open the generated file `replxx.sln` in the `build` subdirectory with Visual Studio.
## Tested with...
* Linux text only console ($TERM = linux)
* Linux KDE terminal application ($TERM = xterm)
* Linux xterm ($TERM = xterm)
* Linux Buildroot ($TERM = vt100)
* Mac OS X iTerm ($TERM = xterm)
* Mac OS X default Terminal.app ($TERM = xterm)
* OpenBSD 4.5 through an OSX Terminal.app ($TERM = screen)
* IBM AIX 6.1
* FreeBSD xterm ($TERM = xterm)
* ANSI.SYS
* Emacs comint mode ($TERM = dumb)
* Windows
Please test it everywhere you can and report back!