package lsp

  1. Overview
  2. Docs
package lsp
Legend:
Library
Module
Module type
Parameter
Class
Class type

Representation of paths

The aim of this module is to provide a solid basis to reason about file and directory paths inside the Dune code base. What it is not is a complete API for paths management that handles all the aspects of file system paths. It simply exposes a high-level and portable API that covers the needs of Dune.

Model of the file system

Local paths

Dune sees the file system as two parts. The first part is composed of the source tree and the build directory. In this part, Dune doesn't know about symlinks and has a fully expanded view of the file system. This means that if the user has a symlink `src/foo` pointing to `bar`, then `src/foo/x` and `bar/x` are seen as two different paths.

A path in this world is called a local path and is simply a sequence of path components. A path component being a string other than "." or ".." and not containing the path separator character ('/').

Such a path can be rooted at the source tree root, the build directory or an unspecified root. All these paths are represented by values of type 'a Path.Local_gen.t where 'a denotes the root of the path.

External paths

The second part is the "external world". It is all the paths that live outside of the workspace and build directory. To be on the safe side Dune makes no assumption does nothing clever with these paths.

External paths are presented as Path.External.t values.contents

The Path.t type

The Path.t type represents all possible paths, i.e. both local and extenral paths.

module Local_gen : sig ... end

Relative path relative to the root tracked by the type system.

module Unspecified : sig ... end
module Local : sig ... end

Relative path with unspecified root.

module Source : sig ... end

In the source section of the current workspace.

module External : sig ... end
module Build : sig ... end
type t = private
  1. | External of External.t
  2. | In_source_tree of Source.t
  3. | In_build_dir of Build.t
val to_string : t -> string
val of_string : string -> t
val parse_string_exn : loc:Stdune__.Loc0.t -> string -> t

a directory is smaller than its descendants

include Comparator.S with type t := t
val compare : t -> t -> Ordering.t
include Comparator.OPS with type t := t
val equal : t -> t -> bool
val (=) : t -> t -> bool
val (>=) : t -> t -> bool
val (>) : t -> t -> bool
val (<=) : t -> t -> bool
val (<) : t -> t -> bool
val (<>) : t -> t -> bool
val to_dyn : t -> Dyn.t
val extension : t -> string
val set_extension : t -> ext:string -> t

set_extension path ~ext replaces extension of path by ext

val split_extension : t -> t * string
val basename : t -> string
val basename_opt : t -> string option
module Set : sig ... end
module Map : Map.S with type key = t
module Table : Hashtbl.S with type key = t
val parent_exn : t -> t
val parent : t -> t option
val hash : t -> int
val to_string_maybe_quoted : t -> string

to_string_maybe_quoted t is maybe_quoted (to_string t)

val root : t
val external_ : External.t -> t
val is_root : t -> bool
val is_managed : t -> bool
val relative : ?error_loc:Stdune__.Loc0.t -> t -> string -> t
val of_filename_relative_to_initial_cwd : string -> t

Create an external path. If the argument is relative, assume it is relative to the initial directory dune was launched in.

val to_absolute_filename : t -> string

Convert a path to an absolute filename. Must be called after the workspace root has been set. root is the root directory of local paths

val reach : t -> from:t -> string

Reach a given path from a directory. For example, let p be a path to the file some/dir/file and d be a path to the directory some/another/dir. Then reach p ~from:d evaluates to ../../dir/file.

val reach_for_running : ?from:t -> t -> string

from defaults to Path.root

val descendant : t -> of_:t -> t option
val is_descendant : t -> of_:t -> bool
val append_local : t -> Local.t -> t
val append_source : t -> Source.t -> t
val extend_basename : t -> suffix:string -> t
val extract_build_context : t -> (string * Source.t) option

Extract the build context from a path. For instance, representing paths as strings:

extract_build_context "_build/blah/foo/bar" = Some ("blah", "foo/bar")

It doesn't work correctly (doesn't return a sensible source path) for build directories that are not build contexts, e.g. "_build/install" and "_build/.aliases".

val extract_build_context_exn : t -> string * Source.t
val extract_build_dir_first_component : t -> (string * Local.t) option
val extract_build_context_dir : t -> (t * Source.t) option

Same as extract_build_context but return the build context as a path:

extract_build_context "_build/blah/foo/bar"
= Some ("_build/blah", "foo/bar")
val extract_build_context_dir_maybe_sandboxed : t -> (t * Source.t) option
val extract_build_context_dir_exn : t -> t * Source.t
val drop_build_context : t -> Source.t option

Drop the "_build/blah" prefix

val drop_build_context_exn : t -> Source.t
val drop_optional_build_context : t -> t

Drop the "_build/blah" prefix if present, return t otherwise

val drop_optional_build_context_maybe_sandboxed : t -> t
val drop_optional_sandbox_root : t -> t
val drop_optional_build_context_src_exn : t -> Source.t

Drop the "_build/blah" prefix if present, return t if it's a source file, otherwise fail.

val explode : t -> string list option
val explode_exn : t -> string list
val build_dir : t

The build directory

val is_in_build_dir : t -> bool

is_in_build_dir t = is_descendant t ~of:build_dir

val is_in_source_tree : t -> bool

is_in_source_tree t = is_managed t && not (is_in_build_dir t)

val as_in_source_tree : t -> Source.t option
val as_in_source_tree_exn : t -> Source.t
val as_in_build_dir : t -> Build.t option
val as_in_build_dir_exn : t -> Build.t
val is_strict_descendant_of_build_dir : t -> bool

is_strict_descendant_of_build_dir t = is_in_build_dir t && t <> build_dir

val split_first_component : t -> (string * t) option

Split after the first component if t is local

val insert_after_build_dir_exn : t -> string -> t
val exists : t -> bool
val readdir_unsorted : t -> (string list, Unix.error) Result.t
val readdir_unsorted_with_kinds : t -> ((string * Unix.file_kind) list, Unix.error) Result.t
val is_dir_sep : char -> bool
val is_directory : t -> bool
val is_directory_with_error : t -> (bool, string) Result.t
val is_file : t -> bool
val rmdir : t -> unit
val rm_rf : ?allow_external:bool -> t -> unit
val clear_dir : t -> unit

clear_dir t deletes all the contents of directory t without removing t itself

val mkdir_p : ?perms:int -> t -> unit
val touch : ?create:bool -> t -> unit
val build_dir_exists : unit -> bool
val ensure_build_dir_exists : unit -> unit
val source : Source.t -> t
val build : Build.t -> t
val in_source : string -> t

paths guaranteed to be in the source directory

val of_local : Local.t -> t
val set_root : External.t -> unit

Set the workspace root. Can only be called once and the path must be absolute

module L : sig ... end
val local_part : t -> Local.t

Return the "local part" of a path. For local paths (in build directory or source tree), this returns the path itself. For external paths, it returns a path that is relative to the current directory. For example, the local part of /a/b is ./a/b.

val stat : t -> Unix.stats
val lstat : t -> Unix.stats
val set_of_source_paths : Source.Set.t -> Set.t
val set_of_build_paths_list : Build.t list -> Set.t
val string_of_file_kind : Unix.file_kind -> string
val rename : t -> t -> unit

Rename a file. rename oldpath newpath renames the file called oldpath, giving it newpath as its new name, moving it between directories if needed. If newpath already exists, its contents will be replaced with those of oldpath.

val chmod : mode:int -> ?stats:Unix.stats option -> ?op:[ `Add | `Remove | `Set ] -> t -> unit

Set permissions on the designed files. op is `Set by default, which sets the permissions exactly to mode, while `Add will add the given mode to the current permissions and `Remove remove them. path will be stat'd in the `Add and `Remove case to determine the current permission, unless the already computed stats are passed as stats to save a system call.

Attempts to resolve a symlink. Returns None if the path isn't a symlink

OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct