package ocamlformat

You can search for identifiers within the package.

in-package search v0.2.0

package ocamlformat

ocamlformat
- Ocamlformat
  - Assoc
  - Ast
    
    Attr
    
    Key
    
    Cl
    
    Cty
    
    Exp
    
    Ext
    
    Key
    
    Indexing_op
    
    Longident
    
    Mod
    
    Mty
    
    Pat
    
    String_id
    
    Token
    
    Tyd
  - Cmt
  - Cmts
    
    Toplevel
  - Conf
  - Config_option
    
    CONFIG
    
    Error
    
    Make
    
    C
    
    Value
    
    Value_removed
  - Docstring
  - Exposed
    
    Left
    
    Right
  - Extended_ast
    
    Asttypes
    
    Parse
    
    Printast
  - File_system
  - Fmt
  - Fmt_ast
  - Fmt_odoc
  - Indent
    
    Partial_ast
    
    Valid_ast
  - 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
    
    Exp
    
    Infix_op_arg
  - Parse_with_comments
    
    W
  - Prec
  - Range
  - Source
  - Std_ast
    
    Parse
    
    Printast
  - Sugar
    
    Exp
    
    Let_binding
    
    Pat
  - Syntax
  - Toplevel_lexer
  - Translation_unit
    
    Error
  - Version
ocamlformat.format_
- Format_
ocamlformat.ocaml_common
- Ocaml_common
  - Location
  - Longident
  - Syntaxerr
  - Warnings
ocamlformat.ocamlformat_stdlib
- Ocamlformat_stdlib
  - Cmdliner
  - Export
  - Fpath
    
    Map
    
    Set
  - List
  - Sexp
  - String
  - Warning
ocamlformat.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
  - Lexer
  - Parse
  - Parser
    
    Incremental
    
    MenhirInterpreter
  - Parsetree
  - Printast
ocamlformat.parser_recovery
- Parser_recovery
ocamlformat.parser_shims
- Parser_shims
  - Clflags
  - Int
  - List
  - Misc
    
    Color
    
    Error_style
    
    Int_literal_converter
    
    LongString
    
    Magic_number
    
    Stdlib
    
    Array
    
    List
    
    Option
    
    String
    
    Map
    
    Set
    
    Tbl
ocamlformat.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
  - Lexer
  - Parse
  - Parser
    
    Incremental
    
    MenhirInterpreter
  - Parsetree
  - Printast
ocamlformat.rpc
- Ocamlformat_rpc
  - IO
  - Protocol
    
    Command_S
    
    Init
    
    V1
    
    V2
  - V
ocamlformat.rpc_lib_protocol
- Ocamlformat_rpc_lib_protocol
  - IO
    
    S
  - Protocol
    
    Make
    
    Command_S
    
    IO
    
    Init
    
    V1
    
    V2
    
    Version

Legend:
Library
Module
Module type
Parameter
Class
Class type

Abstract syntax tree terms

val init : Conf.t -> Ocamlformat_stdlib.unit

Initialize internal state

module Attr : sig ... end

module Ext : sig ... end

module Token : sig ... end

module String_id : sig ... end

module Longident : sig ... end

module Exp : sig ... end

module Indexing_op : sig ... end

val doc_atrs : 
  ?acc:
    (Ocamlformat_stdlib.string Migrate_ast.Location.loc
     * Ocamlformat_stdlib.bool)
      Ocamlformat_stdlib.list ->
  Extended_ast.attributes ->
  (Ocamlformat_stdlib.string Migrate_ast.Location.loc * Ocamlformat_stdlib.bool)
    Ocamlformat_stdlib.list
    Ocamlformat_stdlib.option
  * Extended_ast.attributes

type cmt_checker = {

cmts_before : Migrate_ast.Location.t -> Ocamlformat_stdlib.bool;
cmts_within : Migrate_ast.Location.t -> Ocamlformat_stdlib.bool;
cmts_after : Migrate_ast.Location.t -> Ocamlformat_stdlib.bool;

}

module Pat : sig ... end

module Mod : sig ... end

module Mty : sig ... end

module Cl : sig ... end

module Cty : sig ... end

module Tyd : sig ... end

type toplevel_item = [

| `Item of Extended_ast.structure_item
| `Directive of Extended_ast.toplevel_directive

]

type t =

| Pld of Extended_ast.payload
| Typ of Extended_ast.core_type
| Td of Extended_ast.type_declaration
| Cty of Extended_ast.class_type
| Pat of Extended_ast.pattern
| Exp of Extended_ast.expression
| Vb of Extended_ast.value_binding
| Cl of Extended_ast.class_expr
| Mty of Extended_ast.module_type
| Mod of Extended_ast.module_expr
| Sig of Extended_ast.signature_item
| Str of Extended_ast.structure_item
| Clf of Extended_ast.class_field
| Ctf of Extended_ast.class_type_field
| Tli of toplevel_item
| Top
| Rep
(*
Repl phrase
*)

Ast terms of various forms.

val is_top : t -> Ocamlformat_stdlib.bool

val break_between : 
  Source.t ->
  cmt_checker ->
  (t * Conf.t) ->
  (t * Conf.t) ->
  Ocamlformat_stdlib.bool

val attributes : t -> Extended_ast.attributes

val location : t -> Migrate_ast.Location.t

val dump : Ocamlformat_stdlib.Format.formatter -> t -> Ocamlformat_stdlib.unit

Debug: Dump the representation of an Ast term.

type 'a xt = private {

ctx : t;
ast : 'a;

}

Term-in-context {ctx; ast} records that ast is (considered to be) an immediate sub-term of ctx.

val sub_typ : ctx:t -> Extended_ast.core_type -> Extended_ast.core_type xt

Construct a core_type-in-context.

val sub_cty : ctx:t -> Extended_ast.class_type -> Extended_ast.class_type xt

Construct a class_type-in-context.

val sub_pat : ctx:t -> Extended_ast.pattern -> Extended_ast.pattern xt

Construct a pattern-in-context.

val sub_exp : ctx:t -> Extended_ast.expression -> Extended_ast.expression xt

Construct a expression-in-context.

val sub_cl : ctx:t -> Extended_ast.class_expr -> Extended_ast.class_expr xt

Construct a class_expr-in-context.

val sub_mty : ctx:t -> Extended_ast.module_type -> Extended_ast.module_type xt

Construct a module_type-in-context.

val sub_mod : ctx:t -> Extended_ast.module_expr -> Extended_ast.module_expr xt

Construct a module_expr-in-context.

val sub_sig : 
  ctx:t ->
  Extended_ast.signature_item ->
  Extended_ast.signature_item xt

Construct a signature_item-in-context.

val sub_str : 
  ctx:t ->
  Extended_ast.structure_item ->
  Extended_ast.structure_item xt

Construct a structure_item-in-context.

val is_simple : 
  Conf.t ->
  (Extended_ast.expression xt -> Ocamlformat_stdlib.int) ->
  Extended_ast.expression xt ->
  Ocamlformat_stdlib.bool

Holds of "simple" expressions: constants and constructor and function applications of other simple expressions.

type cls =

| Let_match
| Match
| Non_apply
| Sequence
| Then
| ThenElse

'Classes' of expressions which are parenthesized differently.

val exposed_right_exp : 
  cls ->
  Extended_ast.expression ->
  Ocamlformat_stdlib.bool

exposed_right_exp cls exp holds if there is a right-most subexpression of exp which is of class cls and is not parenthesized.

val prec_ast : t -> Prec.t Ocamlformat_stdlib.option

prec_ast ast is the precedence of ast. Meaningful for binary operators, otherwise returns None.

val parenze_typ : Extended_ast.core_type xt -> Ocamlformat_stdlib.bool

parenze_typ xtyp holds when core_type-in-context xtyp should be parenthesized.

val parenze_cty : Extended_ast.class_type xt -> Ocamlformat_stdlib.bool

parenze_cty xcty holds when class_type-in-context xcty should be parenthesized.

val parenze_cl : Extended_ast.class_expr xt -> Ocamlformat_stdlib.bool

parenze_cl xcl holds when class-in-context xcl should be parenthesized.

val parenze_pat : Extended_ast.pattern xt -> Ocamlformat_stdlib.bool

parenze_pat xpat holds when pattern-in-context xpat should be parenthesized.

val parenze_exp : Extended_ast.expression xt -> Ocamlformat_stdlib.bool

parenze_exp xexp holds when expression-in-context xexp should be parenthesized.

val parenze_nested_exp : Extended_ast.expression xt -> Ocamlformat_stdlib.bool

parenze_nested_exp xexp holds when nested expression-in-context xexp should be parenthesized.

val parenze_mty : Extended_ast.module_type xt -> Ocamlformat_stdlib.bool

parenze_mty xmty holds when module_type-in-context xmty should be parenthesized.

val parenze_mod : Extended_ast.module_expr xt -> Ocamlformat_stdlib.bool

parenze_mod xmod holds when module_expr-in-context xmod should be parenthesized.

val is_displaced_infix_op : 
  Extended_ast.expression xt ->
  Ocamlformat_stdlib.bool

is_displaced_infix_op xexp holds if an expression-in-context xexp is an infix op that is not fully applied.