src/Pure/Tools/imports.scala
author wenzelm
Sun Apr 23 19:17:04 2017 +0200 (2017-04-23)
changeset 65564 5b3cae328a94
parent 65561 741b1d3930c0
child 65566 94c514ea2846
permissions -rw-r--r--
tuned messages;
     1 /*  Title:      Pure/Tools/imports.scala
     2     Author:     Makarius
     3 
     4 Maintain theory imports wrt. session structure.
     5 */
     6 
     7 package isabelle
     8 
     9 
    10 import java.io.{File => JFile}
    11 
    12 
    13 object Imports
    14 {
    15   /* manifest */
    16 
    17   def manifest_files(start: Path, pred: JFile => Boolean = _ => true): List[JFile] =
    18     Mercurial.find_repository(start) match {
    19       case None =>
    20         Output.warning("Ignoring directory " + start + " (no Mercurial repository)")
    21         Nil
    22       case Some(hg) =>
    23         val start_path = start.file.getCanonicalFile.toPath
    24         for {
    25           name <- hg.manifest()
    26           file = (hg.root + Path.explode(name)).file
    27           if pred(file) && file.getCanonicalFile.toPath.startsWith(start_path)
    28         } yield file
    29     }
    30 
    31 
    32   /* update imports */
    33 
    34   sealed case class Update(range: Text.Range, old_text: String, new_text: String)
    35   {
    36     def edits: List[Text.Edit] =
    37       Text.Edit.replace(range.start, old_text, new_text)
    38 
    39     override def toString: String =
    40       range.toString + ": " + old_text + " -> " + new_text
    41   }
    42 
    43   def update_name(keywords: Keyword.Keywords, pos: Position.T, update: String => String)
    44     : Option[(JFile, Update)] =
    45   {
    46     val file =
    47       pos match {
    48         case Position.File(file) => Path.explode(file).file.getCanonicalFile
    49         case _ => error("Missing file in position" + Position.here(pos))
    50       }
    51 
    52     val text = File.read(file)
    53 
    54     val range =
    55       pos match {
    56         case Position.Range(symbol_range) => Symbol.Text_Chunk(text).decode(symbol_range)
    57         case _ => error("Missing range in position" + Position.here(pos))
    58       }
    59 
    60     Token.read_name(keywords, range.substring(text)) match {
    61       case Some(tok) =>
    62         val s1 = tok.source
    63         val s2 = Token.quote_name(keywords, update(tok.content))
    64         if (s1 == s2) None else Some((file, Update(range, s1, s2)))
    65       case None => error("Name token expected" + Position.here(pos))
    66     }
    67   }
    68 
    69 
    70   /* collective operations */
    71 
    72   def imports(
    73     options: Options,
    74     operation_manifest: Boolean = false,
    75     operation_update: Boolean = false,
    76     progress: Progress = No_Progress,
    77     selection: Sessions.Selection = Sessions.Selection.empty,
    78     dirs: List[Path] = Nil,
    79     select_dirs: List[Path] = Nil,
    80     verbose: Boolean = false) =
    81   {
    82     val full_sessions = Sessions.load(options, dirs, select_dirs)
    83     val (selected, selected_sessions) = full_sessions.selection(selection)
    84 
    85     val deps =
    86       Sessions.deps(selected_sessions, progress = progress, verbose = verbose,
    87         global_theories = full_sessions.global_theories,
    88         all_known = true)
    89 
    90     if (operation_manifest) {
    91       progress.echo("\nManifest check:")
    92       val unused_files =
    93         for {
    94           (_, dir) <- Sessions.directories(dirs, select_dirs)
    95           file <- manifest_files(dir, file => file.getName.endsWith(".thy"))
    96           if deps.all_known.get_file(file).isEmpty
    97         } yield file
    98       unused_files.foreach(file => progress.echo("unused file " + quote(file.toString)))
    99     }
   100 
   101     if (operation_update) {
   102       progress.echo("\nUpdate theory imports:")
   103       val updates =
   104         selected.flatMap(session_name =>
   105         {
   106           val info = full_sessions(session_name)
   107           val session_base = deps(session_name)
   108           val session_resources = new Resources(session_base)
   109           val imports_resources = new Resources(session_base.get_imports)
   110 
   111           val local_theories =
   112             (for {
   113               (_, name) <- session_base.known.theories_local.iterator
   114               if session_resources.theory_qualifier(name) == info.theory_qualifier
   115             } yield name).toSet
   116 
   117           def standard_import(qualifier: String, dir: String, s: String): String =
   118           {
   119             val name = imports_resources.import_name(qualifier, dir, s)
   120             val file = Path.explode(name.node).file
   121             val s1 =
   122               imports_resources.session_base.known.get_file(file) match {
   123                 case Some(name1) if session_resources.theory_qualifier(name1) != qualifier =>
   124                   name1.theory
   125                 case Some(name1) if Thy_Header.is_base_name(s) =>
   126                   name1.theory_base_name
   127                 case _ => s
   128               }
   129             val name2 = imports_resources.import_name(qualifier, dir, s1)
   130             if (name.node == name2.node) s1 else s
   131           }
   132 
   133           val updates_root =
   134             for {
   135               (_, pos) <- info.theories.flatMap(_._2)
   136               upd <- update_name(Sessions.root_syntax.keywords, pos,
   137                 standard_import(info.theory_qualifier, info.dir.implode, _))
   138             } yield upd
   139 
   140           val updates_theories =
   141             for {
   142               (_, name) <- session_base.known.theories_local.toList
   143               (_, pos) <- session_resources.check_thy(name, Token.Pos.file(name.node)).imports
   144               upd <- update_name(session_base.syntax.keywords, pos,
   145                 standard_import(session_resources.theory_qualifier(name), name.master_dir, _))
   146             } yield upd
   147 
   148           updates_root ::: updates_theories
   149         })
   150 
   151       val file_updates = (Multi_Map.empty[JFile, Update] /: updates)(_ + _)
   152       val conflicts =
   153         file_updates.iterator_list.flatMap({ case (file, upds) =>
   154           Library.duplicates(upds.sortBy(_.range.start),
   155             (x: Update, y: Update) => x.range overlaps y.range) match
   156           {
   157             case Nil => None
   158             case bad => Some((file, bad))
   159           }
   160         })
   161       if (conflicts.nonEmpty)
   162         error(cat_lines(
   163           conflicts.map({ case (file, bad) =>
   164             "Conflicting updates for file " + file + bad.mkString("\n  ", "\n  ", "") })))
   165 
   166       for ((file, upds) <- file_updates.iterator_list) {
   167         progress.echo("file " + quote(file.toString))
   168         val edits =
   169           upds.sortBy(upd => - upd.range.start).flatMap(upd =>
   170             Text.Edit.replace(upd.range.start, upd.old_text, upd.new_text))
   171         val new_text =
   172           (File.read(file) /: edits)({ case (text, edit) =>
   173             edit.edit(text, 0) match {
   174               case (None, text1) => text1
   175               case (Some(_), _) => error("Failed to apply edit " + edit + " to file " + file)
   176             }
   177           })
   178         File.write_backup2(Path.explode(File.standard_path(file)), new_text)
   179       }
   180     }
   181   }
   182 
   183 
   184   /* Isabelle tool wrapper */
   185 
   186   val isabelle_tool =
   187     Isabelle_Tool("imports", "maintain theory imports wrt. session structure", args =>
   188     {
   189       var select_dirs: List[Path] = Nil
   190       var operation_manifest = false
   191       var requirements = false
   192       var operation_update = false
   193       var exclude_session_groups: List[String] = Nil
   194       var all_sessions = false
   195       var dirs: List[Path] = Nil
   196       var session_groups: List[String] = Nil
   197       var options = Options.init()
   198       var verbose = false
   199       var exclude_sessions: List[String] = Nil
   200 
   201       val getopts = Getopts("""
   202 Usage: isabelle imports [OPTIONS] [SESSIONS ...]
   203 
   204   Options are:
   205     -D DIR       include session directory and select its sessions
   206     -M           operation: Mercurial manifest check for imported theory files
   207     -R           operate on requirements of selected sessions
   208     -U           operation: update theory imports to use session qualifiers
   209     -X NAME      exclude sessions from group NAME and all descendants
   210     -a           select all sessions
   211     -d DIR       include session directory
   212     -g NAME      select session group NAME
   213     -o OPTION    override Isabelle system OPTION (via NAME=VAL or NAME)
   214     -v           verbose
   215     -x NAME      exclude session NAME and all descendants
   216 
   217   Maintain theory imports wrt. session structure. At least one operation
   218   needs to be specified (see option -U).
   219 """,
   220       "D:" -> (arg => select_dirs = select_dirs ::: List(Path.explode(arg))),
   221       "M" -> (_ => operation_manifest = true),
   222       "R" -> (_ => requirements = true),
   223       "U" -> (_ => operation_update = true),
   224       "X:" -> (arg => exclude_session_groups = exclude_session_groups ::: List(arg)),
   225       "a" -> (_ => all_sessions = true),
   226       "d:" -> (arg => dirs = dirs ::: List(Path.explode(arg))),
   227       "g:" -> (arg => session_groups = session_groups ::: List(arg)),
   228       "o:" -> (arg => options = options + arg),
   229       "v" -> (_ => verbose = true),
   230       "x:" -> (arg => exclude_sessions = exclude_sessions ::: List(arg)))
   231 
   232       val sessions = getopts(args)
   233       if (args.isEmpty || !(operation_manifest || operation_update))
   234         getopts.usage()
   235 
   236       val selection =
   237         Sessions.Selection(requirements, all_sessions, exclude_session_groups,
   238           exclude_sessions, session_groups, sessions)
   239 
   240       val progress = new Console_Progress(verbose = verbose)
   241 
   242       imports(options, operation_manifest = operation_manifest, operation_update = operation_update,
   243         progress = progress, selection = selection, dirs = dirs, select_dirs = select_dirs,
   244         verbose = verbose)
   245     })
   246 }