Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/edadma/readline
Scala Native bindings for the GNU Readline Library
https://github.com/edadma/readline
Last synced: 3 months ago
JSON representation
Scala Native bindings for the GNU Readline Library
- Host: GitHub
- URL: https://github.com/edadma/readline
- Owner: edadma
- License: lgpl-3.0
- Created: 2021-08-13T10:35:40.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-03-15T21:30:54.000Z (8 months ago)
- Last Synced: 2024-04-22T13:32:51.058Z (7 months ago)
- Language: Scala
- Homepage:
- Size: 33.2 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-scala-native - readline - Bindings for the [GNU Readline Library](https://www.gnu.org/software/readline/). (Bindings)
README
readline
========
   
*readline* provides Scala Native bindings for the [GNU Readline Library](https://tiswww.cwru.edu/php/chet/readline/rltop.html).
Overview
--------
The goal of this project is to provide an easy-to-use Scala Native facade for the portion of the library that is often used to create REPL's. An example REPL application is provided below that just echos what is typed, however the example also shows how to use *readline*'s history feature including not adding duplicates to the history.
The more "programmer friendly" part of this library is found in the `io.github.edadma.readline.facade` package. That's the only package you need to import from, as seen in the example below. The other package in the library is `io.github.edadma.readline.extern` which provides for interaction with the Readline C library using Scala Native interoperability elements from the so-call `unsafe` namespace. There are no public declarations in the `io.github.edadma.readline.facade` package that use `unsafe` types in their parameter or return types, making it a pure Scala facade. Consequently, you never have to worry about memory allocation or type conversions.
Usage
-----
To use this library, `libreadline-dev` needs to be installed:
```shell
sudo apt install libreadline-dev
```
Include the following in your `project/plugins.sbt`:
```sbt
addSbtPlugin("com.codecommit" % "sbt-github-packages" % "0.5.2")
```
Include the following in your `build.sbt`:
```sbt
resolvers += Resolver.githubPackages("edadma")
libraryDependencies += "io.github.edadma" %%% "readline" % "0.1.2"
```
Use the following `import` in your code:
```scala
import io.github.edadma.readline.facade._
```
Example
-------
This example provides the skeleton for a REPL with history support, including making sure duplicates don't get added to the history.
```scala
import io.github.edadma.readline.facade._
import scala.annotation.tailrec
import Console._
object Main extends App {
val homeDir = System.getProperty("user.home")
val HISTORY_FILE = s"$homeDir/.my_readline_history"
var historyExists = read_history(HISTORY_FILE)
@tailrec
def repl(): Unit = {
val prompt = s"${CYAN}type something$RESET> "
val line = readline(prompt)
if (line != null) {
val s = line.trim
if (s nonEmpty) {
println(s"type typed '$s'")
// do something with 's'
val prev = history_get(history_base + history_length - 1)
if (prev == null || prev != s) {
add_history(s) // only add to history if it's not a duplicate of the previous item
if (historyExists == 0)
append_history(1, HISTORY_FILE)
else {
historyExists = 0
write_history(HISTORY_FILE)
}
}
}
repl()
}
}
repl()
}
```
Readline C library documentation
--------------------------------
The official documentation for the Readline library can be found at [readline](https://tiswww.cwru.edu/php/chet/readline/readline.html#SEC23). The official documentation for the history library can be found at [history](https://tiswww.cwru.edu/php/chet/readline/history.html#SEC6).
License
-------
[LGPL-3.0](https://github.com/edadma/readline/blob/main/LICENSE)