helm/software/components/lexicon/lexiconEngine.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 module L = LexiconAst
  29
  30 let debug = ref false
  31
  32 (* lexicon file name * ma file name *)
  33 exception IncludedFileNotCompiled of string * string
  34 exception MetadataNotFound of string        (* file name *)
  35
  36 type status = {
  37   aliases: L.alias_spec DisambiguateTypes.Environment.t;
  38   multi_aliases: L.alias_spec list DisambiguateTypes.Environment.t;
  39   lexicon_content_rev: LexiconMarshal.lexicon;
  40   notation_ids: CicNotation.notation_id list;      (** in-scope notation ids *)
  41 }
  42
  43 let dump_aliases out msg status =
  44    out (if msg = "" then "aliases dump:" else msg ^ ": aliases dump:");
  45    DisambiguateTypes.Environment.iter
  46       (fun _ x -> out (LexiconAstPp.pp_alias x))
  47       status.aliases
  48
  49 let initial_status = {
  50   aliases = DisambiguateTypes.Environment.empty;
  51   multi_aliases = DisambiguateTypes.Environment.empty;
  52   lexicon_content_rev = [];
  53   notation_ids = [];
  54 }
  55
  56 let add_lexicon_content cmds status =
  57   let content = status.lexicon_content_rev in
  58   let content' =
  59     List.fold_right
  60      (fun cmd acc ->
  61         match cmd with
  62         | L.Alias _
  63         | L.Include _
  64         | L.Notation _ -> cmd :: (List.filter ((<>) cmd) acc)
  65         | L.Interpretation _ -> if List.exists ((=) cmd) acc then acc else cmd::acc)
  66      cmds content
  67   in
  68 (*
  69   prerr_endline ("new lexicon content: " ^
  70      String.concat "; " (List.map LexiconAstPp.pp_command content')
  71   );
  72 *)
  73   { status with lexicon_content_rev = content' }
  74
  75 let set_proof_aliases mode status new_aliases =
  76  if mode = L.WithoutPreferences then
  77    status
  78  else
  79    let commands_of_aliases =
  80      List.map
  81       (fun _,alias -> L.Alias (HExtlib.dummy_floc, alias))
  82    in
  83    let aliases =
  84     List.fold_left (fun acc (d,c) -> DisambiguateTypes.Environment.add d c acc)
  85      status.aliases new_aliases in
  86    let multi_aliases =
  87     List.fold_left (fun acc (d,c) ->
  88       DisambiguateTypes.Environment.cons L.description_of_alias
  89          d c acc)
  90      status.multi_aliases new_aliases
  91    in
  92    let new_status =
  93      { status with multi_aliases = multi_aliases ; aliases = aliases}
  94    in
  95    if new_aliases = [] then
  96      new_status
  97    else
  98      let status =
  99        add_lexicon_content (commands_of_aliases new_aliases) new_status
 100      in
 101      status
 102
 103
 104 let rec eval_command ?(mode=L.WithPreferences) status cmd =
 105 (*
 106  let bmode = match mode with L.WithPreferences -> true | _ -> false in
 107  Printf.eprintf "Include preferences: %b\n" bmode;
 108 *)
 109  let cmd =
 110   match cmd with
 111   | L.Interpretation (loc, dsc, (symbol, args), cic_appl_pattern) ->
 112      let rec disambiguate =
 113       function
 114          CicNotationPt.ApplPattern l ->
 115           CicNotationPt.ApplPattern (List.map disambiguate l)
 116        | CicNotationPt.VarPattern id
 117           when not
 118            (List.exists
 119             (function (CicNotationPt.IdentArg (_,id')) -> id'=id) args)
 120           ->
 121            let item = DisambiguateTypes.Id id in
 122             begin try
 123               match DisambiguateTypes.Environment.find item status.aliases with
 124                  L.Ident_alias (_, uri) ->
 125                   (try
 126                     CicNotationPt.NRefPattern
 127                      (NReference.reference_of_string uri)
 128                    with
 129                     NReference.IllFormedReference _ ->
 130                      CicNotationPt.UriPattern (UriManager.uri_of_string uri))
 131                | _ -> assert false
 132              with Not_found ->
 133               prerr_endline ("LexiconEngine.eval_command: domain item not found: " ^
 134                (DisambiguateTypes.string_of_domain_item item));
 135               dump_aliases prerr_endline "" status;
 136               assert false
 137             end
 138        | p -> p
 139      in
 140       L.Interpretation
 141        (loc, dsc, (symbol, args), disambiguate cic_appl_pattern)
 142   | _-> cmd
 143  in
 144  let notation_ids' = CicNotation.process_notation cmd in
 145  let status =
 146    { status with notation_ids = notation_ids' @ status.notation_ids } in
 147   match cmd with
 148   | L.Include (loc, baseuri, mode, fullpath) ->
 149      let lexiconpath_rw, lexiconpath_r =
 150        LibraryMisc.lexicon_file_of_baseuri
 151          ~must_exist:false ~writable:true ~baseuri,
 152        LibraryMisc.lexicon_file_of_baseuri
 153          ~must_exist:false ~writable:false ~baseuri
 154      in
 155      let lexiconpath =
 156        if Sys.file_exists lexiconpath_rw then lexiconpath_rw else
 157          if Sys.file_exists lexiconpath_r then lexiconpath_r else
 158           raise (IncludedFileNotCompiled (lexiconpath_rw,fullpath))
 159      in
 160      let lexicon = LexiconMarshal.load_lexicon lexiconpath in
 161      let status = List.fold_left (eval_command ~mode) status lexicon in
 162      status
 163   | L.Alias (loc, spec) ->
 164      let diff =
 165       (*CSC: Warning: this code should be factorized with the corresponding
 166              code in DisambiguatePp *)
 167       match spec with
 168       | L.Ident_alias (id,uri) ->
 169          [DisambiguateTypes.Id id,spec]
 170       | L.Symbol_alias (symb, instance, desc) ->
 171          [DisambiguateTypes.Symbol (symb,instance),spec]
 172       | L.Number_alias (instance,desc) ->
 173          [DisambiguateTypes.Num instance,spec]
 174      in
 175       set_proof_aliases mode status diff
 176   | L.Interpretation (_, dsc, (symbol, _), _) as stm ->
 177       let status = add_lexicon_content [stm] status in
 178       let diff =
 179        try
 180         [DisambiguateTypes.Symbol (symbol, 0),
 181           L.Symbol_alias (symbol,0,dsc)]
 182        with
 183         DisambiguateChoices.Choice_not_found msg ->
 184           prerr_endline (Lazy.force msg);
 185           assert false
 186       in
 187       let status = set_proof_aliases mode status diff in
 188       status
 189   | L.Notation _ as stm ->
 190       add_lexicon_content [stm] status
 191
 192 let eval_command status cmd =
 193    if !debug then dump_aliases prerr_endline "before eval_command" status;
 194    let status = eval_command ?mode:None status cmd in
 195    if !debug then dump_aliases prerr_endline "after eval_command" status;
 196    status
 197
 198 let set_proof_aliases status aliases =
 199    if !debug then dump_aliases prerr_endline "before set_proof_aliases" status;
 200    let status = set_proof_aliases L.WithPreferences status aliases in
 201    if !debug then dump_aliases prerr_endline "after set_proof_aliases" status;
 202    status