Module Stdlib.Filename

Instructions: Use this module in your project

In the IDE (CLion, Visual Studio Code, Xcode, etc.) you use for your DkSDK project:

Add the following to your project's dependencies/CMakeLists.txt:

Copy

DkSDKProject_DeclareAvailable(ocaml
    CONSTRAINT "= 4.14.0"
    FINDLIBS str unix runtime_events threads dynlink)
DkSDKProject_MakeAvailable(ocaml)

Add the Findlib::ocaml library to any desired targets in src/*/CMakeLists.txt:

Copy

target_link_libraries(YourPackage_YourLibraryName
     # ... existing libraries, if any ...
     Findlib::ocaml)

Click your IDE's Build button

Not using DkSDK?

FIRST, do one or all of the following:

Run:
Copy
```
opam install ocaml.4.14.0
```

Edit your dune-project and add:

Copy

(package
  (name YourExistingPackage)
  (depends
  ; ... existing dependenices ...
  (ocaml (>= 4.14.0))))

Then run:

Copy

dune build *.opam # if this fails, run: dune build

Edit your <package>.opam file and add:

Copy

depends: [
  # ... existing dependencies ...
  "ocaml" {>= "4.14.0"}
]

Then run:

Copy

opam install . --deps-only

FINALLY, add the library to any desired (library)and/or (executable) targets in your **/dune files:

Copy

(library
  (name YourLibrary)
  ; ... existing library options ...
  (libraries
    ; ... existing libraries ...
    ))

(executable
  (name YourExecutable)
  ; ... existing executable options ...
  (libraries
    ; ... existing libraries ...
    ))

val current_dir_name : string

The conventional name for the current directory (e.g. . in Unix).

val parent_dir_name : string

The conventional name for the parent of the current directory (e.g. .. in Unix).

val dir_sep : string

The directory separator (e.g. / in Unix).

since 3.11.2

valconcat : ``string->``string-> string

concat dir file returns a file name that designates file file in directory dir.

valis_relative : ``string-> bool

Return true if the file name is relative to the current directory, false if it is absolute (i.e. in Unix, starts with /).

valis_implicit : ``string-> bool

Return true if the file name is relative and does not start with an explicit reference to the current directory (./ or ../ in Unix), false if it starts with an explicit reference to the root directory or the current directory.

valcheck_suffix : ``string->``string-> bool

check_suffix name suff returns true if the filename name ends with the suffix suff.

Under Windows ports (including Cygwin), comparison is case-insensitive, relying on String.lowercase_ascii. Note that this does not match exactly the interpretation of case-insensitive filename equivalence from Windows.

valchop_suffix : ``string->``string-> string

chop_suffix name suff removes the suffix suff from the filename name.

raises Invalid_argument

if name does not end with the suffix suff.

valchop_suffix_opt : ``suffix:string->``string-> ``string option

chop_suffix_opt ~suffix filename removes the suffix from the filename if possible, or returns None if the filename does not end with the suffix.

since 4.08

valextension : ``string-> string

extension name is the shortest suffix ext of name0 where:

name0 is the longest suffix of name that does not contain a directory separator;
ext starts with a period;
ext is preceded by at least one non-period character in name0.

If such a suffix does not exist, extension name is the empty string.

since 4.04

valremove_extension : ``string-> string

Return the given file name without its extension, as defined in Filename.extension. If the extension is empty, the function returns the given file name.

The following invariant holds for any file name s:

remove_extension s ^ extension s = s

since 4.04

valchop_extension : ``string-> string

Same as Filename.remove_extension, but raise Invalid_argument if the given name has an empty extension.

valbasename : ``string-> string

Split a file name into directory name / base file name. If name is a valid file name, then concat (dirname name) (basename name) returns a file name which is equivalent to name. Moreover, after setting the current directory to dirname name (with Sys.chdir), references to basename name (which is a relative file name) designate the same file as name before the call to Sys.chdir.

This function conforms to the specification of POSIX.1-2008 for the basename utility.

valdirname : ``string-> string

See Filename.basename. This function conforms to the specification of POSIX.1-2008 for the dirname utility.

val null : string

null is "/dev/null" on POSIX and "NUL" on Windows. It represents a file on the OS that discards all writes and returns end of file on reads.

since 4.10.0

valtemp_file : ``?temp_dir:string->``string->``string-> string

temp_file prefix suffix returns the name of a fresh temporary file in the temporary directory. The base name of the temporary file is formed by concatenating prefix, then a suitably chosen integer number, then suffix. The optional argument temp_dir indicates the temporary directory to use, defaulting to the current result of Filename.get_temp_dir_name. The temporary file is created empty, with permissions 0o600 (readable and writable only by the file owner). The file is guaranteed to be different from any other file that existed when temp_file was called.

raises Sys_error

if the file could not be created.
before 3.11.2

no ?temp_dir optional argument

val open_temp_file : ``?mode:open_flaglist``->``?perms:int->``?temp_dir:string->``string->``string->string *out_channel

Same as Filename.temp_file, but returns both the name of a fresh temporary file, and an output channel opened (atomically) on this file. This function is more secure than temp_file: there is no risk that the temporary file will be modified (e.g. replaced by a symbolic link) before the program opens it. The optional argument mode is a list of additional flags to control the opening of the file. It can contain one or several of Open_append, Open_binary, and Open_text. The default is [Open_text] (open in text mode). The file is created with permissions perms (defaults to readable and writable only by the file owner, 0o600).

raises Sys_error

if the file could not be opened.
before 4.03.0

no ?perms optional argument
before 3.11.2

no ?temp_dir optional argument

valget_temp_dir_name : ``unit-> string

The name of the temporary directory: Under Unix, the value of the TMPDIR environment variable, or "/tmp" if the variable is not set. Under Windows, the value of the TEMP environment variable, or "." if the variable is not set. The temporary directory can be changed with Filename.set_temp_dir_name.

since 4.00.0

valset_temp_dir_name : ``string-> unit

Change the temporary directory returned by Filename.get_temp_dir_name and used by Filename.temp_file and Filename.open_temp_file.

since 4.00.0

val temp_dir_name : string

The name of the initial temporary directory: Under Unix, the value of the TMPDIR environment variable, or "/tmp" if the variable is not set. Under Windows, the value of the TEMP environment variable, or "." if the variable is not set.

deprecated

You should use Filename.get_temp_dir_name instead.
since 3.09.1

valquote : ``string-> string

Return a quoted version of a file name, suitable for use as one argument in a command line, escaping all meta-characters. Warning: under Windows, the output is only suitable for use with programs that follow the standard Windows quoting conventions.

valquote_command : ``string->``?stdin:string->``?stdout:string->``?stderr:string->``string list``-> string

quote_command cmd args returns a quoted command line, suitable for use as an argument to Sys.command, Unix.system, and the Unix.open_process functions.

The string cmd is the command to call. The list args is the list of arguments to pass to this command. It can be empty.

The optional arguments ?stdin and ?stdout and ?stderr are file names used to redirect the standard input, the standard output, or the standard error of the command. If ~stdin:f is given, a redirection < f is performed and the standard input of the command reads from file f. If ~stdout:f is given, a redirection > f is performed and the standard output of the command is written to file f. If ~stderr:f is given, a redirection 2> f is performed and the standard error of the command is written to file f. If both ~stdout:f and ~stderr:f are given, with the exact same file name f, a 2>&1 redirection is performed so that the standard output and the standard error of the command are interleaved and redirected to the same file f.

Under Unix and Cygwin, the command, the arguments, and the redirections if any are quoted using Filename.quote, then concatenated. Under Win32, additional quoting is performed as required by the cmd.exe shell that is called by Sys.command.

raises Failure

if the command cannot be escaped on the current platform.
since 4.10.0

More from the DkSDK Book

1. DkSDK
1. 1. Package capnp
  1. 1. Module Capnp
    1. 1. Module type MessageSig.MESSAGE
        Module type MessageSig.S
        Module S.ListStorage
        Module S.Message
        Module S.Object
        Module S.Segment
        Module S.Slice
        Module S.StructStorage
        Module type MessageSig.SEGMENT
        Module type MessageSig.SLICE
    1. Module Capnp_unix
  1. Package cmdliner
  1. 1. Module Cmdliner
    1. Module Cmdliner_arg
    1. Module Cmdliner_base
    1. Module Cmdliner_cline
    1. Module Cmdliner_cmd
    1. Module Cmdliner_docgen
    1. Module Cmdliner_eval
    1. Module Cmdliner_info
    1. Module Cmdliner_manpage
    1. Module Cmdliner_msg
    1. Module Cmdliner_term
    1. Module Cmdliner_term_deprecated
    1. Module Cmdliner_trie
  1. Package fmt
  1. 1. Module Fmt
    1. Module Fmt_cli
    1. Module Fmt_tty
  1. Package logs
  1. 1. Module Logs
    1. 1. Module type Logs.LOG
      1. ...
    1. Module Logs_cli
    1. Module Logs_fmt
    1. Module Logs_lwt
    1. 1. Module type Logs_lwt.LOG
    1. Module Logs_threaded
  1. Package lwt
  1. 1. Module Lwt
    1. Module Lwt_bytes
    1. Module Lwt_condition
    1. Module Lwt_config
    1. Module Lwt_engine
    1. Module Lwt_features
    1. Module Lwt_fmt
    1. Module Lwt_gc
    1. Module Lwt_io
    1. 1. Module type Lwt_io.NumberIO
    1. Module Lwt_list
    1. Module Lwt_main
    1. 1. Module type Lwt_main.Hooks
    1. Module Lwt_mutex
    1. Module Lwt_mvar
    1. Module Lwt_pool
    1. Module Lwt_pqueue
    1. 1. Module type Lwt_pqueue.OrderedType
        Module type Lwt_pqueue.S
    1. Module Lwt_preemptive
    1. Module Lwt_process
    1. Module Lwt_result
    1. Module Lwt_seq
    1. Module Lwt_sequence
    1. Module Lwt_stream
    1. Module Lwt_switch
    1. Module Lwt_sys
    1. Module Lwt_throttle
    1. 1. Module type Lwt_throttle.S
    1. Module Lwt_timeout
    1. Module Lwt_unix
  1. Package mtime
  1. 1. Module Mtime
    1. Module Mtime_clock
  1. Package ocaml
  1. 1. Module Bigarray
    1. Module Condition
    1. Module Dynlink
    1. Module Event
    1. Module Mutex
    1. Module Profiling
    1. Module Semaphore
    1. Module Stdlib
    1. 1. ...
      1. Module Stdlib.Filename
    1. Module Str
    1. Module Thread
    1. Module ThreadUnix
    1. Module Topdirs
    1. Module Unix
    1. Module UnixLabels
  1. Package
  1. Package result
  1. 1. Module Result
  1. Package stdint
  1. 1. Module Stdint
    1. 1. Module type Stdint.Int