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