package ocamlformat

  1. Overview
  2. Docs
package ocamlformat
Legend:
Library
Module
Module type
Parameter
Class
Class type
type error =
  1. | Illegal_character of char
  2. | Illegal_escape of string * string option
  3. | Reserved_sequence of string * string option
  4. | Unterminated_comment of Ocaml_common.Location.t
  5. | Unterminated_string
  6. | Unterminated_string_in_comment of Ocaml_common.Location.t * Ocaml_common.Location.t
  7. | Empty_character_literal
  8. | Keyword_as_label of string
  9. | Invalid_literal of string
  10. | Invalid_directive of string * string option
exception Error of error * Ocaml_common.Location.t
val keyword_table : (string, Parser.token) Stdlib.Hashtbl.t
val string_buffer : Stdlib.Buffer.t
val reset_string_buffer : unit -> unit
val get_stored_string : unit -> string
val store_string_char : char -> unit
val store_string_utf_8_uchar : Stdlib.Uchar.t -> unit
val store_string : string -> unit
val store_lexeme : Stdlib.Lexing.lexbuf -> unit
val string_start_loc : Ocaml_common.Location.t Stdlib.ref
val comment_start_loc : Ocaml_common.Location.t list Stdlib.ref
val in_comment : unit -> bool
val is_in_string : bool Stdlib.ref
val in_string : unit -> bool
val print_warnings : bool Stdlib.ref
val store_escaped_char : Stdlib.Lexing.lexbuf -> char -> unit
val store_escaped_uchar : Stdlib.Lexing.lexbuf -> Stdlib.Uchar.t -> unit
val compute_quoted_string_idloc : Ocaml_common.Location.t -> int -> string -> Ocaml_common.Location.t
val wrap_string_lexer : (Stdlib.Lexing.lexbuf -> Stdlib.Lexing.position) -> Stdlib.Lexing.lexbuf -> string * Ocaml_common.Location.t
val wrap_comment_lexer : (Stdlib.Lexing.lexbuf -> Ocaml_common.Location.t) -> Stdlib.Lexing.lexbuf -> string * Ocaml_common.Location.t
val error : Stdlib.Lexing.lexbuf -> error -> 'a
val error_loc : Ocaml_common.Location.t -> error -> 'a
val digit_value : char -> int
val num_value : Stdlib.Lexing.lexbuf -> base:int -> first:int -> last:int -> int
val char_for_backslash : char -> char
val illegal_escape : Stdlib.Lexing.lexbuf -> string -> 'a
val char_for_decimal_code : Stdlib.Lexing.lexbuf -> int -> char
val char_for_octal_code : Stdlib.Lexing.lexbuf -> int -> char
val char_for_hexadecimal_code : Stdlib.Lexing.lexbuf -> int -> char
val uchar_for_uchar_escape : Stdlib.Lexing.lexbuf -> Stdlib.Uchar.t
val is_keyword : string -> bool
val check_label_name : Stdlib.Lexing.lexbuf -> string -> unit
val set_lexeme_length : Stdlib.Lexing.lexbuf -> int -> unit
val disambiguate : Stdlib.Lexing.lexbuf -> string -> Parser.token
val try_disambiguate : Stdlib.Lexing.lexbuf -> Parser.token -> Parser.token option
val update_loc : Stdlib.Lexing.lexbuf -> string option -> int -> bool -> int -> unit
val preprocessor : ((unit -> unit) * ((Stdlib.Lexing.lexbuf -> Parser.token) -> Stdlib.Lexing.lexbuf -> Parser.token)) option Stdlib.ref
val escaped_newlines : bool Stdlib.ref
val warn_latin1 : Stdlib.Lexing.lexbuf -> unit
val handle_docstrings : bool Stdlib.ref
val comment_list : (string * Ocaml_common.Location.t) list Stdlib.ref
val add_comment : (string * Ocaml_common.Location.t) -> unit
val add_docstring_comment : Docstrings.docstring -> unit
val comments : unit -> (string * Ocaml_common.Location.t) list
val __ocaml_lex_tables : Stdlib.Lexing.lex_tables
val __ocaml_lex_token_rec : Stdlib.Lexing.lexbuf -> int -> Parser.token
val directive : Stdlib.Lexing.lexbuf -> Parser.token
val __ocaml_lex_directive_rec : Stdlib.Lexing.lexbuf -> int -> Parser.token
val comment : Stdlib.Lexing.lexbuf -> Ocaml_common.Location.t
val __ocaml_lex_comment_rec : Stdlib.Lexing.lexbuf -> int -> Ocaml_common.Location.t
val string : Stdlib.Lexing.lexbuf -> Stdlib.Lexing.position
val __ocaml_lex_string_rec : Stdlib.Lexing.lexbuf -> int -> Stdlib.Lexing.position
val quoted_string : string -> Stdlib.Lexing.lexbuf -> Stdlib.Lexing.position
val __ocaml_lex_quoted_string_rec : string -> Stdlib.Lexing.lexbuf -> int -> Stdlib.Lexing.position
val skip_hash_bang : Stdlib.Lexing.lexbuf -> unit
val __ocaml_lex_skip_hash_bang_rec : Stdlib.Lexing.lexbuf -> int -> unit
val token_with_comments : Stdlib.Lexing.lexbuf -> Parser.token
type newline_state =
  1. | NoLine
  2. | NewLine
  3. | BlankLine
type doc_state =
  1. | Initial
  2. | After of docstring list
  3. | Before of docstring list * docstring list * docstring list
and docstring = Docstrings.docstring
val token : Stdlib.Lexing.lexbuf -> Parser.token
val init : unit -> unit
val set_preprocessor : (unit -> unit) -> ((Stdlib.Lexing.lexbuf -> Parser.token) -> Stdlib.Lexing.lexbuf -> Parser.token) -> unit
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct