Frama-C:
Plug-ins:
Libraries:

Frama-C API - Share

Handle the specific `share' directory of the plug-in.

  • since Oxygen-20120901
  • before 30.0-Zinc

    more modes were allowed

val set : Filepath.t -> unit

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

val get : unit -> Filepath.t
  • returns

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

val is_set : unit -> bool
  • returns

    whether the <dune-site-dir> has been set.

include Parameter_sig.Site_dir
val get_dir : string -> Filepath.t

get_dir name tries to find the directory named name in the site. The function aborts if: name cannot be found or is a file instead of a directory, otherwise it returns the path.

Be careful! This function finds the first directory that exists in the site path. Thus, by extending this path, we get *only* the subdirs and files in this directory, not in all directories of same name. Builder.Make_site_dir can be used to get directories that will always perform the resolution.

val get_file : string -> Filepath.t

get_file name tries to find the file named name in the site. The function aborts if: name cannot be found or is a directory instead of a file, otherwise it returns the path.