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.core/keys.ml.html

Source file keys.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
113
114
115
116
117
118
119
120
(*****************************************************************************)
(*                                                                           *)
(* SPDX-License-Identifier: MIT                                              *)
(* Copyright (c) 2025 Nomadic Labs <contact@nomadic-labs.com>                *)
(*                                                                           *)
(*****************************************************************************)

type t =
  | Up
  | Down
  | Left
  | Right
  | Tab
  | ShiftTab
  | Enter
  | Backspace
  | Char of string
  | Control of string
  | PageUp
  | PageDown
  | Home
  | End
  | Escape
  | Delete
  | Function of int

(* Global keys reserved for application-wide functionality *)
type global_key = Settings | Help | Menu | Quit

let to_string = function
  | Up -> "Up"
  | Down -> "Down"
  | Left -> "Left"
  | Right -> "Right"
  | Tab -> "Tab"
  | ShiftTab -> "Shift-Tab"
  | Enter -> "Enter"
  | Backspace -> "Backspace"
  | Char s -> s
  | Control s -> "C-" ^ s
  | PageUp -> "PageUp"
  | PageDown -> "PageDown"
  | Home -> "Home"
  | End -> "End"
  | Escape -> "Escape"
  | Delete -> "Delete"
  | Function n -> "F" ^ string_of_int n

let of_string s =
  match s with
  | "Up" -> Some Up
  | "Down" -> Some Down
  | "Left" -> Some Left
  | "Right" -> Some Right
  | "Tab" -> Some Tab
  | "Shift-Tab" | "S-Tab" | "BackTab" -> Some ShiftTab
  | "Enter" -> Some Enter
  | "Backspace" -> Some Backspace
  | "PageUp" -> Some PageUp
  | "PageDown" -> Some PageDown
  | "Home" -> Some Home
  | "End" -> Some End
  | "Escape" | "Esc" -> Some Escape
  | "Delete" -> Some Delete
  | _ when String.length s > 1 && String.get s 0 = 'F' -> (
      try Some (Function (int_of_string (String.sub s 1 (String.length s - 1))))
      with _ -> Some (Char s))
  | _ when String.length s >= 2 && String.get s 0 = 'C' && String.get s 1 = '-'
    ->
      Some (Control (String.sub s 2 (String.length s - 2)))
  | _ -> Some (Char s)

let equal a b = to_string a = to_string b

let to_label = function
  | Up -> "↑"
  | Down -> "↓"
  | Left -> "←"
  | Right -> "→"
  | Tab -> "Tab"
  | ShiftTab -> "Shift-Tab"
  | Enter -> "Enter"
  | Backspace -> "Backspace"
  | Char s -> s
  | Control s -> "C-" ^ String.uppercase_ascii s
  | PageUp -> "PgUp"
  | PageDown -> "PgDn"
  | Home -> "Home"
  | End -> "End"
  | Escape -> "Esc"
  | Delete -> "Del"
  | Function n -> "F" ^ string_of_int n

(* Global key mappings - reserved for application-wide functionality *)
let global_key_bindings =
  [
    (Control "s", Settings);
    (Char "?", Help);
    (Control "m", Menu);
    (Control "q", Quit);
  ]

let is_global_key key =
  List.exists (fun (k, _) -> equal k key) global_key_bindings

let get_global_action key =
  List.assoc_opt
    key
    (List.map (fun (k, a) -> (to_string k, a)) global_key_bindings)

let show_global_keys () =
  List.map
    (fun (key, action) ->
      ( to_label key,
        match action with
        | Settings -> "Settings"
        | Help -> "Help"
        | Menu -> "Menu"
        | Quit -> "Quit" ))
    global_key_bindings