matitaB/components/ng_disambiguation/grafiteDisambiguate.mli

   1 (* Copyright (C) 2004-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 type db
  27
  28 class type g_status =
  29  object
  30   inherit Interpretations.g_status
  31   inherit NCicLibrary.g_status
  32   method disambiguate_db: db
  33  end
  34
  35 class virtual status :
  36   string option ->
  37  object ('self)
  38   inherit g_status
  39   inherit Interpretations.status
  40   inherit NCicLibrary.status
  41   method set_disambiguate_db: db -> 'self
  42   method reset_disambiguate_db: unit -> 'self
  43   method set_disambiguate_status: #g_status -> 'self
  44  end
  45
  46 (* reports disambiguation errors *)
  47 exception Error of
  48   (* location of a choice point *)
  49   (Stdpp.location *
  50     (* one possible choice (or no valid choice) *)
  51     (GrafiteAst.alias_spec option *
  52       (* list of asts together with the failing location and error msg *)
  53       ((Stdpp.location * GrafiteAst.alias_spec) list *
  54         Stdpp.location * string) list)
  55       list)
  56   list
  57
  58   (* val eval_with_new_aliases:
  59  #status as 'status -> ('status -> 'a) ->
  60   ((Stdpp.location * DisambiguateTypes.domain_item) * GrafiteAst.alias_spec) list * 'a
  61 *)
  62
  63 val get_interpr : db -> GrafiteAst.alias_spec DisambiguateTypes.InterprEnv.t
  64
  65 val add_to_interpr:
  66  #status as 'status ->
  67   (Stdpp.location * GrafiteAst.alias_spec) list -> 'status
  68
  69 val add_to_disambiguation_univ:
  70  #status as 'status ->
  71   (DisambiguateTypes.domain_item * GrafiteAst.alias_spec) list -> 'status
  72
  73 val aliases_for_objs:
  74  #NCicLibrary.status -> NUri.uri list ->
  75   (DisambiguateTypes.domain_item * GrafiteAst.alias_spec) list
  76
  77 (* args: print function, message (may be empty), status *)
  78 val dump_aliases: (string -> unit) -> string -> #status -> unit
  79
  80 (* reports the first source of ambiguity and its possible interpretations *)
  81 exception Ambiguous_input of (Stdpp.location * GrafiteAst.alias_spec list)
  82
  83 exception BaseUriNotSetYet
  84
  85 val disambiguate_nterm :
  86  #status as 'status ->
  87  NCic.term option -> NCic.context -> NCic.metasenv -> NCic.substitution ->
  88  NotationPt.term Disambiguate.disambiguator_input ->
  89    NCic.metasenv * NCic.substitution * 'status * NCic.term
  90
  91 val disambiguate_nobj :
  92  #status as 'status -> ?baseuri:string ->
  93  (NotationPt.term NotationPt.obj) Disambiguate.disambiguator_input ->
  94  'status * NCic.obj
  95
  96 type pattern =
  97   NotationPt.term Disambiguate.disambiguator_input option *
  98   (string * NCic.term) list * NCic.term option
  99
 100 val disambiguate_npattern:
 101  #NCicEnvironment.status -> GrafiteAst.npattern Disambiguate.disambiguator_input -> pattern
 102
 103 val disambiguate_cic_appl_pattern:
 104  #status ->
 105   NotationPt.argument_pattern list ->
 106    NotationPt.cic_appl_pattern -> NotationPt.cic_appl_pattern