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 exception NoWellTypedInterpretation
  29 exception PathNotWellFormed
  30
  31 val interpretate_path :
  32   context:Cic.name list -> DisambiguateTypes.term ->
  33     Cic.term
  34
  35   (** @param multi true if multi aliases are used, false otherwise *)
  36 type aliases = bool * DisambiguateTypes.environment
  37
  38 module type Disambiguator =
  39 sig
  40   (** @param fresh_instances when set to true fresh instances will be generated
  41    * for each number _and_ symbol in the disambiguation domain. Instances of the
  42    * input AST will be ignored. Defaults to false. *)
  43   val disambiguate_term :
  44     ?fresh_instances:bool ->
  45     dbd:Mysql.dbd ->
  46     context:Cic.context ->
  47     metasenv:Cic.metasenv ->
  48     ?initial_ugraph:CicUniv.universe_graph ->
  49     aliases:aliases ->               (* previous interpretation status *)
  50     DisambiguateTypes.term ->
  51     (DisambiguateTypes.environment * (* new interpretation status *)
  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:Mysql.dbd ->
  61     aliases:aliases ->               (* previous interpretation status *)
  62     uri:UriManager.uri option ->     (* required only for inductive types *)
  63     GrafiteAst.obj ->
  64     (DisambiguateTypes.environment * (* new interpretation status *)
  65      Cic.metasenv *                  (* new metasenv *)
  66      Cic.obj *
  67      CicUniv.universe_graph) list *  (* disambiguated obj *)
  68     bool  (* has interactive_interpretation_choice been invoked? *)
  69 end
  70
  71 module Make (C : DisambiguateTypes.Callbacks) : Disambiguator
  72
  73 module Trivial:
  74 sig
  75   exception Ambiguous_term of string
  76
  77   (** disambiguate an _unanmbiguous_ term using dummy callbacks which fail if a
  78     * choice from the user is needed to disambiguate the term
  79     * @raise Ambiguous_term for ambiguous term *)
  80   val disambiguate_string:
  81     dbd:Mysql.dbd ->
  82     ?context:Cic.context ->
  83     ?metasenv:Cic.metasenv ->
  84     ?initial_ugraph:CicUniv.universe_graph ->
  85     ?aliases:DisambiguateTypes.environment ->(* previous interpretation status*)
  86     string ->
  87     (DisambiguateTypes.environment * (* new interpretation status *)
  88      Cic.metasenv *                 (* new metasenv *)
  89      Cic.term *
  90      CicUniv.universe_graph) list   (* disambiguated term *)
  91 end
  92
  93 val dummy_floc: Lexing.position * Lexing.position
  94