src/Pure/System/options.scala
author wenzelm
Fri Nov 30 21:30:24 2012 +0100 (2012-11-30)
changeset 50299 f70b3712040f
parent 50207 54be125d8cdc
child 50793 b93484db43ed
permissions -rw-r--r--
renamed dockable "Prover Session" to "Theories";
more uniform Library.lowercase/uppercase;
wenzelm@48365
     1
/*  Title:      Pure/System/options.scala
wenzelm@48365
     2
    Author:     Makarius
wenzelm@48365
     3
wenzelm@48365
     4
Stand-alone options with external string representation.
wenzelm@48365
     5
*/
wenzelm@48365
     6
wenzelm@48365
     7
package isabelle
wenzelm@48365
     8
wenzelm@48365
     9
wenzelm@48807
    10
import java.util.Calendar
wenzelm@48807
    11
wenzelm@48807
    12
wenzelm@48365
    13
object Options
wenzelm@48365
    14
{
wenzelm@48421
    15
  type Spec = (String, Option[String])
wenzelm@48421
    16
wenzelm@48421
    17
  val empty: Options = new Options()
wenzelm@48421
    18
wenzelm@48421
    19
wenzelm@48421
    20
  /* representation */
wenzelm@48421
    21
wenzelm@48421
    22
  sealed abstract class Type
wenzelm@48365
    23
  {
wenzelm@50299
    24
    def print: String = Library.lowercase(toString)
wenzelm@48365
    25
  }
wenzelm@49246
    26
  case object Bool extends Type
wenzelm@49246
    27
  case object Int extends Type
wenzelm@49246
    28
  case object Real extends Type
wenzelm@49246
    29
  case object String extends Type
wenzelm@49246
    30
  case object Unknown extends Type
wenzelm@48365
    31
wenzelm@49289
    32
  case class Opt(name: String, typ: Type, value: String, default_value: String,
wenzelm@49289
    33
    description: String, section: String)
wenzelm@48860
    34
  {
wenzelm@49289
    35
    private def print(default: Boolean): String =
wenzelm@49289
    36
    {
wenzelm@49289
    37
      val x = if (default) default_value else value
wenzelm@49247
    38
      "option " + name + " : " + typ.print + " = " +
wenzelm@49289
    39
        (if (typ == Options.String) quote(x) else x) +
wenzelm@49289
    40
        (if (description == "") "" else "\n  -- " + quote(description))
wenzelm@49289
    41
    }
wenzelm@49289
    42
wenzelm@49289
    43
    def print: String = print(false)
wenzelm@49289
    44
    def print_default: String = print(true)
wenzelm@49247
    45
wenzelm@49270
    46
    def title(strip: String): String =
wenzelm@49270
    47
    {
wenzelm@49270
    48
      val words = space_explode('_', name)
wenzelm@49270
    49
      val words1 =
wenzelm@49270
    50
        words match {
wenzelm@49270
    51
          case word :: rest if word == strip => rest
wenzelm@49270
    52
          case _ => words
wenzelm@49270
    53
        }
wenzelm@49270
    54
      words1.map(Library.capitalize).mkString(" ")
wenzelm@49270
    55
    }
wenzelm@49270
    56
wenzelm@48860
    57
    def unknown: Boolean = typ == Unknown
wenzelm@48860
    58
  }
wenzelm@48365
    59
wenzelm@48365
    60
wenzelm@48365
    61
  /* parsing */
wenzelm@48365
    62
wenzelm@49270
    63
  private val SECTION = "section"
wenzelm@48795
    64
  private val OPTION = "option"
wenzelm@48807
    65
  private val OPTIONS = Path.explode("etc/options")
wenzelm@48807
    66
  private val PREFS = Path.explode("$ISABELLE_HOME_USER/etc/preferences")
wenzelm@48807
    67
  private val PREFS_BACKUP = Path.explode("$ISABELLE_HOME_USER/etc/preferences~")
wenzelm@48713
    68
wenzelm@49270
    69
  lazy val options_syntax =
wenzelm@49270
    70
    Outer_Syntax.init() + ":" + "=" + "--" +
wenzelm@49270
    71
      (SECTION, Keyword.THY_HEADING2) + (OPTION, Keyword.THY_DECL)
wenzelm@49270
    72
wenzelm@48807
    73
  lazy val prefs_syntax = Outer_Syntax.init() + "="
wenzelm@48713
    74
wenzelm@48807
    75
  object Parser extends Parse.Parser
wenzelm@48365
    76
  {
wenzelm@48807
    77
    val option_name = atom("option name", _.is_xname)
wenzelm@48807
    78
    val option_type = atom("option type", _.is_ident)
wenzelm@48807
    79
    val option_value =
wenzelm@48807
    80
      opt(token("-", tok => tok.is_sym_ident && tok.content == "-")) ~ atom("nat", _.is_nat) ^^
wenzelm@48807
    81
        { case s ~ n => if (s.isDefined) "-" + n else n } |
wenzelm@48807
    82
      atom("option value", tok => tok.is_name || tok.is_float)
wenzelm@48807
    83
wenzelm@48807
    84
    val option_entry: Parser[Options => Options] =
wenzelm@48365
    85
    {
wenzelm@49270
    86
      command(SECTION) ~! text ^^
wenzelm@49295
    87
        { case _ ~ a => (options: Options) => options.set_section(a) } |
wenzelm@48795
    88
      command(OPTION) ~! (option_name ~ keyword(":") ~ option_type ~
wenzelm@48580
    89
      keyword("=") ~ option_value ~ (keyword("--") ~! text ^^ { case _ ~ x => x } | success(""))) ^^
wenzelm@48795
    90
        { case _ ~ (a ~ _ ~ b ~ _ ~ c ~ d) => (options: Options) => options.declare(a, b, c, d) }
wenzelm@48365
    91
    }
wenzelm@48365
    92
wenzelm@48807
    93
    val prefs_entry: Parser[Options => Options] =
wenzelm@48807
    94
    {
wenzelm@48807
    95
      option_name ~ (keyword("=") ~! option_value) ^^
wenzelm@48860
    96
      { case a ~ (_ ~ b) => (options: Options) => options.add_permissive(a, b) }
wenzelm@48807
    97
    }
wenzelm@48807
    98
wenzelm@48807
    99
    def parse_file(syntax: Outer_Syntax, parser: Parser[Options => Options],
wenzelm@48807
   100
      options: Options, file: Path): Options =
wenzelm@48365
   101
    {
wenzelm@48807
   102
      val toks = syntax.scan(File.read(file))
wenzelm@48807
   103
      val ops =
wenzelm@48807
   104
        parse_all(rep(parser), Token.reader(toks, file.implode)) match {
wenzelm@48807
   105
          case Success(result, _) => result
wenzelm@48807
   106
          case bad => error(bad.toString)
wenzelm@48807
   107
        }
wenzelm@49270
   108
      try { (options.set_section("") /: ops) { case (opts, op) => op(opts) } }
wenzelm@48992
   109
      catch { case ERROR(msg) => error(msg + Position.here(file.position)) }
wenzelm@48365
   110
    }
wenzelm@48365
   111
  }
wenzelm@48365
   112
wenzelm@48807
   113
  def init_defaults(): Options =
wenzelm@48365
   114
  {
wenzelm@48365
   115
    var options = empty
wenzelm@48365
   116
    for {
wenzelm@48365
   117
      dir <- Isabelle_System.components()
wenzelm@48548
   118
      file = dir + OPTIONS if file.is_file
wenzelm@48807
   119
    } { options = Parser.parse_file(options_syntax, Parser.option_entry, options, file) }
wenzelm@48365
   120
    options
wenzelm@48365
   121
  }
wenzelm@48457
   122
wenzelm@48807
   123
  def init(): Options = init_defaults().load_prefs()
wenzelm@48807
   124
wenzelm@48457
   125
wenzelm@48457
   126
  /* encode */
wenzelm@48457
   127
wenzelm@48457
   128
  val encode: XML.Encode.T[Options] = (options => options.encode)
wenzelm@48693
   129
wenzelm@48693
   130
wenzelm@48693
   131
  /* command line entry point */
wenzelm@48693
   132
wenzelm@48693
   133
  def main(args: Array[String])
wenzelm@48693
   134
  {
wenzelm@48693
   135
    Command_Line.tool {
wenzelm@48693
   136
      args.toList match {
wenzelm@48693
   137
        case export_file :: more_options =>
wenzelm@48807
   138
          val options = (Options.init() /: more_options)(_ + _)
wenzelm@48693
   139
wenzelm@48693
   140
          if (export_file == "") java.lang.System.out.println(options.print)
wenzelm@48693
   141
          else File.write(Path.explode(export_file), YXML.string_of_body(options.encode))
wenzelm@48693
   142
wenzelm@48693
   143
          0
wenzelm@48693
   144
        case _ => error("Bad arguments:\n" + cat_lines(args))
wenzelm@48693
   145
      }
wenzelm@48693
   146
    }
wenzelm@48693
   147
  }
wenzelm@48365
   148
}
wenzelm@48365
   149
wenzelm@48365
   150
wenzelm@49270
   151
final class Options private(
wenzelm@49296
   152
  val options: Map[String, Options.Opt] = Map.empty,
wenzelm@49270
   153
  val section: String = "")
wenzelm@48365
   154
{
wenzelm@48365
   155
  override def toString: String = options.iterator.mkString("Options (", ",", ")")
wenzelm@48365
   156
wenzelm@49247
   157
  def print: String = cat_lines(options.toList.sortBy(_._1).map(p => p._2.print))
wenzelm@48693
   158
wenzelm@49245
   159
  def description(name: String): String = check_name(name).description
wenzelm@49245
   160
wenzelm@48365
   161
wenzelm@48370
   162
  /* check */
wenzelm@48365
   163
wenzelm@49246
   164
  def check_name(name: String): Options.Opt =
wenzelm@48365
   165
    options.get(name) match {
wenzelm@48860
   166
      case Some(opt) if !opt.unknown => opt
wenzelm@48860
   167
      case _ => error("Unknown option " + quote(name))
wenzelm@48365
   168
    }
wenzelm@48365
   169
wenzelm@48365
   170
  private def check_type(name: String, typ: Options.Type): Options.Opt =
wenzelm@48365
   171
  {
wenzelm@48365
   172
    val opt = check_name(name)
wenzelm@48365
   173
    if (opt.typ == typ) opt
wenzelm@48365
   174
    else error("Ill-typed option " + quote(name) + " : " + opt.typ.print + " vs. " + typ.print)
wenzelm@48365
   175
  }
wenzelm@48365
   176
wenzelm@48370
   177
wenzelm@48370
   178
  /* basic operations */
wenzelm@48370
   179
wenzelm@48370
   180
  private def put[A](name: String, typ: Options.Type, value: String): Options =
wenzelm@48370
   181
  {
wenzelm@48370
   182
    val opt = check_type(name, typ)
wenzelm@49270
   183
    new Options(options + (name -> opt.copy(value = value)), section)
wenzelm@48370
   184
  }
wenzelm@48370
   185
wenzelm@48365
   186
  private def get[A](name: String, typ: Options.Type, parse: String => Option[A]): A =
wenzelm@48365
   187
  {
wenzelm@48365
   188
    val opt = check_type(name, typ)
wenzelm@48365
   189
    parse(opt.value) match {
wenzelm@48365
   190
      case Some(x) => x
wenzelm@48365
   191
      case None =>
wenzelm@48365
   192
        error("Malformed value for option " + quote(name) +
wenzelm@48365
   193
          " : " + typ.print + " =\n" + quote(opt.value))
wenzelm@48365
   194
    }
wenzelm@48365
   195
  }
wenzelm@48365
   196
wenzelm@48365
   197
wenzelm@48365
   198
  /* internal lookup and update */
wenzelm@48365
   199
wenzelm@49954
   200
  class Bool_Access
wenzelm@48365
   201
  {
wenzelm@48365
   202
    def apply(name: String): Boolean = get(name, Options.Bool, Properties.Value.Boolean.unapply)
wenzelm@48365
   203
    def update(name: String, x: Boolean): Options =
wenzelm@48365
   204
      put(name, Options.Bool, Properties.Value.Boolean(x))
wenzelm@48365
   205
  }
wenzelm@49954
   206
  val bool = new Bool_Access
wenzelm@48365
   207
wenzelm@49954
   208
  class Int_Access
wenzelm@48365
   209
  {
wenzelm@48365
   210
    def apply(name: String): Int = get(name, Options.Int, Properties.Value.Int.unapply)
wenzelm@48365
   211
    def update(name: String, x: Int): Options =
wenzelm@48365
   212
      put(name, Options.Int, Properties.Value.Int(x))
wenzelm@48365
   213
  }
wenzelm@49954
   214
  val int = new Int_Access
wenzelm@48365
   215
wenzelm@49954
   216
  class Real_Access
wenzelm@48365
   217
  {
wenzelm@48365
   218
    def apply(name: String): Double = get(name, Options.Real, Properties.Value.Double.unapply)
wenzelm@48365
   219
    def update(name: String, x: Double): Options =
wenzelm@48365
   220
      put(name, Options.Real, Properties.Value.Double(x))
wenzelm@48365
   221
  }
wenzelm@49954
   222
  val real = new Real_Access
wenzelm@48365
   223
wenzelm@49954
   224
  class String_Access
wenzelm@48365
   225
  {
wenzelm@48365
   226
    def apply(name: String): String = get(name, Options.String, s => Some(s))
wenzelm@48365
   227
    def update(name: String, x: String): Options = put(name, Options.String, x)
wenzelm@48365
   228
  }
wenzelm@49954
   229
  val string = new String_Access
wenzelm@48370
   230
wenzelm@50207
   231
  class Seconds_Access
wenzelm@50207
   232
  {
wenzelm@50207
   233
    def apply(name: String): Time = Time.seconds(real(name))
wenzelm@50207
   234
  }
wenzelm@50207
   235
  val seconds = new Seconds_Access
wenzelm@50207
   236
wenzelm@48370
   237
wenzelm@48807
   238
  /* external updates */
wenzelm@48370
   239
wenzelm@48370
   240
  private def check_value(name: String): Options =
wenzelm@48370
   241
  {
wenzelm@48370
   242
    val opt = check_name(name)
wenzelm@48370
   243
    opt.typ match {
wenzelm@48370
   244
      case Options.Bool => bool(name); this
wenzelm@48370
   245
      case Options.Int => int(name); this
wenzelm@48370
   246
      case Options.Real => real(name); this
wenzelm@48370
   247
      case Options.String => string(name); this
wenzelm@48860
   248
      case Options.Unknown => this
wenzelm@48370
   249
    }
wenzelm@48370
   250
  }
wenzelm@48370
   251
wenzelm@48370
   252
  def declare(name: String, typ_name: String, value: String, description: String = ""): Options =
wenzelm@48370
   253
  {
wenzelm@48370
   254
    options.get(name) match {
wenzelm@48370
   255
      case Some(_) => error("Duplicate declaration of option " + quote(name))
wenzelm@48370
   256
      case None =>
wenzelm@48370
   257
        val typ =
wenzelm@48370
   258
          typ_name match {
wenzelm@48370
   259
            case "bool" => Options.Bool
wenzelm@48370
   260
            case "int" => Options.Int
wenzelm@48370
   261
            case "real" => Options.Real
wenzelm@48370
   262
            case "string" => Options.String
wenzelm@48456
   263
            case _ => error("Unknown type for option " + quote(name) + " : " + quote(typ_name))
wenzelm@48370
   264
          }
wenzelm@49289
   265
        val opt = Options.Opt(name, typ, value, value, description, section)
wenzelm@49270
   266
        (new Options(options + (name -> opt), section)).check_value(name)
wenzelm@48370
   267
    }
wenzelm@48370
   268
  }
wenzelm@48370
   269
wenzelm@48860
   270
  def add_permissive(name: String, value: String): Options =
wenzelm@48860
   271
  {
wenzelm@48860
   272
    if (options.isDefinedAt(name)) this + (name, value)
wenzelm@49289
   273
    else
wenzelm@49289
   274
      new Options(
wenzelm@49289
   275
        options + (name -> Options.Opt(name, Options.Unknown, value, value, "", "")), section)
wenzelm@48860
   276
  }
wenzelm@48860
   277
wenzelm@48807
   278
  def + (name: String, value: String): Options =
wenzelm@48370
   279
  {
wenzelm@48370
   280
    val opt = check_name(name)
wenzelm@49270
   281
    (new Options(options + (name -> opt.copy(value = value)), section)).check_value(name)
wenzelm@48370
   282
  }
wenzelm@48370
   283
wenzelm@48807
   284
  def + (name: String, opt_value: Option[String]): Options =
wenzelm@48370
   285
  {
wenzelm@48370
   286
    val opt = check_name(name)
wenzelm@48370
   287
    opt_value match {
wenzelm@48807
   288
      case Some(value) => this + (name, value)
wenzelm@48807
   289
      case None if opt.typ == Options.Bool => this + (name, "true")
wenzelm@48370
   290
      case None => error("Missing value for option " + quote(name) + " : " + opt.typ.print)
wenzelm@48370
   291
    }
wenzelm@48370
   292
  }
wenzelm@48370
   293
wenzelm@48807
   294
  def + (str: String): Options =
wenzelm@48370
   295
  {
wenzelm@48370
   296
    str.indexOf('=') match {
wenzelm@48807
   297
      case -1 => this + (str, None)
wenzelm@48807
   298
      case i => this + (str.substring(0, i), str.substring(i + 1))
wenzelm@48370
   299
    }
wenzelm@48370
   300
  }
wenzelm@48456
   301
wenzelm@48807
   302
  def ++ (specs: List[Options.Spec]): Options =
wenzelm@48807
   303
    (this /: specs)({ case (x, (y, z)) => x + (y, z) })
wenzelm@48807
   304
wenzelm@48456
   305
wenzelm@49270
   306
  /* sections */
wenzelm@49270
   307
wenzelm@49270
   308
  def set_section(new_section: String): Options =
wenzelm@49270
   309
    new Options(options, new_section)
wenzelm@49270
   310
wenzelm@49270
   311
  def sections: List[(String, List[Options.Opt])] =
wenzelm@49270
   312
    options.groupBy(_._2.section).toList.map({ case (a, opts) => (a, opts.toList.map(_._2)) })
wenzelm@49270
   313
wenzelm@49270
   314
wenzelm@48456
   315
  /* encode */
wenzelm@48456
   316
wenzelm@48456
   317
  def encode: XML.Body =
wenzelm@48456
   318
  {
wenzelm@48860
   319
    val opts =
wenzelm@48860
   320
      for ((name, opt) <- options.toList; if !opt.unknown)
wenzelm@48860
   321
        yield (name, opt.typ.print, opt.value)
wenzelm@48860
   322
wenzelm@48456
   323
    import XML.Encode.{string => str, _}
wenzelm@48860
   324
    list(triple(str, str, str))(opts)
wenzelm@48456
   325
  }
wenzelm@48807
   326
wenzelm@48807
   327
wenzelm@48807
   328
  /* user preferences */
wenzelm@48807
   329
wenzelm@48807
   330
  def load_prefs(): Options =
wenzelm@48807
   331
    if (Options.PREFS.is_file)
wenzelm@48807
   332
      Options.Parser.parse_file(
wenzelm@48807
   333
        Options.prefs_syntax, Options.Parser.prefs_entry, this, Options.PREFS)
wenzelm@48807
   334
    else this
wenzelm@48807
   335
wenzelm@48807
   336
  def save_prefs()
wenzelm@48807
   337
  {
wenzelm@48860
   338
    val defaults = Options.init_defaults()
wenzelm@48807
   339
    val changed =
wenzelm@48807
   340
      (for {
wenzelm@48860
   341
        (name, opt2) <- options.iterator
wenzelm@48860
   342
        opt1 = defaults.options.get(name)
wenzelm@48860
   343
        if (opt1.isEmpty || opt1.get.value != opt2.value)
wenzelm@48860
   344
      } yield (name, opt2.value, if (opt1.isEmpty) "  (* unknown *)" else "")).toList
wenzelm@48860
   345
wenzelm@48807
   346
    val prefs =
wenzelm@48807
   347
      changed.sortBy(_._1)
wenzelm@48860
   348
        .map({ case (x, y, z) => x + " = " + Outer_Syntax.quote_string(y) + z + "\n" }).mkString
wenzelm@48807
   349
wenzelm@48807
   350
    Options.PREFS.file renameTo Options.PREFS_BACKUP.file
wenzelm@48807
   351
    File.write(Options.PREFS,
wenzelm@48807
   352
      "(* generated by Isabelle " + Calendar.getInstance.getTime + " *)\n\n" + prefs)
wenzelm@48807
   353
  }
wenzelm@48365
   354
}
wenzelm@49245
   355
wenzelm@49245
   356
wenzelm@49245
   357
class Options_Variable
wenzelm@49245
   358
{
wenzelm@49245
   359
  // owned by Swing thread
wenzelm@49245
   360
  @volatile private var options = Options.empty
wenzelm@49245
   361
wenzelm@49245
   362
  def value: Options = options
wenzelm@49245
   363
  def update(new_options: Options)
wenzelm@49245
   364
  {
wenzelm@49245
   365
    Swing_Thread.require()
wenzelm@49245
   366
    options = new_options
wenzelm@49245
   367
  }
wenzelm@49245
   368
wenzelm@49245
   369
  def + (name: String, x: String)
wenzelm@49245
   370
  {
wenzelm@49245
   371
    Swing_Thread.require()
wenzelm@49245
   372
    options = options + (name, x)
wenzelm@49245
   373
  }
wenzelm@49245
   374
wenzelm@49954
   375
  class Bool_Access
wenzelm@49245
   376
  {
wenzelm@49245
   377
    def apply(name: String): Boolean = options.bool(name)
wenzelm@49245
   378
    def update(name: String, x: Boolean)
wenzelm@49245
   379
    {
wenzelm@49245
   380
      Swing_Thread.require()
wenzelm@49245
   381
      options = options.bool.update(name, x)
wenzelm@49245
   382
    }
wenzelm@49245
   383
  }
wenzelm@49954
   384
  val bool = new Bool_Access
wenzelm@49245
   385
wenzelm@49954
   386
  class Int_Access
wenzelm@49245
   387
  {
wenzelm@49245
   388
    def apply(name: String): Int = options.int(name)
wenzelm@49245
   389
    def update(name: String, x: Int)
wenzelm@49245
   390
    {
wenzelm@49245
   391
      Swing_Thread.require()
wenzelm@49245
   392
      options = options.int.update(name, x)
wenzelm@49245
   393
    }
wenzelm@49245
   394
  }
wenzelm@49954
   395
  val int = new Int_Access
wenzelm@49245
   396
wenzelm@49954
   397
  class Real_Access
wenzelm@49245
   398
  {
wenzelm@49245
   399
    def apply(name: String): Double = options.real(name)
wenzelm@49245
   400
    def update(name: String, x: Double)
wenzelm@49245
   401
    {
wenzelm@49245
   402
      Swing_Thread.require()
wenzelm@49245
   403
      options = options.real.update(name, x)
wenzelm@49245
   404
    }
wenzelm@49245
   405
  }
wenzelm@49954
   406
  val real = new Real_Access
wenzelm@49245
   407
wenzelm@49954
   408
  class String_Access
wenzelm@49245
   409
  {
wenzelm@49245
   410
    def apply(name: String): String = options.string(name)
wenzelm@49245
   411
    def update(name: String, x: String)
wenzelm@49245
   412
    {
wenzelm@49245
   413
      Swing_Thread.require()
wenzelm@49245
   414
      options = options.string.update(name, x)
wenzelm@49245
   415
    }
wenzelm@49245
   416
  }
wenzelm@49954
   417
  val string = new String_Access
wenzelm@50207
   418
wenzelm@50207
   419
  class Seconds_Access
wenzelm@50207
   420
  {
wenzelm@50207
   421
    def apply(name: String): Time = options.seconds(name)
wenzelm@50207
   422
  }
wenzelm@50207
   423
  val seconds = new Seconds_Access
wenzelm@49245
   424
}
wenzelm@49245
   425