helm/matita/matitaDisambiguator.ml

   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 open Printf
  27
  28 open MatitaTypes
  29
  30 exception Ambiguous_input
  31 exception DisambiguationError of
  32  (Token.flocation option * string Lazy.t) list list
  33
  34 type choose_uris_callback =
  35   id:string -> UriManager.uri list -> UriManager.uri list
  36
  37 type choose_interp_callback = (string * string) list list -> int list
  38
  39 let mono_uris_callback ~id =
  40  if Helm_registry.get_bool "matita.auto_disambiguation" then
  41   function l -> l
  42  else
  43   raise Ambiguous_input
  44
  45 let mono_interp_callback _ = raise Ambiguous_input
  46
  47 let _choose_uris_callback = ref mono_uris_callback
  48 let _choose_interp_callback = ref mono_interp_callback
  49 let set_choose_uris_callback f = _choose_uris_callback := f
  50 let set_choose_interp_callback f = _choose_interp_callback := f
  51
  52 module Callbacks =
  53   struct
  54     let interactive_user_uri_choice ~selection_mode ?ok
  55           ?(enable_button_for_non_vars = true) ~title ~msg ~id uris =
  56               !_choose_uris_callback ~id uris
  57
  58     let interactive_interpretation_choice interp =
  59       !_choose_interp_callback interp
  60
  61     let input_or_locate_uri ~(title:string) ?id =
  62       (* Zack: I try to avoid using this callback. I therefore assume that
  63       * the presence of an identifier that can't be resolved via "locate"
  64       * query is a syntax error *)
  65       let msg = match id with Some id -> id | _ -> "_" in
  66       raise (Unbound_identifier msg)
  67   end
  68
  69 module Disambiguator = Disambiguate.Make (Callbacks)
  70
  71 (* implement module's API *)
  72
  73 let disambiguate_thing ~aliases ~universe
  74   ~(f:?fresh_instances:bool ->
  75       aliases:DisambiguateTypes.environment ->
  76       universe:DisambiguateTypes.multiple_environment option ->
  77       'a -> 'b)
  78   ~(drop_aliases: 'b -> 'b)
  79   ~(drop_aliases_and_clear_diff: 'b -> 'b)
  80   (thing: 'a)
  81 =
  82   assert (universe <> None);
  83   let library = false, DisambiguateTypes.Environment.empty, None in
  84   let multi_aliases = false, DisambiguateTypes.Environment.empty, universe in
  85   let mono_aliases = true, aliases, Some DisambiguateTypes.Environment.empty in
  86   let passes =  (* <fresh_instances?, aliases, coercions?> *)
  87     [ (false, mono_aliases, false);
  88       (false, multi_aliases, false);
  89       (true, mono_aliases, false);
  90       (true, multi_aliases, false);
  91       (true, mono_aliases, true);
  92       (true, multi_aliases, true);
  93       (true, library, true);
  94     ]
  95   in
  96   let try_pass (fresh_instances, (_, aliases, universe), use_coercions) =
  97     CoercDb.use_coercions := use_coercions;
  98     f ~fresh_instances ~aliases ~universe thing
  99   in
 100   let set_aliases (instances,(use_mono_aliases,_,_),_) (_, user_asked as res) =
 101    if use_mono_aliases && not instances then
 102     drop_aliases res
 103    else if user_asked then
 104     drop_aliases res (* one shot aliases *)
 105    else
 106     drop_aliases_and_clear_diff res
 107   in
 108   let rec aux errors =
 109     function
 110     | [ pass ] ->
 111         (try
 112           set_aliases pass (try_pass pass)
 113          with Disambiguate.NoWellTypedInterpretation newerrors ->
 114           raise (DisambiguationError (errors @ [newerrors])))
 115     | hd :: tl ->
 116         (try
 117           set_aliases hd (try_pass hd)
 118         with Disambiguate.NoWellTypedInterpretation newerrors ->
 119          aux (errors @ [newerrors]) tl)
 120     | [] -> assert false
 121   in
 122   let saved_use_coercions = !CoercDb.use_coercions in
 123   try
 124     let res = aux [] passes in
 125     CoercDb.use_coercions := saved_use_coercions;
 126     res
 127   with exn ->
 128     CoercDb.use_coercions := saved_use_coercions;
 129     raise exn
 130
 131 type disambiguator_thing =
 132  { do_it :
 133     'a 'b.
 134     aliases:DisambiguateTypes.environment ->
 135     universe:DisambiguateTypes.multiple_environment option ->
 136     f:(?fresh_instances:bool ->
 137        aliases:DisambiguateTypes.environment ->
 138        universe:DisambiguateTypes.multiple_environment option ->
 139        'a -> 'b * bool) ->
 140     drop_aliases:('b * bool -> 'b * bool) ->
 141     drop_aliases_and_clear_diff:('b * bool -> 'b * bool) -> 'a -> 'b * bool
 142  }
 143
 144 let disambiguate_thing =
 145  let profiler = HExtlib.profile "disambiguate_thing" in
 146   { do_it =
 147      fun ~aliases ~universe ~f ~drop_aliases ~drop_aliases_and_clear_diff thing
 148      -> profiler.HExtlib.profile
 149          (disambiguate_thing ~aliases ~universe ~f ~drop_aliases
 150            ~drop_aliases_and_clear_diff) thing
 151   }
 152
 153 let drop_aliases (choices, user_asked) =
 154   (List.map (fun (d, a, b, c) -> d, a, b, c) choices),
 155   user_asked
 156
 157 let drop_aliases_and_clear_diff (choices, user_asked) =
 158   (List.map (fun (_, a, b, c) -> [], a, b, c) choices),
 159   user_asked
 160
 161 let disambiguate_term ?fresh_instances ~dbd ~context ~metasenv ?initial_ugraph
 162   ~aliases ~universe term
 163  =
 164   assert (fresh_instances = None);
 165   let f =
 166     Disambiguator.disambiguate_term ~dbd ~context ~metasenv ?initial_ugraph
 167   in
 168   disambiguate_thing.do_it ~aliases ~universe ~f ~drop_aliases
 169    ~drop_aliases_and_clear_diff term
 170
 171 let disambiguate_obj ?fresh_instances ~dbd ~aliases ~universe ~uri obj =
 172   assert (fresh_instances = None);
 173   let f = Disambiguator.disambiguate_obj ~dbd ~uri in
 174   disambiguate_thing.do_it ~aliases ~universe ~f ~drop_aliases
 175    ~drop_aliases_and_clear_diff obj