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 offset : t -> int

Return the current line offset

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 original_column : t -> int

Return the block original starting column

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 : int -> 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_clean : t -> bool

A block is considered clean when it is not linked to any parser state (ie it's not within a comment, string, or ocamldoc stuff). This is not enough for a safe checkpoint: lots of rules depend on the previous/next token to decide indentation.

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), and for top-level constructs. Implies is_clean

Sourceval no_parents : t -> bool

True for any block that is alone on its stack

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. Implies is_clean. Should be safe for checkpoints

Sourceval is_in_comment : t -> bool

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

package ocp-indent

Module IndentBlockSource

Module `IndentBlock`Source