package ocp-indent

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

Install 

dune-project
 Dependency

www.typerex.org Readme Changelog Edit opam file Versions (6)

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

ocp-indent-1.10.0.tbz
sha256=e47c8476554f792ddcb9e73de9e86461266a56674e489d744498be610556c1b7
sha512=8c3e6a05f0692772a14aa533aa436d15100ea28be6592f51174811689ce8c3b717c78803189e450574ae982ab4a062b01251e1e57b971ce95dbd3f41265515f2

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

Module IndentPrinterSource

Sourcetype 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

Sourcetype '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.

Sourcetype '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;
}
Sourceval std_output : unit output
Sourceval proceed : 'a output -> Nstream.t -> IndentBlock.t -> 'a -> 'a
Sourceval check : _ output -> Nstream.t -> IndentBlock.t -> bool