printer.mli 4.88 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 31 32 33
(* 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;
  queried_terms : Term.term list;
}

34 35 36 37 38
type printer_args = {
  env        : Env.env;
  prelude    : prelude;
  th_prelude : prelude_map;
  blacklist  : blacklist;
39
  mutable printer_mapping : printer_mapping;
40 41 42
}

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

44 45
val get_default_printer_mapping : printer_mapping

46
val register_printer : desc:Pp.formatted -> string -> printer -> unit
47 48 49

val lookup_printer : string -> printer

50
val list_printers : unit -> (string * Pp.formatted) list
51 52 53 54 55 56

(** {2 use printers} *)

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

57 58
val meta_syntax_type : meta
val meta_syntax_logic : meta
59
val meta_syntax_converter : meta
60
val meta_remove_prop : meta
61
val meta_remove_logic : meta
Andrei Paskevich's avatar
Andrei Paskevich committed
62 63
val meta_remove_type : meta
val meta_realized_theory : meta
64

65 66
val syntax_type : tysymbol -> string -> tdecl
val syntax_logic : lsymbol -> string -> tdecl
67
val syntax_converter : lsymbol -> string -> tdecl
68 69
val remove_prop : prsymbol -> tdecl

70 71 72
val check_syntax_type: tysymbol -> string -> unit
val check_syntax_logic: lsymbol -> string -> unit

73 74
type syntax_map = string Mid.t
(* [syntax_map] maps the idents of removed props to "" *)
75
type converter_map = string Mls.t
76

77
val get_syntax_map : task -> syntax_map
78
val add_syntax_map : tdecl -> syntax_map -> syntax_map
79 80 81 82
(* 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
83

84
val query_syntax : syntax_map -> ident -> string option
85
val query_converter : converter_map -> lsymbol -> string option
86

87 88 89 90
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 *)

91 92 93
val gen_syntax_arguments_typed :
  ('a -> 'b) -> ('a -> 'b array) -> string -> 'a pp -> 'b pp -> 'a -> 'a list pp

94
val syntax_arguments_typed :
95
  string -> term pp -> ty pp -> term -> term list pp
96 97 98
(** (syntax_arguments templ print_arg fmt l) prints in the formatter fmt
     the list l using the template templ and the printer print_arg *)

99 100
(** {2 pretty-printing transformations (useful for caching)} *)

101
val on_syntax_map : (syntax_map -> 'a Trans.trans) -> 'a Trans.trans
102

103 104
val on_converter_map : (converter_map -> 'a Trans.trans) -> 'a Trans.trans

105
val sprint_tdecl :
106
  ('a -> Format.formatter -> Theory.tdecl -> 'a * string list) ->
107 108 109
    Theory.tdecl -> 'a * string list -> 'a * string list

val sprint_decl :
110
  ('a -> Format.formatter -> Decl.decl -> 'a * string list) ->
111
    Theory.tdecl -> 'a * string list -> 'a * string list
112

113 114 115
(** {2 exceptions to use in transformations and printers} *)

exception UnsupportedType of ty   * string
Andrei Paskevich's avatar
Andrei Paskevich committed
116
exception UnsupportedTerm of term * string
117 118 119
exception UnsupportedDecl of decl * string
exception NotImplemented  of        string

120 121
val unsupportedType : ty   -> string -> 'a
val unsupportedTerm : term -> string -> 'a
122
val unsupportedPattern : pattern -> string -> 'a
123 124
val unsupportedDecl : decl -> string -> 'a
val notImplemented  :         string -> 'a
125 126 127 128 129 130 131

(** {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 *)

132
val unsupported : string -> 'a
133 134 135 136 137 138 139 140 141 142 143 144 145

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] *)