src/Pure/Tools/imports.scala
author wenzelm
Sun Apr 23 16:18:31 2017 +0200 (2017-04-23)
changeset 65558 479406635409
parent 65557 29c69a599743
child 65561 741b1d3930c0
permissions -rw-r--r--
support for multiple operations via options;
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@65526
    52
  def apply_updates(updates: List[(JFile, Update)])
wenzelm@65526
    53
  {
wenzelm@65526
    54
    val file_updates = (Multi_Map.empty[JFile, Update] /: updates)(_ + _)
wenzelm@65526
    55
    val conflicts =
wenzelm@65526
    56
      file_updates.iterator_list.flatMap({ case (file, upds) =>
wenzelm@65526
    57
        Library.duplicates(upds.sortBy(_.range.start),
wenzelm@65526
    58
          (x: Update, y: Update) => x.range overlaps y.range) match
wenzelm@65526
    59
        {
wenzelm@65526
    60
          case Nil => None
wenzelm@65526
    61
          case bad => Some((file, bad))
wenzelm@65526
    62
        }
wenzelm@65526
    63
      })
wenzelm@65526
    64
    if (conflicts.nonEmpty)
wenzelm@65526
    65
      error(cat_lines(
wenzelm@65526
    66
        conflicts.map({ case (file, bad) =>
wenzelm@65526
    67
          "Conflicting updates for file " + file + bad.mkString("\n  ", "\n  ", "") })))
wenzelm@65526
    68
wenzelm@65526
    69
    for ((file, upds) <- file_updates.iterator_list) {
wenzelm@65526
    70
      val edits =
wenzelm@65526
    71
        upds.sortBy(upd => - upd.range.start).flatMap(upd =>
wenzelm@65526
    72
          Text.Edit.replace(upd.range.start, upd.old_text, upd.new_text))
wenzelm@65526
    73
      val new_text =
wenzelm@65526
    74
        (File.read(file) /: edits)({ case (text, edit) =>
wenzelm@65526
    75
          edit.edit(text, 0) match {
wenzelm@65526
    76
            case (None, text1) => text1
wenzelm@65526
    77
            case (Some(_), _) => error("Failed to apply edit " + edit + " to file " + file)
wenzelm@65526
    78
          }
wenzelm@65526
    79
        })
wenzelm@65537
    80
      File.write_backup2(Path.explode(File.standard_path(file)), new_text)
wenzelm@65526
    81
    }
wenzelm@65518
    82
  }
wenzelm@65518
    83
wenzelm@65558
    84
  def imports(
wenzelm@65558
    85
    options: Options,
wenzelm@65558
    86
    operation_update: Boolean = false,
wenzelm@65558
    87
    progress: Progress = No_Progress,
wenzelm@65558
    88
    selection: Sessions.Selection = Sessions.Selection.empty,
wenzelm@65558
    89
    dirs: List[Path] = Nil,
wenzelm@65558
    90
    select_dirs: List[Path] = Nil,
wenzelm@65558
    91
    verbose: Boolean = false) =
wenzelm@65558
    92
  {
wenzelm@65558
    93
    val full_sessions = Sessions.load(options, dirs, select_dirs)
wenzelm@65558
    94
    val (selected, selected_sessions) = full_sessions.selection(selection)
wenzelm@65558
    95
wenzelm@65558
    96
    val deps =
wenzelm@65558
    97
      Sessions.deps(selected_sessions, progress = progress, verbose = verbose,
wenzelm@65558
    98
        global_theories = full_sessions.global_theories)
wenzelm@65558
    99
wenzelm@65558
   100
    if (operation_update) {
wenzelm@65558
   101
      val updates =
wenzelm@65558
   102
        selected.flatMap(session_name =>
wenzelm@65558
   103
        {
wenzelm@65558
   104
          val info = full_sessions(session_name)
wenzelm@65558
   105
          val session_base = deps(session_name)
wenzelm@65558
   106
          val session_resources = new Resources(session_base)
wenzelm@65558
   107
          val imports_resources = new Resources(session_base.get_imports)
wenzelm@65558
   108
wenzelm@65558
   109
          val local_theories =
wenzelm@65558
   110
            (for {
wenzelm@65558
   111
              (_, name) <- session_base.known.theories_local.iterator
wenzelm@65558
   112
              if session_resources.theory_qualifier(name) == info.theory_qualifier
wenzelm@65558
   113
            } yield name).toSet
wenzelm@65558
   114
wenzelm@65558
   115
          def standard_import(qualifier: String, dir: String, s: String): String =
wenzelm@65558
   116
          {
wenzelm@65558
   117
            val name = imports_resources.import_name(qualifier, dir, s)
wenzelm@65558
   118
            val file = Path.explode(name.node).file
wenzelm@65558
   119
            val s1 =
wenzelm@65558
   120
              imports_resources.session_base.known.get_file(file) match {
wenzelm@65558
   121
                case Some(name1) if session_resources.theory_qualifier(name1) != qualifier =>
wenzelm@65558
   122
                  name1.theory
wenzelm@65558
   123
                case Some(name1) if Thy_Header.is_base_name(s) =>
wenzelm@65558
   124
                  name1.theory_base_name
wenzelm@65558
   125
                case _ => s
wenzelm@65558
   126
              }
wenzelm@65558
   127
            val name2 = imports_resources.import_name(qualifier, dir, s1)
wenzelm@65558
   128
            if (name.node == name2.node) s1 else s
wenzelm@65558
   129
          }
wenzelm@65558
   130
wenzelm@65558
   131
          val updates_root =
wenzelm@65558
   132
            for {
wenzelm@65558
   133
              (_, pos) <- info.theories.flatMap(_._2)
wenzelm@65558
   134
              upd <- update_name(Sessions.root_syntax.keywords, pos,
wenzelm@65558
   135
                standard_import(info.theory_qualifier, info.dir.implode, _))
wenzelm@65558
   136
            } yield upd
wenzelm@65558
   137
wenzelm@65558
   138
          val updates_theories =
wenzelm@65558
   139
            for {
wenzelm@65558
   140
              (_, name) <- session_base.known.theories_local.toList
wenzelm@65558
   141
              (_, pos) <- session_resources.check_thy(name, Token.Pos.file(name.node)).imports
wenzelm@65558
   142
              upd <- update_name(session_base.syntax.keywords, pos,
wenzelm@65558
   143
                standard_import(session_resources.theory_qualifier(name), name.master_dir, _))
wenzelm@65558
   144
            } yield upd
wenzelm@65558
   145
wenzelm@65558
   146
          updates_root ::: updates_theories
wenzelm@65558
   147
        })
wenzelm@65558
   148
      apply_updates(updates)
wenzelm@65558
   149
    }
wenzelm@65558
   150
  }
wenzelm@65558
   151
wenzelm@65518
   152
wenzelm@65518
   153
  /* Isabelle tool wrapper */
wenzelm@65518
   154
wenzelm@65518
   155
  val isabelle_tool =
wenzelm@65557
   156
    Isabelle_Tool("imports", "maintain theory imports wrt. session structure", args =>
wenzelm@65518
   157
    {
wenzelm@65518
   158
      var select_dirs: List[Path] = Nil
wenzelm@65518
   159
      var requirements = false
wenzelm@65558
   160
      var operation_update = false
wenzelm@65518
   161
      var exclude_session_groups: List[String] = Nil
wenzelm@65518
   162
      var all_sessions = false
wenzelm@65518
   163
      var dirs: List[Path] = Nil
wenzelm@65518
   164
      var session_groups: List[String] = Nil
wenzelm@65518
   165
      var options = Options.init()
wenzelm@65518
   166
      var verbose = false
wenzelm@65518
   167
      var exclude_sessions: List[String] = Nil
wenzelm@65518
   168
wenzelm@65518
   169
      val getopts = Getopts("""
wenzelm@65557
   170
Usage: isabelle imports [OPTIONS] [SESSIONS ...]
wenzelm@65518
   171
wenzelm@65518
   172
  Options are:
wenzelm@65518
   173
    -D DIR       include session directory and select its sessions
wenzelm@65518
   174
    -R           operate on requirements of selected sessions
wenzelm@65558
   175
    -U           operation: update theory imports to use session qualifiers
wenzelm@65518
   176
    -X NAME      exclude sessions from group NAME and all descendants
wenzelm@65518
   177
    -a           select all sessions
wenzelm@65518
   178
    -d DIR       include session directory
wenzelm@65518
   179
    -g NAME      select session group NAME
wenzelm@65518
   180
    -o OPTION    override Isabelle system OPTION (via NAME=VAL or NAME)
wenzelm@65518
   181
    -v           verbose
wenzelm@65518
   182
    -x NAME      exclude session NAME and all descendants
wenzelm@65518
   183
wenzelm@65558
   184
  Maintain theory imports wrt. session structure. At least one operation
wenzelm@65558
   185
  needs to be specified (see option -U).
wenzelm@65518
   186
""",
wenzelm@65518
   187
      "D:" -> (arg => select_dirs = select_dirs ::: List(Path.explode(arg))),
wenzelm@65518
   188
      "R" -> (_ => requirements = true),
wenzelm@65558
   189
      "U" -> (_ => operation_update = true),
wenzelm@65518
   190
      "X:" -> (arg => exclude_session_groups = exclude_session_groups ::: List(arg)),
wenzelm@65518
   191
      "a" -> (_ => all_sessions = true),
wenzelm@65518
   192
      "d:" -> (arg => dirs = dirs ::: List(Path.explode(arg))),
wenzelm@65518
   193
      "g:" -> (arg => session_groups = session_groups ::: List(arg)),
wenzelm@65518
   194
      "o:" -> (arg => options = options + arg),
wenzelm@65518
   195
      "v" -> (_ => verbose = true),
wenzelm@65518
   196
      "x:" -> (arg => exclude_sessions = exclude_sessions ::: List(arg)))
wenzelm@65518
   197
wenzelm@65518
   198
      val sessions = getopts(args)
wenzelm@65558
   199
      if (args.isEmpty || !operation_update) getopts.usage()
wenzelm@65518
   200
wenzelm@65518
   201
      val selection =
wenzelm@65518
   202
        Sessions.Selection(requirements, all_sessions, exclude_session_groups,
wenzelm@65518
   203
          exclude_sessions, session_groups, sessions)
wenzelm@65518
   204
wenzelm@65518
   205
      val progress = new Console_Progress(verbose = verbose)
wenzelm@65518
   206
wenzelm@65558
   207
      imports(options, operation_update = operation_update, progress = progress,
wenzelm@65558
   208
        selection = selection, dirs = dirs, select_dirs = select_dirs, verbose = verbose)
wenzelm@65518
   209
    })
wenzelm@65518
   210
}