src/Pure/Tools/imports.scala
author wenzelm
Sun Apr 23 15:59:51 2017 +0200 (2017-04-23)
changeset 65557 29c69a599743
parent 65542 src/Pure/Tools/update_imports.scala@6a00518bbfcc
child 65558 479406635409
permissions -rw-r--r--
clarified tool name -- more official status;
wenzelm@65557
     1
/*  Title:      Pure/Tools/imports.scala
wenzelm@65518
     2
    Author:     Makarius
wenzelm@65518
     3
wenzelm@65557
     4
Maintain theory imports wrt. session structure.
wenzelm@65518
     5
*/
wenzelm@65518
     6
wenzelm@65518
     7
package isabelle
wenzelm@65518
     8
wenzelm@65518
     9
wenzelm@65526
    10
import java.io.{File => JFile}
wenzelm@65526
    11
wenzelm@65526
    12
wenzelm@65557
    13
object Imports
wenzelm@65518
    14
{
wenzelm@65518
    15
  /* update imports */
wenzelm@65518
    16
wenzelm@65526
    17
  sealed case class Update(range: Text.Range, old_text: String, new_text: String)
wenzelm@65526
    18
  {
wenzelm@65526
    19
    def edits: List[Text.Edit] =
wenzelm@65526
    20
      Text.Edit.replace(range.start, old_text, new_text)
wenzelm@65526
    21
wenzelm@65526
    22
    override def toString: String =
wenzelm@65526
    23
      range.toString + ": " + old_text + " -> " + new_text
wenzelm@65526
    24
  }
wenzelm@65526
    25
wenzelm@65526
    26
  def update_name(keywords: Keyword.Keywords, pos: Position.T, update: String => String)
wenzelm@65526
    27
    : Option[(JFile, Update)] =
wenzelm@65526
    28
  {
wenzelm@65526
    29
    val file =
wenzelm@65526
    30
      pos match {
wenzelm@65526
    31
        case Position.File(file) => Path.explode(file).file.getCanonicalFile
wenzelm@65526
    32
        case _ => error("Missing file in position" + Position.here(pos))
wenzelm@65526
    33
      }
wenzelm@65526
    34
wenzelm@65526
    35
    val text = File.read(file)
wenzelm@65526
    36
wenzelm@65526
    37
    val range =
wenzelm@65526
    38
      pos match {
wenzelm@65526
    39
        case Position.Range(symbol_range) => Symbol.Text_Chunk(text).decode(symbol_range)
wenzelm@65526
    40
        case _ => error("Missing range in position" + Position.here(pos))
wenzelm@65526
    41
      }
wenzelm@65526
    42
wenzelm@65526
    43
    Token.read_name(keywords, range.substring(text)) match {
wenzelm@65526
    44
      case Some(tok) =>
wenzelm@65526
    45
        val s1 = tok.source
wenzelm@65526
    46
        val s2 = Token.quote_name(keywords, update(tok.content))
wenzelm@65526
    47
        if (s1 == s2) None else Some((file, Update(range, s1, s2)))
wenzelm@65526
    48
      case None => error("Name token expected" + Position.here(pos))
wenzelm@65526
    49
    }
wenzelm@65526
    50
  }
wenzelm@65526
    51
wenzelm@65518
    52
  def update_imports(
wenzelm@65518
    53
    options: Options,
wenzelm@65518
    54
    progress: Progress = No_Progress,
wenzelm@65518
    55
    selection: Sessions.Selection = Sessions.Selection.empty,
wenzelm@65518
    56
    dirs: List[Path] = Nil,
wenzelm@65518
    57
    select_dirs: List[Path] = Nil,
wenzelm@65526
    58
    verbose: Boolean = false): List[(JFile, Update)] =
wenzelm@65518
    59
  {
wenzelm@65518
    60
    val full_sessions = Sessions.load(options, dirs, select_dirs)
wenzelm@65518
    61
    val (selected, selected_sessions) = full_sessions.selection(selection)
wenzelm@65526
    62
wenzelm@65518
    63
    val deps =
wenzelm@65518
    64
      Sessions.deps(selected_sessions, progress = progress, verbose = verbose,
wenzelm@65518
    65
        global_theories = full_sessions.global_theories)
wenzelm@65518
    66
wenzelm@65526
    67
    selected.flatMap(session_name =>
wenzelm@65526
    68
    {
wenzelm@65526
    69
      val info = full_sessions(session_name)
wenzelm@65526
    70
      val session_base = deps(session_name)
wenzelm@65540
    71
      val session_resources = new Resources(session_base)
wenzelm@65540
    72
      val imports_resources = new Resources(session_base.get_imports)
wenzelm@65540
    73
wenzelm@65534
    74
      val local_theories =
wenzelm@65534
    75
        (for {
wenzelm@65534
    76
          (_, name) <- session_base.known.theories_local.iterator
wenzelm@65540
    77
          if session_resources.theory_qualifier(name) == info.theory_qualifier
wenzelm@65534
    78
        } yield name).toSet
wenzelm@65526
    79
wenzelm@65533
    80
      def standard_import(qualifier: String, dir: String, s: String): String =
wenzelm@65526
    81
      {
wenzelm@65540
    82
        val name = imports_resources.import_name(qualifier, dir, s)
wenzelm@65542
    83
        val file = Path.explode(name.node).file
wenzelm@65536
    84
        val s1 =
wenzelm@65542
    85
          imports_resources.session_base.known.get_file(file) match {
wenzelm@65542
    86
            case Some(name1) if session_resources.theory_qualifier(name1) != qualifier =>
wenzelm@65542
    87
              name1.theory
wenzelm@65542
    88
            case Some(name1) if Thy_Header.is_base_name(s) =>
wenzelm@65542
    89
              name1.theory_base_name
wenzelm@65542
    90
            case _ => s
wenzelm@65542
    91
          }
wenzelm@65542
    92
        val name2 = imports_resources.import_name(qualifier, dir, s1)
wenzelm@65542
    93
        if (name.node == name2.node) s1 else s
wenzelm@65526
    94
      }
wenzelm@65526
    95
wenzelm@65526
    96
      val updates_root =
wenzelm@65526
    97
        for {
wenzelm@65526
    98
          (_, pos) <- info.theories.flatMap(_._2)
wenzelm@65526
    99
          upd <- update_name(Sessions.root_syntax.keywords, pos,
wenzelm@65533
   100
            standard_import(info.theory_qualifier, info.dir.implode, _))
wenzelm@65526
   101
        } yield upd
wenzelm@65526
   102
wenzelm@65526
   103
      val updates_theories =
wenzelm@65526
   104
        for {
wenzelm@65526
   105
          (_, name) <- session_base.known.theories_local.toList
wenzelm@65540
   106
          (_, pos) <- session_resources.check_thy(name, Token.Pos.file(name.node)).imports
wenzelm@65526
   107
          upd <- update_name(session_base.syntax.keywords, pos,
wenzelm@65540
   108
            standard_import(session_resources.theory_qualifier(name), name.master_dir, _))
wenzelm@65526
   109
        } yield upd
wenzelm@65526
   110
wenzelm@65526
   111
      updates_root ::: updates_theories
wenzelm@65526
   112
    })
wenzelm@65526
   113
  }
wenzelm@65526
   114
wenzelm@65526
   115
  def apply_updates(updates: List[(JFile, Update)])
wenzelm@65526
   116
  {
wenzelm@65526
   117
    val file_updates = (Multi_Map.empty[JFile, Update] /: updates)(_ + _)
wenzelm@65526
   118
    val conflicts =
wenzelm@65526
   119
      file_updates.iterator_list.flatMap({ case (file, upds) =>
wenzelm@65526
   120
        Library.duplicates(upds.sortBy(_.range.start),
wenzelm@65526
   121
          (x: Update, y: Update) => x.range overlaps y.range) match
wenzelm@65526
   122
        {
wenzelm@65526
   123
          case Nil => None
wenzelm@65526
   124
          case bad => Some((file, bad))
wenzelm@65526
   125
        }
wenzelm@65526
   126
      })
wenzelm@65526
   127
    if (conflicts.nonEmpty)
wenzelm@65526
   128
      error(cat_lines(
wenzelm@65526
   129
        conflicts.map({ case (file, bad) =>
wenzelm@65526
   130
          "Conflicting updates for file " + file + bad.mkString("\n  ", "\n  ", "") })))
wenzelm@65526
   131
wenzelm@65526
   132
    for ((file, upds) <- file_updates.iterator_list) {
wenzelm@65526
   133
      val edits =
wenzelm@65526
   134
        upds.sortBy(upd => - upd.range.start).flatMap(upd =>
wenzelm@65526
   135
          Text.Edit.replace(upd.range.start, upd.old_text, upd.new_text))
wenzelm@65526
   136
      val new_text =
wenzelm@65526
   137
        (File.read(file) /: edits)({ case (text, edit) =>
wenzelm@65526
   138
          edit.edit(text, 0) match {
wenzelm@65526
   139
            case (None, text1) => text1
wenzelm@65526
   140
            case (Some(_), _) => error("Failed to apply edit " + edit + " to file " + file)
wenzelm@65526
   141
          }
wenzelm@65526
   142
        })
wenzelm@65537
   143
      File.write_backup2(Path.explode(File.standard_path(file)), new_text)
wenzelm@65526
   144
    }
wenzelm@65518
   145
  }
wenzelm@65518
   146
wenzelm@65518
   147
wenzelm@65518
   148
  /* Isabelle tool wrapper */
wenzelm@65518
   149
wenzelm@65518
   150
  val isabelle_tool =
wenzelm@65557
   151
    Isabelle_Tool("imports", "maintain theory imports wrt. session structure", args =>
wenzelm@65518
   152
    {
wenzelm@65518
   153
      var select_dirs: List[Path] = Nil
wenzelm@65518
   154
      var requirements = false
wenzelm@65518
   155
      var exclude_session_groups: List[String] = Nil
wenzelm@65518
   156
      var all_sessions = false
wenzelm@65518
   157
      var dirs: List[Path] = Nil
wenzelm@65518
   158
      var session_groups: List[String] = Nil
wenzelm@65518
   159
      var options = Options.init()
wenzelm@65518
   160
      var verbose = false
wenzelm@65518
   161
      var exclude_sessions: List[String] = Nil
wenzelm@65518
   162
wenzelm@65518
   163
      val getopts = Getopts("""
wenzelm@65557
   164
Usage: isabelle imports [OPTIONS] [SESSIONS ...]
wenzelm@65518
   165
wenzelm@65518
   166
  Options are:
wenzelm@65518
   167
    -D DIR       include session directory and select its sessions
wenzelm@65518
   168
    -R           operate on requirements of selected sessions
wenzelm@65518
   169
    -X NAME      exclude sessions from group NAME and all descendants
wenzelm@65518
   170
    -a           select all sessions
wenzelm@65518
   171
    -d DIR       include session directory
wenzelm@65518
   172
    -g NAME      select session group NAME
wenzelm@65518
   173
    -o OPTION    override Isabelle system OPTION (via NAME=VAL or NAME)
wenzelm@65518
   174
    -v           verbose
wenzelm@65518
   175
    -x NAME      exclude session NAME and all descendants
wenzelm@65518
   176
wenzelm@65557
   177
  Maintain theory imports wrt. session structure.
wenzelm@65518
   178
wenzelm@65518
   179
  Old versions of files are preserved by appending "~~".
wenzelm@65518
   180
""",
wenzelm@65518
   181
      "D:" -> (arg => select_dirs = select_dirs ::: List(Path.explode(arg))),
wenzelm@65518
   182
      "R" -> (_ => requirements = true),
wenzelm@65518
   183
      "X:" -> (arg => exclude_session_groups = exclude_session_groups ::: List(arg)),
wenzelm@65518
   184
      "a" -> (_ => all_sessions = true),
wenzelm@65518
   185
      "d:" -> (arg => dirs = dirs ::: List(Path.explode(arg))),
wenzelm@65518
   186
      "g:" -> (arg => session_groups = session_groups ::: List(arg)),
wenzelm@65518
   187
      "o:" -> (arg => options = options + arg),
wenzelm@65518
   188
      "v" -> (_ => verbose = true),
wenzelm@65518
   189
      "x:" -> (arg => exclude_sessions = exclude_sessions ::: List(arg)))
wenzelm@65518
   190
wenzelm@65518
   191
      val sessions = getopts(args)
wenzelm@65518
   192
      if (args.isEmpty) getopts.usage()
wenzelm@65518
   193
wenzelm@65518
   194
      val selection =
wenzelm@65518
   195
        Sessions.Selection(requirements, all_sessions, exclude_session_groups,
wenzelm@65518
   196
          exclude_sessions, session_groups, sessions)
wenzelm@65518
   197
wenzelm@65518
   198
      val progress = new Console_Progress(verbose = verbose)
wenzelm@65518
   199
wenzelm@65526
   200
      val updates =
wenzelm@65526
   201
        update_imports(options, progress = progress, selection = selection,
wenzelm@65526
   202
          dirs = dirs, select_dirs = select_dirs, verbose = verbose)
wenzelm@65526
   203
wenzelm@65526
   204
      apply_updates(updates)
wenzelm@65518
   205
    })
wenzelm@65518
   206
}