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 *
  34  ((Token.flocation list * string * string) list *
  35   (DisambiguateTypes.domain_item * DisambiguateTypes.codomain_item) list *
  36   Token.flocation option * string Lazy.t * bool) list list
  37   (** parameters are: option name, error message *)
  38 exception Unbound_identifier of string
  39
  40 type choose_uris_callback =
  41   id:string -> UriManager.uri list -> UriManager.uri list
  42
  43 type choose_interp_callback =
  44   string -> int ->
  45     (Token.flocation list * string * string) list list -> int list
  46
  47 let mono_uris_callback ~id =
  48  if Helm_registry.get_opt_default Helm_registry.get_bool ~default:true
  49       "matita.auto_disambiguation"
  50  then
  51   function l -> l
  52  else
  53   raise Ambiguous_input
  54
  55 let mono_interp_callback _ _ _ = raise Ambiguous_input
  56
  57 let _choose_uris_callback = ref mono_uris_callback
  58 let _choose_interp_callback = ref mono_interp_callback
  59 let set_choose_uris_callback f = _choose_uris_callback := f
  60 let set_choose_interp_callback f = _choose_interp_callback := f
  61
  62 module Callbacks =
  63   struct
  64     let interactive_user_uri_choice ~selection_mode ?ok
  65           ?(enable_button_for_non_vars = true) ~title ~msg ~id uris =
  66               !_choose_uris_callback ~id uris
  67
  68     let interactive_interpretation_choice interp =
  69       !_choose_interp_callback interp
  70
  71     let input_or_locate_uri ~(title:string) ?id () = None
  72       (* Zack: I try to avoid using this callback. I therefore assume that
  73       * the presence of an identifier that can't be resolved via "locate"
  74       * query is a syntax error *)
  75   end
  76
  77 module Disambiguator = Disambiguate.Make (Callbacks)
  78
  79 (* implement module's API *)
  80
  81 let only_one_pass = ref false;;
  82
  83 let disambiguate_thing ~aliases ~universe
  84   ~(f:?fresh_instances:bool ->
  85       aliases:DisambiguateTypes.environment ->
  86       universe:DisambiguateTypes.multiple_environment option ->
  87       'a -> 'b)
  88   ~(drop_aliases: ?minimize_instances:bool -> 'b -> 'b)
  89   ~(drop_aliases_and_clear_diff: 'b -> 'b)
  90   (thing: 'a)
  91 =
  92   assert (universe <> None);
  93   let library = false, DisambiguateTypes.Environment.empty, None in
  94   let multi_aliases = false, DisambiguateTypes.Environment.empty, universe in
  95   let mono_aliases = true, aliases, Some DisambiguateTypes.Environment.empty in
  96   let passes = (* <fresh_instances?, aliases, coercions?> *)
  97    if !only_one_pass then
  98     [ (true, mono_aliases, false) ]
  99    else
 100     [ (true, mono_aliases, false);
 101       (true, multi_aliases, false);
 102       (true, mono_aliases, true);
 103       (true, multi_aliases, true);
 104       (true, library, false);
 105         (* for demo to reduce the number of interpretations *)
 106       (true, library, true);
 107     ]
 108   in
 109   let try_pass (fresh_instances, (_, aliases, universe), insert_coercions) =
 110     CicRefine.insert_coercions := insert_coercions;
 111     f ~fresh_instances ~aliases ~universe thing
 112   in
 113   let set_aliases (instances,(use_mono_aliases,_,_),_) (_, user_asked as res) =
 114    if use_mono_aliases then
 115     drop_aliases ~minimize_instances:true res (* one shot aliases *)
 116    else if user_asked then
 117     drop_aliases ~minimize_instances:true res (* one shot aliases *)
 118    else
 119     drop_aliases_and_clear_diff res
 120   in
 121   let rec aux i errors passes =
 122 (*prerr_endline ("Pass: " ^ string_of_int i);*)
 123    match passes with
 124       [ pass ] ->
 125         (try
 126           set_aliases pass (try_pass pass)
 127          with Disambiguate.NoWellTypedInterpretation (offset,newerrors) ->
 128           raise (DisambiguationError (offset, errors @ [newerrors])))
 129     | hd :: tl ->
 130         (try
 131           set_aliases hd (try_pass hd)
 132         with Disambiguate.NoWellTypedInterpretation (_offset,newerrors) ->
 133          aux (i+1) (errors @ [newerrors]) tl)
 134     | [] -> assert false
 135   in
 136   let saved_insert_coercions = !CicRefine.insert_coercions in
 137   try
 138     let res = aux 1 [] passes in
 139     CicRefine.insert_coercions := saved_insert_coercions;
 140     res
 141   with exn ->
 142     CicRefine.insert_coercions := saved_insert_coercions;
 143     raise exn
 144
 145 type disambiguator_thing =
 146  { do_it :
 147     'a 'b.
 148     aliases:DisambiguateTypes.environment ->
 149     universe:DisambiguateTypes.multiple_environment option ->
 150     f:(?fresh_instances:bool ->
 151        aliases:DisambiguateTypes.environment ->
 152        universe:DisambiguateTypes.multiple_environment option ->
 153        'a -> 'b * bool) ->
 154     drop_aliases:(?minimize_instances:bool -> 'b * bool -> 'b * bool) ->
 155     drop_aliases_and_clear_diff:('b * bool -> 'b * bool) -> 'a -> 'b * bool
 156  }
 157
 158 let disambiguate_thing =
 159  let profiler = HExtlib.profile "disambiguate_thing" in
 160   { do_it =
 161      fun ~aliases ~universe ~f ~drop_aliases ~drop_aliases_and_clear_diff thing
 162      -> profiler.HExtlib.profile
 163          (disambiguate_thing ~aliases ~universe ~f ~drop_aliases
 164            ~drop_aliases_and_clear_diff) thing
 165   }
 166
 167 let drop_aliases ?(minimize_instances=false) (choices, user_asked) =
 168  let module D = DisambiguateTypes in
 169  let minimize d =
 170   if not minimize_instances then
 171    d
 172   else
 173    let rec aux =
 174     function
 175        [] -> []
 176      | (D.Symbol (s,n),((descr,_) as ci)) as he::tl when n > 0 ->
 177          if
 178           List.for_all
 179            (function
 180                (D.Symbol (s2,_),(descr2,_)) -> s2 <> s || descr = descr2
 181              | _ -> true
 182            ) d
 183          then
 184           (D.Symbol (s,0),ci)::(aux tl)
 185          else
 186           he::(aux tl)
 187      | (D.Num n,((descr,_) as ci)) as he::tl when n > 0 ->
 188          if
 189           List.for_all
 190            (function (D.Num _,(descr2,_)) -> descr = descr2 | _ -> true) d
 191          then
 192           (D.Num 0,ci)::(aux tl)
 193          else
 194           he::(aux tl)
 195       | he::tl -> he::(aux tl)
 196    in
 197     aux d
 198  in
 199   (List.map (fun (d, a, b, c) -> minimize d, a, b, c) choices),
 200   user_asked
 201
 202 let drop_aliases_and_clear_diff (choices, user_asked) =
 203   (List.map (fun (_, a, b, c) -> [], a, b, c) choices),
 204   user_asked
 205
 206 let disambiguate_term ?fresh_instances ~dbd ~context ~metasenv ?initial_ugraph
 207   ~aliases ~universe term
 208  =
 209   assert (fresh_instances = None);
 210   let f =
 211     Disambiguator.disambiguate_term ~dbd ~context ~metasenv ?initial_ugraph
 212   in
 213   disambiguate_thing.do_it ~aliases ~universe ~f ~drop_aliases
 214    ~drop_aliases_and_clear_diff term
 215
 216 let disambiguate_obj ?fresh_instances ~dbd ~aliases ~universe ~uri obj =
 217   assert (fresh_instances = None);
 218   let f = Disambiguator.disambiguate_obj ~dbd ~uri in
 219   disambiguate_thing.do_it ~aliases ~universe ~f ~drop_aliases
 220    ~drop_aliases_and_clear_diff obj