Forlan Manual

The `Params` Module

Synopsis

signature PARAMS structure Params :> PARAMS

This module contains functions for querying and setting Forlan parameters.

Interface

val getSearchPath : unit -> string list val setSearchPath : string list -> unit val getWorkingDirectory : unit -> string val setWorkingDirectory : string -> unit val getPrintingListLength : unit -> int val setPrintingListLength : int -> unit val getPrintingStringSize : unit -> int val setPrintingStringSize : int -> unit val getPrintingDataStructureDepth : unit -> int val setPrintingDataStructureDepth : int -> unit val getPrintingLineLength : unit -> int val setPrintingLineLength : int -> unit val setPrintingOfGarbageCollectionMessages : bool -> unit val getTrackExceptions : unit -> bool val setTrackExceptions : bool -> unit val getCompilationManagerVerbosity : unit -> bool val setCompilationManagerVerbosity : bool -> unit val getBindNonExhaustiveWarn : unit -> bool val setBindNonExhaustiveWarn : bool -> unit

Description


getSearchPath(): returns the search path used by Use.use and the various Forlan input functions for loading SML/Forlan files. The default is nil.

setSearchPath xs: sets the search path used by Use.use and the various Forlan input functions to xs. Non-absolute paths are made absolute by prepending the current working directory.

getWorkingDirectory(): returns the current working directory. Non-absolute paths are interpreted relative to this directory.

setWorkingDirectory dir: sets the current working directory to dir. Raises an exception if this directory doesn't exist or isn't accessible.

getPrintingListLength(): returns the number of elements of a list that the Forlan top-level will display. The default is 250.

setPrintingListLength n: sets the number of elements of a list that the Forlan top-level will display to n.

getPrintingStringSize(): returns the number of characters of a string that the Forlan top-level will display. The default is 250.

setPrintingStringSize n: sets the number of characters of a string that the Forlan top-level will display to n.

getPrintingDataStructureDepth(): returns the number of levels of a data structure that the top-level loop will display. The default is 20.

setPrintingDataStructureDepth n: sets the number of levels of a data structure that the top-level loop will display to n.

getPrintingLineLength(): returns the line length that the Forlan pretty-printer works with. The default is 80.

setPrintingLineLength n: sets the line length that the Forlan pretty-printer works with to n.

setPrintingOfGarbageCollectionMessages b: sets whether garbage collection messages will be printed; the default is not to print them.

getTrackExceptions(): returns whether a function call trace will be printed when an exception has been raised. The default is not to do so.

setTrackExceptions b: sets whether a function call trace will be printed when an exception has been raised.

getCompilationManagerVerbosity(): returns whether the Compilation Manager (CM) is verbose in its messaging. The default is that it isn't verbose.

setCompilationManagerVerbosity b: sets whether the compilation manager will be verbose in its messaging.

getBindNonExhaustiveWarn(): returns whether warnings are issued for potentially non-exhaustive bindings. The default is not to do so.

setBindNonExhaustiveWarn b: sets whether warnings should be issued for potentially non-exhaustive bindings.

[ Top | Parent | Root | Contents | Index ]

Forlan Manual

The Params Module

Synopsis

Interface

Description

The `Params` Module