1Load_path(3) OCaml library Load_path(3)
2
3
4
6 Load_path - Management of include directories.
7
9 Module Load_path
10
12 Module Load_path
13 : sig end
14
15
16 Management of include directories.
17
18 This module offers a high level interface to locating files in the load
19 path, which is constructed from -I command line flags and a few other
20 parameters.
21
22 It makes the assumption that the contents of include directories
23 doesn't change during the execution of the compiler.
24
25
26
27
28
29
30 val add_dir : string -> unit
31
32 Add a directory to the load path
33
34
35
36 val remove_dir : string -> unit
37
38 Remove a directory from the load path
39
40
41
42 val reset : unit -> unit
43
44 Remove all directories
45
46
47
48 val init : string list -> unit
49
50
51 init l is the same as reset (); List.iter add_dir (List.rev l)
52
53
54
55
56 val get_paths : unit -> string list
57
58 Return the list of directories passed to add_dir so far, in reverse
59 order.
60
61
62
63 val find : string -> string
64
65 Locate a file in the load path. Raise Not_found if the file cannot be
66 found. This function is optimized for the case where the filename is a
67 basename, i.e. doesn't contain a directory separator.
68
69
70
71 val find_uncap : string -> string
72
73 Same as find , but search also for uncapitalized name, i.e. if name is
74 Foo.ml, allow /path/Foo.ml and /path/foo.ml to match.
75
76
77 module Dir : sig end
78
79
80
81
82
83 val add : Dir.t -> unit
84
85
86
87
88 val get : unit -> Dir.t list
89
90 Same as get_paths () , except that it returns a Dir.t list .
91
92
93
94
95
96OCamldoc 2020-02-27 Load_path(3)