package reason

  1. Overview
  2. Docs
Reason: Syntax & Toolchain for OCaml

Install 

dune-project
 Dependency

github.com Readme Edit opam file Versions (17)

Authors

  1. J
    Jordan Walke <jordojw@gmail.com>

Maintainers

  1. J
    Jordan Walke <jordojw@gmail.com>

Sources

reason-3.6.0.tgz
sha256=271823611ba83c50e9808d99eb93c26a98088acab37f183da14efd6f8923bf9a
md5=d4d729804bc509bca0ac6223e06f7314

doc/reason/Reason_layout/index.html

Module Reason_layout

module Easy_format = Vendored_easy_format
module Comment = Reason_comment
module Range = Reason_location.Range
type break_criterion =
  1. | Never
  2. | IfNeed
  3. | Always
  4. | Always_rec
type separator =
  1. | NoSep
  2. | Sep of string
  3. | SepFinal of string * string
module WhitespaceRegion : sig ... end

* Module concerning info to correctly interleave whitespace above a layout node.

type t =
  1. | SourceMap of Location.t * t
  2. | Sequence of config * t list
  3. | Label of Easy_format.t -> Easy_format.t -> Easy_format.t * t * t
  4. | Easy of Easy_format.t
  5. | Whitespace of WhitespaceRegion.t * t

* These represent "intent to format" the AST, with some parts being annotated * with original source location. The benefit of tracking this in an * intermediate structure, is that we can then interleave comments throughout * the tree before generating the final representation. That prevents the * formatting code from having to thread comments everywhere. * * The final representation is rendered using Easy_format.

and config = {
  1. break : break_criterion;
  2. wrap : string * string;
  3. inline : bool * bool;
  4. sep : separator;
  5. indent : int;
  6. sepLeft : bool;
  7. preSpace : bool;
  8. postSpace : bool;
  9. pad : bool * bool;
  10. listConfigIfCommentsInterleaved : (config -> config) option;
  11. listConfigIfEolCommentsInterleaved : (config -> config) option;
}
val string_of_easy : Easy_format.t -> string
val indent_more : string -> string
val dump_easy : Format.formatter -> Easy_format.t -> unit
val dump : Format.formatter -> t -> unit
val source_map : ?loc:Location.t -> t -> t
val default_list_settings : Easy_format.list_param
val easy_settings_from_config : config -> string * string * string * Easy_format.list_param
val to_easy_format : t -> Easy_format.t
val get_location : t -> Location.t option

getLocFromLayout recursively takes the unioned location of its children, * and returns the max one

val is_before : location:Migrate_parsetree.Ast_408.Location.t -> t -> bool
val contains_location : t -> location:Migrate_parsetree.Ast_408.Location.t -> bool