src/Pure/PIDE/command.scala
author wenzelm
Tue, 07 Sep 2010 16:40:30 +0200
changeset 39172 31b95e0da7b7
parent 38887 1261481ef5e5
child 39173 ed3946086358
permissions -rw-r--r--
Isar_Document.reported_positions: slightly more robust treatment of positions outside the command range, notably parsing beyond EOF;
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
36676
ac7961d42ac3 some rearrangement of Scala sources;
wenzelm
parents: 36012
diff changeset
     1
/*  Title:      Pure/PIDE/command.scala
ac7961d42ac3 some rearrangement of Scala sources;
wenzelm
parents: 36012
diff changeset
     2
    Author:     Fabian Immler, TU Munich
ac7961d42ac3 some rearrangement of Scala sources;
wenzelm
parents: 36012
diff changeset
     3
    Author:     Makarius
ac7961d42ac3 some rearrangement of Scala sources;
wenzelm
parents: 36012
diff changeset
     4
ac7961d42ac3 some rearrangement of Scala sources;
wenzelm
parents: 36012
diff changeset
     5
Prover commands with semantic state.
ac7961d42ac3 some rearrangement of Scala sources;
wenzelm
parents: 36012
diff changeset
     6
*/
34407
aad6834ba380 added some headers and comments;
wenzelm
parents: 34401
diff changeset
     7
34871
e596a0b71f3c incorporate "proofdocument" part into main Isabelle/Pure.jar -- except for html_panel.scala, which depends on external library (Lobo/Cobra browser);
wenzelm
parents: 34865
diff changeset
     8
package isabelle
34318
c13e168a8ae6 original sources from Johannes Hölzl a48e0c6ab1aea77c52d596f7efc007a543d3d10c with minor modifications of directory layout;
wenzelm
parents:
diff changeset
     9
34451
3b9d0074ed44 command id via Isabelle.plugin;
wenzelm
parents: 34410
diff changeset
    10
38872
26c505765024 Command.results: ordered by serial number;
wenzelm
parents: 38723
diff changeset
    11
import scala.collection.immutable.SortedMap
26c505765024 Command.results: ordered by serial number;
wenzelm
parents: 38723
diff changeset
    12
26c505765024 Command.results: ordered by serial number;
wenzelm
parents: 38723
diff changeset
    13
34637
f3b5d6e248be added symbol_index (presently unused);
wenzelm
parents: 34603
diff changeset
    14
object Command
f3b5d6e248be added symbol_index (presently unused);
wenzelm
parents: 34603
diff changeset
    15
{
38361
b609d0b271fa specific command state;
wenzelm
parents: 38360
diff changeset
    16
  /** accumulated results from prover **/
b609d0b271fa specific command state;
wenzelm
parents: 38360
diff changeset
    17
38362
754ad6340055 misc tuning and simplification;
wenzelm
parents: 38361
diff changeset
    18
  case class State(
38361
b609d0b271fa specific command state;
wenzelm
parents: 38360
diff changeset
    19
    val command: Command,
38872
26c505765024 Command.results: ordered by serial number;
wenzelm
parents: 38723
diff changeset
    20
    val status: List[Markup] = Nil,
26c505765024 Command.results: ordered by serial number;
wenzelm
parents: 38723
diff changeset
    21
    val results: SortedMap[Long, XML.Tree] = SortedMap.empty,
26c505765024 Command.results: ordered by serial number;
wenzelm
parents: 38723
diff changeset
    22
    val markup: Markup_Tree = Markup_Tree.empty)
38361
b609d0b271fa specific command state;
wenzelm
parents: 38360
diff changeset
    23
  {
b609d0b271fa specific command state;
wenzelm
parents: 38360
diff changeset
    24
    /* content */
b609d0b271fa specific command state;
wenzelm
parents: 38360
diff changeset
    25
38714
31da698fc4e5 more precise Command.State accumulation;
wenzelm
parents: 38658
diff changeset
    26
    def add_status(st: Markup): State = copy(status = st :: status)
31da698fc4e5 more precise Command.State accumulation;
wenzelm
parents: 38658
diff changeset
    27
    def add_markup(info: Text.Info[Any]): State = copy(markup = markup + info)
38872
26c505765024 Command.results: ordered by serial number;
wenzelm
parents: 38723
diff changeset
    28
    def add_result(serial: Long, result: XML.Tree): State =
26c505765024 Command.results: ordered by serial number;
wenzelm
parents: 38723
diff changeset
    29
      copy(results = results + (serial -> result))
38361
b609d0b271fa specific command state;
wenzelm
parents: 38360
diff changeset
    30
38658
20d82e98bcd7 tuned root markup;
wenzelm
parents: 38637
diff changeset
    31
    def root_info: Text.Info[Any] =
38581
d503a0912e14 simplified Command.status again, reverting most of e5eed57913d0 (note that more complex information can be represented with full markup reports);
wenzelm
parents: 38579
diff changeset
    32
      new Text.Info(command.range,
38658
20d82e98bcd7 tuned root markup;
wenzelm
parents: 38637
diff changeset
    33
        XML.Elem(Markup(Markup.STATUS, Nil), status.reverse.map(XML.Elem(_, Nil))))
20d82e98bcd7 tuned root markup;
wenzelm
parents: 38637
diff changeset
    34
    def root_markup: Markup_Tree = markup + root_info
38361
b609d0b271fa specific command state;
wenzelm
parents: 38360
diff changeset
    35
b609d0b271fa specific command state;
wenzelm
parents: 38360
diff changeset
    36
b609d0b271fa specific command state;
wenzelm
parents: 38360
diff changeset
    37
    /* message dispatch */
b609d0b271fa specific command state;
wenzelm
parents: 38360
diff changeset
    38
38872
26c505765024 Command.results: ordered by serial number;
wenzelm
parents: 38723
diff changeset
    39
    def accumulate(message: XML.Elem): Command.State =
38361
b609d0b271fa specific command state;
wenzelm
parents: 38360
diff changeset
    40
      message match {
38714
31da698fc4e5 more precise Command.State accumulation;
wenzelm
parents: 38658
diff changeset
    41
        case XML.Elem(Markup(Markup.STATUS, _), msgs) =>
31da698fc4e5 more precise Command.State accumulation;
wenzelm
parents: 38658
diff changeset
    42
          (this /: msgs)((state, msg) =>
31da698fc4e5 more precise Command.State accumulation;
wenzelm
parents: 38658
diff changeset
    43
            msg match {
31da698fc4e5 more precise Command.State accumulation;
wenzelm
parents: 38658
diff changeset
    44
              case XML.Elem(markup, Nil) => state.add_status(markup)
31da698fc4e5 more precise Command.State accumulation;
wenzelm
parents: 38658
diff changeset
    45
              case _ => System.err.println("Ignored status message: " + msg); state
31da698fc4e5 more precise Command.State accumulation;
wenzelm
parents: 38658
diff changeset
    46
            })
38581
d503a0912e14 simplified Command.status again, reverting most of e5eed57913d0 (note that more complex information can be represented with full markup reports);
wenzelm
parents: 38579
diff changeset
    47
38572
0fe2c01ef7da Command.State: accumulate markup reports uniformly;
wenzelm
parents: 38564
diff changeset
    48
        case XML.Elem(Markup(Markup.REPORT, _), msgs) =>
0fe2c01ef7da Command.State: accumulate markup reports uniformly;
wenzelm
parents: 38564
diff changeset
    49
          (this /: msgs)((state, msg) =>
0fe2c01ef7da Command.State: accumulate markup reports uniformly;
wenzelm
parents: 38564
diff changeset
    50
            msg match {
38887
1261481ef5e5 Command.State: add reported positions to markup tree, according main message position or Markup.binding/entity/report occurrences in body;
wenzelm
parents: 38877
diff changeset
    51
              case XML.Elem(Markup(name, atts @ Position.Id_Range(id, range)), args)
1261481ef5e5 Command.State: add reported positions to markup tree, according main message position or Markup.binding/entity/report occurrences in body;
wenzelm
parents: 38877
diff changeset
    52
              if id == command.id =>
38872
26c505765024 Command.results: ordered by serial number;
wenzelm
parents: 38723
diff changeset
    53
                val props = Position.purge(atts)
38723
wenzelm
parents: 38722
diff changeset
    54
                val info =
wenzelm
parents: 38722
diff changeset
    55
                  Text.Info[Any](command.decode(range), XML.Elem(Markup(name, props), args))
wenzelm
parents: 38722
diff changeset
    56
                state.add_markup(info)
38572
0fe2c01ef7da Command.State: accumulate markup reports uniformly;
wenzelm
parents: 38564
diff changeset
    57
              case _ => System.err.println("Ignored report message: " + msg); state
38361
b609d0b271fa specific command state;
wenzelm
parents: 38360
diff changeset
    58
            })
38872
26c505765024 Command.results: ordered by serial number;
wenzelm
parents: 38723
diff changeset
    59
        case XML.Elem(Markup(name, atts), body) =>
26c505765024 Command.results: ordered by serial number;
wenzelm
parents: 38723
diff changeset
    60
          atts match {
26c505765024 Command.results: ordered by serial number;
wenzelm
parents: 38723
diff changeset
    61
            case Markup.Serial(i) =>
38887
1261481ef5e5 Command.State: add reported positions to markup tree, according main message position or Markup.binding/entity/report occurrences in body;
wenzelm
parents: 38877
diff changeset
    62
              val result = XML.Elem(Markup(name, Position.purge(atts)), body)
39172
31b95e0da7b7 Isar_Document.reported_positions: slightly more robust treatment of positions outside the command range, notably parsing beyond EOF;
wenzelm
parents: 38887
diff changeset
    63
              (add_result(i, result) /: Isar_Document.reported_positions(command, message))(
31b95e0da7b7 Isar_Document.reported_positions: slightly more robust treatment of positions outside the command range, notably parsing beyond EOF;
wenzelm
parents: 38887
diff changeset
    64
                (st, range) => st.add_markup(Text.Info(range, result)))
38872
26c505765024 Command.results: ordered by serial number;
wenzelm
parents: 38723
diff changeset
    65
            case _ => System.err.println("Ignored message without serial number: " + message); this
26c505765024 Command.results: ordered by serial number;
wenzelm
parents: 38723
diff changeset
    66
          }
38361
b609d0b271fa specific command state;
wenzelm
parents: 38360
diff changeset
    67
      }
b609d0b271fa specific command state;
wenzelm
parents: 38360
diff changeset
    68
  }
38367
f7d2574dc3a6 more basic notion of unparsed input;
wenzelm
parents: 38363
diff changeset
    69
f7d2574dc3a6 more basic notion of unparsed input;
wenzelm
parents: 38363
diff changeset
    70
f7d2574dc3a6 more basic notion of unparsed input;
wenzelm
parents: 38363
diff changeset
    71
  /* unparsed dummy commands */
f7d2574dc3a6 more basic notion of unparsed input;
wenzelm
parents: 38363
diff changeset
    72
f7d2574dc3a6 more basic notion of unparsed input;
wenzelm
parents: 38363
diff changeset
    73
  def unparsed(source: String) =
f7d2574dc3a6 more basic notion of unparsed input;
wenzelm
parents: 38363
diff changeset
    74
    new Command(Document.NO_ID, List(Token(Token.Kind.UNPARSED, source)))
34318
c13e168a8ae6 original sources from Johannes Hölzl a48e0c6ab1aea77c52d596f7efc007a543d3d10c with minor modifications of directory layout;
wenzelm
parents:
diff changeset
    75
}
c13e168a8ae6 original sources from Johannes Hölzl a48e0c6ab1aea77c52d596f7efc007a543d3d10c with minor modifications of directory layout;
wenzelm
parents:
diff changeset
    76
38361
b609d0b271fa specific command state;
wenzelm
parents: 38360
diff changeset
    77
34697
3d4874198e62 State: immutable;
wenzelm
parents: 34688
diff changeset
    78
class Command(
38150
67fc24df3721 simplified/refined document model: collection of named nodes, without proper dependencies yet;
wenzelm
parents: 37373
diff changeset
    79
    val id: Document.Command_ID,
38373
wenzelm
parents: 38370
diff changeset
    80
    val span: List[Token])
34451
3b9d0074ed44 command id via Isabelle.plugin;
wenzelm
parents: 34410
diff changeset
    81
{
34859
f986d84dd44b renamed Command.content to source;
wenzelm
parents: 34858
diff changeset
    82
  /* classification */
34500
384427c750c8 state_results: separate buffer for messages from running command;
wenzelm
parents: 34497
diff changeset
    83
36012
0614676f14d4 replaced some deprecated methods;
wenzelm
parents: 34871
diff changeset
    84
  def is_command: Boolean = !span.isEmpty && span.head.is_command
34865
104298db6abf Outer_Lex.is_ignored;
wenzelm
parents: 34860
diff changeset
    85
  def is_ignored: Boolean = span.forall(_.is_ignored)
34859
f986d84dd44b renamed Command.content to source;
wenzelm
parents: 34858
diff changeset
    86
  def is_malformed: Boolean = !is_command && !is_ignored
f986d84dd44b renamed Command.content to source;
wenzelm
parents: 34858
diff changeset
    87
38367
f7d2574dc3a6 more basic notion of unparsed input;
wenzelm
parents: 38363
diff changeset
    88
  def is_unparsed = id == Document.NO_ID
f7d2574dc3a6 more basic notion of unparsed input;
wenzelm
parents: 38363
diff changeset
    89
36012
0614676f14d4 replaced some deprecated methods;
wenzelm
parents: 34871
diff changeset
    90
  def name: String = if (is_command) span.head.content else ""
37129
4c83696b340e Command.toString: include id for debugging;
wenzelm
parents: 36990
diff changeset
    91
  override def toString =
37373
25078ba44436 tuned Command.toString -- preserving uniqueness allows the Scala toplevel to print Linear_Set[Command] results without crashing;
wenzelm
parents: 37197
diff changeset
    92
    id + "/" + (if (is_command) name else if (is_ignored) "IGNORED" else "MALFORMED")
34495
722533c532da Command: added name field and toString;
wenzelm
parents: 34491
diff changeset
    93
34859
f986d84dd44b renamed Command.content to source;
wenzelm
parents: 34858
diff changeset
    94
f986d84dd44b renamed Command.content to source;
wenzelm
parents: 34858
diff changeset
    95
  /* source text */
34451
3b9d0074ed44 command id via Isabelle.plugin;
wenzelm
parents: 34410
diff changeset
    96
34859
f986d84dd44b renamed Command.content to source;
wenzelm
parents: 34858
diff changeset
    97
  val source: String = span.map(_.source).mkString
38426
2858ec7b6dd8 specific types Text.Offset and Text.Range;
wenzelm
parents: 38415
diff changeset
    98
  def source(range: Text.Range): String = source.substring(range.start, range.stop)
34859
f986d84dd44b renamed Command.content to source;
wenzelm
parents: 34858
diff changeset
    99
  def length: Int = source.length
38572
0fe2c01ef7da Command.State: accumulate markup reports uniformly;
wenzelm
parents: 38564
diff changeset
   100
38877
682c4932b3cc Command.newlines: account for physical newlines;
wenzelm
parents: 38872
diff changeset
   101
  val newlines =
682c4932b3cc Command.newlines: account for physical newlines;
wenzelm
parents: 38872
diff changeset
   102
    (0 /: Symbol.iterator(source)) {
682c4932b3cc Command.newlines: account for physical newlines;
wenzelm
parents: 38872
diff changeset
   103
      case (n, s) => if (Symbol.is_physical_newline(s)) n + 1 else n }
682c4932b3cc Command.newlines: account for physical newlines;
wenzelm
parents: 38872
diff changeset
   104
38479
e628da370072 more efficient Markup_Tree, based on branches sorted by quasi-order;
wenzelm
parents: 38476
diff changeset
   105
  val range: Text.Range = Text.Range(0, length)
34855
81d0410dc3ac iterators for ranges of commands/starts -- avoid extra array per document;
wenzelm
parents: 34835
diff changeset
   106
34859
f986d84dd44b renamed Command.content to source;
wenzelm
parents: 34858
diff changeset
   107
  lazy val symbol_index = new Symbol.Index(source)
38579
ce46a6f55bce tuned signature;
wenzelm
parents: 38577
diff changeset
   108
  def decode(i: Text.Offset): Text.Offset = symbol_index.decode(i)
ce46a6f55bce tuned signature;
wenzelm
parents: 38577
diff changeset
   109
  def decode(r: Text.Range): Text.Range = symbol_index.decode(r)
38370
8b15d0f98962 explicit Document.State value, instead of individual state variables in Session, Command, Document;
wenzelm
parents: 38367
diff changeset
   110
8b15d0f98962 explicit Document.State value, instead of individual state variables in Session, Command, Document;
wenzelm
parents: 38367
diff changeset
   111
8b15d0f98962 explicit Document.State value, instead of individual state variables in Session, Command, Document;
wenzelm
parents: 38367
diff changeset
   112
  /* accumulated results */
8b15d0f98962 explicit Document.State value, instead of individual state variables in Session, Command, Document;
wenzelm
parents: 38367
diff changeset
   113
38872
26c505765024 Command.results: ordered by serial number;
wenzelm
parents: 38723
diff changeset
   114
  val empty_state: Command.State = Command.State(this)
34676
9e725d34df7b Command and Command_State handle results from prover as Accumulator
immler@in.tum.de
parents: 34675
diff changeset
   115
}