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 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287
|
(**************************************************************************)
(* *)
(* 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. *)
(* *)
(**************************************************************************)
open Ocamlformat_parser_extended
include Parsetree
let equal_core_type : core_type -> core_type -> bool = Poly.equal
type use_file = toplevel_phrase list
type repl_file = repl_phrase list
type 'a t =
| Structure : structure t
| Signature : signature t
| Use_file : use_file t
| Core_type : core_type t
| Module_type : module_type t
| Expression : expression t
| Repl_file : repl_file t
| Documentation : Ocamlformat_odoc_parser.Ast.t t
type any_t = Any : 'a t -> any_t [@@unboxed]
let of_syntax = function
| Syntax.Structure -> Any Structure
| Signature -> Any Signature
| Use_file -> Any Use_file
| Core_type -> Any Core_type
| Module_type -> Any Module_type
| Expression -> Any Expression
| Repl_file -> Any Repl_file
| Documentation -> Any Documentation
let equal (type a) (_ : a t) : a -> a -> bool = Poly.equal
let map (type a) (x : a t) (m : Ast_mapper.mapper) : a -> a =
match x with
| Structure -> m.structure m
| Signature -> m.signature m
| Use_file -> List.map ~f:(m.toplevel_phrase m)
| Core_type -> m.typ m
| Module_type -> m.module_type m
| Expression -> m.expr m
| Repl_file -> List.map ~f:(m.repl_phrase m)
| Documentation -> Fn.id
module Parse = struct
let normalize_mapper ~ocaml_version ~preserve_beginend =
let open Asttypes in
let open Ast_mapper in
let enable_short_field_annot =
Ocaml_version.compare ocaml_version Ocaml_version.Releases.v4_03_0 >= 0
in
let record_field m (f, t, v) =
match (t, v) with
(* [{ x = x }] -> [{ x }] *)
| ( _
, Some {pexp_desc= Pexp_ident {txt= v_txt; _}; pexp_attributes= []; _}
)
when Std_longident.field_alias ~field:f.txt v_txt ->
(f, t, None)
(* [{ x = (x : t) }] -> [{ x : t }] *)
| ( None
, Some
{ pexp_desc=
Pexp_constraint
( { pexp_desc= Pexp_ident {txt= v_txt; _}
; pexp_attributes= []
; _ }
, t1 )
; pexp_attributes= []
; _ } )
when enable_short_field_annot
&& Std_longident.field_alias ~field:f.txt v_txt ->
(f, Some (Pconstraint t1), None)
(* [{ x :> t = (x : t) }] -> [{ x : t :> t }] *)
| ( Some (Pcoerce (None, t2))
, Some
{ pexp_desc=
Pexp_constraint
( { pexp_desc= Pexp_ident {txt= v_txt; _}
; pexp_attributes= []
; _ }
, t1 )
; pexp_attributes= []
; _ } )
when enable_short_field_annot
&& Std_longident.field_alias ~field:f.txt v_txt ->
(f, Some (Pcoerce (Some t1, t2)), None)
(* [{ x = (x :> t) }] -> [{ x :> t }] *)
(* [{ x = (x : t :> t) }] -> [{ x : t :> t }] *)
| ( None
, Some
{ pexp_desc=
Pexp_coerce
( { pexp_desc= Pexp_ident {txt= v_txt; _}
; pexp_attributes= []
; _ }
, t1
, t2 )
; pexp_attributes= []
; _ } )
when enable_short_field_annot
&& Std_longident.field_alias ~field:f.txt v_txt ->
(f, Some (Pcoerce (t1, t2)), None)
(* [{ x : t = (x :> t) }] -> [{ x : t :> t }] *)
| ( Some (Pconstraint t1)
, Some
{ pexp_desc=
Pexp_coerce
( { pexp_desc= Pexp_ident {txt= v_txt; _}
; pexp_attributes= []
; _ }
, None
, t2 )
; pexp_attributes= []
; _ } )
when enable_short_field_annot
&& Std_longident.field_alias ~field:f.txt v_txt ->
(f, Some (Pcoerce (Some t1, t2)), None)
| _ -> (f, t, Option.map ~f:(m.expr m) v)
in
let pat_record_field m (f, t, v) =
match (t, v) with
(* [{ x = x }] -> [{ x }] *)
| _, Some {ppat_desc= Ppat_var {txt= v_txt; _}; ppat_attributes= []; _}
when Std_longident.field_alias ~field:f.txt (Lident v_txt) ->
(f, t, None)
(* [{ x = (x : t) }] -> [{ x : t}] *)
| ( None
, Some
{ ppat_desc=
Ppat_constraint
( { ppat_desc= Ppat_var {txt= v_txt; _}
; ppat_attributes= []
; _ }
, t )
; ppat_attributes= []
; _ } )
when enable_short_field_annot
&& Std_longident.field_alias ~field:f.txt (Lident v_txt) ->
(f, Some t, None)
| _ -> (f, t, Option.map ~f:(m.pat m) v)
in
let binding_op (m : Ast_mapper.mapper) b =
let b' =
let loc_start = b.pbop_op.loc.loc_start in
let loc_end = b.pbop_exp.pexp_loc.loc_end in
{b with pbop_loc= {b.pbop_loc with loc_start; loc_end}}
in
Ast_mapper.default_mapper.binding_op m b'
in
let pat m = function
| {ppat_desc= Ppat_cons (_ :: _ :: _ :: _ as l); _} as p
when match List.last_exn l with
(* Empty lists are always represented as Lident [] *)
| { ppat_desc= Ppat_construct ({txt= Lident "[]"; loc= _}, None)
; ppat_attributes= []
; _ } ->
true
| _ -> false ->
let pats = List.(rev (tl_exn (rev l))) in
{p with ppat_desc= Ppat_list pats}
(* Field alias shorthand *)
| {ppat_desc= Ppat_record (fields, flag); _} as e ->
let fields = List.map ~f:(pat_record_field m) fields in
{e with ppat_desc= Ppat_record (fields, flag)}
(* [(module M) : (module T)] -> [(module M : T)] *)
| { ppat_desc=
Ppat_constraint
( {ppat_desc= Ppat_unpack (name, None); ppat_attributes= []; _}
, {ptyp_desc= Ptyp_package pt; ptyp_attributes= []; _} )
; _ } as p ->
{p with ppat_desc= Ppat_unpack (name, Some pt)}
| p -> Ast_mapper.default_mapper.pat m p
in
let expr (m : Ast_mapper.mapper) = function
| {pexp_desc= Pexp_cons (_ :: _ :: _ :: _ as l); _} as e
when match List.last_exn l with
(* Empty lists are always represented as Lident [] *)
| { pexp_desc= Pexp_construct ({txt= Lident "[]"; loc= _}, None)
; pexp_attributes= []
; _ } ->
true
| _ -> false ->
let exprs = List.(rev (tl_exn (rev l))) in
{e with pexp_desc= Pexp_list exprs}
(* Removing beginend *)
| {pexp_desc= Pexp_beginend e'; pexp_attributes= []; _}
when not preserve_beginend ->
m.expr m e'
(* Field alias shorthand *)
| {pexp_desc= Pexp_record (fields, with_); _} as e ->
let fields = List.map ~f:(record_field m) fields in
{ e with
pexp_desc= Pexp_record (fields, Option.map ~f:(m.expr m) with_)
}
(* [( + ) 1 2] -> [1 + 2] *)
| { pexp_desc=
Pexp_apply
( { pexp_desc=
Pexp_ident {txt= Lident op as longident; loc= loc_op}
; pexp_attributes= []
; _ }
, [(Nolabel, l); (Nolabel, r)] )
; _ } as e
when Std_longident.is_infix longident
&& not (Std_longident.is_monadic_binding longident) ->
let label_loc = {txt= op; loc= loc_op} in
{e with pexp_desc= Pexp_infix (label_loc, m.expr m l, m.expr m r)}
(* [(module M) : (module T)] -> [(module M : T)] *)
| { pexp_desc=
Pexp_constraint
( { pexp_desc= Pexp_pack (name, None)
; pexp_attributes= []
; pexp_loc
; _ }
, {ptyp_desc= Ptyp_package pt; ptyp_attributes= []; ptyp_loc; _}
)
; _ } as p
when Migrate_ast.Location.compare_start ptyp_loc pexp_loc > 0 ->
(* Match locations to differentiate between the two position for
the constraint, we want to shorten the second: - [let _ :
(module S) = (module M)] - [let _ = ((module M) : (module
S))] *)
{p with pexp_desc= Pexp_pack (name, Some pt)}
| e -> Ast_mapper.default_mapper.expr m e
in
Ast_mapper.{default_mapper with expr; pat; binding_op}
let ast (type a) (fg : a t) ~ocaml_version ~preserve_beginend ~input_name
str : a =
map fg (normalize_mapper ~ocaml_version ~preserve_beginend)
@@
let lexbuf = Lexing.from_string str in
let ocaml_version =
Some Ocaml_version.(major ocaml_version, minor ocaml_version)
in
Location.init_info lexbuf input_name ;
match fg with
| Structure -> Parse.implementation ~ocaml_version lexbuf
| Signature -> Parse.interface ~ocaml_version lexbuf
| Use_file -> Parse.use_file ~ocaml_version lexbuf
| Core_type -> Parse.core_type ~ocaml_version lexbuf
| Module_type -> Parse.module_type ~ocaml_version lexbuf
| Expression -> Parse.expression ~ocaml_version lexbuf
| Repl_file -> Toplevel_lexer.repl_file ~ocaml_version lexbuf
| Documentation ->
let pos = (Location.curr lexbuf).loc_start in
let pos = {pos with pos_fname= input_name} in
Docstring.parse_file pos str
end
module Printast = struct
include Printast
let use_file = Format.pp_print_list top_phrase
let repl_file = Format.pp_print_list repl_phrase
let ast (type a) : a t -> _ -> a -> _ = function
| Structure -> implementation
| Signature -> interface
| Use_file -> use_file
| Core_type -> core_type
| Module_type -> module_type
| Expression -> expression
| Repl_file -> repl_file
| Documentation -> Docstring.dump
end
module Asttypes = struct
include Asttypes
let is_override = function Override -> true | Fresh -> false
let is_recursive = function Recursive -> true | Nonrecursive -> false
end
|