package merlin-lib

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Argument parsing library which fold over arguments
1. Combinators for building actions
2. Parsing of argument lists

Merlin's libraries

Install

dune-project

Dependency

github.com Readme Changelog Edit opam file Versions (17)

Authors

T

The Merlin team

Maintainers

D

defree@gmail.com

Sources

merlin-5.8.1-505.tbz

sha256=b8fb32bc0fc092af2fd6bdc831cb966057f2e3fd7b99a172b705e96ba8082583

sha512=01ca96f8167d062ba24036e43f650ff958fb157d44867bd52eb7999b7d19bf9fc97cdcd46c04b6979f0e1149d5041047723eed5913b03c4404d7acb116183bee

doc/merlin-lib.utils/Merlin_utils/Marg/index.html

Module `Merlin_utils.Marg`Source

Argument parsing library which fold over arguments

Specifications of arguments is split in two passes:

_ table for parsing global arguments (compiler flags, merlin configuration)
a (string * _ t) for parsing command local arguments

Sourcetype 'acc t = string list -> 'acc -> string list * 'acc

Action associated to a flag updating a state of type 'acc. It takes a list of arguments and either succeeds returning untouched arguments or fails raising an exception.

Sourcetype 'acc table = (string, 'acc t) Hashtbl.t

A table mapping a flag to the corresponding action

Combinators for building actions

Sourceval unit : ('acc -> 'acc) -> 'acc t

Action updating state and not consuming any argument

Sourceval param : string -> (string -> 'acc -> 'acc) -> 'acc t

Action consuming a single argument

Sourceval bool : (bool -> 'acc -> 'acc) -> 'acc t

Action consuming a boolean argument

Sourceval int : (int -> 'acc -> 'acc) -> 'acc t

Action consuming an integer argument

Sourceval unit_ignore : 'acc t

Action doing nothing

Sourceval param_ignore : 'acc t

Action doing nothing and dropping one argument

Parsing of argument lists

Sourcetype docstring = string

Sourcetype 'a spec = string * docstring * 'a t

Source

val parse_one : 
  warning:(string -> unit) ->
  'global table ->
  'local spec list ->
  string list ->
  'global ->
  'local ->
  (string list * 'global * 'local) option

Consume at most one flag from the list, returning updated state or None in case of failure. Warning function is called with an error message in case of incorrect use.