helm/ocaml/cic_disambiguation/disambiguate.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 (** {2 Disambiguation interface} *)
  27
  28 (* the integer is an offset to be added to each location *)
  29 exception NoWellTypedInterpretation of
  30  int * (Token.flocation option * string Lazy.t) list
  31 exception PathNotWellFormed
  32
  33 val interpretate_path :
  34   context:Cic.name list -> CicNotationPt.term ->
  35     Cic.term
  36
  37 module type Disambiguator =
  38 sig
  39   (** @param fresh_instances when set to true fresh instances will be generated
  40    * for each number _and_ symbol in the disambiguation domain. Instances of the
  41    * input AST will be ignored. Defaults to false. *)
  42   val disambiguate_term :
  43     ?fresh_instances:bool ->
  44     dbd:HMysql.dbd ->
  45     context:Cic.context ->
  46     metasenv:Cic.metasenv ->
  47     ?initial_ugraph:CicUniv.universe_graph ->
  48     aliases:DisambiguateTypes.environment ->(* previous interpretation status *)
  49     universe:DisambiguateTypes.multiple_environment option ->
  50     CicNotationPt.term ->
  51     ((DisambiguateTypes.domain_item * DisambiguateTypes.codomain_item) list *
  52      Cic.metasenv *                  (* new metasenv *)
  53      Cic.term *
  54      CicUniv.universe_graph) list *  (* disambiguated term *)
  55     bool  (* has interactive_interpretation_choice been invoked? *)
  56
  57   (** @param fresh_instances as per disambiguate_term *)
  58   val disambiguate_obj :
  59     ?fresh_instances:bool ->
  60     dbd:HMysql.dbd ->
  61     aliases:DisambiguateTypes.environment ->(* previous interpretation status *)
  62     universe:DisambiguateTypes.multiple_environment option ->
  63     uri:UriManager.uri option ->     (* required only for inductive types *)
  64     CicNotationPt.obj ->
  65     ((DisambiguateTypes.domain_item * DisambiguateTypes.codomain_item) list *
  66      Cic.metasenv *                  (* new metasenv *)
  67      Cic.obj *
  68      CicUniv.universe_graph) list *  (* disambiguated obj *)
  69     bool  (* has interactive_interpretation_choice been invoked? *)
  70 end
  71
  72 module Make (C : DisambiguateTypes.Callbacks) : Disambiguator
  73