helm/ocaml/cic_disambiguation/disambiguateChoices.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 DisambiguateTypes
  27
  28 (** {2 Choice registration interface} *)
  29
  30   (** to be raised when a choice is invalid due to some given parameter (e.g.
  31    * wrong number of Cic.term arguments received) *)
  32 exception Invalid_choice
  33
  34   (** raised by lookup_XXXX below *)
  35 exception Choice_not_found of string
  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 Choices lookup}
  44  * for user defined aliases *)
  45
  46   (** @param symbol symbol as per AST *)
  47 val lookup_symbol_choices: string -> codomain_item list
  48
  49 val lookup_num_choices: unit -> codomain_item list
  50
  51   (** @param symbol symbol as per AST
  52    * @param dsc description (1st component of codomain_item)
  53    *)
  54 val lookup_symbol_by_dsc: string -> string -> codomain_item
  55
  56   (** @param dsc description (1st component of codomain_item) *)
  57 val lookup_num_by_dsc: string -> codomain_item
  58