src/Pure/System/options.scala
author wenzelm
Tue, 13 Mar 2018 17:15:01 +0100
changeset 67845 46fa8c2c142a
parent 67178 70576478bda9
child 67847 c61acb4855b6
permissions -rw-r--r--
more flexible preferences: avoid hardwired file; tuned signature;
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
48365
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
     1
/*  Title:      Pure/System/options.scala
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
     2
    Author:     Makarius
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
     3
51945
5b1ac9843f02 tuned comments;
wenzelm
parents: 51620
diff changeset
     4
System options with external string representation.
48365
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
     5
*/
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
     6
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
     7
package isabelle
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
     8
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
     9
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
    10
object Options
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
    11
{
48421
c4d337782de4 propagate defined options;
wenzelm
parents: 48411
diff changeset
    12
  type Spec = (String, Option[String])
c4d337782de4 propagate defined options;
wenzelm
parents: 48411
diff changeset
    13
c4d337782de4 propagate defined options;
wenzelm
parents: 48411
diff changeset
    14
  val empty: Options = new Options()
c4d337782de4 propagate defined options;
wenzelm
parents: 48411
diff changeset
    15
c4d337782de4 propagate defined options;
wenzelm
parents: 48411
diff changeset
    16
c4d337782de4 propagate defined options;
wenzelm
parents: 48411
diff changeset
    17
  /* representation */
c4d337782de4 propagate defined options;
wenzelm
parents: 48411
diff changeset
    18
c4d337782de4 propagate defined options;
wenzelm
parents: 48411
diff changeset
    19
  sealed abstract class Type
48365
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
    20
  {
56599
c4424d8c890f tuned signature -- separate module Word;
wenzelm
parents: 56559
diff changeset
    21
    def print: String = Word.lowercase(toString)
48365
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
    22
  }
49246
248e66e8321f more systematic JEdit_Options.make_component;
wenzelm
parents: 49245
diff changeset
    23
  case object Bool extends Type
248e66e8321f more systematic JEdit_Options.make_component;
wenzelm
parents: 49245
diff changeset
    24
  case object Int extends Type
248e66e8321f more systematic JEdit_Options.make_component;
wenzelm
parents: 49245
diff changeset
    25
  case object Real extends Type
248e66e8321f more systematic JEdit_Options.make_component;
wenzelm
parents: 49245
diff changeset
    26
  case object String extends Type
248e66e8321f more systematic JEdit_Options.make_component;
wenzelm
parents: 49245
diff changeset
    27
  case object Unknown extends Type
48365
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
    28
56465
6ad693903e22 more positions and markup;
wenzelm
parents: 55618
diff changeset
    29
  case class Opt(
6ad693903e22 more positions and markup;
wenzelm
parents: 55618
diff changeset
    30
    public: Boolean,
6ad693903e22 more positions and markup;
wenzelm
parents: 55618
diff changeset
    31
    pos: Position.T,
6ad693903e22 more positions and markup;
wenzelm
parents: 55618
diff changeset
    32
    name: String,
6ad693903e22 more positions and markup;
wenzelm
parents: 55618
diff changeset
    33
    typ: Type,
6ad693903e22 more positions and markup;
wenzelm
parents: 55618
diff changeset
    34
    value: String,
6ad693903e22 more positions and markup;
wenzelm
parents: 55618
diff changeset
    35
    default_value: String,
6ad693903e22 more positions and markup;
wenzelm
parents: 55618
diff changeset
    36
    description: String,
6ad693903e22 more positions and markup;
wenzelm
parents: 55618
diff changeset
    37
    section: String)
48860
56ec76f769c0 retain unknown options within preferences;
wenzelm
parents: 48807
diff changeset
    38
  {
49289
60424f123621 more informative tooltip: default value;
wenzelm
parents: 49270
diff changeset
    39
    private def print(default: Boolean): String =
60424f123621 more informative tooltip: default value;
wenzelm
parents: 49270
diff changeset
    40
    {
60424f123621 more informative tooltip: default value;
wenzelm
parents: 49270
diff changeset
    41
      val x = if (default) default_value else value
49247
ffd9ad9dc35b more detailed option tooltip;
wenzelm
parents: 49246
diff changeset
    42
      "option " + name + " : " + typ.print + " = " +
49289
60424f123621 more informative tooltip: default value;
wenzelm
parents: 49270
diff changeset
    43
        (if (typ == Options.String) quote(x) else x) +
60424f123621 more informative tooltip: default value;
wenzelm
parents: 49270
diff changeset
    44
        (if (description == "") "" else "\n  -- " + quote(description))
60424f123621 more informative tooltip: default value;
wenzelm
parents: 49270
diff changeset
    45
    }
60424f123621 more informative tooltip: default value;
wenzelm
parents: 49270
diff changeset
    46
60424f123621 more informative tooltip: default value;
wenzelm
parents: 49270
diff changeset
    47
    def print: String = print(false)
60424f123621 more informative tooltip: default value;
wenzelm
parents: 49270
diff changeset
    48
    def print_default: String = print(true)
49247
ffd9ad9dc35b more detailed option tooltip;
wenzelm
parents: 49246
diff changeset
    49
56559
eece73c31e38 added dictionaries_selector GUI;
wenzelm
parents: 56552
diff changeset
    50
    def title(strip: String = ""): String =
49270
e5d162d15867 some support to organize options in sections;
wenzelm
parents: 49247
diff changeset
    51
    {
56600
628e039cc34d more specific support for sequence of words;
wenzelm
parents: 56599
diff changeset
    52
      val words = Word.explode('_', name)
49270
e5d162d15867 some support to organize options in sections;
wenzelm
parents: 49247
diff changeset
    53
      val words1 =
e5d162d15867 some support to organize options in sections;
wenzelm
parents: 49247
diff changeset
    54
        words match {
e5d162d15867 some support to organize options in sections;
wenzelm
parents: 49247
diff changeset
    55
          case word :: rest if word == strip => rest
e5d162d15867 some support to organize options in sections;
wenzelm
parents: 49247
diff changeset
    56
          case _ => words
e5d162d15867 some support to organize options in sections;
wenzelm
parents: 49247
diff changeset
    57
        }
56609
5ac67041ccf8 capitalize more carefully, e.g. relevant for option "ML_exception_trace";
wenzelm
parents: 56600
diff changeset
    58
      Word.implode(words1.map(Word.perhaps_capitalize(_)))
49270
e5d162d15867 some support to organize options in sections;
wenzelm
parents: 49247
diff changeset
    59
    }
e5d162d15867 some support to organize options in sections;
wenzelm
parents: 49247
diff changeset
    60
48860
56ec76f769c0 retain unknown options within preferences;
wenzelm
parents: 48807
diff changeset
    61
    def unknown: Boolean = typ == Unknown
56ec76f769c0 retain unknown options within preferences;
wenzelm
parents: 48807
diff changeset
    62
  }
48365
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
    63
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
    64
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
    65
  /* parsing */
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
    66
49270
e5d162d15867 some support to organize options in sections;
wenzelm
parents: 49247
diff changeset
    67
  private val SECTION = "section"
52065
78f2475aa126 explicit notion of public options, which are shown in the editor options dialog;
wenzelm
parents: 51945
diff changeset
    68
  private val PUBLIC = "public"
48795
bece259ee055 clarified format of etc/options: only declarations, not re-definitions;
wenzelm
parents: 48718
diff changeset
    69
  private val OPTION = "option"
48807
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
    70
  private val OPTIONS = Path.explode("etc/options")
67845
46fa8c2c142a more flexible preferences: avoid hardwired file;
wenzelm
parents: 67178
diff changeset
    71
  private val PREFS = Path.explode("$ISABELLE_HOME_USER/etc/preferences")
48713
de26cf3191a3 more token markers, based on actual outer syntax;
wenzelm
parents: 48693
diff changeset
    72
67004
af72fa58f71b clarified lazy Completion within Outer_Syntax: measurable speedup of Sessions.deps;
wenzelm
parents: 66984
diff changeset
    73
  val options_syntax =
af72fa58f71b clarified lazy Completion within Outer_Syntax: measurable speedup of Sessions.deps;
wenzelm
parents: 66984
diff changeset
    74
    Outer_Syntax.empty + ":" + "=" + "--" + Symbol.comment + Symbol.comment_decoded +
63441
4c3fa4dba79f explicit kind "before_command";
wenzelm
parents: 62968
diff changeset
    75
      (SECTION, Keyword.DOCUMENT_HEADING) +
4c3fa4dba79f explicit kind "before_command";
wenzelm
parents: 62968
diff changeset
    76
      (PUBLIC, Keyword.BEFORE_COMMAND) +
4c3fa4dba79f explicit kind "before_command";
wenzelm
parents: 62968
diff changeset
    77
      (OPTION, Keyword.THY_DECL)
49270
e5d162d15867 some support to organize options in sections;
wenzelm
parents: 49247
diff changeset
    78
67004
af72fa58f71b clarified lazy Completion within Outer_Syntax: measurable speedup of Sessions.deps;
wenzelm
parents: 66984
diff changeset
    79
  val prefs_syntax = Outer_Syntax.empty + "="
48713
de26cf3191a3 more token markers, based on actual outer syntax;
wenzelm
parents: 48693
diff changeset
    80
62968
4e4738698db4 clarified syntax;
wenzelm
parents: 62832
diff changeset
    81
  trait Parser extends Parse.Parser
48365
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
    82
  {
62968
4e4738698db4 clarified syntax;
wenzelm
parents: 62832
diff changeset
    83
    val option_name = atom("option name", _.is_name)
4e4738698db4 clarified syntax;
wenzelm
parents: 62832
diff changeset
    84
    val option_type = atom("option type", _.is_name)
48807
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
    85
    val option_value =
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
    86
      opt(token("-", tok => tok.is_sym_ident && tok.content == "-")) ~ atom("nat", _.is_nat) ^^
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
    87
        { case s ~ n => if (s.isDefined) "-" + n else n } |
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
    88
      atom("option value", tok => tok.is_name || tok.is_float)
62968
4e4738698db4 clarified syntax;
wenzelm
parents: 62832
diff changeset
    89
  }
48807
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
    90
62968
4e4738698db4 clarified syntax;
wenzelm
parents: 62832
diff changeset
    91
  object Parser extends Parse.Parser with Parser
4e4738698db4 clarified syntax;
wenzelm
parents: 62832
diff changeset
    92
  {
61579
634cd44bb1d3 symbolic syntax "\<comment> text";
wenzelm
parents: 60215
diff changeset
    93
    def comment_marker: Parser[String] =
634cd44bb1d3 symbolic syntax "\<comment> text";
wenzelm
parents: 60215
diff changeset
    94
      $$$("--") | $$$(Symbol.comment) | $$$(Symbol.comment_decoded)
634cd44bb1d3 symbolic syntax "\<comment> text";
wenzelm
parents: 60215
diff changeset
    95
48807
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
    96
    val option_entry: Parser[Options => Options] =
48365
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
    97
    {
49270
e5d162d15867 some support to organize options in sections;
wenzelm
parents: 49247
diff changeset
    98
      command(SECTION) ~! text ^^
49295
2750756db9c5 more precise sections;
wenzelm
parents: 49289
diff changeset
    99
        { case _ ~ a => (options: Options) => options.set_section(a) } |
60133
a90982bbe8b4 clarified keywords for quasi-command spans and Sidekick structure;
wenzelm
parents: 59811
diff changeset
   100
      opt($$$(PUBLIC)) ~ command(OPTION) ~! (position(option_name) ~ $$$(":") ~ option_type ~
61579
634cd44bb1d3 symbolic syntax "\<comment> text";
wenzelm
parents: 60215
diff changeset
   101
      $$$("=") ~ option_value ~ (comment_marker ~! text ^^ { case _ ~ x => x } | success(""))) ^^
59811
6b0d9e8ac227 clarified position;
wenzelm
parents: 59705
diff changeset
   102
        { case a ~ _ ~ ((b, pos) ~ _ ~ c ~ _ ~ d ~ e) =>
56465
6ad693903e22 more positions and markup;
wenzelm
parents: 55618
diff changeset
   103
            (options: Options) => options.declare(a.isDefined, pos, b, c, d, e) }
48365
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   104
    }
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   105
48807
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
   106
    val prefs_entry: Parser[Options => Options] =
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
   107
    {
58908
58bedbc18915 tuned signature;
wenzelm
parents: 58868
diff changeset
   108
      option_name ~ ($$$("=") ~! option_value) ^^
48860
56ec76f769c0 retain unknown options within preferences;
wenzelm
parents: 48807
diff changeset
   109
      { case a ~ (_ ~ b) => (options: Options) => options.add_permissive(a, b) }
48807
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
   110
    }
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
   111
67845
46fa8c2c142a more flexible preferences: avoid hardwired file;
wenzelm
parents: 67178
diff changeset
   112
    def parse_file(options: Options, file_name: String, content: String,
46fa8c2c142a more flexible preferences: avoid hardwired file;
wenzelm
parents: 67178
diff changeset
   113
      syntax: Outer_Syntax = options_syntax,
46fa8c2c142a more flexible preferences: avoid hardwired file;
wenzelm
parents: 67178
diff changeset
   114
      parser: Parser[Options => Options] = option_entry): Options =
48365
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   115
    {
67845
46fa8c2c142a more flexible preferences: avoid hardwired file;
wenzelm
parents: 67178
diff changeset
   116
      val toks = Token.explode(syntax.keywords, content)
48807
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
   117
      val ops =
67845
46fa8c2c142a more flexible preferences: avoid hardwired file;
wenzelm
parents: 67178
diff changeset
   118
        parse_all(rep(parser), Token.reader(toks, Token.Pos.file(file_name))) match {
48807
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
   119
          case Success(result, _) => result
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
   120
          case bad => error(bad.toString)
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
   121
        }
49270
e5d162d15867 some support to organize options in sections;
wenzelm
parents: 49247
diff changeset
   122
      try { (options.set_section("") /: ops) { case (opts, op) => op(opts) } }
67845
46fa8c2c142a more flexible preferences: avoid hardwired file;
wenzelm
parents: 67178
diff changeset
   123
      catch { case ERROR(msg) => error(msg + Position.File(file_name)) }
48365
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   124
    }
67845
46fa8c2c142a more flexible preferences: avoid hardwired file;
wenzelm
parents: 67178
diff changeset
   125
46fa8c2c142a more flexible preferences: avoid hardwired file;
wenzelm
parents: 67178
diff changeset
   126
    def parse_prefs(options: Options, content: String): Options =
46fa8c2c142a more flexible preferences: avoid hardwired file;
wenzelm
parents: 67178
diff changeset
   127
      parse_file(options, PREFS.base_name, content, syntax = prefs_syntax, parser = prefs_entry)
48365
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   128
  }
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   129
67845
46fa8c2c142a more flexible preferences: avoid hardwired file;
wenzelm
parents: 67178
diff changeset
   130
  def read_prefs(file: Path = PREFS): String =
46fa8c2c142a more flexible preferences: avoid hardwired file;
wenzelm
parents: 67178
diff changeset
   131
    if (file.is_file) File.read(file) else ""
64186
49816908ae42 support for separate sub-system options, independent of main Isabelle options;
wenzelm
parents: 64151
diff changeset
   132
67845
46fa8c2c142a more flexible preferences: avoid hardwired file;
wenzelm
parents: 67178
diff changeset
   133
  def init(prefs: String = read_prefs(PREFS)): Options =
48365
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   134
  {
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   135
    var options = empty
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   136
    for {
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   137
      dir <- Isabelle_System.components()
48548
49afe0e92163 simplified Path vs. JVM File operations;
wenzelm
parents: 48457
diff changeset
   138
      file = dir + OPTIONS if file.is_file
67845
46fa8c2c142a more flexible preferences: avoid hardwired file;
wenzelm
parents: 67178
diff changeset
   139
    } { options = Parser.parse_file(options, file.implode, File.read(file)) }
46fa8c2c142a more flexible preferences: avoid hardwired file;
wenzelm
parents: 67178
diff changeset
   140
    Options.Parser.parse_prefs(options, prefs)
48365
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   141
  }
48457
fd9e28d5a143 pass build options to ML;
wenzelm
parents: 48456
diff changeset
   142
fd9e28d5a143 pass build options to ML;
wenzelm
parents: 48456
diff changeset
   143
fd9e28d5a143 pass build options to ML;
wenzelm
parents: 48456
diff changeset
   144
  /* encode */
fd9e28d5a143 pass build options to ML;
wenzelm
parents: 48456
diff changeset
   145
fd9e28d5a143 pass build options to ML;
wenzelm
parents: 48456
diff changeset
   146
  val encode: XML.Encode.T[Options] = (options => options.encode)
48693
ceeea46bdeba "isabelle options" prints Isabelle system options;
wenzelm
parents: 48605
diff changeset
   147
ceeea46bdeba "isabelle options" prints Isabelle system options;
wenzelm
parents: 48605
diff changeset
   148
62832
c1410bcf6e87 prefer internal tool;
wenzelm
parents: 62454
diff changeset
   149
  /* Isabelle tool wrapper */
48693
ceeea46bdeba "isabelle options" prints Isabelle system options;
wenzelm
parents: 48605
diff changeset
   150
66669
bbcb75c58086 proper tool name (cf. c1410bcf6e87);
wenzelm
parents: 65236
diff changeset
   151
  val isabelle_tool = Isabelle_Tool("options", "print Isabelle system options", args =>
48693
ceeea46bdeba "isabelle options" prints Isabelle system options;
wenzelm
parents: 48605
diff changeset
   152
  {
62832
c1410bcf6e87 prefer internal tool;
wenzelm
parents: 62454
diff changeset
   153
    var build_options = false
c1410bcf6e87 prefer internal tool;
wenzelm
parents: 62454
diff changeset
   154
    var get_option = ""
c1410bcf6e87 prefer internal tool;
wenzelm
parents: 62454
diff changeset
   155
    var list_options = false
c1410bcf6e87 prefer internal tool;
wenzelm
parents: 62454
diff changeset
   156
    var export_file = ""
62437
bccad0374407 moved getopts to Scala;
wenzelm
parents: 62227
diff changeset
   157
62832
c1410bcf6e87 prefer internal tool;
wenzelm
parents: 62454
diff changeset
   158
    val getopts = Getopts("""
62437
bccad0374407 moved getopts to Scala;
wenzelm
parents: 62227
diff changeset
   159
Usage: isabelle options [OPTIONS] [MORE_OPTIONS ...]
48693
ceeea46bdeba "isabelle options" prints Isabelle system options;
wenzelm
parents: 48605
diff changeset
   160
62437
bccad0374407 moved getopts to Scala;
wenzelm
parents: 62227
diff changeset
   161
  Options are:
bccad0374407 moved getopts to Scala;
wenzelm
parents: 62227
diff changeset
   162
    -b           include $ISABELLE_BUILD_OPTIONS
bccad0374407 moved getopts to Scala;
wenzelm
parents: 62227
diff changeset
   163
    -g OPTION    get value of OPTION
bccad0374407 moved getopts to Scala;
wenzelm
parents: 62227
diff changeset
   164
    -l           list options
bccad0374407 moved getopts to Scala;
wenzelm
parents: 62227
diff changeset
   165
    -x FILE      export options to FILE in YXML format
bccad0374407 moved getopts to Scala;
wenzelm
parents: 62227
diff changeset
   166
bccad0374407 moved getopts to Scala;
wenzelm
parents: 62227
diff changeset
   167
  Report Isabelle system options, augmented by MORE_OPTIONS given as
bccad0374407 moved getopts to Scala;
wenzelm
parents: 62227
diff changeset
   168
  arguments NAME=VAL or NAME.
bccad0374407 moved getopts to Scala;
wenzelm
parents: 62227
diff changeset
   169
""",
62832
c1410bcf6e87 prefer internal tool;
wenzelm
parents: 62454
diff changeset
   170
      "b" -> (_ => build_options = true),
c1410bcf6e87 prefer internal tool;
wenzelm
parents: 62454
diff changeset
   171
      "g:" -> (arg => get_option = arg),
c1410bcf6e87 prefer internal tool;
wenzelm
parents: 62454
diff changeset
   172
      "l" -> (_ => list_options = true),
c1410bcf6e87 prefer internal tool;
wenzelm
parents: 62454
diff changeset
   173
      "x:" -> (arg => export_file = arg))
52737
7b396ef36af6 clarified meaning of options for "isabelle options";
wenzelm
parents: 52735
diff changeset
   174
62832
c1410bcf6e87 prefer internal tool;
wenzelm
parents: 62454
diff changeset
   175
    val more_options = getopts(args)
c1410bcf6e87 prefer internal tool;
wenzelm
parents: 62454
diff changeset
   176
    if (get_option == "" && !list_options && export_file == "") getopts.usage()
52737
7b396ef36af6 clarified meaning of options for "isabelle options";
wenzelm
parents: 52735
diff changeset
   177
62832
c1410bcf6e87 prefer internal tool;
wenzelm
parents: 62454
diff changeset
   178
    val options =
c1410bcf6e87 prefer internal tool;
wenzelm
parents: 62454
diff changeset
   179
    {
c1410bcf6e87 prefer internal tool;
wenzelm
parents: 62454
diff changeset
   180
      val options0 = Options.init()
c1410bcf6e87 prefer internal tool;
wenzelm
parents: 62454
diff changeset
   181
      val options1 =
c1410bcf6e87 prefer internal tool;
wenzelm
parents: 62454
diff changeset
   182
        if (build_options)
c1410bcf6e87 prefer internal tool;
wenzelm
parents: 62454
diff changeset
   183
          (options0 /: Word.explode(Isabelle_System.getenv("ISABELLE_BUILD_OPTIONS")))(_ + _)
c1410bcf6e87 prefer internal tool;
wenzelm
parents: 62454
diff changeset
   184
        else options0
c1410bcf6e87 prefer internal tool;
wenzelm
parents: 62454
diff changeset
   185
      (options1 /: more_options)(_ + _)
c1410bcf6e87 prefer internal tool;
wenzelm
parents: 62454
diff changeset
   186
    }
48693
ceeea46bdeba "isabelle options" prints Isabelle system options;
wenzelm
parents: 48605
diff changeset
   187
62832
c1410bcf6e87 prefer internal tool;
wenzelm
parents: 62454
diff changeset
   188
    if (get_option != "")
67178
70576478bda9 avoid println with its extra CR on Windows;
wenzelm
parents: 67004
diff changeset
   189
      Output.writeln(options.check_name(get_option).value, stdout = true)
62437
bccad0374407 moved getopts to Scala;
wenzelm
parents: 62227
diff changeset
   190
62832
c1410bcf6e87 prefer internal tool;
wenzelm
parents: 62454
diff changeset
   191
    if (export_file != "")
c1410bcf6e87 prefer internal tool;
wenzelm
parents: 62454
diff changeset
   192
      File.write(Path.explode(export_file), YXML.string_of_body(options.encode))
62437
bccad0374407 moved getopts to Scala;
wenzelm
parents: 62227
diff changeset
   193
62832
c1410bcf6e87 prefer internal tool;
wenzelm
parents: 62454
diff changeset
   194
    if (get_option == "" && export_file == "")
67178
70576478bda9 avoid println with its extra CR on Windows;
wenzelm
parents: 67004
diff changeset
   195
      Output.writeln(options.print, stdout = true)
62832
c1410bcf6e87 prefer internal tool;
wenzelm
parents: 62454
diff changeset
   196
  })
48365
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   197
}
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   198
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   199
49270
e5d162d15867 some support to organize options in sections;
wenzelm
parents: 49247
diff changeset
   200
final class Options private(
49296
313369027391 some GUI support for color options;
wenzelm
parents: 49295
diff changeset
   201
  val options: Map[String, Options.Opt] = Map.empty,
49270
e5d162d15867 some support to organize options in sections;
wenzelm
parents: 49247
diff changeset
   202
  val section: String = "")
48365
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   203
{
64186
49816908ae42 support for separate sub-system options, independent of main Isabelle options;
wenzelm
parents: 64151
diff changeset
   204
  override def toString: String = options.iterator.mkString("Options(", ",", ")")
48365
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   205
54347
d5589530f3ba clarified isabelle options -l;
wenzelm
parents: 53336
diff changeset
   206
  private def print_opt(opt: Options.Opt): String =
d5589530f3ba clarified isabelle options -l;
wenzelm
parents: 53336
diff changeset
   207
    if (opt.public) "public " + opt.print else opt.print
d5589530f3ba clarified isabelle options -l;
wenzelm
parents: 53336
diff changeset
   208
d5589530f3ba clarified isabelle options -l;
wenzelm
parents: 53336
diff changeset
   209
  def print: String = cat_lines(options.toList.sortBy(_._1).map(p => print_opt(p._2)))
48693
ceeea46bdeba "isabelle options" prints Isabelle system options;
wenzelm
parents: 48605
diff changeset
   210
49245
cb70157293c0 manage Isabelle/jEdit options as Isabelle/Scala options (with persistent preferences);
wenzelm
parents: 48992
diff changeset
   211
  def description(name: String): String = check_name(name).description
cb70157293c0 manage Isabelle/jEdit options as Isabelle/Scala options (with persistent preferences);
wenzelm
parents: 48992
diff changeset
   212
48365
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   213
48370
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   214
  /* check */
48365
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   215
49246
248e66e8321f more systematic JEdit_Options.make_component;
wenzelm
parents: 49245
diff changeset
   216
  def check_name(name: String): Options.Opt =
48365
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   217
    options.get(name) match {
48860
56ec76f769c0 retain unknown options within preferences;
wenzelm
parents: 48807
diff changeset
   218
      case Some(opt) if !opt.unknown => opt
56ec76f769c0 retain unknown options within preferences;
wenzelm
parents: 48807
diff changeset
   219
      case _ => error("Unknown option " + quote(name))
48365
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   220
    }
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   221
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   222
  private def check_type(name: String, typ: Options.Type): Options.Opt =
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   223
  {
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   224
    val opt = check_name(name)
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   225
    if (opt.typ == typ) opt
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   226
    else error("Ill-typed option " + quote(name) + " : " + opt.typ.print + " vs. " + typ.print)
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   227
  }
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   228
48370
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   229
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   230
  /* basic operations */
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   231
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   232
  private def put[A](name: String, typ: Options.Type, value: String): Options =
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   233
  {
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   234
    val opt = check_type(name, typ)
49270
e5d162d15867 some support to organize options in sections;
wenzelm
parents: 49247
diff changeset
   235
    new Options(options + (name -> opt.copy(value = value)), section)
48370
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   236
  }
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   237
48365
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   238
  private def get[A](name: String, typ: Options.Type, parse: String => Option[A]): A =
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   239
  {
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   240
    val opt = check_type(name, typ)
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   241
    parse(opt.value) match {
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   242
      case Some(x) => x
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   243
      case None =>
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   244
        error("Malformed value for option " + quote(name) +
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   245
          " : " + typ.print + " =\n" + quote(opt.value))
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   246
    }
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   247
  }
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   248
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   249
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   250
  /* internal lookup and update */
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   251
49954
44658062d822 more explicit auxiliary classes to avoid warning "reflective access of structural type member method" of scala-2.10.0-RC1;
wenzelm
parents: 49296
diff changeset
   252
  class Bool_Access
48365
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   253
  {
63805
c272680df665 clarified modules;
wenzelm
parents: 63441
diff changeset
   254
    def apply(name: String): Boolean = get(name, Options.Bool, Value.Boolean.unapply)
48365
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   255
    def update(name: String, x: Boolean): Options =
63805
c272680df665 clarified modules;
wenzelm
parents: 63441
diff changeset
   256
      put(name, Options.Bool, Value.Boolean(x))
48365
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   257
  }
49954
44658062d822 more explicit auxiliary classes to avoid warning "reflective access of structural type member method" of scala-2.10.0-RC1;
wenzelm
parents: 49296
diff changeset
   258
  val bool = new Bool_Access
48365
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   259
49954
44658062d822 more explicit auxiliary classes to avoid warning "reflective access of structural type member method" of scala-2.10.0-RC1;
wenzelm
parents: 49296
diff changeset
   260
  class Int_Access
48365
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   261
  {
63805
c272680df665 clarified modules;
wenzelm
parents: 63441
diff changeset
   262
    def apply(name: String): Int = get(name, Options.Int, Value.Int.unapply)
48365
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   263
    def update(name: String, x: Int): Options =
63805
c272680df665 clarified modules;
wenzelm
parents: 63441
diff changeset
   264
      put(name, Options.Int, Value.Int(x))
48365
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   265
  }
49954
44658062d822 more explicit auxiliary classes to avoid warning "reflective access of structural type member method" of scala-2.10.0-RC1;
wenzelm
parents: 49296
diff changeset
   266
  val int = new Int_Access
48365
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   267
49954
44658062d822 more explicit auxiliary classes to avoid warning "reflective access of structural type member method" of scala-2.10.0-RC1;
wenzelm
parents: 49296
diff changeset
   268
  class Real_Access
48365
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   269
  {
63805
c272680df665 clarified modules;
wenzelm
parents: 63441
diff changeset
   270
    def apply(name: String): Double = get(name, Options.Real, Value.Double.unapply)
48365
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   271
    def update(name: String, x: Double): Options =
63805
c272680df665 clarified modules;
wenzelm
parents: 63441
diff changeset
   272
      put(name, Options.Real, Value.Double(x))
48365
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   273
  }
49954
44658062d822 more explicit auxiliary classes to avoid warning "reflective access of structural type member method" of scala-2.10.0-RC1;
wenzelm
parents: 49296
diff changeset
   274
  val real = new Real_Access
48365
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   275
49954
44658062d822 more explicit auxiliary classes to avoid warning "reflective access of structural type member method" of scala-2.10.0-RC1;
wenzelm
parents: 49296
diff changeset
   276
  class String_Access
48365
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   277
  {
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   278
    def apply(name: String): String = get(name, Options.String, s => Some(s))
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   279
    def update(name: String, x: String): Options = put(name, Options.String, x)
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   280
  }
49954
44658062d822 more explicit auxiliary classes to avoid warning "reflective access of structural type member method" of scala-2.10.0-RC1;
wenzelm
parents: 49296
diff changeset
   281
  val string = new String_Access
48370
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   282
50207
54be125d8cdc tuned signature;
wenzelm
parents: 49954
diff changeset
   283
  class Seconds_Access
54be125d8cdc tuned signature;
wenzelm
parents: 49954
diff changeset
   284
  {
54be125d8cdc tuned signature;
wenzelm
parents: 49954
diff changeset
   285
    def apply(name: String): Time = Time.seconds(real(name))
54be125d8cdc tuned signature;
wenzelm
parents: 49954
diff changeset
   286
  }
54be125d8cdc tuned signature;
wenzelm
parents: 49954
diff changeset
   287
  val seconds = new Seconds_Access
54be125d8cdc tuned signature;
wenzelm
parents: 49954
diff changeset
   288
48370
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   289
48807
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
   290
  /* external updates */
48370
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   291
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   292
  private def check_value(name: String): Options =
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   293
  {
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   294
    val opt = check_name(name)
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   295
    opt.typ match {
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   296
      case Options.Bool => bool(name); this
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   297
      case Options.Int => int(name); this
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   298
      case Options.Real => real(name); this
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   299
      case Options.String => string(name); this
48860
56ec76f769c0 retain unknown options within preferences;
wenzelm
parents: 48807
diff changeset
   300
      case Options.Unknown => this
48370
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   301
    }
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   302
  }
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   303
56465
6ad693903e22 more positions and markup;
wenzelm
parents: 55618
diff changeset
   304
  def declare(
6ad693903e22 more positions and markup;
wenzelm
parents: 55618
diff changeset
   305
    public: Boolean,
6ad693903e22 more positions and markup;
wenzelm
parents: 55618
diff changeset
   306
    pos: Position.T,
6ad693903e22 more positions and markup;
wenzelm
parents: 55618
diff changeset
   307
    name: String,
6ad693903e22 more positions and markup;
wenzelm
parents: 55618
diff changeset
   308
    typ_name: String,
6ad693903e22 more positions and markup;
wenzelm
parents: 55618
diff changeset
   309
    value: String,
6ad693903e22 more positions and markup;
wenzelm
parents: 55618
diff changeset
   310
    description: String): Options =
48370
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   311
  {
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   312
    options.get(name) match {
56465
6ad693903e22 more positions and markup;
wenzelm
parents: 55618
diff changeset
   313
      case Some(other) =>
6ad693903e22 more positions and markup;
wenzelm
parents: 55618
diff changeset
   314
        error("Duplicate declaration of option " + quote(name) + Position.here(pos) +
6ad693903e22 more positions and markup;
wenzelm
parents: 55618
diff changeset
   315
          Position.here(other.pos))
48370
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   316
      case None =>
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   317
        val typ =
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   318
          typ_name match {
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   319
            case "bool" => Options.Bool
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   320
            case "int" => Options.Int
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   321
            case "real" => Options.Real
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   322
            case "string" => Options.String
56465
6ad693903e22 more positions and markup;
wenzelm
parents: 55618
diff changeset
   323
            case _ =>
6ad693903e22 more positions and markup;
wenzelm
parents: 55618
diff changeset
   324
              error("Unknown type for option " + quote(name) + " : " + quote(typ_name) +
6ad693903e22 more positions and markup;
wenzelm
parents: 55618
diff changeset
   325
                Position.here(pos))
48370
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   326
          }
56465
6ad693903e22 more positions and markup;
wenzelm
parents: 55618
diff changeset
   327
        val opt = Options.Opt(public, pos, name, typ, value, value, description, section)
49270
e5d162d15867 some support to organize options in sections;
wenzelm
parents: 49247
diff changeset
   328
        (new Options(options + (name -> opt), section)).check_value(name)
48370
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   329
    }
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   330
  }
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   331
48860
56ec76f769c0 retain unknown options within preferences;
wenzelm
parents: 48807
diff changeset
   332
  def add_permissive(name: String, value: String): Options =
56ec76f769c0 retain unknown options within preferences;
wenzelm
parents: 48807
diff changeset
   333
  {
56ec76f769c0 retain unknown options within preferences;
wenzelm
parents: 48807
diff changeset
   334
    if (options.isDefinedAt(name)) this + (name, value)
56465
6ad693903e22 more positions and markup;
wenzelm
parents: 55618
diff changeset
   335
    else {
6ad693903e22 more positions and markup;
wenzelm
parents: 55618
diff changeset
   336
      val opt = Options.Opt(false, Position.none, name, Options.Unknown, value, value, "", "")
6ad693903e22 more positions and markup;
wenzelm
parents: 55618
diff changeset
   337
      new Options(options + (name -> opt), section)
6ad693903e22 more positions and markup;
wenzelm
parents: 55618
diff changeset
   338
    }
48860
56ec76f769c0 retain unknown options within preferences;
wenzelm
parents: 48807
diff changeset
   339
  }
56ec76f769c0 retain unknown options within preferences;
wenzelm
parents: 48807
diff changeset
   340
48807
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
   341
  def + (name: String, value: String): Options =
48370
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   342
  {
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   343
    val opt = check_name(name)
49270
e5d162d15867 some support to organize options in sections;
wenzelm
parents: 49247
diff changeset
   344
    (new Options(options + (name -> opt.copy(value = value)), section)).check_value(name)
48370
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   345
  }
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   346
48807
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
   347
  def + (name: String, opt_value: Option[String]): Options =
48370
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   348
  {
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   349
    val opt = check_name(name)
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   350
    opt_value match {
48807
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
   351
      case Some(value) => this + (name, value)
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
   352
      case None if opt.typ == Options.Bool => this + (name, "true")
48370
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   353
      case None => error("Missing value for option " + quote(name) + " : " + opt.typ.print)
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   354
    }
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   355
  }
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   356
48807
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
   357
  def + (str: String): Options =
48370
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   358
  {
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   359
    str.indexOf('=') match {
48807
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
   360
      case -1 => this + (str, None)
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
   361
      case i => this + (str.substring(0, i), str.substring(i + 1))
48370
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   362
    }
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   363
  }
48456
d8ff14f44a40 added ML version of stand-alone options, with XML.encode/decode operations (unidirectional from Scala to ML);
wenzelm
parents: 48421
diff changeset
   364
48807
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
   365
  def ++ (specs: List[Options.Spec]): Options =
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
   366
    (this /: specs)({ case (x, (y, z)) => x + (y, z) })
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
   367
48456
d8ff14f44a40 added ML version of stand-alone options, with XML.encode/decode operations (unidirectional from Scala to ML);
wenzelm
parents: 48421
diff changeset
   368
49270
e5d162d15867 some support to organize options in sections;
wenzelm
parents: 49247
diff changeset
   369
  /* sections */
e5d162d15867 some support to organize options in sections;
wenzelm
parents: 49247
diff changeset
   370
e5d162d15867 some support to organize options in sections;
wenzelm
parents: 49247
diff changeset
   371
  def set_section(new_section: String): Options =
e5d162d15867 some support to organize options in sections;
wenzelm
parents: 49247
diff changeset
   372
    new Options(options, new_section)
e5d162d15867 some support to organize options in sections;
wenzelm
parents: 49247
diff changeset
   373
e5d162d15867 some support to organize options in sections;
wenzelm
parents: 49247
diff changeset
   374
  def sections: List[(String, List[Options.Opt])] =
e5d162d15867 some support to organize options in sections;
wenzelm
parents: 49247
diff changeset
   375
    options.groupBy(_._2.section).toList.map({ case (a, opts) => (a, opts.toList.map(_._2)) })
e5d162d15867 some support to organize options in sections;
wenzelm
parents: 49247
diff changeset
   376
e5d162d15867 some support to organize options in sections;
wenzelm
parents: 49247
diff changeset
   377
48456
d8ff14f44a40 added ML version of stand-alone options, with XML.encode/decode operations (unidirectional from Scala to ML);
wenzelm
parents: 48421
diff changeset
   378
  /* encode */
d8ff14f44a40 added ML version of stand-alone options, with XML.encode/decode operations (unidirectional from Scala to ML);
wenzelm
parents: 48421
diff changeset
   379
d8ff14f44a40 added ML version of stand-alone options, with XML.encode/decode operations (unidirectional from Scala to ML);
wenzelm
parents: 48421
diff changeset
   380
  def encode: XML.Body =
d8ff14f44a40 added ML version of stand-alone options, with XML.encode/decode operations (unidirectional from Scala to ML);
wenzelm
parents: 48421
diff changeset
   381
  {
48860
56ec76f769c0 retain unknown options within preferences;
wenzelm
parents: 48807
diff changeset
   382
    val opts =
56465
6ad693903e22 more positions and markup;
wenzelm
parents: 55618
diff changeset
   383
      for ((_, opt) <- options.toList; if !opt.unknown)
6ad693903e22 more positions and markup;
wenzelm
parents: 55618
diff changeset
   384
        yield (opt.pos, (opt.name, (opt.typ.print, opt.value)))
48860
56ec76f769c0 retain unknown options within preferences;
wenzelm
parents: 48807
diff changeset
   385
56465
6ad693903e22 more positions and markup;
wenzelm
parents: 55618
diff changeset
   386
    import XML.Encode.{string => string_, _}
6ad693903e22 more positions and markup;
wenzelm
parents: 55618
diff changeset
   387
    list(pair(properties, pair(string_, pair(string_, string_))))(opts)
48456
d8ff14f44a40 added ML version of stand-alone options, with XML.encode/decode operations (unidirectional from Scala to ML);
wenzelm
parents: 48421
diff changeset
   388
  }
48807
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
   389
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
   390
67845
46fa8c2c142a more flexible preferences: avoid hardwired file;
wenzelm
parents: 67178
diff changeset
   391
  /* save preferences */
48807
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
   392
67845
46fa8c2c142a more flexible preferences: avoid hardwired file;
wenzelm
parents: 67178
diff changeset
   393
  def save_prefs(file: Path = Options.PREFS)
48807
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
   394
  {
67845
46fa8c2c142a more flexible preferences: avoid hardwired file;
wenzelm
parents: 67178
diff changeset
   395
    val defaults: Options = Options.init(prefs = "")
48807
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
   396
    val changed =
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
   397
      (for {
48860
56ec76f769c0 retain unknown options within preferences;
wenzelm
parents: 48807
diff changeset
   398
        (name, opt2) <- options.iterator
56ec76f769c0 retain unknown options within preferences;
wenzelm
parents: 48807
diff changeset
   399
        opt1 = defaults.options.get(name)
60215
5fb4990dfc73 misc tuning, based on warnings by IntelliJ IDEA;
wenzelm
parents: 60133
diff changeset
   400
        if opt1.isEmpty || opt1.get.value != opt2.value
48860
56ec76f769c0 retain unknown options within preferences;
wenzelm
parents: 48807
diff changeset
   401
      } yield (name, opt2.value, if (opt1.isEmpty) "  (* unknown *)" else "")).toList
56ec76f769c0 retain unknown options within preferences;
wenzelm
parents: 48807
diff changeset
   402
48807
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
   403
    val prefs =
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
   404
      changed.sortBy(_._1)
48860
56ec76f769c0 retain unknown options within preferences;
wenzelm
parents: 48807
diff changeset
   405
        .map({ case (x, y, z) => x + " = " + Outer_Syntax.quote_string(y) + z + "\n" }).mkString
48807
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
   406
67845
46fa8c2c142a more flexible preferences: avoid hardwired file;
wenzelm
parents: 67178
diff changeset
   407
    Isabelle_System.mkdirs(file.dir)
46fa8c2c142a more flexible preferences: avoid hardwired file;
wenzelm
parents: 67178
diff changeset
   408
    File.write_backup(file, "(* generated by Isabelle " + Date.now() + " *)\n\n" + prefs)
48807
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
   409
  }
48365
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   410
}
49245
cb70157293c0 manage Isabelle/jEdit options as Isabelle/Scala options (with persistent preferences);
wenzelm
parents: 48992
diff changeset
   411
cb70157293c0 manage Isabelle/jEdit options as Isabelle/Scala options (with persistent preferences);
wenzelm
parents: 48992
diff changeset
   412
65236
4fa82bbb394e afford early initialization of JEdit_Options, but it may lead to messy exception trace for malformed etc/preferences (see also 6eeaaefcea56);
wenzelm
parents: 64186
diff changeset
   413
class Options_Variable(init_options: Options)
49245
cb70157293c0 manage Isabelle/jEdit options as Isabelle/Scala options (with persistent preferences);
wenzelm
parents: 48992
diff changeset
   414
{
65236
4fa82bbb394e afford early initialization of JEdit_Options, but it may lead to messy exception trace for malformed etc/preferences (see also 6eeaaefcea56);
wenzelm
parents: 64186
diff changeset
   415
  private var options = init_options
49245
cb70157293c0 manage Isabelle/jEdit options as Isabelle/Scala options (with persistent preferences);
wenzelm
parents: 48992
diff changeset
   416
65236
4fa82bbb394e afford early initialization of JEdit_Options, but it may lead to messy exception trace for malformed etc/preferences (see also 6eeaaefcea56);
wenzelm
parents: 64186
diff changeset
   417
  def value: Options = synchronized { options }
49245
cb70157293c0 manage Isabelle/jEdit options as Isabelle/Scala options (with persistent preferences);
wenzelm
parents: 48992
diff changeset
   418
65236
4fa82bbb394e afford early initialization of JEdit_Options, but it may lead to messy exception trace for malformed etc/preferences (see also 6eeaaefcea56);
wenzelm
parents: 64186
diff changeset
   419
  private def upd(f: Options => Options): Unit = synchronized { options = f(options) }
4fa82bbb394e afford early initialization of JEdit_Options, but it may lead to messy exception trace for malformed etc/preferences (see also 6eeaaefcea56);
wenzelm
parents: 64186
diff changeset
   420
  def += (name: String, x: String): Unit = upd(opts => opts + (name, x))
49245
cb70157293c0 manage Isabelle/jEdit options as Isabelle/Scala options (with persistent preferences);
wenzelm
parents: 48992
diff changeset
   421
49954
44658062d822 more explicit auxiliary classes to avoid warning "reflective access of structural type member method" of scala-2.10.0-RC1;
wenzelm
parents: 49296
diff changeset
   422
  class Bool_Access
49245
cb70157293c0 manage Isabelle/jEdit options as Isabelle/Scala options (with persistent preferences);
wenzelm
parents: 48992
diff changeset
   423
  {
62227
6eeaaefcea56 clarified errors: more explicit treatment of uninitialized state;
wenzelm
parents: 61579
diff changeset
   424
    def apply(name: String): Boolean = value.bool(name)
6eeaaefcea56 clarified errors: more explicit treatment of uninitialized state;
wenzelm
parents: 61579
diff changeset
   425
    def update(name: String, x: Boolean): Unit = upd(opts => opts.bool.update(name, x))
49245
cb70157293c0 manage Isabelle/jEdit options as Isabelle/Scala options (with persistent preferences);
wenzelm
parents: 48992
diff changeset
   426
  }
49954
44658062d822 more explicit auxiliary classes to avoid warning "reflective access of structural type member method" of scala-2.10.0-RC1;
wenzelm
parents: 49296
diff changeset
   427
  val bool = new Bool_Access
49245
cb70157293c0 manage Isabelle/jEdit options as Isabelle/Scala options (with persistent preferences);
wenzelm
parents: 48992
diff changeset
   428
49954
44658062d822 more explicit auxiliary classes to avoid warning "reflective access of structural type member method" of scala-2.10.0-RC1;
wenzelm
parents: 49296
diff changeset
   429
  class Int_Access
49245
cb70157293c0 manage Isabelle/jEdit options as Isabelle/Scala options (with persistent preferences);
wenzelm
parents: 48992
diff changeset
   430
  {
62227
6eeaaefcea56 clarified errors: more explicit treatment of uninitialized state;
wenzelm
parents: 61579
diff changeset
   431
    def apply(name: String): Int = value.int(name)
6eeaaefcea56 clarified errors: more explicit treatment of uninitialized state;
wenzelm
parents: 61579
diff changeset
   432
    def update(name: String, x: Int): Unit = upd(opts => opts.int.update(name, x))
49245
cb70157293c0 manage Isabelle/jEdit options as Isabelle/Scala options (with persistent preferences);
wenzelm
parents: 48992
diff changeset
   433
  }
49954
44658062d822 more explicit auxiliary classes to avoid warning "reflective access of structural type member method" of scala-2.10.0-RC1;
wenzelm
parents: 49296
diff changeset
   434
  val int = new Int_Access
49245
cb70157293c0 manage Isabelle/jEdit options as Isabelle/Scala options (with persistent preferences);
wenzelm
parents: 48992
diff changeset
   435
49954
44658062d822 more explicit auxiliary classes to avoid warning "reflective access of structural type member method" of scala-2.10.0-RC1;
wenzelm
parents: 49296
diff changeset
   436
  class Real_Access
49245
cb70157293c0 manage Isabelle/jEdit options as Isabelle/Scala options (with persistent preferences);
wenzelm
parents: 48992
diff changeset
   437
  {
62227
6eeaaefcea56 clarified errors: more explicit treatment of uninitialized state;
wenzelm
parents: 61579
diff changeset
   438
    def apply(name: String): Double = value.real(name)
6eeaaefcea56 clarified errors: more explicit treatment of uninitialized state;
wenzelm
parents: 61579
diff changeset
   439
    def update(name: String, x: Double): Unit = upd(opts => opts.real.update(name, x))
49245
cb70157293c0 manage Isabelle/jEdit options as Isabelle/Scala options (with persistent preferences);
wenzelm
parents: 48992
diff changeset
   440
  }
49954
44658062d822 more explicit auxiliary classes to avoid warning "reflective access of structural type member method" of scala-2.10.0-RC1;
wenzelm
parents: 49296
diff changeset
   441
  val real = new Real_Access
49245
cb70157293c0 manage Isabelle/jEdit options as Isabelle/Scala options (with persistent preferences);
wenzelm
parents: 48992
diff changeset
   442
49954
44658062d822 more explicit auxiliary classes to avoid warning "reflective access of structural type member method" of scala-2.10.0-RC1;
wenzelm
parents: 49296
diff changeset
   443
  class String_Access
49245
cb70157293c0 manage Isabelle/jEdit options as Isabelle/Scala options (with persistent preferences);
wenzelm
parents: 48992
diff changeset
   444
  {
62227
6eeaaefcea56 clarified errors: more explicit treatment of uninitialized state;
wenzelm
parents: 61579
diff changeset
   445
    def apply(name: String): String = value.string(name)
6eeaaefcea56 clarified errors: more explicit treatment of uninitialized state;
wenzelm
parents: 61579
diff changeset
   446
    def update(name: String, x: String): Unit = upd(opts => opts.string.update(name, x))
49245
cb70157293c0 manage Isabelle/jEdit options as Isabelle/Scala options (with persistent preferences);
wenzelm
parents: 48992
diff changeset
   447
  }
49954
44658062d822 more explicit auxiliary classes to avoid warning "reflective access of structural type member method" of scala-2.10.0-RC1;
wenzelm
parents: 49296
diff changeset
   448
  val string = new String_Access
50207
54be125d8cdc tuned signature;
wenzelm
parents: 49954
diff changeset
   449
54be125d8cdc tuned signature;
wenzelm
parents: 49954
diff changeset
   450
  class Seconds_Access
54be125d8cdc tuned signature;
wenzelm
parents: 49954
diff changeset
   451
  {
62227
6eeaaefcea56 clarified errors: more explicit treatment of uninitialized state;
wenzelm
parents: 61579
diff changeset
   452
    def apply(name: String): Time = value.seconds(name)
50207
54be125d8cdc tuned signature;
wenzelm
parents: 49954
diff changeset
   453
  }
54be125d8cdc tuned signature;
wenzelm
parents: 49954
diff changeset
   454
  val seconds = new Seconds_Access
49245
cb70157293c0 manage Isabelle/jEdit options as Isabelle/Scala options (with persistent preferences);
wenzelm
parents: 48992
diff changeset
   455
}