printer.mli 4.55 KB
Newer Older
1 2
(**************************************************************************)
(*                                                                        *)
MARCHE Claude's avatar
MARCHE Claude committed
3
(*  Copyright (C) 2010-2012                                               *)
4 5 6
(*    François Bobot                                                      *)
(*    Jean-Christophe Filliâtre                                           *)
(*    Claude Marché                                                       *)
MARCHE Claude's avatar
MARCHE Claude committed
7
(*    Guillaume Melquiond                                                 *)
8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34
(*    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
open Theory
open Task

(** Register printers *)

type prelude = string list
type prelude_map = prelude Mid.t

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

35
type printer = Env.env -> prelude -> prelude_map -> ?old:in_channel -> task pp
36

37
val register_printer : desc:Pp.formatted -> string -> printer -> unit
38 39 40

val lookup_printer : string -> printer

41 42
val list_printers : unit -> (string * Pp.formatted) list
val print_printer_desc : Pp.formatter -> (string * Pp.formatted) -> unit
43 44 45 46 47

(** {2 use printers} *)

val print_prelude : prelude pp
val print_th_prelude : task -> prelude_map pp
48
val print_prelude_for_theory : theory -> prelude_map pp
49

50 51
val meta_syntax_type : meta
val meta_syntax_logic : meta
52
val meta_remove_prop : meta
53 54
val meta_remove_logic : meta
val meta_remove_type_symbol : meta
55
val meta_realized : meta
56

57 58
val syntax_type : tysymbol -> string -> tdecl
val syntax_logic : lsymbol -> string -> tdecl
59 60
val remove_prop : prsymbol -> tdecl

61 62
type syntax_map = string Mid.t
(* [syntax_map] maps the idents of removed props to "" *)
63

64
val get_syntax_map : task -> syntax_map
65 66
val add_syntax_map : tdecl -> syntax_map -> syntax_map
  (* interprets a declaration as a syntax rule, if any *)
67

68
val query_syntax : syntax_map -> ident -> string option
69

70 71 72 73
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 *)

74
val syntax_arguments_typed :
75
  string -> term pp -> ty pp -> term -> term list pp
76 77 78
(** (syntax_arguments templ print_arg fmt l) prints in the formatter fmt
     the list l using the template templ and the printer print_arg *)

79 80 81 82 83 84
(** {2 pretty-printing transformations (useful for caching)} *)

val fold_tdecls : (syntax_map -> tdecl -> 'a -> 'a) -> 'a -> 'a Trans.trans

val sprint_tdecls : (syntax_map -> tdecl pp) -> string list Trans.trans
val sprint_decls  : (syntax_map -> decl  pp) -> string list Trans.trans
85

86 87 88
(** {2 exceptions to use in transformations and printers} *)

exception UnsupportedType of ty   * string
Andrei Paskevich's avatar
Andrei Paskevich committed
89
exception UnsupportedTerm of term * string
90 91 92
exception UnsupportedDecl of decl * string
exception NotImplemented  of        string

93 94 95 96
val unsupportedType : ty   -> string -> 'a
val unsupportedTerm : term -> string -> 'a
val unsupportedDecl : decl -> string -> 'a
val notImplemented  :         string -> 'a
97 98 99 100 101 102 103

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

104
val unsupported : string -> 'a
105 106 107 108 109 110 111 112 113 114 115 116 117 118

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