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