src/Pure/Admin/component_vampire.scala
author wenzelm
Wed, 25 Oct 2023 11:52:40 +0200
changeset 78823 893049a842b5
parent 78822 09b5113e5c9d
child 78824 e0cb5a96f5fe
permissions -rw-r--r--
removed junk;
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: 77510
diff changeset
     1
/*  Title:      Pure/Admin/component_vampire.scala
72886
ac64b753a65f build Isabelle Vampire component from repository;
wenzelm
parents:
diff changeset
     2
    Author:     Makarius
ac64b753a65f build Isabelle Vampire component from repository;
wenzelm
parents:
diff changeset
     3
74465
981e3b6b08a5 build from official downloads;
wenzelm
parents: 74464
diff changeset
     4
Build Isabelle Vampire component from official download.
72886
ac64b753a65f build Isabelle Vampire component from repository;
wenzelm
parents:
diff changeset
     5
*/
ac64b753a65f build Isabelle Vampire component from repository;
wenzelm
parents:
diff changeset
     6
ac64b753a65f build Isabelle Vampire component from repository;
wenzelm
parents:
diff changeset
     7
package isabelle
ac64b753a65f build Isabelle Vampire component from repository;
wenzelm
parents:
diff changeset
     8
ac64b753a65f build Isabelle Vampire component from repository;
wenzelm
parents:
diff changeset
     9
77566
2a99fcb283ee renamed administrative tools to build Isabelle components (unrelated to "isabelle build");
wenzelm
parents: 77510
diff changeset
    10
object Component_Vampire {
74465
981e3b6b08a5 build from official downloads;
wenzelm
parents: 74464
diff changeset
    11
  val default_download_url = "https://github.com/vprover/vampire/archive/refs/tags/v4.6.tar.gz"
72890
42d75bf8725c parallel jobs for make;
wenzelm
parents: 72889
diff changeset
    12
  val default_jobs = 1
72887
970bad477c13 clarified default name;
wenzelm
parents: 72886
diff changeset
    13
74464
c30906fbbe91 build just one vampire version;
wenzelm
parents: 74313
diff changeset
    14
  def make_component_name(version: String): String =
c30906fbbe91 build just one vampire version;
wenzelm
parents: 74313
diff changeset
    15
    "vampire-" + Library.try_unprefix("v", version).getOrElse(version)
72886
ac64b753a65f build Isabelle Vampire component from repository;
wenzelm
parents:
diff changeset
    16
ac64b753a65f build Isabelle Vampire component from repository;
wenzelm
parents:
diff changeset
    17
ac64b753a65f build Isabelle Vampire component from repository;
wenzelm
parents:
diff changeset
    18
  /* build Vampire */
ac64b753a65f build Isabelle Vampire component from repository;
wenzelm
parents:
diff changeset
    19
ac64b753a65f build Isabelle Vampire component from repository;
wenzelm
parents:
diff changeset
    20
  def build_vampire(
74465
981e3b6b08a5 build from official downloads;
wenzelm
parents: 74464
diff changeset
    21
    download_url: String = default_download_url,
72890
42d75bf8725c parallel jobs for make;
wenzelm
parents: 72889
diff changeset
    22
    jobs: Int = default_jobs,
72887
970bad477c13 clarified default name;
wenzelm
parents: 72886
diff changeset
    23
    component_name: String = "",
78822
09b5113e5c9d tuned component_vampire script for Vampire 4.8 and added new flag to force version name
desharna
parents: 77566
diff changeset
    24
    component_version: String = "",
72886
ac64b753a65f build Isabelle Vampire component from repository;
wenzelm
parents:
diff changeset
    25
    progress: Progress = new Progress,
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 74480
diff changeset
    26
    target_dir: Path = Path.current
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 74480
diff changeset
    27
  ): Unit = {
73650
9ce115baaa4f clarified signature;
wenzelm
parents: 73340
diff changeset
    28
    Isabelle_System.require_command("cmake")
72938
bc88423eb0ad more checks;
wenzelm
parents: 72891
diff changeset
    29
75394
42267c650205 tuned formatting;
wenzelm
parents: 75393
diff changeset
    30
    Isabelle_System.with_tmp_dir("build") { tmp_dir =>
74465
981e3b6b08a5 build from official downloads;
wenzelm
parents: 74464
diff changeset
    31
      /* component */
981e3b6b08a5 build from official downloads;
wenzelm
parents: 74464
diff changeset
    32
981e3b6b08a5 build from official downloads;
wenzelm
parents: 74464
diff changeset
    33
      val Archive_Name = """^.*?([^/]+)$""".r
981e3b6b08a5 build from official downloads;
wenzelm
parents: 74464
diff changeset
    34
      val Version = """^v?([0-9.]+)\.tar.gz$""".r
981e3b6b08a5 build from official downloads;
wenzelm
parents: 74464
diff changeset
    35
981e3b6b08a5 build from official downloads;
wenzelm
parents: 74464
diff changeset
    36
      val archive_name =
981e3b6b08a5 build from official downloads;
wenzelm
parents: 74464
diff changeset
    37
        download_url match {
981e3b6b08a5 build from official downloads;
wenzelm
parents: 74464
diff changeset
    38
          case Archive_Name(name) => name
981e3b6b08a5 build from official downloads;
wenzelm
parents: 74464
diff changeset
    39
          case _ => error("Failed to determine source archive name from " + quote(download_url))
981e3b6b08a5 build from official downloads;
wenzelm
parents: 74464
diff changeset
    40
        }
981e3b6b08a5 build from official downloads;
wenzelm
parents: 74464
diff changeset
    41
981e3b6b08a5 build from official downloads;
wenzelm
parents: 74464
diff changeset
    42
      val version =
78822
09b5113e5c9d tuned component_vampire script for Vampire 4.8 and added new flag to force version name
desharna
parents: 77566
diff changeset
    43
        component_version match {
09b5113e5c9d tuned component_vampire script for Vampire 4.8 and added new flag to force version name
desharna
parents: 77566
diff changeset
    44
          case "" =>
09b5113e5c9d tuned component_vampire script for Vampire 4.8 and added new flag to force version name
desharna
parents: 77566
diff changeset
    45
            archive_name match {
09b5113e5c9d tuned component_vampire script for Vampire 4.8 and added new flag to force version name
desharna
parents: 77566
diff changeset
    46
              case Version(version) => version
09b5113e5c9d tuned component_vampire script for Vampire 4.8 and added new flag to force version name
desharna
parents: 77566
diff changeset
    47
              case _ => error("Failed to determine component version from " + quote(archive_name))
09b5113e5c9d tuned component_vampire script for Vampire 4.8 and added new flag to force version name
desharna
parents: 77566
diff changeset
    48
            }
09b5113e5c9d tuned component_vampire script for Vampire 4.8 and added new flag to force version name
desharna
parents: 77566
diff changeset
    49
          case _ => component_version
74465
981e3b6b08a5 build from official downloads;
wenzelm
parents: 74464
diff changeset
    50
        }
72886
ac64b753a65f build Isabelle Vampire component from repository;
wenzelm
parents:
diff changeset
    51
74464
c30906fbbe91 build just one vampire version;
wenzelm
parents: 74313
diff changeset
    52
      val component = proper_string(component_name) getOrElse make_component_name(version)
76518
b30b8e23383c clarified signature: more explicit types;
wenzelm
parents: 75394
diff changeset
    53
      val component_dir =
76547
9fe5d8c70352 tuned signature;
wenzelm
parents: 76541
diff changeset
    54
        Components.Directory(target_dir + Path.basic(component)).create(progress = progress)
72886
ac64b753a65f build Isabelle Vampire component from repository;
wenzelm
parents:
diff changeset
    55
74465
981e3b6b08a5 build from official downloads;
wenzelm
parents: 74464
diff changeset
    56
981e3b6b08a5 build from official downloads;
wenzelm
parents: 74464
diff changeset
    57
      /* platform */
981e3b6b08a5 build from official downloads;
wenzelm
parents: 74464
diff changeset
    58
72886
ac64b753a65f build Isabelle Vampire component from repository;
wenzelm
parents:
diff changeset
    59
      val platform_name =
ac64b753a65f build Isabelle Vampire component from repository;
wenzelm
parents:
diff changeset
    60
        proper_string(Isabelle_System.getenv("ISABELLE_PLATFORM64")) getOrElse
ac64b753a65f build Isabelle Vampire component from repository;
wenzelm
parents:
diff changeset
    61
          error("No 64bit platform")
74465
981e3b6b08a5 build from official downloads;
wenzelm
parents: 74464
diff changeset
    62
76518
b30b8e23383c clarified signature: more explicit types;
wenzelm
parents: 75394
diff changeset
    63
      val platform_dir =
b30b8e23383c clarified signature: more explicit types;
wenzelm
parents: 75394
diff changeset
    64
        Isabelle_System.make_directory(component_dir.path + Path.basic(platform_name))
72886
ac64b753a65f build Isabelle Vampire component from repository;
wenzelm
parents:
diff changeset
    65
ac64b753a65f build Isabelle Vampire component from repository;
wenzelm
parents:
diff changeset
    66
74465
981e3b6b08a5 build from official downloads;
wenzelm
parents: 74464
diff changeset
    67
      /* download source */
981e3b6b08a5 build from official downloads;
wenzelm
parents: 74464
diff changeset
    68
981e3b6b08a5 build from official downloads;
wenzelm
parents: 74464
diff changeset
    69
      val archive_path = tmp_dir + Path.basic(archive_name)
981e3b6b08a5 build from official downloads;
wenzelm
parents: 74464
diff changeset
    70
      Isabelle_System.download_file(download_url, archive_path, progress = progress)
72886
ac64b753a65f build Isabelle Vampire component from repository;
wenzelm
parents:
diff changeset
    71
76540
83de6e9ae983 clarified signature: prefer Scala functions instead of shell scripts;
wenzelm
parents: 76529
diff changeset
    72
      Isabelle_System.extract(archive_path, tmp_dir)
76529
ded37aade88e clarified signature;
wenzelm
parents: 76518
diff changeset
    73
      val source_dir = File.get_dir(tmp_dir, title = download_url)
72886
ac64b753a65f build Isabelle Vampire component from repository;
wenzelm
parents:
diff changeset
    74
76541
3706b88035d2 more direct target directory;
wenzelm
parents: 76540
diff changeset
    75
      Isabelle_System.extract(archive_path, component_dir.src, strip = true)
72888
74d785882737 prefer cmake build for standard version: more portable;
wenzelm
parents: 72887
diff changeset
    76
74d785882737 prefer cmake build for standard version: more portable;
wenzelm
parents: 72887
diff changeset
    77
74464
c30906fbbe91 build just one vampire version;
wenzelm
parents: 74313
diff changeset
    78
      /* build */
72886
ac64b753a65f build Isabelle Vampire component from repository;
wenzelm
parents:
diff changeset
    79
74465
981e3b6b08a5 build from official downloads;
wenzelm
parents: 74464
diff changeset
    80
      progress.echo("Building Vampire for " + platform_name + " ...")
72888
74d785882737 prefer cmake build for standard version: more portable;
wenzelm
parents: 72887
diff changeset
    81
76529
ded37aade88e clarified signature;
wenzelm
parents: 76518
diff changeset
    82
      Isabelle_System.copy_file(source_dir + Path.explode("LICENCE"), component_dir.path)
72888
74d785882737 prefer cmake build for standard version: more portable;
wenzelm
parents: 72887
diff changeset
    83
78822
09b5113e5c9d tuned component_vampire script for Vampire 4.8 and added new flag to force version name
desharna
parents: 77566
diff changeset
    84
      val cmake_opts =
09b5113e5c9d tuned component_vampire script for Vampire 4.8 and added new flag to force version name
desharna
parents: 77566
diff changeset
    85
        "-DCMAKE_BUILD_TYPE=Release -DCMAKE_BUILD_HOL=On -DCMAKE_DISABLE_FIND_PACKAGE_Z3=ON " +
09b5113e5c9d tuned component_vampire script for Vampire 4.8 and added new flag to force version name
desharna
parents: 77566
diff changeset
    86
        (if (Platform.is_linux) "-DBUILD_SHARED_LIBS=0 " else "")
74464
c30906fbbe91 build just one vampire version;
wenzelm
parents: 74313
diff changeset
    87
      val cmake_out =
74465
981e3b6b08a5 build from official downloads;
wenzelm
parents: 74464
diff changeset
    88
        progress.bash("cmake " + cmake_opts + """-G "Unix Makefiles" .""",
77510
f5d6cd98b16a clarified signature: manage "verbose" flag via "progress";
wenzelm
parents: 76548
diff changeset
    89
          cwd = source_dir.file, echo = progress.verbose).check.out
72886
ac64b753a65f build Isabelle Vampire component from repository;
wenzelm
parents:
diff changeset
    90
74464
c30906fbbe91 build just one vampire version;
wenzelm
parents: 74313
diff changeset
    91
      val Pattern = """-- Setting binary name to '?([^\s']*)'?""".r
c30906fbbe91 build just one vampire version;
wenzelm
parents: 74313
diff changeset
    92
      val binary =
c30906fbbe91 build just one vampire version;
wenzelm
parents: 74313
diff changeset
    93
        split_lines(cmake_out).collectFirst({ case Pattern(name) => name })
c30906fbbe91 build just one vampire version;
wenzelm
parents: 74313
diff changeset
    94
          .getOrElse(error("Failed to determine binary name from cmake output:\n" + cmake_out))
72888
74d785882737 prefer cmake build for standard version: more portable;
wenzelm
parents: 72887
diff changeset
    95
77510
f5d6cd98b16a clarified signature: manage "verbose" flag via "progress";
wenzelm
parents: 76548
diff changeset
    96
      progress.bash("make -j" + jobs, cwd = source_dir.file, echo = progress.verbose).check
72888
74d785882737 prefer cmake build for standard version: more portable;
wenzelm
parents: 72887
diff changeset
    97
76529
ded37aade88e clarified signature;
wenzelm
parents: 76518
diff changeset
    98
      Isabelle_System.copy_file(source_dir + Path.basic("bin") + Path.basic(binary).platform_exe,
74464
c30906fbbe91 build just one vampire version;
wenzelm
parents: 74313
diff changeset
    99
        platform_dir + Path.basic("vampire").platform_exe)
72888
74d785882737 prefer cmake build for standard version: more portable;
wenzelm
parents: 72887
diff changeset
   100
74d785882737 prefer cmake build for standard version: more portable;
wenzelm
parents: 72887
diff changeset
   101
72886
ac64b753a65f build Isabelle Vampire component from repository;
wenzelm
parents:
diff changeset
   102
      /* settings */
ac64b753a65f build Isabelle Vampire component from repository;
wenzelm
parents:
diff changeset
   103
76548
0af64cc2eee9 tuned signature;
wenzelm
parents: 76547
diff changeset
   104
      component_dir.write_settings("""
72886
ac64b753a65f build Isabelle Vampire component from repository;
wenzelm
parents:
diff changeset
   105
VAMPIRE_HOME="$COMPONENT/$ISABELLE_PLATFORM64"
78822
09b5113e5c9d tuned component_vampire script for Vampire 4.8 and added new flag to force version name
desharna
parents: 77566
diff changeset
   106
VAMPIRE_VERSION=""" + quote(version) + """
72886
ac64b753a65f build Isabelle Vampire component from repository;
wenzelm
parents:
diff changeset
   107
ac64b753a65f build Isabelle Vampire component from repository;
wenzelm
parents:
diff changeset
   108
ISABELLE_VAMPIRE="$VAMPIRE_HOME/vampire"
ac64b753a65f build Isabelle Vampire component from repository;
wenzelm
parents:
diff changeset
   109
""")
ac64b753a65f build Isabelle Vampire component from repository;
wenzelm
parents:
diff changeset
   110
ac64b753a65f build Isabelle Vampire component from repository;
wenzelm
parents:
diff changeset
   111
ac64b753a65f build Isabelle Vampire component from repository;
wenzelm
parents:
diff changeset
   112
      /* README */
ac64b753a65f build Isabelle Vampire component from repository;
wenzelm
parents:
diff changeset
   113
76518
b30b8e23383c clarified signature: more explicit types;
wenzelm
parents: 75394
diff changeset
   114
      File.write(component_dir.README,
74465
981e3b6b08a5 build from official downloads;
wenzelm
parents: 74464
diff changeset
   115
        "This Isabelle component provides Vampire " + version + """using the
78823
893049a842b5 removed junk;
wenzelm
parents: 78822
diff changeset
   116
original sources from """ + download_url + """
72886
ac64b753a65f build Isabelle Vampire component from repository;
wenzelm
parents:
diff changeset
   117
74465
981e3b6b08a5 build from official downloads;
wenzelm
parents: 74464
diff changeset
   118
The executables have been built via "cmake . && make"
72886
ac64b753a65f build Isabelle Vampire component from repository;
wenzelm
parents:
diff changeset
   119
ac64b753a65f build Isabelle Vampire component from repository;
wenzelm
parents:
diff changeset
   120
ac64b753a65f build Isabelle Vampire component from repository;
wenzelm
parents:
diff changeset
   121
        Makarius
ac64b753a65f build Isabelle Vampire component from repository;
wenzelm
parents:
diff changeset
   122
        """ + Date.Format.date(Date.now()) + "\n")
75394
42267c650205 tuned formatting;
wenzelm
parents: 75393
diff changeset
   123
    }
72886
ac64b753a65f build Isabelle Vampire component from repository;
wenzelm
parents:
diff changeset
   124
  }
ac64b753a65f build Isabelle Vampire component from repository;
wenzelm
parents:
diff changeset
   125
ac64b753a65f build Isabelle Vampire component from repository;
wenzelm
parents:
diff changeset
   126
ac64b753a65f build Isabelle Vampire component from repository;
wenzelm
parents:
diff changeset
   127
  /* Isabelle tool wrapper */
ac64b753a65f build Isabelle Vampire component from repository;
wenzelm
parents:
diff changeset
   128
ac64b753a65f build Isabelle Vampire component from repository;
wenzelm
parents:
diff changeset
   129
  val isabelle_tool =
77566
2a99fcb283ee renamed administrative tools to build Isabelle components (unrelated to "isabelle build");
wenzelm
parents: 77510
diff changeset
   130
    Isabelle_Tool("component_vampire", "build prover component from official download",
75394
42267c650205 tuned formatting;
wenzelm
parents: 75393
diff changeset
   131
    Scala_Project.here,
42267c650205 tuned formatting;
wenzelm
parents: 75393
diff changeset
   132
    { args =>
72886
ac64b753a65f build Isabelle Vampire component from repository;
wenzelm
parents:
diff changeset
   133
      var target_dir = Path.current
74465
981e3b6b08a5 build from official downloads;
wenzelm
parents: 74464
diff changeset
   134
      var download_url = default_download_url
72890
42d75bf8725c parallel jobs for make;
wenzelm
parents: 72889
diff changeset
   135
      var jobs = default_jobs
72887
970bad477c13 clarified default name;
wenzelm
parents: 72886
diff changeset
   136
      var component_name = ""
78822
09b5113e5c9d tuned component_vampire script for Vampire 4.8 and added new flag to force version name
desharna
parents: 77566
diff changeset
   137
      var component_version = ""
72886
ac64b753a65f build Isabelle Vampire component from repository;
wenzelm
parents:
diff changeset
   138
      var verbose = false
ac64b753a65f build Isabelle Vampire component from repository;
wenzelm
parents:
diff changeset
   139
ac64b753a65f build Isabelle Vampire component from repository;
wenzelm
parents:
diff changeset
   140
      val getopts = Getopts("""
77566
2a99fcb283ee renamed administrative tools to build Isabelle components (unrelated to "isabelle build");
wenzelm
parents: 77510
diff changeset
   141
Usage: isabelle component_vampire [OPTIONS]
72886
ac64b753a65f build Isabelle Vampire component from repository;
wenzelm
parents:
diff changeset
   142
ac64b753a65f build Isabelle Vampire component from repository;
wenzelm
parents:
diff changeset
   143
  Options are:
ac64b753a65f build Isabelle Vampire component from repository;
wenzelm
parents:
diff changeset
   144
    -D DIR       target directory (default ".")
74465
981e3b6b08a5 build from official downloads;
wenzelm
parents: 74464
diff changeset
   145
    -U URL       download URL
981e3b6b08a5 build from official downloads;
wenzelm
parents: 74464
diff changeset
   146
                 (default: """" + default_download_url + """")
72890
42d75bf8725c parallel jobs for make;
wenzelm
parents: 72889
diff changeset
   147
    -j NUMBER    parallel jobs for make (default: """ + default_jobs + """)
74465
981e3b6b08a5 build from official downloads;
wenzelm
parents: 74464
diff changeset
   148
    -n NAME      component name (default: """" + make_component_name("VERSION") + """")
78822
09b5113e5c9d tuned component_vampire script for Vampire 4.8 and added new flag to force version name
desharna
parents: 77566
diff changeset
   149
    -V VERSION   component version (default: parsed from URL)
72886
ac64b753a65f build Isabelle Vampire component from repository;
wenzelm
parents:
diff changeset
   150
    -v           verbose
ac64b753a65f build Isabelle Vampire component from repository;
wenzelm
parents:
diff changeset
   151
ac64b753a65f build Isabelle Vampire component from repository;
wenzelm
parents:
diff changeset
   152
  Build prover component from official download.
ac64b753a65f build Isabelle Vampire component from repository;
wenzelm
parents:
diff changeset
   153
""",
ac64b753a65f build Isabelle Vampire component from repository;
wenzelm
parents:
diff changeset
   154
        "D:" -> (arg => target_dir = Path.explode(arg)),
74465
981e3b6b08a5 build from official downloads;
wenzelm
parents: 74464
diff changeset
   155
        "U:" -> (arg => download_url = arg),
72890
42d75bf8725c parallel jobs for make;
wenzelm
parents: 72889
diff changeset
   156
        "j:" -> (arg => jobs = Value.Nat.parse(arg)),
72886
ac64b753a65f build Isabelle Vampire component from repository;
wenzelm
parents:
diff changeset
   157
        "n:" -> (arg => component_name = arg),
78822
09b5113e5c9d tuned component_vampire script for Vampire 4.8 and added new flag to force version name
desharna
parents: 77566
diff changeset
   158
        "V:" -> (arg => component_version = arg),
72886
ac64b753a65f build Isabelle Vampire component from repository;
wenzelm
parents:
diff changeset
   159
        "v" -> (_ => verbose = true))
ac64b753a65f build Isabelle Vampire component from repository;
wenzelm
parents:
diff changeset
   160
ac64b753a65f build Isabelle Vampire component from repository;
wenzelm
parents:
diff changeset
   161
      val more_args = getopts(args)
ac64b753a65f build Isabelle Vampire component from repository;
wenzelm
parents:
diff changeset
   162
      if (more_args.nonEmpty) getopts.usage()
ac64b753a65f build Isabelle Vampire component from repository;
wenzelm
parents:
diff changeset
   163
77510
f5d6cd98b16a clarified signature: manage "verbose" flag via "progress";
wenzelm
parents: 76548
diff changeset
   164
      val progress = new Console_Progress(verbose = verbose)
72886
ac64b753a65f build Isabelle Vampire component from repository;
wenzelm
parents:
diff changeset
   165
74465
981e3b6b08a5 build from official downloads;
wenzelm
parents: 74464
diff changeset
   166
      build_vampire(download_url = download_url, component_name = component_name,
78822
09b5113e5c9d tuned component_vampire script for Vampire 4.8 and added new flag to force version name
desharna
parents: 77566
diff changeset
   167
        component_version = component_version, jobs = jobs, progress = progress,
09b5113e5c9d tuned component_vampire script for Vampire 4.8 and added new flag to force version name
desharna
parents: 77566
diff changeset
   168
        target_dir = target_dir)
72886
ac64b753a65f build Isabelle Vampire component from repository;
wenzelm
parents:
diff changeset
   169
    })
ac64b753a65f build Isabelle Vampire component from repository;
wenzelm
parents:
diff changeset
   170
}