package ocp-indent-nlfork

You can search for identifiers within the package.

in-package search v0.2.0

ocp-indent library, "newline tokens" fork

Install

Dune Dependency

www.typerex.org Readme Edit opam file Versions (2)

Authors

Maintainers

C

contact@ocamlpro.com

Sources

nlfork-1.5.4.tar.gz

md5=e9d1a7de64e169536ddf16023b111409

sha512=4637eb4ac2a47001f7b236ad7fdcbf7fe1a659e947a46aacd7ff2f2e386c82c423468aabd6adcabed8caf869d4a8f3f592ea1134b4ba77b7d37080e01cc497dc

doc/ocp-indent-nlfork.lib/IndentBlock/index.html

Module `IndentBlock`Source

Sourcetype t

Indenter block

Sourceval shift : t -> int -> t

Shift a block by a given offset

Sourceval set_column : t -> int -> t

Set the start column of the given block to column

Sourceval reverse : t -> t

reverse block updates the stack to account for the original indentation, assumed as correct. Useful for partial indentation

Sourceval padding : t -> int

Return the padding of the block, ie expected relative indentation of sub-blocks

Sourceval indent : t -> int

Return the block indentation

Sourceval empty : t

The empty block

Sourceval update : IndentConfig.t -> t -> Nstream.t -> Nstream.token -> t

update t str tok computes the new block state after processing the token tok in block t. The next tokens can be observed in the stream str.

Sourceval dump : t -> unit

Display token and stack of the block

Sourceval guess_indent : t -> int

guess_indent line block For indenting empty lines: attempt to guess what the most probable indent at this point would be

Sourceval is_at_top : t -> bool

True only when the block is at the root of the file (the stack is empty, the block isn't included in any syntactical construct).

Sourceval is_declaration : t -> bool

Returns true if the given block is at a top-level declaration level, ie not within any expression or type definition, but possibly inside a module, signature or class definition.

Sourceval is_in_comment : t -> bool

Either we are at a comment, or within an ocamldoc block.

Sourceval is_in_string : t -> bool

Sourceval starts_line : t -> bool

true when the block is at a line start.