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

include module type of Migrate_ast.Longident

include module type of Ocaml_common.Longident

type t =

| Lident of string
| Ldot of t * string
| Lapply of t * t

val flatten : t -> string list

val unflatten : string list -> t option

For a non-empty list l, unflatten l is Some lid where lid is the long identifier created by concatenating the elements of l with Ldot. unflatten [] is None.

val last : t -> string

val parse : string -> t

This function is broken on identifiers that are not just "Word.Word.word"; for example, it returns incorrect results on infix operators and extended module paths.

If you want to generate long identifiers that are a list of dot-separated identifiers, the function unflatten is safer and faster. unflatten is available since OCaml 4.06.0.

If you want to parse any identifier correctly, use the long-identifiers functions from the Parse module, in particular Parse.longident. They are available since OCaml 4.11, and also provide proper input-location support.

deprecated this function may misparse its input, use "Parse.longident" or "Longident.unflatten"

val lident : Ocamlformat_stdlib.string -> t

Make a Lident from a dotless string

val is_infix : t -> Ocamlformat_stdlib.bool

Holds for infix identifiers.

val is_hash_getter : t -> Ocamlformat_stdlib.bool

is_hash_getter id returns whether id is considered a hash-getter operator, of the form #**# or #**. where ** can be 0 or more operator chars.

val is_monadic_binding : t -> Ocamlformat_stdlib.bool

is_monadic_binding id returns whether id is a monadic binding operator of the form let** or and** where ** can be 1 or more operator chars.

val field_alias_str : 
  field:t ->
  Ocamlformat_stdlib.string ->
  Ocamlformat_stdlib.bool

val field_alias : field:t -> t -> Ocamlformat_stdlib.bool