File: find_ml_file.doc

package info (click to toggle)
hol88 2.02.19940316dfsg-5
  • links: PTS
  • area: main
  • in suites: bookworm
  • size: 65,816 kB
  • sloc: ml: 199,939; ansic: 9,666; sh: 6,913; makefile: 6,032; lisp: 2,747; yacc: 894; sed: 201; cpp: 87; awk: 5
file content (34 lines) | stat: -rw-r--r-- 827 bytes parent folder | download | duplicates (11)
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
\DOC find_ml_file

\TYPE {find_ml_file: (string -> string)}

\SYNOPSIS
Searches for a named {ML} file.

\DESCRIBE
Given a {`.ml`} suffixed string {`foo.ml`}, {find_ml_file} searches for the
{ML} source file {foo.ml}. If the given string does not have a {`.ml`} suffix,
then {find_ml_file} searches for the object file {foo_ml.o} or the {ML} source
file {foo.ml}. If the object file exists, then its name is returned.
Otherwise, the name of the {ML} source file is returned if it
exists.

\FAILURE
Fails if the appropriate file cannot be found using the current search path.

\EXAMPLE
{
#find_ml_file `foo`;;
`foo_ml.o` : string

#find_ml_file `foo.ml`;;
`foo.ml` : string
}
\USES
Typically used to determine whether an object file exists for a named {ML}
source file.

\SEEALSO
find_file, search_path, set_search_path

\ENDDOC