Module `IBase.SourceFile`

type t

val compare : t -> t -> int

module Map : IStdlib.IStd.Caml.Map.S with type Map.key = t: Maps from source_file

module Set : IStdlib.IStd.Caml.Set.S with type Set.elt = t: Set of source files

module Hash : IStdlib.IStd.Caml.Hashtbl.S with type Hash.key = t

val is_invalid : t -> bool: Is the source file the invalid source file?

val read_config_changed_files : unit -> Set.t option: return the list of changed files as read from Config.changed_files_index. NOTE: it may include extra source_files if --changed-files-index contains paths to header files.

val invalid : string -> t: Invalid source file

val equal : t -> t -> bool: equality of source files

val from_abs_path : ?⁠warn_on_error:bool -> string -> t: create source file from absolute path. WARNING: If warn_on_error is false, no warning will be shown whenever an error occurs for the given path (e.g. if it does not exist).

val create : ?⁠warn_on_error:bool -> string -> t: Create a SourceFile from a given path. If relative, it assumes it is w.r.t. project root. WARNING: If warn_on_error is false, no warning will be shown whenever an error occurs for the given path (e.g. if it does not exist).

val is_under_project_root : t -> bool: Returns true if the file is under the project root or the workspace directory if it exists

val of_header : ?⁠warn_on_error:bool -> t -> t option: Return approximate source file corresponding to the parameter if it's header file and file exists. returns None otherwise. WARNING: If warn_on_error is false, no warning will be shown whenever an error occurs for the given SourceFile (e.g. if it does not exist).

val pp : Stdlib.Format.formatter -> t -> unit: pretty print t

val to_abs_path : t -> string: get the full path of a source file

val to_rel_path : t -> string: get the relative path of a source file

val to_string : ?⁠force_relative:bool -> t -> string: convert a source file to a string WARNING: result may not be valid file path, do not use this function to perform operations on filenames

val has_extension : t -> ext:string -> bool: returns whether the source file has provided extension

module SQLite : SqliteUtils.Data with type t = t

module Normalizer : IStdlib.HashNormalizer.S with type t = t