summaryrefslogtreecommitdiff
path: root/src/property.mli
diff options
context:
space:
mode:
Diffstat (limited to 'src/property.mli')
-rw-r--r--src/property.mli89
1 files changed, 89 insertions, 0 deletions
diff --git a/src/property.mli b/src/property.mli
new file mode 100644
index 00000000..fa24377a
--- /dev/null
+++ b/src/property.mli
@@ -0,0 +1,89 @@
+(**************************************************************************)
+(* Sail *)
+(* *)
+(* Copyright (c) 2013-2017 *)
+(* Kathyrn Gray *)
+(* Shaked Flur *)
+(* Stephen Kell *)
+(* Gabriel Kerneis *)
+(* Robert Norton-Wright *)
+(* Christopher Pulte *)
+(* Peter Sewell *)
+(* Alasdair Armstrong *)
+(* Brian Campbell *)
+(* Thomas Bauereiss *)
+(* Anthony Fox *)
+(* Jon French *)
+(* Dominic Mulligan *)
+(* Stephen Kell *)
+(* Mark Wassell *)
+(* *)
+(* All rights reserved. *)
+(* *)
+(* This software was developed by the University of Cambridge Computer *)
+(* Laboratory as part of the Rigorous Engineering of Mainstream Systems *)
+(* (REMS) project, funded by EPSRC grant EP/K008528/1. *)
+(* *)
+(* Redistribution and use in source and binary forms, with or without *)
+(* modification, are permitted provided that the following conditions *)
+(* are met: *)
+(* 1. Redistributions of source code must retain the above copyright *)
+(* notice, this list of conditions and the following disclaimer. *)
+(* 2. Redistributions in binary form must reproduce the above copyright *)
+(* notice, this list of conditions and the following disclaimer in *)
+(* the documentation and/or other materials provided with the *)
+(* distribution. *)
+(* *)
+(* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' *)
+(* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED *)
+(* TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A *)
+(* PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR *)
+(* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, *)
+(* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT *)
+(* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF *)
+(* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND *)
+(* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, *)
+(* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT *)
+(* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF *)
+(* SUCH DAMAGE. *)
+(**************************************************************************)
+
+(** This file implements utilities for dealing with $property and
+ $counterexample pragmas. *)
+
+open Ast
+open Ast_util
+open Type_check
+
+(** [find_properties defs] returns a mapping from ids to of 4-tuples of the form
+ (prop_type, command, loc, val_spec), which contains the information
+ from any pragmas of the form
+
+ $prop_type command
+ ...
+ val <val_spec>
+
+ where prop_type is either "counterexample" or "property" and the
+ location loc is the location that was attached to the pragma
+*)
+val find_properties : 'a defs -> (string * string * l * 'a val_spec) Bindings.t
+
+(** For a property
+
+ $prop_type val f : forall X, C. T -> bool
+
+ find the function body for id:
+
+ function f(args) = exp
+
+ and rewrite the function body to
+
+ function f(args) = if constraint(not(C)) then true else exp
+
+ The reason we do this is that the type information in T constrained
+ by C might be lost when translating to Jib, as Jib types are
+ simpler and less precise. If we then do random test
+ generation/proving we want to ensure that inputs outside the
+ constraints of the function are ignored.
+*)
+val rewrite : tannot defs -> tannot defs