1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
|
(**************************************************************************)
(* *)
(* OCamlFormat *)
(* *)
(* Copyright (c) Facebook, Inc. and its affiliates. *)
(* *)
(* This source code is licensed under the MIT license found in *)
(* the LICENSE file in the root directory of this source tree. *)
(* *)
(**************************************************************************)
(** Placing and formatting comments in a parsetree.
This module provides an interface to the global mutable data structure
that maintains the relationship between comments and Ast terms within a
parsetree.
Each comment is placed, by one of the [init] functions, either before or
after a location appearing in the parsetree. The [relocate] function can
be used to adjust this placement.
When comments are formatted by one of the [fmt] functions, they are
removed from the data structure. This is significant in cases where there
are multiple Ast terms with the same location. *)
type t
val init :
'a Extended_ast.t -> debug:bool -> Source.t -> 'a -> Cmt.t list -> t
(** [init fragment source x comments] associates each comment in [comments]
with a source location appearing in [x]. It uses [Source] to help resolve
ambiguities. Initializes the state used by the [fmt] functions. *)
val relocate :
t -> src:Location.t -> before:Location.t -> after:Location.t -> unit
(** [relocate src before after] moves (changes the association with
locations) comments before [src] to [before] and comments after [src] to
[after]. *)
val relocate_wrongfully_attached_cmts :
t -> Source.t -> Extended_ast.expression -> unit
(** [relocate_wrongfully_attached_cmts] relocates wrongfully attached
comments, e.g. comments that should be attached to the whole
pattern-matching expressions ([match-with] or [try-with] expressions) but
are wrongfully attached to the matched expression. *)
val fmt_before :
t
-> Conf.t
-> fmt_code:Fmt_odoc.fmt_code
-> ?pro:Fmt.t
-> ?epi:Fmt.t
-> ?eol:Fmt.t
-> ?adj:Fmt.t
-> Location.t
-> Fmt.t
(** [fmt_before loc] formats the comments associated with [loc] that appear
before [loc]. *)
val fmt_after :
t
-> Conf.t
-> fmt_code:Fmt_odoc.fmt_code
-> ?pro:Fmt.t
-> ?epi:Fmt.t
-> ?filter:(Cmt.t -> bool)
-> Location.t
-> Fmt.t
(** [fmt_after loc] formats the comments associated with [loc] that appear
after [loc]. *)
val fmt_within :
t
-> Conf.t
-> fmt_code:Fmt_odoc.fmt_code
-> ?pro:Fmt.t
-> ?epi:Fmt.t
-> Location.t
-> Fmt.t
(** [fmt_within loc] formats the comments associated with [loc] that appear
within [loc]. *)
module Toplevel : sig
val fmt_before :
t -> Conf.t -> fmt_code:Fmt_odoc.fmt_code -> Location.t -> Fmt.t
(** [fmt_before loc] formats the comments associated with [loc] that appear
before [loc]. *)
val fmt_after :
t -> Conf.t -> fmt_code:Fmt_odoc.fmt_code -> Location.t -> Fmt.t
(** [fmt_after loc] formats the comments associated with [loc] that appear
after [loc]. *)
end
val drop_inside : t -> Location.t -> unit
val drop_before : t -> Location.t -> t
val has_before : t -> Location.t -> bool
(** [has_before t loc] holds if [t] contains some comment before [loc]. *)
val has_within : t -> Location.t -> bool
(** [has_within t loc] holds if [t] contains some comment within [loc]. *)
val has_after : t -> Location.t -> bool
(** [has_after t loc] holds if [t] contains some comment after [loc]. *)
val remaining_comments : t -> Cmt.t list
(** Returns comments that have not been formatted yet. *)
val remaining_locs : t -> Location.t list
val remaining_before : t -> Location.t -> Cmt.t list
(** [remaining_before c loc] returns the comments before [loc] *)
type layout_cache_key =
| Arg of Asttypes.arg_label * Parsetree.expression
| Pattern of Parsetree.pattern
| Expression of Parsetree.expression
val preserve : cache_key:layout_cache_key -> (unit -> Fmt.t) -> t -> string
(** [preserve f t] formats like [f ()] but returns a string and does not
consume comments from [t]. *)
|
