parser.mly 30.7 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 namespaces *)
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 186 187
scope_head:
| SCOPE boption(IMPORT) uident
    { Typing.open_namespace (floc $startpos $endpos) $3; $2 }

188
module_decl:
Andrei Paskevich's avatar
Andrei Paskevich committed
189
| scope_head module_decl* END
190
    { Typing.close_namespace (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 204 205 206 207 208 209 210 211
| 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
      Typing.open_namespace loc (use_as $3 $4);
      Typing.add_decl loc (Duse $3);
      Typing.close_namespace loc ~import:$2 }
| CLONE boption(IMPORT) tqualid option(preceded(AS, uident)) clone_subst
    { let loc = floc $startpos $endpos in
      Typing.open_namespace loc (use_as $3 $4);
      Typing.add_decl loc (Dclone ($3, $5));
      Typing.close_namespace 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 223 224
| 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) }
| LEMMA     qualid              { CSlemma ($2) }
| GOAL      qualid              { CSgoal  ($2) }
225

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

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

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

Andrei Paskevich's avatar
Andrei Paskevich committed
242 243 244 245 246 247 248 249 250 251 252 253 254
(* 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) }

255
(* Type declarations *)
256 257

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

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

268 269 270 271 272 273 274 275
(* TODO: should global "mutable" imply "private"?
  "type t 'a = mutable { x : int }"
    - if "x" is immutable then the type can only be private
    - if "x" is automatically mutable then I don't like it
    - if there are known mutable fields, then a global "mutable"
      is redundant, unless it also means "private" *)
(* TODO: what should be the syntax for mutable private records
    without known fields? *)
Jean-Christophe Filliâtre's avatar
Jean-Christophe Filliâtre committed
276
typedefn:
277
| (* epsilon *)
278 279 280 281 282 283 284 285 286 287 288 289 290 291
    { (Public, false), TDabstract }
| EQUAL vis_mut bar_list1(type_case)
    { $2, TDalgebraic $3 }
| EQUAL vis_mut LEFTBRC semicolon_list1(type_field) RIGHTBRC
    { $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 }
292 293

abstract:
294 295
| PRIVATE           { Private }
| ABSTRACT          { Abstract }
296

297 298 299 300
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 } }
301

302
field_modifiers:
303
| (* epsilon *) { false, false }
304 305 306 307 308
| MUTABLE       { true,  false }
| GHOST         { false, true  }
| GHOST MUTABLE { true,  true  }
| MUTABLE GHOST { true,  true  }

309
type_case:
310
| labels(uident) params { floc $startpos $endpos, $1, $2 }
311

312
(* Logic declarations *)
313

314 315
constant_decl:
| labels(lident_rich) cast preceded(EQUAL,term)?
316 317
  { { ld_ident = $1; ld_params = []; ld_type = Some $2;
      ld_def = $3; ld_loc = floc $startpos $endpos } }
318

319 320
function_decl:
| labels(lident_rich) params cast preceded(EQUAL,term)?
321 322
  { { 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
323

324 325
predicate_decl:
| labels(lident_rich) params preceded(EQUAL,term)?
326 327
  { { ld_ident = $1; ld_params = $2; ld_type = None;
      ld_def = $3; ld_loc = floc $startpos $endpos } }
328

329
with_logic_decl:
330
| WITH labels(lident_rich) params cast? preceded(EQUAL,term)?
331 332
  { { 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
333

334
(* Inductive declarations *)
335 336

inductive_decl:
337
| labels(lident_rich) params ind_defn
338 339
  { { in_ident = $1; in_params = $2;
      in_def = $3; in_loc = floc $startpos $endpos } }
340

341 342 343
ind_defn:
| (* epsilon *)             { [] }
| EQUAL bar_list1(ind_case) { $2 }
Jean-Christophe Filliâtre's avatar
Jean-Christophe Filliâtre committed
344

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

348
(* Type expressions *)
349

350 351 352 353
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
354

355 356
ty_arg:
| lqualid                           { PTtyapp ($1, []) }
357
| quote_lident                      { PTtyvar $1 }
358 359 360
| LEFTPAR comma_list2(ty) RIGHTPAR  { PTtuple $2 }
| LEFTPAR RIGHTPAR                  { PTtuple [] }
| LEFTPAR ty RIGHTPAR               { PTparen $2 }
361

362 363
cast:
| COLON ty  { $2 }
364

365
(* Parameters and binders *)
366

367 368
(* [param] and [binder] below must have the same grammar
   and raise [Error] in the same cases. Interpretaion of
369 370
   single-standing untyped [Qident]'s is different: [param]
   treats them as type expressions, [binder], as parameter
371 372
   names, whose type must be inferred. *)

373
params:  param*  { List.concat $1 }
374

375
binders: binder+ { List.concat $1 }
376 377 378

param:
| anon_binder
379 380 381 382 383 384 385 386
    { 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 _, []) ->
387 388
             error_param (floc $startpos $endpos)
      | _ -> error_loc (floc $startpos($2) $endpos($2)) }
389
| LEFTPAR binder_vars_rest RIGHTPAR
390
    { match $2 with [l,_] -> error_param l
391
      | _ -> error_loc (floc $startpos($3) $endpos($3)) }
392
| LEFTPAR GHOST binder_vars_rest RIGHTPAR
393
    { match $3 with [l,_] -> error_param l
394 395
      | _ -> error_loc (floc $startpos($4) $endpos($4)) }
| LEFTPAR binder_vars cast RIGHTPAR
396
    { List.map (fun (l,i) -> l, i, false, $3) $2 }
397
| LEFTPAR GHOST binder_vars cast RIGHTPAR
398
    { List.map (fun (l,i) -> l, i, true, $4) $3 }
Jean-Christophe Filliâtre's avatar
Jean-Christophe Filliâtre committed
399

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

431 432 433
binder_vars:
| binder_vars_head  { List.rev $1 }
| binder_vars_rest  { $1 }
434

435
binder_vars_rest:
436 437 438 439 440 441 442
| 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*
443
   { List.rev_append $1 ($2 :: $3) }
444
| anon_binder binder_var*
445
   { $1 :: $2 }
Jean-Christophe Filliâtre's avatar
Jean-Christophe Filliâtre committed
446

447
binder_vars_head:
448
| ty {
449 450
    let of_id id = id.id_loc, Some id in
    let push acc = function
451
      | PTtyapp (Qident id, []) -> of_id id :: acc
452
      | _ -> Loc.error ~loc:(floc $startpos $endpos) Error in
453
    match $1 with
454
      | PTtyapp (Qident id, l) -> List.fold_left push [of_id id] l
455
      | _ -> Loc.error ~loc:(floc $startpos $endpos) Error }
456

457
binder_var:
458 459
| labels(lident)  { floc $startpos $endpos, Some $1 }
| anon_binder     { $1 }
460 461

anon_binder:
462 463
| UNDERSCORE      { floc $startpos $endpos, None }

464 465 466 467 468 469 470 471 472
(* 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 *)
473 474 475
      | Tinfix (l,o,r) -> Tinnfix (l,o,r)
      | Tbinop (l,o,r) -> Tbinnop (l,o,r)
      | d -> d }
476
| NOT term
477
    { Tnot $2 }
478 479 480 481
| OLD term
    { Tat ($2, mk_id "0" $startpos($1) $endpos($1)) }
| term AT uident
    { Tat ($1, $3) }
482 483 484 485
| prefix_op term %prec prec_prefix_op
    { Tidapp (Qident $1, [$2]) }
| l = term ; o = bin_op ; r = term
    { Tbinop (l, o, r) }
486
| l = term ; o = infix_op_1 ; r = term
487
    { Tinfix (l, o, r) }
488 489
| l = term ; o = infix_op_234 ; r = term
    { Tidapp (Qident o, [l; r]) }
490 491 492 493 494 495 496 497 498 499 500
| 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
    { match $2.pat_desc with
      | Pvar id -> Tlet (id, $4, $6)
      | Pwild -> Tlet (id_anonymous $2.pat_loc, $4, $6)
      | Ptuple [] -> Tlet (id_anonymous $2.pat_loc,
          { $4 with term_desc = Tcast ($4, PTtuple []) }, $6)
501 502 503 504 505
      | Pcast ({pat_desc = Pvar id}, ty) ->
          Tlet (id, { $4 with term_desc = Tcast ($4, ty) }, $6)
      | Pcast ({pat_desc = Pwild}, ty) ->
          let id = id_anonymous $2.pat_loc in
          Tlet (id, { $4 with term_desc = Tcast ($4, ty) }, $6)
506
      | _ -> Tmatch ($4, [$2, $6]) }
507 508 509 510 511 512
| 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) }
513 514 515 516 517 518
| 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) }
519
| FUN binders ARROW term
520
    { Tquant (Dterm.DTlambda, $2, [], $4) }
521 522 523 524 525 526 527
| EPSILON
    { Loc.errorm "Epsilon terms are currently not supported in WhyML" }
| label term %prec prec_named
    { Tnamed ($1, $2) }
| term cast
    { Tcast ($1, $2) }

528
lam_defn:
529
| binders EQUAL term  { Tquant (Dterm.DTlambda, $1, [], $3) }
530

531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557
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]) }
558 559 560 561 562 563
| 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]) }
564

565 566
field_list1(X):
| fl = semicolon_list1(separated_pair(lqualid, EQUAL, X)) { fl }
567

568 569
match_cases(X):
| cl = bar_list1(separated_pair(pattern, ARROW, X)) { cl }
570

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

574 575 576
triggers:
| (* epsilon *)                                                 { [] }
| LEFTSQ separated_nonempty_list(BAR,comma_list1(term)) RIGHTSQ { $2 }
577

578
%inline bin_op:
579 580 581 582 583 584
| ARROW   { Dterm.DTimplies }
| LRARROW { Dterm.DTiff }
| OR      { Dterm.DTor }
| BARBAR  { Dterm.DTor_asym }
| AND     { Dterm.DTand }
| AMPAMP  { Dterm.DTand_asym }
585

586
quant:
587 588
| FORALL  { Dterm.DTforall }
| EXISTS  { Dterm.DTexists }
589

590 591 592
numeral:
| INTEGER { Number.ConstInt $1 }
| FLOAT   { Number.ConstReal $1 }
593

594
(* Program declarations *)
595

Andrei Paskevich's avatar
Andrei Paskevich committed
596
prog_decl:
597 598
| 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) }
599
| LET ghost kind labels(lident_rich) EQUAL seq_expr    { Dlet ($4, $2, $3, $6) }
600 601 602 603 604 605 606 607 608 609 610 611 612 613
| LET REC with_list1(rec_defn)                         { Drec $3 }
| EXCEPTION labels(uident)                             { Dexn ($2, PTtuple []) }
| EXCEPTION labels(uident) ty                          { Dexn ($2, $3) }

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

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

(* Function definitions *)
616

617
rec_defn:
618 619
| ghost kind labels(lident_rich) binders cast? spec EQUAL spec seq_expr
    { $3, $1, $2, $4, $5, spec_union $6 $8, $9 }
620

621
fun_defn:
622
| binders cast? spec EQUAL spec seq_expr
623
    { Efun ($1, $2, spec_union $3 $5, $6) }
624

625 626
val_defn:
| params cast spec  { Eany ($1, $2, $3) }
627

628 629 630 631 632 633 634 635
(* 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 }
636

637
expr: e = mk_expr(expr_) { e }
638 639 640

expr_:
| expr_arg_
641 642
    { match $1 with (* break the infix relation chain *)
      | Einfix (l,o,r) -> Einnfix (l,o,r) | d -> d }
643 644 645 646
| expr AMPAMP expr
    { Eand ($1, $3) }
| expr BARBAR expr
    { Eor ($1, $3) }
647
| NOT expr
648
    { Enot $2 }
649
| prefix_op expr %prec prec_prefix_op
650
    { Eidapp (Qident $1, [$2]) }
651
| l = expr ; o = infix_op_1 ; r = expr
652
    { Einfix (l,o,r) }
653 654
| l = expr ; o = infix_op_234 ; r = expr
    { Eidapp (Qident o, [l;r]) }
655 656 657
| 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 }
658
| IF seq_expr THEN expr ELSE expr
659
    { Eif ($2, $4, $6) }
660
| IF seq_expr THEN expr %prec prec_no_else
661 662
    { Eif ($2, $4, mk_expr (Etuple []) $startpos $endpos) }
| expr LARROW expr
663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678
    { 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]) }
679 680 681 682 683 684
| LET ghost kind pattern EQUAL seq_expr IN seq_expr
    { match $4.pat_desc with
      | Pvar id -> Elet (id, $2, $3, $6, $8)
      | Pwild -> Elet (id_anonymous $4.pat_loc, $2, $3, $6, $8)
      | Ptuple [] -> Elet (id_anonymous $4.pat_loc, $2, $3,
          { $6 with expr_desc = Ecast ($6, PTtuple []) }, $8)
685
      | Pcast ({pat_desc = Pvar id}, ty) ->
686
          Elet (id, $2, $3, { $6 with expr_desc = Ecast ($6, ty) }, $8)
687
      | Pcast ({pat_desc = Pwild}, ty) ->
688 689
          let id = id_anonymous $4.pat_loc in
          Elet (id, $2, $3, { $6 with expr_desc = Ecast ($6, ty) }, $8)
690
      | _ ->
691 692 693 694 695 696 697 698 699 700 701
          let e = if $2 then { $6 with expr_desc = Eghost $6 } else $6 in
          (match $3 with
          | Expr.RKnone -> Ematch (e, [$4, $8])
          | _ -> Loc.errorm ~loc:($4.pat_loc)
              "`let <kind>' cannot be used with complex patterns") }
| 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) }
702
| LET REC with_list1(rec_defn) IN seq_expr
703
    { Erec ($3, $5) }
704
| FUN binders spec ARROW spec seq_expr
705 706 707
    { Efun ($2, None, spec_union $3 $5, $6) }
| ABSTRACT spec seq_expr END
    { Efun ([], None, $2, $3) }
708 709
| ANY ty spec
    { Eany ([], $2, $3) }
710 711
| VAL ghost kind labels(lident_rich) mk_expr(val_defn) IN seq_expr
    { Elet ($4, $2, $3, $5, $7) }
712 713 714 715
| 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) }
716 717
| LABEL labels(uident) IN seq_expr
    { Emark ($2, $4) }
718
| WHILE seq_expr DO loop_annotation seq_expr DONE
719
    { let inv, var = $4 in Ewhile ($2, inv, var, $5) }
720 721
| FOR lident EQUAL seq_expr for_direction seq_expr DO invariant* seq_expr DONE
    { Efor ($2, $4, $5, $6, $8, $9) }
722
| ABSURD
723
    { Eabsurd }
724 725 726 727
| RAISE uqualid expr_arg?
    { Eraise ($2, $3) }
| RAISE LEFTPAR uqualid expr_arg? RIGHTPAR
    { Eraise ($3, $4) }
728 729
| TRY seq_expr WITH bar_list1(exn_handler) END
    { Etry ($2, $4) }
730
| GHOST expr
731 732 733
    { Eghost $2 }
| assertion_kind LEFTBRC term RIGHTBRC
    { Eassert ($1, $3) }
734
| label expr %prec prec_named
735 736 737
    { Enamed ($1, $2) }
| expr cast
    { Ecast ($1, $2) }
738

739 740
expr_arg: e = mk_expr(expr_arg_) { e }
expr_dot: e = mk_expr(expr_dot_) { e }
741 742

expr_arg_:
743 744 745 746 747 748 749 750 751 752 753
| 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 }
754 755

expr_sub:
756
| expr_dot DOT lqualid_rich                         { Eidapp ($3, [$1]) }
757 758 759 760 761 762 763
| 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) }
764
| expr_arg LEFTSQ expr RIGHTSQ
765
    { Eidapp (get_op $startpos($2) $endpos($2), [$1;$3]) }
766
| expr_arg LEFTSQ expr LARROW expr RIGHTSQ
767
    { Eidapp (set_op $startpos($2) $endpos($2), [$1;$3;$5]) }
768 769 770 771 772 773
| 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]) }
774

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

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

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

for_direction:
792 793
| TO      { Expr.To }
| DOWNTO  { Expr.DownTo }
794

795
(* Specification *)
796

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

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

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

826
raises:
827 828 829
| uqualid ARROW term
    { $1, mk_pat (Ptuple []) $startpos($1) $endpos($1), $3 }
| uqualid pat_arg ARROW term
830
    { $1, $2, $4 }
831

832
xsymbol:
833
| uqualid
834
    { $1, mk_pat Pwild $startpos $endpos, mk_term Ttrue $startpos $endpos }
835

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

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

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

845
(* Patterns *)
Jean-Christophe's avatar
Jean-Christophe committed
846

847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863
mk_pat(X): X { mk_pat $1 $startpos $endpos }

pattern: mk_pat(pattern_) { $1 }
pat_arg: mk_pat(pat_arg_) { $1 }

pattern_:
| pat_conj_                             { $1 }
| mk_pat(pat_conj_) BAR pattern         { Por ($1,$3) }

pat_conj_:
| pat_uni_                              { $1 }
| comma_list2(mk_pat(pat_uni_))         { Ptuple $1 }

pat_uni_:
| pat_arg_                              { $1 }
| uqualid pat_arg+                      { Papp ($1,$2) }
| mk_pat(pat_uni_) AS labels(lident)    { Pas ($1,$3) }
864
| mk_pat(pat_uni_) cast                 { Pcast($1,$2) }
865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880

pat_arg_:
| UNDERSCORE                            { Pwild }
| labels(lident)                        { Pvar $1 }
| uqualid                               { Papp ($1,[]) }
| LEFTPAR RIGHTPAR                      { Ptuple [] }
| LEFTPAR pattern_ RIGHTPAR             { $2 }
| LEFTBRC field_list1(pattern) RIGHTBRC { Prec $2 }

(* Idents *)

ident:
| uident { $1 }
| lident { $1 }

uident:
881
| UIDENT        { mk_id $1 $startpos $endpos }
882 883

lident:
884
| LIDENT        { mk_id $1 $startpos $endpos }
885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910

quote_lident:
| QUOTE_LIDENT  { mk_id $1 $startpos $endpos }

(* Idents + symbolic operation names *)

ident_rich:
| uident        { $1 }
| lident_rich   { $1 }