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