Module Catala_utils.FileSource

Sourcetype t = string

Utility functions used for file manipulation.

Sourceval with_out_channel : t -> (out_channel -> 'a) -> 'a

Runs the given function with the provided file opened, ensuring it is properly closed afterwards. May raise just as open_out.

Sourceval with_in_channel : t -> (in_channel -> 'a) -> 'a

Runs the given function with the provided file opened, ensuring it is properly closed afterwards. May raise just as open_in.

Formatter wrappers

Sourceval with_formatter_of_out_channel : out_channel -> (Format.formatter -> 'a) -> 'a

with_formatter_of_out_channel oc f creates an flushes the formatter used in f from the given out_channel oc.

Sourceval with_formatter_of_file : t -> (Format.formatter -> 'a) -> 'a

with_formatter_of_file filename f manages the formatter created from the file filename used in f -- i.e. closes the corresponding out_channel and flushes the formatter.

Sourceval with_formatter_of_opt_file : t option -> (Format.formatter -> 'a) -> 'a

with_formatter_of_opt_file filename_opt f manages the formatter created from the file filename_opt if there is some (see with_formatter_of_file), otherwise, uses the Format.std_formatter.

Sourceval get_out_channel : source_file:Cli.input_src -> output_file:t option -> ?ext:string -> unit -> t option * ((out_channel -> 'a) -> 'a)

get_output ~source_file ~output_file ?ext () returns the inferred filename and its corresponding with_out_channel function. If the output_file is equal to Some "-" returns a wrapper around stdout.

Sourceval get_formatter_of_out_channel : source_file:Cli.input_src -> output_file:t option -> ?ext:string -> unit -> t option * ((Format.formatter -> 'a) -> 'a)

get_output_format ~source_file ~output_file ?ext () returns the inferred filename and its corresponding with_formatter_of_out_channel function. If the output_file is equal to Some "-" returns a wrapper around stdout.

Sourceval temp_file : string -> string -> t

Like Filename.temp_file, but registers the file for deletion at program exit unless Cli.debug_flag is set.

Sourceval with_temp_file : string -> string -> ?contents:string -> (t -> 'a) -> 'a

Creates a temp file (with prefix and suffix like temp_file, optionally with the given contents, for the lifetime of the supplied function, then remove it unconditionally

Sourceval contents : t -> string

Reads the contents of a file as a string

Sourceval process_out : ?check_exit:(int -> unit) -> string -> string list -> string

process_out cmd args executes the given command with the specified arguments, and returns the stdout of the process as a string. check_exit is called on the return code of the sub-process, the default is to fail on anything but 0.

Sourceval check_directory : t -> t option

Checks if the given directory exists and returns it normalised (as per Unix.realpath).

Sourceval check_file : t -> t option

Returns its argument if it exists and is a plain file, None otherwise. Does not do resolution like check_directory.

Sourceval check_exec : t -> t

Resolves a command:

  • if t is a plain name, resolve in PATH
  • if t is relative, returns its absolute path
  • fails with an error explaining that t was not found
Sourceval (/) : t -> t -> t

Filename.concat: Sugar to allow writing File.("some" / "relative" / "path"). As an exception, if the lhs is ., returns the rhs unchanged.

Sourceval dirname : t -> t

Filename.dirname, re-exported for convenience

Sourceval (/../) : t -> t -> t

Sugar for Filename.dirname "a" / b

Sourceval (-.-) : t -> string -> t

Extension replacement: chops the given filename extension, and replaces it with the given one (which shouldn't contain a dot)

Sourceval path_to_list : t -> string list

Empty elements or current-directory (".") are skipped in the resulting list

Sourceval equal : t -> t -> bool

Case-insensitive string comparison (no file resolution whatsoever)

Sourceval compare : t -> t -> int

Case-insensitive string comparison (no file resolution whatsoever)

Sourceval format : Format.formatter -> t -> unit

Formats a filename in a consistent style, with double-quotes and color (when the output supports)

Sourcemodule Set : Set.S with type elt = t
Sourcemodule Map : Map.S with type key = t
Sourceval scan_tree : (t -> 'a option) -> t -> (t * t list * 'a list) Seq.t

Recursively scans a directory for files. Directories or files matching ".*" or "_*" are ignored. Unreadable files or subdirectories are ignored with a debug message. If t is a plain file, scan just that non-recursively.

The matching results are returned grouped by directory, case-insensitively ordered by filename, as a list of non-empty subdirs and a list of extracted items.

Sourcemodule Tree : sig ... end

A lazy tree structure mirroring the filesystem ; uses the comparison from File, so paths are case-insensitive.