src/Pure/System/options.scala
author wenzelm
Sun, 13 Apr 2014 16:42:44 +0200
changeset 56559 eece73c31e38
parent 56552 76cf86240cb7
child 56599 c4424d8c890f
permissions -rw-r--r--
added dictionaries_selector GUI; tuned;
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
48807
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
    10
import java.util.Calendar
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
    11
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
    12
48365
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
    13
object Options
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
    14
{
48421
c4d337782de4 propagate defined options;
wenzelm
parents: 48411
diff changeset
    15
  type Spec = (String, Option[String])
c4d337782de4 propagate defined options;
wenzelm
parents: 48411
diff changeset
    16
c4d337782de4 propagate defined options;
wenzelm
parents: 48411
diff changeset
    17
  val empty: Options = new Options()
c4d337782de4 propagate defined options;
wenzelm
parents: 48411
diff changeset
    18
c4d337782de4 propagate defined options;
wenzelm
parents: 48411
diff changeset
    19
c4d337782de4 propagate defined options;
wenzelm
parents: 48411
diff changeset
    20
  /* representation */
c4d337782de4 propagate defined options;
wenzelm
parents: 48411
diff changeset
    21
c4d337782de4 propagate defined options;
wenzelm
parents: 48411
diff changeset
    22
  sealed abstract class Type
48365
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
    23
  {
50299
f70b3712040f renamed dockable "Prover Session" to "Theories";
wenzelm
parents: 50207
diff changeset
    24
    def print: String = Library.lowercase(toString)
48365
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
    25
  }
49246
248e66e8321f more systematic JEdit_Options.make_component;
wenzelm
parents: 49245
diff changeset
    26
  case object Bool extends Type
248e66e8321f more systematic JEdit_Options.make_component;
wenzelm
parents: 49245
diff changeset
    27
  case object Int extends Type
248e66e8321f more systematic JEdit_Options.make_component;
wenzelm
parents: 49245
diff changeset
    28
  case object Real extends Type
248e66e8321f more systematic JEdit_Options.make_component;
wenzelm
parents: 49245
diff changeset
    29
  case object String extends Type
248e66e8321f more systematic JEdit_Options.make_component;
wenzelm
parents: 49245
diff changeset
    30
  case object Unknown extends Type
48365
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
    31
56465
6ad693903e22 more positions and markup;
wenzelm
parents: 55618
diff changeset
    32
  case class Opt(
6ad693903e22 more positions and markup;
wenzelm
parents: 55618
diff changeset
    33
    public: Boolean,
6ad693903e22 more positions and markup;
wenzelm
parents: 55618
diff changeset
    34
    pos: Position.T,
6ad693903e22 more positions and markup;
wenzelm
parents: 55618
diff changeset
    35
    name: String,
6ad693903e22 more positions and markup;
wenzelm
parents: 55618
diff changeset
    36
    typ: Type,
6ad693903e22 more positions and markup;
wenzelm
parents: 55618
diff changeset
    37
    value: String,
6ad693903e22 more positions and markup;
wenzelm
parents: 55618
diff changeset
    38
    default_value: String,
6ad693903e22 more positions and markup;
wenzelm
parents: 55618
diff changeset
    39
    description: String,
6ad693903e22 more positions and markup;
wenzelm
parents: 55618
diff changeset
    40
    section: String)
48860
56ec76f769c0 retain unknown options within preferences;
wenzelm
parents: 48807
diff changeset
    41
  {
49289
60424f123621 more informative tooltip: default value;
wenzelm
parents: 49270
diff changeset
    42
    private def print(default: Boolean): String =
60424f123621 more informative tooltip: default value;
wenzelm
parents: 49270
diff changeset
    43
    {
60424f123621 more informative tooltip: default value;
wenzelm
parents: 49270
diff changeset
    44
      val x = if (default) default_value else value
49247
ffd9ad9dc35b more detailed option tooltip;
wenzelm
parents: 49246
diff changeset
    45
      "option " + name + " : " + typ.print + " = " +
49289
60424f123621 more informative tooltip: default value;
wenzelm
parents: 49270
diff changeset
    46
        (if (typ == Options.String) quote(x) else x) +
60424f123621 more informative tooltip: default value;
wenzelm
parents: 49270
diff changeset
    47
        (if (description == "") "" else "\n  -- " + quote(description))
60424f123621 more informative tooltip: default value;
wenzelm
parents: 49270
diff changeset
    48
    }
60424f123621 more informative tooltip: default value;
wenzelm
parents: 49270
diff changeset
    49
60424f123621 more informative tooltip: default value;
wenzelm
parents: 49270
diff changeset
    50
    def print: String = print(false)
60424f123621 more informative tooltip: default value;
wenzelm
parents: 49270
diff changeset
    51
    def print_default: String = print(true)
49247
ffd9ad9dc35b more detailed option tooltip;
wenzelm
parents: 49246
diff changeset
    52
56559
eece73c31e38 added dictionaries_selector GUI;
wenzelm
parents: 56552
diff changeset
    53
    def title(strip: String = ""): String =
49270
e5d162d15867 some support to organize options in sections;
wenzelm
parents: 49247
diff changeset
    54
    {
e5d162d15867 some support to organize options in sections;
wenzelm
parents: 49247
diff changeset
    55
      val words = space_explode('_', name)
e5d162d15867 some support to organize options in sections;
wenzelm
parents: 49247
diff changeset
    56
      val words1 =
e5d162d15867 some support to organize options in sections;
wenzelm
parents: 49247
diff changeset
    57
        words match {
e5d162d15867 some support to organize options in sections;
wenzelm
parents: 49247
diff changeset
    58
          case word :: rest if word == strip => rest
e5d162d15867 some support to organize options in sections;
wenzelm
parents: 49247
diff changeset
    59
          case _ => words
e5d162d15867 some support to organize options in sections;
wenzelm
parents: 49247
diff changeset
    60
        }
56552
76cf86240cb7 some case-mangling;
wenzelm
parents: 56465
diff changeset
    61
      words1.map(Library.capitalize(_)).mkString(" ")
49270
e5d162d15867 some support to organize options in sections;
wenzelm
parents: 49247
diff changeset
    62
    }
e5d162d15867 some support to organize options in sections;
wenzelm
parents: 49247
diff changeset
    63
48860
56ec76f769c0 retain unknown options within preferences;
wenzelm
parents: 48807
diff changeset
    64
    def unknown: Boolean = typ == Unknown
56ec76f769c0 retain unknown options within preferences;
wenzelm
parents: 48807
diff changeset
    65
  }
48365
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
    66
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
    67
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
    68
  /* parsing */
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
    69
49270
e5d162d15867 some support to organize options in sections;
wenzelm
parents: 49247
diff changeset
    70
  private val SECTION = "section"
52065
78f2475aa126 explicit notion of public options, which are shown in the editor options dialog;
wenzelm
parents: 51945
diff changeset
    71
  private val PUBLIC = "public"
48795
bece259ee055 clarified format of etc/options: only declarations, not re-definitions;
wenzelm
parents: 48718
diff changeset
    72
  private val OPTION = "option"
48807
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
    73
  private val OPTIONS = Path.explode("etc/options")
50793
b93484db43ed create required PREFS_DIR;
wenzelm
parents: 50299
diff changeset
    74
  private val PREFS_DIR = Path.explode("$ISABELLE_HOME_USER/etc")
b93484db43ed create required PREFS_DIR;
wenzelm
parents: 50299
diff changeset
    75
  private val PREFS = PREFS_DIR + Path.basic("preferences")
48713
de26cf3191a3 more token markers, based on actual outer syntax;
wenzelm
parents: 48693
diff changeset
    76
49270
e5d162d15867 some support to organize options in sections;
wenzelm
parents: 49247
diff changeset
    77
  lazy val options_syntax =
e5d162d15867 some support to organize options in sections;
wenzelm
parents: 49247
diff changeset
    78
    Outer_Syntax.init() + ":" + "=" + "--" +
52065
78f2475aa126 explicit notion of public options, which are shown in the editor options dialog;
wenzelm
parents: 51945
diff changeset
    79
      (SECTION, Keyword.THY_HEADING2) + (PUBLIC, Keyword.THY_DECL) + (OPTION, Keyword.THY_DECL)
49270
e5d162d15867 some support to organize options in sections;
wenzelm
parents: 49247
diff changeset
    80
48807
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
    81
  lazy val prefs_syntax = Outer_Syntax.init() + "="
48713
de26cf3191a3 more token markers, based on actual outer syntax;
wenzelm
parents: 48693
diff changeset
    82
48807
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
    83
  object Parser extends Parse.Parser
48365
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
    84
  {
48807
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
    85
    val option_name = atom("option name", _.is_xname)
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
    86
    val option_type = atom("option type", _.is_ident)
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
    87
    val option_value =
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
    88
      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
    89
        { case s ~ n => if (s.isDefined) "-" + n else n } |
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
    90
      atom("option value", tok => tok.is_name || tok.is_float)
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
    91
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
    92
    val option_entry: Parser[Options => Options] =
48365
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
    93
    {
49270
e5d162d15867 some support to organize options in sections;
wenzelm
parents: 49247
diff changeset
    94
      command(SECTION) ~! text ^^
49295
2750756db9c5 more precise sections;
wenzelm
parents: 49289
diff changeset
    95
        { case _ ~ a => (options: Options) => options.set_section(a) } |
52065
78f2475aa126 explicit notion of public options, which are shown in the editor options dialog;
wenzelm
parents: 51945
diff changeset
    96
      opt(command(PUBLIC)) ~ command(OPTION) ~! (option_name ~ keyword(":") ~ option_type ~
48580
9df76dd45900 some description of main build options;
wenzelm
parents: 48548
diff changeset
    97
      keyword("=") ~ option_value ~ (keyword("--") ~! text ^^ { case _ ~ x => x } | success(""))) ^^
56465
6ad693903e22 more positions and markup;
wenzelm
parents: 55618
diff changeset
    98
        { case a ~ pos ~ (b ~ _ ~ c ~ _ ~ d ~ e) =>
6ad693903e22 more positions and markup;
wenzelm
parents: 55618
diff changeset
    99
            (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
   100
    }
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   101
48807
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
   102
    val prefs_entry: Parser[Options => Options] =
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
   103
    {
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
   104
      option_name ~ (keyword("=") ~! option_value) ^^
48860
56ec76f769c0 retain unknown options within preferences;
wenzelm
parents: 48807
diff changeset
   105
      { case a ~ (_ ~ b) => (options: Options) => options.add_permissive(a, b) }
48807
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
   106
    }
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
   107
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
   108
    def parse_file(syntax: Outer_Syntax, parser: Parser[Options => Options],
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
   109
      options: Options, file: Path): Options =
48365
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   110
    {
48807
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
   111
      val toks = syntax.scan(File.read(file))
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
   112
      val ops =
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
   113
        parse_all(rep(parser), Token.reader(toks, file.implode)) match {
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
   114
          case Success(result, _) => result
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
   115
          case bad => error(bad.toString)
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
   116
        }
49270
e5d162d15867 some support to organize options in sections;
wenzelm
parents: 49247
diff changeset
   117
      try { (options.set_section("") /: ops) { case (opts, op) => op(opts) } }
48992
0518bf89c777 renamed Position.str_of to Position.here;
wenzelm
parents: 48860
diff changeset
   118
      catch { case ERROR(msg) => error(msg + Position.here(file.position)) }
48365
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   119
    }
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   120
  }
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   121
48807
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
   122
  def init_defaults(): Options =
48365
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   123
  {
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   124
    var options = empty
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   125
    for {
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   126
      dir <- Isabelle_System.components()
48548
49afe0e92163 simplified Path vs. JVM File operations;
wenzelm
parents: 48457
diff changeset
   127
      file = dir + OPTIONS if file.is_file
48807
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
   128
    } { options = Parser.parse_file(options_syntax, Parser.option_entry, options, file) }
48365
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   129
    options
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   130
  }
48457
fd9e28d5a143 pass build options to ML;
wenzelm
parents: 48456
diff changeset
   131
48807
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
   132
  def init(): Options = init_defaults().load_prefs()
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
   133
48457
fd9e28d5a143 pass build options to ML;
wenzelm
parents: 48456
diff changeset
   134
fd9e28d5a143 pass build options to ML;
wenzelm
parents: 48456
diff changeset
   135
  /* encode */
fd9e28d5a143 pass build options to ML;
wenzelm
parents: 48456
diff changeset
   136
fd9e28d5a143 pass build options to ML;
wenzelm
parents: 48456
diff changeset
   137
  val encode: XML.Encode.T[Options] = (options => options.encode)
48693
ceeea46bdeba "isabelle options" prints Isabelle system options;
wenzelm
parents: 48605
diff changeset
   138
ceeea46bdeba "isabelle options" prints Isabelle system options;
wenzelm
parents: 48605
diff changeset
   139
ceeea46bdeba "isabelle options" prints Isabelle system options;
wenzelm
parents: 48605
diff changeset
   140
  /* command line entry point */
ceeea46bdeba "isabelle options" prints Isabelle system options;
wenzelm
parents: 48605
diff changeset
   141
ceeea46bdeba "isabelle options" prints Isabelle system options;
wenzelm
parents: 48605
diff changeset
   142
  def main(args: Array[String])
ceeea46bdeba "isabelle options" prints Isabelle system options;
wenzelm
parents: 48605
diff changeset
   143
  {
ceeea46bdeba "isabelle options" prints Isabelle system options;
wenzelm
parents: 48605
diff changeset
   144
    Command_Line.tool {
ceeea46bdeba "isabelle options" prints Isabelle system options;
wenzelm
parents: 48605
diff changeset
   145
      args.toList match {
52735
842b5e7dcac8 support isabelle options -g;
wenzelm
parents: 52065
diff changeset
   146
        case get_option :: export_file :: more_options =>
48807
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
   147
          val options = (Options.init() /: more_options)(_ + _)
48693
ceeea46bdeba "isabelle options" prints Isabelle system options;
wenzelm
parents: 48605
diff changeset
   148
52735
842b5e7dcac8 support isabelle options -g;
wenzelm
parents: 52065
diff changeset
   149
          if (get_option != "")
55618
995162143ef4 tuned imports;
wenzelm
parents: 54347
diff changeset
   150
            System.out.println(options.check_name(get_option).value)
52737
7b396ef36af6 clarified meaning of options for "isabelle options";
wenzelm
parents: 52735
diff changeset
   151
7b396ef36af6 clarified meaning of options for "isabelle options";
wenzelm
parents: 52735
diff changeset
   152
          if (export_file != "")
52735
842b5e7dcac8 support isabelle options -g;
wenzelm
parents: 52065
diff changeset
   153
            File.write(Path.explode(export_file), YXML.string_of_body(options.encode))
52737
7b396ef36af6 clarified meaning of options for "isabelle options";
wenzelm
parents: 52735
diff changeset
   154
7b396ef36af6 clarified meaning of options for "isabelle options";
wenzelm
parents: 52735
diff changeset
   155
          if (get_option == "" && export_file == "")
55618
995162143ef4 tuned imports;
wenzelm
parents: 54347
diff changeset
   156
            System.out.println(options.print)
48693
ceeea46bdeba "isabelle options" prints Isabelle system options;
wenzelm
parents: 48605
diff changeset
   157
ceeea46bdeba "isabelle options" prints Isabelle system options;
wenzelm
parents: 48605
diff changeset
   158
          0
ceeea46bdeba "isabelle options" prints Isabelle system options;
wenzelm
parents: 48605
diff changeset
   159
        case _ => error("Bad arguments:\n" + cat_lines(args))
ceeea46bdeba "isabelle options" prints Isabelle system options;
wenzelm
parents: 48605
diff changeset
   160
      }
ceeea46bdeba "isabelle options" prints Isabelle system options;
wenzelm
parents: 48605
diff changeset
   161
    }
ceeea46bdeba "isabelle options" prints Isabelle system options;
wenzelm
parents: 48605
diff changeset
   162
  }
48365
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   163
}
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   164
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   165
49270
e5d162d15867 some support to organize options in sections;
wenzelm
parents: 49247
diff changeset
   166
final class Options private(
49296
313369027391 some GUI support for color options;
wenzelm
parents: 49295
diff changeset
   167
  val options: Map[String, Options.Opt] = Map.empty,
49270
e5d162d15867 some support to organize options in sections;
wenzelm
parents: 49247
diff changeset
   168
  val section: String = "")
48365
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   169
{
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   170
  override def toString: String = options.iterator.mkString("Options (", ",", ")")
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   171
54347
d5589530f3ba clarified isabelle options -l;
wenzelm
parents: 53336
diff changeset
   172
  private def print_opt(opt: Options.Opt): String =
d5589530f3ba clarified isabelle options -l;
wenzelm
parents: 53336
diff changeset
   173
    if (opt.public) "public " + opt.print else opt.print
d5589530f3ba clarified isabelle options -l;
wenzelm
parents: 53336
diff changeset
   174
d5589530f3ba clarified isabelle options -l;
wenzelm
parents: 53336
diff changeset
   175
  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
   176
49245
cb70157293c0 manage Isabelle/jEdit options as Isabelle/Scala options (with persistent preferences);
wenzelm
parents: 48992
diff changeset
   177
  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
   178
48365
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   179
48370
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   180
  /* check */
48365
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   181
49246
248e66e8321f more systematic JEdit_Options.make_component;
wenzelm
parents: 49245
diff changeset
   182
  def check_name(name: String): Options.Opt =
48365
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   183
    options.get(name) match {
48860
56ec76f769c0 retain unknown options within preferences;
wenzelm
parents: 48807
diff changeset
   184
      case Some(opt) if !opt.unknown => opt
56ec76f769c0 retain unknown options within preferences;
wenzelm
parents: 48807
diff changeset
   185
      case _ => error("Unknown option " + quote(name))
48365
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   186
    }
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   187
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   188
  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
   189
  {
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   190
    val opt = check_name(name)
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   191
    if (opt.typ == typ) opt
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   192
    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
   193
  }
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   194
48370
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   195
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   196
  /* basic operations */
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   197
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   198
  private def put[A](name: String, typ: Options.Type, value: String): Options =
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   199
  {
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   200
    val opt = check_type(name, typ)
49270
e5d162d15867 some support to organize options in sections;
wenzelm
parents: 49247
diff changeset
   201
    new Options(options + (name -> opt.copy(value = value)), section)
48370
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   202
  }
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   203
48365
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   204
  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
   205
  {
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   206
    val opt = check_type(name, typ)
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   207
    parse(opt.value) match {
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   208
      case Some(x) => x
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   209
      case None =>
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   210
        error("Malformed value for option " + quote(name) +
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   211
          " : " + typ.print + " =\n" + quote(opt.value))
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   212
    }
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   213
  }
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   214
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   215
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   216
  /* internal lookup and update */
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   217
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
   218
  class Bool_Access
48365
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   219
  {
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   220
    def apply(name: String): Boolean = get(name, Options.Bool, Properties.Value.Boolean.unapply)
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   221
    def update(name: String, x: Boolean): Options =
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   222
      put(name, Options.Bool, Properties.Value.Boolean(x))
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   223
  }
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
   224
  val bool = new Bool_Access
48365
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   225
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
   226
  class Int_Access
48365
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
    def apply(name: String): Int = get(name, Options.Int, Properties.Value.Int.unapply)
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   229
    def update(name: String, x: Int): Options =
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   230
      put(name, Options.Int, Properties.Value.Int(x))
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   231
  }
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
   232
  val int = new Int_Access
48365
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   233
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
   234
  class Real_Access
48365
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   235
  {
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   236
    def apply(name: String): Double = get(name, Options.Real, Properties.Value.Double.unapply)
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   237
    def update(name: String, x: Double): Options =
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   238
      put(name, Options.Real, Properties.Value.Double(x))
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   239
  }
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
   240
  val real = new Real_Access
48365
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   241
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
   242
  class String_Access
48365
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   243
  {
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   244
    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
   245
    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
   246
  }
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
   247
  val string = new String_Access
48370
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   248
50207
54be125d8cdc tuned signature;
wenzelm
parents: 49954
diff changeset
   249
  class Seconds_Access
54be125d8cdc tuned signature;
wenzelm
parents: 49954
diff changeset
   250
  {
54be125d8cdc tuned signature;
wenzelm
parents: 49954
diff changeset
   251
    def apply(name: String): Time = Time.seconds(real(name))
54be125d8cdc tuned signature;
wenzelm
parents: 49954
diff changeset
   252
  }
54be125d8cdc tuned signature;
wenzelm
parents: 49954
diff changeset
   253
  val seconds = new Seconds_Access
54be125d8cdc tuned signature;
wenzelm
parents: 49954
diff changeset
   254
48370
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   255
48807
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
   256
  /* external updates */
48370
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   257
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   258
  private def check_value(name: String): Options =
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   259
  {
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   260
    val opt = check_name(name)
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   261
    opt.typ match {
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   262
      case Options.Bool => bool(name); this
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   263
      case Options.Int => int(name); this
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   264
      case Options.Real => real(name); this
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   265
      case Options.String => string(name); this
48860
56ec76f769c0 retain unknown options within preferences;
wenzelm
parents: 48807
diff changeset
   266
      case Options.Unknown => this
48370
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   267
    }
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   268
  }
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   269
56465
6ad693903e22 more positions and markup;
wenzelm
parents: 55618
diff changeset
   270
  def declare(
6ad693903e22 more positions and markup;
wenzelm
parents: 55618
diff changeset
   271
    public: Boolean,
6ad693903e22 more positions and markup;
wenzelm
parents: 55618
diff changeset
   272
    pos: Position.T,
6ad693903e22 more positions and markup;
wenzelm
parents: 55618
diff changeset
   273
    name: String,
6ad693903e22 more positions and markup;
wenzelm
parents: 55618
diff changeset
   274
    typ_name: String,
6ad693903e22 more positions and markup;
wenzelm
parents: 55618
diff changeset
   275
    value: String,
6ad693903e22 more positions and markup;
wenzelm
parents: 55618
diff changeset
   276
    description: String): Options =
48370
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   277
  {
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   278
    options.get(name) match {
56465
6ad693903e22 more positions and markup;
wenzelm
parents: 55618
diff changeset
   279
      case Some(other) =>
6ad693903e22 more positions and markup;
wenzelm
parents: 55618
diff changeset
   280
        error("Duplicate declaration of option " + quote(name) + Position.here(pos) +
6ad693903e22 more positions and markup;
wenzelm
parents: 55618
diff changeset
   281
          Position.here(other.pos))
48370
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   282
      case None =>
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   283
        val typ =
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   284
          typ_name match {
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   285
            case "bool" => Options.Bool
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   286
            case "int" => Options.Int
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   287
            case "real" => Options.Real
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   288
            case "string" => Options.String
56465
6ad693903e22 more positions and markup;
wenzelm
parents: 55618
diff changeset
   289
            case _ =>
6ad693903e22 more positions and markup;
wenzelm
parents: 55618
diff changeset
   290
              error("Unknown type for option " + quote(name) + " : " + quote(typ_name) +
6ad693903e22 more positions and markup;
wenzelm
parents: 55618
diff changeset
   291
                Position.here(pos))
48370
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   292
          }
56465
6ad693903e22 more positions and markup;
wenzelm
parents: 55618
diff changeset
   293
        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
   294
        (new Options(options + (name -> opt), section)).check_value(name)
48370
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   295
    }
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   296
  }
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   297
48860
56ec76f769c0 retain unknown options within preferences;
wenzelm
parents: 48807
diff changeset
   298
  def add_permissive(name: String, value: String): Options =
56ec76f769c0 retain unknown options within preferences;
wenzelm
parents: 48807
diff changeset
   299
  {
56ec76f769c0 retain unknown options within preferences;
wenzelm
parents: 48807
diff changeset
   300
    if (options.isDefinedAt(name)) this + (name, value)
56465
6ad693903e22 more positions and markup;
wenzelm
parents: 55618
diff changeset
   301
    else {
6ad693903e22 more positions and markup;
wenzelm
parents: 55618
diff changeset
   302
      val opt = Options.Opt(false, Position.none, name, Options.Unknown, value, value, "", "")
6ad693903e22 more positions and markup;
wenzelm
parents: 55618
diff changeset
   303
      new Options(options + (name -> opt), section)
6ad693903e22 more positions and markup;
wenzelm
parents: 55618
diff changeset
   304
    }
48860
56ec76f769c0 retain unknown options within preferences;
wenzelm
parents: 48807
diff changeset
   305
  }
56ec76f769c0 retain unknown options within preferences;
wenzelm
parents: 48807
diff changeset
   306
48807
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
   307
  def + (name: String, value: String): Options =
48370
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   308
  {
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   309
    val opt = check_name(name)
49270
e5d162d15867 some support to organize options in sections;
wenzelm
parents: 49247
diff changeset
   310
    (new Options(options + (name -> opt.copy(value = value)), section)).check_value(name)
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
48807
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
   313
  def + (name: String, opt_value: Option[String]): Options =
48370
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   314
  {
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   315
    val opt = check_name(name)
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   316
    opt_value match {
48807
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
   317
      case Some(value) => this + (name, value)
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
   318
      case None if opt.typ == Options.Bool => this + (name, "true")
48370
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   319
      case None => error("Missing value for option " + quote(name) + " : " + opt.typ.print)
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   320
    }
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   321
  }
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   322
48807
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
   323
  def + (str: String): Options =
48370
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   324
  {
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   325
    str.indexOf('=') match {
48807
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
   326
      case -1 => this + (str, None)
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
   327
      case i => this + (str.substring(0, i), str.substring(i + 1))
48370
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   328
    }
d0fa3efec93b require explicit initialization of options;
wenzelm
parents: 48369
diff changeset
   329
  }
48456
d8ff14f44a40 added ML version of stand-alone options, with XML.encode/decode operations (unidirectional from Scala to ML);
wenzelm
parents: 48421
diff changeset
   330
48807
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
   331
  def ++ (specs: List[Options.Spec]): Options =
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
   332
    (this /: specs)({ case (x, (y, z)) => x + (y, z) })
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
   333
48456
d8ff14f44a40 added ML version of stand-alone options, with XML.encode/decode operations (unidirectional from Scala to ML);
wenzelm
parents: 48421
diff changeset
   334
49270
e5d162d15867 some support to organize options in sections;
wenzelm
parents: 49247
diff changeset
   335
  /* sections */
e5d162d15867 some support to organize options in sections;
wenzelm
parents: 49247
diff changeset
   336
e5d162d15867 some support to organize options in sections;
wenzelm
parents: 49247
diff changeset
   337
  def set_section(new_section: String): Options =
e5d162d15867 some support to organize options in sections;
wenzelm
parents: 49247
diff changeset
   338
    new Options(options, new_section)
e5d162d15867 some support to organize options in sections;
wenzelm
parents: 49247
diff changeset
   339
e5d162d15867 some support to organize options in sections;
wenzelm
parents: 49247
diff changeset
   340
  def sections: List[(String, List[Options.Opt])] =
e5d162d15867 some support to organize options in sections;
wenzelm
parents: 49247
diff changeset
   341
    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
   342
e5d162d15867 some support to organize options in sections;
wenzelm
parents: 49247
diff changeset
   343
48456
d8ff14f44a40 added ML version of stand-alone options, with XML.encode/decode operations (unidirectional from Scala to ML);
wenzelm
parents: 48421
diff changeset
   344
  /* encode */
d8ff14f44a40 added ML version of stand-alone options, with XML.encode/decode operations (unidirectional from Scala to ML);
wenzelm
parents: 48421
diff changeset
   345
d8ff14f44a40 added ML version of stand-alone options, with XML.encode/decode operations (unidirectional from Scala to ML);
wenzelm
parents: 48421
diff changeset
   346
  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
   347
  {
48860
56ec76f769c0 retain unknown options within preferences;
wenzelm
parents: 48807
diff changeset
   348
    val opts =
56465
6ad693903e22 more positions and markup;
wenzelm
parents: 55618
diff changeset
   349
      for ((_, opt) <- options.toList; if !opt.unknown)
6ad693903e22 more positions and markup;
wenzelm
parents: 55618
diff changeset
   350
        yield (opt.pos, (opt.name, (opt.typ.print, opt.value)))
48860
56ec76f769c0 retain unknown options within preferences;
wenzelm
parents: 48807
diff changeset
   351
56465
6ad693903e22 more positions and markup;
wenzelm
parents: 55618
diff changeset
   352
    import XML.Encode.{string => string_, _}
6ad693903e22 more positions and markup;
wenzelm
parents: 55618
diff changeset
   353
    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
   354
  }
48807
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
   355
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
   356
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
   357
  /* user preferences */
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
   358
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
   359
  def load_prefs(): Options =
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
   360
    if (Options.PREFS.is_file)
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
   361
      Options.Parser.parse_file(
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
   362
        Options.prefs_syntax, Options.Parser.prefs_entry, this, Options.PREFS)
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
   363
    else this
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
   364
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
   365
  def save_prefs()
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
   366
  {
48860
56ec76f769c0 retain unknown options within preferences;
wenzelm
parents: 48807
diff changeset
   367
    val defaults = Options.init_defaults()
48807
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
   368
    val changed =
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
   369
      (for {
48860
56ec76f769c0 retain unknown options within preferences;
wenzelm
parents: 48807
diff changeset
   370
        (name, opt2) <- options.iterator
56ec76f769c0 retain unknown options within preferences;
wenzelm
parents: 48807
diff changeset
   371
        opt1 = defaults.options.get(name)
56ec76f769c0 retain unknown options within preferences;
wenzelm
parents: 48807
diff changeset
   372
        if (opt1.isEmpty || opt1.get.value != opt2.value)
56ec76f769c0 retain unknown options within preferences;
wenzelm
parents: 48807
diff changeset
   373
      } yield (name, opt2.value, if (opt1.isEmpty) "  (* unknown *)" else "")).toList
56ec76f769c0 retain unknown options within preferences;
wenzelm
parents: 48807
diff changeset
   374
48807
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
   375
    val prefs =
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
   376
      changed.sortBy(_._1)
48860
56ec76f769c0 retain unknown options within preferences;
wenzelm
parents: 48807
diff changeset
   377
        .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
   378
50893
d55eb82ae77b Isabelle_System.mkdirs with explicit error checking (in accordance to ML version), e.g. relevant with read-only DMG file-system on Mac OS X;
wenzelm
parents: 50793
diff changeset
   379
    Isabelle_System.mkdirs(Options.PREFS_DIR)
53336
b3bf6d72fea5 more general backup files;
wenzelm
parents: 52737
diff changeset
   380
    File.write_backup(Options.PREFS,
48807
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
   381
      "(* generated by Isabelle " + Calendar.getInstance.getTime + " *)\n\n" + prefs)
fde8c3d84ff5 some support for persistent user preferences;
wenzelm
parents: 48795
diff changeset
   382
  }
48365
d88aefda01c4 basic support for stand-alone options with external string representation;
wenzelm
parents:
diff changeset
   383
}
49245
cb70157293c0 manage Isabelle/jEdit options as Isabelle/Scala options (with persistent preferences);
wenzelm
parents: 48992
diff changeset
   384
cb70157293c0 manage Isabelle/jEdit options as Isabelle/Scala options (with persistent preferences);
wenzelm
parents: 48992
diff changeset
   385
cb70157293c0 manage Isabelle/jEdit options as Isabelle/Scala options (with persistent preferences);
wenzelm
parents: 48992
diff changeset
   386
class Options_Variable
cb70157293c0 manage Isabelle/jEdit options as Isabelle/Scala options (with persistent preferences);
wenzelm
parents: 48992
diff changeset
   387
{
51620
7c39677f9ea0 more conventional synchronized access to Options_Variable -- avoid Swing_Thread getting in the way, which might be absent in some environments (e.g. SWT);
wenzelm
parents: 50893
diff changeset
   388
  private var options = Options.empty
49245
cb70157293c0 manage Isabelle/jEdit options as Isabelle/Scala options (with persistent preferences);
wenzelm
parents: 48992
diff changeset
   389
51620
7c39677f9ea0 more conventional synchronized access to Options_Variable -- avoid Swing_Thread getting in the way, which might be absent in some environments (e.g. SWT);
wenzelm
parents: 50893
diff changeset
   390
  def value: Options = synchronized { options }
7c39677f9ea0 more conventional synchronized access to Options_Variable -- avoid Swing_Thread getting in the way, which might be absent in some environments (e.g. SWT);
wenzelm
parents: 50893
diff changeset
   391
  def update(new_options: Options): Unit = synchronized { options = new_options }
49245
cb70157293c0 manage Isabelle/jEdit options as Isabelle/Scala options (with persistent preferences);
wenzelm
parents: 48992
diff changeset
   392
51620
7c39677f9ea0 more conventional synchronized access to Options_Variable -- avoid Swing_Thread getting in the way, which might be absent in some environments (e.g. SWT);
wenzelm
parents: 50893
diff changeset
   393
  def + (name: String, x: String): Unit = synchronized { options = options + (name, x) }
49245
cb70157293c0 manage Isabelle/jEdit options as Isabelle/Scala options (with persistent preferences);
wenzelm
parents: 48992
diff changeset
   394
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
   395
  class Bool_Access
49245
cb70157293c0 manage Isabelle/jEdit options as Isabelle/Scala options (with persistent preferences);
wenzelm
parents: 48992
diff changeset
   396
  {
51620
7c39677f9ea0 more conventional synchronized access to Options_Variable -- avoid Swing_Thread getting in the way, which might be absent in some environments (e.g. SWT);
wenzelm
parents: 50893
diff changeset
   397
    def apply(name: String): Boolean = synchronized { options.bool(name) }
7c39677f9ea0 more conventional synchronized access to Options_Variable -- avoid Swing_Thread getting in the way, which might be absent in some environments (e.g. SWT);
wenzelm
parents: 50893
diff changeset
   398
    def update(name: String, x: Boolean): Unit =
7c39677f9ea0 more conventional synchronized access to Options_Variable -- avoid Swing_Thread getting in the way, which might be absent in some environments (e.g. SWT);
wenzelm
parents: 50893
diff changeset
   399
      synchronized { options = options.bool.update(name, x) }
49245
cb70157293c0 manage Isabelle/jEdit options as Isabelle/Scala options (with persistent preferences);
wenzelm
parents: 48992
diff changeset
   400
  }
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
   401
  val bool = new Bool_Access
49245
cb70157293c0 manage Isabelle/jEdit options as Isabelle/Scala options (with persistent preferences);
wenzelm
parents: 48992
diff changeset
   402
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
   403
  class Int_Access
49245
cb70157293c0 manage Isabelle/jEdit options as Isabelle/Scala options (with persistent preferences);
wenzelm
parents: 48992
diff changeset
   404
  {
51620
7c39677f9ea0 more conventional synchronized access to Options_Variable -- avoid Swing_Thread getting in the way, which might be absent in some environments (e.g. SWT);
wenzelm
parents: 50893
diff changeset
   405
    def apply(name: String): Int = synchronized { options.int(name) }
7c39677f9ea0 more conventional synchronized access to Options_Variable -- avoid Swing_Thread getting in the way, which might be absent in some environments (e.g. SWT);
wenzelm
parents: 50893
diff changeset
   406
    def update(name: String, x: Int): Unit =
7c39677f9ea0 more conventional synchronized access to Options_Variable -- avoid Swing_Thread getting in the way, which might be absent in some environments (e.g. SWT);
wenzelm
parents: 50893
diff changeset
   407
      synchronized { options = options.int.update(name, x) }
49245
cb70157293c0 manage Isabelle/jEdit options as Isabelle/Scala options (with persistent preferences);
wenzelm
parents: 48992
diff changeset
   408
  }
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
   409
  val int = new Int_Access
49245
cb70157293c0 manage Isabelle/jEdit options as Isabelle/Scala options (with persistent preferences);
wenzelm
parents: 48992
diff changeset
   410
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
   411
  class Real_Access
49245
cb70157293c0 manage Isabelle/jEdit options as Isabelle/Scala options (with persistent preferences);
wenzelm
parents: 48992
diff changeset
   412
  {
51620
7c39677f9ea0 more conventional synchronized access to Options_Variable -- avoid Swing_Thread getting in the way, which might be absent in some environments (e.g. SWT);
wenzelm
parents: 50893
diff changeset
   413
    def apply(name: String): Double = synchronized { options.real(name) }
7c39677f9ea0 more conventional synchronized access to Options_Variable -- avoid Swing_Thread getting in the way, which might be absent in some environments (e.g. SWT);
wenzelm
parents: 50893
diff changeset
   414
    def update(name: String, x: Double): Unit =
7c39677f9ea0 more conventional synchronized access to Options_Variable -- avoid Swing_Thread getting in the way, which might be absent in some environments (e.g. SWT);
wenzelm
parents: 50893
diff changeset
   415
      synchronized { options = options.real.update(name, x) }
49245
cb70157293c0 manage Isabelle/jEdit options as Isabelle/Scala options (with persistent preferences);
wenzelm
parents: 48992
diff changeset
   416
  }
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
   417
  val real = new Real_Access
49245
cb70157293c0 manage Isabelle/jEdit options as Isabelle/Scala options (with persistent preferences);
wenzelm
parents: 48992
diff changeset
   418
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
   419
  class String_Access
49245
cb70157293c0 manage Isabelle/jEdit options as Isabelle/Scala options (with persistent preferences);
wenzelm
parents: 48992
diff changeset
   420
  {
51620
7c39677f9ea0 more conventional synchronized access to Options_Variable -- avoid Swing_Thread getting in the way, which might be absent in some environments (e.g. SWT);
wenzelm
parents: 50893
diff changeset
   421
    def apply(name: String): String = synchronized { options.string(name) }
7c39677f9ea0 more conventional synchronized access to Options_Variable -- avoid Swing_Thread getting in the way, which might be absent in some environments (e.g. SWT);
wenzelm
parents: 50893
diff changeset
   422
    def update(name: String, x: String): Unit =
7c39677f9ea0 more conventional synchronized access to Options_Variable -- avoid Swing_Thread getting in the way, which might be absent in some environments (e.g. SWT);
wenzelm
parents: 50893
diff changeset
   423
      synchronized { options = options.string.update(name, x) }
49245
cb70157293c0 manage Isabelle/jEdit options as Isabelle/Scala options (with persistent preferences);
wenzelm
parents: 48992
diff changeset
   424
  }
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
   425
  val string = new String_Access
50207
54be125d8cdc tuned signature;
wenzelm
parents: 49954
diff changeset
   426
54be125d8cdc tuned signature;
wenzelm
parents: 49954
diff changeset
   427
  class Seconds_Access
54be125d8cdc tuned signature;
wenzelm
parents: 49954
diff changeset
   428
  {
51620
7c39677f9ea0 more conventional synchronized access to Options_Variable -- avoid Swing_Thread getting in the way, which might be absent in some environments (e.g. SWT);
wenzelm
parents: 50893
diff changeset
   429
    def apply(name: String): Time = synchronized { options.seconds(name) }
50207
54be125d8cdc tuned signature;
wenzelm
parents: 49954
diff changeset
   430
  }
54be125d8cdc tuned signature;
wenzelm
parents: 49954
diff changeset
   431
  val seconds = new Seconds_Access
49245
cb70157293c0 manage Isabelle/jEdit options as Isabelle/Scala options (with persistent preferences);
wenzelm
parents: 48992
diff changeset
   432
}
cb70157293c0 manage Isabelle/jEdit options as Isabelle/Scala options (with persistent preferences);
wenzelm
parents: 48992
diff changeset
   433