package ocamlformat

You can search for identifiers within the package.

in-package search v0.2.0

OCamlFormat Manual
- API
- Doc-comments language reference
- Editor setup
- Frequently asked questions
- Getting started
- How-To's
- ocamlformat-rpc
- Library ocamlformat
  - Ocamlformat
    
    Assoc
    
    Ast
    
    Attr
    
    Key
    
    Ext
    
    Key
    
    Token
    
    String_id
    
    Longident
    
    Exp
    
    Indexing_op
    
    Pat
    
    Mod
    
    Mty
    
    Cl
    
    Cty
    
    Tyd
    
    Cmt
    
    Cmts
    
    Format
    
    Toplevel
    
    Conf
    
    Config_option
    
    Error
    
    CONFIG
    
    Make
    
    Value
    
    Value_removed
    
    Docstring
    
    Exposed
    
    Left
    
    Right
    
    Extended_ast
    
    Parse
    
    Printast
    
    Asttypes
    
    File_system
    
    Fmt
    
    Format
    
    Fmt_ast
    
    Fmt_odoc
    
    Indent
    
    Valid_ast
    
    Partial_ast
    
    Literal_lexer
    
    Loc_tree
    
    Migrate_ast
    
    Lexing
    
    Position
    
    Location
    
    Longident
    
    Multimap
    
    M
    
    Non_overlapping_interval_tree
    
    IN
    
    S
    
    Make
    
    Normalize_extended_ast
    
    Normalize_std_ast
    
    Params
    
    Format
    
    Exp
    
    Infix_op_arg
    
    Parse_with_comments
    
    W
    
    Prec
    
    Range
    
    Source
    
    Std_ast
    
    Parse
    
    Printast
    
    Sugar
    
    Exp
    
    Let_binding
    
    Syntax
    
    Toplevel_lexer
    
    Translation_unit
    
    Error
    
    Version
- Library ocamlformat.format_
  - Format_
- Library ocamlformat.ocaml_common
  - Ocaml_common
    
    Location
    
    Longident
    
    Syntaxerr
    
    Warnings
- Library ocamlformat.ocamlformat_stdlib
  - Ocamlformat_stdlib
    
    Applicative
    
    Array
    
    Avltree
    
    Backtrace
    
    Binary_search
    
    Binary_searchable
    
    Blit
    
    Bool
    
    Buffer
    
    Bytes
    
    Char
    
    Comparable
    
    Comparator
    
    Comparisons
    
    Container
    
    Either
    
    Equal
    
    Error
    
    Exn
    
    Field
    
    Float
    
    Floatable
    
    Fn
    
    Formatter
    
    Hash
    
    Hash_set
    
    Hashable
    
    Hasher
    
    Hashtbl
    
    Identifiable
    
    Indexed_container
    
    Info
    
    Int
    
    Int_conversions
    
    Int32
    
    Int63
    
    Int64
    
    Intable
    
    Int_math
    
    Invariant
    
    Lazy
    
    Map
    
    Maybe_bound
    
    Monad
    
    Nativeint
    
    Nothing
    
    Option
    
    Option_array
    
    Or_error
    
    Ordered_collection_common
    
    Ordering
    
    Poly
    
    Popcount
    
    Pretty_printer
    
    Printf
    
    Linked_queue
    
    Queue
    
    Random
    
    Ref
    
    Result
    
    Sequence
    
    Set
    
    Sexpable
    
    Sign
    
    Sign_or_nan
    
    Source_code_position
    
    Stack
    
    Staged
    
    Stringable
    
    Sys
    
    T
    
    Type_equal
    
    Uniform_array
    
    Unit
    
    Uchar
    
    Variant
    
    With_return
    
    Word_size
    
    T
    
    T1
    
    T2
    
    T3
    
    Sexp
    
    Private
    
    Export
    
    Continue_or_stop
    
    In_channel
    
    Out_channel
    
    Cmdliner
    
    Manpage
    
    Term
    
    Cmd
    
    Arg
    
    Fpath
    
    Set
    
    Map
    
    List
    
    Cartesian_product
    
    Monad_infix
    
    Let_syntax
    
    Or_unequal_lengths
    
    Assoc
    
    Infix
    
    String
    
    Caseless
    
    Search_pattern
    
    Escaping
    
    Warning
    
    Format
    
    Filename
- Library ocamlformat.parser_extended
  - Parser_extended
    
    Ast_helper
    
    Const
    
    Attr
    
    Typ
    
    Pat
    
    Exp
    
    Val
    
    Type
    
    Te
    
    Mty
    
    Mod
    
    Sig
    
    Str
    
    Md
    
    Ms
    
    Mtd
    
    Mb
    
    Opn
    
    Incl
    
    Vb
    
    Cty
    
    Ctf
    
    Cl
    
    Cf
    
    Ci
    
    Csig
    
    Cstr
    
    Rf
    
    Of
    
    Ast_mapper
    
    Asttypes
    
    Docstrings
    
    WithMenhir
    
    Lexer
    
    Parse
    
    Parser
    
    MenhirInterpreter
    
    Incremental
    
    Parsetree
    
    Printast
- Library ocamlformat.parser_recovery
  - Parser_recovery
- Library ocamlformat.parser_shims
  - Parser_shims
    
    List
    
    Int
    
    Misc
    
    Stdlib
    
    List
    
    Option
    
    Array
    
    String
    
    Set
    
    Map
    
    Tbl
    
    Int_literal_converter
    
    LongString
    
    Magic_number
    
    Color
    
    Error_style
    
    Clflags
- Library ocamlformat.parser_standard
  - Parser_standard
    
    Ast_helper
    
    Const
    
    Attr
    
    Typ
    
    Pat
    
    Exp
    
    Val
    
    Type
    
    Te
    
    Mty
    
    Mod
    
    Sig
    
    Str
    
    Md
    
    Ms
    
    Mtd
    
    Mb
    
    Opn
    
    Incl
    
    Vb
    
    Cty
    
    Ctf
    
    Cl
    
    Cf
    
    Ci
    
    Csig
    
    Cstr
    
    Rf
    
    Of
    
    Ast_mapper
    
    Asttypes
    
    Docstrings
    
    WithMenhir
    
    Lexer
    
    Parse
    
    Parser
    
    MenhirInterpreter
    
    Incremental
    
    Parsetree
    
    Printast
- Library ocamlformat.result
  - Ocamlformat_result
    
    Let_syntax
    
    Global_scope
- Library ocamlformat.rpc
  - Ocamlformat_rpc
    
    IO
    
    Rpc
    
    Protocol
    
    Command_S
    
    Init
    
    V1
    
    V2
    
    V
- Library ocamlformat.rpc_lib_protocol
  - Ocamlformat_rpc_lib_protocol
    
    IO
    
    S
    
    Protocol
    
    Version
    
    Make
    
    Command_S
    
    Init
    
    V1
    
    V2
- Sources
  - ocamlformat
    
    Assoc.ml
    
    Ast.ml
    
    Cmt.ml
    
    Cmts.ml
    
    Conf.ml
    
    Config_option.ml
    
    Docstring.ml
    
    Exposed.ml
    
    Extended_ast.ml
    
    File_system.ml
    
    Fmt.ml
    
    Fmt_ast.ml
    
    Fmt_odoc.ml
    
    Indent.ml
    
    Literal_lexer.ml
    
    Loc_tree.ml
    
    Migrate_ast.ml
    
    Multimap.ml
    
    Non_overlapping_interval_tree.ml
    
    Normalize_extended_ast.ml
    
    Normalize_std_ast.ml
    
    Params.ml
    
    Parse_with_comments.ml
    
    Prec.ml
    
    Range.ml
    
    Source.ml
    
    Std_ast.ml
    
    Sugar.ml
    
    Syntax.ml
    
    Toplevel_lexer.ml
    
    Translation_unit.ml
    
    Version.ml
    
    ocamlformat.ml
  - ocamlformat.format_
    
    format.ml
    
    format_.ml
    
    format___.ml
  - ocamlformat.ocaml_common
    
    location.ml
    
    longident.ml
    
    ocaml_common.ml
    
    syntaxerr.ml
    
    warnings.ml
  - ocamlformat.ocamlformat_stdlib
    
    cmdliner_ext.ml
    
    fpath_ext.ml
    
    list_ext.ml
    
    ocamlformat_stdlib.ml
    
    ocamlformat_stdlib__.ml
    
    string_ext.ml
    
    warning.ml
  - ocamlformat.parser_extended
    
    ast_helper.ml
    
    ast_mapper.ml
    
    asttypes.ml
    
    docstrings.ml
    
    lexer.ml
    
    parse.ml
    
    parser.ml
    
    parser_extended.ml
    
    parsetree.ml
    
    printast.ml
  - ocamlformat.parser_recovery
    
    annot.ml
    
    lexer.ml
    
    merlin_recovery.ml
    
    parser.ml
    
    parser_recover.ml
    
    parser_recovery.ml
    
    parser_recovery__.ml
  - ocamlformat.parser_shims
    
    parser_shims.ml
  - ocamlformat.parser_standard
    
    ast_helper.ml
    
    ast_mapper.ml
    
    asttypes.ml
    
    docstrings.ml
    
    lexer.ml
    
    parse.ml
    
    parser.ml
    
    parser_standard.ml
    
    parsetree.ml
    
    printast.ml
  - ocamlformat.result
    
    ocamlformat_result.ml
  - ocamlformat.rpc
    
    ocamlformat_rpc.ml
  - ocamlformat.rpc_lib_protocol
    
    IO.ml
    
    ocamlformat_rpc_lib_protocol.ml
    
    protocol.ml

Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module `Ocamlformat.Source`Source

Sourcetype t

val create : 
  text:Ocamlformat_stdlib.string ->
  tokens:
    (Parser_extended.Parser.token * Ocaml_common.Location.t)
      Ocamlformat_stdlib.list ->
  t

Source

val empty_line_between : 
  t ->
  Lexing.position ->
  Lexing.position ->
  Ocamlformat_stdlib.bool

empty_line_between t p1 p2 is true if there is an empty line between p1 and p2. The lines containing p1 and p2 are not considered empty.

Sourceval empty_line_before : t -> Ocaml_common.Location.t -> Ocamlformat_stdlib.bool

Sourceval empty_line_after : t -> Ocaml_common.Location.t -> Ocamlformat_stdlib.bool

Source

val tokens_between : 
  t ->
  filter:(Parser_extended.Parser.token -> Ocamlformat_stdlib.bool) ->
  Lexing.position ->
  Lexing.position ->
  (Parser_extended.Parser.token * Ocaml_common.Location.t)
    Ocamlformat_stdlib.list

Sourceval string_at : t -> Ocaml_common.Location.t -> Ocamlformat_stdlib.string

Source

val find_token_after : 
  t ->
  filter:(Parser_extended.Parser.token -> Ocamlformat_stdlib.bool) ->
  Lexing.position ->
  (Parser_extended.Parser.token * Ocaml_common.Location.t)
    Ocamlformat_stdlib.option

Source

val find_token_before : 
  t ->
  filter:(Parser_extended.Parser.token -> Ocamlformat_stdlib.bool) ->
  Lexing.position ->
  (Parser_extended.Parser.token * Ocaml_common.Location.t)
    Ocamlformat_stdlib.option

Source

val string_literal : 
  t ->
  [ `Normalize | `Preserve ] ->
  Ocaml_common.Location.t ->
  Ocamlformat_stdlib.string

Sourceval char_literal : t -> Ocaml_common.Location.t -> Ocamlformat_stdlib.string

Source

val is_long_pmod_functor : 
  t ->
  Extended_ast.module_expr ->
  Ocamlformat_stdlib.bool

is_long_pmod_functor source mod_exp holds if mod_exp is a Pmod_functor expression that is expressed in long ('functor (M) ->') form in source.

Source

val is_long_pmty_functor : 
  t ->
  Extended_ast.module_type ->
  Ocamlformat_stdlib.bool

is_long_pmty_functor source mod_type holds if mod_type is a Pmty_functor type that is expressed in long ('functor (M) ->') form in source.

Source

val begins_line : 
  ?ignore_spaces:Ocamlformat_stdlib.bool ->
  t ->
  Ocaml_common.Location.t ->
  Ocamlformat_stdlib.bool

Sourceval ends_line : t -> Ocaml_common.Location.t -> Ocamlformat_stdlib.bool

Source

val extension_using_sugar : 
  name:Ocamlformat_stdlib.string Ocaml_common.Location.loc ->
  payload:Ocaml_common.Location.t ->
  Ocamlformat_stdlib.bool

Source

val extend_loc_to_include_attributes : 
  Ocaml_common.Location.t ->
  Extended_ast.attributes ->
  Ocaml_common.Location.t

Source

val type_constraint_is_first : 
  Extended_ast.core_type ->
  Ocaml_common.Location.t ->
  Ocamlformat_stdlib.bool

Sourceval is_quoted_string : t -> Ocaml_common.Location.t -> Ocamlformat_stdlib.bool

Source

val loc_of_first_token_at : 
  t ->
  Ocaml_common.Location.t ->
  Parser_extended.Parser.token ->
  Ocaml_common.Location.t Ocamlformat_stdlib.option

Source

val find_first_token_on_line : 
  t ->
  Ocamlformat_stdlib.int ->
  (Parser_extended.Parser.token * Ocaml_common.Location.t)
    Ocamlformat_stdlib.option

package ocamlformat

Module Ocamlformat.SourceSource

Module `Ocamlformat.Source`Source