src/Tools/VSCode/src/document_model.scala
author wenzelm
Sat, 07 Jan 2017 20:44:37 +0100
changeset 64826 c97296294f6d
parent 64824 330ec9bc4b75
child 64827 4ef1eb75f1cd
permissions -rw-r--r--
clarified check_thy_reader: check node_name here;
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
64605
9c1173a7e4cb basic support for VSCode Language Server protocol;
wenzelm
parents:
diff changeset
     1
/*  Title:      Tools/VSCode/src/document_model.scala
9c1173a7e4cb basic support for VSCode Language Server protocol;
wenzelm
parents:
diff changeset
     2
    Author:     Makarius
9c1173a7e4cb basic support for VSCode Language Server protocol;
wenzelm
parents:
diff changeset
     3
9c1173a7e4cb basic support for VSCode Language Server protocol;
wenzelm
parents:
diff changeset
     4
Document model for line-oriented text.
9c1173a7e4cb basic support for VSCode Language Server protocol;
wenzelm
parents:
diff changeset
     5
*/
9c1173a7e4cb basic support for VSCode Language Server protocol;
wenzelm
parents:
diff changeset
     6
9c1173a7e4cb basic support for VSCode Language Server protocol;
wenzelm
parents:
diff changeset
     7
package isabelle.vscode
9c1173a7e4cb basic support for VSCode Language Server protocol;
wenzelm
parents:
diff changeset
     8
9c1173a7e4cb basic support for VSCode Language Server protocol;
wenzelm
parents:
diff changeset
     9
9c1173a7e4cb basic support for VSCode Language Server protocol;
wenzelm
parents:
diff changeset
    10
import isabelle._
9c1173a7e4cb basic support for VSCode Language Server protocol;
wenzelm
parents:
diff changeset
    11
64710
72ca4e5f976e manage changes of external files;
wenzelm
parents: 64709
diff changeset
    12
import java.io.{File => JFile}
72ca4e5f976e manage changes of external files;
wenzelm
parents: 64709
diff changeset
    13
64605
9c1173a7e4cb basic support for VSCode Language Server protocol;
wenzelm
parents:
diff changeset
    14
64707
7157685b71e3 clarified Document_Model perspective and edits;
wenzelm
parents: 64704
diff changeset
    15
object Document_Model
7157685b71e3 clarified Document_Model perspective and edits;
wenzelm
parents: 64704
diff changeset
    16
{
64777
ca09695eb43c clarified Document.Node.Name (again): canonical platform file;
wenzelm
parents: 64775
diff changeset
    17
  def init(session: Session, node_name: Document.Node.Name): Document_Model =
64707
7157685b71e3 clarified Document_Model perspective and edits;
wenzelm
parents: 64704
diff changeset
    18
  {
7157685b71e3 clarified Document_Model perspective and edits;
wenzelm
parents: 64704
diff changeset
    19
    val resources = session.resources.asInstanceOf[VSCode_Resources]
64709
5e6566ab78bf more explicit edits -- eliminated Clear;
wenzelm
parents: 64707
diff changeset
    20
    val doc = Line.Document("", resources.text_length)
5e6566ab78bf more explicit edits -- eliminated Clear;
wenzelm
parents: 64707
diff changeset
    21
    Document_Model(session, node_name, doc)
64707
7157685b71e3 clarified Document_Model perspective and edits;
wenzelm
parents: 64704
diff changeset
    22
  }
7157685b71e3 clarified Document_Model perspective and edits;
wenzelm
parents: 64704
diff changeset
    23
}
7157685b71e3 clarified Document_Model perspective and edits;
wenzelm
parents: 64704
diff changeset
    24
64710
72ca4e5f976e manage changes of external files;
wenzelm
parents: 64709
diff changeset
    25
sealed case class Document_Model(
64707
7157685b71e3 clarified Document_Model perspective and edits;
wenzelm
parents: 64704
diff changeset
    26
  session: Session,
7157685b71e3 clarified Document_Model perspective and edits;
wenzelm
parents: 64704
diff changeset
    27
  node_name: Document.Node.Name,
7157685b71e3 clarified Document_Model perspective and edits;
wenzelm
parents: 64704
diff changeset
    28
  doc: Line.Document,
64726
c534a2ac537d clarified;
wenzelm
parents: 64725
diff changeset
    29
  external_file: Boolean = false,
64707
7157685b71e3 clarified Document_Model perspective and edits;
wenzelm
parents: 64704
diff changeset
    30
  node_required: Boolean = false,
7157685b71e3 clarified Document_Model perspective and edits;
wenzelm
parents: 64704
diff changeset
    31
  last_perspective: Document.Node.Perspective_Text = Document.Node.no_perspective_text,
64816
wenzelm
parents: 64815
diff changeset
    32
  pending_edits: List[Text.Edit] = Nil,
64814
wenzelm
parents: 64806
diff changeset
    33
  published_diagnostics: List[Text.Info[Command.Results]] = Nil) extends Document.Model
64605
9c1173a7e4cb basic support for VSCode Language Server protocol;
wenzelm
parents:
diff changeset
    34
{
64710
72ca4e5f976e manage changes of external files;
wenzelm
parents: 64709
diff changeset
    35
  /* external file */
72ca4e5f976e manage changes of external files;
wenzelm
parents: 64709
diff changeset
    36
64727
13e37567a0d6 automatically resolve dependencies from document models and file-system;
wenzelm
parents: 64726
diff changeset
    37
  def external(b: Boolean): Document_Model = copy(external_file = b)
13e37567a0d6 automatically resolve dependencies from document models and file-system;
wenzelm
parents: 64726
diff changeset
    38
64800
415dafeb9669 manage document blobs as well;
wenzelm
parents: 64777
diff changeset
    39
  def node_visible: Boolean = !external_file
415dafeb9669 manage document blobs as well;
wenzelm
parents: 64777
diff changeset
    40
64710
72ca4e5f976e manage changes of external files;
wenzelm
parents: 64709
diff changeset
    41
64690
599873de8b01 more uniform pending_input / pending_output;
wenzelm
parents: 64683
diff changeset
    42
  /* header */
599873de8b01 more uniform pending_input / pending_output;
wenzelm
parents: 64683
diff changeset
    43
64702
d95b9117cb5b re-use resources from session;
wenzelm
parents: 64690
diff changeset
    44
  def node_header: Document.Node.Header =
64673
b5965890e54d more uniform treatment of file name vs. theory name and special header;
wenzelm
parents: 64672
diff changeset
    45
    resources.special_header(node_name) getOrElse
64826
c97296294f6d clarified check_thy_reader: check node_name here;
wenzelm
parents: 64824
diff changeset
    46
      resources.check_thy_reader("", node_name, Scan.char_reader(doc.text))
64605
9c1173a7e4cb basic support for VSCode Language Server protocol;
wenzelm
parents:
diff changeset
    47
9c1173a7e4cb basic support for VSCode Language Server protocol;
wenzelm
parents:
diff changeset
    48
64707
7157685b71e3 clarified Document_Model perspective and edits;
wenzelm
parents: 64704
diff changeset
    49
  /* perspective */
7157685b71e3 clarified Document_Model perspective and edits;
wenzelm
parents: 64704
diff changeset
    50
64800
415dafeb9669 manage document blobs as well;
wenzelm
parents: 64777
diff changeset
    51
  def node_perspective(doc_blobs: Document.Blobs): (Boolean, Document.Node.Perspective_Text) =
415dafeb9669 manage document blobs as well;
wenzelm
parents: 64777
diff changeset
    52
  {
415dafeb9669 manage document blobs as well;
wenzelm
parents: 64777
diff changeset
    53
    if (is_theory) {
415dafeb9669 manage document blobs as well;
wenzelm
parents: 64777
diff changeset
    54
      val snapshot = this.snapshot()
415dafeb9669 manage document blobs as well;
wenzelm
parents: 64777
diff changeset
    55
415dafeb9669 manage document blobs as well;
wenzelm
parents: 64777
diff changeset
    56
      val text_perspective =
415dafeb9669 manage document blobs as well;
wenzelm
parents: 64777
diff changeset
    57
        if (node_visible || snapshot.commands_loading_ranges(resources.visible_node(_)).nonEmpty)
415dafeb9669 manage document blobs as well;
wenzelm
parents: 64777
diff changeset
    58
          Text.Perspective.full
415dafeb9669 manage document blobs as well;
wenzelm
parents: 64777
diff changeset
    59
        else Text.Perspective.empty
64723
65bcb1fbaa73 clarified node_visible;
wenzelm
parents: 64710
diff changeset
    60
64800
415dafeb9669 manage document blobs as well;
wenzelm
parents: 64777
diff changeset
    61
      (snapshot.node.load_commands_changed(doc_blobs),
415dafeb9669 manage document blobs as well;
wenzelm
parents: 64777
diff changeset
    62
        Document.Node.Perspective(node_required, text_perspective, Document.Node.Overlays.empty))
415dafeb9669 manage document blobs as well;
wenzelm
parents: 64777
diff changeset
    63
    }
415dafeb9669 manage document blobs as well;
wenzelm
parents: 64777
diff changeset
    64
    else (false, Document.Node.no_perspective_text)
415dafeb9669 manage document blobs as well;
wenzelm
parents: 64777
diff changeset
    65
  }
415dafeb9669 manage document blobs as well;
wenzelm
parents: 64777
diff changeset
    66
64707
7157685b71e3 clarified Document_Model perspective and edits;
wenzelm
parents: 64704
diff changeset
    67
64800
415dafeb9669 manage document blobs as well;
wenzelm
parents: 64777
diff changeset
    68
  /* blob */
415dafeb9669 manage document blobs as well;
wenzelm
parents: 64777
diff changeset
    69
415dafeb9669 manage document blobs as well;
wenzelm
parents: 64777
diff changeset
    70
  def get_blob: Option[Document.Blob] =
415dafeb9669 manage document blobs as well;
wenzelm
parents: 64777
diff changeset
    71
    if (is_theory) None
64821
37bf7acf6a4b clarified lazy text content;
wenzelm
parents: 64816
diff changeset
    72
    else Some((Document.Blob(doc.bytes, doc.chunk, pending_edits.nonEmpty)))
64707
7157685b71e3 clarified Document_Model perspective and edits;
wenzelm
parents: 64704
diff changeset
    73
7157685b71e3 clarified Document_Model perspective and edits;
wenzelm
parents: 64704
diff changeset
    74
64605
9c1173a7e4cb basic support for VSCode Language Server protocol;
wenzelm
parents:
diff changeset
    75
  /* edits */
9c1173a7e4cb basic support for VSCode Language Server protocol;
wenzelm
parents:
diff changeset
    76
64806
99f49258b02b more robust treatment of logical lines;
wenzelm
parents: 64800
diff changeset
    77
  def update_text(text: String): Option[Document_Model] =
64709
5e6566ab78bf more explicit edits -- eliminated Clear;
wenzelm
parents: 64707
diff changeset
    78
  {
64821
37bf7acf6a4b clarified lazy text content;
wenzelm
parents: 64816
diff changeset
    79
    val old_text = doc.text
64806
99f49258b02b more robust treatment of logical lines;
wenzelm
parents: 64800
diff changeset
    80
    val new_text = Line.normalize(text)
64816
wenzelm
parents: 64815
diff changeset
    81
    Text.Edit.replace(0, old_text, new_text) match {
wenzelm
parents: 64815
diff changeset
    82
      case Nil => None
wenzelm
parents: 64815
diff changeset
    83
      case edits =>
wenzelm
parents: 64815
diff changeset
    84
        val doc1 = Line.Document(new_text, doc.text_length)
wenzelm
parents: 64815
diff changeset
    85
        val pending_edits1 = pending_edits ::: edits
wenzelm
parents: 64815
diff changeset
    86
        Some(copy(doc = doc1, pending_edits = pending_edits1))
64709
5e6566ab78bf more explicit edits -- eliminated Clear;
wenzelm
parents: 64707
diff changeset
    87
    }
5e6566ab78bf more explicit edits -- eliminated Clear;
wenzelm
parents: 64707
diff changeset
    88
  }
5e6566ab78bf more explicit edits -- eliminated Clear;
wenzelm
parents: 64707
diff changeset
    89
64800
415dafeb9669 manage document blobs as well;
wenzelm
parents: 64777
diff changeset
    90
  def flush_edits(doc_blobs: Document.Blobs): Option[(List[Document.Edit_Text], Document_Model)] =
64707
7157685b71e3 clarified Document_Model perspective and edits;
wenzelm
parents: 64704
diff changeset
    91
  {
64800
415dafeb9669 manage document blobs as well;
wenzelm
parents: 64777
diff changeset
    92
    val (reparse, perspective) = node_perspective(doc_blobs)
415dafeb9669 manage document blobs as well;
wenzelm
parents: 64777
diff changeset
    93
    if (reparse || pending_edits.nonEmpty || last_perspective != perspective) {
415dafeb9669 manage document blobs as well;
wenzelm
parents: 64777
diff changeset
    94
      val edits: List[Document.Edit_Text] =
415dafeb9669 manage document blobs as well;
wenzelm
parents: 64777
diff changeset
    95
        get_blob match {
415dafeb9669 manage document blobs as well;
wenzelm
parents: 64777
diff changeset
    96
          case None =>
415dafeb9669 manage document blobs as well;
wenzelm
parents: 64777
diff changeset
    97
            List(session.header_edit(node_name, node_header),
64816
wenzelm
parents: 64815
diff changeset
    98
              node_name -> Document.Node.Edits(pending_edits),
64800
415dafeb9669 manage document blobs as well;
wenzelm
parents: 64777
diff changeset
    99
              node_name -> perspective)
415dafeb9669 manage document blobs as well;
wenzelm
parents: 64777
diff changeset
   100
          case Some(blob) =>
415dafeb9669 manage document blobs as well;
wenzelm
parents: 64777
diff changeset
   101
            List(node_name -> Document.Node.Blob(blob),
64816
wenzelm
parents: 64815
diff changeset
   102
              node_name -> Document.Node.Edits(pending_edits))
64800
415dafeb9669 manage document blobs as well;
wenzelm
parents: 64777
diff changeset
   103
        }
64816
wenzelm
parents: 64815
diff changeset
   104
      Some((edits, copy(pending_edits = Nil, last_perspective = perspective)))
64605
9c1173a7e4cb basic support for VSCode Language Server protocol;
wenzelm
parents:
diff changeset
   105
    }
64707
7157685b71e3 clarified Document_Model perspective and edits;
wenzelm
parents: 64704
diff changeset
   106
    else None
7157685b71e3 clarified Document_Model perspective and edits;
wenzelm
parents: 64704
diff changeset
   107
  }
64605
9c1173a7e4cb basic support for VSCode Language Server protocol;
wenzelm
parents:
diff changeset
   108
9c1173a7e4cb basic support for VSCode Language Server protocol;
wenzelm
parents:
diff changeset
   109
64679
b2bf280b7e13 more uniform treatment of input/output wrt. client;
wenzelm
parents: 64673
diff changeset
   110
  /* diagnostics */
b2bf280b7e13 more uniform treatment of input/output wrt. client;
wenzelm
parents: 64673
diff changeset
   111
b2bf280b7e13 more uniform treatment of input/output wrt. client;
wenzelm
parents: 64673
diff changeset
   112
  def publish_diagnostics(rendering: VSCode_Rendering)
b2bf280b7e13 more uniform treatment of input/output wrt. client;
wenzelm
parents: 64673
diff changeset
   113
    : Option[(List[Text.Info[Command.Results]], Document_Model)] =
b2bf280b7e13 more uniform treatment of input/output wrt. client;
wenzelm
parents: 64673
diff changeset
   114
  {
b2bf280b7e13 more uniform treatment of input/output wrt. client;
wenzelm
parents: 64673
diff changeset
   115
    val diagnostics = rendering.diagnostics
b2bf280b7e13 more uniform treatment of input/output wrt. client;
wenzelm
parents: 64673
diff changeset
   116
    if (diagnostics == published_diagnostics) None
b2bf280b7e13 more uniform treatment of input/output wrt. client;
wenzelm
parents: 64673
diff changeset
   117
    else Some(diagnostics, copy(published_diagnostics = diagnostics))
b2bf280b7e13 more uniform treatment of input/output wrt. client;
wenzelm
parents: 64673
diff changeset
   118
  }
b2bf280b7e13 more uniform treatment of input/output wrt. client;
wenzelm
parents: 64673
diff changeset
   119
b2bf280b7e13 more uniform treatment of input/output wrt. client;
wenzelm
parents: 64673
diff changeset
   120
64725
wenzelm
parents: 64723
diff changeset
   121
  /* prover session */
64702
d95b9117cb5b re-use resources from session;
wenzelm
parents: 64690
diff changeset
   122
d95b9117cb5b re-use resources from session;
wenzelm
parents: 64690
diff changeset
   123
  def resources: VSCode_Resources = session.resources.asInstanceOf[VSCode_Resources]
64605
9c1173a7e4cb basic support for VSCode Language Server protocol;
wenzelm
parents:
diff changeset
   124
64816
wenzelm
parents: 64815
diff changeset
   125
  def is_stable: Boolean = pending_edits.isEmpty
wenzelm
parents: 64815
diff changeset
   126
  def snapshot(): Document.Snapshot = session.snapshot(node_name, pending_edits)
64622
529bbb8977c7 more uniform rendering for Isabelle/jEdit and Isabelle/VSCode;
wenzelm
parents: 64605
diff changeset
   127
64704
08c2d80428ff re-use options from resources;
wenzelm
parents: 64703
diff changeset
   128
  def rendering(): VSCode_Rendering = new VSCode_Rendering(this, snapshot(), resources)
64605
9c1173a7e4cb basic support for VSCode Language Server protocol;
wenzelm
parents:
diff changeset
   129
}