helm/ocaml/acic_content/termAcicContent.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   (** {2 Persistant state handling} *)
  27
  28 type interpretation_id
  29
  30 val add_interpretation:
  31   string ->                                       (* id / description *)
  32   string * CicNotationPt.argument_pattern list -> (* symbol, level 2 pattern *)
  33   CicNotationPt.cic_appl_pattern ->               (* level 3 pattern *)
  34     interpretation_id
  35
  36   (** @raise Interpretation_not_found *)
  37 val lookup_interpretations:
  38   string -> (* symbol *)
  39     (string * CicNotationPt.argument_pattern list *
  40       CicNotationPt.cic_appl_pattern) list
  41
  42 exception Interpretation_not_found
  43
  44   (** @raise Interpretation_not_found *)
  45 val remove_interpretation: interpretation_id -> unit
  46
  47   (** {3 Interpretations toggling} *)
  48
  49 val get_all_interpretations: unit -> (interpretation_id * string) list
  50 val get_active_interpretations: unit -> interpretation_id list
  51 val set_active_interpretations: interpretation_id list -> unit
  52
  53   (** {2 acic -> content} *)
  54
  55 val ast_of_acic:
  56   (Cic.id, CicNotationPt.sort_kind) Hashtbl.t ->    (* id -> sort *)
  57   Cic.annterm ->                                    (* acic *)
  58     CicNotationPt.term                              (* ast *)
  59     * (Cic.id, UriManager.uri) Hashtbl.t            (* id -> uri *)
  60
  61   (** {2 content -> acic} *)
  62
  63   (** @param env environment from argument_pattern to cic terms
  64    * @param pat cic_appl_pattern *)
  65 val instantiate_appl_pattern:
  66   (string * Cic.term) list -> CicNotationPt.cic_appl_pattern ->
  67     Cic.term
  68