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 open Disambiguate_types
  27
  28   (* TODO move to  CicSomething *)
  29 val term_of_uri: string -> Cic.term
  30
  31 (** {2 Choice registration interface} *)
  32
  33   (** to be raised when a choice is invalid due to some given parameter (e.g.
  34    * wrong number of Cic.term arguments received) *)
  35 exception Invalid_choice
  36
  37   (** register a new symbol choice *)
  38 val add_symbol_choice: string -> codomain_item -> unit
  39
  40   (** register a new number choice *)
  41 val add_num_choice: codomain_item -> unit
  42
  43 (** {2 Disambiguation interface} *)
  44
  45 exception NoWellTypedInterpretation
  46
  47 module Make (C : Callbacks) :
  48   sig
  49     val disambiguate_term :
  50       MQIConn.handle ->
  51       Cic.context ->
  52       Cic.metasenv ->
  53       Ast.term ->
  54       aliases:environment ->  (* previous interpretation status *)
  55         environment *                   (* new interpretation status *)
  56         Cic.metasenv *                  (* new metasenv *)
  57         Cic.term                        (* disambiguated term *)
  58   end
  59