src/Pure/Tools/update_header.scala
author wenzelm
Fri, 01 Apr 2022 23:19:12 +0200
changeset 75394 42267c650205
parent 75393 87ebf5a50283
child 75906 2167b9e3157a
permissions -rw-r--r--
tuned formatting;
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
58872
f0f623005324 added update_header tool;
wenzelm
parents:
diff changeset
     1
/*  Title:      Pure/Tools/update_header.scala
f0f623005324 added update_header tool;
wenzelm
parents:
diff changeset
     2
    Author:     Makarius
f0f623005324 added update_header tool;
wenzelm
parents:
diff changeset
     3
f0f623005324 added update_header tool;
wenzelm
parents:
diff changeset
     4
Replace theory header command.
f0f623005324 added update_header tool;
wenzelm
parents:
diff changeset
     5
*/
f0f623005324 added update_header tool;
wenzelm
parents:
diff changeset
     6
f0f623005324 added update_header tool;
wenzelm
parents:
diff changeset
     7
package isabelle
f0f623005324 added update_header tool;
wenzelm
parents:
diff changeset
     8
f0f623005324 added update_header tool;
wenzelm
parents:
diff changeset
     9
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 73340
diff changeset
    10
object Update_Header {
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 73340
diff changeset
    11
  def update_header(section: String, path: Path): Unit = {
58872
f0f623005324 added update_header tool;
wenzelm
parents:
diff changeset
    12
    val text0 = File.read(path)
f0f623005324 added update_header tool;
wenzelm
parents:
diff changeset
    13
    val text1 =
59083
88b0b1f28adc tuned signature;
wenzelm
parents: 58872
diff changeset
    14
      (for (tok <- Token.explode(Keyword.Keywords.empty, text0).iterator)
58872
f0f623005324 added update_header tool;
wenzelm
parents:
diff changeset
    15
        yield { if (tok.source == "header") section else tok.source }).mkString
f0f623005324 added update_header tool;
wenzelm
parents:
diff changeset
    16
f0f623005324 added update_header tool;
wenzelm
parents:
diff changeset
    17
    if (text0 != text1) {
f0f623005324 added update_header tool;
wenzelm
parents:
diff changeset
    18
      Output.writeln("changing " + path)
f0f623005324 added update_header tool;
wenzelm
parents:
diff changeset
    19
      File.write_backup2(path, text1)
f0f623005324 added update_header tool;
wenzelm
parents:
diff changeset
    20
    }
f0f623005324 added update_header tool;
wenzelm
parents:
diff changeset
    21
  }
f0f623005324 added update_header tool;
wenzelm
parents:
diff changeset
    22
f0f623005324 added update_header tool;
wenzelm
parents:
diff changeset
    23
62836
98dbed6cfa44 prefer internal tool;
wenzelm
parents: 62454
diff changeset
    24
  /* Isabelle tool wrapper */
58872
f0f623005324 added update_header tool;
wenzelm
parents:
diff changeset
    25
61463
8e46cea6a45a added 'paragraph', 'subparagraph';
wenzelm
parents: 59083
diff changeset
    26
  private val headings =
8e46cea6a45a added 'paragraph', 'subparagraph';
wenzelm
parents: 59083
diff changeset
    27
    Set("chapter", "section", "subsection", "subsubsection", "paragraph", "subparagraph")
8e46cea6a45a added 'paragraph', 'subparagraph';
wenzelm
parents: 59083
diff changeset
    28
62836
98dbed6cfa44 prefer internal tool;
wenzelm
parents: 62454
diff changeset
    29
  val isabelle_tool =
72763
3cc73d00553c added document antiquotation @{tool};
wenzelm
parents: 68994
diff changeset
    30
    Isabelle_Tool("update_header", "replace obsolete theory header command",
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 73340
diff changeset
    31
      Scala_Project.here,
75394
42267c650205 tuned formatting;
wenzelm
parents: 75393
diff changeset
    32
      { args =>
42267c650205 tuned formatting;
wenzelm
parents: 75393
diff changeset
    33
        var section = "section"
62446
5b749c31eb97 moved getopts to Scala;
wenzelm
parents: 61463
diff changeset
    34
75394
42267c650205 tuned formatting;
wenzelm
parents: 75393
diff changeset
    35
        val getopts = Getopts("""
62446
5b749c31eb97 moved getopts to Scala;
wenzelm
parents: 61463
diff changeset
    36
Usage: isabelle update_header [FILES|DIRS...]
5b749c31eb97 moved getopts to Scala;
wenzelm
parents: 61463
diff changeset
    37
5b749c31eb97 moved getopts to Scala;
wenzelm
parents: 61463
diff changeset
    38
  Options are:
5b749c31eb97 moved getopts to Scala;
wenzelm
parents: 61463
diff changeset
    39
    -s COMMAND   alternative heading command (default 'section')
5b749c31eb97 moved getopts to Scala;
wenzelm
parents: 61463
diff changeset
    40
5b749c31eb97 moved getopts to Scala;
wenzelm
parents: 61463
diff changeset
    41
  Recursively find .thy files and replace obsolete theory header commands
5b749c31eb97 moved getopts to Scala;
wenzelm
parents: 61463
diff changeset
    42
  by 'chapter', 'section' (default), 'subsection', 'subsubsection',
5b749c31eb97 moved getopts to Scala;
wenzelm
parents: 61463
diff changeset
    43
  'paragraph', 'subparagraph'.
5b749c31eb97 moved getopts to Scala;
wenzelm
parents: 61463
diff changeset
    44
5b749c31eb97 moved getopts to Scala;
wenzelm
parents: 61463
diff changeset
    45
  Old versions of files are preserved by appending "~~".
5b749c31eb97 moved getopts to Scala;
wenzelm
parents: 61463
diff changeset
    46
""",
75394
42267c650205 tuned formatting;
wenzelm
parents: 75393
diff changeset
    47
          "s:" -> (arg => section = arg))
62446
5b749c31eb97 moved getopts to Scala;
wenzelm
parents: 61463
diff changeset
    48
75394
42267c650205 tuned formatting;
wenzelm
parents: 75393
diff changeset
    49
        val specs = getopts(args)
42267c650205 tuned formatting;
wenzelm
parents: 75393
diff changeset
    50
        if (specs.isEmpty) getopts.usage()
62446
5b749c31eb97 moved getopts to Scala;
wenzelm
parents: 61463
diff changeset
    51
75394
42267c650205 tuned formatting;
wenzelm
parents: 75393
diff changeset
    52
        if (!headings.contains(section))
42267c650205 tuned formatting;
wenzelm
parents: 75393
diff changeset
    53
          error("Bad heading command: " + quote(section))
62446
5b749c31eb97 moved getopts to Scala;
wenzelm
parents: 61463
diff changeset
    54
75394
42267c650205 tuned formatting;
wenzelm
parents: 75393
diff changeset
    55
        for {
42267c650205 tuned formatting;
wenzelm
parents: 75393
diff changeset
    56
          spec <- specs
42267c650205 tuned formatting;
wenzelm
parents: 75393
diff changeset
    57
          file <- File.find_files(Path.explode(spec).file, file => file.getName.endsWith(".thy"))
42267c650205 tuned formatting;
wenzelm
parents: 75393
diff changeset
    58
        } update_header(section, File.path(file))
42267c650205 tuned formatting;
wenzelm
parents: 75393
diff changeset
    59
      })
58872
f0f623005324 added update_header tool;
wenzelm
parents:
diff changeset
    60
}