package coq-lsp

  1. Overview
  2. Docs
package coq-lsp
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Source file main.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
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
module Lsp = Fleche_lsp
open Fleche

(** TODO:

    - new edge "defined_in" object file
    - new edge "uses" for Require
    - new attributes "uses" "in_body" / "in_type" *)

(* Put these in an utility function for plugins *)
(* Duplicated with rq_document *)
let _of_execution ~io ~what (v : (_, _) Coq.Protect.E.t) =
  match v with
  | { r; feedback = _ } -> (
    match r with
    | Coq.Protect.R.Completed (Ok goals) -> goals
    | Coq.Protect.R.Completed (Error (Anomaly { msg; _ }))
    | Coq.Protect.R.Completed (Error (User { msg; _ })) ->
      let lvl = Io.Level.Error in
      Io.Report.msg ~io ~lvl "error when retrieving %s: %a" what Pp.pp_with msg;
      None
    | Coq.Protect.R.Interrupted -> None)

module Kind = struct
  type t =
    | Notation
    | Definition
    | Theorem
    | Other of string
    | Unknown
    | Lemma
  [@@deriving to_yojson]

  let to_string = function
    | Notation -> "Notation"
    | Definition -> "Definition"
    | Theorem -> "Theorem"
    | Other s -> "Other(" ^ s ^ ")"
    | Unknown -> "Unknown"
    | Lemma -> "Lemma"

  let of_rocq_logic_kind = function
    | Decls.Theorem -> Theorem
    | Lemma -> Lemma
    | Fact -> Other "Fact"
    | Remark -> Other "Remark"
    | Property -> Other "Property"
    | Proposition -> Other "Proposition"
    | Corollary -> Other "Corollary"

  let of_rocq_decl_kind = function
    | Decls.Definition -> Definition
    | Coercion -> Other "Coercion"
    | SubClass -> Other "SubClass"
    | CanonicalStructure -> Other "CanonicalStructure"
    | Example -> Other "Example"
    | Fixpoint -> Other "Fixpoint"
    | CoFixpoint -> Other "CoFixpoint"
    | Scheme -> Other "Scheme"
    | StructureComponent -> Other "StructureComponent"
    | IdentityCoercion -> Other "IdentityCoercion"
    | Instance -> Other "Instance"
    | Method -> Other "Method"
    | Let -> Other "Let"
    | LetContext -> Other "LetContext"

  (* For Lang.Ast.Info.t *)
  let _of_detail = function
    | Some "Notation" -> Notation
    | Some "Definition" -> Definition
    | Some "Lemma" -> Lemma
    | Some "Theorem" -> Theorem
    | Some s -> Other s
    | None -> Unknown
end

(* extract refs and notations *)
let rec analyze_constr_expr_acc () depl (e : Constrexpr.constr_expr) :
    string list =
  let open Constrexpr in
  (match e.v with
  | CRef (qid, _) -> [ Libnames.string_of_qualid qid ]
  | CFix (_, _) -> []
  | CCoFix (_, _) -> []
  | CProdN (_, _) -> []
  | CLambdaN (_, _) -> []
  | CLetIn (_, _, _, _) -> []
  | CAppExpl (_, _) -> []
  | CApp (_, _) -> []
  | CProj (_, _, _, _) -> []
  | CRecord _ -> []
  | CCases (_, _, _, _) -> []
  | CLetTuple (_, _, _, _) -> []
  | CIf (_, _, _, _) -> []
  | CHole _ -> []
  | CGenarg _ -> []
  | CGenargGlob _ -> []
  | CPatVar _ -> []
  | CEvar (_, _) -> []
  | CSort _ -> []
  | CCast (_, _, _) -> []
  | CNotation (_, (_, ntn_key), (l, ll, _, _)) ->
    (* Constrexpr_ops.fold_constr_expr_with_binders doesn't recurse properly
       here *)
    let f =
      Constrexpr_ops.fold_constr_expr_with_binders
        (fun _ () -> ())
        analyze_constr_expr_acc () []
    in
    [ ntn_key ] @ List.concat_map f (l @ List.flatten ll)
  | CGeneralization (_, _) -> []
  | CPrim _ -> []
  | CDelimiters (_, _, _) -> []
  | CArray (_, _, _, _) -> [])
  |> List.append depl

let analyze_constr_expr (e : Constrexpr.constr_expr) =
  Constrexpr_ops.fold_constr_expr_with_binders
    (fun _ () -> ())
    analyze_constr_expr_acc () [] e

(* *)
let analyze_definition_expr de =
  let open Vernacexpr in
  let ty =
    match de with
    | ProveBody (_bl, e) -> e
    | DefineBody (_bl, _rr, e, _) -> e
  in
  analyze_constr_expr ty

let name_to_string = function
  | Names.Anonymous -> None
  | Names.Name id -> Some (Names.Id.to_string id)

(* Better Rocq analysis, for example extract the list of notations *)
let analyze (CAst.{ loc = _; v } : Vernacexpr.vernac_control) : _ option =
  let open Vernacexpr in
  let { control = _; attrs = _; expr } = v in
  match expr with
  | VernacSynterp e -> (
    match e with
    | VernacLoad (_, _) -> None
    | VernacReservedNotation (_, _) -> None
    | VernacNotation (_, _) -> None
    | VernacDeclareCustomEntry _ -> None
    | VernacBeginSection _ -> None
    | VernacEndSegment _ -> None
    | VernacRequire (_, _, _) -> None
    | VernacImport (_, _) -> None
    | VernacDeclareModule (_, _, _, _) -> None
    | VernacDefineModule (_, _, _, _, _) -> None
    | VernacDeclareModuleType (_, _, _, _) -> None
    | VernacInclude _ -> None
    | VernacDeclareMLModule _ -> None
    | VernacChdir _ -> None
    | VernacExtraDependency (_, _, _) -> None
    | VernacSetOption (_, _, _) -> None
    | VernacProofMode _ -> None
    | VernacExtend (_, _) -> None)
  | VernacSynPure e -> (
    match e with
    | VernacOpenCloseScope (_, _) -> None
    | VernacDeclareScope _ -> None
    | VernacDelimiters (_, _) -> None
    | VernacBindScope (_, _) -> None
    | VernacEnableNotation (_, _, _, _, _) -> None
    | VernacDefinition ((_, kind), (name, _), expr) ->
      let name = name_to_string name.v in
      let kind = Kind.of_rocq_decl_kind kind in
      let deps = analyze_definition_expr expr in
      Some (name, kind, deps)
    | VernacStartTheoremProof (_, []) -> None
    | VernacStartTheoremProof (kind, ((name, _), (_, ty)) :: _) ->
      let name = Some (Names.Id.to_string name.v) in
      let kind = Kind.of_rocq_logic_kind kind in
      let deps = analyze_constr_expr ty in
      Some (name, kind, deps)
    | VernacEndProof _ -> None
    | VernacExactProof _ -> None
    | VernacAssumption (_, _, _) -> None
    | VernacSymbol _ -> None
    | VernacInductive (_, _) -> None
    | VernacFixpoint (_, _) -> None
    | VernacCoFixpoint (_, _) -> None
    | VernacScheme _ -> None
    | VernacSchemeEquality (_, _) -> None
    | VernacCombinedScheme (_, _) -> None
    | VernacUniverse _ -> None
    | VernacSort _ -> None
    | VernacConstraint _ -> None
    | VernacAddRewRule (_, _) -> None
    | VernacCanonical _ -> None
    | VernacCoercion (_, _) -> None
    | VernacIdentityCoercion (_, _, _) -> None
    | VernacNameSectionHypSet (_, _) -> None
    | VernacInstance (_, _, _, _, _) -> None
    | VernacDeclareInstance (_, _, _, _) -> None
    | VernacContext _ -> None
    | VernacExistingInstance _ -> None
    | VernacExistingClass _ -> None
    | VernacResetName _ -> None
    | VernacResetInitial -> None
    | VernacBack _ -> None
    | VernacCreateHintDb (_, _) -> None
    | VernacRemoveHints (_, _) -> None
    | VernacHints (_, _) -> None
    | VernacSyntacticDefinition (_, _, _) -> None
    | VernacArguments (_, _, _, _) -> None
    | VernacReserve _ -> None
    | VernacGeneralizable _ -> None
    | VernacSetOpacity (_, _) -> None
    | VernacSetStrategy _ -> None
    | VernacMemOption (_, _) -> None
    | VernacPrintOption _ -> None
    | VernacCheckMayEval (_, _, _) -> None
    | VernacGlobalCheck _ -> None
    | VernacDeclareReduction (_, _) -> None
    | VernacPrint _ -> None
    | VernacSearch (_, _, _) -> None
    | VernacLocate _ -> None
    | VernacRegister (_, _) -> None
    | VernacPrimitive (_, _, _) -> None
    | VernacComments _ -> None
    | VernacAttributes _ -> None
    | VernacAbort -> None
    | VernacAbortAll -> None
    | VernacRestart -> None
    | VernacUndo _ -> None
    | VernacUndoTo _ -> None
    | VernacFocus _ -> None
    | VernacUnfocus -> None
    | VernacUnfocused -> None
    | VernacBullet _ -> None
    | VernacSubproof _ -> None
    | VernacEndSubproof -> None
    | VernacShow _ -> None
    | VernacCheckGuard -> None
    | VernacValidateProof -> None
    | VernacProof (_, _) -> None
    | VernacAddOption (_, _) -> None
    | VernacRemoveOption (_, _) -> None)

let analyze (node : Doc.Node.t) =
  match node.ast with
  | Some { v; _ } -> analyze (Coq.Ast.to_coq v)
  | _ -> None

(* We output a record for each object we can recognize in the document, linear
   order. *)
module Node_info = struct
  (* Just to bring the serializers in scope *)
  module Lang = Lsp.JLang
  module Coq = Lsp.JCoq

  type t =
    { uri : Lang.LUri.File.t
    ; range : Lang.Range.t
    ; kind : Kind.t
    ; name : string
    ; raw : string
    ; deps : string list
    }
  [@@deriving to_yojson]

  let of_node ~io:_ ~token:_ ~uri ~(contents : Contents.t) (node : Doc.Node.t) =
    match analyze node with
    | None -> None
    | Some (name, kind, deps) ->
      (* let uuid = "TODO" in *)
      let range = node.range in
      let name =
        match name with
        | Some name -> name
        | None -> "anonymous"
      in
      let deps = List.sort_uniq String.compare deps in
      let raw = Fleche.Contents.extract_raw ~contents ~range in
      Some { uri; range; kind; name; raw; deps }
end

module GDB = struct
  (* Object identifier *)
  module Id = struct
    type t = string [@@deriving to_yojson]
  end

  module Attr = struct
    type t = string list [@@deriving to_yojson]
  end

  module Node = struct
    type t =
      { id : Id.t
      ; attrs : Attr.t
      }
    [@@deriving to_yojson]
  end

  module Edge = struct
    type t =
      { from : Id.t
      ; to_ : Id.t [@key "to"]
      ; attrs : Attr.t
      ; label : string
      }
    [@@deriving to_yojson]
  end

  module Labels = struct
    type t = (Id.t * string) list

    let to_yojson l =
      let f (id, label) = (id, `String label) in
      let fields = List.map f l in
      `Assoc fields
  end
end

module Meta = struct
  open GDB

  type t = Node.t list * Edge.t list * Labels.t

  let mk_edges ~from ~deps ~attrs =
    let f to_ = { Edge.from; to_; attrs; label = "USES" } in
    List.map f deps

  let rec to_graph_db (nl, el, ll) (l : Node_info.t list) : t =
    match l with
    | [] -> (List.rev nl, List.rev el, List.rev ll)
    | n :: l ->
      let { Node_info.uri = _; range = _; kind; name; raw = _; deps } = n in
      let attrs = [] in
      let nn = { Node.id = name; attrs } in
      let ne = mk_edges ~from:name ~deps ~attrs in
      let nll = (name, Kind.to_string kind) in
      to_graph_db (nn :: nl, ne @ el, nll :: ll) l

  let to_graph_db (l : Node_info.t list) : t = to_graph_db ([], [], []) l

  (* Create nodes for orphan deps in the graph *)
  let to_graph_db l =
    let nl, el, ll = to_graph_db l in
    (nl, el, ll)

  let pp fmt (nl, el, l) =
    let nl = `List (List.map Node.to_yojson nl) in
    let el = `List (List.map Edge.to_yojson el) in
    let l = Labels.to_yojson l in
    let obj = `Assoc [ ("edges", el); ("nodes", nl); ("node_labels", l) ] in
    let obj = `Assoc [ ("graph", obj) ] in
    Format.fprintf fmt "@[%a@]@\n" (Yojson.Safe.pretty_print ~std:true) obj
end

let dump_meta ~io ~token ~out_file ~(doc : Doc.t) =
  let uri, contents = (doc.uri, doc.contents) in
  let ll =
    List.filter_map (Node_info.of_node ~io ~token ~uri ~contents) doc.nodes
  in
  let ll = Meta.to_graph_db ll in
  let f fmt meta = Meta.pp fmt meta in
  Coq.Compat.format_to_file ~file:out_file ~f ll

let dump_meta ~io ~token ~(doc : Doc.t) =
  let uri = doc.uri in
  let uri_str = Lang.LUri.File.to_string_uri uri in
  let lvl = Io.Level.Info in
  Io.Report.msg ~io ~lvl "[metanejo plugin] dumping metadata for %s ..." uri_str;
  let out_file_j = Lang.LUri.File.to_string_file uri ^ ".meta.json" in
  let () = dump_meta ~io ~token ~out_file:out_file_j ~doc in
  (* let out_file_s = Lang.LUri.File.to_string_file uri ^ ".sexp.goaldump" in *)
  (* let () = dump_goals ~out_file:out_file_s ~doc pp_sexp in *)
  Io.Report.msg ~io ~lvl
    "[metanejo plugin] dumping metadata for %s was completed!" uri_str;
  ()

let main () = Theory.Register.Completed.add dump_meta
let () = main ()