package ocamlformat-lib

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Primitive functions

ocamlformat-lib
- Ocamlformat_lib
  - Assoc
  - Ast
    
    Attr
    
    Key
    
    Cl
    
    Cty
    
    Exp
    
    Ext
    
    Key
    
    Ext_attrs
    
    Mod
    
    Mty
    
    Pat
    
    Token
    
    Tyd
  - Box_debug
  - Chunk
  - Cmt
  - 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
    
    Doc
    
    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-lib.format_
- Ocamlformat_format
  - Format_
ocamlformat-lib.ocaml_common
- Ocamlformat_ocaml_common
  - Location
    
    Doc
  - Longident
  - Syntaxerr
  - Warnings
ocamlformat-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-lib.odoc_parser
- Ocamlformat_odoc_parser
  - Ast
  - Lexer
  - Loc
  - Odoc_parser
    
    Warning
  - Parse_error
  - Syntax
  - Token
  - Warning
ocamlformat-lib.parser_extended
- Ocamlformat_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
    
    C
    
    CE
    
    CT
    
    E
    
    FP
    
    Flag
    
    M
    
    MT
    
    P
    
    PVB
    
    T
  - Asttypes
  - Docstrings
    
    WithMenhir
    
    WithParsing
  - Lexer
  - Parse
  - Parser
    
    Incremental
    
    MenhirInterpreter
  - Parsetree
  - Pprintast
    
    Doc
  - Printast
ocamlformat-lib.parser_shims
- Ocamlformat_parser_shims
  - Builtin_attributes
  - Clflags
  - Format_doc
    
    Doc
    
    Driver
  - Load_path
  - Misc
    
    Color
    
    Error_style
    
    Style
    
    Utf8_lexeme
ocamlformat-lib.parser_standard
- Ocamlformat_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
    
    C
    
    CE
    
    CT
    
    E
    
    M
    
    MT
    
    P
    
    PpxContext
    
    T
  - Asttypes
  - Docstrings
    
    WithMenhir
    
    WithParsing
  - Lexer
  - Parse
  - Parser
    
    Incremental
    
    MenhirInterpreter
  - Parsetree
  - Pprintast
    
    Doc
  - Printast
ocamlformat-lib.stdlib_shims
- Ocamlformat_stdlib_shims
  - Bytes
  - Either
  - Int
  - List
  - String
  - Uchar

Legend:
Library
Module
Module type
Parameter
Class
Class type

module Doc : sig ... end

Compatibility interface

type doc = Doc.t

type t = doc

type formatter = doc ref

type 'a printer = formatter -> 'a -> unit

val formatter : 'a -> 'a

Primitive functions

val pp_print_string : Doc.t ref -> string -> unit

val pp_print_as : Doc.t ref -> int -> string -> unit

val pp_print_substring : pos:int -> len:int -> Doc.t ref -> string -> unit

val pp_print_substring_as : 
  pos:int ->
  len:int ->
  Doc.t ref ->
  int ->
  string ->
  unit

val pp_print_bytes : Doc.t ref -> bytes -> unit

val pp_print_text : Doc.t ref -> string -> unit

val pp_print_char : Doc.t ref -> char -> unit

val pp_print_int : Doc.t ref -> int -> unit

val pp_print_float : Doc.t ref -> float -> unit

val pp_print_bool : Doc.t ref -> bool -> unit

val pp_print_nothing : 'a -> 'b -> unit

val pp_close_box : Doc.t ref -> unit -> unit

val pp_close_stag : Doc.t ref -> unit -> unit

val pp_print_break : Doc.t ref -> int -> int -> unit

val pp_print_custom_break : 
  Doc.t ref ->
  fits:(string * int * string) ->
  breaks:(string * int * string) ->
  unit

val pp_print_space : Doc.t ref -> unit -> unit

val pp_print_cut : Doc.t ref -> unit -> unit

val pp_print_flush : Doc.t ref -> unit -> unit

val pp_force_newline : Doc.t ref -> unit -> unit

val pp_print_newline : Doc.t ref -> unit -> unit

val pp_print_if_newline : Doc.t ref -> unit -> unit

val pp_open_stag : Doc.t ref -> Format.stag -> unit

val pp_open_box_gen : 
  Doc.t ref ->
  int ->
  CamlinternalFormatBasics.block_type ->
  unit

val pp_open_box : Doc.t ref -> int -> unit

val pp_open_tbox : Doc.t ref -> unit -> unit

val pp_close_tbox : Doc.t ref -> unit -> unit

val pp_set_tab : Doc.t ref -> unit -> unit

val pp_print_tab : Doc.t ref -> unit -> unit

val pp_print_tbreak : Doc.t ref -> int -> int -> unit

val pp_doc : Doc.t ref -> Doc.t -> unit

module Driver : sig ... end

val kfprintf : 
  (Doc.t ref -> 'a) ->
  Doc.t ref ->
  ('b, Doc.t ref, unit, unit, unit, 'a) CamlinternalFormatBasics.format6 ->
  'b

val fprintf : 
  Doc.t ref ->
  ('a, Doc.t ref, unit, unit, unit, unit) CamlinternalFormatBasics.format6 ->
  'a

val kdprintf : 
  ((Doc.t ref -> unit) -> 'a) ->
  ('b, Doc.t ref, unit, unit, unit, 'a) CamlinternalFormatBasics.format6 ->
  'b

val dprintf : 
  ('a, Doc.t ref, unit, unit, unit, Doc.t ref -> unit)
    CamlinternalFormatBasics.format6 ->
  'a

val doc_printf : 
  ('a, Doc.t ref, unit, unit, unit, Doc.t) CamlinternalFormatBasics.format6 ->
  'a

val kdoc_printf : 
  (Doc.t -> 'a) ->
  ('b, Doc.t ref, unit, unit, unit, 'a) CamlinternalFormatBasics.format6 ->
  'b

val doc_printer : ('a ref -> 'b -> 'c) -> 'b -> 'a -> 'a

type 'a format_printer = Format.formatter -> 'a -> unit

val format_printer : (Doc.t ref -> 'a -> 'b) -> Format.formatter -> 'a -> unit

val compat : (Doc.t ref -> 'a -> 'b) -> Format.formatter -> 'a -> unit

val compat1 : 
  ('a -> Doc.t ref -> 'b -> 'c) ->
  'a ->
  Format.formatter ->
  'b ->
  unit

val compat2 : 
  ('a -> 'b -> Doc.t ref -> 'c -> 'd) ->
  'a ->
  'b ->
  Format.formatter ->
  'c ->
  unit

val kasprintf : 
  (string -> 'a) ->
  ('b, Doc.t ref, unit, unit, unit, 'a) CamlinternalFormatBasics.format6 ->
  'b

val asprintf : 
  ('a, Doc.t ref, unit, unit, unit, string) CamlinternalFormatBasics.format6 ->
  'a

val pp_print_iter : 
  ?pp_sep:(Doc.t ref -> unit -> unit) ->
  (('a -> unit) -> 'b -> 'c) ->
  (Doc.t ref -> 'a -> 'd) ->
  Doc.t ref ->
  'b ->
  unit

val pp_print_list : 
  ?pp_sep:(Doc.t ref -> unit -> unit) ->
  (Doc.t ref -> 'a -> 'b) ->
  Doc.t ref ->
  'a list ->
  unit

val pp_print_array : 
  ?pp_sep:(Doc.t ref -> unit -> unit) ->
  (Doc.t ref -> 'a -> 'b) ->
  Doc.t ref ->
  'a array ->
  unit

val pp_print_seq : 
  ?pp_sep:(Doc.t ref -> unit -> unit) ->
  (Doc.t ref -> 'a -> 'b) ->
  Doc.t ref ->
  'a Seq.t ->
  unit

val pp_print_option : 
  ?none:('a ref -> unit -> unit) ->
  ('a ref -> 'b -> 'c) ->
  'a ref ->
  'b option ->
  unit

val pp_print_result : 
  ok:('a ref -> 'b -> 'c) ->
  error:('a ref -> 'd -> 'e) ->
  'a ref ->
  ('b, 'd) result ->
  unit

val pp_print_either : 
  left:('a ref -> 'b -> 'c) ->
  right:('a ref -> 'd -> 'e) ->
  'a ref ->
  ('b, 'd) Ocamlformat_stdlib_shims.Either.t ->
  unit

val comma : Doc.t ref -> unit -> unit

val pp_two_columns : 
  ?sep:string ->
  ?max_lines:int ->
  Doc.t ref ->
  (string * string) list ->
  unit

val deprecated_printer : (Format.formatter -> unit) -> Doc.t ref -> unit

val deprecated : (Format.formatter -> 'a -> unit) -> Doc.t ref -> 'a -> unit

val deprecated1 : 
  ('a -> Format.formatter -> 'b -> unit) ->
  'a ->
  Doc.t ref ->
  'b ->
  unit