printer.mli 5.1 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 9 10
(*                                                                  *)
(*  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.                           *)
(*                                                                  *)
(********************************************************************)
11 12 13 14 15 16 17 18 19 20 21 22

open Ident
open Ty
open Term
open Decl
open Theory
open Task

(** Register printers *)

type prelude = string list
type prelude_map = prelude Mid.t
23
type blacklist = string list
24 25 26

type 'a pp = Format.formatter -> 'a -> unit

27 28 29 30
(* Makes it possible to estabilish traceability from names
in the output of the printer to elements of AST in its input. *)
type printer_mapping = {
  lsymbol_m     : string -> Term.lsymbol;
31 32 33
  vc_line       : Loc.position option;
  (* The position of the term corresponding to the line in the program
     for that the VC was made *)
34
  queried_terms : Term.term list;
35 36
  (* The list of terms that were queried for the counter-example
     by the printer *)
37 38
}

39 40 41 42 43
type printer_args = {
  env        : Env.env;
  prelude    : prelude;
  th_prelude : prelude_map;
  blacklist  : blacklist;
44
  mutable printer_mapping : printer_mapping;
45 46 47
}

type printer = printer_args -> ?old:in_channel -> task pp
48

49 50
val get_default_printer_mapping : printer_mapping

51
val register_printer : desc:Pp.formatted -> string -> printer -> unit
52 53 54

val lookup_printer : string -> printer

55
val list_printers : unit -> (string * Pp.formatted) list
56 57 58 59 60 61

(** {2 use printers} *)

val print_prelude : prelude pp
val print_th_prelude : task -> prelude_map pp

62 63
val meta_syntax_type : meta
val meta_syntax_logic : meta
64
val meta_syntax_converter : meta
65
val meta_remove_prop : meta
66
val meta_remove_logic : meta
Andrei Paskevich's avatar
Andrei Paskevich committed
67 68
val meta_remove_type : meta
val meta_realized_theory : meta
69

70 71
val syntax_type : tysymbol -> string -> tdecl
val syntax_logic : lsymbol -> string -> tdecl
72
val syntax_converter : lsymbol -> string -> tdecl
73 74
val remove_prop : prsymbol -> tdecl

75 76 77
val check_syntax_type: tysymbol -> string -> unit
val check_syntax_logic: lsymbol -> string -> unit

78 79
type syntax_map = string Mid.t
(* [syntax_map] maps the idents of removed props to "" *)
80
type converter_map = string Mls.t
81

82
val get_syntax_map : task -> syntax_map
83
val add_syntax_map : tdecl -> syntax_map -> syntax_map
84 85 86 87
(* interprets a declaration as a syntax rule, if any *)

val get_converter_map : task -> converter_map
val add_converter_map : tdecl -> converter_map -> converter_map
88

89
val query_syntax : syntax_map -> ident -> string option
90
val query_converter : converter_map -> lsymbol -> string option
91

92 93 94 95
val syntax_arguments : string -> 'a pp -> 'a list pp
(** (syntax_arguments templ print_arg fmt l) prints in the formatter fmt
     the list l using the template templ and the printer print_arg *)

96 97 98
val gen_syntax_arguments_typed :
  ('a -> 'b) -> ('a -> 'b array) -> string -> 'a pp -> 'b pp -> 'a -> 'a list pp

99
val syntax_arguments_typed :
100
  string -> term pp -> ty pp -> term -> term list pp
101 102 103
(** (syntax_arguments templ print_arg fmt l) prints in the formatter fmt
     the list l using the template templ and the printer print_arg *)

104 105
(** {2 pretty-printing transformations (useful for caching)} *)

106
val on_syntax_map : (syntax_map -> 'a Trans.trans) -> 'a Trans.trans
107

108 109
val on_converter_map : (converter_map -> 'a Trans.trans) -> 'a Trans.trans

110
val sprint_tdecl :
111
  ('a -> Format.formatter -> Theory.tdecl -> 'a * string list) ->
112 113 114
    Theory.tdecl -> 'a * string list -> 'a * string list

val sprint_decl :
115
  ('a -> Format.formatter -> Decl.decl -> 'a * string list) ->
116
    Theory.tdecl -> 'a * string list -> 'a * string list
117

118 119 120
(** {2 exceptions to use in transformations and printers} *)

exception UnsupportedType of ty   * string
Andrei Paskevich's avatar
Andrei Paskevich committed
121
exception UnsupportedTerm of term * string
122 123 124
exception UnsupportedDecl of decl * string
exception NotImplemented  of        string

125 126
val unsupportedType : ty   -> string -> 'a
val unsupportedTerm : term -> string -> 'a
127
val unsupportedPattern : pattern -> string -> 'a
128 129
val unsupportedDecl : decl -> string -> 'a
val notImplemented  :         string -> 'a
130 131 132 133 134 135 136

(** {3 functions that catch inner error} *)

exception Unsupported of string
(** This exception must be raised only inside a call
    of one of the catch_* functions below *)

137
val unsupported : string -> 'a
138 139 140 141 142 143 144 145 146 147 148 149 150

val catch_unsupportedType : (ty -> 'a) -> (ty -> 'a)
(** [catch_unsupportedType f] return a function which applied on [arg]:
    - return [f arg] if [f arg] does not raise {!Unsupported} exception
    - raise [UnsupportedType (arg,s)] if [f arg] raises [Unsupported s]*)

val catch_unsupportedTerm : (term -> 'a) -> (term -> 'a)
(** same as {! catch_unsupportedType} but use [UnsupportedExpr]
    instead of [UnsupportedType]*)

val catch_unsupportedDecl : (decl -> 'a) -> (decl -> 'a)
(** same as {! catch_unsupportedType} but use [UnsupportedDecl]
    instead of [UnsupportedType] *)