Source file translate.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
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
module Param = struct
  let rec translate : type a. a Ast.Param.t -> a Cmdliner.Arg.conv = function
    | Conv { docv; parse; print } -> Cmdliner.Arg.conv ?docv (parse, print)
    | String -> Cmdliner.Arg.string
    | Int -> Cmdliner.Arg.int
    | Float -> Cmdliner.Arg.float
    | Bool -> Cmdliner.Arg.bool
    | File -> Cmdliner.Arg.file
    | Enum { docv = _; choices = hd :: tl; to_string = _ } -> Cmdliner.Arg.enum (hd :: tl)
    | Comma_separated param -> Cmdliner.Arg.list ~sep:',' (translate param)
  ;;

  let rec docv : type a. a Ast.Param.t -> string option = function
    | Conv { docv; parse = _; print = _ } -> docv
    | String -> Some "STRING"
    | Int -> Some "INT"
    | Float -> Some "FLOAT"
    | Bool -> Some "BOOL"
    | File -> Some "FILE"
    | Enum { docv; choices = _; to_string = _ } -> docv
    | Comma_separated param ->
      docv param |> Option.map (fun docv -> Printf.sprintf "[%s,..]" docv)
  ;;
end

module Arg = struct
  let docv_of_param ~docv ~param =
    match docv with
    | Some _ -> docv
    | None -> Param.docv param
  ;;

  (* Trailing dots integrate better with cmdliner's rendering. *)
  let fmt_doc ~doc =
    let trim = String.trim doc in
    let add_dot_suffix =
      String.length trim > 0
      &&
      match trim.[String.length trim - 1] with
      | '.' | '?' -> false
      | _ -> true
    in
    if add_dot_suffix then trim ^ "." else trim
  ;;

  let rec doc_of_param : type a. doc:string -> param:a Ast.Param.t -> string =
    fun ~doc ~param ->
    match (param : _ Ast.Param.t) with
    | Conv _ | String | Int | Float | Bool | File -> fmt_doc ~doc
    | Enum { docv = _; choices = hd :: tl; to_string = _ } ->
      Printf.sprintf
        "%s $(docv) must be %s."
        (fmt_doc ~doc)
        (Cmdliner.Arg.doc_alts_enum ~quoted:true (hd :: tl))
    | Comma_separated param -> doc_of_param ~doc:(doc ^ " (comma-separated)") ~param
  ;;

  let rec translate : type a. a Ast.Arg.t -> a Cmdliner.Term.t = function
    | Return x -> Cmdliner.Term.const x
    | Map { x; f } -> Cmdliner.Term.map f (translate x)
    | Both (a, b) -> Cmdliner.Term.product (translate a) (translate b)
    | Apply { f; x } -> Cmdliner.Term.app (translate f) (translate x)
    | Flag { names = hd :: tl; doc } ->
      let doc = fmt_doc ~doc in
      Cmdliner.Arg.value (Cmdliner.Arg.flag (Cmdliner.Arg.info ~doc (hd :: tl)))
    | Flag_count { names = hd :: tl; doc } ->
      let doc = fmt_doc ~doc in
      Cmdliner.Arg.value (Cmdliner.Arg.flag_all (Cmdliner.Arg.info ~doc (hd :: tl)))
      |> Cmdliner.Term.map List.length
    | Named { names = hd :: tl; param; docv; doc } ->
      let doc = doc_of_param ~doc ~param in
      let docv = docv_of_param ~docv ~param in
      Cmdliner.Arg.required
        (Cmdliner.Arg.opt
           (Cmdliner.Arg.some (Param.translate param))
           None
           (Cmdliner.Arg.info ?docv ~doc (hd :: tl)))
    | Named_multi { names = hd :: tl; param; docv; doc } ->
      let doc = doc_of_param ~doc ~param in
      let docv = docv_of_param ~docv ~param in
      Cmdliner.Arg.value
        (Cmdliner.Arg.opt_all
           (Param.translate param)
           []
           (Cmdliner.Arg.info ?docv ~doc (hd :: tl)))
    | Named_opt { names = hd :: tl; param; docv; doc } ->
      let doc = doc_of_param ~doc ~param in
      let docv = docv_of_param ~docv ~param in
      Cmdliner.Arg.value
        (Cmdliner.Arg.opt
           (Cmdliner.Arg.some (Param.translate param))
           None
           (Cmdliner.Arg.info ?docv ~doc (hd :: tl)))
    | Named_with_default { names = hd :: tl; param; default; docv; doc } ->
      let doc = doc_of_param ~doc ~param in
      let docv = docv_of_param ~docv ~param in
      Cmdliner.Arg.value
        (Cmdliner.Arg.opt
           (Param.translate param)
           default
           (Cmdliner.Arg.info ?docv ~doc (hd :: tl)))
    | Pos { pos; param; docv; doc } ->
      let doc = doc_of_param ~doc ~param in
      let docv = docv_of_param ~docv ~param in
      Cmdliner.Arg.required
        (Cmdliner.Arg.pos
           pos
           (Cmdliner.Arg.some (Param.translate param))
           None
           (Cmdliner.Arg.info ?docv ~doc []))
    | Pos_opt { pos; param; docv; doc } ->
      let doc = doc_of_param ~doc ~param in
      let docv = docv_of_param ~docv ~param in
      Cmdliner.Arg.value
        (Cmdliner.Arg.pos
           pos
           (Cmdliner.Arg.some (Param.translate param))
           None
           (Cmdliner.Arg.info ?docv ~doc []))
    | Pos_with_default { pos; param; default; docv; doc } ->
      let doc = doc_of_param ~doc ~param in
      let docv = docv_of_param ~docv ~param in
      Cmdliner.Arg.value
        (Cmdliner.Arg.pos
           pos
           (Param.translate param)
           default
           (Cmdliner.Arg.info ?docv ~doc []))
    | Pos_all { param; docv; doc } ->
      let doc = doc_of_param ~doc ~param in
      let docv = docv_of_param ~docv ~param in
      Cmdliner.Arg.value
        (Cmdliner.Arg.pos_all
           (Param.translate param)
           []
           (Cmdliner.Arg.info ?docv ~doc []))
  ;;
end

module Command = struct
  type block = [ `P of string ]

  let manpage_of_readme ~readme : block list =
    let readme = readme () in
    let lines = String.split_on_char '\n' readme in
    let paragraphs = Queue.create () in
    let buffer = Buffer.create 256 in
    let flush_line () =
      let line = Buffer.contents buffer in
      if not (String.length line = 0)
      then (
        Queue.push (`P line) paragraphs;
        Buffer.clear buffer)
    in
    let add_separator () = if Buffer.length buffer > 0 then Buffer.add_char buffer ' ' in
    let rec loop lines =
      match lines with
      | [] -> flush_line ()
      | "" :: lines ->
        flush_line ();
        Queue.push (`P "\n") paragraphs;
        loop lines
      | line :: lines ->
        add_separator ();
        Buffer.add_string buffer line;
        loop lines
    in
    loop lines;
    Queue.fold (fun tl hd -> hd :: tl) [] paragraphs |> List.rev
  ;;

  let rec translate
    : type a. ?version:string -> a Ast.Command.t -> name:string -> a Cmdliner.Cmd.t
    =
    fun ?version command ~name ->
    match (command : _ Ast.Command.t) with
    | Make { arg; summary; readme } ->
      let info =
        Cmdliner.Cmd.info
          ?man:
            (readme
             |> Option.map (fun readme ->
               (manpage_of_readme ~readme :> Cmdliner.Manpage.block list)))
          ~doc:summary
          ?version
          name
      in
      Cmdliner.Cmd.v info (Arg.translate arg)
    | Group { default; summary; readme; subcommands } ->
      let commands = subcommands |> List.map (fun (name, arg) -> translate arg ~name) in
      let info =
        Cmdliner.Cmd.info
          ?man:
            (readme
             |> Option.map (fun readme ->
               (manpage_of_readme ~readme :> Cmdliner.Manpage.block list)))
          ~doc:summary
          ?version
          name
      in
      Cmdliner.Cmd.group ?default:(default |> Option.map Arg.translate) info commands
  ;;
end

module To_ast = Cmdlang.Command.Private.To_ast

let param p = p |> To_ast.param |> Param.translate
let arg a = a |> To_ast.arg |> Arg.translate
let command ?version a ~name = a |> To_ast.command |> Command.translate ?version ~name

module Private = struct
  module Arg = Arg
  module Command = Command
end