matita/components/content/interpretations.mli

   1 (* Copyright (C) 2005, 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
  27   (** {2 Persistant state handling} *)
  28
  29 type interpretation_id
  30
  31 type cic_id = string
  32
  33 val add_interpretation:
  34   string ->                                       (* id / description *)
  35   string * NotationPt.argument_pattern list -> (* symbol, level 2 pattern *)
  36   NotationPt.cic_appl_pattern ->               (* level 3 pattern *)
  37     interpretation_id
  38
  39   (** @raise Interpretation_not_found *)
  40 val lookup_interpretations:
  41   ?sorted:bool -> string -> (* symbol *)
  42     (string * NotationPt.argument_pattern list *
  43       NotationPt.cic_appl_pattern) list
  44
  45 exception Interpretation_not_found
  46
  47   (** @raise Interpretation_not_found *)
  48 val remove_interpretation: interpretation_id -> unit
  49
  50   (** {3 Interpretations toggling} *)
  51
  52 val get_all_interpretations: unit -> (interpretation_id * string) list
  53 val get_active_interpretations: unit -> interpretation_id list
  54 val set_active_interpretations: interpretation_id list -> unit
  55
  56   (** {2 content -> cic} *)
  57
  58   (** @param env environment from argument_pattern to cic terms
  59    * @param pat cic_appl_pattern *)
  60 val instantiate_appl_pattern:
  61   mk_appl:('term list -> 'term) ->
  62   mk_implicit:(bool -> 'term) ->
  63   term_of_nref : (NReference.reference -> 'term) ->
  64   (string * 'term) list -> NotationPt.cic_appl_pattern ->
  65     'term
  66
  67 val push: unit -> unit
  68 val pop: unit -> unit
  69
  70 (* for Matita NG *)
  71 val find_level2_patterns32:
  72  int ->
  73   string * string *
  74    NotationPt.argument_pattern list * NotationPt.cic_appl_pattern
  75
  76 val add_load_patterns32:
  77  ((bool * NotationPt.cic_appl_pattern * int) list -> unit) -> unit
  78 val init: unit -> unit