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
|
(************************************************************************)
(* * The Coq Proof Assistant / The Coq Development Team *)
(* v * Copyright INRIA, CNRS and contributors *)
(* <O___,, * (see version control and CREDITS file for authors & dates) *)
(* \VV/ **************************************************************)
(* // * This file is distributed under the terms of the *)
(* * GNU Lesser General Public License Version 2.1 *)
(* * (see LICENSE file for the text of the license) *)
(************************************************************************)
exception Parsing_error of string
type arg_source = CmdLine | ProjectFile
type 'a sourced = { thing : 'a; source : arg_source }
type meta_file = Absent | Present of string | Generate of string
type 'a project = {
project_file : string option;
makefile : string option;
native_compiler : native_compiler option;
(* the installation path for installing project documentation (relative to
* the user-contrib folder) *)
docroot : string option;
files : string sourced list; (* .v, .ml, .mlg, .mli, .mllib, .mlpack files *)
cmd_line_files : string sourced list;
meta_file : meta_file;
ml_includes : path sourced list;
r_includes : (path * logic_path) sourced list;
q_includes : (path * logic_path) sourced list;
extra_args : string sourced list;
defs : (string * string) sourced list;
extra_data : 'a;
}
and logic_path = string
and path = { path : string; canonical_path : string }
and native_compiler =
| NativeYes
| NativeNo
| NativeOndemand
val cmdline_args_to_project
: warning_fn:(string -> unit) -> curdir:string
-> parse_extra:(string -> string list -> 'a -> (string list * 'a) option)
-> 'a -> string list -> 'a project
exception UnableToOpenProjectFile of string
val read_project_file : warning_fn:(string -> unit) -> string -> unit project
(** [read_project_file warning_fn file] parses [file] as a Coq project;
use [warning_fn] for deprecate options;
raise [Parsing_error] on illegal options or arguments;
raise [UnableToOpenProjectFile msg] if the file could not be opened;
fails on some illegal non-project-file options *)
val coqtop_args_from_project : _ project -> string list
val find_project_file : from:string -> projfile_name:string -> string option
val all_files : _ project -> string sourced list
val files_by_suffix : string sourced list -> string list -> string sourced list
val map_sourced_list : ('a -> 'b) -> 'a sourced list -> 'b list
(** Only uses the elements with source=CmdLine *)
val map_cmdline : ('a -> 'b) -> 'a sourced list -> 'b list
val forget_source : 'a sourced -> 'a
|
