src/Tools/jEdit/src/document_model.scala
author wenzelm
Sun, 10 Jul 2011 00:21:19 +0200
changeset 43722 9b5dadb0c28d
parent 43718 4a4ca9e4a14b
child 44160 8848867501fb
permissions -rw-r--r--
propagate header changes to prover process; simplified Document case classes; Document.State.assignments: indexed by Version_ID;
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
43282
5d294220ca43 moved sources -- eliminated Netbeans artifact of jedit package directory;
wenzelm
parents: 40851
diff changeset
     1
/*  Title:      Tools/jEdit/src/document_model.scala
36760
b82a698ef6c9 tuned headers;
wenzelm
parents: 36015
diff changeset
     2
    Author:     Fabian Immler, TU Munich
b82a698ef6c9 tuned headers;
wenzelm
parents: 36015
diff changeset
     3
    Author:     Makarius
b82a698ef6c9 tuned headers;
wenzelm
parents: 36015
diff changeset
     4
38222
dac5fa0ac971 replaced individual Document_Model history by all-inclusive one in Session;
wenzelm
parents: 38158
diff changeset
     5
Document model connected to jEdit buffer -- single node in theory graph.
36760
b82a698ef6c9 tuned headers;
wenzelm
parents: 36015
diff changeset
     6
*/
34407
aad6834ba380 added some headers and comments;
wenzelm
parents: 34406
diff changeset
     7
34784
02959dcea756 split Theory_View into Document_Model (connected to Buffer) and Document_View (connected to JEditTextArea);
wenzelm
parents: 34783
diff changeset
     8
package isabelle.jedit
34760
dc7f5e0d9d27 misc modernization of names;
wenzelm
parents: 34759
diff changeset
     9
34318
c13e168a8ae6 original sources from Johannes Hölzl a48e0c6ab1aea77c52d596f7efc007a543d3d10c with minor modifications of directory layout;
wenzelm
parents:
diff changeset
    10
36015
6111de7c916a adapted to Scala 2.8.0 Beta 1;
wenzelm
parents: 34871
diff changeset
    11
import isabelle._
6111de7c916a adapted to Scala 2.8.0 Beta 1;
wenzelm
parents: 34871
diff changeset
    12
34693
3e995f100ad2 sealed Edit;
wenzelm
parents: 34685
diff changeset
    13
import scala.collection.mutable
34446
5c79f97ec1d1 superficial tuning;
wenzelm
parents: 34445
diff changeset
    14
34784
02959dcea756 split Theory_View into Document_Model (connected to Buffer) and Document_View (connected to JEditTextArea);
wenzelm
parents: 34783
diff changeset
    15
import org.gjt.sp.jedit.Buffer
34783
cb95d6bbf5f1 clarified BufferListener: use adapter, listen to contentInserted instead of preContentInserted;
wenzelm
parents: 34778
diff changeset
    16
import org.gjt.sp.jedit.buffer.{BufferAdapter, BufferListener, JEditBuffer}
38158
8aaa21db41f3 Document_Model: include token marker here;
wenzelm
parents: 38152
diff changeset
    17
import org.gjt.sp.jedit.textarea.TextArea
8aaa21db41f3 Document_Model: include token marker here;
wenzelm
parents: 38152
diff changeset
    18
8aaa21db41f3 Document_Model: include token marker here;
wenzelm
parents: 38152
diff changeset
    19
import java.awt.font.TextAttribute
34318
c13e168a8ae6 original sources from Johannes Hölzl a48e0c6ab1aea77c52d596f7efc007a543d3d10c with minor modifications of directory layout;
wenzelm
parents:
diff changeset
    20
34760
dc7f5e0d9d27 misc modernization of names;
wenzelm
parents: 34759
diff changeset
    21
34784
02959dcea756 split Theory_View into Document_Model (connected to Buffer) and Document_View (connected to JEditTextArea);
wenzelm
parents: 34783
diff changeset
    22
object Document_Model
34588
e8ac8794971f superficial tuning;
wenzelm
parents: 34583
diff changeset
    23
{
34784
02959dcea756 split Theory_View into Document_Model (connected to Buffer) and Document_View (connected to JEditTextArea);
wenzelm
parents: 34783
diff changeset
    24
  /* document model of buffer */
02959dcea756 split Theory_View into Document_Model (connected to Buffer) and Document_View (connected to JEditTextArea);
wenzelm
parents: 34783
diff changeset
    25
02959dcea756 split Theory_View into Document_Model (connected to Buffer) and Document_View (connected to JEditTextArea);
wenzelm
parents: 34783
diff changeset
    26
  private val key = "isabelle.document_model"
02959dcea756 split Theory_View into Document_Model (connected to Buffer) and Document_View (connected to JEditTextArea);
wenzelm
parents: 34783
diff changeset
    27
34788
3779c54a2d21 direct apply for Document_Model and Document_View;
wenzelm
parents: 34784
diff changeset
    28
  def apply(buffer: Buffer): Option[Document_Model] =
34784
02959dcea756 split Theory_View into Document_Model (connected to Buffer) and Document_View (connected to JEditTextArea);
wenzelm
parents: 34783
diff changeset
    29
  {
38223
2a368e8e0a80 more explicit treatment of Swing thread context;
wenzelm
parents: 38222
diff changeset
    30
    Swing_Thread.require()
34784
02959dcea756 split Theory_View into Document_Model (connected to Buffer) and Document_View (connected to JEditTextArea);
wenzelm
parents: 34783
diff changeset
    31
    buffer.getProperty(key) match {
02959dcea756 split Theory_View into Document_Model (connected to Buffer) and Document_View (connected to JEditTextArea);
wenzelm
parents: 34783
diff changeset
    32
      case model: Document_Model => Some(model)
02959dcea756 split Theory_View into Document_Model (connected to Buffer) and Document_View (connected to JEditTextArea);
wenzelm
parents: 34783
diff changeset
    33
      case _ => None
02959dcea756 split Theory_View into Document_Model (connected to Buffer) and Document_View (connected to JEditTextArea);
wenzelm
parents: 34783
diff changeset
    34
    }
02959dcea756 split Theory_View into Document_Model (connected to Buffer) and Document_View (connected to JEditTextArea);
wenzelm
parents: 34783
diff changeset
    35
  }
02959dcea756 split Theory_View into Document_Model (connected to Buffer) and Document_View (connected to JEditTextArea);
wenzelm
parents: 34783
diff changeset
    36
02959dcea756 split Theory_View into Document_Model (connected to Buffer) and Document_View (connected to JEditTextArea);
wenzelm
parents: 34783
diff changeset
    37
  def exit(buffer: Buffer)
02959dcea756 split Theory_View into Document_Model (connected to Buffer) and Document_View (connected to JEditTextArea);
wenzelm
parents: 34783
diff changeset
    38
  {
38223
2a368e8e0a80 more explicit treatment of Swing thread context;
wenzelm
parents: 38222
diff changeset
    39
    Swing_Thread.require()
34788
3779c54a2d21 direct apply for Document_Model and Document_View;
wenzelm
parents: 34784
diff changeset
    40
    apply(buffer) match {
39636
610dc743932c permissive exit;
wenzelm
parents: 39179
diff changeset
    41
      case None =>
34784
02959dcea756 split Theory_View into Document_Model (connected to Buffer) and Document_View (connected to JEditTextArea);
wenzelm
parents: 34783
diff changeset
    42
      case Some(model) =>
02959dcea756 split Theory_View into Document_Model (connected to Buffer) and Document_View (connected to JEditTextArea);
wenzelm
parents: 34783
diff changeset
    43
        model.deactivate()
02959dcea756 split Theory_View into Document_Model (connected to Buffer) and Document_View (connected to JEditTextArea);
wenzelm
parents: 34783
diff changeset
    44
        buffer.unsetProperty(key)
34653
2e033aaf128e commands carrying state-information
immler@in.tum.de
parents: 34652
diff changeset
    45
    }
34318
c13e168a8ae6 original sources from Johannes Hölzl a48e0c6ab1aea77c52d596f7efc007a543d3d10c with minor modifications of directory layout;
wenzelm
parents:
diff changeset
    46
  }
43397
dba359c0ae3b more robust init;
wenzelm
parents: 43394
diff changeset
    47
43697
77ce24aa1770 explicit Document.Node.Header, with master_dir and thy_name;
wenzelm
parents: 43661
diff changeset
    48
  def init(session: Session, buffer: Buffer, master_dir: Path, thy_name: String): Document_Model =
43397
dba359c0ae3b more robust init;
wenzelm
parents: 43394
diff changeset
    49
  {
dba359c0ae3b more robust init;
wenzelm
parents: 43394
diff changeset
    50
    exit(buffer)
43648
e32de528b5ef more explicit edit_node vs. init_node;
wenzelm
parents: 43644
diff changeset
    51
    val model = new Document_Model(session, buffer, master_dir, thy_name)
43397
dba359c0ae3b more robust init;
wenzelm
parents: 43394
diff changeset
    52
    buffer.setProperty(key, model)
dba359c0ae3b more robust init;
wenzelm
parents: 43394
diff changeset
    53
    model.activate()
dba359c0ae3b more robust init;
wenzelm
parents: 43394
diff changeset
    54
    model
dba359c0ae3b more robust init;
wenzelm
parents: 43394
diff changeset
    55
  }
34318
c13e168a8ae6 original sources from Johannes Hölzl a48e0c6ab1aea77c52d596f7efc007a543d3d10c with minor modifications of directory layout;
wenzelm
parents:
diff changeset
    56
}
c13e168a8ae6 original sources from Johannes Hölzl a48e0c6ab1aea77c52d596f7efc007a543d3d10c with minor modifications of directory layout;
wenzelm
parents:
diff changeset
    57
38151
2837c952ca31 explicit Change.Snapshot and Document.Node;
wenzelm
parents: 38150
diff changeset
    58
43648
e32de528b5ef more explicit edit_node vs. init_node;
wenzelm
parents: 43644
diff changeset
    59
class Document_Model(val session: Session,
43697
77ce24aa1770 explicit Document.Node.Header, with master_dir and thy_name;
wenzelm
parents: 43661
diff changeset
    60
  val buffer: Buffer, val master_dir: Path, val thy_name: String)
34588
e8ac8794971f superficial tuning;
wenzelm
parents: 34583
diff changeset
    61
{
38224
809578d7f6af more explicit model of pending text edits;
wenzelm
parents: 38223
diff changeset
    62
  /* pending text edits */
38222
dac5fa0ac971 replaced individual Document_Model history by all-inclusive one in Session;
wenzelm
parents: 38158
diff changeset
    63
43718
4a4ca9e4a14b clarified propagation of node name and header;
wenzelm
parents: 43715
diff changeset
    64
  private val node_name = (master_dir + Path.basic(thy_name)).implode
4a4ca9e4a14b clarified propagation of node name and header;
wenzelm
parents: 43715
diff changeset
    65
43697
77ce24aa1770 explicit Document.Node.Header, with master_dir and thy_name;
wenzelm
parents: 43661
diff changeset
    66
  private def node_header(): Document.Node.Header =
43722
9b5dadb0c28d propagate header changes to prover process;
wenzelm
parents: 43718
diff changeset
    67
    Document.Node.Header(Path.current,  // FIXME master_dir (!?)
43697
77ce24aa1770 explicit Document.Node.Header, with master_dir and thy_name;
wenzelm
parents: 43661
diff changeset
    68
      Exn.capture { Thy_Header.check(thy_name, buffer.getSegment(0, buffer.getLength)) })
43648
e32de528b5ef more explicit edit_node vs. init_node;
wenzelm
parents: 43644
diff changeset
    69
43644
ea08ce1c314b tuned signature;
wenzelm
parents: 43512
diff changeset
    70
  private object pending_edits  // owned by Swing thread
38224
809578d7f6af more explicit model of pending text edits;
wenzelm
parents: 38223
diff changeset
    71
  {
38425
e467db701d78 moved Text_Edit to Text.Edit;
wenzelm
parents: 38417
diff changeset
    72
    private val pending = new mutable.ListBuffer[Text.Edit]
e467db701d78 moved Text_Edit to Text.Edit;
wenzelm
parents: 38417
diff changeset
    73
    def snapshot(): List[Text.Edit] = pending.toList
38224
809578d7f6af more explicit model of pending text edits;
wenzelm
parents: 38223
diff changeset
    74
43648
e32de528b5ef more explicit edit_node vs. init_node;
wenzelm
parents: 43644
diff changeset
    75
    def flush()
38224
809578d7f6af more explicit model of pending text edits;
wenzelm
parents: 38223
diff changeset
    76
    {
809578d7f6af more explicit model of pending text edits;
wenzelm
parents: 38223
diff changeset
    77
      Swing_Thread.require()
43648
e32de528b5ef more explicit edit_node vs. init_node;
wenzelm
parents: 43644
diff changeset
    78
      snapshot() match {
e32de528b5ef more explicit edit_node vs. init_node;
wenzelm
parents: 43644
diff changeset
    79
        case Nil =>
e32de528b5ef more explicit edit_node vs. init_node;
wenzelm
parents: 43644
diff changeset
    80
        case edits =>
e32de528b5ef more explicit edit_node vs. init_node;
wenzelm
parents: 43644
diff changeset
    81
          pending.clear
43718
4a4ca9e4a14b clarified propagation of node name and header;
wenzelm
parents: 43715
diff changeset
    82
          session.edit_node(node_name, node_header(), edits)
43648
e32de528b5ef more explicit edit_node vs. init_node;
wenzelm
parents: 43644
diff changeset
    83
      }
38224
809578d7f6af more explicit model of pending text edits;
wenzelm
parents: 38223
diff changeset
    84
    }
809578d7f6af more explicit model of pending text edits;
wenzelm
parents: 38223
diff changeset
    85
40478
4bae781b8f7c replaced Document.Node_Text_Edit by Document.Text_Edit, with treatment of deleted nodes;
wenzelm
parents: 40474
diff changeset
    86
    def init()
4bae781b8f7c replaced Document.Node_Text_Edit by Document.Text_Edit, with treatment of deleted nodes;
wenzelm
parents: 40474
diff changeset
    87
    {
43648
e32de528b5ef more explicit edit_node vs. init_node;
wenzelm
parents: 43644
diff changeset
    88
      flush()
43718
4a4ca9e4a14b clarified propagation of node name and header;
wenzelm
parents: 43715
diff changeset
    89
      session.init_node(node_name, node_header(), Isabelle.buffer_text(buffer))
40478
4bae781b8f7c replaced Document.Node_Text_Edit by Document.Text_Edit, with treatment of deleted nodes;
wenzelm
parents: 40474
diff changeset
    90
    }
4bae781b8f7c replaced Document.Node_Text_Edit by Document.Text_Edit, with treatment of deleted nodes;
wenzelm
parents: 40474
diff changeset
    91
4bae781b8f7c replaced Document.Node_Text_Edit by Document.Text_Edit, with treatment of deleted nodes;
wenzelm
parents: 40474
diff changeset
    92
    private val delay_flush =
4bae781b8f7c replaced Document.Node_Text_Edit by Document.Text_Edit, with treatment of deleted nodes;
wenzelm
parents: 40474
diff changeset
    93
      Swing_Thread.delay_last(session.input_delay) { flush() }
4bae781b8f7c replaced Document.Node_Text_Edit by Document.Text_Edit, with treatment of deleted nodes;
wenzelm
parents: 40474
diff changeset
    94
38425
e467db701d78 moved Text_Edit to Text.Edit;
wenzelm
parents: 38417
diff changeset
    95
    def +=(edit: Text.Edit)
38224
809578d7f6af more explicit model of pending text edits;
wenzelm
parents: 38223
diff changeset
    96
    {
809578d7f6af more explicit model of pending text edits;
wenzelm
parents: 38223
diff changeset
    97
      Swing_Thread.require()
809578d7f6af more explicit model of pending text edits;
wenzelm
parents: 38223
diff changeset
    98
      pending += edit
809578d7f6af more explicit model of pending text edits;
wenzelm
parents: 38223
diff changeset
    99
      delay_flush()
38222
dac5fa0ac971 replaced individual Document_Model history by all-inclusive one in Session;
wenzelm
parents: 38158
diff changeset
   100
    }
dac5fa0ac971 replaced individual Document_Model history by all-inclusive one in Session;
wenzelm
parents: 38158
diff changeset
   101
  }
38152
eab0d1c2e46e Change.Snapshot: include from_current/to_current here, with precomputed changes;
wenzelm
parents: 38151
diff changeset
   102
eab0d1c2e46e Change.Snapshot: include from_current/to_current here, with precomputed changes;
wenzelm
parents: 38151
diff changeset
   103
eab0d1c2e46e Change.Snapshot: include from_current/to_current here, with precomputed changes;
wenzelm
parents: 38151
diff changeset
   104
  /* snapshot */
34731
c0cb6bd10eec keep BufferListener and TextAreaExtension private;
wenzelm
parents: 34724
diff changeset
   105
38417
b8922ae21111 renamed class Document to Document.Version etc.;
wenzelm
parents: 38359
diff changeset
   106
  def snapshot(): Document.Snapshot =
b8922ae21111 renamed class Document to Document.Version etc.;
wenzelm
parents: 38359
diff changeset
   107
  {
38223
2a368e8e0a80 more explicit treatment of Swing thread context;
wenzelm
parents: 38222
diff changeset
   108
    Swing_Thread.require()
43697
77ce24aa1770 explicit Document.Node.Header, with master_dir and thy_name;
wenzelm
parents: 43661
diff changeset
   109
    session.snapshot(node_name, pending_edits.snapshot())
38223
2a368e8e0a80 more explicit treatment of Swing thread context;
wenzelm
parents: 38222
diff changeset
   110
  }
34828
c2308b317244 misc tuning;
wenzelm
parents: 34827
diff changeset
   111
c2308b317244 misc tuning;
wenzelm
parents: 34827
diff changeset
   112
c2308b317244 misc tuning;
wenzelm
parents: 34827
diff changeset
   113
  /* buffer listener */
c2308b317244 misc tuning;
wenzelm
parents: 34827
diff changeset
   114
c2308b317244 misc tuning;
wenzelm
parents: 34827
diff changeset
   115
  private val buffer_listener: BufferListener = new BufferAdapter
c2308b317244 misc tuning;
wenzelm
parents: 34827
diff changeset
   116
  {
40478
4bae781b8f7c replaced Document.Node_Text_Edit by Document.Text_Edit, with treatment of deleted nodes;
wenzelm
parents: 40474
diff changeset
   117
    override def bufferLoaded(buffer: JEditBuffer)
4bae781b8f7c replaced Document.Node_Text_Edit by Document.Text_Edit, with treatment of deleted nodes;
wenzelm
parents: 40474
diff changeset
   118
    {
4bae781b8f7c replaced Document.Node_Text_Edit by Document.Text_Edit, with treatment of deleted nodes;
wenzelm
parents: 40474
diff changeset
   119
      pending_edits.init()
4bae781b8f7c replaced Document.Node_Text_Edit by Document.Text_Edit, with treatment of deleted nodes;
wenzelm
parents: 40474
diff changeset
   120
    }
4bae781b8f7c replaced Document.Node_Text_Edit by Document.Text_Edit, with treatment of deleted nodes;
wenzelm
parents: 40474
diff changeset
   121
34828
c2308b317244 misc tuning;
wenzelm
parents: 34827
diff changeset
   122
    override def contentInserted(buffer: JEditBuffer,
c2308b317244 misc tuning;
wenzelm
parents: 34827
diff changeset
   123
      start_line: Int, offset: Int, num_lines: Int, length: Int)
c2308b317244 misc tuning;
wenzelm
parents: 34827
diff changeset
   124
    {
40478
4bae781b8f7c replaced Document.Node_Text_Edit by Document.Text_Edit, with treatment of deleted nodes;
wenzelm
parents: 40474
diff changeset
   125
      if (!buffer.isLoading)
4bae781b8f7c replaced Document.Node_Text_Edit by Document.Text_Edit, with treatment of deleted nodes;
wenzelm
parents: 40474
diff changeset
   126
        pending_edits += Text.Edit.insert(offset, buffer.getText(offset, length))
34828
c2308b317244 misc tuning;
wenzelm
parents: 34827
diff changeset
   127
    }
c2308b317244 misc tuning;
wenzelm
parents: 34827
diff changeset
   128
c2308b317244 misc tuning;
wenzelm
parents: 34827
diff changeset
   129
    override def preContentRemoved(buffer: JEditBuffer,
38426
2858ec7b6dd8 specific types Text.Offset and Text.Range;
wenzelm
parents: 38425
diff changeset
   130
      start_line: Int, offset: Int, num_lines: Int, removed_length: Int)
34828
c2308b317244 misc tuning;
wenzelm
parents: 34827
diff changeset
   131
    {
40478
4bae781b8f7c replaced Document.Node_Text_Edit by Document.Text_Edit, with treatment of deleted nodes;
wenzelm
parents: 40474
diff changeset
   132
      if (!buffer.isLoading)
4bae781b8f7c replaced Document.Node_Text_Edit by Document.Text_Edit, with treatment of deleted nodes;
wenzelm
parents: 40474
diff changeset
   133
        pending_edits += Text.Edit.remove(offset, buffer.getText(offset, removed_length))
34828
c2308b317244 misc tuning;
wenzelm
parents: 34827
diff changeset
   134
    }
c2308b317244 misc tuning;
wenzelm
parents: 34827
diff changeset
   135
  }
c2308b317244 misc tuning;
wenzelm
parents: 34827
diff changeset
   136
c2308b317244 misc tuning;
wenzelm
parents: 34827
diff changeset
   137
38158
8aaa21db41f3 Document_Model: include token marker here;
wenzelm
parents: 38152
diff changeset
   138
  /* activation */
37557
1ae272fd4082 refresh Isabelle token marker after buffer properties changed, e.g. when fold mode is switched;
wenzelm
parents: 37555
diff changeset
   139
43512
270ce5ff2086 clarified init/exit procedure;
wenzelm
parents: 43452
diff changeset
   140
  private def activate()
34784
02959dcea756 split Theory_View into Document_Model (connected to Buffer) and Document_View (connected to JEditTextArea);
wenzelm
parents: 34783
diff changeset
   141
  {
02959dcea756 split Theory_View into Document_Model (connected to Buffer) and Document_View (connected to JEditTextArea);
wenzelm
parents: 34783
diff changeset
   142
    buffer.addBufferListener(buffer_listener)
43512
270ce5ff2086 clarified init/exit procedure;
wenzelm
parents: 43452
diff changeset
   143
    pending_edits.init()
34784
02959dcea756 split Theory_View into Document_Model (connected to Buffer) and Document_View (connected to JEditTextArea);
wenzelm
parents: 34783
diff changeset
   144
    buffer.propertiesChanged()
34680
1f1f6c95de64 clarified structure of TheoryView
immler@in.tum.de
parents: 34679
diff changeset
   145
  }
1f1f6c95de64 clarified structure of TheoryView
immler@in.tum.de
parents: 34679
diff changeset
   146
43512
270ce5ff2086 clarified init/exit procedure;
wenzelm
parents: 43452
diff changeset
   147
  private def deactivate()
34680
1f1f6c95de64 clarified structure of TheoryView
immler@in.tum.de
parents: 34679
diff changeset
   148
  {
40478
4bae781b8f7c replaced Document.Node_Text_Edit by Document.Text_Edit, with treatment of deleted nodes;
wenzelm
parents: 40474
diff changeset
   149
    pending_edits.flush()
34784
02959dcea756 split Theory_View into Document_Model (connected to Buffer) and Document_View (connected to JEditTextArea);
wenzelm
parents: 34783
diff changeset
   150
    buffer.removeBufferListener(buffer_listener)
43512
270ce5ff2086 clarified init/exit procedure;
wenzelm
parents: 43452
diff changeset
   151
    buffer.propertiesChanged()
34680
1f1f6c95de64 clarified structure of TheoryView
immler@in.tum.de
parents: 34679
diff changeset
   152
  }
34447
wenzelm
parents: 34446
diff changeset
   153
}