Indenter block

Shift a block by a given offset

Set the start column of the given block to column

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

Return the current line offset

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

Return the block indentation

Return the block original starting column

The empty block

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.

Display token and stack of the block

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

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.

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

True for any block that is alone on its stack

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

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