src/Pure/PIDE/markup.scala
author wenzelm
Wed Jan 03 20:55:13 2018 +0100 (17 months ago ago)
changeset 67336 3ee6da378183
parent 67323 d02208cefbdb
child 67839 0c2ed45ece20
permissions -rw-r--r--
HTML output for Markdown elements;
clarified HTML operations;
wenzelm@45670
     1
/*  Title:      Pure/PIDE/markup.scala
wenzelm@27958
     2
    Author:     Makarius
wenzelm@27958
     3
wenzelm@56743
     4
Quasi-abstract markup elements.
wenzelm@27958
     5
*/
wenzelm@27958
     6
wenzelm@27958
     7
package isabelle
wenzelm@27958
     8
wenzelm@27970
     9
wenzelm@32450
    10
object Markup
wenzelm@32450
    11
{
wenzelm@56743
    12
  /* elements */
wenzelm@56743
    13
wenzelm@56743
    14
  object Elements
wenzelm@56743
    15
  {
wenzelm@56743
    16
    def apply(elems: Set[String]): Elements = new Elements(elems)
wenzelm@56743
    17
    def apply(elems: String*): Elements = apply(Set(elems: _*))
wenzelm@56743
    18
    val empty: Elements = apply()
wenzelm@56743
    19
    val full: Elements =
wenzelm@56743
    20
      new Elements(Set.empty)
wenzelm@56743
    21
      {
wenzelm@56743
    22
        override def apply(elem: String): Boolean = true
wenzelm@56743
    23
        override def toString: String = "Elements.full"
wenzelm@56743
    24
      }
wenzelm@56743
    25
  }
wenzelm@56743
    26
wenzelm@56743
    27
  sealed class Elements private[Markup](private val rep: Set[String])
wenzelm@56743
    28
  {
wenzelm@56743
    29
    def apply(elem: String): Boolean = rep.contains(elem)
wenzelm@56743
    30
    def + (elem: String): Elements = new Elements(rep + elem)
wenzelm@56743
    31
    def ++ (elems: Elements): Elements = new Elements(rep ++ elems.rep)
wenzelm@65176
    32
    def - (elem: String): Elements = new Elements(rep - elem)
wenzelm@65176
    33
    def -- (elems: Elements): Elements = new Elements(rep -- elems.rep)
wenzelm@56743
    34
    override def toString: String = rep.mkString("Elements(", ",", ")")
wenzelm@56743
    35
  }
wenzelm@56743
    36
wenzelm@56743
    37
wenzelm@45666
    38
  /* properties */
wenzelm@29184
    39
wenzelm@29184
    40
  val NAME = "name"
wenzelm@43780
    41
  val Name = new Properties.String(NAME)
wenzelm@42136
    42
wenzelm@29184
    43
  val KIND = "kind"
wenzelm@43780
    44
  val Kind = new Properties.String(KIND)
wenzelm@29184
    45
wenzelm@65937
    46
  val CONTENT = "content"
wenzelm@65937
    47
  val Content = new Properties.String(CONTENT)
wenzelm@65937
    48
wenzelm@60744
    49
  val SERIAL = "serial"
wenzelm@60744
    50
  val Serial = new Properties.Long(SERIAL)
wenzelm@60744
    51
wenzelm@52854
    52
  val INSTANCE = "instance"
wenzelm@52854
    53
  val Instance = new Properties.String(INSTANCE)
wenzelm@52854
    54
wenzelm@29184
    55
wenzelm@50201
    56
  /* basic markup */
wenzelm@29184
    57
wenzelm@45666
    58
  val Empty = Markup("", Nil)
wenzelm@45666
    59
  val Broken = Markup("broken", Nil)
wenzelm@50201
    60
wenzelm@55553
    61
  class Markup_String(val name: String, prop: String)
wenzelm@55553
    62
  {
wenzelm@55553
    63
    private val Prop = new Properties.String(prop)
wenzelm@55553
    64
wenzelm@55553
    65
    def apply(s: String): Markup = Markup(name, Prop(s))
wenzelm@55553
    66
    def unapply(markup: Markup): Option[String] =
wenzelm@55553
    67
      if (markup.name == name) Prop.unapply(markup.properties) else None
wenzelm@55553
    68
  }
wenzelm@55553
    69
wenzelm@55553
    70
  class Markup_Int(val name: String, prop: String)
wenzelm@55553
    71
  {
wenzelm@55553
    72
    private val Prop = new Properties.Int(prop)
wenzelm@55553
    73
wenzelm@55553
    74
    def apply(i: Int): Markup = Markup(name, Prop(i))
wenzelm@55553
    75
    def unapply(markup: Markup): Option[Int] =
wenzelm@55553
    76
      if (markup.name == name) Prop.unapply(markup.properties) else None
wenzelm@55553
    77
  }
wenzelm@55553
    78
wenzelm@60744
    79
  class Markup_Long(val name: String, prop: String)
wenzelm@60744
    80
  {
wenzelm@60744
    81
    private val Prop = new Properties.Long(prop)
wenzelm@60744
    82
wenzelm@60744
    83
    def apply(i: Long): Markup = Markup(name, Prop(i))
wenzelm@60744
    84
    def unapply(markup: Markup): Option[Long] =
wenzelm@60744
    85
      if (markup.name == name) Prop.unapply(markup.properties) else None
wenzelm@60744
    86
  }
wenzelm@60744
    87
wenzelm@50201
    88
wenzelm@50201
    89
  /* formal entities */
wenzelm@50201
    90
wenzelm@50201
    91
  val BINDING = "binding"
wenzelm@50201
    92
  val ENTITY = "entity"
wenzelm@50201
    93
wenzelm@50201
    94
  object Entity
wenzelm@50201
    95
  {
wenzelm@62986
    96
    val Def = new Properties.Long("def")
wenzelm@62986
    97
    val Ref = new Properties.Long("ref")
wenzelm@62986
    98
wenzelm@50201
    99
    def unapply(markup: Markup): Option[(String, String)] =
wenzelm@50201
   100
      markup match {
wenzelm@55553
   101
        case Markup(ENTITY, props) =>
wenzelm@63337
   102
          val kind = Kind.unapply(props).getOrElse("")
wenzelm@63337
   103
          val name = Name.unapply(props).getOrElse("")
wenzelm@63337
   104
          Some((kind, name))
wenzelm@50201
   105
        case _ => None
wenzelm@50201
   106
      }
wenzelm@50201
   107
  }
wenzelm@50201
   108
wenzelm@50201
   109
wenzelm@55672
   110
  /* completion */
wenzelm@55672
   111
wenzelm@55672
   112
  val COMPLETION = "completion"
wenzelm@55914
   113
  val NO_COMPLETION = "no_completion"
wenzelm@55672
   114
wenzelm@55672
   115
wenzelm@50201
   116
  /* position */
wenzelm@50201
   117
wenzelm@50201
   118
  val LINE = "line"
wenzelm@58978
   119
  val END_LINE = "line"
wenzelm@50201
   120
  val OFFSET = "offset"
wenzelm@50201
   121
  val END_OFFSET = "end_offset"
wenzelm@50201
   122
  val FILE = "file"
wenzelm@50201
   123
  val ID = "id"
wenzelm@50201
   124
wenzelm@50201
   125
  val DEF_LINE = "def_line"
wenzelm@50201
   126
  val DEF_OFFSET = "def_offset"
wenzelm@50201
   127
  val DEF_END_OFFSET = "def_end_offset"
wenzelm@50201
   128
  val DEF_FILE = "def_file"
wenzelm@50201
   129
  val DEF_ID = "def_id"
wenzelm@50201
   130
wenzelm@50201
   131
  val POSITION_PROPERTIES = Set(LINE, OFFSET, END_OFFSET, FILE, ID)
wenzelm@50201
   132
  val POSITION = "position"
wenzelm@50201
   133
wenzelm@50201
   134
wenzelm@58464
   135
  /* expression */
wenzelm@58464
   136
wenzelm@58464
   137
  val EXPRESSION = "expression"
wenzelm@62806
   138
  object Expression
wenzelm@62806
   139
  {
wenzelm@62806
   140
    def unapply(markup: Markup): Option[String] =
wenzelm@62806
   141
      markup match {
wenzelm@62806
   142
        case Markup(EXPRESSION, Kind(kind)) => Some(kind)
wenzelm@62806
   143
        case Markup(EXPRESSION, _) => Some("")
wenzelm@62806
   144
        case _ => None
wenzelm@62806
   145
      }
wenzelm@62806
   146
  }
wenzelm@58464
   147
wenzelm@58464
   148
wenzelm@58544
   149
  /* citation */
wenzelm@58544
   150
wenzelm@58544
   151
  val CITATION = "citation"
wenzelm@58545
   152
  val Citation = new Markup_String(CITATION, NAME)
wenzelm@58544
   153
wenzelm@58544
   154
wenzelm@55552
   155
  /* embedded languages */
wenzelm@55552
   156
wenzelm@55666
   157
  val Symbols = new Properties.Boolean("symbols")
wenzelm@55666
   158
  val Antiquotes = new Properties.Boolean("antiquotes")
wenzelm@55828
   159
  val Delimited = new Properties.Boolean("delimited")
wenzelm@55615
   160
wenzelm@55552
   161
  val LANGUAGE = "language"
wenzelm@55615
   162
  object Language
wenzelm@55615
   163
  {
wenzelm@67336
   164
    val DOCUMENT = "document"
wenzelm@55616
   165
    val ML = "ML"
wenzelm@56278
   166
    val SML = "SML"
wenzelm@56843
   167
    val PATH = "path"
wenzelm@55616
   168
    val UNKNOWN = "unknown"
wenzelm@55616
   169
wenzelm@55828
   170
    def unapply(markup: Markup): Option[(String, Boolean, Boolean, Boolean)] =
wenzelm@55615
   171
      markup match {
wenzelm@55615
   172
        case Markup(LANGUAGE, props) =>
wenzelm@55828
   173
          (props, props, props, props) match {
wenzelm@55828
   174
            case (Name(name), Symbols(symbols), Antiquotes(antiquotes), Delimited(delimited)) =>
wenzelm@55828
   175
              Some((name, symbols, antiquotes, delimited))
wenzelm@55615
   176
            case _ => None
wenzelm@55615
   177
          }
wenzelm@55615
   178
        case _ => None
wenzelm@55615
   179
      }
wenzelm@55615
   180
  }
wenzelm@55552
   181
wenzelm@55552
   182
wenzelm@54702
   183
  /* external resources */
wenzelm@50201
   184
wenzelm@50201
   185
  val PATH = "path"
wenzelm@55553
   186
  val Path = new Markup_String(PATH, NAME)
wenzelm@50201
   187
wenzelm@54702
   188
  val URL = "url"
wenzelm@55553
   189
  val Url = new Markup_String(URL, NAME)
wenzelm@54702
   190
wenzelm@61660
   191
  val DOC = "doc"
wenzelm@61660
   192
  val Doc = new Markup_String(DOC, NAME)
wenzelm@61660
   193
wenzelm@50201
   194
wenzelm@50201
   195
  /* pretty printing */
wenzelm@50201
   196
wenzelm@61866
   197
  val Consistent = new Properties.Boolean("consistent")
wenzelm@61864
   198
  val Indent = new Properties.Int("indent")
wenzelm@61866
   199
  val Width = new Properties.Int("width")
wenzelm@61864
   200
wenzelm@61866
   201
  object Block
wenzelm@61866
   202
  {
wenzelm@61866
   203
    val name = "block"
wenzelm@61866
   204
    def apply(c: Boolean, i: Int): Markup =
wenzelm@61866
   205
      Markup(name,
wenzelm@61866
   206
        (if (c) Consistent(c) else Nil) :::
wenzelm@61866
   207
        (if (i != 0) Indent(i) else Nil))
wenzelm@61866
   208
    def unapply(markup: Markup): Option[(Boolean, Int)] =
wenzelm@61866
   209
      if (markup.name == name) {
wenzelm@61866
   210
        val c = Consistent.unapply(markup.properties).getOrElse(false)
wenzelm@61866
   211
        val i = Indent.unapply(markup.properties).getOrElse(0)
wenzelm@61866
   212
        Some((c, i))
wenzelm@61866
   213
      }
wenzelm@61866
   214
      else None
wenzelm@61866
   215
  }
wenzelm@61866
   216
wenzelm@61864
   217
  object Break
wenzelm@61864
   218
  {
wenzelm@61864
   219
    val name = "break"
wenzelm@61866
   220
    def apply(w: Int, i: Int): Markup =
wenzelm@61866
   221
      Markup(name,
wenzelm@61866
   222
        (if (w != 0) Width(w) else Nil) :::
wenzelm@61866
   223
        (if (i != 0) Indent(i) else Nil))
wenzelm@61864
   224
    def unapply(markup: Markup): Option[(Int, Int)] =
wenzelm@61864
   225
      if (markup.name == name) {
wenzelm@61866
   226
        val w = Width.unapply(markup.properties).getOrElse(0)
wenzelm@61866
   227
        val i = Indent.unapply(markup.properties).getOrElse(0)
wenzelm@61866
   228
        Some((w, i))
wenzelm@61864
   229
      }
wenzelm@61864
   230
      else None
wenzelm@61864
   231
  }
wenzelm@50201
   232
wenzelm@51570
   233
  val ITEM = "item"
wenzelm@51574
   234
  val BULLET = "bullet"
wenzelm@51570
   235
wenzelm@50201
   236
  val SEPARATOR = "separator"
wenzelm@50201
   237
wenzelm@50201
   238
wenzelm@56548
   239
  /* text properties */
wenzelm@56548
   240
wenzelm@56548
   241
  val WORDS = "words"
wenzelm@50201
   242
wenzelm@50201
   243
  val HIDDEN = "hidden"
wenzelm@50201
   244
wenzelm@50201
   245
wenzelm@58048
   246
  /* misc entities */
wenzelm@50201
   247
wenzelm@50201
   248
  val CLASS = "class"
wenzelm@50201
   249
  val TYPE_NAME = "type_name"
wenzelm@50201
   250
  val FIXED = "fixed"
wenzelm@53378
   251
  val CASE = "case"
wenzelm@50201
   252
  val CONSTANT = "constant"
wenzelm@50201
   253
  val DYNAMIC_FACT = "dynamic_fact"
wenzelm@50201
   254
wenzelm@50201
   255
wenzelm@50201
   256
  /* inner syntax */
wenzelm@50201
   257
wenzelm@50201
   258
  val TFREE = "tfree"
wenzelm@50201
   259
  val TVAR = "tvar"
wenzelm@50201
   260
  val FREE = "free"
wenzelm@50201
   261
  val SKOLEM = "skolem"
wenzelm@50201
   262
  val BOUND = "bound"
wenzelm@50201
   263
  val VAR = "var"
wenzelm@50201
   264
  val NUMERAL = "numeral"
wenzelm@50201
   265
  val LITERAL = "literal"
wenzelm@50201
   266
  val DELIMITER = "delimiter"
wenzelm@50201
   267
  val INNER_STRING = "inner_string"
wenzelm@55033
   268
  val INNER_CARTOUCHE = "inner_cartouche"
wenzelm@50201
   269
  val INNER_COMMENT = "inner_comment"
wenzelm@50201
   270
wenzelm@50201
   271
  val TOKEN_RANGE = "token_range"
wenzelm@50201
   272
wenzelm@50201
   273
  val SORTING = "sorting"
wenzelm@50201
   274
  val TYPING = "typing"
wenzelm@63347
   275
  val CLASS_PARAMETER = "class_parameter"
wenzelm@50201
   276
wenzelm@50201
   277
  val ATTRIBUTE = "attribute"
wenzelm@50201
   278
  val METHOD = "method"
wenzelm@50201
   279
wenzelm@50201
   280
wenzelm@55552
   281
  /* antiquotations */
wenzelm@50201
   282
wenzelm@55526
   283
  val ANTIQUOTED = "antiquoted"
wenzelm@55526
   284
  val ANTIQUOTE = "antiquote"
wenzelm@55526
   285
wenzelm@50201
   286
  val ML_ANTIQUOTATION = "ML_antiquotation"
wenzelm@50201
   287
  val DOCUMENT_ANTIQUOTATION = "document_antiquotation"
wenzelm@50201
   288
  val DOCUMENT_ANTIQUOTATION_OPTION = "document_antiquotation_option"
wenzelm@50201
   289
wenzelm@50201
   290
wenzelm@50201
   291
  /* text structure */
wenzelm@50201
   292
wenzelm@50201
   293
  val PARAGRAPH = "paragraph"
wenzelm@50545
   294
  val TEXT_FOLD = "text_fold"
wenzelm@50201
   295
wenzelm@50201
   296
wenzelm@61449
   297
  /* Markdown document structure */
wenzelm@61449
   298
wenzelm@61449
   299
  val MARKDOWN_PARAGRAPH = "markdown_paragraph"
wenzelm@67323
   300
  val MARKDOWN_ITEM = "markdown_item"
wenzelm@67336
   301
  val Markdown_Bullet = new Markup_Int("markdown_bullet", "depth")
wenzelm@61449
   302
  val Markdown_List = new Markup_String("markdown_list", "kind")
wenzelm@67336
   303
wenzelm@67336
   304
  val ITEMIZE = "itemize"
wenzelm@67336
   305
  val ENUMERATE = "enumerate"
wenzelm@67336
   306
  val DESCRIPTION = "description"
wenzelm@61449
   307
wenzelm@61449
   308
wenzelm@60744
   309
  /* ML */
wenzelm@50201
   310
wenzelm@55505
   311
  val ML_KEYWORD1 = "ML_keyword1"
wenzelm@55505
   312
  val ML_KEYWORD2 = "ML_keyword2"
wenzelm@55505
   313
  val ML_KEYWORD3 = "ML_keyword3"
wenzelm@50201
   314
  val ML_DELIMITER = "ML_delimiter"
wenzelm@50201
   315
  val ML_TVAR = "ML_tvar"
wenzelm@50201
   316
  val ML_NUMERAL = "ML_numeral"
wenzelm@50201
   317
  val ML_CHAR = "ML_char"
wenzelm@50201
   318
  val ML_STRING = "ML_string"
wenzelm@50201
   319
  val ML_COMMENT = "ML_comment"
wenzelm@56278
   320
  val SML_STRING = "SML_string"
wenzelm@56278
   321
  val SML_COMMENT = "SML_comment"
wenzelm@50201
   322
wenzelm@50201
   323
  val ML_DEF = "ML_def"
wenzelm@50201
   324
  val ML_OPEN = "ML_open"
wenzelm@55837
   325
  val ML_STRUCTURE = "ML_structure"
wenzelm@50201
   326
  val ML_TYPING = "ML_typing"
wenzelm@50201
   327
wenzelm@60744
   328
  val ML_BREAKPOINT = "ML_breakpoint"
wenzelm@60744
   329
wenzelm@50201
   330
wenzelm@50201
   331
  /* outer syntax */
wenzelm@50201
   332
wenzelm@55744
   333
  val COMMAND = "command"
wenzelm@66044
   334
  val KEYWORD = "keyword"
wenzelm@55744
   335
  val KEYWORD1 = "keyword1"
wenzelm@55744
   336
  val KEYWORD2 = "keyword2"
wenzelm@55765
   337
  val KEYWORD3 = "keyword3"
wenzelm@55919
   338
  val QUASI_KEYWORD = "quasi_keyword"
wenzelm@56202
   339
  val IMPROPER = "improper"
wenzelm@50201
   340
  val OPERATOR = "operator"
wenzelm@50201
   341
  val STRING = "string"
wenzelm@59081
   342
  val ALT_STRING = "alt_string"
wenzelm@50201
   343
  val VERBATIM = "verbatim"
wenzelm@55033
   344
  val CARTOUCHE = "cartouche"
wenzelm@50201
   345
  val COMMENT = "comment"
wenzelm@50201
   346
wenzelm@50201
   347
wenzelm@50201
   348
  /* timing */
wenzelm@50201
   349
wenzelm@50781
   350
  val Elapsed = new Properties.Double("elapsed")
wenzelm@50781
   351
  val CPU = new Properties.Double("cpu")
wenzelm@50781
   352
  val GC = new Properties.Double("gc")
wenzelm@50781
   353
wenzelm@50781
   354
  object Timing_Properties
wenzelm@50781
   355
  {
wenzelm@50781
   356
    def apply(timing: isabelle.Timing): Properties.T =
wenzelm@50781
   357
      Elapsed(timing.elapsed.seconds) ::: CPU(timing.cpu.seconds) ::: GC(timing.gc.seconds)
wenzelm@51662
   358
wenzelm@50781
   359
    def unapply(props: Properties.T): Option[isabelle.Timing] =
wenzelm@50781
   360
      (props, props, props) match {
wenzelm@50781
   361
        case (Elapsed(elapsed), CPU(cpu), GC(gc)) =>
wenzelm@50781
   362
          Some(new isabelle.Timing(Time.seconds(elapsed), Time.seconds(cpu), Time.seconds(gc)))
wenzelm@50781
   363
        case _ => None
wenzelm@50781
   364
      }
wenzelm@50781
   365
  }
wenzelm@50781
   366
wenzelm@50201
   367
  val TIMING = "timing"
wenzelm@50201
   368
wenzelm@50201
   369
  object Timing
wenzelm@50201
   370
  {
wenzelm@50781
   371
    def apply(timing: isabelle.Timing): Markup = Markup(TIMING, Timing_Properties(timing))
wenzelm@51662
   372
wenzelm@50201
   373
    def unapply(markup: Markup): Option[isabelle.Timing] =
wenzelm@50201
   374
      markup match {
wenzelm@50781
   375
        case Markup(TIMING, Timing_Properties(timing)) => Some(timing)
wenzelm@50201
   376
        case _ => None
wenzelm@50201
   377
      }
wenzelm@50201
   378
  }
wenzelm@50201
   379
wenzelm@50201
   380
wenzelm@65317
   381
  /* process result */
wenzelm@65317
   382
wenzelm@65317
   383
  val Return_Code = new Properties.Int("return_code")
wenzelm@65317
   384
wenzelm@65317
   385
  object Process_Result
wenzelm@65317
   386
  {
wenzelm@65317
   387
    def apply(result: Process_Result): Properties.T =
wenzelm@65317
   388
      Return_Code(result.rc) :::
wenzelm@65317
   389
        (if (result.timing.is_zero) Nil else Timing_Properties(result.timing))
wenzelm@65317
   390
wenzelm@65317
   391
    def unapply(props: Properties.T): Option[Process_Result] =
wenzelm@65317
   392
      props match {
wenzelm@65317
   393
        case Return_Code(rc) =>
wenzelm@65317
   394
          val timing = Timing_Properties.unapply(props).getOrElse(isabelle.Timing.zero)
wenzelm@65317
   395
          Some(isabelle.Process_Result(rc, timing = timing))
wenzelm@65317
   396
        case _ => None
wenzelm@65317
   397
      }
wenzelm@65317
   398
  }
wenzelm@65317
   399
wenzelm@65317
   400
wenzelm@63474
   401
  /* command indentation */
wenzelm@63474
   402
wenzelm@63474
   403
  object Command_Indent
wenzelm@63474
   404
  {
wenzelm@63474
   405
    val name = "command_indent"
wenzelm@63474
   406
    def unapply(markup: Markup): Option[Int] =
wenzelm@63474
   407
      if (markup.name == name) Indent.unapply(markup.properties) else None
wenzelm@63474
   408
  }
wenzelm@63474
   409
wenzelm@63474
   410
wenzelm@63474
   411
  /* goals */
wenzelm@50201
   412
wenzelm@50543
   413
  val GOAL = "goal"
wenzelm@50201
   414
  val SUBGOAL = "subgoal"
wenzelm@50215
   415
wenzelm@50450
   416
wenzelm@50201
   417
  /* command status */
wenzelm@50201
   418
wenzelm@50201
   419
  val TASK = "task"
wenzelm@50201
   420
wenzelm@50201
   421
  val ACCEPTED = "accepted"
wenzelm@50201
   422
  val FORKED = "forked"
wenzelm@50201
   423
  val JOINED = "joined"
wenzelm@50201
   424
  val RUNNING = "running"
wenzelm@50201
   425
  val FINISHED = "finished"
wenzelm@50201
   426
  val FAILED = "failed"
wenzelm@66382
   427
  val CONSOLIDATED = "consolidated"
wenzelm@50201
   428
wenzelm@50201
   429
wenzelm@50201
   430
  /* interactive documents */
wenzelm@50201
   431
wenzelm@50201
   432
  val VERSION = "version"
wenzelm@50201
   433
  val ASSIGN = "assign"
wenzelm@50201
   434
wenzelm@50201
   435
wenzelm@50201
   436
  /* prover process */
wenzelm@50201
   437
wenzelm@50201
   438
  val PROVER_COMMAND = "prover_command"
wenzelm@50201
   439
  val PROVER_ARG = "prover_arg"
wenzelm@50201
   440
wenzelm@50201
   441
wenzelm@50201
   442
  /* messages */
wenzelm@50201
   443
wenzelm@50201
   444
  val INIT = "init"
wenzelm@50201
   445
  val STATUS = "status"
wenzelm@50201
   446
  val REPORT = "report"
wenzelm@50500
   447
  val RESULT = "result"
wenzelm@50201
   448
  val WRITELN = "writeln"
wenzelm@59184
   449
  val STATE = "state"
wenzelm@59184
   450
  val INFORMATION = "information"
wenzelm@50201
   451
  val TRACING = "tracing"
wenzelm@50201
   452
  val WARNING = "warning"
wenzelm@59203
   453
  val LEGACY = "legacy"
wenzelm@50201
   454
  val ERROR = "error"
wenzelm@50201
   455
  val PROTOCOL = "protocol"
wenzelm@50201
   456
  val SYSTEM = "system"
wenzelm@50201
   457
  val STDOUT = "stdout"
wenzelm@50201
   458
  val STDERR = "stderr"
wenzelm@50201
   459
  val EXIT = "exit"
wenzelm@50201
   460
wenzelm@50201
   461
  val WRITELN_MESSAGE = "writeln_message"
wenzelm@59184
   462
  val STATE_MESSAGE = "state_message"
wenzelm@59184
   463
  val INFORMATION_MESSAGE = "information_message"
wenzelm@50201
   464
  val TRACING_MESSAGE = "tracing_message"
wenzelm@50201
   465
  val WARNING_MESSAGE = "warning_message"
wenzelm@59203
   466
  val LEGACY_MESSAGE = "legacy_message"
wenzelm@50201
   467
  val ERROR_MESSAGE = "error_message"
wenzelm@50201
   468
wenzelm@59184
   469
  val messages = Map(
wenzelm@59184
   470
    WRITELN -> WRITELN_MESSAGE,
wenzelm@59184
   471
    STATE -> STATE_MESSAGE,
wenzelm@59184
   472
    INFORMATION -> INFORMATION_MESSAGE,
wenzelm@59184
   473
    TRACING -> TRACING_MESSAGE,
wenzelm@59184
   474
    WARNING -> WARNING_MESSAGE,
wenzelm@59203
   475
    LEGACY -> LEGACY_MESSAGE,
wenzelm@59184
   476
    ERROR -> ERROR_MESSAGE)
wenzelm@59184
   477
wenzelm@52876
   478
  val message: String => String = messages.withDefault((s: String) => s)
wenzelm@50201
   479
wenzelm@50201
   480
  val NO_REPORT = "no_report"
wenzelm@50201
   481
wenzelm@50201
   482
  val BAD = "bad"
wenzelm@50201
   483
wenzelm@50500
   484
  val INTENSIFY = "intensify"
wenzelm@50500
   485
wenzelm@50500
   486
wenzelm@50500
   487
  /* active areas */
wenzelm@50500
   488
wenzelm@50715
   489
  val BROWSER = "browser"
wenzelm@50500
   490
  val GRAPHVIEW = "graphview"
wenzelm@50500
   491
wenzelm@50500
   492
  val SENDBACK = "sendback"
wenzelm@50500
   493
  val PADDING = "padding"
wenzelm@52697
   494
  val PADDING_LINE = (PADDING, "line")
wenzelm@52697
   495
  val PADDING_COMMAND = (PADDING, "command")
wenzelm@50500
   496
wenzelm@50500
   497
  val DIALOG = "dialog"
wenzelm@50503
   498
  val Result = new Properties.String(RESULT)
wenzelm@50500
   499
wenzelm@63681
   500
  val JEDIT_ACTION = "jedit_action"
wenzelm@63681
   501
wenzelm@50201
   502
wenzelm@50201
   503
  /* protocol message functions */
wenzelm@50201
   504
wenzelm@50201
   505
  val FUNCTION = "function"
wenzelm@50201
   506
  val Function = new Properties.String(FUNCTION)
wenzelm@50201
   507
wenzelm@66942
   508
  val COMMAND_TIMING: Properties.Entry = (FUNCTION, "command_timing")
wenzelm@66942
   509
  val THEORY_TIMING: Properties.Entry = (FUNCTION, "theory_timing")
wenzelm@66942
   510
wenzelm@52563
   511
  val Assign_Update: Properties.T = List((FUNCTION, "assign_update"))
wenzelm@50201
   512
  val Removed_Versions: Properties.T = List((FUNCTION, "removed_versions"))
wenzelm@50201
   513
wenzelm@52111
   514
  object Protocol_Handler
wenzelm@52111
   515
  {
wenzelm@52111
   516
    def unapply(props: Properties.T): Option[(String)] =
wenzelm@52111
   517
      props match {
wenzelm@52111
   518
        case List((FUNCTION, "protocol_handler"), (NAME, name)) => Some(name)
wenzelm@52111
   519
        case _ => None
wenzelm@52111
   520
      }
wenzelm@52111
   521
  }
wenzelm@52111
   522
wenzelm@52111
   523
  val INVOKE_SCALA = "invoke_scala"
wenzelm@50201
   524
  object Invoke_Scala
wenzelm@50201
   525
  {
wenzelm@50201
   526
    def unapply(props: Properties.T): Option[(String, String)] =
wenzelm@50201
   527
      props match {
wenzelm@52111
   528
        case List((FUNCTION, INVOKE_SCALA), (NAME, name), (ID, id)) => Some((name, id))
wenzelm@50201
   529
        case _ => None
wenzelm@50201
   530
      }
wenzelm@50201
   531
  }
wenzelm@52111
   532
wenzelm@52111
   533
  val CANCEL_SCALA = "cancel_scala"
wenzelm@50201
   534
  object Cancel_Scala
wenzelm@50201
   535
  {
wenzelm@50201
   536
    def unapply(props: Properties.T): Option[String] =
wenzelm@50201
   537
      props match {
wenzelm@52111
   538
        case List((FUNCTION, CANCEL_SCALA), (ID, id)) => Some(id)
wenzelm@50201
   539
        case _ => None
wenzelm@50201
   540
      }
wenzelm@50201
   541
  }
wenzelm@50255
   542
wenzelm@50255
   543
  object ML_Statistics
wenzelm@50255
   544
  {
wenzelm@50255
   545
    def unapply(props: Properties.T): Option[Properties.T] =
wenzelm@50255
   546
      props match {
wenzelm@66872
   547
        case (FUNCTION, "ML_statistics") :: props => Some(props)
wenzelm@50255
   548
        case _ => None
wenzelm@50255
   549
      }
wenzelm@50255
   550
  }
wenzelm@50975
   551
wenzelm@50975
   552
  object Task_Statistics
wenzelm@50975
   553
  {
wenzelm@50975
   554
    def unapply(props: Properties.T): Option[Properties.T] =
wenzelm@50975
   555
      props match {
wenzelm@66872
   556
        case (FUNCTION, "task_statistics") :: props => Some(props)
wenzelm@50975
   557
        case _ => None
wenzelm@50975
   558
      }
wenzelm@50975
   559
  }
lars@55316
   560
wenzelm@59367
   561
  val LOADING_THEORY = "loading_theory"
wenzelm@56616
   562
  object Loading_Theory
wenzelm@56616
   563
  {
wenzelm@56616
   564
    def unapply(props: Properties.T): Option[String] =
wenzelm@56616
   565
      props match {
wenzelm@59367
   566
        case List((FUNCTION, LOADING_THEORY), (NAME, name)) => Some(name)
wenzelm@56616
   567
        case _ => None
wenzelm@56616
   568
      }
wenzelm@56616
   569
  }
wenzelm@56616
   570
wenzelm@65313
   571
  val BUILD_SESSION_FINISHED = "build_session_finished"
wenzelm@65313
   572
  val Build_Session_Finished: Properties.T = List((FUNCTION, BUILD_SESSION_FINISHED))
wenzelm@56616
   573
wenzelm@56864
   574
  val PRINT_OPERATIONS = "print_operations"
wenzelm@56864
   575
wenzelm@55555
   576
wenzelm@60830
   577
  /* debugger output */
wenzelm@60830
   578
wenzelm@60842
   579
  val DEBUGGER_STATE = "debugger_state"
wenzelm@60842
   580
  object Debugger_State
wenzelm@60842
   581
  {
wenzelm@60842
   582
    def unapply(props: Properties.T): Option[String] =
wenzelm@60842
   583
      props match {
wenzelm@60842
   584
        case List((FUNCTION, DEBUGGER_STATE), (NAME, name)) => Some(name)
wenzelm@60842
   585
        case _ => None
wenzelm@60842
   586
      }
wenzelm@60842
   587
  }
wenzelm@60842
   588
wenzelm@60830
   589
  val DEBUGGER_OUTPUT = "debugger_output"
wenzelm@60830
   590
  object Debugger_Output
wenzelm@60830
   591
  {
wenzelm@60834
   592
    def unapply(props: Properties.T): Option[String] =
wenzelm@60830
   593
      props match {
wenzelm@60834
   594
        case List((FUNCTION, DEBUGGER_OUTPUT), (NAME, name)) => Some(name)
wenzelm@60830
   595
        case _ => None
wenzelm@60830
   596
      }
wenzelm@60830
   597
  }
wenzelm@60830
   598
wenzelm@60830
   599
lars@55316
   600
  /* simplifier trace */
lars@55316
   601
wenzelm@57597
   602
  val SIMP_TRACE_PANEL = "simp_trace_panel"
lars@55316
   603
wenzelm@55555
   604
  val SIMP_TRACE_LOG = "simp_trace_log"
wenzelm@55555
   605
  val SIMP_TRACE_STEP = "simp_trace_step"
wenzelm@55555
   606
  val SIMP_TRACE_RECURSE = "simp_trace_recurse"
wenzelm@55555
   607
  val SIMP_TRACE_HINT = "simp_trace_hint"
wenzelm@55555
   608
  val SIMP_TRACE_IGNORE = "simp_trace_ignore"
lars@55316
   609
wenzelm@55555
   610
  val SIMP_TRACE_CANCEL = "simp_trace_cancel"
wenzelm@55555
   611
  object Simp_Trace_Cancel
lars@55316
   612
  {
lars@55316
   613
    def unapply(props: Properties.T): Option[Long] =
lars@55316
   614
      props match {
wenzelm@55555
   615
        case (FUNCTION, SIMP_TRACE_CANCEL) :: Serial(i) => Some(i)
lars@55316
   616
        case _ => None
lars@55316
   617
      }
lars@55316
   618
  }
wenzelm@65335
   619
wenzelm@65335
   620
wenzelm@65335
   621
  /* XML data representation */
wenzelm@65335
   622
wenzelm@65335
   623
  def encode: XML.Encode.T[Markup] = (markup: Markup) =>
wenzelm@65335
   624
  {
wenzelm@65335
   625
    import XML.Encode._
wenzelm@65335
   626
    pair(string, properties)((markup.name, markup.properties))
wenzelm@65335
   627
  }
wenzelm@65335
   628
wenzelm@65335
   629
  def decode: XML.Decode.T[Markup] = (body: XML.Body) =>
wenzelm@65335
   630
  {
wenzelm@65335
   631
    import XML.Decode._
wenzelm@65335
   632
    val (name, props) = pair(string, properties)(body)
wenzelm@65335
   633
    Markup(name, props)
wenzelm@65335
   634
  }
wenzelm@45666
   635
}
wenzelm@43721
   636
wenzelm@43721
   637
wenzelm@45666
   638
sealed case class Markup(name: String, properties: Properties.T)
wenzelm@59709
   639
{
wenzelm@59709
   640
  def markup(s: String): String =
wenzelm@59709
   641
    YXML.string_of_tree(XML.Elem(this, List(XML.Text(s))))
wenzelm@64358
   642
wenzelm@64358
   643
  def update_properties(more_props: Properties.T): Markup =
wenzelm@64358
   644
    if (more_props.isEmpty) this
wenzelm@64358
   645
    else Markup(name, (more_props :\ properties) { case (p, ps) => Properties.put(ps, p) })
wenzelm@65753
   646
wenzelm@65753
   647
  def + (entry: Properties.Entry): Markup =
wenzelm@65753
   648
    Markup(name, Properties.put(properties, entry))
wenzelm@59709
   649
}