src/Pure/System/executable.scala
author wenzelm
Fri, 01 Apr 2022 17:06:10 +0200
changeset 75393 87ebf5a50283
parent 73317 df49ca5da9d0
child 77217 e5ec449b4839
permissions -rw-r--r--
clarified formatting, for the sake of scala3;
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
72448
faad63aca1e7 support for platform-specific executables;
wenzelm
parents:
diff changeset
     1
/*  Title:      Pure/System/executable.scala
faad63aca1e7 support for platform-specific executables;
wenzelm
parents:
diff changeset
     2
    Author:     Makarius
faad63aca1e7 support for platform-specific executables;
wenzelm
parents:
diff changeset
     3
faad63aca1e7 support for platform-specific executables;
wenzelm
parents:
diff changeset
     4
Support for platform-specific executables.
faad63aca1e7 support for platform-specific executables;
wenzelm
parents:
diff changeset
     5
*/
faad63aca1e7 support for platform-specific executables;
wenzelm
parents:
diff changeset
     6
faad63aca1e7 support for platform-specific executables;
wenzelm
parents:
diff changeset
     7
package isabelle
faad63aca1e7 support for platform-specific executables;
wenzelm
parents:
diff changeset
     8
faad63aca1e7 support for platform-specific executables;
wenzelm
parents:
diff changeset
     9
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 73317
diff changeset
    10
object Executable {
72460
e79294c4230c more portable;
wenzelm
parents: 72454
diff changeset
    11
  def libraries_closure(path: Path,
72454
549391271e74 clarified Executable.libraries_closure;
wenzelm
parents: 72448
diff changeset
    12
    mingw: MinGW = MinGW.none,
72460
e79294c4230c more portable;
wenzelm
parents: 72454
diff changeset
    13
    filter: String => Boolean = _ => true,
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 73317
diff changeset
    14
    patchelf: Boolean = false
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 73317
diff changeset
    15
  ): List[String] = {
72460
e79294c4230c more portable;
wenzelm
parents: 72454
diff changeset
    16
    val exe_path = path.expand
72454
549391271e74 clarified Executable.libraries_closure;
wenzelm
parents: 72448
diff changeset
    17
    val exe_dir = exe_path.dir
549391271e74 clarified Executable.libraries_closure;
wenzelm
parents: 72448
diff changeset
    18
    val exe = exe_path.base
72448
faad63aca1e7 support for platform-specific executables;
wenzelm
parents:
diff changeset
    19
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 73317
diff changeset
    20
    val ldd_lines = {
72454
549391271e74 clarified Executable.libraries_closure;
wenzelm
parents: 72448
diff changeset
    21
      val ldd = if (Platform.is_macos) "otool -L" else "ldd"
549391271e74 clarified Executable.libraries_closure;
wenzelm
parents: 72448
diff changeset
    22
      val script = mingw.bash_script(ldd + " " + File.bash_path(exe))
549391271e74 clarified Executable.libraries_closure;
wenzelm
parents: 72448
diff changeset
    23
      Library.split_lines(Isabelle_System.bash(script, cwd = exe_dir.file).check.out)
72448
faad63aca1e7 support for platform-specific executables;
wenzelm
parents:
diff changeset
    24
    }
faad63aca1e7 support for platform-specific executables;
wenzelm
parents:
diff changeset
    25
72454
549391271e74 clarified Executable.libraries_closure;
wenzelm
parents: 72448
diff changeset
    26
    def lib_name(lib: String): String =
72468
60471f4bafd2 proper library names on Windows;
wenzelm
parents: 72460
diff changeset
    27
      Library.take_prefix[Char](c => c != '.' && c != '-',
72454
549391271e74 clarified Executable.libraries_closure;
wenzelm
parents: 72448
diff changeset
    28
        Library.take_suffix[Char](_ != '/', lib.toList)._2)._1.mkString
549391271e74 clarified Executable.libraries_closure;
wenzelm
parents: 72448
diff changeset
    29
549391271e74 clarified Executable.libraries_closure;
wenzelm
parents: 72448
diff changeset
    30
    val libs =
549391271e74 clarified Executable.libraries_closure;
wenzelm
parents: 72448
diff changeset
    31
      if (Platform.is_macos) {
549391271e74 clarified Executable.libraries_closure;
wenzelm
parents: 72448
diff changeset
    32
        val Pattern = """^\s*(/.+)\s+\(.*\)$""".r
549391271e74 clarified Executable.libraries_closure;
wenzelm
parents: 72448
diff changeset
    33
        for {
549391271e74 clarified Executable.libraries_closure;
wenzelm
parents: 72448
diff changeset
    34
          Pattern(lib) <- ldd_lines
549391271e74 clarified Executable.libraries_closure;
wenzelm
parents: 72448
diff changeset
    35
          if !lib.startsWith("@executable_path/") && filter(lib_name(lib))
549391271e74 clarified Executable.libraries_closure;
wenzelm
parents: 72448
diff changeset
    36
        } yield lib
549391271e74 clarified Executable.libraries_closure;
wenzelm
parents: 72448
diff changeset
    37
      }
549391271e74 clarified Executable.libraries_closure;
wenzelm
parents: 72448
diff changeset
    38
      else {
549391271e74 clarified Executable.libraries_closure;
wenzelm
parents: 72448
diff changeset
    39
        val Pattern = """^.*=>\s*(/.+)\s+\(.*\)$""".r
549391271e74 clarified Executable.libraries_closure;
wenzelm
parents: 72448
diff changeset
    40
        val prefix =
549391271e74 clarified Executable.libraries_closure;
wenzelm
parents: 72448
diff changeset
    41
          mingw.root match {
549391271e74 clarified Executable.libraries_closure;
wenzelm
parents: 72448
diff changeset
    42
            case None => ""
549391271e74 clarified Executable.libraries_closure;
wenzelm
parents: 72448
diff changeset
    43
            case Some(path) => path.absolute.implode
549391271e74 clarified Executable.libraries_closure;
wenzelm
parents: 72448
diff changeset
    44
          }
549391271e74 clarified Executable.libraries_closure;
wenzelm
parents: 72448
diff changeset
    45
        for { Pattern(lib) <- ldd_lines if filter(lib_name(lib)) }
549391271e74 clarified Executable.libraries_closure;
wenzelm
parents: 72448
diff changeset
    46
          yield prefix + lib
549391271e74 clarified Executable.libraries_closure;
wenzelm
parents: 72448
diff changeset
    47
      }
549391271e74 clarified Executable.libraries_closure;
wenzelm
parents: 72448
diff changeset
    48
549391271e74 clarified Executable.libraries_closure;
wenzelm
parents: 72448
diff changeset
    49
    if (libs.nonEmpty) {
73317
df49ca5da9d0 clarified modules: more like ML;
wenzelm
parents: 72468
diff changeset
    50
      libs.foreach(lib => Isabelle_System.copy_file(Path.explode(lib), exe_dir))
72454
549391271e74 clarified Executable.libraries_closure;
wenzelm
parents: 72448
diff changeset
    51
549391271e74 clarified Executable.libraries_closure;
wenzelm
parents: 72448
diff changeset
    52
      if (Platform.is_linux) {
72460
e79294c4230c more portable;
wenzelm
parents: 72454
diff changeset
    53
        if (patchelf) {
e79294c4230c more portable;
wenzelm
parents: 72454
diff changeset
    54
          // requires e.g. Ubuntu 16.04 LTS
e79294c4230c more portable;
wenzelm
parents: 72454
diff changeset
    55
          Isabelle_System.require_command("patchelf")
e79294c4230c more portable;
wenzelm
parents: 72454
diff changeset
    56
          Isabelle_System.bash("patchelf --force-rpath --set-rpath '$ORIGIN' " + File.bash_path(exe_path)).check
e79294c4230c more portable;
wenzelm
parents: 72454
diff changeset
    57
        }
e79294c4230c more portable;
wenzelm
parents: 72454
diff changeset
    58
        else {
e79294c4230c more portable;
wenzelm
parents: 72454
diff changeset
    59
          // requires e.g. LDFLAGS=-Wl,-rpath,_DUMMY_
e79294c4230c more portable;
wenzelm
parents: 72454
diff changeset
    60
          Isabelle_System.require_command("chrpath")
e79294c4230c more portable;
wenzelm
parents: 72454
diff changeset
    61
          Isabelle_System.bash("chrpath -r '$ORIGIN' " + File.bash_path(exe_path)).check
e79294c4230c more portable;
wenzelm
parents: 72454
diff changeset
    62
        }
72454
549391271e74 clarified Executable.libraries_closure;
wenzelm
parents: 72448
diff changeset
    63
      }
549391271e74 clarified Executable.libraries_closure;
wenzelm
parents: 72448
diff changeset
    64
      else if (Platform.is_macos) {
549391271e74 clarified Executable.libraries_closure;
wenzelm
parents: 72448
diff changeset
    65
        val script =
549391271e74 clarified Executable.libraries_closure;
wenzelm
parents: 72448
diff changeset
    66
          ("install_name_tool" ::
549391271e74 clarified Executable.libraries_closure;
wenzelm
parents: 72448
diff changeset
    67
            libs.map(file => "-change " + Bash.string(file) + " " +
549391271e74 clarified Executable.libraries_closure;
wenzelm
parents: 72448
diff changeset
    68
              Bash.string("@executable_path/" + Path.explode(file).file_name) + " " +
549391271e74 clarified Executable.libraries_closure;
wenzelm
parents: 72448
diff changeset
    69
              File.bash_path(exe))).mkString(" ")
549391271e74 clarified Executable.libraries_closure;
wenzelm
parents: 72448
diff changeset
    70
        Isabelle_System.bash(script, cwd = exe_dir.file).check
72448
faad63aca1e7 support for platform-specific executables;
wenzelm
parents:
diff changeset
    71
      }
faad63aca1e7 support for platform-specific executables;
wenzelm
parents:
diff changeset
    72
    }
72454
549391271e74 clarified Executable.libraries_closure;
wenzelm
parents: 72448
diff changeset
    73
549391271e74 clarified Executable.libraries_closure;
wenzelm
parents: 72448
diff changeset
    74
    libs
72448
faad63aca1e7 support for platform-specific executables;
wenzelm
parents:
diff changeset
    75
  }
faad63aca1e7 support for platform-specific executables;
wenzelm
parents:
diff changeset
    76
}