parser.mly 32.8 KB
Newer Older
1 2 3
(********************************************************************)
(*                                                                  *)
(*  The Why3 Verification Platform   /   The Why3 Development Team  *)
4
(*  Copyright 2010-2015   --   INRIA - CNRS - Paris-Sud University  *)
5 6 7 8
(*                                                                  *)
(*  This software is distributed under the terms of the GNU Lesser  *)
(*  General Public License version 2.1, with the special exception  *)
(*  on linking described in file LICENSE.                           *)
9
(*                                                                  *)
10
(********************************************************************)
Jean-Christophe Filliâtre's avatar
Jean-Christophe Filliâtre committed
11 12 13 14

%{
  open Ptree

15
  let infix  s = "infix "  ^ s
16
  let prefix s = "prefix " ^ s
17
  let mixfix s = "mixfix " ^ s
18

Andrei Paskevich's avatar
Andrei Paskevich committed
19 20 21
  let qualid_last = function Qident x | Qdot (_, x) -> x

  let use_as q = function Some x -> x | None -> qualid_last q
22

23
  let floc s e = Loc.extract (s,e)
24

25
  let add_lab id l = { id with id_lab = l }
26

27
  let id_anonymous loc = { id_str = "_"; id_lab = []; id_loc = loc }
28

29
  let mk_id id s e = { id_str = id; id_lab = []; id_loc = floc s e }
30

31 32
  let get_op s e = Qident (mk_id (mixfix "[]") s e)
  let set_op s e = Qident (mk_id (mixfix "[<-]") s e)
33 34 35
  let sub_op s e = Qident (mk_id (mixfix "[_.._]") s e)
  let above_op s e = Qident (mk_id (mixfix "[_..]") s e)
  let below_op s e = Qident (mk_id (mixfix "[.._]") s e)
36

37 38
  let mk_pat  d s e = { pat_desc  = d; pat_loc  = floc s e }
  let mk_term d s e = { term_desc = d; term_loc = floc s e }
39
  let mk_expr d s e = { expr_desc = d; expr_loc = floc s e }
40

41 42 43
  let variant_union v1 v2 = match v1, v2 with
    | _, [] -> v1
    | [], _ -> v2
44
    | _, ({term_loc = loc},_)::_ -> Loc.errorm ~loc
45 46 47 48 49 50
        "multiple `variant' clauses are not allowed"

  let empty_spec = {
    sp_pre     = [];
    sp_post    = [];
    sp_xpost   = [];
51
    sp_reads   = [];
52 53
    sp_writes  = [];
    sp_variant = [];
54 55
    sp_checkrw = false;
    sp_diverge = false;
56
  }
57

58 59 60 61
  let spec_union s1 s2 = {
    sp_pre     = s1.sp_pre @ s2.sp_pre;
    sp_post    = s1.sp_post @ s2.sp_post;
    sp_xpost   = s1.sp_xpost @ s2.sp_xpost;
62
    sp_reads   = s1.sp_reads @ s2.sp_reads;
63 64
    sp_writes  = s1.sp_writes @ s2.sp_writes;
    sp_variant = variant_union s1.sp_variant s2.sp_variant;
65 66
    sp_checkrw = s1.sp_checkrw || s2.sp_checkrw;
    sp_diverge = s1.sp_diverge || s2.sp_diverge;
67
  }
68

69
(* dead code
70
  let add_init_mark e =
71
    let init = { id_str = "Init"; id_lab = []; id_loc = e.expr_loc } in
72
    { e with expr_desc = Emark (init, e) }
73
*)
74

75
  let small_integer i =
76
    try match i with
77 78 79 80
      | Number.IConstDec s -> int_of_string s
      | Number.IConstHex s -> int_of_string ("0x"^s)
      | Number.IConstOct s -> int_of_string ("0o"^s)
      | Number.IConstBin s -> int_of_string ("0b"^s)
81
    with Failure _ -> raise Error
82

83 84
  let error_param loc =
    Loc.errorm ~loc "cannot determine the type of the parameter"
85

86 87 88 89 90
  let error_loc loc = Loc.error ~loc Error

  let () = Exn_printer.register (fun fmt exn -> match exn with
    | Error -> Format.fprintf fmt "syntax error"
    | _ -> raise exn)
Jean-Christophe Filliâtre's avatar
Jean-Christophe Filliâtre committed
91 92
%}

93
(* Tokens *)
Jean-Christophe Filliâtre's avatar
Jean-Christophe Filliâtre committed
94

95
%token <string> LIDENT UIDENT
Andrei Paskevich's avatar
Andrei Paskevich committed
96
%token <Number.integer_constant> INTEGER
97
%token <string> OP1 OP2 OP3 OP4 OPPREF
Andrei Paskevich's avatar
Andrei Paskevich committed
98
%token <Number.real_constant> FLOAT
Jean-Christophe Filliâtre's avatar
Jean-Christophe Filliâtre committed
99
%token <string> STRING
100
%token <Loc.position> POSITION
101
%token <string> QUOTE_LIDENT
102

103
(* keywords *)
104

105
%token AS AXIOM CLONE COINDUCTIVE CONSTANT
Andrei Paskevich's avatar
Andrei Paskevich committed
106 107
%token ELSE END EPSILON EXISTS EXPORT FALSE FORALL FUNCTION
%token GOAL IF IMPORT IN INDUCTIVE LEMMA
108
%token LET MATCH META NOT PREDICATE SCOPE
109
%token THEN THEORY TRUE TYPE USE WITH
110

111
(* program keywords *)
112

113
%token ABSTRACT ABSURD ANY ASSERT ASSUME AT BEGIN CHECK
114
%token DIVERGES DO DONE DOWNTO ENSURES EXCEPTION FOR
115
%token FUN GHOST INVARIANT LABEL MODULE MUTABLE OLD
116 117
%token PRIVATE RAISE RAISES READS REC REQUIRES RETURNS
%token TO TRY VAL VARIANT WHILE WRITES
118

119
(* symbols *)
120

Andrei Paskevich's avatar
Andrei Paskevich committed
121
%token AND ARROW
122
%token BAR
123
%token COLON COMMA
124
%token DOT DOTDOT EQUAL LTGT
125
%token LEFTPAR LEFTPAR_STAR_RIGHTPAR LEFTSQ
126
%token LARROW LRARROW OR
127
%token RIGHTPAR RIGHTSQ
Andrei Paskevich's avatar
Andrei Paskevich committed
128
%token UNDERSCORE
129 130 131

%token EOF

132
(* program symbols *)
133

134
%token AMPAMP BARBAR LEFTBRC RIGHTBRC SEMICOLON
135

136
(* Precedences *)
Jean-Christophe Filliâtre's avatar
Jean-Christophe Filliâtre committed
137

138
%nonassoc IN
139 140 141
%nonassoc below_SEMI
%nonassoc SEMICOLON
%nonassoc LET VAL
142
%nonassoc prec_no_else
143
%nonassoc DOT ELSE GHOST
144
%nonassoc prec_named
145
%nonassoc COLON
Jean-Christophe Filliâtre's avatar
Jean-Christophe Filliâtre committed
146

Andrei Paskevich's avatar
Andrei Paskevich committed
147
%right ARROW LRARROW
148 149
%right OR BARBAR
%right AND AMPAMP
Andrei Paskevich's avatar
Andrei Paskevich committed
150
%nonassoc NOT
151
%right EQUAL LTGT OP1
152
%nonassoc AT OLD
153
%nonassoc LARROW
154
%nonassoc RIGHTSQ    (* stronger than <- for e1[e2 <- e3] *)
155
%left OP2
156
%left OP3
157
%left OP4
158
%nonassoc prec_prefix_op
159 160
%nonassoc LEFTSQ
%nonassoc OPPREF
161

162
(* Entry points *)
Jean-Christophe Filliâtre's avatar
Jean-Christophe Filliâtre committed
163

164
%start <Pmodule.pmodule Stdlib.Mstr.t> mlw_file
Jean-Christophe Filliâtre's avatar
Jean-Christophe Filliâtre committed
165 166
%%

167
(* Modules and scopes *)
168

169
mlw_file:
170 171 172 173 174
| mlw_module* EOF
    { Typing.close_file () }
| module_decl+ EOF
    { let loc = floc $startpos($2) $endpos($2) in
      Typing.close_module loc; Typing.close_file () }
175

176
mlw_module:
177 178
| module_head module_decl* END
    { Typing.close_module (floc $startpos($3) $endpos($3)) }
179

180
module_head:
181 182
| THEORY labels(uident)  { Typing.open_module $2 }
| MODULE labels(uident)  { Typing.open_module $2 }
183

Andrei Paskevich's avatar
Andrei Paskevich committed
184 185
scope_head:
| SCOPE boption(IMPORT) uident
186
    { Typing.open_scope (floc $startpos $endpos) $3; $2 }
Andrei Paskevich's avatar
Andrei Paskevich committed
187

188
module_decl:
Andrei Paskevich's avatar
Andrei Paskevich committed
189
| scope_head module_decl* END
190
    { Typing.close_scope (floc $startpos($1) $endpos($1)) ~import:$1 }
Andrei Paskevich's avatar
Andrei Paskevich committed
191 192 193
| d = pure_decl | d = prog_decl | d = meta_decl
    { Typing.add_decl (floc $startpos $endpos) d }
| use_clone { () }
194

195
(* Use and clone *)
196

197
use_clone:
Andrei Paskevich's avatar
Andrei Paskevich committed
198 199 200 201 202 203
| USE EXPORT tqualid
    { Typing.add_decl (floc $startpos $endpos) (Duse $3) }
| CLONE EXPORT tqualid clone_subst
    { Typing.add_decl (floc $startpos $endpos) (Dclone ($3, $4)) }
| USE boption(IMPORT) tqualid option(preceded(AS, uident))
    { let loc = floc $startpos $endpos in
204
      Typing.open_scope loc (use_as $3 $4);
Andrei Paskevich's avatar
Andrei Paskevich committed
205
      Typing.add_decl loc (Duse $3);
206
      Typing.close_scope loc ~import:$2 }
Andrei Paskevich's avatar
Andrei Paskevich committed
207 208
| CLONE boption(IMPORT) tqualid option(preceded(AS, uident)) clone_subst
    { let loc = floc $startpos $endpos in
209
      Typing.open_scope loc (use_as $3 $4);
Andrei Paskevich's avatar
Andrei Paskevich committed
210
      Typing.add_decl loc (Dclone ($3, $5));
211
      Typing.close_scope loc ~import:$2 }
212

213
clone_subst:
Andrei Paskevich's avatar
Andrei Paskevich committed
214 215 216 217
| (* epsilon *)                         { [] }
| WITH comma_list1(single_clone_subst)  { $2 }

single_clone_subst:
Andrei Paskevich's avatar
Andrei Paskevich committed
218 219 220 221 222
| TYPE qualid ty_var* EQUAL ty  { CStsym  ($2,$3,$5) }
| CONSTANT  qualid EQUAL qualid { CSfsym  ($2,$4) }
| FUNCTION  qualid EQUAL qualid { CSfsym  ($2,$4) }
| PREDICATE qualid EQUAL qualid { CSpsym  ($2,$4) }
| VAL       qualid EQUAL qualid { CSvsym  ($2,$4) }
223
| AXIOM     qualid              { CSaxiom ($2) }
Andrei Paskevich's avatar
Andrei Paskevich committed
224 225
| LEMMA     qualid              { CSlemma ($2) }
| GOAL      qualid              { CSgoal  ($2) }
226

Andrei Paskevich's avatar
Andrei Paskevich committed
227
(* Meta declarations *)
228

Andrei Paskevich's avatar
Andrei Paskevich committed
229 230
meta_decl:
| META sident comma_list1(meta_arg)  { Dmeta ($2, $3) }
231 232

meta_arg:
233 234 235 236
| TYPE      ty      { Mty $2 }
| CONSTANT  qualid  { Mfs $2 }
| FUNCTION  qualid  { Mfs $2 }
| PREDICATE qualid  { Mps $2 }
237 238 239
| AXIOM     qualid  { Max $2 }
| LEMMA     qualid  { Mlm $2 }
| GOAL      qualid  { Mgl $2 }
240 241
| STRING            { Mstr $1 }
| INTEGER           { Mint (small_integer $1) }
242

Andrei Paskevich's avatar
Andrei Paskevich committed
243 244 245 246 247 248 249 250 251 252 253 254 255
(* Theory declarations *)

pure_decl:
| TYPE with_list1(type_decl)                { Dtype $2 }
| CONSTANT  constant_decl                   { Dlogic [$2] }
| FUNCTION  function_decl  with_logic_decl* { Dlogic ($2::$3) }
| PREDICATE predicate_decl with_logic_decl* { Dlogic ($2::$3) }
| INDUCTIVE   with_list1(inductive_decl)    { Dind (Decl.Ind, $2) }
| COINDUCTIVE with_list1(inductive_decl)    { Dind (Decl.Coind, $2) }
| AXIOM labels(ident) COLON term            { Dprop (Decl.Paxiom, $2, $4) }
| LEMMA labels(ident) COLON term            { Dprop (Decl.Plemma, $2, $4) }
| GOAL  labels(ident) COLON term            { Dprop (Decl.Pgoal, $2, $4) }

256
(* Type declarations *)
257 258

type_decl:
259 260
| labels(lident) ty_var* typedefn invariant*
  { let (vis, mut), def = $3 in
261
    { td_ident = $1; td_params = $2;
262 263 264
      td_vis = vis; td_mut = mut;
      td_inv = $4; td_def = def;
      td_loc = floc $startpos $endpos } }
265

266
ty_var:
267
| labels(quote_lident) { $1 }
Jean-Christophe Filliâtre's avatar
Jean-Christophe Filliâtre committed
268 269

typedefn:
270
| (* epsilon *)
271
    { (Abstract, false), TDrecord [] }
272 273
| EQUAL vis_mut bar_list1(type_case)
    { $2, TDalgebraic $3 }
274
| EQUAL vis_mut LEFTBRC loption(semicolon_list1(type_field)) RIGHTBRC
275 276 277 278 279 280 281 282 283 284
    { $2, TDrecord $4 }
| EQUAL vis_mut ty
    { $2, TDalias $3 }

vis_mut:
| (* epsilon *)     { Public, false }
| MUTABLE           { Public, true  }
| abstract          { $1, false }
| abstract MUTABLE  { $1, true }
| MUTABLE abstract  { $2, true }
285 286

abstract:
287 288
| PRIVATE           { Private }
| ABSTRACT          { Abstract }
289

290 291 292 293
type_field:
| field_modifiers labels(lident) cast
  { { f_ident = $2; f_mutable = fst $1; f_ghost = snd $1;
      f_pty = $3; f_loc = floc $startpos $endpos } }
294

295
field_modifiers:
296
| (* epsilon *) { false, false }
297 298 299 300 301
| MUTABLE       { true,  false }
| GHOST         { false, true  }
| GHOST MUTABLE { true,  true  }
| MUTABLE GHOST { true,  true  }

302
type_case:
303
| labels(uident) params { floc $startpos $endpos, $1, $2 }
304

305
(* Logic declarations *)
306

307 308
constant_decl:
| labels(lident_rich) cast preceded(EQUAL,term)?
309 310
  { { ld_ident = $1; ld_params = []; ld_type = Some $2;
      ld_def = $3; ld_loc = floc $startpos $endpos } }
311

312 313
function_decl:
| labels(lident_rich) params cast preceded(EQUAL,term)?
314 315
  { { ld_ident = $1; ld_params = $2; ld_type = Some $3;
      ld_def = $4; ld_loc = floc $startpos $endpos } }
Andrei Paskevich's avatar
Andrei Paskevich committed
316

317 318
predicate_decl:
| labels(lident_rich) params preceded(EQUAL,term)?
319 320
  { { ld_ident = $1; ld_params = $2; ld_type = None;
      ld_def = $3; ld_loc = floc $startpos $endpos } }
321

322
with_logic_decl:
323
| WITH labels(lident_rich) params cast? preceded(EQUAL,term)?
324 325
  { { ld_ident = $2; ld_params = $3; ld_type = $4;
      ld_def = $5; ld_loc = floc $startpos $endpos } }
Jean-Christophe Filliâtre's avatar
Jean-Christophe Filliâtre committed
326

327
(* Inductive declarations *)
328 329

inductive_decl:
330
| labels(lident_rich) params ind_defn
331 332
  { { in_ident = $1; in_params = $2;
      in_def = $3; in_loc = floc $startpos $endpos } }
333

334 335 336
ind_defn:
| (* epsilon *)             { [] }
| EQUAL bar_list1(ind_case) { $2 }
Jean-Christophe Filliâtre's avatar
Jean-Christophe Filliâtre committed
337

338 339
ind_case:
| labels(ident) COLON term  { floc $startpos $endpos, $1, $3 }
Jean-Christophe Filliâtre's avatar
Jean-Christophe Filliâtre committed
340

341
(* Type expressions *)
342

343 344 345 346
ty:
| ty_arg          { $1 }
| lqualid ty_arg+ { PTtyapp ($1, $2) }
| ty ARROW ty     { PTarrow ($1, $3) }
Jean-Christophe Filliâtre's avatar
Jean-Christophe Filliâtre committed
347

348 349
ty_arg:
| lqualid                           { PTtyapp ($1, []) }
350
| quote_lident                      { PTtyvar $1 }
351 352 353
| LEFTPAR comma_list2(ty) RIGHTPAR  { PTtuple $2 }
| LEFTPAR RIGHTPAR                  { PTtuple [] }
| LEFTPAR ty RIGHTPAR               { PTparen $2 }
354

355 356
cast:
| COLON ty  { $2 }
357

358
(* Parameters and binders *)
359

360 361
(* [param] and [binder] below must have the same grammar
   and raise [Error] in the same cases. Interpretaion of
362 363
   single-standing untyped [Qident]'s is different: [param]
   treats them as type expressions, [binder], as parameter
364 365
   names, whose type must be inferred. *)

366
params:  param*  { List.concat $1 }
367

368
binders: binder+ { List.concat $1 }
369 370 371

param:
| anon_binder
372 373 374 375 376 377 378 379
    { error_param (floc $startpos $endpos) }
| ty_arg
    { [floc $startpos $endpos, None, false, $1] }
| LEFTPAR GHOST ty RIGHTPAR
    { [floc $startpos $endpos, None, true, $3] }
| ty_arg label label*
    { match $1 with
      | PTtyapp (Qident _, []) ->
380 381
             error_param (floc $startpos $endpos)
      | _ -> error_loc (floc $startpos($2) $endpos($2)) }
382
| LEFTPAR binder_vars_rest RIGHTPAR
383
    { match $2 with [l,_] -> error_param l
384
      | _ -> error_loc (floc $startpos($3) $endpos($3)) }
385
| LEFTPAR GHOST binder_vars_rest RIGHTPAR
386
    { match $3 with [l,_] -> error_param l
387 388
      | _ -> error_loc (floc $startpos($4) $endpos($4)) }
| LEFTPAR binder_vars cast RIGHTPAR
389
    { List.map (fun (l,i) -> l, i, false, $3) $2 }
390
| LEFTPAR GHOST binder_vars cast RIGHTPAR
391
    { List.map (fun (l,i) -> l, i, true, $4) $3 }
Jean-Christophe Filliâtre's avatar
Jean-Christophe Filliâtre committed
392

393 394
binder:
| anon_binder
395
    { let l,i = $1 in [l, i, false, None] }
396 397 398 399
| ty_arg
    { match $1 with
      | PTtyapp (Qident id, [])
      | PTparen (PTtyapp (Qident id, [])) ->
400 401
             [floc $startpos $endpos, Some id, false, None]
      | _ -> [floc $startpos $endpos, None, false, Some $1] }
402 403 404
| LEFTPAR GHOST ty RIGHTPAR
    { match $3 with
      | PTtyapp (Qident id, []) ->
405 406
             [floc $startpos $endpos, Some id, true, None]
      | _ -> [floc $startpos $endpos, None, true, Some $3] }
407 408 409
| ty_arg label label*
    { match $1 with
      | PTtyapp (Qident id, []) ->
410 411 412
             let id = add_lab id ($2::$3) in
             [floc $startpos $endpos, Some id, false, None]
      | _ -> error_loc (floc $startpos($2) $endpos($2)) }
413
| LEFTPAR binder_vars_rest RIGHTPAR
414
    { match $2 with [l,i] -> [l, i, false, None]
415
      | _ -> error_loc (floc $startpos($3) $endpos($3)) }
416
| LEFTPAR GHOST binder_vars_rest RIGHTPAR
417
    { match $3 with [l,i] -> [l, i, true, None]
418 419
      | _ -> error_loc (floc $startpos($4) $endpos($4)) }
| LEFTPAR binder_vars cast RIGHTPAR
420
    { List.map (fun (l,i) -> l, i, false, Some $3) $2 }
421
| LEFTPAR GHOST binder_vars cast RIGHTPAR
422
    { List.map (fun (l,i) -> l, i, true, Some $4) $3 }
423

424 425 426
binder_vars:
| binder_vars_head  { List.rev $1 }
| binder_vars_rest  { $1 }
427

428
binder_vars_rest:
429 430 431 432 433 434 435
| binder_vars_head label label* binder_var*
    { List.rev_append (match $1 with
        | (l, Some id) :: bl ->
            let l3 = floc $startpos($3) $endpos($3) in
            (Loc.join l l3, Some (add_lab id ($2::$3))) :: bl
        | _ -> assert false) $4 }
| binder_vars_head anon_binder binder_var*
436
    { List.rev_append $1 ($2 :: $3) }
437
| anon_binder binder_var*
438
    { $1 :: $2 }
Jean-Christophe Filliâtre's avatar
Jean-Christophe Filliâtre committed
439

440
binder_vars_head:
441
| ty {
442 443
    let of_id id = id.id_loc, Some id in
    let push acc = function
444
      | PTtyapp (Qident id, []) -> of_id id :: acc
445
      | _ -> Loc.error ~loc:(floc $startpos $endpos) Error in
446
    match $1 with
447
      | PTtyapp (Qident id, l) -> List.fold_left push [of_id id] l
448
      | _ -> Loc.error ~loc:(floc $startpos $endpos) Error }
449

450
binder_var:
451 452
| labels(lident)  { floc $startpos $endpos, Some $1 }
| anon_binder     { $1 }
453 454

anon_binder:
455 456
| UNDERSCORE      { floc $startpos $endpos, None }

457 458 459 460 461 462 463 464 465
(* Logical terms *)

mk_term(X): d = X { mk_term d $startpos $endpos }

term: t = mk_term(term_) { t }

term_:
| term_arg_
    { match $1 with (* break the infix relation chain *)
466 467 468
      | Tinfix (l,o,r) -> Tinnfix (l,o,r)
      | Tbinop (l,o,r) -> Tbinnop (l,o,r)
      | d -> d }
469
| NOT term
470
    { Tnot $2 }
471 472 473 474
| OLD term
    { Tat ($2, mk_id "0" $startpos($1) $endpos($1)) }
| term AT uident
    { Tat ($1, $3) }
475 476 477 478
| prefix_op term %prec prec_prefix_op
    { Tidapp (Qident $1, [$2]) }
| l = term ; o = bin_op ; r = term
    { Tbinop (l, o, r) }
479
| l = term ; o = infix_op_1 ; r = term
480
    { Tinfix (l, o, r) }
481 482
| l = term ; o = infix_op_234 ; r = term
    { Tidapp (Qident o, [l; r]) }
483 484 485 486 487 488
| term_arg located(term_arg)+ (* FIXME/TODO: "term term_arg" *)
    { let join f (a,_,e) = mk_term (Tapply (f,a)) $startpos e in
      (List.fold_left join $1 $2).term_desc }
| IF term THEN term ELSE term
    { Tif ($2, $4, $6) }
| LET pattern EQUAL term IN term
489 490 491 492 493 494 495 496 497
    { let cast ty = { $4 with term_desc = Tcast ($4, ty) } in
      let pat, def = match $2.pat_desc with
        | Ptuple [] -> { $2 with pat_desc = Pwild }, cast (PTtuple [])
        | Pcast ({pat_desc = (Pvar (_,false)|Pwild)} as p, ty) -> p, cast ty
        | _ -> $2, $4 in
      match pat.pat_desc with
      | Pvar (id,false) -> Tlet (id, def, $6)
      | Pwild -> Tlet (id_anonymous pat.pat_loc, def, $6)
      | _ -> Tmatch (def, [pat, $6]) }
498 499 500 501 502 503
| LET labels(lident_op_id) EQUAL term IN term
    { Tlet ($2, $4, $6) }
| LET labels(lident) mk_term(lam_defn) IN term
    { Tlet ($2, $3, $5) }
| LET labels(lident_op_id) mk_term(lam_defn) IN term
    { Tlet ($2, $3, $5) }
504 505 506 507 508 509
| MATCH term WITH match_cases(term) END
    { Tmatch ($2, $4) }
| MATCH comma_list2(term) WITH match_cases(term) END
    { Tmatch (mk_term (Ttuple $2) $startpos($2) $endpos($2), $4) }
| quant comma_list1(quant_vars) triggers DOT term
    { Tquant ($1, List.concat $2, $3, $5) }
510
| FUN binders ARROW term
511
    { Tquant (Dterm.DTlambda, $2, [], $4) }
512 513 514 515 516 517 518
| EPSILON
    { Loc.errorm "Epsilon terms are currently not supported in WhyML" }
| label term %prec prec_named
    { Tnamed ($1, $2) }
| term cast
    { Tcast ($1, $2) }

519
lam_defn:
520
| binders EQUAL term  { Tquant (Dterm.DTlambda, $1, [], $3) }
521

522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548
term_arg: mk_term(term_arg_) { $1 }
term_dot: mk_term(term_dot_) { $1 }

term_arg_:
| qualid                    { Tident $1 }
| numeral                   { Tconst $1 }
| TRUE                      { Ttrue }
| FALSE                     { Tfalse }
| o = oppref ; a = term_arg { Tidapp (Qident o, [a]) }
| term_sub_                 { $1 }

term_dot_:
| lqualid                   { Tident $1 }
| o = oppref ; a = term_dot { Tidapp (Qident o, [a]) }
| term_sub_                 { $1 }

term_sub_:
| term_dot DOT lqualid_rich                         { Tidapp ($3,[$1]) }
| LEFTPAR term RIGHTPAR                             { $2.term_desc }
| LEFTPAR RIGHTPAR                                  { Ttuple [] }
| LEFTPAR comma_list2(term) RIGHTPAR                { Ttuple $2 }
| LEFTBRC field_list1(term) RIGHTBRC                { Trecord $2 }
| LEFTBRC term_arg WITH field_list1(term) RIGHTBRC  { Tupdate ($2,$4) }
| term_arg LEFTSQ term RIGHTSQ
    { Tidapp (get_op $startpos($2) $endpos($2), [$1;$3]) }
| term_arg LEFTSQ term LARROW term RIGHTSQ
    { Tidapp (set_op $startpos($2) $endpos($2), [$1;$3;$5]) }
549 550 551 552 553 554
| term_arg LEFTSQ term DOTDOT term RIGHTSQ
    { Tidapp (sub_op $startpos($2) $endpos($2), [$1;$3;$5]) }
| term_arg LEFTSQ term DOTDOT RIGHTSQ
    { Tidapp (above_op $startpos($2) $endpos($2), [$1;$3]) }
| term_arg LEFTSQ DOTDOT term RIGHTSQ
    { Tidapp (below_op $startpos($2) $endpos($2), [$1;$4]) }
555

556 557
field_list1(X):
| fl = semicolon_list1(separated_pair(lqualid, EQUAL, X)) { fl }
558

559 560
match_cases(X):
| cl = bar_list1(separated_pair(pattern, ARROW, X)) { cl }
561

562 563
quant_vars:
| binder_var+ cast? { List.map (fun (l,i) -> l, i, false, $2) $1 }
564

565 566 567
triggers:
| (* epsilon *)                                                 { [] }
| LEFTSQ separated_nonempty_list(BAR,comma_list1(term)) RIGHTSQ { $2 }
568

569
%inline bin_op:
570 571 572 573 574 575
| ARROW   { Dterm.DTimplies }
| LRARROW { Dterm.DTiff }
| OR      { Dterm.DTor }
| BARBAR  { Dterm.DTor_asym }
| AND     { Dterm.DTand }
| AMPAMP  { Dterm.DTand_asym }
576

577
quant:
578 579
| FORALL  { Dterm.DTforall }
| EXISTS  { Dterm.DTexists }
580

581 582 583
numeral:
| INTEGER { Number.ConstInt $1 }
| FLOAT   { Number.ConstReal $1 }
584

585
(* Program declarations *)
586

Andrei Paskevich's avatar
Andrei Paskevich committed
587
prog_decl:
588 589
| VAL ghost kind labels(lident_rich) mk_expr(val_defn) { Dlet ($4, $2, $3, $5) }
| LET ghost kind labels(lident_rich) mk_expr(fun_defn) { Dlet ($4, $2, $3, $5) }
590
| LET ghost kind labels(lident_rich) EQUAL seq_expr    { Dlet ($4, $2, $3, $6) }
591
| LET REC with_list1(rec_defn)                         { Drec $3 }
592 593
| EXCEPTION labels(uident)            { Dexn ($2, PTtuple [], Ity.MaskVisible) }
| EXCEPTION labels(uident) return     { Dexn ($2, fst $3, snd $3) }
594 595 596 597 598 599 600 601 602 603 604

ghost:
| (* epsilon *) { false }
| GHOST         { true }

kind:
| (* epsilon *) { Expr.RKnone }
| FUNCTION      { Expr.RKfunc }
| CONSTANT      { Expr.RKfunc }
| PREDICATE     { Expr.RKpred }
| LEMMA         { Expr.RKlemma }
605 606

(* Function definitions *)
607

608
rec_defn:
609 610
| ghost kind labels(lident_rich) binders ret_opt spec EQUAL spec seq_expr
    { $3, $1, $2, $4, fst $5, snd $5, spec_union $6 $8, $9 }
611

612
fun_defn:
613 614
| binders ret_opt spec EQUAL spec seq_expr
    { Efun ($1, fst $2, snd $2, spec_union $3 $5, $6) }
615

616
val_defn:
617 618
| params ret_opt spec
    { Eany ($1, Expr.RKnone, fst $2, snd $2, $3) }
619

620 621 622 623 624 625 626 627
(* Program expressions *)

mk_expr(X): d = X { mk_expr d $startpos $endpos }

seq_expr:
| expr %prec below_SEMI   { $1 }
| expr SEMICOLON          { $1 }
| expr SEMICOLON seq_expr { mk_expr (Esequence ($1, $3)) $startpos $endpos }
628

629
expr: e = mk_expr(expr_) { e }
630 631 632

expr_:
| expr_arg_
633 634
    { match $1 with (* break the infix relation chain *)
      | Einfix (l,o,r) -> Einnfix (l,o,r) | d -> d }
635 636 637 638
| expr AMPAMP expr
    { Eand ($1, $3) }
| expr BARBAR expr
    { Eor ($1, $3) }
639
| NOT expr
640
    { Enot $2 }
641
| prefix_op expr %prec prec_prefix_op
642
    { Eidapp (Qident $1, [$2]) }
643
| l = expr ; o = infix_op_1 ; r = expr
644
    { Einfix (l,o,r) }
645 646
| l = expr ; o = infix_op_234 ; r = expr
    { Eidapp (Qident o, [l;r]) }
647 648 649
| expr_arg located(expr_arg)+ (* FIXME/TODO: "expr expr_arg" *)
    { let join f (a,_,e) = mk_expr (Eapply (f,a)) $startpos e in
      (List.fold_left join $1 $2).expr_desc }
650
| IF seq_expr THEN expr ELSE expr
651
    { Eif ($2, $4, $6) }
652
| IF seq_expr THEN expr %prec prec_no_else
653 654
    { Eif ($2, $4, mk_expr (Etuple []) $startpos $endpos) }
| expr LARROW expr
655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670
    { let loc = floc $startpos $endpos in
      let rec down ll rl = match ll, rl with
        | {expr_desc = Eidapp (q, [e1])}::ll, e2::rl -> (e1,q,e2) :: down ll rl
        | {expr_desc = Eidapp (Qident id, [_;_]); expr_loc = loc}::_, _::_
          when id.id_str = mixfix "[]" -> Loc.errorm ~loc
            "Parallel array assignments are not allowed"
        | {expr_loc = loc}::_, _::_ -> Loc.errorm ~loc
            "Invalid left expression in an assignment"
        | [], [] -> []
        | _ -> Loc.errorm ~loc "Invalid parallel assignment" in
      match $1.expr_desc, $3.expr_desc with
        | Eidapp (Qident id, [e1;e2]), _ when id.id_str = mixfix "[]" ->
            Eidapp (Qident {id with id_str = mixfix "[]<-"}, [e1;e2;$3])
        | Etuple ll, Etuple rl -> Eassign (down ll rl)
        | Etuple _, _ -> Loc.errorm ~loc "Invalid parallel assignment"
        | _, _ -> Eassign (down [$1] [$3]) }
671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697
| LET ghost kind let_pattern EQUAL seq_expr IN seq_expr
    { let re_pat pat d = { pat with pat_desc = d } in
      let rec ghostify pat = match pat.pat_desc with
        (* let_pattern marks the opening variable with Ptuple [_] *)
        | Ptuple [{pat_desc = Pvar (id,_)}] -> re_pat pat (Pvar (id,$2))
        | Ptuple (p::pl) -> re_pat pat (Ptuple (ghostify p :: pl))
        | Pas (p,id,gh) -> re_pat pat (Pas (ghostify p, id, gh))
        | Por (p1,p2) -> re_pat pat (Por (ghostify p1, p2))
        | Pcast (p,t) -> re_pat pat (Pcast (ghostify p, t))
        | _ when $2 -> Loc.errorm ~loc:(floc $startpos($2) $endpos($2))
            "illegal ghost qualifier" (* $4 does not start with a Pvar *)
        | _ -> pat in
      let pat = ghostify $4 in
      let kind = match pat.pat_desc with
        | _ when $3 = Expr.RKnone -> $3
        | Pvar (_,_) | Pcast ({pat_desc = Pvar (_,_)},_) -> $3
        | _ -> Loc.errorm ~loc:(floc $startpos($3) $endpos($3))
            "illegal kind qualifier" in
      let cast ty = { $6 with expr_desc = Ecast ($6, ty) } in
      let pat, def = match pat.pat_desc with
        | Ptuple [] -> re_pat pat Pwild, cast (PTtuple [])
        | Pcast ({pat_desc = (Pvar _|Pwild)} as pat, ty) -> pat, cast ty
        | _ -> pat, $6 in
      match pat.pat_desc with
      | Pvar (id, gh) -> Elet (id, gh, kind, def, $8)
      | Pwild -> Elet (id_anonymous pat.pat_loc, false, kind, def, $8)
      | _ -> Ematch (def, [pat, $8]) }
698 699 700 701 702 703
| LET ghost kind labels(lident_op_id) EQUAL seq_expr IN seq_expr
    { Elet ($4, $2, $3, $6, $8) }
| LET ghost kind labels(lident) mk_expr(fun_defn) IN seq_expr
    { Elet ($4, $2, $3, $5, $7) }
| LET ghost kind labels(lident_op_id) mk_expr(fun_defn) IN seq_expr
    { Elet ($4, $2, $3, $5, $7) }
704
| LET REC with_list1(rec_defn) IN seq_expr
705
    { Erec ($3, $5) }
706
| FUN binders spec ARROW spec seq_expr
707
    { Efun ($2, None, Ity.MaskVisible, spec_union $3 $5, $6) }
708
| ABSTRACT spec seq_expr END
709 710 711
    { Efun ([], None, Ity.MaskVisible, $2, $3) }
| ANY return spec
    { Eany ([], Expr.RKnone, Some (fst $2), snd $2, $3) }
712 713
| VAL ghost kind labels(lident_rich) mk_expr(val_defn) IN seq_expr
    { Elet ($4, $2, $3, $5, $7) }
714 715 716 717
| MATCH seq_expr WITH match_cases(seq_expr) END
    { Ematch ($2, $4) }
| MATCH comma_list2(expr) WITH match_cases(seq_expr) END
    { Ematch (mk_expr (Etuple $2) $startpos($2) $endpos($2), $4) }
718 719
| LABEL labels(uident) IN seq_expr
    { Emark ($2, $4) }
720
| WHILE seq_expr DO loop_annotation seq_expr DONE
721
    { let inv, var = $4 in Ewhile ($2, inv, var, $5) }
722 723
| FOR lident EQUAL seq_expr for_direction seq_expr DO invariant* seq_expr DONE
    { Efor ($2, $4, $5, $6, $8, $9) }
724
| ABSURD
725
    { Eabsurd }
726 727 728 729
| RAISE uqualid expr_arg?
    { Eraise ($2, $3) }
| RAISE LEFTPAR uqualid expr_arg? RIGHTPAR
    { Eraise ($3, $4) }
730 731
| TRY seq_expr WITH bar_list1(exn_handler) END
    { Etry ($2, $4) }
732
| GHOST expr
733 734 735
    { Eghost $2 }
| assertion_kind LEFTBRC term RIGHTBRC
    { Eassert ($1, $3) }
736
| label expr %prec prec_named
737 738 739
    { Enamed ($1, $2) }
| expr cast
    { Ecast ($1, $2) }
740

741 742
expr_arg: e = mk_expr(expr_arg_) { e }
expr_dot: e = mk_expr(expr_dot_) { e }
743 744

expr_arg_:
745 746 747 748 749 750 751 752 753 754 755
| qualid                    { Eident $1 }
| numeral                   { Econst $1 }
| TRUE                      { Etrue }
| FALSE                     { Efalse }
| o = oppref ; a = expr_arg { Eidapp (Qident o, [a]) }
| expr_sub                  { $1 }

expr_dot_:
| lqualid                   { Eident $1 }
| o = oppref ; a = expr_dot { Eidapp (Qident o, [a]) }
| expr_sub                  { $1 }
756 757

expr_sub:
758
| expr_dot DOT lqualid_rich                         { Eidapp ($3, [$1]) }
759 760 761 762 763 764 765
| BEGIN seq_expr END                                { $2.expr_desc }
| LEFTPAR seq_expr RIGHTPAR                         { $2.expr_desc }
| BEGIN END                                         { Etuple [] }
| LEFTPAR RIGHTPAR                                  { Etuple [] }
| LEFTPAR comma_list2(expr) RIGHTPAR                { Etuple $2 }
| LEFTBRC field_list1(expr) RIGHTBRC                { Erecord $2 }
| LEFTBRC expr_arg WITH field_list1(expr) RIGHTBRC  { Eupdate ($2, $4) }
766
| expr_arg LEFTSQ expr RIGHTSQ
767
    { Eidapp (get_op $startpos($2) $endpos($2), [$1;$3]) }
768
| expr_arg LEFTSQ expr LARROW expr RIGHTSQ
769
    { Eidapp (set_op $startpos($2) $endpos($2), [$1;$3;$5]) }
770 771 772 773 774 775
| expr_arg LEFTSQ expr DOTDOT expr RIGHTSQ
    { Eidapp (sub_op $startpos($2) $endpos($2), [$1;$3;$5]) }
| expr_arg LEFTSQ expr DOTDOT RIGHTSQ
    { Eidapp (above_op $startpos($2) $endpos($2), [$1;$3]) }
| expr_arg LEFTSQ DOTDOT expr RIGHTSQ
    { Eidapp (below_op $startpos($2) $endpos($2), [$1;$4]) }
776

777 778
loop_annotation:
| (* epsilon *)
779
    { [], [] }
780
| invariant loop_annotation
781
    { let inv, var = $2 in $1 :: inv, var }
782
| variant loop_annotation
783
    { let inv, var = $2 in inv, variant_union $1 var }
784

785 786
exn_handler:
| uqualid pat_arg? ARROW seq_expr { $1, $2, $4 }
787 788

assertion_kind:
789 790 791
| ASSERT  { Expr.Assert }
| ASSUME  { Expr.Assume }
| CHECK   { Expr.Check }
792 793

for_direction:
794 795
| TO      { Expr.To }
| DOWNTO  { Expr.DownTo }
796

797
(* Specification *)
798

799
spec:
800
| (* epsilon *)     { empty_spec }
801
| single_spec spec  { spec_union $1 $2 }
802

803
single_spec:
804
| REQUIRES LEFTBRC term RIGHTBRC
805 806
    { { empty_spec with sp_pre = [$3] } }
| ENSURES LEFTBRC ensures RIGHTBRC
807
    { { empty_spec with sp_post = [floc $startpos($3) $endpos($3), $3] } }
808
| RETURNS LEFTBRC match_cases(term) RIGHTBRC
809 810 811 812
    { { empty_spec with sp_post = [floc $startpos($3) $endpos($3), $3] } }
| RAISES LEFTBRC bar_list1(raises) RIGHTBRC
    { { empty_spec with sp_xpost = [floc $startpos($3) $endpos($3), $3] } }
| READS  LEFTBRC comma_list0(lqualid) RIGHTBRC
813
    { { empty_spec with sp_reads = $3; sp_checkrw = true } }
814
| WRITES LEFTBRC comma_list0(term) RIGHTBRC
815
    { { empty_spec with sp_writes = $3; sp_checkrw = true } }
816 817
| RAISES LEFTBRC comma_list1(xsymbol) RIGHTBRC
    { { empty_spec with sp_xpost = [floc $startpos($3) $endpos($3), $3] } }
818 819
| DIVERGES
    { { empty_spec with sp_diverge = true } }
820 821
| variant
    { { empty_spec with sp_variant = $1 } }
822

823
ensures:
824
| term
825
    { let id = mk_id "result" $startpos $endpos in
826
      [mk_pat (Pvar (id,false)) $startpos $endpos, $1] }
827

828
raises:
829
| uqualid ARROW term
Andrei Paskevich's avatar
Andrei Paskevich committed
830
    { $1, Some (mk_pat (Ptuple []) $startpos($1) $endpos($1), $3) }
831
| uqualid pat_arg ARROW term
Andrei Paskevich's avatar
Andrei Paskevich committed
832
    { $1, Some ($2, $4) }
833

834
xsymbol:
Andrei Paskevich's avatar
Andrei Paskevich committed
835
| uqualid { $1, None }
836

837
invariant:
838
| INVARIANT LEFTBRC term RIGHTBRC { $3 }
839

840
variant:
841
| VARIANT LEFTBRC comma_list1(single_variant) RIGHTBRC { $3 }
842

843
single_variant:
844
| term preceded(WITH,lqualid)? { $1, $2 }
845

846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869
ret_opt:
| (* epsilon *)     { None, Ity.MaskVisible }
| COLON return      { Some (fst $2), snd $2 }

return:
| ret_arg           { $1 }
| lqualid ty_arg+   { PTtyapp ($1, $2), Ity.MaskVisible }
| ret_arg ARROW ty  { PTarrow (fst $1, $3),
                      if Ity.mask_ghost (snd $1) then
                        raise Error else Ity.MaskVisible }
| GHOST ty          { $2, Ity.MaskGhost }

ret_arg:
| lqualid                               { PTtyapp ($1, []), Ity.MaskVisible }
| quote_lident                          { PTtyvar $1, Ity.MaskVisible }
| LEFTPAR RIGHTPAR                      { PTtuple [], Ity.MaskVisible }
| LEFTPAR ret_sub RIGHTPAR              { PTparen (fst $2), snd $2 }
| LEFTPAR comma_list2(ret_sub) RIGHTPAR { PTtuple (List.map fst $2),
                                    Ity.MaskTuple (List.map snd $2) }

ret_sub:
| ty                { $1, Ity.MaskVisible }
| GHOST ty          { $2, Ity.MaskGhost }