package lsp
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=35e8c7341f8eb1fa39fb0f0e0701a7ed90b9a0bb89ccf84b7ed997cd258cbec3
sha512=c96a7a3ca845ec193e9edc4a74804a22d6e37efc852b54575011879bd2105e0df021408632219f542ca3ad85b36b5c8b72f2b417204d154d5f0dd0839535afa5
doc/lsp.stdune/Stdune/Pp/index.html
Module Stdune.PpSource
Pretty-printing.
A document that is not yet rendered. The argument is the type of tags in the document. For instance tags might be used for styles.
Basic combinators
concat ?sep l prints elements in l separated by sep. sep defaults to nop.
Convenience function for List.map followed by concat
Print a bunch of text. The line may be broken at any spaces in the text.
Same as text but take a format string as argument.
Break hints
space instructs the pretty-printing algorithm that the line may be broken at this point. If the algorithm decides not to break the line, a single space will be printed instead.
So for instance verbatim "x" ++ space ++ verbatim "y" might produce "x y" or "x\n<indentation>y".
cut instructs the pretty-printing algorithm that the line may be broken at this point. If the algorithm decides not to break the line, nothing is printed instead.
So for instance verbatim "x" ++ space ++ verbatim "y" might produce "xy" or "x\n<indentation>y".
break is a generalisation of space and cut. It also instructs the pretty-printing algorithm that the line may be broken at this point. If it ends up being broken, shift will be added to the indentation level, otherwise nspaces spaces will be printed. shift can be negative, in which case the indentation will be reduced.
custom_break ~fits:(a, b, c) ~breaks:(x, y, z) is a generalisation of break. It also instructs the pretty-printing algorithm that the line may be broken at this point. If it ends up being broken, x is printed, the line breaks, y will be added to the indentation level and z is printed, otherwise a will be printed, b spaces are printed and then c is printed. The indentation y can be negative, in which case the indentation will be reduced.
Boxes
Boxes are the basic components to control the layout of the text. Break hints such as space and cut may cause the line to be broken, depending on the splitting rules. Whenever a line is split, the rest of the material printed in the box is indented with indent.
You can think of a box with indentation as something with this shape:
######################### <- first line <indent>################# <indent>################# <indent>################# <indent>#################
And the top left corner of this shape is anchored where the box was declared. So for instance, the following document:
Pp.verbatim "....." ++ Pp.box ~indent:2 (Pp.text "some long ... text") would produce:
.....some long ...
textTry to put as much as possible on each line. Additionally, a break hint always break the line if the breaking would reduce the indentation level inside the box (break with negative shift value).
If possible, print everything on one line. Otherwise, behave as a vbox
Try to put as much as possible on each line. Basically the same as box but without the rule about breaks with negative shift value.
Tags
Tags are arbitrary pieces of information attached to a document. They can be used to add styles to pretty-printed text, for instance to print to the terminal with colors.
Convenience functions
enumerate l ~f produces an enumeration of the form:
- item1 - item2 - item3 ...
chain l ~f is used to print a succession of items that follow each other. It produces an output of this form:
item1 -> item2 -> item3 ...
Operators
Rendering
Render a document to a classic formatter
val to_fmt_with_tags :
Format.formatter ->
'a t ->
tag_handler:(Format.formatter -> 'a -> 'a t -> unit) ->
unit