File: file_util.mli

package info (click to toggle)
coq 8.20.1%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 44,116 kB
  • sloc: ml: 234,160; sh: 4,301; python: 3,270; ansic: 2,644; makefile: 882; lisp: 172; javascript: 63; xml: 24; sed: 2
file content (26 lines) | stat: -rw-r--r-- 1,586 bytes parent folder | download | duplicates (2)
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
(************************************************************************)
(*         *   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)         *)
(************************************************************************)

(** [to_relative_path path] takes as input a file path [path], and constructs
    an equivalent relative path from the current working directory. If [path]
    is already relative, then it is returned immediately. *)
val to_relative_path : string -> string

(** [normalize_path path] takes as input a file path [path], and returns an
    equivalent path that: (1) does not contain the current directory member
    ["."] unless the path is to the current directory (in which case ["."]
    is returned, or ["./"] if [path] has a trailing ["/"]), (2) only uses
    parent directory members [".."] for a prefix of the path, and (3), has
    a trailing ["/"] only if and only if [path] does.

    For example, paths ["dir1/dir2/file.v"], ["."], ["dir1/dir2/dir3/"] and
    ["../../dir/file.v"] are possible return values, but ["./file.v"] and
    ["dir1/../dir2"] are not. *)
val normalize_path : string -> string