package frama-c

  1. Overview
  2. Docs
package frama-c
Legend:
Library
Module
Module type
Parameter
Class
Class type

Builds a User_dir_opt from an existing User_dir. The first parameter is the parent directory. The second gives the name of the directory to create (also used to create the option name), a possible environment variable name and the help message for the option.

  • since 30.0-Zinc

Parameters

module _ : Parameter_sig.User_dir
module _ : sig ... end

Signature

include Parameter_sig.User_dir
val get_dir : ?create_path:bool -> string -> Filepath.Normalized.t

get_dir ~create_path name tries to get the directory name. The function aborts if:

  • a file named name exists,
  • creating a the directory fails.

Otherwise returns the path, and creates it if create_path is true (it defaults to false). Subdirectories modules can be created with Builder.Make_user_dir and Builder.Make_user_dir_opt.

val get_file : ?create_path:bool -> string -> Filepath.Normalized.t

get_file ~create_path name tries to get the file name. The function aborts if:

  • a directory named name exists,
  • creating the path to the file fails.

Otherwise returns the path, and creates the directories that lead to the file if create_path is true (it defaults to false). The file is *not* created by the function.

val set : Filepath.Normalized.t -> unit

Sets the <user-dir> directory (without creating it).

val get : unit -> Filepath.Normalized.t
  • returns

    the <user-dir> directory (without creating it).

val is_set : unit -> bool
  • returns

    whether the <user-dir> has been set.

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