package ocp-indent

  1. Overview
  2. Docs
A simple tool to indent OCaml programs

Install 

dune-project
 Dependency

www.typerex.org Edit opam file Versions (5)

Authors

  1. L
    Louis Gesbert <louis.gesbert@ocamlpro.com>
  2. T
    Thomas Gazagnaire <thomas@gazagnaire.org>
  3. J
    Jun Furuse

Maintainers

  1. C
    contact@ocamlpro.com

Sources

1.6.1.tar.gz
sha256=f314fa1d6f1ece652a291b552f1f49ec6439c9c3f5e7819e16de5c08d4588fe2
md5=935d03f4f6376d687c46f350ff5eecdd

doc/ocp-indent.lib/IndentPrinter/index.html

Module IndentPrinter

type output_elt =
  1. | Newline
  2. | Indent of int
  3. | Whitespace of string
  4. | Text of string

Passed to the function specified with the Extended output_kind

type 'a output_kind =
  1. | Numeric of int -> 'a -> 'a
  2. | Print of string -> 'a -> 'a
  3. | Extended of IndentBlock.t -> output_elt -> 'a -> 'a

* If Print f, the whole input is fed as strings through f, with expected lines reindented (with spaces). * If Numeric f, the indentation values (i.e. total number of leading spaces) for each lines on which in_lines is true are passed through the function. * If Extended f, every element is fed to f with arguments state element. There is at least an element for each token, but there may be more (whitespace, multiline tokens...). You may safely raise an exception from f to stop further processing. This version can be used for syntax highlighting or storing checkpoints.

type 'a output = {
  1. debug : bool;
  2. config : IndentConfig.t;
    (*

    Returns true on the lines that should be reindented (lines start at 1)

    *)
  3. in_lines : int -> bool;
    (*

    if true, partial indent will adapt to the current indent of the file

    *)
  4. adaptive : bool;
  5. indent_empty : bool;
  6. kind : 'a output_kind;
}
val std_output : unit output
val proceed : 'a output -> Nstream.t -> IndentBlock.t -> 'a -> 'a