Module Fmt_tty
Contents
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
:DkSDKProject_DeclareAvailable(fmt CONSTRAINT "= 0.9.0+dune" FINDLIBS fmt fmt.cli fmt.top fmt.tty) DkSDKProject_MakeAvailable(fmt)
Add the
Findlib::fmt
library to any desired targets insrc/*/CMakeLists.txt
:target_link_libraries(YourPackage_YourLibraryName # ... existing libraries, if any ... Findlib::fmt)
Click your IDE's
Build
button
Not using DkSDK?
FIRST, do one or all of the following:
Run:
opam install fmt.0.9.0+dune
Edit your
dune-project
and add:(package (name YourExistingPackage) (depends ; ... existing dependenices ... (fmt (>= 0.9.0+dune))))
Then run:
dune build *.opam # if this fails, run: dune build
Edit your
<package>.opam
file and add:depends: [ # ... existing dependencies ... "fmt" {>= "0.9.0+dune"} ]
Then run:
opam install . --deps-only
FINALLY, add the fmt.tty
library to any desired (library)
and/or (executable)
targets in your **/dune
files:
(library
(name YourLibrary)
; ... existing library options ...
(libraries
; ... existing libraries ...
fmt.tty))
(executable
(name YourExecutable)
; ... existing executable options ...
(libraries
; ... existing libraries ...
fmt.tty))
TTY setup
val
setup : ``?style_renderer:
Fmt.style_renderer
->
``?utf_8:bool
->
out_channel
->
Stdlib.Format.formatter
setup ?style_renderer ?utf_8 outc
is a formatter for outc
with
Fmt.set_style_renderer
and
Fmt.set_utf_8
correctly setup. If
style_renderer
or utf_8
are specified they override the automatic
setup.
If outc
is stdout
, Fmt.stdout
is returned.
If outc
is stderr
, Fmt.stderr
is returned.
val
setup_std_outputs : ``?style_renderer:
Fmt.style_renderer
->
``?utf_8:bool
->
``unit
->
unit
setup_std_outputs ?style_renderer ?utf_8 ()
applies
setup
on stdout
and stderr
.