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