task.mli 3.59 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
(**************************************************************************)
(*                                                                        *)
(*  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.                  *)
(*                                                                        *)
(**************************************************************************)

20
open Util
21 22 23 24
open Ident
open Ty
open Term
open Decl
25
open Theory
26

27 28 29 30 31 32
(** Clone and meta history *)

type tdecl_set = private {
  tds_set : Stdecl.t;
  tds_tag : int;
}
33

34 35 36 37
type clone_map = tdecl_set Mid.t
type meta_map = tdecl_set Mstr.t

(** Task *)
38

39 40 41
type task = task_hd option

and task_hd = private {
42 43 44 45
  task_decl  : tdecl;       (* last declaration *)
  task_prev  : task;        (* context *)
  task_known : known_map;   (* known identifiers *)
  task_clone : clone_map;   (* cloning history *)
46
  task_meta  : meta_map;    (* meta properties *)
47
  task_tag   : int;         (* unique task tag *)
48 49
}

Andrei Paskevich's avatar
Andrei Paskevich committed
50
val task_equal : task -> task -> bool
51
val task_hd_equal : task_hd -> task_hd -> bool
52

53
val task_known : task -> known_map
54
val task_clone : task -> clone_map
55
val task_meta  : task -> meta_map
56

57 58
val find_clone : task -> theory -> tdecl_set
val find_meta  : task -> string -> tdecl_set
59

60
(** {2 constructors} *)
61

62
val add_decl : task -> decl -> task
Andrei Paskevich's avatar
Andrei Paskevich committed
63
val add_tdecl : task -> tdecl -> task
64

65 66
val use_export : task -> theory -> task
val clone_export : task -> theory -> th_inst -> task
67
val add_meta : task -> string -> meta_arg list -> task
68

69
(** {2 declaration constructors + add_decl} *)
Andrei Paskevich's avatar
Andrei Paskevich committed
70

71 72 73 74
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
75

76 77 78
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
79

80
(** {2 utilities} *)
81

82
val split_theory : theory -> Spr.t option -> task list
83 84
  (** [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 *)
85

86
(** {2 bottom-up, tail-recursive traversal functions} *)
87

88 89
val task_fold : ('a -> tdecl -> 'a) -> 'a -> task -> 'a
val task_iter : (tdecl -> unit) -> task -> unit
90

91
val task_tdecls : task -> tdecl list
92
val task_decls  : task -> decl list
93 94 95

val task_goal  : task -> prsymbol

96
(* special selector for metaproperties of a single ident *)
97

98 99 100
exception NotTaggingMeta of string

val find_meta_ids : string -> tdecl_set -> Sid.t -> Sid.t
101

102 103
(* exceptions *)

104
exception GoalNotFound
Andrei Paskevich's avatar
Andrei Paskevich committed
105
exception GoalFound
106
exception SkipFound
Andrei Paskevich's avatar
Andrei Paskevich committed
107
exception LemmaFound
108