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