task.mli 3.27 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
(**************************************************************************)
(*                                                                        *)
(*  Copyright (C) 2010-                                                   *)
(*    Francois Bobot                                                      *)
(*    Jean-Christophe Filliatre                                           *)
(*    Johannes Kanig                                                      *)
(*    Andrei Paskevich                                                    *)
(*                                                                        *)
(*  This software is free software; you can redistribute it and/or        *)
(*  modify it under the terms of the GNU Library General Public           *)
(*  License version 2.1, with the special exception on linking            *)
(*  described in file LICENSE.                                            *)
(*                                                                        *)
(*  This software is distributed in the hope that it will be useful,      *)
(*  but WITHOUT ANY WARRANTY; without even the implied warranty of        *)
(*  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.                  *)
(*                                                                        *)
(**************************************************************************)

open Ident
open Ty
open Term
open Decl
24
open Theory
25 26 27

(** Task *)

28 29 30
type task = task_hd option

and task_hd = private {
31 32 33 34 35 36
  task_decl  : tdecl;       (* last declaration *)
  task_prev  : task;        (* context *)
  task_known : known_map;   (* known identifiers *)
  task_clone : clone_map;   (* cloning history *)
  task_used  : use_map;     (* referenced theories *)
  task_tag   : int;         (* unique task tag *)
37 38
}

39 40 41 42 43
and tdecl = private
  | Decl  of decl
  | Use   of theory
  | Clone of theory * (ident * ident) list

Andrei Paskevich's avatar
Andrei Paskevich committed
44
val task_equal : task -> task -> bool
45
val task_hd_equal : task_hd -> task_hd -> bool
46

47
val task_known : task -> known_map
48
val task_clone : task -> clone_map
49
val task_used  : task -> use_map
50

51 52
(* constructors *)

Andrei Paskevich's avatar
Andrei Paskevich committed
53 54
val create_decl : decl -> tdecl

55
val add_decl : task -> decl -> task
Andrei Paskevich's avatar
Andrei Paskevich committed
56
val add_tdecl : task -> tdecl -> task
57

58 59
val use_export : task -> theory -> task
val clone_export : task -> theory -> th_inst -> task
60

61
(* declaration constructors + add_decl *)
Andrei Paskevich's avatar
Andrei Paskevich committed
62

63 64 65 66
val add_ty_decl : task -> ty_decl list -> task
val add_logic_decl : task -> logic_decl list -> task
val add_ind_decl : task -> ind_decl list -> task
val add_prop_decl : task -> prop_kind -> prsymbol -> fmla -> task
67

68 69 70
val add_ty_decls : task -> ty_decl list -> task
val add_logic_decls : task -> logic_decl list -> task
val add_ind_decls : task -> ind_decl list -> task
71

72
(* utilities *)
73

74
val split_theory : theory -> Spr.t option -> task list
75 76
  (** [split_theory th s] returns the tasks of [th] which end by one
      of [s]. They are in the opposite order than in the theory *)
77 78

(* bottom-up, tail-recursive traversal functions *)
79

80 81 82 83
val task_fold : ('a -> tdecl -> 'a) -> 'a -> task -> 'a
val task_iter : (tdecl -> unit) -> task -> unit
val task_tdecls : task -> tdecl list
val task_decls : task -> decl list
84 85 86 87 88 89

val task_goal  : task -> prsymbol

val last_clone : task -> task
val last_use   : task -> task

90 91
(* exceptions *)

92
exception GoalNotFound
Andrei Paskevich's avatar
Andrei Paskevich committed
93
exception GoalFound
Andrei Paskevich's avatar
Andrei Paskevich committed
94
exception LemmaFound
95