feat: prepare 0.0.1

Author: leostera

.gitignore

@@ -0,0 +1 @@
+_build

.ocamlformat

@@ -0,0 +1,13 @@
+# Changes
+
+## 0.0.1
+
+Initial release, including: 
+
+* High-level `Terminal` module for controlling a terminal
+* Async-input with UTF-8 support in the `Stdin` module
+* Terminal `Profile`s for determining what color palettes are available
+* A `Color` module for parsing and working with RGB/ANSI/ANSI256 colors
+* A collection of 60 escape sequence functions in `Escape_seq`
+* a lot of room for improvement!
+

CHANGES.md

@@ -0,0 +1,19 @@
+Copyright (c) 2023, Leandro Ostera
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

LICENSE.md

@@ -0,0 +1,15 @@
+# TTY
+
+TTY is a pure OCaml library for directly interacting with the
+terminal, including escape sequences, color profiles, colors, and
+consuming stdin.
+
+It is the main backend for [MintTea][minttea].
+
+[minttea]: https://github.com/leostera/minttea
+
+## Getting Started
+
+```
+$ opam install tty
+```

README.md

@@ -0,0 +1,24 @@
+(lang dune 3.11)
+
+(name tty)
+
+(generate_opam_files true)
+
+(source (github leostera/tty))
+
+(authors "Leandro Ostera <leandro@abstractmachines.dev>")
+
+(maintainers "Leandro Ostera <leandro@abstractmachines.dev>")
+
+(license MIT)
+
+(package
+ (name tty)
+ (synopsis "A library for interacting with teletype and terminal emulators")
+ (description "TTY is a library for directly interacting with teletypes and terminal emulators, including escape sequences, colors, and consuming stdin")
+ (depends
+   (ocaml (>= "5.1"))
+   (dune (>= "3.11"))
+   (uutf (>= "1.0.3")))
+ (tags (terminal ansi tty teletype utf8)))
+

dune-project

@@ -0,0 +1,32 @@
+# This file is generated by dune, edit dune-project instead
+opam-version: "2.0"
+synopsis: "A library for interacting with teletype and terminal emulators"
+description:
+  "TTY is a library for directly interacting with teletypes and terminal emulators, including escape sequences, colors, and consuming stdin"
+maintainer: ["Leandro Ostera <leandro@abstractmachines.dev>"]
+authors: ["Leandro Ostera <leandro@abstractmachines.dev>"]
+license: "MIT"
+tags: ["terminal" "ansi" "tty" "teletype" "utf8"]
+homepage: "https://github.com/leostera/tty"
+bug-reports: "https://github.com/leostera/tty/issues"
+depends: [
+  "ocaml" {>= "5.1"}
+  "dune" {>= "3.11" & >= "3.11"}
+  "uutf" {>= "1.0.3"}
+  "odoc" {with-doc}
+]
+build: [
+  ["dune" "subst"] {dev}
+  [
+    "dune"
+    "build"
+    "-p"
+    name
+    "-j"
+    jobs
+    "@install"
+    "@runtest" {with-test}
+    "@doc" {with-doc}
+  ]
+]
+dev-repo: "git+https://github.com/leostera/tty.git"

tty.opam

@@ -0,0 +1,45 @@
+type t = RGB of int * int * int | ANSI of int | ANSI256 of int | No_color
+
+exception Invalid_color of string
+exception Invalid_color_param of string
+exception Invalid_color_num of string * int
+
+let to_255 str =
+  match int_of_string_opt ("0x" ^ str) with
+  | None -> raise (Invalid_color_param str)
+  | Some c -> c
+
+let rgb r g b = RGB (to_255 r, to_255 g, to_255 b)
+
+let rgb str =
+  match String.to_seq str |> List.of_seq |> List.map (String.make 1) with
+  | [ "#"; r1; r2; g1; g2; b1; b2 ] -> rgb (r1 ^ r2) (g1 ^ g2) (b1 ^ b2)
+  | [ "#"; r1; g1; b1 ] -> rgb r1 g1 b1
+  | _ -> raise (Invalid_color str)
+
+let ansi i = ANSI i
+let ansi256 i = ANSI256 i
+let no_color = No_color
+
+let make str =
+  if String.starts_with ~prefix:"#" str then rgb str
+  else
+    match int_of_string_opt str with
+    | None -> raise (Invalid_color str)
+    | Some i when i < 16 -> ansi i
+    | Some i -> ansi256 i
+
+let to_escape_seq ~mode t =
+  match t with
+  | RGB (r, g, b) -> Format.sprintf "2;%d;%d;%d" r g b
+  | ANSI c ->
+      let bg_mod x = if mode = `bg then x + 10 else x in
+      let c = if c < 8 then bg_mod c + 30 else bg_mod (c - 8) + 90 in
+      Int.to_string c
+  | ANSI256 c -> Format.sprintf "5;%d" c
+  | No_color -> ""
+
+let is_no_color t = t = No_color
+let is_rgb t = match t with RGB _ -> true | _ -> false
+let is_ansi t = match t with ANSI _ -> true | _ -> false
+let is_ansi256 t = match t with ANSI256 _ -> true | _ -> false

tty/color.ml

@@ -0,0 +1,18 @@
+type t = private
+  | RGB of int * int * int
+  | ANSI of int
+  | ANSI256 of int
+  | No_color
+
+val make : string -> t
+
+exception Invalid_color of string
+exception Invalid_color_param of string
+exception Invalid_color_num of string * int
+
+val no_color : t
+val is_no_color : t -> bool
+val is_rgb : t -> bool
+val is_ansi : t -> bool
+val is_ansi256 : t -> bool
+val to_escape_seq : mode:[> `bg | `fg ] -> t -> string

tty/color.mli

@@ -0,0 +1,4 @@
+(library
+ (public_name tty)
+ (name tty)
+ (libraries uutf unix))