src/Pure/Admin/component_llncs.scala
author Fabian Huch <huch@in.tum.de>
Thu, 06 Jun 2024 13:37:27 +0200
changeset 80260 ed9b1598d293
parent 77566 2a99fcb283ee
permissions -rw-r--r--
manage components of ci builds;
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
77566
2a99fcb283ee renamed administrative tools to build Isabelle components (unrelated to "isabelle build");
wenzelm
parents: 76548
diff changeset
     1
/*  Title:      Pure/Admin/component_llncs.scala
76443
8dbb0b2f6576 support for Springer LLNCS with demo document;
wenzelm
parents:
diff changeset
     2
    Author:     Makarius
8dbb0b2f6576 support for Springer LLNCS with demo document;
wenzelm
parents:
diff changeset
     3
8dbb0b2f6576 support for Springer LLNCS with demo document;
wenzelm
parents:
diff changeset
     4
Build Isabelle component for Springer LaTeX LNCS style.
8dbb0b2f6576 support for Springer LLNCS with demo document;
wenzelm
parents:
diff changeset
     5
8dbb0b2f6576 support for Springer LLNCS with demo document;
wenzelm
parents:
diff changeset
     6
See also:
8dbb0b2f6576 support for Springer LLNCS with demo document;
wenzelm
parents:
diff changeset
     7
8dbb0b2f6576 support for Springer LLNCS with demo document;
wenzelm
parents:
diff changeset
     8
  - https://ctan.org/pkg/llncs?lang=en
8dbb0b2f6576 support for Springer LLNCS with demo document;
wenzelm
parents:
diff changeset
     9
  - https://www.springer.com/gp/computer-science/lncs/conference-proceedings-guidelines
8dbb0b2f6576 support for Springer LLNCS with demo document;
wenzelm
parents:
diff changeset
    10
*/
8dbb0b2f6576 support for Springer LLNCS with demo document;
wenzelm
parents:
diff changeset
    11
8dbb0b2f6576 support for Springer LLNCS with demo document;
wenzelm
parents:
diff changeset
    12
package isabelle
8dbb0b2f6576 support for Springer LLNCS with demo document;
wenzelm
parents:
diff changeset
    13
8dbb0b2f6576 support for Springer LLNCS with demo document;
wenzelm
parents:
diff changeset
    14
77566
2a99fcb283ee renamed administrative tools to build Isabelle components (unrelated to "isabelle build");
wenzelm
parents: 76548
diff changeset
    15
object Component_LLNCS {
76443
8dbb0b2f6576 support for Springer LLNCS with demo document;
wenzelm
parents:
diff changeset
    16
  /* build llncs component */
8dbb0b2f6576 support for Springer LLNCS with demo document;
wenzelm
parents:
diff changeset
    17
8dbb0b2f6576 support for Springer LLNCS with demo document;
wenzelm
parents:
diff changeset
    18
  val default_url = "https://mirrors.ctan.org/macros/latex/contrib/llncs.zip"
8dbb0b2f6576 support for Springer LLNCS with demo document;
wenzelm
parents:
diff changeset
    19
8dbb0b2f6576 support for Springer LLNCS with demo document;
wenzelm
parents:
diff changeset
    20
  def build_llncs(
8dbb0b2f6576 support for Springer LLNCS with demo document;
wenzelm
parents:
diff changeset
    21
    download_url: String = default_url,
8dbb0b2f6576 support for Springer LLNCS with demo document;
wenzelm
parents:
diff changeset
    22
    target_dir: Path = Path.current,
8dbb0b2f6576 support for Springer LLNCS with demo document;
wenzelm
parents:
diff changeset
    23
    progress: Progress = new Progress
8dbb0b2f6576 support for Springer LLNCS with demo document;
wenzelm
parents:
diff changeset
    24
  ): Unit = {
8dbb0b2f6576 support for Springer LLNCS with demo document;
wenzelm
parents:
diff changeset
    25
    Isabelle_System.with_tmp_file("download", ext = "zip") { download_file =>
8dbb0b2f6576 support for Springer LLNCS with demo document;
wenzelm
parents:
diff changeset
    26
      Isabelle_System.with_tmp_dir("download") { download_dir =>
8dbb0b2f6576 support for Springer LLNCS with demo document;
wenzelm
parents:
diff changeset
    27
8dbb0b2f6576 support for Springer LLNCS with demo document;
wenzelm
parents:
diff changeset
    28
        /* download */
8dbb0b2f6576 support for Springer LLNCS with demo document;
wenzelm
parents:
diff changeset
    29
8dbb0b2f6576 support for Springer LLNCS with demo document;
wenzelm
parents:
diff changeset
    30
        Isabelle_System.download_file(download_url, download_file, progress = progress)
76530
2bf13b30b98e clarified signature;
wenzelm
parents: 76529
diff changeset
    31
        Isabelle_System.extract(download_file, download_dir)
76443
8dbb0b2f6576 support for Springer LLNCS with demo document;
wenzelm
parents:
diff changeset
    32
76529
ded37aade88e clarified signature;
wenzelm
parents: 76518
diff changeset
    33
        val llncs_dir = File.get_dir(download_dir, title = download_url)
76443
8dbb0b2f6576 support for Springer LLNCS with demo document;
wenzelm
parents:
diff changeset
    34
8dbb0b2f6576 support for Springer LLNCS with demo document;
wenzelm
parents:
diff changeset
    35
8dbb0b2f6576 support for Springer LLNCS with demo document;
wenzelm
parents:
diff changeset
    36
        /* component */
8dbb0b2f6576 support for Springer LLNCS with demo document;
wenzelm
parents:
diff changeset
    37
76546
88cecb9f1cdc proper unzip with strip option, within the JVM;
wenzelm
parents: 76530
diff changeset
    38
        val README_md = Path.explode("README.md")
76443
8dbb0b2f6576 support for Springer LLNCS with demo document;
wenzelm
parents:
diff changeset
    39
        val version = {
8dbb0b2f6576 support for Springer LLNCS with demo document;
wenzelm
parents:
diff changeset
    40
          val Version = """^_.* v(.*)_$""".r
76546
88cecb9f1cdc proper unzip with strip option, within the JVM;
wenzelm
parents: 76530
diff changeset
    41
          split_lines(File.read(llncs_dir + README_md))
76443
8dbb0b2f6576 support for Springer LLNCS with demo document;
wenzelm
parents:
diff changeset
    42
            .collectFirst({ case Version(v) => v })
76546
88cecb9f1cdc proper unzip with strip option, within the JVM;
wenzelm
parents: 76530
diff changeset
    43
            .getOrElse(error("Failed to detect version in " + README_md))
76443
8dbb0b2f6576 support for Springer LLNCS with demo document;
wenzelm
parents:
diff changeset
    44
        }
8dbb0b2f6576 support for Springer LLNCS with demo document;
wenzelm
parents:
diff changeset
    45
8dbb0b2f6576 support for Springer LLNCS with demo document;
wenzelm
parents:
diff changeset
    46
        val component = "llncs-" + version
76518
b30b8e23383c clarified signature: more explicit types;
wenzelm
parents: 76443
diff changeset
    47
        val component_dir =
76547
9fe5d8c70352 tuned signature;
wenzelm
parents: 76546
diff changeset
    48
          Components.Directory(target_dir + Path.basic(component)).create(progress = progress)
76443
8dbb0b2f6576 support for Springer LLNCS with demo document;
wenzelm
parents:
diff changeset
    49
76546
88cecb9f1cdc proper unzip with strip option, within the JVM;
wenzelm
parents: 76530
diff changeset
    50
        Isabelle_System.extract(download_file, component_dir.path, strip = true)
76443
8dbb0b2f6576 support for Springer LLNCS with demo document;
wenzelm
parents:
diff changeset
    51
8dbb0b2f6576 support for Springer LLNCS with demo document;
wenzelm
parents:
diff changeset
    52
8dbb0b2f6576 support for Springer LLNCS with demo document;
wenzelm
parents:
diff changeset
    53
        /* settings */
8dbb0b2f6576 support for Springer LLNCS with demo document;
wenzelm
parents:
diff changeset
    54
76548
0af64cc2eee9 tuned signature;
wenzelm
parents: 76547
diff changeset
    55
        component_dir.write_settings("""
76443
8dbb0b2f6576 support for Springer LLNCS with demo document;
wenzelm
parents:
diff changeset
    56
ISABELLE_LLNCS_HOME="$COMPONENT"
8dbb0b2f6576 support for Springer LLNCS with demo document;
wenzelm
parents:
diff changeset
    57
""")
8dbb0b2f6576 support for Springer LLNCS with demo document;
wenzelm
parents:
diff changeset
    58
8dbb0b2f6576 support for Springer LLNCS with demo document;
wenzelm
parents:
diff changeset
    59
8dbb0b2f6576 support for Springer LLNCS with demo document;
wenzelm
parents:
diff changeset
    60
        /* README */
8dbb0b2f6576 support for Springer LLNCS with demo document;
wenzelm
parents:
diff changeset
    61
76546
88cecb9f1cdc proper unzip with strip option, within the JVM;
wenzelm
parents: 76530
diff changeset
    62
        File.change(component_dir.path + README_md)(_.replace("&nbsp;", "\u00a0"))
88cecb9f1cdc proper unzip with strip option, within the JVM;
wenzelm
parents: 76530
diff changeset
    63
76518
b30b8e23383c clarified signature: more explicit types;
wenzelm
parents: 76443
diff changeset
    64
        File.write(component_dir.README,
76443
8dbb0b2f6576 support for Springer LLNCS with demo document;
wenzelm
parents:
diff changeset
    65
          """This is the Springer LaTeX LNCS style for authors from
8dbb0b2f6576 support for Springer LLNCS with demo document;
wenzelm
parents:
diff changeset
    66
""" + download_url + """
8dbb0b2f6576 support for Springer LLNCS with demo document;
wenzelm
parents:
diff changeset
    67
8dbb0b2f6576 support for Springer LLNCS with demo document;
wenzelm
parents:
diff changeset
    68
8dbb0b2f6576 support for Springer LLNCS with demo document;
wenzelm
parents:
diff changeset
    69
    Makarius
8dbb0b2f6576 support for Springer LLNCS with demo document;
wenzelm
parents:
diff changeset
    70
    """ + Date.Format.date(Date.now()) + "\n")
8dbb0b2f6576 support for Springer LLNCS with demo document;
wenzelm
parents:
diff changeset
    71
      }
8dbb0b2f6576 support for Springer LLNCS with demo document;
wenzelm
parents:
diff changeset
    72
    }
8dbb0b2f6576 support for Springer LLNCS with demo document;
wenzelm
parents:
diff changeset
    73
  }
8dbb0b2f6576 support for Springer LLNCS with demo document;
wenzelm
parents:
diff changeset
    74
8dbb0b2f6576 support for Springer LLNCS with demo document;
wenzelm
parents:
diff changeset
    75
8dbb0b2f6576 support for Springer LLNCS with demo document;
wenzelm
parents:
diff changeset
    76
  /* Isabelle tool wrapper */
8dbb0b2f6576 support for Springer LLNCS with demo document;
wenzelm
parents:
diff changeset
    77
8dbb0b2f6576 support for Springer LLNCS with demo document;
wenzelm
parents:
diff changeset
    78
  val isabelle_tool =
77566
2a99fcb283ee renamed administrative tools to build Isabelle components (unrelated to "isabelle build");
wenzelm
parents: 76548
diff changeset
    79
    Isabelle_Tool("component_llncs", "build component for Springer LaTeX LNCS style",
76443
8dbb0b2f6576 support for Springer LLNCS with demo document;
wenzelm
parents:
diff changeset
    80
      Scala_Project.here,
8dbb0b2f6576 support for Springer LLNCS with demo document;
wenzelm
parents:
diff changeset
    81
      { args =>
8dbb0b2f6576 support for Springer LLNCS with demo document;
wenzelm
parents:
diff changeset
    82
        var target_dir = Path.current
8dbb0b2f6576 support for Springer LLNCS with demo document;
wenzelm
parents:
diff changeset
    83
        var download_url = default_url
8dbb0b2f6576 support for Springer LLNCS with demo document;
wenzelm
parents:
diff changeset
    84
8dbb0b2f6576 support for Springer LLNCS with demo document;
wenzelm
parents:
diff changeset
    85
        val getopts = Getopts("""
77566
2a99fcb283ee renamed administrative tools to build Isabelle components (unrelated to "isabelle build");
wenzelm
parents: 76548
diff changeset
    86
Usage: isabelle component_llncs [OPTIONS]
76443
8dbb0b2f6576 support for Springer LLNCS with demo document;
wenzelm
parents:
diff changeset
    87
8dbb0b2f6576 support for Springer LLNCS with demo document;
wenzelm
parents:
diff changeset
    88
  Options are:
8dbb0b2f6576 support for Springer LLNCS with demo document;
wenzelm
parents:
diff changeset
    89
    -D DIR       target directory (default ".")
8dbb0b2f6576 support for Springer LLNCS with demo document;
wenzelm
parents:
diff changeset
    90
    -U URL       download URL (default: """" + default_url + """")
8dbb0b2f6576 support for Springer LLNCS with demo document;
wenzelm
parents:
diff changeset
    91
8dbb0b2f6576 support for Springer LLNCS with demo document;
wenzelm
parents:
diff changeset
    92
  Build component for Springer LaTeX LNCS style.
8dbb0b2f6576 support for Springer LLNCS with demo document;
wenzelm
parents:
diff changeset
    93
""",
8dbb0b2f6576 support for Springer LLNCS with demo document;
wenzelm
parents:
diff changeset
    94
          "D:" -> (arg => target_dir = Path.explode(arg)),
8dbb0b2f6576 support for Springer LLNCS with demo document;
wenzelm
parents:
diff changeset
    95
          "U:" -> (arg => download_url = arg))
8dbb0b2f6576 support for Springer LLNCS with demo document;
wenzelm
parents:
diff changeset
    96
8dbb0b2f6576 support for Springer LLNCS with demo document;
wenzelm
parents:
diff changeset
    97
        val more_args = getopts(args)
8dbb0b2f6576 support for Springer LLNCS with demo document;
wenzelm
parents:
diff changeset
    98
        if (more_args.nonEmpty) getopts.usage()
8dbb0b2f6576 support for Springer LLNCS with demo document;
wenzelm
parents:
diff changeset
    99
8dbb0b2f6576 support for Springer LLNCS with demo document;
wenzelm
parents:
diff changeset
   100
        val progress = new Console_Progress()
8dbb0b2f6576 support for Springer LLNCS with demo document;
wenzelm
parents:
diff changeset
   101
8dbb0b2f6576 support for Springer LLNCS with demo document;
wenzelm
parents:
diff changeset
   102
        build_llncs(download_url = download_url, target_dir = target_dir, progress = progress)
8dbb0b2f6576 support for Springer LLNCS with demo document;
wenzelm
parents:
diff changeset
   103
      })
8dbb0b2f6576 support for Springer LLNCS with demo document;
wenzelm
parents:
diff changeset
   104
}