src/Pure/System/options.scala
author wenzelm
Sat, 11 Mar 2023 12:41:53 +0100
changeset 77610 3b09ae9e40cb
parent 77609 a45cce93529c
child 77611 606ac3fae270
permissions -rw-r--r--
clarified session prefs (or "options" within the database);
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
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 74827
diff changeset
    10
object Options {
48421
c4d337782de4 propagate defined options;
wenzelm
parents: 48411
diff changeset
    11
  type Spec = (String, Option[String])
c4d337782de4 propagate defined options;
wenzelm
parents: 48411
diff changeset
    12
c4d337782de4 propagate defined options;
wenzelm
parents: 48411
diff changeset
    13
  val empty: Options = new Options()
c4d337782de4 propagate defined options;
wenzelm
parents: 48411
diff changeset
    14
c4d337782de4 propagate defined options;
wenzelm
parents: 48411
diff changeset
    15
75847
93436389db1c clarified signature: more explicit types;
wenzelm
parents: 75846
diff changeset
    16
  /* typed access */
75842
a8c401312f9d clarified signature;
wenzelm
parents: 75405
diff changeset
    17
75846
d9926523855e clarified signature --- avoid dependent types;
wenzelm
parents: 75845
diff changeset
    18
  abstract class Access[A](val options: Options) {
75842
a8c401312f9d clarified signature;
wenzelm
parents: 75405
diff changeset
    19
    def apply(name: String): A
a8c401312f9d clarified signature;
wenzelm
parents: 75405
diff changeset
    20
    def update(name: String, x: A): Options
75847
93436389db1c clarified signature: more explicit types;
wenzelm
parents: 75846
diff changeset
    21
    def change(name: String, f: A => A): Options = update(name, f(apply(name)))
75842
a8c401312f9d clarified signature;
wenzelm
parents: 75405
diff changeset
    22
  }
a8c401312f9d clarified signature;
wenzelm
parents: 75405
diff changeset
    23
75847
93436389db1c clarified signature: more explicit types;
wenzelm
parents: 75846
diff changeset
    24
  class Access_Variable[A](
93436389db1c clarified signature: more explicit types;
wenzelm
parents: 75846
diff changeset
    25
    val options: Options_Variable,
93436389db1c clarified signature: more explicit types;
wenzelm
parents: 75846
diff changeset
    26
    val pure_access: Options => Access[A]
93436389db1c clarified signature: more explicit types;
wenzelm
parents: 75846
diff changeset
    27
  ) {
93436389db1c clarified signature: more explicit types;
wenzelm
parents: 75846
diff changeset
    28
    def apply(name: String): A = pure_access(options.value)(name)
93436389db1c clarified signature: more explicit types;
wenzelm
parents: 75846
diff changeset
    29
    def update(name: String, x: A): Unit =
93436389db1c clarified signature: more explicit types;
wenzelm
parents: 75846
diff changeset
    30
      options.change(options => pure_access(options).update(name, x))
93436389db1c clarified signature: more explicit types;
wenzelm
parents: 75846
diff changeset
    31
    def change(name: String, f: A => A): Unit = update(name, f(apply(name)))
75842
a8c401312f9d clarified signature;
wenzelm
parents: 75405
diff changeset
    32
  }
a8c401312f9d clarified signature;
wenzelm
parents: 75405
diff changeset
    33
a8c401312f9d clarified signature;
wenzelm
parents: 75405
diff changeset
    34
48421
c4d337782de4 propagate defined options;
wenzelm
parents: 48411
diff changeset
    35
  /* representation */
c4d337782de4 propagate defined options;
wenzelm
parents: 48411
diff changeset
    36
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 74827
diff changeset
    37
  sealed abstract class Type {
56599
c4424d8c890f tuned signature -- separate module Word;
wenzelm
parents: 56559
diff changeset
    38
    def print: String = Word.lowercase(toString)
48365
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
    39
  }
49246
248e66e8321f more systematic JEdit_Options.make_component;
wenzelm
parents: 49245
diff changeset
    40
  case object Bool extends Type
248e66e8321f more systematic JEdit_Options.make_component;
wenzelm
parents: 49245
diff changeset
    41
  case object Int extends Type
248e66e8321f more systematic JEdit_Options.make_component;
wenzelm
parents: 49245
diff changeset
    42
  case object Real extends Type
248e66e8321f more systematic JEdit_Options.make_component;
wenzelm
parents: 49245
diff changeset
    43
  case object String extends Type
248e66e8321f more systematic JEdit_Options.make_component;
wenzelm
parents: 49245
diff changeset
    44
  case object Unknown extends Type
48365
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
    45
77603
236e43c8bb5b support option tags;
wenzelm
parents: 77504
diff changeset
    46
  val TAG_CONTENT = "content"
236e43c8bb5b support option tags;
wenzelm
parents: 77504
diff changeset
    47
  val TAG_DOCUMENT = "document"
236e43c8bb5b support option tags;
wenzelm
parents: 77504
diff changeset
    48
  val TAG_BUILD = "build"
236e43c8bb5b support option tags;
wenzelm
parents: 77504
diff changeset
    49
  val TAG_UPDATE = "update"
236e43c8bb5b support option tags;
wenzelm
parents: 77504
diff changeset
    50
  val TAG_CONNECTION = "connection"
236e43c8bb5b support option tags;
wenzelm
parents: 77504
diff changeset
    51
77605
bc1248c5d159 clarified signature;
wenzelm
parents: 77603
diff changeset
    52
  case class Entry(
56465
6ad693903e22 more positions and markup;
wenzelm
parents: 55618
diff changeset
    53
    public: Boolean,
6ad693903e22 more positions and markup;
wenzelm
parents: 55618
diff changeset
    54
    pos: Position.T,
6ad693903e22 more positions and markup;
wenzelm
parents: 55618
diff changeset
    55
    name: String,
6ad693903e22 more positions and markup;
wenzelm
parents: 55618
diff changeset
    56
    typ: Type,
6ad693903e22 more positions and markup;
wenzelm
parents: 55618
diff changeset
    57
    value: String,
6ad693903e22 more positions and markup;
wenzelm
parents: 55618
diff changeset
    58
    default_value: String,
74827
c1b5d6e6ff74 clarified system option standard values: avoid oddities like "isabelle build -o document_output" producing directories named "true";
wenzelm
parents: 74144
diff changeset
    59
    standard_value: Option[String],
77603
236e43c8bb5b support option tags;
wenzelm
parents: 77504
diff changeset
    60
    tags: List[String],
56465
6ad693903e22 more positions and markup;
wenzelm
parents: 55618
diff changeset
    61
    description: String,
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 74827
diff changeset
    62
    section: String
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 74827
diff changeset
    63
  ) {
74827
c1b5d6e6ff74 clarified system option standard values: avoid oddities like "isabelle build -o document_output" producing directories named "true";
wenzelm
parents: 74144
diff changeset
    64
    private def print_value(x: String): String = if (typ == Options.String) quote(x) else x
c1b5d6e6ff74 clarified system option standard values: avoid oddities like "isabelle build -o document_output" producing directories named "true";
wenzelm
parents: 74144
diff changeset
    65
    private def print_standard: String =
c1b5d6e6ff74 clarified system option standard values: avoid oddities like "isabelle build -o document_output" producing directories named "true";
wenzelm
parents: 74144
diff changeset
    66
      standard_value match {
c1b5d6e6ff74 clarified system option standard values: avoid oddities like "isabelle build -o document_output" producing directories named "true";
wenzelm
parents: 74144
diff changeset
    67
        case None => ""
c1b5d6e6ff74 clarified system option standard values: avoid oddities like "isabelle build -o document_output" producing directories named "true";
wenzelm
parents: 74144
diff changeset
    68
        case Some(s) if s == default_value => " (standard)"
c1b5d6e6ff74 clarified system option standard values: avoid oddities like "isabelle build -o document_output" producing directories named "true";
wenzelm
parents: 74144
diff changeset
    69
        case Some(s) => " (standard " + print_value(s) + ")"
c1b5d6e6ff74 clarified system option standard values: avoid oddities like "isabelle build -o document_output" producing directories named "true";
wenzelm
parents: 74144
diff changeset
    70
      }
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 74827
diff changeset
    71
    private def print(default: Boolean): String = {
49289
60424f123621 more informative tooltip: default value;
wenzelm
parents: 49270
diff changeset
    72
      val x = if (default) default_value else value
74827
c1b5d6e6ff74 clarified system option standard values: avoid oddities like "isabelle build -o document_output" producing directories named "true";
wenzelm
parents: 74144
diff changeset
    73
      "option " + name + " : " + typ.print + " = " + print_value(x) + print_standard +
77504
wenzelm
parents: 77374
diff changeset
    74
        if_proper(description, "\n  -- " + quote(description))
49289
60424f123621 more informative tooltip: default value;
wenzelm
parents: 49270
diff changeset
    75
    }
60424f123621 more informative tooltip: default value;
wenzelm
parents: 49270
diff changeset
    76
60424f123621 more informative tooltip: default value;
wenzelm
parents: 49270
diff changeset
    77
    def print: String = print(false)
60424f123621 more informative tooltip: default value;
wenzelm
parents: 49270
diff changeset
    78
    def print_default: String = print(true)
49247
ffd9ad9dc35b more detailed option tooltip;
wenzelm
parents: 49246
diff changeset
    79
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 74827
diff changeset
    80
    def title(strip: String = ""): String = {
56600
628e039cc34d more specific support for sequence of words;
wenzelm
parents: 56599
diff changeset
    81
      val words = Word.explode('_', name)
49270
e5d162d15867 some support to organize options in sections;
wenzelm
parents: 49247
diff changeset
    82
      val words1 =
e5d162d15867 some support to organize options in sections;
wenzelm
parents: 49247
diff changeset
    83
        words match {
e5d162d15867 some support to organize options in sections;
wenzelm
parents: 49247
diff changeset
    84
          case word :: rest if word == strip => rest
e5d162d15867 some support to organize options in sections;
wenzelm
parents: 49247
diff changeset
    85
          case _ => words
e5d162d15867 some support to organize options in sections;
wenzelm
parents: 49247
diff changeset
    86
        }
71601
97ccf48c2f0c misc tuning based on hints by IntelliJ IDEA;
wenzelm
parents: 69366
diff changeset
    87
      Word.implode(words1.map(Word.perhaps_capitalize))
49270
e5d162d15867 some support to organize options in sections;
wenzelm
parents: 49247
diff changeset
    88
    }
76579
c79b43c1c7ab tuned signature;
wenzelm
parents: 75847
diff changeset
    89
    def title_jedit: String = title("jedit")
49270
e5d162d15867 some support to organize options in sections;
wenzelm
parents: 49247
diff changeset
    90
48860
56ec76f769c0 retain unknown options within preferences;
wenzelm
parents: 48807
diff changeset
    91
    def unknown: Boolean = typ == Unknown
77603
236e43c8bb5b support option tags;
wenzelm
parents: 77504
diff changeset
    92
236e43c8bb5b support option tags;
wenzelm
parents: 77504
diff changeset
    93
    def has_tag(tag: String): Boolean = tags.contains(tag)
77606
b0a4f8c29446 clarified exported options;
wenzelm
parents: 77605
diff changeset
    94
b0a4f8c29446 clarified exported options;
wenzelm
parents: 77605
diff changeset
    95
    def session_content: Boolean =
b0a4f8c29446 clarified exported options;
wenzelm
parents: 77605
diff changeset
    96
      has_tag(TAG_CONTENT) ||
b0a4f8c29446 clarified exported options;
wenzelm
parents: 77605
diff changeset
    97
      has_tag(TAG_DOCUMENT) ||
b0a4f8c29446 clarified exported options;
wenzelm
parents: 77605
diff changeset
    98
      has_tag(TAG_UPDATE)
48860
56ec76f769c0 retain unknown options within preferences;
wenzelm
parents: 48807
diff changeset
    99
  }
48365
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   100
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   101
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   102
  /* parsing */
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   103
49270
e5d162d15867 some support to organize options in sections;
wenzelm
parents: 49247
diff changeset
   104
  private val SECTION = "section"
52065
78f2475aa126 explicit notion of public options, which are shown in the editor options dialog;
wenzelm
parents: 51945
diff changeset
   105
  private val PUBLIC = "public"
48795
bece259ee055 clarified format of etc/options: only declarations, not re-definitions;
wenzelm
parents: 48718
diff changeset
   106
  private val OPTION = "option"
74827
c1b5d6e6ff74 clarified system option standard values: avoid oddities like "isabelle build -o document_output" producing directories named "true";
wenzelm
parents: 74144
diff changeset
   107
  private val STANDARD = "standard"
77603
236e43c8bb5b support option tags;
wenzelm
parents: 77504
diff changeset
   108
  private val FOR = "for"
48807
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
   109
  private val OPTIONS = Path.explode("etc/options")
67845
46fa8c2c142a more flexible preferences: avoid hardwired file;
wenzelm
parents: 67178
diff changeset
   110
  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
   111
71601
97ccf48c2f0c misc tuning based on hints by IntelliJ IDEA;
wenzelm
parents: 69366
diff changeset
   112
  val options_syntax: Outer_Syntax =
74827
c1b5d6e6ff74 clarified system option standard values: avoid oddities like "isabelle build -o document_output" producing directories named "true";
wenzelm
parents: 74144
diff changeset
   113
    Outer_Syntax.empty + ":" + "=" + "--" + "(" + ")" +
c1b5d6e6ff74 clarified system option standard values: avoid oddities like "isabelle build -o document_output" producing directories named "true";
wenzelm
parents: 74144
diff changeset
   114
      Symbol.comment + Symbol.comment_decoded +
63441
4c3fa4dba79f explicit kind "before_command";
wenzelm
parents: 62968
diff changeset
   115
      (SECTION, Keyword.DOCUMENT_HEADING) +
4c3fa4dba79f explicit kind "before_command";
wenzelm
parents: 62968
diff changeset
   116
      (PUBLIC, Keyword.BEFORE_COMMAND) +
74827
c1b5d6e6ff74 clarified system option standard values: avoid oddities like "isabelle build -o document_output" producing directories named "true";
wenzelm
parents: 74144
diff changeset
   117
      (OPTION, Keyword.THY_DECL) +
77603
236e43c8bb5b support option tags;
wenzelm
parents: 77504
diff changeset
   118
      STANDARD + FOR
49270
e5d162d15867 some support to organize options in sections;
wenzelm
parents: 49247
diff changeset
   119
71601
97ccf48c2f0c misc tuning based on hints by IntelliJ IDEA;
wenzelm
parents: 69366
diff changeset
   120
  val prefs_syntax: Outer_Syntax = Outer_Syntax.empty + "="
48713
de26cf3191a3 more token markers, based on actual outer syntax;
wenzelm
parents: 48693
diff changeset
   121
75405
b13ab7d11b90 clarified signature: avoid ambiguity in scala3;
wenzelm
parents: 75394
diff changeset
   122
  trait Parsers extends Parse.Parsers {
71601
97ccf48c2f0c misc tuning based on hints by IntelliJ IDEA;
wenzelm
parents: 69366
diff changeset
   123
    val option_name: Parser[String] = atom("option name", _.is_name)
97ccf48c2f0c misc tuning based on hints by IntelliJ IDEA;
wenzelm
parents: 69366
diff changeset
   124
    val option_type: Parser[String] = atom("option type", _.is_name)
97ccf48c2f0c misc tuning based on hints by IntelliJ IDEA;
wenzelm
parents: 69366
diff changeset
   125
    val option_value: Parser[String] =
48807
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
   126
      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
   127
        { case s ~ n => if (s.isDefined) "-" + n else n } |
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
   128
      atom("option value", tok => tok.is_name || tok.is_float)
74827
c1b5d6e6ff74 clarified system option standard values: avoid oddities like "isabelle build -o document_output" producing directories named "true";
wenzelm
parents: 74144
diff changeset
   129
    val option_standard: Parser[Option[String]] =
c1b5d6e6ff74 clarified system option standard values: avoid oddities like "isabelle build -o document_output" producing directories named "true";
wenzelm
parents: 74144
diff changeset
   130
      $$$("(") ~! $$$(STANDARD) ~ opt(option_value) ~ $$$(")") ^^ { case _ ~ _ ~ a ~ _ => a }
77603
236e43c8bb5b support option tags;
wenzelm
parents: 77504
diff changeset
   131
    val option_tag: Parser[String] = atom("option tag", _.is_name)
236e43c8bb5b support option tags;
wenzelm
parents: 77504
diff changeset
   132
    val option_tags: Parser[List[String]] =
236e43c8bb5b support option tags;
wenzelm
parents: 77504
diff changeset
   133
      $$$(FOR) ~! rep(option_tag) ^^ { case _ ~ x => x } | success(Nil)
62968
4e4738698db4 clarified syntax;
wenzelm
parents: 62832
diff changeset
   134
  }
48807
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
   135
75405
b13ab7d11b90 clarified signature: avoid ambiguity in scala3;
wenzelm
parents: 75394
diff changeset
   136
  private object Parsers extends Parsers {
61579
634cd44bb1d3 symbolic syntax "\<comment> text";
wenzelm
parents: 60215
diff changeset
   137
    def comment_marker: Parser[String] =
634cd44bb1d3 symbolic syntax "\<comment> text";
wenzelm
parents: 60215
diff changeset
   138
      $$$("--") | $$$(Symbol.comment) | $$$(Symbol.comment_decoded)
634cd44bb1d3 symbolic syntax "\<comment> text";
wenzelm
parents: 60215
diff changeset
   139
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 74827
diff changeset
   140
    val option_entry: Parser[Options => Options] = {
49270
e5d162d15867 some support to organize options in sections;
wenzelm
parents: 49247
diff changeset
   141
      command(SECTION) ~! text ^^
49295
2750756db9c5 more precise sections;
wenzelm
parents: 49289
diff changeset
   142
        { case _ ~ a => (options: Options) => options.set_section(a) } |
60133
a90982bbe8b4 clarified keywords for quasi-command spans and Sidekick structure;
wenzelm
parents: 59811
diff changeset
   143
      opt($$$(PUBLIC)) ~ command(OPTION) ~! (position(option_name) ~ $$$(":") ~ option_type ~
77603
236e43c8bb5b support option tags;
wenzelm
parents: 77504
diff changeset
   144
      $$$("=") ~ option_value ~ opt(option_standard) ~ option_tags ~
74827
c1b5d6e6ff74 clarified system option standard values: avoid oddities like "isabelle build -o document_output" producing directories named "true";
wenzelm
parents: 74144
diff changeset
   145
        (comment_marker ~! text ^^ { case _ ~ x => x } | success(""))) ^^
77603
236e43c8bb5b support option tags;
wenzelm
parents: 77504
diff changeset
   146
        { case a ~ _ ~ ((b, pos) ~ _ ~ c ~ _ ~ d ~ e ~ f ~ g) =>
236e43c8bb5b support option tags;
wenzelm
parents: 77504
diff changeset
   147
            (options: Options) => options.declare(a.isDefined, pos, b, c, d, e, f, g) }
48365
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   148
    }
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   149
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 74827
diff changeset
   150
    val prefs_entry: Parser[Options => Options] = {
58908
58bedbc18915 tuned signature;
wenzelm
parents: 58868
diff changeset
   151
      option_name ~ ($$$("=") ~! option_value) ^^
48860
56ec76f769c0 retain unknown options within preferences;
wenzelm
parents: 48807
diff changeset
   152
      { case a ~ (_ ~ b) => (options: Options) => options.add_permissive(a, b) }
48807
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
   153
    }
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
   154
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 74827
diff changeset
   155
    def parse_file(
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 74827
diff changeset
   156
      options: Options,
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 74827
diff changeset
   157
      file_name: String,
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 74827
diff changeset
   158
      content: String,
67845
46fa8c2c142a more flexible preferences: avoid hardwired file;
wenzelm
parents: 67178
diff changeset
   159
      syntax: Outer_Syntax = options_syntax,
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 74827
diff changeset
   160
      parser: Parser[Options => Options] = option_entry
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 74827
diff changeset
   161
    ): Options = {
67845
46fa8c2c142a more flexible preferences: avoid hardwired file;
wenzelm
parents: 67178
diff changeset
   162
      val toks = Token.explode(syntax.keywords, content)
48807
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
   163
      val ops =
67845
46fa8c2c142a more flexible preferences: avoid hardwired file;
wenzelm
parents: 67178
diff changeset
   164
        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
   165
          case Success(result, _) => result
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
   166
          case bad => error(bad.toString)
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
   167
        }
73359
d8a0e996614b tuned --- fewer warnings;
wenzelm
parents: 73340
diff changeset
   168
      try { ops.foldLeft(options.set_section("")) { case (opts, op) => op(opts) } }
73166
78dd1abfbbe1 proper message;
wenzelm
parents: 72763
diff changeset
   169
      catch { case ERROR(msg) => error(msg + Position.here(Position.File(file_name))) }
48365
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   170
    }
67845
46fa8c2c142a more flexible preferences: avoid hardwired file;
wenzelm
parents: 67178
diff changeset
   171
46fa8c2c142a more flexible preferences: avoid hardwired file;
wenzelm
parents: 67178
diff changeset
   172
    def parse_prefs(options: Options, content: String): Options =
69366
b6dacf6eabe3 clarified signature;
wenzelm
parents: 69074
diff changeset
   173
      parse_file(options, PREFS.file_name, content, syntax = prefs_syntax, parser = prefs_entry)
48365
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   174
  }
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   175
67845
46fa8c2c142a more flexible preferences: avoid hardwired file;
wenzelm
parents: 67178
diff changeset
   176
  def read_prefs(file: Path = PREFS): String =
46fa8c2c142a more flexible preferences: avoid hardwired file;
wenzelm
parents: 67178
diff changeset
   177
    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
   178
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 74827
diff changeset
   179
  def init(prefs: String = read_prefs(PREFS), opts: List[String] = Nil): Options = {
48365
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   180
    var options = empty
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   181
    for {
73815
43882e34c038 clarified modules;
wenzelm
parents: 73715
diff changeset
   182
      dir <- Components.directories()
48548
49afe0e92163 simplified Path vs. JVM File operations;
wenzelm
parents: 48457
diff changeset
   183
      file = dir + OPTIONS if file.is_file
75405
b13ab7d11b90 clarified signature: avoid ambiguity in scala3;
wenzelm
parents: 75394
diff changeset
   184
    } { options = Parsers.parse_file(options, file.implode, File.read(file)) }
b13ab7d11b90 clarified signature: avoid ambiguity in scala3;
wenzelm
parents: 75394
diff changeset
   185
    opts.foldLeft(Parsers.parse_prefs(options, prefs))(_ + _)
48365
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   186
  }
48457
fd9e28d5a143 pass build options to ML;
wenzelm
parents: 48456
diff changeset
   187
77609
a45cce93529c tuned signature;
wenzelm
parents: 77608
diff changeset
   188
  def init0(): Options = init(prefs = "")
a45cce93529c tuned signature;
wenzelm
parents: 77608
diff changeset
   189
48457
fd9e28d5a143 pass build options to ML;
wenzelm
parents: 48456
diff changeset
   190
62832
c1410bcf6e87 prefer internal tool;
wenzelm
parents: 62454
diff changeset
   191
  /* Isabelle tool wrapper */
48693
ceeea46bdeba "isabelle options" prints Isabelle system options;
wenzelm
parents: 48605
diff changeset
   192
72763
3cc73d00553c added document antiquotation @{tool};
wenzelm
parents: 72375
diff changeset
   193
  val isabelle_tool = Isabelle_Tool("options", "print Isabelle system options",
75394
42267c650205 tuned formatting;
wenzelm
parents: 75393
diff changeset
   194
    Scala_Project.here,
42267c650205 tuned formatting;
wenzelm
parents: 75393
diff changeset
   195
    { args =>
42267c650205 tuned formatting;
wenzelm
parents: 75393
diff changeset
   196
      var build_options = false
42267c650205 tuned formatting;
wenzelm
parents: 75393
diff changeset
   197
      var get_option = ""
42267c650205 tuned formatting;
wenzelm
parents: 75393
diff changeset
   198
      var list_options = false
42267c650205 tuned formatting;
wenzelm
parents: 75393
diff changeset
   199
      var export_file = ""
62437
bccad0374407 moved getopts to Scala;
wenzelm
parents: 62227
diff changeset
   200
75394
42267c650205 tuned formatting;
wenzelm
parents: 75393
diff changeset
   201
      val getopts = Getopts("""
62437
bccad0374407 moved getopts to Scala;
wenzelm
parents: 62227
diff changeset
   202
Usage: isabelle options [OPTIONS] [MORE_OPTIONS ...]
48693
ceeea46bdeba "isabelle options" prints Isabelle system options;
wenzelm
parents: 48605
diff changeset
   203
62437
bccad0374407 moved getopts to Scala;
wenzelm
parents: 62227
diff changeset
   204
  Options are:
bccad0374407 moved getopts to Scala;
wenzelm
parents: 62227
diff changeset
   205
    -b           include $ISABELLE_BUILD_OPTIONS
bccad0374407 moved getopts to Scala;
wenzelm
parents: 62227
diff changeset
   206
    -g OPTION    get value of OPTION
bccad0374407 moved getopts to Scala;
wenzelm
parents: 62227
diff changeset
   207
    -l           list options
bccad0374407 moved getopts to Scala;
wenzelm
parents: 62227
diff changeset
   208
    -x FILE      export options to FILE in YXML format
bccad0374407 moved getopts to Scala;
wenzelm
parents: 62227
diff changeset
   209
bccad0374407 moved getopts to Scala;
wenzelm
parents: 62227
diff changeset
   210
  Report Isabelle system options, augmented by MORE_OPTIONS given as
bccad0374407 moved getopts to Scala;
wenzelm
parents: 62227
diff changeset
   211
  arguments NAME=VAL or NAME.
bccad0374407 moved getopts to Scala;
wenzelm
parents: 62227
diff changeset
   212
""",
75394
42267c650205 tuned formatting;
wenzelm
parents: 75393
diff changeset
   213
        "b" -> (_ => build_options = true),
42267c650205 tuned formatting;
wenzelm
parents: 75393
diff changeset
   214
        "g:" -> (arg => get_option = arg),
42267c650205 tuned formatting;
wenzelm
parents: 75393
diff changeset
   215
        "l" -> (_ => list_options = true),
42267c650205 tuned formatting;
wenzelm
parents: 75393
diff changeset
   216
        "x:" -> (arg => export_file = arg))
52737
7b396ef36af6 clarified meaning of options for "isabelle options";
wenzelm
parents: 52735
diff changeset
   217
75394
42267c650205 tuned formatting;
wenzelm
parents: 75393
diff changeset
   218
      val more_options = getopts(args)
42267c650205 tuned formatting;
wenzelm
parents: 75393
diff changeset
   219
      if (get_option == "" && !list_options && export_file == "") getopts.usage()
52737
7b396ef36af6 clarified meaning of options for "isabelle options";
wenzelm
parents: 52735
diff changeset
   220
75394
42267c650205 tuned formatting;
wenzelm
parents: 75393
diff changeset
   221
      val options = {
42267c650205 tuned formatting;
wenzelm
parents: 75393
diff changeset
   222
        val options0 = Options.init()
42267c650205 tuned formatting;
wenzelm
parents: 75393
diff changeset
   223
        val options1 =
42267c650205 tuned formatting;
wenzelm
parents: 75393
diff changeset
   224
          if (build_options)
42267c650205 tuned formatting;
wenzelm
parents: 75393
diff changeset
   225
            Word.explode(Isabelle_System.getenv("ISABELLE_BUILD_OPTIONS")).foldLeft(options0)(_ + _)
42267c650205 tuned formatting;
wenzelm
parents: 75393
diff changeset
   226
          else options0
42267c650205 tuned formatting;
wenzelm
parents: 75393
diff changeset
   227
        more_options.foldLeft(options1)(_ + _)
42267c650205 tuned formatting;
wenzelm
parents: 75393
diff changeset
   228
      }
48693
ceeea46bdeba "isabelle options" prints Isabelle system options;
wenzelm
parents: 48605
diff changeset
   229
75394
42267c650205 tuned formatting;
wenzelm
parents: 75393
diff changeset
   230
      if (get_option != "")
42267c650205 tuned formatting;
wenzelm
parents: 75393
diff changeset
   231
        Output.writeln(options.check_name(get_option).value, stdout = true)
62437
bccad0374407 moved getopts to Scala;
wenzelm
parents: 62227
diff changeset
   232
75394
42267c650205 tuned formatting;
wenzelm
parents: 75393
diff changeset
   233
      if (export_file != "")
42267c650205 tuned formatting;
wenzelm
parents: 75393
diff changeset
   234
        File.write(Path.explode(export_file), YXML.string_of_body(options.encode))
62437
bccad0374407 moved getopts to Scala;
wenzelm
parents: 62227
diff changeset
   235
75394
42267c650205 tuned formatting;
wenzelm
parents: 75393
diff changeset
   236
      if (get_option == "" && export_file == "")
42267c650205 tuned formatting;
wenzelm
parents: 75393
diff changeset
   237
        Output.writeln(options.print, stdout = true)
42267c650205 tuned formatting;
wenzelm
parents: 75393
diff changeset
   238
    })
48365
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
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   241
49270
e5d162d15867 some support to organize options in sections;
wenzelm
parents: 49247
diff changeset
   242
final class Options private(
77605
bc1248c5d159 clarified signature;
wenzelm
parents: 77603
diff changeset
   243
  options: Map[String, Options.Entry] = Map.empty,
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 74827
diff changeset
   244
  val section: String = ""
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 74827
diff changeset
   245
) {
77605
bc1248c5d159 clarified signature;
wenzelm
parents: 77603
diff changeset
   246
  def iterator: Iterator[Options.Entry] = options.valuesIterator
75844
7d27944d7141 clarified signature: avoid public representation;
wenzelm
parents: 75843
diff changeset
   247
77605
bc1248c5d159 clarified signature;
wenzelm
parents: 77603
diff changeset
   248
  override def toString: String = iterator.mkString("Options(", ",", ")")
48365
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   249
77605
bc1248c5d159 clarified signature;
wenzelm
parents: 77603
diff changeset
   250
  private def print_entry(opt: Options.Entry): String =
54347
d5589530f3ba clarified isabelle options -l;
wenzelm
parents: 53336
diff changeset
   251
    if (opt.public) "public " + opt.print else opt.print
d5589530f3ba clarified isabelle options -l;
wenzelm
parents: 53336
diff changeset
   252
77605
bc1248c5d159 clarified signature;
wenzelm
parents: 77603
diff changeset
   253
  def print: String = cat_lines(iterator.toList.sortBy(_.name).map(print_entry))
48693
ceeea46bdeba "isabelle options" prints Isabelle system options;
wenzelm
parents: 48605
diff changeset
   254
49245
cb70157293c0 manage Isabelle/jEdit options as Isabelle/Scala options (with persistent preferences);
wenzelm
parents: 48992
diff changeset
   255
  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
   256
48365
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   257
48370
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   258
  /* check */
48365
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   259
77605
bc1248c5d159 clarified signature;
wenzelm
parents: 77603
diff changeset
   260
  def get(name: String): Option[Options.Entry] = options.get(name)
75844
7d27944d7141 clarified signature: avoid public representation;
wenzelm
parents: 75843
diff changeset
   261
77605
bc1248c5d159 clarified signature;
wenzelm
parents: 77603
diff changeset
   262
  def check_name(name: String): Options.Entry =
75844
7d27944d7141 clarified signature: avoid public representation;
wenzelm
parents: 75843
diff changeset
   263
    get(name) match {
48860
56ec76f769c0 retain unknown options within preferences;
wenzelm
parents: 48807
diff changeset
   264
      case Some(opt) if !opt.unknown => opt
56ec76f769c0 retain unknown options within preferences;
wenzelm
parents: 48807
diff changeset
   265
      case _ => error("Unknown option " + quote(name))
48365
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   266
    }
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   267
77605
bc1248c5d159 clarified signature;
wenzelm
parents: 77603
diff changeset
   268
  private def check_type(name: String, typ: Options.Type): Options.Entry = {
48365
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   269
    val opt = check_name(name)
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   270
    if (opt.typ == typ) opt
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   271
    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
   272
  }
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   273
48370
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   274
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   275
  /* basic operations */
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   276
75843
d750ead045a1 tuned signature;
wenzelm
parents: 75842
diff changeset
   277
  private def put(name: String, typ: Options.Type, value: String): Options = {
48370
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   278
    val opt = check_type(name, typ)
49270
e5d162d15867 some support to organize options in sections;
wenzelm
parents: 49247
diff changeset
   279
    new Options(options + (name -> opt.copy(value = value)), section)
48370
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   280
  }
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   281
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 74827
diff changeset
   282
  private def get[A](name: String, typ: Options.Type, parse: String => Option[A]): A = {
48365
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   283
    val opt = check_type(name, typ)
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   284
    parse(opt.value) match {
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   285
      case Some(x) => x
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   286
      case None =>
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   287
        error("Malformed value for option " + quote(name) +
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   288
          " : " + typ.print + " =\n" + quote(opt.value))
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   289
    }
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   290
  }
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   291
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   292
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   293
  /* internal lookup and update */
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   294
75846
d9926523855e clarified signature --- avoid dependent types;
wenzelm
parents: 75845
diff changeset
   295
  val bool: Options.Access[Boolean] =
d9926523855e clarified signature --- avoid dependent types;
wenzelm
parents: 75845
diff changeset
   296
    new Options.Access[Boolean](this) {
d9926523855e clarified signature --- avoid dependent types;
wenzelm
parents: 75845
diff changeset
   297
      def apply(name: String): Boolean = get(name, Options.Bool, Value.Boolean.unapply)
d9926523855e clarified signature --- avoid dependent types;
wenzelm
parents: 75845
diff changeset
   298
      def update(name: String, x: Boolean): Options = put(name, Options.Bool, Value.Boolean(x))
d9926523855e clarified signature --- avoid dependent types;
wenzelm
parents: 75845
diff changeset
   299
    }
48365
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   300
75846
d9926523855e clarified signature --- avoid dependent types;
wenzelm
parents: 75845
diff changeset
   301
  val int: Options.Access[Int] =
d9926523855e clarified signature --- avoid dependent types;
wenzelm
parents: 75845
diff changeset
   302
    new Options.Access[Int](this) {
d9926523855e clarified signature --- avoid dependent types;
wenzelm
parents: 75845
diff changeset
   303
      def apply(name: String): Int = get(name, Options.Int, Value.Int.unapply)
d9926523855e clarified signature --- avoid dependent types;
wenzelm
parents: 75845
diff changeset
   304
      def update(name: String, x: Int): Options = put(name, Options.Int, Value.Int(x))
d9926523855e clarified signature --- avoid dependent types;
wenzelm
parents: 75845
diff changeset
   305
    }
48365
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   306
75846
d9926523855e clarified signature --- avoid dependent types;
wenzelm
parents: 75845
diff changeset
   307
  val real: Options.Access[Double] =
d9926523855e clarified signature --- avoid dependent types;
wenzelm
parents: 75845
diff changeset
   308
    new Options.Access[Double](this) {
d9926523855e clarified signature --- avoid dependent types;
wenzelm
parents: 75845
diff changeset
   309
      def apply(name: String): Double = get(name, Options.Real, Value.Double.unapply)
d9926523855e clarified signature --- avoid dependent types;
wenzelm
parents: 75845
diff changeset
   310
      def update(name: String, x: Double): Options = put(name, Options.Real, Value.Double(x))
d9926523855e clarified signature --- avoid dependent types;
wenzelm
parents: 75845
diff changeset
   311
    }
48365
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   312
75846
d9926523855e clarified signature --- avoid dependent types;
wenzelm
parents: 75845
diff changeset
   313
  val string: Options.Access[String] =
d9926523855e clarified signature --- avoid dependent types;
wenzelm
parents: 75845
diff changeset
   314
    new Options.Access[String](this) {
d9926523855e clarified signature --- avoid dependent types;
wenzelm
parents: 75845
diff changeset
   315
      def apply(name: String): String = get(name, Options.String, Some(_))
d9926523855e clarified signature --- avoid dependent types;
wenzelm
parents: 75845
diff changeset
   316
      def update(name: String, x: String): Options = put(name, Options.String, x)
d9926523855e clarified signature --- avoid dependent types;
wenzelm
parents: 75845
diff changeset
   317
    }
48370
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   318
69074
787f3db8e313 tuned signature;
wenzelm
parents: 69073
diff changeset
   319
  def proper_string(name: String): Option[String] =
787f3db8e313 tuned signature;
wenzelm
parents: 69073
diff changeset
   320
    Library.proper_string(string(name))
787f3db8e313 tuned signature;
wenzelm
parents: 69073
diff changeset
   321
69073
d05defa39e3d tuned signature;
wenzelm
parents: 68841
diff changeset
   322
  def seconds(name: String): Time = Time.seconds(real(name))
50207
54be125d8cdc tuned signature;
wenzelm
parents: 49954
diff changeset
   323
48370
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   324
48807
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
   325
  /* external updates */
48370
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   326
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 74827
diff changeset
   327
  private def check_value(name: String): Options = {
48370
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   328
    val opt = check_name(name)
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   329
    opt.typ match {
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   330
      case Options.Bool => bool(name); this
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   331
      case Options.Int => int(name); this
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   332
      case Options.Real => real(name); this
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   333
      case Options.String => string(name); this
48860
56ec76f769c0 retain unknown options within preferences;
wenzelm
parents: 48807
diff changeset
   334
      case Options.Unknown => this
48370
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   335
    }
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   336
  }
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   337
56465
6ad693903e22 more positions and markup;
wenzelm
parents: 55618
diff changeset
   338
  def declare(
6ad693903e22 more positions and markup;
wenzelm
parents: 55618
diff changeset
   339
    public: Boolean,
6ad693903e22 more positions and markup;
wenzelm
parents: 55618
diff changeset
   340
    pos: Position.T,
6ad693903e22 more positions and markup;
wenzelm
parents: 55618
diff changeset
   341
    name: String,
6ad693903e22 more positions and markup;
wenzelm
parents: 55618
diff changeset
   342
    typ_name: String,
6ad693903e22 more positions and markup;
wenzelm
parents: 55618
diff changeset
   343
    value: String,
74827
c1b5d6e6ff74 clarified system option standard values: avoid oddities like "isabelle build -o document_output" producing directories named "true";
wenzelm
parents: 74144
diff changeset
   344
    standard: Option[Option[String]],
77603
236e43c8bb5b support option tags;
wenzelm
parents: 77504
diff changeset
   345
    tags: List[String],
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 74827
diff changeset
   346
    description: String
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 74827
diff changeset
   347
  ): Options = {
75844
7d27944d7141 clarified signature: avoid public representation;
wenzelm
parents: 75843
diff changeset
   348
    get(name) match {
56465
6ad693903e22 more positions and markup;
wenzelm
parents: 55618
diff changeset
   349
      case Some(other) =>
6ad693903e22 more positions and markup;
wenzelm
parents: 55618
diff changeset
   350
        error("Duplicate declaration of option " + quote(name) + Position.here(pos) +
6ad693903e22 more positions and markup;
wenzelm
parents: 55618
diff changeset
   351
          Position.here(other.pos))
48370
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   352
      case None =>
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   353
        val typ =
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   354
          typ_name match {
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   355
            case "bool" => Options.Bool
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   356
            case "int" => Options.Int
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   357
            case "real" => Options.Real
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   358
            case "string" => Options.String
56465
6ad693903e22 more positions and markup;
wenzelm
parents: 55618
diff changeset
   359
            case _ =>
6ad693903e22 more positions and markup;
wenzelm
parents: 55618
diff changeset
   360
              error("Unknown type for option " + quote(name) + " : " + quote(typ_name) +
6ad693903e22 more positions and markup;
wenzelm
parents: 55618
diff changeset
   361
                Position.here(pos))
48370
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   362
          }
74827
c1b5d6e6ff74 clarified system option standard values: avoid oddities like "isabelle build -o document_output" producing directories named "true";
wenzelm
parents: 74144
diff changeset
   363
        val standard_value =
c1b5d6e6ff74 clarified system option standard values: avoid oddities like "isabelle build -o document_output" producing directories named "true";
wenzelm
parents: 74144
diff changeset
   364
          standard match {
c1b5d6e6ff74 clarified system option standard values: avoid oddities like "isabelle build -o document_output" producing directories named "true";
wenzelm
parents: 74144
diff changeset
   365
            case None => None
c1b5d6e6ff74 clarified system option standard values: avoid oddities like "isabelle build -o document_output" producing directories named "true";
wenzelm
parents: 74144
diff changeset
   366
            case Some(_) if typ == Options.Bool =>
c1b5d6e6ff74 clarified system option standard values: avoid oddities like "isabelle build -o document_output" producing directories named "true";
wenzelm
parents: 74144
diff changeset
   367
              error("Illegal standard value for option " + quote(name) + " : " + typ_name +
c1b5d6e6ff74 clarified system option standard values: avoid oddities like "isabelle build -o document_output" producing directories named "true";
wenzelm
parents: 74144
diff changeset
   368
                Position.here)
c1b5d6e6ff74 clarified system option standard values: avoid oddities like "isabelle build -o document_output" producing directories named "true";
wenzelm
parents: 74144
diff changeset
   369
            case Some(s) => Some(s.getOrElse(value))
c1b5d6e6ff74 clarified system option standard values: avoid oddities like "isabelle build -o document_output" producing directories named "true";
wenzelm
parents: 74144
diff changeset
   370
          }
c1b5d6e6ff74 clarified system option standard values: avoid oddities like "isabelle build -o document_output" producing directories named "true";
wenzelm
parents: 74144
diff changeset
   371
        val opt =
77605
bc1248c5d159 clarified signature;
wenzelm
parents: 77603
diff changeset
   372
          Options.Entry(
77603
236e43c8bb5b support option tags;
wenzelm
parents: 77504
diff changeset
   373
            public, pos, name, typ, value, value, standard_value, tags, description, section)
49270
e5d162d15867 some support to organize options in sections;
wenzelm
parents: 49247
diff changeset
   374
        (new Options(options + (name -> opt), section)).check_value(name)
48370
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   375
    }
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   376
  }
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   377
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 74827
diff changeset
   378
  def add_permissive(name: String, value: String): Options = {
48860
56ec76f769c0 retain unknown options within preferences;
wenzelm
parents: 48807
diff changeset
   379
    if (options.isDefinedAt(name)) this + (name, value)
56465
6ad693903e22 more positions and markup;
wenzelm
parents: 55618
diff changeset
   380
    else {
77603
236e43c8bb5b support option tags;
wenzelm
parents: 77504
diff changeset
   381
      val opt =
77605
bc1248c5d159 clarified signature;
wenzelm
parents: 77603
diff changeset
   382
        Options.Entry(false, Position.none, name, Options.Unknown, value, value, None, Nil, "", "")
56465
6ad693903e22 more positions and markup;
wenzelm
parents: 55618
diff changeset
   383
      new Options(options + (name -> opt), section)
6ad693903e22 more positions and markup;
wenzelm
parents: 55618
diff changeset
   384
    }
48860
56ec76f769c0 retain unknown options within preferences;
wenzelm
parents: 48807
diff changeset
   385
  }
56ec76f769c0 retain unknown options within preferences;
wenzelm
parents: 48807
diff changeset
   386
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 74827
diff changeset
   387
  def + (name: String, value: String): Options = {
48370
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   388
    val opt = check_name(name)
49270
e5d162d15867 some support to organize options in sections;
wenzelm
parents: 49247
diff changeset
   389
    (new Options(options + (name -> opt.copy(value = value)), section)).check_value(name)
48370
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   390
  }
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   391
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 74827
diff changeset
   392
  def + (name: String, opt_value: Option[String]): Options = {
48370
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   393
    val opt = check_name(name)
74827
c1b5d6e6ff74 clarified system option standard values: avoid oddities like "isabelle build -o document_output" producing directories named "true";
wenzelm
parents: 74144
diff changeset
   394
    opt_value orElse opt.standard_value match {
48807
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
   395
      case Some(value) => this + (name, value)
74827
c1b5d6e6ff74 clarified system option standard values: avoid oddities like "isabelle build -o document_output" producing directories named "true";
wenzelm
parents: 74144
diff changeset
   396
      case None if opt.typ == Options.Bool => this + (name, "true")
48370
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   397
      case None => error("Missing value for option " + quote(name) + " : " + opt.typ.print)
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   398
    }
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   399
  }
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   400
48807
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
   401
  def + (str: String): Options =
73712
3eba8d4b624b clarified signature;
wenzelm
parents: 73359
diff changeset
   402
    str match {
73715
bf51c23f3f99 clarified signature -- avoid odd warning about scala/bug#6675;
wenzelm
parents: 73712
diff changeset
   403
      case Properties.Eq(a, b) => this + (a, b)
73712
3eba8d4b624b clarified signature;
wenzelm
parents: 73359
diff changeset
   404
      case _ => this + (str, None)
48370
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   405
    }
48456
d8ff14f44a40 added ML version of stand-alone options, with XML.encode/decode operations (unidirectional from Scala to ML);
wenzelm
parents: 48421
diff changeset
   406
48807
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
   407
  def ++ (specs: List[Options.Spec]): Options =
73359
d8a0e996614b tuned --- fewer warnings;
wenzelm
parents: 73340
diff changeset
   408
    specs.foldLeft(this) { case (x, (y, z)) => x + (y, z) }
48807
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
   409
48456
d8ff14f44a40 added ML version of stand-alone options, with XML.encode/decode operations (unidirectional from Scala to ML);
wenzelm
parents: 48421
diff changeset
   410
49270
e5d162d15867 some support to organize options in sections;
wenzelm
parents: 49247
diff changeset
   411
  /* sections */
e5d162d15867 some support to organize options in sections;
wenzelm
parents: 49247
diff changeset
   412
e5d162d15867 some support to organize options in sections;
wenzelm
parents: 49247
diff changeset
   413
  def set_section(new_section: String): Options =
e5d162d15867 some support to organize options in sections;
wenzelm
parents: 49247
diff changeset
   414
    new Options(options, new_section)
e5d162d15867 some support to organize options in sections;
wenzelm
parents: 49247
diff changeset
   415
77605
bc1248c5d159 clarified signature;
wenzelm
parents: 77603
diff changeset
   416
  def sections: List[(String, List[Options.Entry])] =
49270
e5d162d15867 some support to organize options in sections;
wenzelm
parents: 49247
diff changeset
   417
    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
   418
e5d162d15867 some support to organize options in sections;
wenzelm
parents: 49247
diff changeset
   419
48456
d8ff14f44a40 added ML version of stand-alone options, with XML.encode/decode operations (unidirectional from Scala to ML);
wenzelm
parents: 48421
diff changeset
   420
  /* encode */
d8ff14f44a40 added ML version of stand-alone options, with XML.encode/decode operations (unidirectional from Scala to ML);
wenzelm
parents: 48421
diff changeset
   421
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 74827
diff changeset
   422
  def encode: XML.Body = {
48860
56ec76f769c0 retain unknown options within preferences;
wenzelm
parents: 48807
diff changeset
   423
    val opts =
56465
6ad693903e22 more positions and markup;
wenzelm
parents: 55618
diff changeset
   424
      for ((_, opt) <- options.toList; if !opt.unknown)
6ad693903e22 more positions and markup;
wenzelm
parents: 55618
diff changeset
   425
        yield (opt.pos, (opt.name, (opt.typ.print, opt.value)))
48860
56ec76f769c0 retain unknown options within preferences;
wenzelm
parents: 48807
diff changeset
   426
56465
6ad693903e22 more positions and markup;
wenzelm
parents: 55618
diff changeset
   427
    import XML.Encode.{string => string_, _}
6ad693903e22 more positions and markup;
wenzelm
parents: 55618
diff changeset
   428
    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
   429
  }
48807
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
   430
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
   431
77608
eaa6b47fab2c tuned comments;
wenzelm
parents: 77607
diff changeset
   432
  /* preferences */
48807
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
   433
77603
236e43c8bb5b support option tags;
wenzelm
parents: 77504
diff changeset
   434
  def make_prefs(
77609
a45cce93529c tuned signature;
wenzelm
parents: 77608
diff changeset
   435
    defaults: Options = Options.init0(),
77605
bc1248c5d159 clarified signature;
wenzelm
parents: 77603
diff changeset
   436
    filter: Options.Entry => Boolean = _ => true
77603
236e43c8bb5b support option tags;
wenzelm
parents: 77504
diff changeset
   437
  ): String = {
77374
268bf61631ec more robust options in "prefs" format: avoid odd control character;
wenzelm
parents: 77366
diff changeset
   438
    (for {
268bf61631ec more robust options in "prefs" format: avoid odd control character;
wenzelm
parents: 77366
diff changeset
   439
      (name, opt2) <- options.iterator
268bf61631ec more robust options in "prefs" format: avoid odd control character;
wenzelm
parents: 77366
diff changeset
   440
      opt1 = defaults.get(name)
77603
236e43c8bb5b support option tags;
wenzelm
parents: 77504
diff changeset
   441
      if (opt1.isEmpty || opt1.get.value != opt2.value) && filter(opt2)
77374
268bf61631ec more robust options in "prefs" format: avoid odd control character;
wenzelm
parents: 77366
diff changeset
   442
    } yield (name, opt2.value, if (opt1.isEmpty) "  (* unknown *)" else ""))
268bf61631ec more robust options in "prefs" format: avoid odd control character;
wenzelm
parents: 77366
diff changeset
   443
      .toList.sortBy(_._1)
268bf61631ec more robust options in "prefs" format: avoid odd control character;
wenzelm
parents: 77366
diff changeset
   444
      .map({ case (x, y, z) => x + " = " + Outer_Syntax.quote_string(y) + z + "\n" }).mkString
268bf61631ec more robust options in "prefs" format: avoid odd control character;
wenzelm
parents: 77366
diff changeset
   445
  }
268bf61631ec more robust options in "prefs" format: avoid odd control character;
wenzelm
parents: 77366
diff changeset
   446
77610
3b09ae9e40cb clarified session prefs (or "options" within the database);
wenzelm
parents: 77609
diff changeset
   447
  def session_prefs(defaults: Options = Options.init0()): String =
3b09ae9e40cb clarified session prefs (or "options" within the database);
wenzelm
parents: 77609
diff changeset
   448
    make_prefs(defaults = defaults, filter = _.session_content)
3b09ae9e40cb clarified session prefs (or "options" within the database);
wenzelm
parents: 77609
diff changeset
   449
77609
a45cce93529c tuned signature;
wenzelm
parents: 77608
diff changeset
   450
  def save_prefs(file: Path = Options.PREFS, defaults: Options = Options.init0()): Unit = {
77374
268bf61631ec more robust options in "prefs" format: avoid odd control character;
wenzelm
parents: 77366
diff changeset
   451
    val prefs = make_prefs(defaults = defaults)
72375
e48d93811ed7 clarified signature;
wenzelm
parents: 71601
diff changeset
   452
    Isabelle_System.make_directory(file.dir)
67845
46fa8c2c142a more flexible preferences: avoid hardwired file;
wenzelm
parents: 67178
diff changeset
   453
    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
   454
  }
48365
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   455
}
49245
cb70157293c0 manage Isabelle/jEdit options as Isabelle/Scala options (with persistent preferences);
wenzelm
parents: 48992
diff changeset
   456
cb70157293c0 manage Isabelle/jEdit options as Isabelle/Scala options (with persistent preferences);
wenzelm
parents: 48992
diff changeset
   457
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 74827
diff changeset
   458
class Options_Variable(init_options: Options) {
75846
d9926523855e clarified signature --- avoid dependent types;
wenzelm
parents: 75845
diff changeset
   459
  private var _options = init_options
49245
cb70157293c0 manage Isabelle/jEdit options as Isabelle/Scala options (with persistent preferences);
wenzelm
parents: 48992
diff changeset
   460
75846
d9926523855e clarified signature --- avoid dependent types;
wenzelm
parents: 75845
diff changeset
   461
  def value: Options = synchronized { _options }
d9926523855e clarified signature --- avoid dependent types;
wenzelm
parents: 75845
diff changeset
   462
  def change(f: Options => Options): Unit = synchronized { _options = f(_options) }
d9926523855e clarified signature --- avoid dependent types;
wenzelm
parents: 75845
diff changeset
   463
  def += (name: String, x: String): Unit = change(options => options + (name, x))
49245
cb70157293c0 manage Isabelle/jEdit options as Isabelle/Scala options (with persistent preferences);
wenzelm
parents: 48992
diff changeset
   464
75846
d9926523855e clarified signature --- avoid dependent types;
wenzelm
parents: 75845
diff changeset
   465
  val bool: Options.Access_Variable[Boolean] =
75847
93436389db1c clarified signature: more explicit types;
wenzelm
parents: 75846
diff changeset
   466
    new Options.Access_Variable[Boolean](this, _.bool)
49245
cb70157293c0 manage Isabelle/jEdit options as Isabelle/Scala options (with persistent preferences);
wenzelm
parents: 48992
diff changeset
   467
75846
d9926523855e clarified signature --- avoid dependent types;
wenzelm
parents: 75845
diff changeset
   468
  val int: Options.Access_Variable[Int] =
75847
93436389db1c clarified signature: more explicit types;
wenzelm
parents: 75846
diff changeset
   469
    new Options.Access_Variable[Int](this, _.int)
49245
cb70157293c0 manage Isabelle/jEdit options as Isabelle/Scala options (with persistent preferences);
wenzelm
parents: 48992
diff changeset
   470
75846
d9926523855e clarified signature --- avoid dependent types;
wenzelm
parents: 75845
diff changeset
   471
  val real: Options.Access_Variable[Double] =
75847
93436389db1c clarified signature: more explicit types;
wenzelm
parents: 75846
diff changeset
   472
    new Options.Access_Variable[Double](this, _.real)
49245
cb70157293c0 manage Isabelle/jEdit options as Isabelle/Scala options (with persistent preferences);
wenzelm
parents: 48992
diff changeset
   473
75846
d9926523855e clarified signature --- avoid dependent types;
wenzelm
parents: 75845
diff changeset
   474
  val string: Options.Access_Variable[String] =
75847
93436389db1c clarified signature: more explicit types;
wenzelm
parents: 75846
diff changeset
   475
    new Options.Access_Variable[String](this, _.string)
50207
54be125d8cdc tuned signature;
wenzelm
parents: 49954
diff changeset
   476
69074
787f3db8e313 tuned signature;
wenzelm
parents: 69073
diff changeset
   477
  def proper_string(name: String): Option[String] =
787f3db8e313 tuned signature;
wenzelm
parents: 69073
diff changeset
   478
    Library.proper_string(string(name))
787f3db8e313 tuned signature;
wenzelm
parents: 69073
diff changeset
   479
69073
d05defa39e3d tuned signature;
wenzelm
parents: 68841
diff changeset
   480
  def seconds(name: String): Time = value.seconds(name)
49245
cb70157293c0 manage Isabelle/jEdit options as Isabelle/Scala options (with persistent preferences);
wenzelm
parents: 48992
diff changeset
   481
}