author | wenzelm |
Fri, 01 Apr 2022 17:06:10 +0200 | |
changeset 75393 | 87ebf5a50283 |
parent 75230 | bbbee54b1198 |
child 75394 | 42267c650205 |
permissions | -rw-r--r-- |
30175 | 1 |
/* Title: Pure/System/isabelle_system.scala |
27919 | 2 |
Author: Makarius |
3 |
||
73890 | 4 |
Miscellaneous Isabelle system operations. |
27919 | 5 |
*/ |
6 |
||
7 |
package isabelle |
|
8 |
||
55618 | 9 |
|
74146 | 10 |
import java.util.{Map => JMap, HashMap} |
67835 | 11 |
import java.io.{File => JFile, IOException} |
73317 | 12 |
import java.nio.file.{Path => JPath, Files, SimpleFileVisitor, FileVisitResult, |
13 |
StandardCopyOption, FileSystemException} |
|
56477 | 14 |
import java.nio.file.attribute.BasicFileAttributes |
27936 | 15 |
|
73987
fc363a3b690a
build.props for isabelle.jar, including isabelle.jedit;
wenzelm
parents:
73945
diff
changeset
|
16 |
import scala.jdk.CollectionConverters._ |
fc363a3b690a
build.props for isabelle.jar, including isabelle.jedit;
wenzelm
parents:
73945
diff
changeset
|
17 |
|
27919 | 18 |
|
75393 | 19 |
object Isabelle_System { |
75218 | 20 |
/* settings environment */ |
56477 | 21 |
|
75393 | 22 |
def settings(putenv: List[(String, String)] = Nil): JMap[String, String] = { |
74146 | 23 |
val env0 = isabelle.setup.Environment.settings() |
24 |
if (putenv.isEmpty) env0 |
|
25 |
else { |
|
26 |
val env = new HashMap(env0) |
|
27 |
for ((a, b) <- putenv) env.put(a, b) |
|
28 |
env |
|
29 |
} |
|
30 |
} |
|
71739 | 31 |
|
73897 | 32 |
def getenv(name: String, env: JMap[String, String] = settings()): String = |
33 |
Option(env.get(name)).getOrElse("") |
|
31498 | 34 |
|
73897 | 35 |
def getenv_strict(name: String, env: JMap[String, String] = settings()): String = |
65717 | 36 |
proper_string(getenv(name, env)) getOrElse |
37 |
error("Undefined Isabelle environment variable: " + quote(name)) |
|
27919 | 38 |
|
73520
4cba4e250c28
clarified ISABELLE_ID: distribution vs. hg archive vs. hg repos;
wenzelm
parents:
73445
diff
changeset
|
39 |
|
73891
6c9044f04756
clarified modules (again): services require full Isabelle/Scala environment;
wenzelm
parents:
73890
diff
changeset
|
40 |
/* services */ |
6c9044f04756
clarified modules (again): services require full Isabelle/Scala environment;
wenzelm
parents:
73890
diff
changeset
|
41 |
|
6c9044f04756
clarified modules (again): services require full Isabelle/Scala environment;
wenzelm
parents:
73890
diff
changeset
|
42 |
abstract class Service |
6c9044f04756
clarified modules (again): services require full Isabelle/Scala environment;
wenzelm
parents:
73890
diff
changeset
|
43 |
|
6c9044f04756
clarified modules (again): services require full Isabelle/Scala environment;
wenzelm
parents:
73890
diff
changeset
|
44 |
@volatile private var _services: Option[List[Class[Service]]] = None |
6c9044f04756
clarified modules (again): services require full Isabelle/Scala environment;
wenzelm
parents:
73890
diff
changeset
|
45 |
|
75393 | 46 |
def services(): List[Class[Service]] = { |
73891
6c9044f04756
clarified modules (again): services require full Isabelle/Scala environment;
wenzelm
parents:
73890
diff
changeset
|
47 |
if (_services.isEmpty) init() // unsynchronized check |
6c9044f04756
clarified modules (again): services require full Isabelle/Scala environment;
wenzelm
parents:
73890
diff
changeset
|
48 |
_services.get |
6c9044f04756
clarified modules (again): services require full Isabelle/Scala environment;
wenzelm
parents:
73890
diff
changeset
|
49 |
} |
6c9044f04756
clarified modules (again): services require full Isabelle/Scala environment;
wenzelm
parents:
73890
diff
changeset
|
50 |
|
6c9044f04756
clarified modules (again): services require full Isabelle/Scala environment;
wenzelm
parents:
73890
diff
changeset
|
51 |
def make_services[C](c: Class[C]): List[C] = |
6c9044f04756
clarified modules (again): services require full Isabelle/Scala environment;
wenzelm
parents:
73890
diff
changeset
|
52 |
for { c1 <- services() if Library.is_subclass(c1, c) } |
6c9044f04756
clarified modules (again): services require full Isabelle/Scala environment;
wenzelm
parents:
73890
diff
changeset
|
53 |
yield c1.getDeclaredConstructor().newInstance().asInstanceOf[C] |
6c9044f04756
clarified modules (again): services require full Isabelle/Scala environment;
wenzelm
parents:
73890
diff
changeset
|
54 |
|
6c9044f04756
clarified modules (again): services require full Isabelle/Scala environment;
wenzelm
parents:
73890
diff
changeset
|
55 |
|
6c9044f04756
clarified modules (again): services require full Isabelle/Scala environment;
wenzelm
parents:
73890
diff
changeset
|
56 |
/* init settings + services */ |
6c9044f04756
clarified modules (again): services require full Isabelle/Scala environment;
wenzelm
parents:
73890
diff
changeset
|
57 |
|
75393 | 58 |
def make_services(): List[Class[Service]] = { |
59 |
def make(where: String, names: List[String]): List[Class[Service]] = { |
|
73987
fc363a3b690a
build.props for isabelle.jar, including isabelle.jedit;
wenzelm
parents:
73945
diff
changeset
|
60 |
for (name <- names) yield { |
fc363a3b690a
build.props for isabelle.jar, including isabelle.jedit;
wenzelm
parents:
73945
diff
changeset
|
61 |
def err(msg: String): Nothing = |
fc363a3b690a
build.props for isabelle.jar, including isabelle.jedit;
wenzelm
parents:
73945
diff
changeset
|
62 |
error("Bad Isabelle/Scala service " + quote(name) + " in " + where + "\n" + msg) |
fc363a3b690a
build.props for isabelle.jar, including isabelle.jedit;
wenzelm
parents:
73945
diff
changeset
|
63 |
try { Class.forName(name).asInstanceOf[Class[Service]] } |
fc363a3b690a
build.props for isabelle.jar, including isabelle.jedit;
wenzelm
parents:
73945
diff
changeset
|
64 |
catch { |
fc363a3b690a
build.props for isabelle.jar, including isabelle.jedit;
wenzelm
parents:
73945
diff
changeset
|
65 |
case _: ClassNotFoundException => err("Class not found") |
fc363a3b690a
build.props for isabelle.jar, including isabelle.jedit;
wenzelm
parents:
73945
diff
changeset
|
66 |
case exn: Throwable => err(Exn.message(exn)) |
fc363a3b690a
build.props for isabelle.jar, including isabelle.jedit;
wenzelm
parents:
73945
diff
changeset
|
67 |
} |
fc363a3b690a
build.props for isabelle.jar, including isabelle.jedit;
wenzelm
parents:
73945
diff
changeset
|
68 |
} |
fc363a3b690a
build.props for isabelle.jar, including isabelle.jedit;
wenzelm
parents:
73945
diff
changeset
|
69 |
} |
fc363a3b690a
build.props for isabelle.jar, including isabelle.jedit;
wenzelm
parents:
73945
diff
changeset
|
70 |
|
fc363a3b690a
build.props for isabelle.jar, including isabelle.jedit;
wenzelm
parents:
73945
diff
changeset
|
71 |
def from_env(variable: String): List[Class[Service]] = |
fc363a3b690a
build.props for isabelle.jar, including isabelle.jedit;
wenzelm
parents:
73945
diff
changeset
|
72 |
make(quote(variable), space_explode(':', getenv_strict(variable))) |
fc363a3b690a
build.props for isabelle.jar, including isabelle.jedit;
wenzelm
parents:
73945
diff
changeset
|
73 |
|
fc363a3b690a
build.props for isabelle.jar, including isabelle.jedit;
wenzelm
parents:
73945
diff
changeset
|
74 |
def from_jar(platform_jar: String): List[Class[Service]] = |
fc363a3b690a
build.props for isabelle.jar, including isabelle.jedit;
wenzelm
parents:
73945
diff
changeset
|
75 |
make(quote(platform_jar), |
fc363a3b690a
build.props for isabelle.jar, including isabelle.jedit;
wenzelm
parents:
73945
diff
changeset
|
76 |
isabelle.setup.Build.get_services(JPath.of(platform_jar)).asScala.toList) |
fc363a3b690a
build.props for isabelle.jar, including isabelle.jedit;
wenzelm
parents:
73945
diff
changeset
|
77 |
|
fc363a3b690a
build.props for isabelle.jar, including isabelle.jedit;
wenzelm
parents:
73945
diff
changeset
|
78 |
from_env("ISABELLE_SCALA_SERVICES") ::: Scala.class_path().flatMap(from_jar) |
fc363a3b690a
build.props for isabelle.jar, including isabelle.jedit;
wenzelm
parents:
73945
diff
changeset
|
79 |
} |
fc363a3b690a
build.props for isabelle.jar, including isabelle.jedit;
wenzelm
parents:
73945
diff
changeset
|
80 |
|
75393 | 81 |
def init(isabelle_root: String = "", cygwin_root: String = ""): Unit = { |
73906 | 82 |
isabelle.setup.Environment.init(isabelle_root, cygwin_root) |
73987
fc363a3b690a
build.props for isabelle.jar, including isabelle.jedit;
wenzelm
parents:
73945
diff
changeset
|
83 |
synchronized { if (_services.isEmpty) { _services = Some(make_services()) } } |
73891
6c9044f04756
clarified modules (again): services require full Isabelle/Scala environment;
wenzelm
parents:
73890
diff
changeset
|
84 |
} |
6c9044f04756
clarified modules (again): services require full Isabelle/Scala environment;
wenzelm
parents:
73890
diff
changeset
|
85 |
|
6c9044f04756
clarified modules (again): services require full Isabelle/Scala environment;
wenzelm
parents:
73890
diff
changeset
|
86 |
|
73520
4cba4e250c28
clarified ISABELLE_ID: distribution vs. hg archive vs. hg repos;
wenzelm
parents:
73445
diff
changeset
|
87 |
/* getetc -- static distribution parameters */ |
4cba4e250c28
clarified ISABELLE_ID: distribution vs. hg archive vs. hg repos;
wenzelm
parents:
73445
diff
changeset
|
88 |
|
75393 | 89 |
def getetc(name: String, root: Path = Path.ISABELLE_HOME): Option[String] = { |
73520
4cba4e250c28
clarified ISABELLE_ID: distribution vs. hg archive vs. hg repos;
wenzelm
parents:
73445
diff
changeset
|
90 |
val path = root + Path.basic("etc") + Path.basic(name) |
4cba4e250c28
clarified ISABELLE_ID: distribution vs. hg archive vs. hg repos;
wenzelm
parents:
73445
diff
changeset
|
91 |
if (path.is_file) { |
4cba4e250c28
clarified ISABELLE_ID: distribution vs. hg archive vs. hg repos;
wenzelm
parents:
73445
diff
changeset
|
92 |
Library.trim_split_lines(File.read(path)) match { |
4cba4e250c28
clarified ISABELLE_ID: distribution vs. hg archive vs. hg repos;
wenzelm
parents:
73445
diff
changeset
|
93 |
case Nil => None |
4cba4e250c28
clarified ISABELLE_ID: distribution vs. hg archive vs. hg repos;
wenzelm
parents:
73445
diff
changeset
|
94 |
case List(s) => Some(s) |
4cba4e250c28
clarified ISABELLE_ID: distribution vs. hg archive vs. hg repos;
wenzelm
parents:
73445
diff
changeset
|
95 |
case _ => error("Single line expected in " + path.absolute) |
4cba4e250c28
clarified ISABELLE_ID: distribution vs. hg archive vs. hg repos;
wenzelm
parents:
73445
diff
changeset
|
96 |
} |
4cba4e250c28
clarified ISABELLE_ID: distribution vs. hg archive vs. hg repos;
wenzelm
parents:
73445
diff
changeset
|
97 |
} |
4cba4e250c28
clarified ISABELLE_ID: distribution vs. hg archive vs. hg repos;
wenzelm
parents:
73445
diff
changeset
|
98 |
else None |
4cba4e250c28
clarified ISABELLE_ID: distribution vs. hg archive vs. hg repos;
wenzelm
parents:
73445
diff
changeset
|
99 |
} |
4cba4e250c28
clarified ISABELLE_ID: distribution vs. hg archive vs. hg repos;
wenzelm
parents:
73445
diff
changeset
|
100 |
|
4cba4e250c28
clarified ISABELLE_ID: distribution vs. hg archive vs. hg repos;
wenzelm
parents:
73445
diff
changeset
|
101 |
|
73521 | 102 |
/* Isabelle distribution identification */ |
73520
4cba4e250c28
clarified ISABELLE_ID: distribution vs. hg archive vs. hg repos;
wenzelm
parents:
73445
diff
changeset
|
103 |
|
73525 | 104 |
def isabelle_id(root: Path = Path.ISABELLE_HOME): String = |
105 |
getetc("ISABELLE_ID", root = root) orElse Mercurial.archive_id(root) getOrElse { |
|
106 |
if (Mercurial.is_repository(root)) Mercurial.repository(root).parent() |
|
74268 | 107 |
else error("Failed to identify Isabelle distribution " + root.expand) |
73520
4cba4e250c28
clarified ISABELLE_ID: distribution vs. hg archive vs. hg repos;
wenzelm
parents:
73445
diff
changeset
|
108 |
} |
67865 | 109 |
|
75393 | 110 |
object Isabelle_Id extends Scala.Fun_String("isabelle_id") { |
73523
2cd23d587db9
further clarification of Isabelle distribution identification -- avoid odd patching of sources;
wenzelm
parents:
73522
diff
changeset
|
111 |
val here = Scala_Project.here |
73525 | 112 |
def apply(arg: String): String = isabelle_id() |
73523
2cd23d587db9
further clarification of Isabelle distribution identification -- avoid odd patching of sources;
wenzelm
parents:
73522
diff
changeset
|
113 |
} |
2cd23d587db9
further clarification of Isabelle distribution identification -- avoid odd patching of sources;
wenzelm
parents:
73522
diff
changeset
|
114 |
|
73522 | 115 |
def isabelle_tags(root: Path = Path.ISABELLE_HOME): String = |
73521 | 116 |
getetc("ISABELLE_TAGS", root = root) orElse Mercurial.archive_tags(root) getOrElse { |
117 |
if (Mercurial.is_repository(root)) { |
|
118 |
val hg = Mercurial.repository(root) |
|
119 |
hg.tags(rev = hg.parent()) |
|
120 |
} |
|
121 |
else "" |
|
122 |
} |
|
31796 | 123 |
|
75218 | 124 |
def export_isabelle_identifier(isabelle_identifier: String): String = |
125 |
if (isabelle_identifier == "") "" |
|
126 |
else "export ISABELLE_IDENTIFIER=" + Bash.string(isabelle_identifier) + "\n" |
|
127 |
||
73523
2cd23d587db9
further clarification of Isabelle distribution identification -- avoid odd patching of sources;
wenzelm
parents:
73522
diff
changeset
|
128 |
def isabelle_identifier(): Option[String] = proper_string(getenv("ISABELLE_IDENTIFIER")) |
2cd23d587db9
further clarification of Isabelle distribution identification -- avoid odd patching of sources;
wenzelm
parents:
73522
diff
changeset
|
129 |
|
2cd23d587db9
further clarification of Isabelle distribution identification -- avoid odd patching of sources;
wenzelm
parents:
73522
diff
changeset
|
130 |
def isabelle_heading(): String = |
2cd23d587db9
further clarification of Isabelle distribution identification -- avoid odd patching of sources;
wenzelm
parents:
73522
diff
changeset
|
131 |
isabelle_identifier() match { |
2cd23d587db9
further clarification of Isabelle distribution identification -- avoid odd patching of sources;
wenzelm
parents:
73522
diff
changeset
|
132 |
case None => "" |
2cd23d587db9
further clarification of Isabelle distribution identification -- avoid odd patching of sources;
wenzelm
parents:
73522
diff
changeset
|
133 |
case Some(version) => " (" + version + ")" |
2cd23d587db9
further clarification of Isabelle distribution identification -- avoid odd patching of sources;
wenzelm
parents:
73522
diff
changeset
|
134 |
} |
2cd23d587db9
further clarification of Isabelle distribution identification -- avoid odd patching of sources;
wenzelm
parents:
73522
diff
changeset
|
135 |
|
2cd23d587db9
further clarification of Isabelle distribution identification -- avoid odd patching of sources;
wenzelm
parents:
73522
diff
changeset
|
136 |
def isabelle_name(): String = getenv_strict("ISABELLE_NAME") |
2cd23d587db9
further clarification of Isabelle distribution identification -- avoid odd patching of sources;
wenzelm
parents:
73522
diff
changeset
|
137 |
|
74336
7bb0ac635397
permissive identification, e.g. relevant for HOL-SPARK examples running on rsync-clone;
wenzelm
parents:
74268
diff
changeset
|
138 |
def identification(): String = |
7bb0ac635397
permissive identification, e.g. relevant for HOL-SPARK examples running on rsync-clone;
wenzelm
parents:
74268
diff
changeset
|
139 |
"Isabelle" + (try { "/" + isabelle_id () } catch { case ERROR(_) => "" }) + isabelle_heading() |
73547 | 140 |
|
54039 | 141 |
|
43606 | 142 |
/** file-system operations **/ |
31796 | 143 |
|
73322 | 144 |
/* scala functions */ |
145 |
||
75393 | 146 |
private def apply_paths(args: List[String], fun: List[Path] => Unit): List[String] = { |
147 |
fun(args.map(Path.explode)) |
|
148 |
Nil |
|
149 |
} |
|
73322 | 150 |
|
73567 | 151 |
private def apply_paths1(args: List[String], fun: Path => Unit): List[String] = |
152 |
apply_paths(args, { case List(path) => fun(path) }) |
|
73322 | 153 |
|
73567 | 154 |
private def apply_paths2(args: List[String], fun: (Path, Path) => Unit): List[String] = |
155 |
apply_paths(args, { case List(path1, path2) => fun(path1, path2) }) |
|
73322 | 156 |
|
73567 | 157 |
private def apply_paths3(args: List[String], fun: (Path, Path, Path) => Unit): List[String] = |
158 |
apply_paths(args, { case List(path1, path2, path3) => fun(path1, path2, path3) }) |
|
73322 | 159 |
|
160 |
||
71114 | 161 |
/* permissions */ |
162 |
||
163 |
def chmod(arg: String, path: Path): Unit = |
|
71123 | 164 |
bash("chmod " + arg + " " + File.bash_path(path)).check |
71114 | 165 |
|
166 |
def chown(arg: String, path: Path): Unit = |
|
71123 | 167 |
bash("chown " + arg + " " + File.bash_path(path)).check |
71114 | 168 |
|
169 |
||
64189 | 170 |
/* directories */ |
50893
d55eb82ae77b
Isabelle_System.mkdirs with explicit error checking (in accordance to ML version), e.g. relevant with read-only DMG file-system on Mac OS X;
wenzelm
parents:
50854
diff
changeset
|
171 |
|
75393 | 172 |
def make_directory(path: Path): Path = { |
73325
a89f56ab2686
more robust (amending 87403fde8cc3): notably allow symlink to existing directory, which Files.createDirectories does not accept;
wenzelm
parents:
73324
diff
changeset
|
173 |
if (!path.is_dir) { |
73945 | 174 |
try { Files.createDirectories(path.java_path) } |
73325
a89f56ab2686
more robust (amending 87403fde8cc3): notably allow symlink to existing directory, which Files.createDirectories does not accept;
wenzelm
parents:
73324
diff
changeset
|
175 |
catch { case ERROR(_) => error("Failed to create directory: " + path.absolute) } |
a89f56ab2686
more robust (amending 87403fde8cc3): notably allow symlink to existing directory, which Files.createDirectories does not accept;
wenzelm
parents:
73324
diff
changeset
|
176 |
} |
72376 | 177 |
path |
178 |
} |
|
50893
d55eb82ae77b
Isabelle_System.mkdirs with explicit error checking (in accordance to ML version), e.g. relevant with read-only DMG file-system on Mac OS X;
wenzelm
parents:
50854
diff
changeset
|
179 |
|
72377 | 180 |
def new_directory(path: Path): Path = |
72426
f5d60c12deeb
more standard path output (despite platform_path from d55eb82ae77b);
wenzelm
parents:
72414
diff
changeset
|
181 |
if (path.is_dir) error("Directory already exists: " + path.absolute) |
72377 | 182 |
else make_directory(path) |
183 |
||
75393 | 184 |
def copy_dir(dir1: Path, dir2: Path): Unit = { |
73322 | 185 |
val res = bash("cp -a " + File.bash_path(dir1) + " " + File.bash_path(dir2)) |
186 |
if (!res.ok) { |
|
187 |
cat_error("Failed to copy directory " + dir1.absolute + " to " + dir2.absolute, res.err) |
|
188 |
} |
|
189 |
} |
|
73317 | 190 |
|
75393 | 191 |
def with_copy_dir[A](dir1: Path, dir2: Path)(body: => A): A = { |
75230
bbbee54b1198
prepare patched version more thoroughly, with explicit patches;
wenzelm
parents:
75229
diff
changeset
|
192 |
if (dir2.is_file || dir2.is_dir) error("Directory already exists: " + dir2.absolute) |
bbbee54b1198
prepare patched version more thoroughly, with explicit patches;
wenzelm
parents:
75229
diff
changeset
|
193 |
else { |
bbbee54b1198
prepare patched version more thoroughly, with explicit patches;
wenzelm
parents:
75229
diff
changeset
|
194 |
try { copy_dir(dir1, dir2); body } |
bbbee54b1198
prepare patched version more thoroughly, with explicit patches;
wenzelm
parents:
75229
diff
changeset
|
195 |
finally { rm_tree(dir2 ) } |
bbbee54b1198
prepare patched version more thoroughly, with explicit patches;
wenzelm
parents:
75229
diff
changeset
|
196 |
} |
bbbee54b1198
prepare patched version more thoroughly, with explicit patches;
wenzelm
parents:
75229
diff
changeset
|
197 |
} |
bbbee54b1198
prepare patched version more thoroughly, with explicit patches;
wenzelm
parents:
75229
diff
changeset
|
198 |
|
73317 | 199 |
|
75393 | 200 |
object Make_Directory extends Scala.Fun_Strings("make_directory") { |
73322 | 201 |
val here = Scala_Project.here |
73567 | 202 |
def apply(args: List[String]): List[String] = apply_paths1(args, make_directory) |
73322 | 203 |
} |
73317 | 204 |
|
75393 | 205 |
object Copy_Dir extends Scala.Fun_Strings("copy_dir") { |
73322 | 206 |
val here = Scala_Project.here |
73567 | 207 |
def apply(args: List[String]): List[String] = apply_paths2(args, copy_dir) |
73322 | 208 |
} |
209 |
||
210 |
||
211 |
/* copy files */ |
|
64189 | 212 |
|
75393 | 213 |
def copy_file(src: JFile, dst: JFile): Unit = { |
73317 | 214 |
val target = if (dst.isDirectory) new JFile(dst, src.getName) else dst |
73319 | 215 |
if (!File.eq(src, target)) { |
73322 | 216 |
try { |
217 |
Files.copy(src.toPath, target.toPath, |
|
218 |
StandardCopyOption.COPY_ATTRIBUTES, |
|
219 |
StandardCopyOption.REPLACE_EXISTING) |
|
220 |
} |
|
221 |
catch { |
|
222 |
case ERROR(msg) => |
|
73651 | 223 |
cat_error("Failed to copy file " + |
73322 | 224 |
File.path(src).absolute + " to " + File.path(dst).absolute, msg) |
225 |
} |
|
73317 | 226 |
} |
227 |
} |
|
228 |
||
73320 | 229 |
def copy_file(src: Path, dst: Path): Unit = copy_file(src.file, dst.file) |
73317 | 230 |
|
75393 | 231 |
def copy_file_base(base_dir: Path, src: Path, target_dir: Path): Unit = { |
73320 | 232 |
val src1 = src.expand |
233 |
val src1_dir = src1.dir |
|
73321 | 234 |
if (!src1.starts_basic) error("Illegal path specification " + src1 + " beyond base directory") |
73320 | 235 |
copy_file(base_dir + src1, Isabelle_System.make_directory(target_dir + src1_dir)) |
73317 | 236 |
} |
237 |
||
238 |
||
75393 | 239 |
object Copy_File extends Scala.Fun_Strings("copy_file") { |
73322 | 240 |
val here = Scala_Project.here |
73567 | 241 |
def apply(args: List[String]): List[String] = apply_paths2(args, copy_file) |
73322 | 242 |
} |
243 |
||
75393 | 244 |
object Copy_File_Base extends Scala.Fun_Strings("copy_file_base") { |
73322 | 245 |
val here = Scala_Project.here |
73567 | 246 |
def apply(args: List[String]): List[String] = apply_paths3(args, copy_file_base) |
73322 | 247 |
} |
248 |
||
249 |
||
250 |
/* move files */ |
|
73317 | 251 |
|
75393 | 252 |
def move_file(src: JFile, dst: JFile): Unit = { |
73317 | 253 |
val target = if (dst.isDirectory) new JFile(dst, src.getName) else dst |
73319 | 254 |
if (!File.eq(src, target)) |
73317 | 255 |
Files.move(src.toPath, target.toPath, StandardCopyOption.REPLACE_EXISTING) |
256 |
} |
|
257 |
||
73320 | 258 |
def move_file(src: Path, dst: Path): Unit = move_file(src.file, dst.file) |
73317 | 259 |
|
260 |
||
261 |
/* symbolic link */ |
|
262 |
||
75393 | 263 |
def symlink(src: Path, dst: Path, force: Boolean = false, native: Boolean = false): Unit = { |
73317 | 264 |
val src_file = src.file |
265 |
val dst_file = dst.file |
|
266 |
val target = if (dst_file.isDirectory) new JFile(dst_file, src_file.getName) else dst_file |
|
267 |
||
268 |
if (force) target.delete |
|
269 |
||
75393 | 270 |
def cygwin_link(): Unit = { |
74070 | 271 |
if (native) { |
272 |
error("Failed to create native symlink on Windows: " + quote(src_file.toString) + |
|
273 |
"\n(but it could work as Administrator)") |
|
274 |
} |
|
275 |
else isabelle.setup.Environment.cygwin_link(File.standard_path(src), target) |
|
276 |
} |
|
277 |
||
73893 | 278 |
|
73317 | 279 |
try { Files.createSymbolicLink(target.toPath, src_file.toPath) } |
280 |
catch { |
|
73893 | 281 |
case _: UnsupportedOperationException if Platform.is_windows => cygwin_link() |
282 |
case _: FileSystemException if Platform.is_windows => cygwin_link() |
|
73317 | 283 |
} |
284 |
} |
|
285 |
||
50893
d55eb82ae77b
Isabelle_System.mkdirs with explicit error checking (in accordance to ML version), e.g. relevant with read-only DMG file-system on Mac OS X;
wenzelm
parents:
50854
diff
changeset
|
286 |
|
56428
1acf2d76ac23
more standard Isabelle_System.tmp_file and tmp_dir operations, in accordance to ML version;
wenzelm
parents:
55876
diff
changeset
|
287 |
/* tmp files */ |
1acf2d76ac23
more standard Isabelle_System.tmp_file and tmp_dir operations, in accordance to ML version;
wenzelm
parents:
55876
diff
changeset
|
288 |
|
75393 | 289 |
def isabelle_tmp_prefix(): JFile = { |
56428
1acf2d76ac23
more standard Isabelle_System.tmp_file and tmp_dir operations, in accordance to ML version;
wenzelm
parents:
55876
diff
changeset
|
290 |
val path = Path.explode("$ISABELLE_TMP_PREFIX") |
72375 | 291 |
path.file.mkdirs // low-level mkdirs to avoid recursion via Isabelle environment |
60988 | 292 |
File.platform_file(path) |
56428
1acf2d76ac23
more standard Isabelle_System.tmp_file and tmp_dir operations, in accordance to ML version;
wenzelm
parents:
55876
diff
changeset
|
293 |
} |
1acf2d76ac23
more standard Isabelle_System.tmp_file and tmp_dir operations, in accordance to ML version;
wenzelm
parents:
55876
diff
changeset
|
294 |
|
75393 | 295 |
def tmp_file(name: String, ext: String = "", base_dir: JFile = isabelle_tmp_prefix()): JFile = { |
56428
1acf2d76ac23
more standard Isabelle_System.tmp_file and tmp_dir operations, in accordance to ML version;
wenzelm
parents:
55876
diff
changeset
|
296 |
val suffix = if (ext == "") "" else "." + ext |
67924 | 297 |
val file = Files.createTempFile(base_dir.toPath, name, suffix).toFile |
75219 | 298 |
file.deleteOnExit() |
56428
1acf2d76ac23
more standard Isabelle_System.tmp_file and tmp_dir operations, in accordance to ML version;
wenzelm
parents:
55876
diff
changeset
|
299 |
file |
1acf2d76ac23
more standard Isabelle_System.tmp_file and tmp_dir operations, in accordance to ML version;
wenzelm
parents:
55876
diff
changeset
|
300 |
} |
1acf2d76ac23
more standard Isabelle_System.tmp_file and tmp_dir operations, in accordance to ML version;
wenzelm
parents:
55876
diff
changeset
|
301 |
|
75393 | 302 |
def with_tmp_file[A](name: String, ext: String = "")(body: Path => A): A = { |
56428
1acf2d76ac23
more standard Isabelle_System.tmp_file and tmp_dir operations, in accordance to ML version;
wenzelm
parents:
55876
diff
changeset
|
303 |
val file = tmp_file(name, ext) |
64220 | 304 |
try { body(File.path(file)) } finally { file.delete } |
56428
1acf2d76ac23
more standard Isabelle_System.tmp_file and tmp_dir operations, in accordance to ML version;
wenzelm
parents:
55876
diff
changeset
|
305 |
} |
1acf2d76ac23
more standard Isabelle_System.tmp_file and tmp_dir operations, in accordance to ML version;
wenzelm
parents:
55876
diff
changeset
|
306 |
|
1acf2d76ac23
more standard Isabelle_System.tmp_file and tmp_dir operations, in accordance to ML version;
wenzelm
parents:
55876
diff
changeset
|
307 |
|
56477 | 308 |
/* tmp dirs */ |
309 |
||
75393 | 310 |
def rm_tree(root: JFile): Unit = { |
56477 | 311 |
root.delete |
312 |
if (root.isDirectory) { |
|
313 |
Files.walkFileTree(root.toPath, |
|
314 |
new SimpleFileVisitor[JPath] { |
|
75393 | 315 |
override def visitFile(file: JPath, attrs: BasicFileAttributes): FileVisitResult = { |
68991
6c1beb52d766
more robust: avoid race condition wrt. cleanup of ML process, e.g. relevant for "$ISABELLE_TMP/rat.ML" in theory Codegen.Further;
wenzelm
parents:
68409
diff
changeset
|
316 |
try { Files.deleteIfExists(file) } |
6c1beb52d766
more robust: avoid race condition wrt. cleanup of ML process, e.g. relevant for "$ISABELLE_TMP/rat.ML" in theory Codegen.Further;
wenzelm
parents:
68409
diff
changeset
|
317 |
catch { case _: IOException => } |
56477 | 318 |
FileVisitResult.CONTINUE |
319 |
} |
|
320 |
||
75393 | 321 |
override def postVisitDirectory(dir: JPath, e: IOException): FileVisitResult = { |
56477 | 322 |
if (e == null) { |
68991
6c1beb52d766
more robust: avoid race condition wrt. cleanup of ML process, e.g. relevant for "$ISABELLE_TMP/rat.ML" in theory Codegen.Further;
wenzelm
parents:
68409
diff
changeset
|
323 |
try { Files.deleteIfExists(dir) } |
6c1beb52d766
more robust: avoid race condition wrt. cleanup of ML process, e.g. relevant for "$ISABELLE_TMP/rat.ML" in theory Codegen.Further;
wenzelm
parents:
68409
diff
changeset
|
324 |
catch { case _: IOException => } |
56477 | 325 |
FileVisitResult.CONTINUE |
326 |
} |
|
327 |
else throw e |
|
328 |
} |
|
329 |
} |
|
330 |
) |
|
331 |
} |
|
332 |
} |
|
333 |
||
73324 | 334 |
def rm_tree(root: Path): Unit = rm_tree(root.file) |
335 |
||
75393 | 336 |
object Rm_Tree extends Scala.Fun_Strings("rm_tree") { |
73324 | 337 |
val here = Scala_Project.here |
73567 | 338 |
def apply(args: List[String]): List[String] = apply_paths1(args, rm_tree) |
73324 | 339 |
} |
340 |
||
75393 | 341 |
def tmp_dir(name: String, base_dir: JFile = isabelle_tmp_prefix()): JFile = { |
67924 | 342 |
val dir = Files.createTempDirectory(base_dir.toPath, name).toFile |
75219 | 343 |
dir.deleteOnExit() |
56477 | 344 |
dir |
345 |
} |
|
346 |
||
75393 | 347 |
def with_tmp_dir[A](name: String)(body: Path => A): A = { |
56477 | 348 |
val dir = tmp_dir(name) |
64220 | 349 |
try { body(File.path(dir)) } finally { rm_tree(dir) } |
56477 | 350 |
} |
351 |
||
352 |
||
65793 | 353 |
/* quasi-atomic update of directory */ |
354 |
||
75393 | 355 |
def update_directory(dir: Path, f: Path => Unit): Unit = { |
65793 | 356 |
val new_dir = dir.ext("new") |
357 |
val old_dir = dir.ext("old") |
|
358 |
||
359 |
rm_tree(new_dir) |
|
360 |
rm_tree(old_dir) |
|
361 |
||
362 |
f(new_dir) |
|
363 |
||
73317 | 364 |
if (dir.is_dir) move_file(dir, old_dir) |
365 |
move_file(new_dir, dir) |
|
65793 | 366 |
rm_tree(old_dir) |
367 |
} |
|
368 |
||
369 |
||
62613 | 370 |
|
371 |
/** external processes **/ |
|
372 |
||
373 |
/* GNU bash */ |
|
31796 | 374 |
|
62610
4c89504c76fb
more uniform signature for various process invocations;
wenzelm
parents:
62602
diff
changeset
|
375 |
def bash(script: String, |
74212 | 376 |
description: String = "", |
62610
4c89504c76fb
more uniform signature for various process invocations;
wenzelm
parents:
62602
diff
changeset
|
377 |
cwd: JFile = null, |
73897 | 378 |
env: JMap[String, String] = settings(), |
62610
4c89504c76fb
more uniform signature for various process invocations;
wenzelm
parents:
62602
diff
changeset
|
379 |
redirect: Boolean = false, |
74142
0f051404f487
clarified signature: more options for bash_process;
wenzelm
parents:
74070
diff
changeset
|
380 |
input: String = "", |
51962
016cb7d8f297
limit build process output, to avoid bombing Isabelle/Scala process by ill-behaved jobs (e.g. Containers in AFP/9025435b29cf);
wenzelm
parents:
51820
diff
changeset
|
381 |
progress_stdout: String => Unit = (_: String) => (), |
016cb7d8f297
limit build process output, to avoid bombing Isabelle/Scala process by ill-behaved jobs (e.g. Containers in AFP/9025435b29cf);
wenzelm
parents:
51820
diff
changeset
|
382 |
progress_stderr: String => Unit = (_: String) => (), |
72598 | 383 |
watchdog: Option[Bash.Watchdog] = None, |
62602 | 384 |
strict: Boolean = true, |
75393 | 385 |
cleanup: () => Unit = () => () |
386 |
): Process_Result = { |
|
74212 | 387 |
Bash.process(script, |
388 |
description = description, cwd = cwd, env = env, redirect = redirect, cleanup = cleanup). |
|
74142
0f051404f487
clarified signature: more options for bash_process;
wenzelm
parents:
74070
diff
changeset
|
389 |
result(input = input, progress_stdout = progress_stdout, progress_stderr = progress_stderr, |
72598 | 390 |
watchdog = watchdog, strict = strict) |
34198
ff5486262cd6
moved Library.decode_permissive_utf8 to Isabelle_System;
wenzelm
parents:
34196
diff
changeset
|
391 |
} |
ff5486262cd6
moved Library.decode_permissive_utf8 to Isabelle_System;
wenzelm
parents:
34196
diff
changeset
|
392 |
|
75218 | 393 |
|
394 |
/* command-line tools */ |
|
395 |
||
75393 | 396 |
def require_command(cmd: String, test: String = "--version"): Unit = { |
75218 | 397 |
if (!bash(Bash.string(cmd) + " " + test).ok) error("Missing system command: " + quote(cmd)) |
398 |
} |
|
399 |
||
64935
9437a117408b
insist in proper GNU tar, to avoid subtle semantic differences;
wenzelm
parents:
64657
diff
changeset
|
400 |
private lazy val gnutar_check: Boolean = |
9437a117408b
insist in proper GNU tar, to avoid subtle semantic differences;
wenzelm
parents:
64657
diff
changeset
|
401 |
try { bash("tar --version").check.out.containsSlice("GNU tar") || error("") } |
9437a117408b
insist in proper GNU tar, to avoid subtle semantic differences;
wenzelm
parents:
64657
diff
changeset
|
402 |
catch { case ERROR(_) => false } |
9437a117408b
insist in proper GNU tar, to avoid subtle semantic differences;
wenzelm
parents:
64657
diff
changeset
|
403 |
|
69425 | 404 |
def gnutar( |
405 |
args: String, |
|
406 |
dir: Path = Path.current, |
|
407 |
original_owner: Boolean = false, |
|
73624 | 408 |
strip: Int = 0, |
75393 | 409 |
redirect: Boolean = false |
410 |
): Process_Result = { |
|
69425 | 411 |
val options = |
412 |
(if (dir.is_current) "" else "-C " + File.bash_path(dir) + " ") + |
|
73624 | 413 |
(if (original_owner) "" else "--owner=root --group=staff ") + |
414 |
(if (strip <= 0) "" else "--strip-components=" + strip + " ") |
|
69425 | 415 |
|
416 |
if (gnutar_check) bash("tar " + options + args, redirect = redirect) |
|
64935
9437a117408b
insist in proper GNU tar, to avoid subtle semantic differences;
wenzelm
parents:
64657
diff
changeset
|
417 |
else error("Expected to find GNU tar executable") |
9437a117408b
insist in proper GNU tar, to avoid subtle semantic differences;
wenzelm
parents:
64657
diff
changeset
|
418 |
} |
9437a117408b
insist in proper GNU tar, to avoid subtle semantic differences;
wenzelm
parents:
64657
diff
changeset
|
419 |
|
75393 | 420 |
def make_patch(base_dir: Path, src: Path, dst: Path, diff_options: String = ""): String = { |
421 |
with_tmp_file("patch")(patch => { |
|
75229 | 422 |
Isabelle_System.bash( |
75230
bbbee54b1198
prepare patched version more thoroughly, with explicit patches;
wenzelm
parents:
75229
diff
changeset
|
423 |
"diff -ru " + diff_options + " -- " + File.bash_path(src) + " " + File.bash_path(dst) + |
bbbee54b1198
prepare patched version more thoroughly, with explicit patches;
wenzelm
parents:
75229
diff
changeset
|
424 |
" > " + File.bash_path(patch), |
75229 | 425 |
cwd = base_dir.file).check_rc(_ <= 1) |
426 |
File.read(patch) |
|
427 |
}) |
|
75220 | 428 |
} |
429 |
||
64152 | 430 |
def hostname(): String = bash("hostname -s").check.out |
64139 | 431 |
|
54690 | 432 |
def open(arg: String): Unit = |
64304 | 433 |
bash("exec \"$ISABELLE_OPEN\" " + Bash.string(arg) + " >/dev/null 2>/dev/null &") |
54690 | 434 |
|
435 |
def pdf_viewer(arg: Path): Unit = |
|
62616 | 436 |
bash("exec \"$PDF_VIEWER\" " + File.bash_path(arg) + " >/dev/null 2>/dev/null &") |
54690 | 437 |
|
75393 | 438 |
def open_external_file(name: String): Boolean = { |
73224
49686e3b1909
clarified links to external files, e.g. .pdf within .thy source document;
wenzelm
parents:
72976
diff
changeset
|
439 |
val ext = Library.take_suffix((c: Char) => c != '.', name.toList)._2.mkString |
49686e3b1909
clarified links to external files, e.g. .pdf within .thy source document;
wenzelm
parents:
72976
diff
changeset
|
440 |
val external = |
49686e3b1909
clarified links to external files, e.g. .pdf within .thy source document;
wenzelm
parents:
72976
diff
changeset
|
441 |
ext.nonEmpty && |
49686e3b1909
clarified links to external files, e.g. .pdf within .thy source document;
wenzelm
parents:
72976
diff
changeset
|
442 |
Library.space_explode(':', getenv("ISABELLE_EXTERNAL_FILES")).contains(ext) |
49686e3b1909
clarified links to external files, e.g. .pdf within .thy source document;
wenzelm
parents:
72976
diff
changeset
|
443 |
if (external) { |
49686e3b1909
clarified links to external files, e.g. .pdf within .thy source document;
wenzelm
parents:
72976
diff
changeset
|
444 |
if (ext == "pdf" && Path.is_wellformed(name)) pdf_viewer(Path.explode(name)) |
49686e3b1909
clarified links to external files, e.g. .pdf within .thy source document;
wenzelm
parents:
72976
diff
changeset
|
445 |
else open(name) |
49686e3b1909
clarified links to external files, e.g. .pdf within .thy source document;
wenzelm
parents:
72976
diff
changeset
|
446 |
} |
49686e3b1909
clarified links to external files, e.g. .pdf within .thy source document;
wenzelm
parents:
72976
diff
changeset
|
447 |
external |
49686e3b1909
clarified links to external files, e.g. .pdf within .thy source document;
wenzelm
parents:
72976
diff
changeset
|
448 |
} |
49686e3b1909
clarified links to external files, e.g. .pdf within .thy source document;
wenzelm
parents:
72976
diff
changeset
|
449 |
|
65916 | 450 |
|
32450 | 451 |
|
31796 | 452 |
/** Isabelle resources **/ |
453 |
||
64161 | 454 |
/* repository clone with Admin */ |
455 |
||
456 |
def admin(): Boolean = Path.explode("~~/Admin").is_dir |
|
457 |
||
458 |
||
62633 | 459 |
/* default logic */ |
48503 | 460 |
|
75393 | 461 |
def default_logic(args: String*): String = { |
50403
87868964733c
more uniform default logic, using settings, options, args etc.;
wenzelm
parents:
50298
diff
changeset
|
462 |
args.find(_ != "") match { |
87868964733c
more uniform default logic, using settings, options, args etc.;
wenzelm
parents:
50298
diff
changeset
|
463 |
case Some(logic) => logic |
73317 | 464 |
case None => getenv_strict("ISABELLE_LOGIC") |
50403
87868964733c
more uniform default logic, using settings, options, args etc.;
wenzelm
parents:
50298
diff
changeset
|
465 |
} |
87868964733c
more uniform default logic, using settings, options, args etc.;
wenzelm
parents:
50298
diff
changeset
|
466 |
} |
73323 | 467 |
|
468 |
||
469 |
/* download file */ |
|
470 |
||
75393 | 471 |
def download(url_name: String, progress: Progress = new Progress): HTTP.Content = { |
73335 | 472 |
val url = Url(url_name) |
473 |
progress.echo("Getting " + quote(url_name)) |
|
73566 | 474 |
try { HTTP.Client.get(url) } |
475 |
catch { case ERROR(msg) => cat_error("Failed to download " + quote(url_name), msg) } |
|
73323 | 476 |
} |
477 |
||
73566 | 478 |
def download_file(url_name: String, file: Path, progress: Progress = new Progress): Unit = |
479 |
Bytes.write(file, download(url_name, progress = progress).bytes) |
|
480 |
||
75393 | 481 |
object Download extends Scala.Fun("download", thread = true) { |
73323 | 482 |
val here = Scala_Project.here |
73566 | 483 |
override def invoke(args: List[Bytes]): List[Bytes] = |
484 |
args match { case List(url) => List(download(url.text).bytes) } |
|
73323 | 485 |
} |
73608 | 486 |
|
487 |
||
488 |
/* repositories */ |
|
489 |
||
73611 | 490 |
val isabelle_repository: Mercurial.Server = |
491 |
Mercurial.Server("https://isabelle.sketis.net/repos/isabelle") |
|
73608 | 492 |
|
73611 | 493 |
val afp_repository: Mercurial.Server = |
494 |
Mercurial.Server("https://isabelle.sketis.net/repos/afp-devel") |
|
73610 | 495 |
|
496 |
def official_releases(): List[String] = |
|
497 |
Library.trim_split_lines( |
|
498 |
isabelle_repository.read_file(Path.explode("Admin/Release/official"))) |
|
27919 | 499 |
} |