matitaB/components/ng_cic_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 State handling} *)
  28
  29 val hide_coercions: bool ref
  30
  31 type db
  32
  33 class type g_status =
  34   object
  35     inherit NCicCoercion.g_status
  36     method interp_db: db
  37   end
  38
  39 class virtual status :
  40   string option ->
  41   object ('self)
  42     inherit g_status
  43     inherit NCicCoercion.status
  44     method set_interp_db: db -> 'self
  45     method set_interp_status: #g_status -> 'self
  46   end
  47
  48 val add_interpretation:
  49   #status as 'status ->
  50   string ->                                       (* id / description *)
  51   string * NotationPt.argument_pattern list -> (* symbol, level 2 pattern *)
  52   NotationPt.cic_appl_pattern ->               (* level 3 pattern *)
  53     'status
  54
  55 exception Interpretation_not_found
  56
  57   (** @raise Interpretation_not_found *)
  58 val lookup_interpretations:
  59   #status ->
  60    ?sorted:bool -> string -> (* symbol *)
  61     (string * NotationPt.argument_pattern list *
  62       NotationPt.cic_appl_pattern) list
  63
  64   (** {3 Interpretations toggling} *)
  65
  66 val toggle_active_interpretations: #status as 'status -> bool -> 'status
  67
  68   (** {2 content -> cic} *)
  69
  70   (** @param env environment from argument_pattern to cic terms
  71    * @param pat cic_appl_pattern *)
  72 val instantiate_appl_pattern:
  73   mk_appl:('term list -> 'term) ->
  74   mk_implicit:(bool -> 'term) ->
  75   term_of_nref : (NReference.reference -> 'term) ->
  76   (string * 'term) list -> NotationPt.cic_appl_pattern ->
  77     'term
  78
  79 val nmap_term:
  80  #status ->
  81   metasenv:NCic.metasenv -> subst:NCic.substitution -> context:NCic.context ->
  82   NCic.term ->
  83    NotationPt.term
  84
  85 val nmap_context:
  86  #status ->
  87   metasenv:NCic.metasenv -> subst:NCic.substitution ->
  88   NCic.context -> NotationPt.context
  89
  90 val nmap_sequent:
  91  #status -> metasenv:NCic.metasenv -> subst:NCic.substitution ->
  92   int * NCic.conjecture ->
  93    NotationPt.sequent
  94
  95 val nmap_obj:
  96  #status -> NCic.obj -> NotationPt.term NotationPt.obj