src/Pure/General/markup.scala
author wenzelm
Mon Apr 11 17:11:03 2011 +0200 (2011-04-11 ago)
changeset 42327 7c7cc7590eb3
parent 42202 f6483ed40529
child 42376 c3abf2c3f541
permissions -rw-r--r--
Name_Space.entry_markup: keep def position as separate properties;
uniform treatment of ML_def/ML_open/ML_struct as entities;
hyperlinks for all entities -- excluding ML_open/ML_struct for now;
wenzelm@27958
     1
/*  Title:      Pure/General/markup.scala
wenzelm@27958
     2
    Author:     Makarius
wenzelm@27958
     3
wenzelm@27958
     4
Common 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@38722
    12
  /* plain values */
wenzelm@38414
    13
wenzelm@40392
    14
  object Int
wenzelm@40392
    15
  {
wenzelm@40392
    16
    def apply(x: scala.Int): String = x.toString
wenzelm@38414
    17
    def unapply(s: String): Option[scala.Int] =
wenzelm@38414
    18
      try { Some(Integer.parseInt(s)) }
wenzelm@38414
    19
      catch { case _: NumberFormatException => None }
wenzelm@38414
    20
  }
wenzelm@38414
    21
wenzelm@40392
    22
  object Long
wenzelm@40392
    23
  {
wenzelm@40392
    24
    def apply(x: scala.Long): String = x.toString
wenzelm@38414
    25
    def unapply(s: String): Option[scala.Long] =
wenzelm@38414
    26
      try { Some(java.lang.Long.parseLong(s)) }
wenzelm@38414
    27
      catch { case _: NumberFormatException => None }
wenzelm@38414
    28
  }
wenzelm@38414
    29
wenzelm@40392
    30
  object Double
wenzelm@40392
    31
  {
wenzelm@40392
    32
    def apply(x: scala.Double): String = x.toString
wenzelm@40392
    33
    def unapply(s: String): Option[scala.Double] =
wenzelm@40392
    34
      try { Some(java.lang.Double.parseDouble(s)) }
wenzelm@40392
    35
      catch { case _: NumberFormatException => None }
wenzelm@40392
    36
  }
wenzelm@40392
    37
wenzelm@38414
    38
wenzelm@38722
    39
  /* named properties */
wenzelm@36683
    40
wenzelm@38722
    41
  class Property(val name: String)
wenzelm@38355
    42
  {
wenzelm@38722
    43
    def apply(value: String): List[(String, String)] = List((name, value))
wenzelm@38722
    44
    def unapply(props: List[(String, String)]): Option[String] =
wenzelm@38722
    45
      props.find(_._1 == name).map(_._2)
wenzelm@38355
    46
  }
wenzelm@38355
    47
wenzelm@38722
    48
  class Int_Property(name: String)
wenzelm@36683
    49
  {
wenzelm@38722
    50
    def apply(value: scala.Int): List[(String, String)] = List((name, Int(value)))
wenzelm@38722
    51
    def unapply(props: List[(String, String)]): Option[Int] =
wenzelm@38722
    52
      props.find(_._1 == name) match {
wenzelm@38722
    53
        case None => None
wenzelm@38722
    54
        case Some((_, value)) => Int.unapply(value)
wenzelm@38722
    55
      }
wenzelm@38722
    56
  }
wenzelm@38722
    57
wenzelm@38722
    58
  class Long_Property(name: String)
wenzelm@38722
    59
  {
wenzelm@38722
    60
    def apply(value: scala.Long): List[(String, String)] = List((name, Long(value)))
wenzelm@38722
    61
    def unapply(props: List[(String, String)]): Option[Long] =
wenzelm@38722
    62
      props.find(_._1 == name) match {
wenzelm@38722
    63
        case None => None
wenzelm@38722
    64
        case Some((_, value)) => Long.unapply(value)
wenzelm@38722
    65
      }
wenzelm@36683
    66
  }
wenzelm@36683
    67
wenzelm@40392
    68
  class Double_Property(name: String)
wenzelm@40392
    69
  {
wenzelm@40392
    70
    def apply(value: scala.Double): List[(String, String)] = List((name, Double(value)))
wenzelm@40392
    71
    def unapply(props: List[(String, String)]): Option[Double] =
wenzelm@40392
    72
      props.find(_._1 == name) match {
wenzelm@40392
    73
        case None => None
wenzelm@40392
    74
        case Some((_, value)) => Double.unapply(value)
wenzelm@40392
    75
      }
wenzelm@40392
    76
  }
wenzelm@40392
    77
wenzelm@36683
    78
wenzelm@38474
    79
  /* empty */
wenzelm@38474
    80
wenzelm@38474
    81
  val Empty = Markup("", Nil)
wenzelm@38474
    82
wenzelm@38474
    83
wenzelm@38721
    84
  /* misc properties */
wenzelm@29184
    85
wenzelm@29184
    86
  val NAME = "name"
wenzelm@42136
    87
  val Name = new Property(NAME)
wenzelm@42136
    88
wenzelm@29184
    89
  val KIND = "kind"
wenzelm@42136
    90
  val Kind = new Property(KIND)
wenzelm@29184
    91
wenzelm@29184
    92
wenzelm@33088
    93
  /* formal entities */
wenzelm@33088
    94
wenzelm@38887
    95
  val BINDING = "binding"
wenzelm@33088
    96
  val ENTITY = "entity"
wenzelm@33088
    97
  val DEF = "def"
wenzelm@33088
    98
  val REF = "ref"
wenzelm@33088
    99
wenzelm@42202
   100
  object Entity
wenzelm@42202
   101
  {
wenzelm@42202
   102
    def unapply(markup: Markup): Option[(String, String)] =
wenzelm@42202
   103
      markup match {
wenzelm@42202
   104
        case Markup(ENTITY, props @ Kind(kind)) =>
wenzelm@42202
   105
          props match {
wenzelm@42202
   106
            case Name(name) => Some(kind, name)
wenzelm@42202
   107
            case _ => None
wenzelm@42202
   108
          }
wenzelm@42202
   109
        case _ => None
wenzelm@42202
   110
      }
wenzelm@42202
   111
  }
wenzelm@42202
   112
wenzelm@33088
   113
wenzelm@27970
   114
  /* position */
wenzelm@27970
   115
wenzelm@27970
   116
  val LINE = "line"
wenzelm@27970
   117
  val COLUMN = "column"
wenzelm@27970
   118
  val OFFSET = "offset"
wenzelm@27970
   119
  val END_OFFSET = "end_offset"
wenzelm@27970
   120
  val FILE = "file"
wenzelm@27970
   121
  val ID = "id"
wenzelm@27970
   122
wenzelm@42327
   123
  val DEF_LINE = "def_line"
wenzelm@42327
   124
  val DEF_COLUMN = "def_column"
wenzelm@42327
   125
  val DEF_OFFSET = "def_offset"
wenzelm@42327
   126
  val DEF_END_OFFSET = "def_end_offset"
wenzelm@42327
   127
  val DEF_FILE = "def_file"
wenzelm@42327
   128
  val DEF_ID = "def_id"
wenzelm@42327
   129
wenzelm@41483
   130
  val POSITION_PROPERTIES = Set(LINE, COLUMN, OFFSET, END_OFFSET, FILE, ID)
wenzelm@29205
   131
wenzelm@29184
   132
  val POSITION = "position"
wenzelm@29184
   133
wenzelm@29184
   134
wenzelm@36683
   135
  /* pretty printing */
wenzelm@36683
   136
wenzelm@38724
   137
  val Indent = new Int_Property("indent")
wenzelm@36683
   138
  val BLOCK = "block"
wenzelm@38724
   139
  val Width = new Int_Property("width")
wenzelm@36683
   140
  val BREAK = "break"
wenzelm@36683
   141
wenzelm@36683
   142
wenzelm@33985
   143
  /* hidden text */
wenzelm@33985
   144
wenzelm@33985
   145
  val HIDDEN = "hidden"
wenzelm@33985
   146
wenzelm@33985
   147
wenzelm@29184
   148
  /* logical entities */
wenzelm@29184
   149
wenzelm@29184
   150
  val TCLASS = "tclass"
wenzelm@29184
   151
  val TYCON = "tycon"
wenzelm@29184
   152
  val FIXED_DECL = "fixed_decl"
wenzelm@29184
   153
  val FIXED = "fixed"
wenzelm@29184
   154
  val CONST_DECL = "const_decl"
wenzelm@42136
   155
  val CONST = "constant"
wenzelm@29184
   156
  val FACT_DECL = "fact_decl"
wenzelm@29184
   157
  val FACT = "fact"
wenzelm@29184
   158
  val DYNAMIC_FACT = "dynamic_fact"
wenzelm@29184
   159
  val LOCAL_FACT_DECL = "local_fact_decl"
wenzelm@29184
   160
  val LOCAL_FACT = "local_fact"
wenzelm@29184
   161
wenzelm@29184
   162
wenzelm@29184
   163
  /* inner syntax */
wenzelm@29184
   164
wenzelm@29184
   165
  val TFREE = "tfree"
wenzelm@29184
   166
  val TVAR = "tvar"
wenzelm@29184
   167
  val FREE = "free"
wenzelm@29184
   168
  val SKOLEM = "skolem"
wenzelm@29184
   169
  val BOUND = "bound"
wenzelm@29184
   170
  val VAR = "var"
wenzelm@29184
   171
  val NUM = "num"
wenzelm@29184
   172
  val FLOAT = "float"
wenzelm@29184
   173
  val XNUM = "xnum"
wenzelm@29184
   174
  val XSTR = "xstr"
wenzelm@29184
   175
  val LITERAL = "literal"
wenzelm@29184
   176
  val INNER_COMMENT = "inner_comment"
wenzelm@29184
   177
wenzelm@39168
   178
  val TOKEN_RANGE = "token_range"
wenzelm@39168
   179
wenzelm@29184
   180
  val SORT = "sort"
wenzelm@29184
   181
  val TYP = "typ"
wenzelm@29184
   182
  val TERM = "term"
wenzelm@29184
   183
  val PROP = "prop"
wenzelm@29184
   184
wenzelm@29184
   185
  val ATTRIBUTE = "attribute"
wenzelm@29184
   186
  val METHOD = "method"
wenzelm@29184
   187
wenzelm@29184
   188
wenzelm@29184
   189
  /* embedded source text */
wenzelm@29184
   190
wenzelm@29184
   191
  val ML_SOURCE = "ML_source"
wenzelm@29184
   192
  val DOC_SOURCE = "doc_source"
wenzelm@29184
   193
wenzelm@29184
   194
  val ANTIQ = "antiq"
wenzelm@29184
   195
  val ML_ANTIQ = "ML_antiq"
wenzelm@29184
   196
  val DOC_ANTIQ = "doc_antiq"
wenzelm@29184
   197
wenzelm@29184
   198
wenzelm@30615
   199
  /* ML syntax */
wenzelm@30615
   200
wenzelm@30615
   201
  val ML_KEYWORD = "ML_keyword"
wenzelm@37195
   202
  val ML_DELIMITER = "ML_delimiter"
wenzelm@30615
   203
  val ML_IDENT = "ML_ident"
wenzelm@30615
   204
  val ML_TVAR = "ML_tvar"
wenzelm@30615
   205
  val ML_NUMERAL = "ML_numeral"
wenzelm@30615
   206
  val ML_CHAR = "ML_char"
wenzelm@30615
   207
  val ML_STRING = "ML_string"
wenzelm@30615
   208
  val ML_COMMENT = "ML_comment"
wenzelm@30615
   209
  val ML_MALFORMED = "ML_malformed"
wenzelm@30615
   210
wenzelm@30702
   211
  val ML_DEF = "ML_def"
wenzelm@31472
   212
  val ML_OPEN = "ML_open"
wenzelm@31472
   213
  val ML_STRUCT = "ML_struct"
wenzelm@30702
   214
  val ML_TYPING = "ML_typing"
wenzelm@30702
   215
wenzelm@30615
   216
wenzelm@29184
   217
  /* outer syntax */
wenzelm@29184
   218
wenzelm@29184
   219
  val KEYWORD_DECL = "keyword_decl"
wenzelm@29184
   220
  val COMMAND_DECL = "command_decl"
wenzelm@29184
   221
wenzelm@29184
   222
  val KEYWORD = "keyword"
wenzelm@37194
   223
  val OPERATOR = "operator"
wenzelm@29184
   224
  val COMMAND = "command"
wenzelm@29184
   225
  val IDENT = "ident"
wenzelm@29184
   226
  val STRING = "string"
wenzelm@29184
   227
  val ALTSTRING = "altstring"
wenzelm@29184
   228
  val VERBATIM = "verbatim"
wenzelm@29184
   229
  val COMMENT = "comment"
wenzelm@29184
   230
  val CONTROL = "control"
wenzelm@29184
   231
  val MALFORMED = "malformed"
wenzelm@29184
   232
wenzelm@29185
   233
  val COMMAND_SPAN = "command_span"
wenzelm@29185
   234
  val IGNORED_SPAN = "ignored_span"
wenzelm@29185
   235
  val MALFORMED_SPAN = "malformed_span"
wenzelm@29185
   236
wenzelm@29184
   237
wenzelm@40394
   238
  /* timing */
wenzelm@40394
   239
wenzelm@40394
   240
  val TIMING = "timing"
wenzelm@40394
   241
  val ELAPSED = "elapsed"
wenzelm@40394
   242
  val CPU = "cpu"
wenzelm@40394
   243
  val GC = "gc"
wenzelm@40394
   244
wenzelm@40394
   245
  object Timing
wenzelm@40394
   246
  {
wenzelm@40394
   247
    def apply(timing: isabelle.Timing): Markup =
wenzelm@40394
   248
      Markup(TIMING, List(
wenzelm@40848
   249
        (ELAPSED, Double(timing.elapsed.seconds)),
wenzelm@40848
   250
        (CPU, Double(timing.cpu.seconds)),
wenzelm@40848
   251
        (GC, Double(timing.gc.seconds))))
wenzelm@40394
   252
    def unapply(markup: Markup): Option[isabelle.Timing] =
wenzelm@40394
   253
      markup match {
wenzelm@40394
   254
        case Markup(TIMING, List(
wenzelm@40848
   255
          (ELAPSED, Double(elapsed)), (CPU, Double(cpu)), (GC, Double(gc)))) =>
wenzelm@40848
   256
            Some(new isabelle.Timing(Time.seconds(elapsed), Time.seconds(cpu), Time.seconds(gc)))
wenzelm@40394
   257
        case _ => None
wenzelm@40394
   258
      }
wenzelm@40394
   259
  }
wenzelm@40394
   260
wenzelm@40394
   261
wenzelm@29184
   262
  /* toplevel */
wenzelm@29184
   263
wenzelm@38721
   264
  val SUBGOALS = "subgoals"
wenzelm@38721
   265
  val PROOF_STATE = "proof_state"
wenzelm@38721
   266
wenzelm@29184
   267
  val STATE = "state"
wenzelm@29184
   268
  val SUBGOAL = "subgoal"
wenzelm@29184
   269
  val SENDBACK = "sendback"
wenzelm@29184
   270
  val HILITE = "hilite"
wenzelm@29184
   271
wenzelm@29184
   272
wenzelm@29184
   273
  /* command status */
wenzelm@29184
   274
wenzelm@29417
   275
  val TASK = "task"
wenzelm@29417
   276
wenzelm@37186
   277
  val FORKED = "forked"
wenzelm@37186
   278
  val JOINED = "joined"
wenzelm@29184
   279
  val FAILED = "failed"
wenzelm@29184
   280
  val FINISHED = "finished"
wenzelm@29488
   281
wenzelm@29488
   282
wenzelm@29488
   283
  /* interactive documents */
wenzelm@29488
   284
wenzelm@38414
   285
  val VERSION = "version"
wenzelm@38414
   286
  val EXEC = "exec"
wenzelm@38414
   287
  val ASSIGN = "assign"
wenzelm@29488
   288
  val EDIT = "edit"
wenzelm@29184
   289
wenzelm@27970
   290
wenzelm@27970
   291
  /* messages */
wenzelm@27970
   292
wenzelm@38872
   293
  val Serial = new Long_Property("serial")
wenzelm@27970
   294
wenzelm@29195
   295
  val MESSAGE = "message"
wenzelm@29522
   296
  val CLASS = "class"
wenzelm@29522
   297
wenzelm@29522
   298
  val INIT = "init"
wenzelm@29522
   299
  val STATUS = "status"
wenzelm@39525
   300
  val REPORT = "report"
wenzelm@29522
   301
  val WRITELN = "writeln"
wenzelm@29522
   302
  val TRACING = "tracing"
wenzelm@29522
   303
  val WARNING = "warning"
wenzelm@29522
   304
  val ERROR = "error"
wenzelm@29522
   305
  val SYSTEM = "system"
wenzelm@29522
   306
  val STDOUT = "stdout"
wenzelm@29522
   307
  val EXIT = "exit"
wenzelm@29195
   308
wenzelm@39439
   309
  val NO_REPORT = "no_report"
wenzelm@39439
   310
wenzelm@39171
   311
  val BAD = "bad"
wenzelm@39171
   312
wenzelm@39591
   313
  val READY = "ready"
wenzelm@31384
   314
wenzelm@27970
   315
wenzelm@34119
   316
  /* system data */
wenzelm@27970
   317
wenzelm@38231
   318
  val Data = Markup("data", Nil)
wenzelm@27958
   319
}
wenzelm@38230
   320
wenzelm@38230
   321
sealed case class Markup(name: String, properties: List[(String, String)])