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