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