src/Pure/System/isabelle_system.scala
author wenzelm
Sat, 23 May 2009 17:21:44 +0200
changeset 31234 6ce6801129de
parent 30175 62ba490670e8
child 31436 dde1b4d1c95b
permissions -rw-r--r--
getenv_strict needs to be based on getenv (accidentally broken in 0e88d33e8d19);
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
30175
62ba490670e8 fixed headers;
wenzelm
parents: 30174
diff changeset
     1
/*  Title:      Pure/System/isabelle_system.scala
27919
1eb8a3902d49 Isabelle system support.
wenzelm
parents:
diff changeset
     2
    Author:     Makarius
1eb8a3902d49 Isabelle system support.
wenzelm
parents:
diff changeset
     3
27974
1dfb0e260e4c added exec;
wenzelm
parents: 27962
diff changeset
     4
Isabelle system support -- basic Cygwin/Posix compatibility.
27919
1eb8a3902d49 Isabelle system support.
wenzelm
parents:
diff changeset
     5
*/
1eb8a3902d49 Isabelle system support.
wenzelm
parents:
diff changeset
     6
1eb8a3902d49 Isabelle system support.
wenzelm
parents:
diff changeset
     7
package isabelle
1eb8a3902d49 Isabelle system support.
wenzelm
parents:
diff changeset
     8
27936
947cb8e3d313 added get_setting;
wenzelm
parents: 27919
diff changeset
     9
import java.util.regex.{Pattern, Matcher}
28063
3533485fc7b8 IsabelleSystem.mk_fifo, IsabelleSystem.rm_fifo;
wenzelm
parents: 28057
diff changeset
    10
import java.io.{BufferedReader, InputStreamReader, FileInputStream, File, IOException}
3533485fc7b8 IsabelleSystem.mk_fifo, IsabelleSystem.rm_fifo;
wenzelm
parents: 28057
diff changeset
    11
3533485fc7b8 IsabelleSystem.mk_fifo, IsabelleSystem.rm_fifo;
wenzelm
parents: 28057
diff changeset
    12
import scala.io.Source
27936
947cb8e3d313 added get_setting;
wenzelm
parents: 27919
diff changeset
    13
27919
1eb8a3902d49 Isabelle system support.
wenzelm
parents:
diff changeset
    14
29174
d4058295affb proper class IsabelleSystem -- no longer static;
wenzelm
parents: 29152
diff changeset
    15
class IsabelleSystem {
27919
1eb8a3902d49 Isabelle system support.
wenzelm
parents:
diff changeset
    16
28057
6b90e6532d51 added charset (from isabelle_process.scala);
wenzelm
parents: 28046
diff changeset
    17
  val charset = "UTF-8"
6b90e6532d51 added charset (from isabelle_process.scala);
wenzelm
parents: 28046
diff changeset
    18
6b90e6532d51 added charset (from isabelle_process.scala);
wenzelm
parents: 28046
diff changeset
    19
28046
1447932b1b13 added is_cygwin;
wenzelm
parents: 27993
diff changeset
    20
  /* Isabelle environment settings */
27919
1eb8a3902d49 Isabelle system support.
wenzelm
parents:
diff changeset
    21
29177
0e88d33e8d19 maintain initial process environment;
wenzelm
parents: 29174
diff changeset
    22
  private val environment = System.getenv
0e88d33e8d19 maintain initial process environment;
wenzelm
parents: 29174
diff changeset
    23
27953
b2003c98897c added getenv;
wenzelm
parents: 27936
diff changeset
    24
  def getenv(name: String) = {
29177
0e88d33e8d19 maintain initial process environment;
wenzelm
parents: 29174
diff changeset
    25
    val value = environment.get(if (name == "HOME") "HOME_JVM" else name)
27953
b2003c98897c added getenv;
wenzelm
parents: 27936
diff changeset
    26
    if (value != null) value else ""
b2003c98897c added getenv;
wenzelm
parents: 27936
diff changeset
    27
  }
27919
1eb8a3902d49 Isabelle system support.
wenzelm
parents:
diff changeset
    28
27953
b2003c98897c added getenv;
wenzelm
parents: 27936
diff changeset
    29
  def getenv_strict(name: String) = {
31234
6ce6801129de getenv_strict needs to be based on getenv (accidentally broken in 0e88d33e8d19);
wenzelm
parents: 30175
diff changeset
    30
    val value = getenv(name)
27993
6dd90ef9f927 simplified exceptions: use plain error function / RuntimeException;
wenzelm
parents: 27974
diff changeset
    31
    if (value != "") value else error("Undefined environment variable: " + name)
27919
1eb8a3902d49 Isabelle system support.
wenzelm
parents:
diff changeset
    32
  }
1eb8a3902d49 Isabelle system support.
wenzelm
parents:
diff changeset
    33
29177
0e88d33e8d19 maintain initial process environment;
wenzelm
parents: 29174
diff changeset
    34
  val is_cygwin = Pattern.matches(".*-cygwin", getenv_strict("ML_PLATFORM"))
28046
1447932b1b13 added is_cygwin;
wenzelm
parents: 27993
diff changeset
    35
27936
947cb8e3d313 added get_setting;
wenzelm
parents: 27919
diff changeset
    36
27974
1dfb0e260e4c added exec;
wenzelm
parents: 27962
diff changeset
    37
  /* file path specifications */
27936
947cb8e3d313 added get_setting;
wenzelm
parents: 27919
diff changeset
    38
947cb8e3d313 added get_setting;
wenzelm
parents: 27919
diff changeset
    39
  private val cygdrive_pattern = Pattern.compile("/cygdrive/([a-zA-Z])($|/.*)")
947cb8e3d313 added get_setting;
wenzelm
parents: 27919
diff changeset
    40
947cb8e3d313 added get_setting;
wenzelm
parents: 27919
diff changeset
    41
  def platform_path(source_path: String) = {
947cb8e3d313 added get_setting;
wenzelm
parents: 27919
diff changeset
    42
    val result_path = new StringBuilder
27919
1eb8a3902d49 Isabelle system support.
wenzelm
parents:
diff changeset
    43
27936
947cb8e3d313 added get_setting;
wenzelm
parents: 27919
diff changeset
    44
    def init(path: String) = {
947cb8e3d313 added get_setting;
wenzelm
parents: 27919
diff changeset
    45
      val cygdrive = cygdrive_pattern.matcher(path)
947cb8e3d313 added get_setting;
wenzelm
parents: 27919
diff changeset
    46
      if (cygdrive.matches) {
27953
b2003c98897c added getenv;
wenzelm
parents: 27936
diff changeset
    47
        result_path.length = 0
27936
947cb8e3d313 added get_setting;
wenzelm
parents: 27919
diff changeset
    48
        result_path.append(cygdrive.group(1))
947cb8e3d313 added get_setting;
wenzelm
parents: 27919
diff changeset
    49
        result_path.append(":")
947cb8e3d313 added get_setting;
wenzelm
parents: 27919
diff changeset
    50
        result_path.append(File.separator)
947cb8e3d313 added get_setting;
wenzelm
parents: 27919
diff changeset
    51
        cygdrive.group(2)
947cb8e3d313 added get_setting;
wenzelm
parents: 27919
diff changeset
    52
      }
947cb8e3d313 added get_setting;
wenzelm
parents: 27919
diff changeset
    53
      else if (path.startsWith("/")) {
27953
b2003c98897c added getenv;
wenzelm
parents: 27936
diff changeset
    54
        result_path.length = 0
b2003c98897c added getenv;
wenzelm
parents: 27936
diff changeset
    55
        result_path.append(getenv_strict("ISABELLE_ROOT_JVM"))
27936
947cb8e3d313 added get_setting;
wenzelm
parents: 27919
diff changeset
    56
        path.substring(1)
947cb8e3d313 added get_setting;
wenzelm
parents: 27919
diff changeset
    57
      }
947cb8e3d313 added get_setting;
wenzelm
parents: 27919
diff changeset
    58
      else path
947cb8e3d313 added get_setting;
wenzelm
parents: 27919
diff changeset
    59
    }
947cb8e3d313 added get_setting;
wenzelm
parents: 27919
diff changeset
    60
    def append(path: String) = {
947cb8e3d313 added get_setting;
wenzelm
parents: 27919
diff changeset
    61
      for (p <- init(path).split("/")) {
947cb8e3d313 added get_setting;
wenzelm
parents: 27919
diff changeset
    62
        if (p != "") {
947cb8e3d313 added get_setting;
wenzelm
parents: 27919
diff changeset
    63
          val len = result_path.length
947cb8e3d313 added get_setting;
wenzelm
parents: 27919
diff changeset
    64
          if (len > 0 && result_path(len - 1) != File.separatorChar)
947cb8e3d313 added get_setting;
wenzelm
parents: 27919
diff changeset
    65
            result_path.append(File.separator)
947cb8e3d313 added get_setting;
wenzelm
parents: 27919
diff changeset
    66
          result_path.append(p)
947cb8e3d313 added get_setting;
wenzelm
parents: 27919
diff changeset
    67
        }
947cb8e3d313 added get_setting;
wenzelm
parents: 27919
diff changeset
    68
      }
947cb8e3d313 added get_setting;
wenzelm
parents: 27919
diff changeset
    69
    }
947cb8e3d313 added get_setting;
wenzelm
parents: 27919
diff changeset
    70
    for (p <- init(source_path).split("/")) {
27953
b2003c98897c added getenv;
wenzelm
parents: 27936
diff changeset
    71
      if (p.startsWith("$")) append(getenv_strict(p.substring(1)))
b2003c98897c added getenv;
wenzelm
parents: 27936
diff changeset
    72
      else if (p == "~") append(getenv_strict("HOME"))
b2003c98897c added getenv;
wenzelm
parents: 27936
diff changeset
    73
      else if (p == "~~") append(getenv_strict("ISABELLE_HOME"))
27936
947cb8e3d313 added get_setting;
wenzelm
parents: 27919
diff changeset
    74
      else append(p)
947cb8e3d313 added get_setting;
wenzelm
parents: 27919
diff changeset
    75
    }
947cb8e3d313 added get_setting;
wenzelm
parents: 27919
diff changeset
    76
    result_path.toString
947cb8e3d313 added get_setting;
wenzelm
parents: 27919
diff changeset
    77
  }
27953
b2003c98897c added getenv;
wenzelm
parents: 27936
diff changeset
    78
29152
89b0803404d7 added platform_file;
wenzelm
parents: 29140
diff changeset
    79
  def platform_file(path: String) =
89b0803404d7 added platform_file;
wenzelm
parents: 29140
diff changeset
    80
    new File(platform_path(path))
89b0803404d7 added platform_file;
wenzelm
parents: 29140
diff changeset
    81
27953
b2003c98897c added getenv;
wenzelm
parents: 27936
diff changeset
    82
27974
1dfb0e260e4c added exec;
wenzelm
parents: 27962
diff changeset
    83
  /* processes */
27953
b2003c98897c added getenv;
wenzelm
parents: 27936
diff changeset
    84
29177
0e88d33e8d19 maintain initial process environment;
wenzelm
parents: 29174
diff changeset
    85
  def execute(redirect: Boolean, args: String*): Process = {
0e88d33e8d19 maintain initial process environment;
wenzelm
parents: 29174
diff changeset
    86
    val cmdline = new java.util.LinkedList[String]
0e88d33e8d19 maintain initial process environment;
wenzelm
parents: 29174
diff changeset
    87
    if (is_cygwin) cmdline.add(platform_path("/bin/env"))
0e88d33e8d19 maintain initial process environment;
wenzelm
parents: 29174
diff changeset
    88
    for (s <- args) cmdline.add(s)
27974
1dfb0e260e4c added exec;
wenzelm
parents: 27962
diff changeset
    89
29177
0e88d33e8d19 maintain initial process environment;
wenzelm
parents: 29174
diff changeset
    90
    val proc = new ProcessBuilder(cmdline)
29180
wenzelm
parents: 29177
diff changeset
    91
    proc.environment.clear
wenzelm
parents: 29177
diff changeset
    92
    proc.environment.putAll(environment)
wenzelm
parents: 29177
diff changeset
    93
    proc.redirectErrorStream(redirect)
wenzelm
parents: 29177
diff changeset
    94
    proc.start
28046
1447932b1b13 added is_cygwin;
wenzelm
parents: 27993
diff changeset
    95
  }
1447932b1b13 added is_cygwin;
wenzelm
parents: 27993
diff changeset
    96
28063
3533485fc7b8 IsabelleSystem.mk_fifo, IsabelleSystem.rm_fifo;
wenzelm
parents: 28057
diff changeset
    97
3533485fc7b8 IsabelleSystem.mk_fifo, IsabelleSystem.rm_fifo;
wenzelm
parents: 28057
diff changeset
    98
  /* Isabelle tools (non-interactive) */
3533485fc7b8 IsabelleSystem.mk_fifo, IsabelleSystem.rm_fifo;
wenzelm
parents: 28057
diff changeset
    99
28496
4cff10648928 renamed isatool to isabelle_tool in programming interfaces;
wenzelm
parents: 28063
diff changeset
   100
  def isabelle_tool(args: String*) = {
28063
3533485fc7b8 IsabelleSystem.mk_fifo, IsabelleSystem.rm_fifo;
wenzelm
parents: 28057
diff changeset
   101
    val proc =
29177
0e88d33e8d19 maintain initial process environment;
wenzelm
parents: 29174
diff changeset
   102
      try { execute(true, (List(getenv_strict("ISABELLE_TOOL")) ++ args): _*) }
28063
3533485fc7b8 IsabelleSystem.mk_fifo, IsabelleSystem.rm_fifo;
wenzelm
parents: 28057
diff changeset
   103
      catch { case e: IOException => error(e.getMessage) }
3533485fc7b8 IsabelleSystem.mk_fifo, IsabelleSystem.rm_fifo;
wenzelm
parents: 28057
diff changeset
   104
    proc.getOutputStream.close
29174
d4058295affb proper class IsabelleSystem -- no longer static;
wenzelm
parents: 29152
diff changeset
   105
    val output = Source.fromInputStream(proc.getInputStream, charset).mkString
28063
3533485fc7b8 IsabelleSystem.mk_fifo, IsabelleSystem.rm_fifo;
wenzelm
parents: 28057
diff changeset
   106
    val rc = proc.waitFor
3533485fc7b8 IsabelleSystem.mk_fifo, IsabelleSystem.rm_fifo;
wenzelm
parents: 28057
diff changeset
   107
    (output, rc)
3533485fc7b8 IsabelleSystem.mk_fifo, IsabelleSystem.rm_fifo;
wenzelm
parents: 28057
diff changeset
   108
  }
3533485fc7b8 IsabelleSystem.mk_fifo, IsabelleSystem.rm_fifo;
wenzelm
parents: 28057
diff changeset
   109
3533485fc7b8 IsabelleSystem.mk_fifo, IsabelleSystem.rm_fifo;
wenzelm
parents: 28057
diff changeset
   110
3533485fc7b8 IsabelleSystem.mk_fifo, IsabelleSystem.rm_fifo;
wenzelm
parents: 28057
diff changeset
   111
  /* named pipes */
3533485fc7b8 IsabelleSystem.mk_fifo, IsabelleSystem.rm_fifo;
wenzelm
parents: 28057
diff changeset
   112
3533485fc7b8 IsabelleSystem.mk_fifo, IsabelleSystem.rm_fifo;
wenzelm
parents: 28057
diff changeset
   113
  def mk_fifo() = {
28496
4cff10648928 renamed isatool to isabelle_tool in programming interfaces;
wenzelm
parents: 28063
diff changeset
   114
    val (result, rc) = isabelle_tool("mkfifo")
28063
3533485fc7b8 IsabelleSystem.mk_fifo, IsabelleSystem.rm_fifo;
wenzelm
parents: 28057
diff changeset
   115
    if (rc == 0) result.trim
3533485fc7b8 IsabelleSystem.mk_fifo, IsabelleSystem.rm_fifo;
wenzelm
parents: 28057
diff changeset
   116
    else error(result)
3533485fc7b8 IsabelleSystem.mk_fifo, IsabelleSystem.rm_fifo;
wenzelm
parents: 28057
diff changeset
   117
  }
3533485fc7b8 IsabelleSystem.mk_fifo, IsabelleSystem.rm_fifo;
wenzelm
parents: 28057
diff changeset
   118
3533485fc7b8 IsabelleSystem.mk_fifo, IsabelleSystem.rm_fifo;
wenzelm
parents: 28057
diff changeset
   119
  def rm_fifo(fifo: String) = {
28496
4cff10648928 renamed isatool to isabelle_tool in programming interfaces;
wenzelm
parents: 28063
diff changeset
   120
    val (result, rc) = isabelle_tool("rmfifo", fifo)
28063
3533485fc7b8 IsabelleSystem.mk_fifo, IsabelleSystem.rm_fifo;
wenzelm
parents: 28057
diff changeset
   121
    if (rc != 0) error(result)
3533485fc7b8 IsabelleSystem.mk_fifo, IsabelleSystem.rm_fifo;
wenzelm
parents: 28057
diff changeset
   122
  }
3533485fc7b8 IsabelleSystem.mk_fifo, IsabelleSystem.rm_fifo;
wenzelm
parents: 28057
diff changeset
   123
29177
0e88d33e8d19 maintain initial process environment;
wenzelm
parents: 29174
diff changeset
   124
  def fifo_reader(fifo: String) = {
0e88d33e8d19 maintain initial process environment;
wenzelm
parents: 29174
diff changeset
   125
    // blocks until writer is ready
0e88d33e8d19 maintain initial process environment;
wenzelm
parents: 29174
diff changeset
   126
    val stream =
0e88d33e8d19 maintain initial process environment;
wenzelm
parents: 29174
diff changeset
   127
      if (is_cygwin) execute(false, "cat", fifo).getInputStream
0e88d33e8d19 maintain initial process environment;
wenzelm
parents: 29174
diff changeset
   128
      else new FileInputStream(fifo)
0e88d33e8d19 maintain initial process environment;
wenzelm
parents: 29174
diff changeset
   129
    new BufferedReader(new InputStreamReader(stream, charset))
0e88d33e8d19 maintain initial process environment;
wenzelm
parents: 29174
diff changeset
   130
  }
28063
3533485fc7b8 IsabelleSystem.mk_fifo, IsabelleSystem.rm_fifo;
wenzelm
parents: 28057
diff changeset
   131
29152
89b0803404d7 added platform_file;
wenzelm
parents: 29140
diff changeset
   132
89b0803404d7 added platform_file;
wenzelm
parents: 29140
diff changeset
   133
  /* find logics */
89b0803404d7 added platform_file;
wenzelm
parents: 29140
diff changeset
   134
89b0803404d7 added platform_file;
wenzelm
parents: 29140
diff changeset
   135
  def find_logics() = {
89b0803404d7 added platform_file;
wenzelm
parents: 29140
diff changeset
   136
    val ml_ident = getenv_strict("ML_IDENTIFIER")
89b0803404d7 added platform_file;
wenzelm
parents: 29140
diff changeset
   137
    var logics: Set[String] = Set()
89b0803404d7 added platform_file;
wenzelm
parents: 29140
diff changeset
   138
    for (dir <- getenv_strict("ISABELLE_PATH").split(":")) {
89b0803404d7 added platform_file;
wenzelm
parents: 29140
diff changeset
   139
      val files = platform_file(dir + "/" + ml_ident).listFiles()
89b0803404d7 added platform_file;
wenzelm
parents: 29140
diff changeset
   140
      if (files != null) {
89b0803404d7 added platform_file;
wenzelm
parents: 29140
diff changeset
   141
        for (file <- files if file.isFile) logics += file.getName
89b0803404d7 added platform_file;
wenzelm
parents: 29140
diff changeset
   142
      }
89b0803404d7 added platform_file;
wenzelm
parents: 29140
diff changeset
   143
    }
89b0803404d7 added platform_file;
wenzelm
parents: 29140
diff changeset
   144
    logics.toList.sort(_ < _)
89b0803404d7 added platform_file;
wenzelm
parents: 29140
diff changeset
   145
  }
29570
10fca82e688a IsabelleSystem: provide Symbol.Interpretation;
wenzelm
parents: 29180
diff changeset
   146
10fca82e688a IsabelleSystem: provide Symbol.Interpretation;
wenzelm
parents: 29180
diff changeset
   147
10fca82e688a IsabelleSystem: provide Symbol.Interpretation;
wenzelm
parents: 29180
diff changeset
   148
  /* symbols */
10fca82e688a IsabelleSystem: provide Symbol.Interpretation;
wenzelm
parents: 29180
diff changeset
   149
10fca82e688a IsabelleSystem: provide Symbol.Interpretation;
wenzelm
parents: 29180
diff changeset
   150
  private def read_symbols(path: String) = {
10fca82e688a IsabelleSystem: provide Symbol.Interpretation;
wenzelm
parents: 29180
diff changeset
   151
    val file = new File(platform_path(path))
10fca82e688a IsabelleSystem: provide Symbol.Interpretation;
wenzelm
parents: 29180
diff changeset
   152
    if (file.canRead) Source.fromFile(file).getLines
10fca82e688a IsabelleSystem: provide Symbol.Interpretation;
wenzelm
parents: 29180
diff changeset
   153
    else Iterator.empty
10fca82e688a IsabelleSystem: provide Symbol.Interpretation;
wenzelm
parents: 29180
diff changeset
   154
  }
10fca82e688a IsabelleSystem: provide Symbol.Interpretation;
wenzelm
parents: 29180
diff changeset
   155
  val symbols = new Symbol.Interpretation(
10fca82e688a IsabelleSystem: provide Symbol.Interpretation;
wenzelm
parents: 29180
diff changeset
   156
    read_symbols("$ISABELLE_HOME/etc/symbols") ++
10fca82e688a IsabelleSystem: provide Symbol.Interpretation;
wenzelm
parents: 29180
diff changeset
   157
    read_symbols("$ISABELLE_HOME_USER/etc/symbols"))
27919
1eb8a3902d49 Isabelle system support.
wenzelm
parents:
diff changeset
   158
}