[hcoop/debian/mlton.git] / doc / guide / src / ShowBasisDirective.adoc

ShowBasisDirective
==================

A comment of the form `(*#showBasis "<file>"*)` is recognized as a directive to
save the current basis (i.e., environment) to `<file>` (in the same format as
the `-show-basis <file>` <:CompileTimeOptions: compile-time option>).  The
`<file>` is interpreted relative to the source file in which it appears.  The
comment is lexed as a distinct token and is parsed as a structure-level
declaration.  [Note that treating the directive as a top-level declaration would
prohibit using it inside a functor body, which would make the feature
significantly less useful in the context of the MLton compiler sources (with its
nearly fully functorial style).]

This feature is meant to facilitate auto-completion via
https://github.com/MatthewFluet/company-mlton[`company-mlton`] and similar
tools.
Commit	Line	Data
7f918cf1 CE	1	ShowBasisDirective
	2	==================
	3
	4	A comment of the form `(#showBasis "<file>")` is recognized as a directive to
	5	save the current basis (i.e., environment) to `<file>` (in the same format as
	6	the `-show-basis <file>` <:CompileTimeOptions: compile-time option>). The
	7	`<file>` is interpreted relative to the source file in which it appears. The
	8	comment is lexed as a distinct token and is parsed as a structure-level
	9	declaration. [Note that treating the directive as a top-level declaration would
	10	prohibit using it inside a functor body, which would make the feature
	11	significantly less useful in the context of the MLton compiler sources (with its
	12	nearly fully functorial style).]
	13
	14	This feature is meant to facilitate auto-completion via
	15	https://github.com/MatthewFluet/company-mlton[`company-mlton`] and similar
	16	tools.