package miaou-core

  1. Overview
  2. Docs
Miaou core/widgets (no drivers, no SDL)

Install 

dune-project
 Dependency

github.com Edit opam file Versions (1)

Authors

  1. N
    Nomadic Labs <contact@nomadic-labs.com>

Maintainers

  1. N
    Nomadic Labs <contact@nomadic-labs.com>

Sources

v0.5.2.tar.gz
md5=60a3b9f181f24572a06a9492532bfdda
sha512=fcc35a275066be2900e6201782faf47503076fa4640f08cf78067835a6f447b74613009e55b2ac799adb7ca46f1bffa261fc5971753f2cc3c6bef327511c7ef6

doc/src/miaou-core.runner-common/tui_driver_common.ml.html

Source file tui_driver_common.ml

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
(*****************************************************************************
 *                                                                           *
 * SPDX-License-Identifier: MIT                                              *
 * Copyright (c) 2025 Nomadic Labs <contact@nomadic-labs.com>                *
 *                                                                           *
 *****************************************************************************)

[@@@warning "-32-34-37-69"]

open Miaou_core.Tui_page
module Widgets = Miaou_widgets_display.Widgets
module Registry = Miaou_core.Registry

(* Local alias for outcome to ensure compilation when mli changes are applied *)
type outcome = [`Quit | `Back | `SwitchTo of string]

type backend = {available : bool; run : (module PAGE_SIG) -> outcome}

type t = private T

let size () =
  (Obj.magic 0 : t) [@allow_forbidden "dummy private type for driver interface"]

let poll_event () = "" (* placeholder synchronous event *)

let draw_text s =
  (print_string [@allow_forbidden "terminal driver writes to stdout"]) s ;
  flush stdout

let clear () =
  (print_string [@allow_forbidden "terminal driver writes escape sequences"])
    "\027[2J" ;
  flush stdout

let flush () = ()

let current_page : (module PAGE_SIG) option ref = ref None

let set_page (page_module : (module PAGE_SIG)) =
  current_page := Some page_module

let backend_choice ~sdl_available ~matrix_available ~web_available =
  match Sys.getenv_opt "MIAOU_DRIVER" with
  | Some v -> (
      match String.lowercase_ascii (String.trim v) with
      | "matrix" when matrix_available -> `Matrix
      | "sdl" when sdl_available -> `Sdl
      | "term" | "lambda-term" | "lambda_term" -> `Lambda_term
      | "web" when web_available -> `Web
      | "html" when Html_driver.available -> `Html
      | _ -> `Matrix (* Default to matrix for unknown values too *))
  | None ->
      (* Default priority: Matrix > SDL > Lambda_term *)
      if matrix_available then `Matrix
      else if sdl_available then `Sdl
      else `Lambda_term

let run ~term_backend ~sdl_backend ~matrix_backend ~web_backend
    (initial_page : (module PAGE_SIG)) : outcome =
  Widgets.set_backend `Terminal ;
  (* Page stack for Back navigation *)
  let page_stack = ref [] in
  let rec loop (page : (module PAGE_SIG)) : outcome =
    let outcome =
      match
        backend_choice
          ~sdl_available:sdl_backend.available
          ~matrix_available:matrix_backend.available
          ~web_available:web_backend.available
      with
      | `Matrix ->
          Widgets.set_backend `Terminal ;
          matrix_backend.run page
      | `Sdl ->
          Widgets.set_backend `Sdl ;
          sdl_backend.run page
      | `Web ->
          Widgets.set_backend `Terminal ;
          web_backend.run page
      | `Html ->
          Widgets.set_backend `Terminal ;
          Html_driver.run page
      | `Lambda_term ->
          Widgets.set_backend `Terminal ;
          term_backend.run page
    in
    match outcome with
    | `Quit -> `Quit
    | `Back -> (
        match !page_stack with
        | [] -> `Quit (* No history, quit *)
        | prev :: rest ->
            page_stack := rest ;
            loop prev)
    | `SwitchTo next -> (
        match Registry.find next with
        | Some p ->
            page_stack := page :: !page_stack ;
            loop p
        | None -> `Quit)
  in
  let _result = loop initial_page in
  (* Shutdown fibers and exit to avoid Eio.Switch.run waiting for them *)
  Miaou_helpers.Fiber_runtime.shutdown () ;
  exit 0

let () =
  ignore size ;
  ignore poll_event ;
  ignore draw_text ;
  ignore clear ;
  ignore flush