package ocamlformat-mlx-lib

You can search for identifiers within the package.

in-package search v0.2.0

ocamlformat-mlx-lib
- Ocamlformat_lib
  - Assoc
  - Ast
    
    Attr
    
    Key
    
    Cl
    
    Cty
    
    Exp
    
    Ext
    
    Key
    
    Mod
    
    Mty
    
    Pat
    
    Token
    
    Tyd
  - Box_debug
  - Chunk
  - Cmt
    
    Comparator_no_loc
  - Cmts
    
    Toplevel
  - Conf
    
    Elt
    
    Error
    
    Operational
    
    UI
  - Conf_decl
    
    Store
    
    UI
    
    Value
    
    Value_removed
  - Conf_t
    
    Elt
    
    Error
  - Docstring
  - Eol_compat
  - Exposed
    
    Left
    
    Right
  - Extended_ast
    
    Asttypes
    
    Parse
    
    Printast
  - Fmt
  - Fmt_ast
  - Fmt_odoc
  - Literal_lexer
  - Loc_tree
  - Migrate_ast
    
    Lexing
    
    Location
    
    Longident
    
    Position
  - Multimap
    
    M
    
    K
  - Non_overlapping_interval_tree
    
    IN
    
    Make
    
    Itv
    
    S
  - Normalize_extended_ast
  - Normalize_std_ast
  - Params
    
    Align
    
    Exp
    
    Infix_op_arg
    
    Indent
    
    Mod
    
    Pcty
  - Parse_with_comments
    
    W
  - Prec
  - Source
  - Std_ast
    
    Parse
    
    Printast
  - Std_longident
    
    String_id
  - Sugar
    
    Exp
    
    Let_binding
  - Syntax
  - Toplevel_lexer
  - Translation_unit
    
    Error
  - Version
ocamlformat-mlx-lib.format_
- Format_
ocamlformat-mlx-lib.ocaml_common
- Ocaml_common
  - Location
  - Longident
  - Syntaxerr
  - Warnings
ocamlformat-mlx-lib.ocamlformat_stdlib
- Ocamlformat_stdlib
  - Caml
  - Export
  - Fpath
    
    Map
    
    Set
  - Int_conversions
    
    Make
    
    I
    
    Make_binary
    
    Binary
    
    I
    
    Make_hex
    
    Hex
    
    I
  - List
  - Sexp
  - String
  - Warning
ocamlformat-mlx-lib.odoc_parser
- Odoc_parser
  - Ast
  - Loc
  - Warning
ocamlformat-mlx-lib.parser_extended
- Parser_extended
  - Ast_helper
    
    Attr
    
    Cf
    
    Ci
    
    Cl
    
    Const
    
    Csig
    
    Cstr
    
    Ctf
    
    Cty
    
    Exp
    
    Incl
    
    Mb
    
    Md
    
    Mod
    
    Ms
    
    Mtd
    
    Mty
    
    Of
    
    Opn
    
    Pat
    
    Rf
    
    Sig
    
    Str
    
    Te
    
    Typ
    
    Type
    
    Val
    
    Vb
  - Ast_mapper
  - Asttypes
  - Docstrings
    
    WithMenhir
  - Jsx_helper
  - Lexer
  - Parse
  - Parser
    
    Incremental
    
    MenhirInterpreter
  - Parsetree
  - Printast
ocamlformat-mlx-lib.parser_shims
- Parser_shims
  - Builtin_attributes
  - Clflags
  - Int
  - List
  - Load_path
  - Misc
    
    Color
    
    Error_style
    
    Int_literal_converter
    
    LongString
    
    Magic_number
    
    Stdlib
    
    Array
    
    List
    
    Option
    
    String
    
    Map
    
    Set
    
    Tbl
    
    Style
ocamlformat-mlx-lib.parser_standard
- Parser_standard
  - Ast_helper
    
    Attr
    
    Cf
    
    Ci
    
    Cl
    
    Const
    
    Csig
    
    Cstr
    
    Ctf
    
    Cty
    
    Exp
    
    Incl
    
    Mb
    
    Md
    
    Mod
    
    Ms
    
    Mtd
    
    Mty
    
    Of
    
    Opn
    
    Pat
    
    Rf
    
    Sig
    
    Str
    
    Te
    
    Typ
    
    Type
    
    Val
    
    Vb
  - Ast_mapper
  - Asttypes
  - Docstrings
    
    WithMenhir
  - Jsx_helper
  - Lexer
  - Parse
  - Parser
    
    Incremental
    
    MenhirInterpreter
  - Parsetree
  - Printast
ocamlformat-mlx-lib.result
- Ocamlformat_result
  - Global_scope
  - Let_syntax

Legend:
Library
Module
Module type
Parameter
Class
Class type

Formatting combinators

type s =
  (Ocamlformat_stdlib.unit, Format_.formatter, Ocamlformat_stdlib.unit)
    Ocamlformat_stdlib.format

Format strings that accept no arguments.

type t

Format thunks.

type sp =

| Blank
(*

*)
| Cut
(*
@,
*)
| Space
(*
@
*)
| Break of Ocamlformat_stdlib.int * Ocamlformat_stdlib.int
(*
@;
*)

val sp : sp -> t

val ($) : t -> t -> t

Format concatenation: a $ b formats a, then b.

val sequence : t Ocamlformat_stdlib.list -> t

Format concatenation of n elements.

val (>$) : t -> ('b -> t) -> 'b -> t

Pre-compose a format thunk onto a function returning a format thunk.

val lazy_ : (Ocamlformat_stdlib.unit -> t) -> t

Defer the evaluation of some side effects until formatting happens.

val set_margin : Ocamlformat_stdlib.int -> t

Set the margin.

val set_max_indent : Ocamlformat_stdlib.int Ocamlformat_stdlib.option -> t

Set the maximum indentation.

val eval : Format_.formatter -> t -> Ocamlformat_stdlib.unit

eval fs t runs format thunk t outputting to fs

val protect : 
  t ->
  on_error:(Ocamlformat_stdlib.exn -> Ocamlformat_stdlib.unit) ->
  t

Catch exceptions raised while formatting.

Break hints and format strings --------------------------------------

val break : Ocamlformat_stdlib.int -> Ocamlformat_stdlib.int -> t

Format a break hint.

val cbreak : 
  fits:
    (Ocamlformat_stdlib.string
     * Ocamlformat_stdlib.int
     * Ocamlformat_stdlib.string) ->
  breaks:
    (Ocamlformat_stdlib.string
     * Ocamlformat_stdlib.int
     * Ocamlformat_stdlib.string) ->
  t

Format a custom break.

fits = (a, b, c) formats a string a, b spaces and a string c if the line does not break.
breaks = (d, e, f) formats a string d, e spaces and a string f if the line breaks.

val noop : t

Format nothing.

val fmt : s -> t

Format a format string.

Primitive types -----------------------------------------------------

val char : Ocamlformat_stdlib.char -> t

Format a char.

val str : Ocamlformat_stdlib.string -> t

Format a string.

Primitive containers ------------------------------------------------

val opt : 'a Ocamlformat_stdlib.option -> ('a -> t) -> t

Format an option using provided formatter for the element.

val list : 'a Ocamlformat_stdlib.list -> s -> ('a -> t) -> t

Format a list separated by a format string using provided function for the elements.

val list_fl : 
  'a Ocamlformat_stdlib.list ->
  (first:Ocamlformat_stdlib.bool -> last:Ocamlformat_stdlib.bool -> 'a -> t) ->
  t

Format a list using provided function for the elements, which is passed the flags indicating if the element is the first or last.

val list_pn : 
  'a Ocamlformat_stdlib.list ->
  (prev:'a Ocamlformat_stdlib.option ->
    'a ->
    next:'a Ocamlformat_stdlib.option ->
    t) ->
  t

Format a list using provided function for the elements, which is passed the previous and next elements, if any.

val list_k : 'a Ocamlformat_stdlib.list -> t -> ('a -> t) -> t

Format a list using the format thunk for the separators between elements.

Conditional formatting ----------------------------------------------

val fmt_if : Ocamlformat_stdlib.bool -> s -> t

Conditionally format.

val fmt_if_k : Ocamlformat_stdlib.bool -> t -> t

Conditionally format thunk.

val fmt_or : Ocamlformat_stdlib.bool -> s -> s -> t

Conditionally select between two format strings.

val fmt_or_k : Ocamlformat_stdlib.bool -> t -> t -> t

Conditionally select between two format thunks.

val fmt_opt : t Ocamlformat_stdlib.option -> t

Optionally format. fmt_opt (Some t) is t and fmt_opt None is noop.

Conditional on immediately following a line break -------------------

val if_newline : Ocamlformat_stdlib.string -> t

Format a string if the line has just been broken.

val break_unless_newline : 
  Ocamlformat_stdlib.int ->
  Ocamlformat_stdlib.int ->
  t

Format a break unless the line has just been broken.

Conditional on breaking of enclosing box ----------------------------

type behavior =

| Fit
| Break

val fits_breaks : 
  ?force:behavior ->
  ?hint:(Ocamlformat_stdlib.int * Ocamlformat_stdlib.int) ->
  ?level:Ocamlformat_stdlib.int ->
  Ocamlformat_stdlib.string ->
  Ocamlformat_stdlib.string ->
  t

fits_breaks fits nspaces offset breaks prints fits if the enclosing box fits on one line, and otherwise prints breaks, which is a string that optionally follows a break hint (that is a pair (nspaces, offset) equivalent to the break hint "@;<nspaces offset>").

val fits_breaks_if : 
  ?force:behavior ->
  ?hint:(Ocamlformat_stdlib.int * Ocamlformat_stdlib.int) ->
  ?level:Ocamlformat_stdlib.int ->
  Ocamlformat_stdlib.bool ->
  Ocamlformat_stdlib.string ->
  Ocamlformat_stdlib.string ->
  t

As fits_breaks, but conditional.

Wrapping ------------------------------------------------------------

val wrap : s -> s -> t -> t

wrap prologue epilogue body formats prologue then body then epilogue.

val wrap_k : t -> t -> t -> t

As wrap, but prologue and epilogue may be arbitrary format thunks.

val wrap_if : Ocamlformat_stdlib.bool -> s -> s -> t -> t

As wrap, but prologue and epilogue are only formatted conditionally.

val wrap_if_k : Ocamlformat_stdlib.bool -> t -> t -> t -> t

As wrap_if, but prologue and epilogue may be arbitrary format thunks.

val wrap_if_fits_or : 
  Ocamlformat_stdlib.bool ->
  Ocamlformat_stdlib.string ->
  Ocamlformat_stdlib.string ->
  t ->
  t

As wrap_if_fits, but prologue and epilogue can be forced by the additional condition.

val wrap_fits_breaks : 
  ?space:Ocamlformat_stdlib.bool ->
  Conf.t ->
  Ocamlformat_stdlib.string ->
  Ocamlformat_stdlib.string ->
  t ->
  t

As wrap, but if space is provided, a space is added after prologue and a space hint is added before epilogue in case the enclosing box breaks.

val wrap_fits_breaks_if : 
  ?space:Ocamlformat_stdlib.bool ->
  Conf.t ->
  Ocamlformat_stdlib.bool ->
  Ocamlformat_stdlib.string ->
  Ocamlformat_stdlib.string ->
  t ->
  t

As wrap_fits_breaks, but prologue and epilogue are formatted subject to the additional condition.

Boxes ---------------------------------------------------------------

val with_box_debug : t -> t

Represent boxes inside a format thunk with colored brackets. For debug purposes

val open_vbox : ?name:Ocamlformat_stdlib.string -> Ocamlformat_stdlib.int -> t

Open an vbox with specified indentation.

val open_hvbox : ?name:Ocamlformat_stdlib.string -> Ocamlformat_stdlib.int -> t

Open an hvbox with specified indentation.

val open_hovbox : 
  ?name:Ocamlformat_stdlib.string ->
  Ocamlformat_stdlib.int ->
  t

Open an hovbox with specified indentation.

val close_box : t

Close an arbitrary box.

Wrapping boxes ------------------------------------------------------

val cbox : ?name:Ocamlformat_stdlib.string -> Ocamlformat_stdlib.int -> t -> t

Wrap a format thunk with a compacting box with specified indentation.

val vbox : ?name:Ocamlformat_stdlib.string -> Ocamlformat_stdlib.int -> t -> t

Wrap a format thunk with a vbox with specified indentation.

val hvbox : ?name:Ocamlformat_stdlib.string -> Ocamlformat_stdlib.int -> t -> t

Wrap a format thunk with an hvbox with specified indentation.

val hovbox : 
  ?name:Ocamlformat_stdlib.string ->
  Ocamlformat_stdlib.int ->
  t ->
  t

Wrap a format thunk with an hovbox with specified indentation.

val cbox_if : 
  ?name:Ocamlformat_stdlib.string ->
  Ocamlformat_stdlib.bool ->
  Ocamlformat_stdlib.int ->
  t ->
  t

Conditionally wrap a format thunk with a compacting sbox with specified indentation.

val vbox_if : 
  ?name:Ocamlformat_stdlib.string ->
  Ocamlformat_stdlib.bool ->
  Ocamlformat_stdlib.int ->
  t ->
  t

Conditionally wrap a format thunk with a vbox with specified indentation.

val hvbox_if : 
  ?name:Ocamlformat_stdlib.string ->
  Ocamlformat_stdlib.bool ->
  Ocamlformat_stdlib.int ->
  t ->
  t

Conditionally wrap a format thunk with an hvbox with specified indentation.

val hovbox_if : 
  ?name:Ocamlformat_stdlib.string ->
  Ocamlformat_stdlib.bool ->
  Ocamlformat_stdlib.int ->
  t ->
  t

Conditionally wrap a format thunk with an hovbox with specified indentation.

Text filling --------------------------------------------------------

val fill_text : 
  ?epi:Ocamlformat_stdlib.string ->
  Ocamlformat_stdlib.string ->
  t

Format a non-empty string as filled text wrapped at the margin.