helm/software/components/cic_unification/cicMetaSubst.mli

   1 (* Copyright (C) 2004, HELM Team.
   2  *
   3  * This file is part of HELM, an Hypertextual, Electronic
   4  * Library of Mathematics, developed at the Computer Science
   5  * Department, University of Bologna, Italy.
   6  *
   7  * HELM is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation; either version 2
  10  * of the License, or (at your option) any later version.
  11  *
  12  * HELM is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with HELM; if not, write to the Free Software
  19  * Foundation, Inc., 59 Temple Place - Suite 330, Boston,
  20  * MA  02111-1307, USA.
  21  *
  22  * For details, see the HELM World-Wide-Web page,
  23  * http://helm.cs.unibo.it/
  24  *)
  25
  26 exception MetaSubstFailure of string Lazy.t
  27 exception Uncertain of string Lazy.t
  28 exception AssertFailure of string Lazy.t
  29 exception DeliftingARelWouldCaptureAFreeVariable;;
  30
  31 (* The entry (i,t) in a substitution means that *)
  32 (* (META i) have been instantiated with t.      *)
  33 (* type substitution = (int * (Cic.context * Cic.term)) list *)
  34
  35   (** @raise SubstNotFound *)
  36
  37 (* apply_subst subst t                     *)
  38 (* applies the substitution [subst] to [t] *)
  39 (* [subst] must be already unwinded        *)
  40
  41 val apply_subst : Cic.substitution -> Cic.term -> Cic.term
  42 val apply_subst_context : Cic.substitution -> Cic.context -> Cic.context
  43 val apply_subst_metasenv: Cic.substitution -> Cic.metasenv -> Cic.metasenv
  44
  45 (*** delifting ***)
  46
  47 val delift :
  48   int -> Cic.substitution -> Cic.context -> Cic.metasenv ->
  49   (Cic.term option) list -> Cic.term ->
  50     Cic.term * Cic.metasenv * Cic.substitution
  51 val restrict :
  52   Cic.substitution -> (int * int) list -> Cic.metasenv ->
  53   Cic.metasenv * Cic.substitution
  54
  55 (** delifts the Rels in t of n
  56  *  @raise DeliftingARelWouldCaptureAFreeVariable
  57  *)
  58 val delift_rels :
  59  Cic.substitution -> Cic.metasenv -> int -> Cic.term ->
  60   Cic.term * Cic.substitution * Cic.metasenv
  61
  62 (** {2 Pretty printers} *)
  63 val use_low_level_ppterm_in_context : bool ref
  64 val set_ppterm_in_context :
  65  (metasenv:Cic.metasenv -> Cic.substitution -> Cic.term -> Cic.context ->
  66    string) -> unit
  67
  68 val ppsubst_unfolded: metasenv:Cic.metasenv -> Cic.substitution -> string
  69 val ppsubst: metasenv:Cic.metasenv -> Cic.substitution -> string
  70 val ppterm: metasenv:Cic.metasenv -> Cic.substitution -> Cic.term -> string
  71 val ppcontext:
  72  metasenv:Cic.metasenv -> ?sep: string -> Cic.substitution -> Cic.context ->
  73    string
  74 val ppterm_in_context:
  75  metasenv:Cic.metasenv -> Cic.substitution -> Cic.term -> Cic.context -> string
  76 val ppmetasenv: ?sep: string -> Cic.substitution -> Cic.metasenv -> string
  77
  78 (** {2 Format-like pretty printers}
  79  * As above with prototypes suitable for toplevel/ocamldebug printers. No
  80  * subsitutions are applied here since such printers are required to be invoked
  81  * with only one argument.
  82  *)
  83
  84 val fppsubst: Format.formatter -> Cic.substitution -> unit
  85 val fppterm: Format.formatter -> Cic.term -> unit
  86 val fppmetasenv: Format.formatter -> Cic.metasenv -> unit
  87
  88 (*
  89 (* DEBUG *)
  90 val print_counters: unit -> unit
  91 val reset_counters: unit -> unit
  92 *)
  93
  94 (* val clean_up_meta :
  95   Cic.substitution -> Cic.metasenv -> Cic.term -> Cic.term
  96 *)