src/Tools/jEdit/src/isabelle_sidekick.scala
author wenzelm
Fri, 05 Aug 2016 16:30:53 +0200
changeset 63610 4b40b8196dc7
parent 63606 fc3a23763617
child 64813 7283f41d05ab
permissions -rw-r--r--
Sidekick parser for isabelle-ml and sml mode;
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
43282
5d294220ca43 moved sources -- eliminated Netbeans artifact of jedit package directory;
wenzelm
parents: 40792
diff changeset
     1
/*  Title:      Tools/jEdit/src/isabelle_sidekick.scala
36760
b82a698ef6c9 tuned headers;
wenzelm
parents: 36759
diff changeset
     2
    Author:     Fabian Immler, TU Munich
b82a698ef6c9 tuned headers;
wenzelm
parents: 36759
diff changeset
     3
    Author:     Makarius
b82a698ef6c9 tuned headers;
wenzelm
parents: 36759
diff changeset
     4
b82a698ef6c9 tuned headers;
wenzelm
parents: 36759
diff changeset
     5
SideKick parsers for Isabelle proof documents.
b82a698ef6c9 tuned headers;
wenzelm
parents: 36759
diff changeset
     6
*/
34393
f0e1608a774f basic tree structure for sidekick
immler@in.tum.de
parents:
diff changeset
     7
34426
81f93e0f13b4 renamed isabelle.prover.IsabelleSKParser to isabelle.jedit.IsabelleSideKickParser;
wenzelm
parents: 34417
diff changeset
     8
package isabelle.jedit
34393
f0e1608a774f basic tree structure for sidekick
immler@in.tum.de
parents:
diff changeset
     9
34760
dc7f5e0d9d27 misc modernization of names;
wenzelm
parents: 34759
diff changeset
    10
36015
6111de7c916a adapted to Scala 2.8.0 Beta 1;
wenzelm
parents: 35004
diff changeset
    11
import isabelle._
6111de7c916a adapted to Scala 2.8.0 Beta 1;
wenzelm
parents: 35004
diff changeset
    12
34393
f0e1608a774f basic tree structure for sidekick
immler@in.tum.de
parents:
diff changeset
    13
import javax.swing.tree.DefaultMutableTreeNode
34701
80b0add08eef IsabelleSideKickParser: incorporate former MarkupNode.markup2default_node, observe stopped flag;
wenzelm
parents: 34669
diff changeset
    14
import javax.swing.text.Position
59183
ec83638b6bfb imitate font more carefully: err on smaller size;
wenzelm
parents: 59091
diff changeset
    15
import javax.swing.{JLabel, Icon}
34417
bce2f2ea9819 misc tuning and adaption according to original IsabelleParser --
wenzelm
parents: 34408
diff changeset
    16
53274
1760c01f1c78 maintain Completion_Popup.Text_Area as client property like Document_View;
wenzelm
parents: 53233
diff changeset
    17
import org.gjt.sp.jedit.Buffer
1760c01f1c78 maintain Completion_Popup.Text_Area as client property like Document_View;
wenzelm
parents: 53233
diff changeset
    18
import sidekick.{SideKickParser, SideKickParsedData, IAsset}
34701
80b0add08eef IsabelleSideKickParser: incorporate former MarkupNode.markup2default_node, observe stopped flag;
wenzelm
parents: 34669
diff changeset
    19
34393
f0e1608a774f basic tree structure for sidekick
immler@in.tum.de
parents:
diff changeset
    20
36738
dce592144219 support several sidekick parsers -- very basic default parser;
wenzelm
parents: 36737
diff changeset
    21
object Isabelle_Sidekick
dce592144219 support several sidekick parsers -- very basic default parser;
wenzelm
parents: 36737
diff changeset
    22
{
40477
wenzelm
parents: 40475
diff changeset
    23
  def int_to_pos(offset: Text.Offset): Position =
57912
wenzelm
parents: 57904
diff changeset
    24
    new Position { def getOffset = offset; override def toString: String = offset.toString }
40452
45e7c2889d2f misc tuning and simplification, using Isabelle_Sidekick.Asset (not sidekick.Asset, which is dynamically dispatched to slightly different semantics);
wenzelm
parents: 39624
diff changeset
    25
58526
f05ccce3eca2 SideKick parser for bibtex entries;
wenzelm
parents: 57912
diff changeset
    26
  def root_data(buffer: Buffer): SideKickParsedData =
f05ccce3eca2 SideKick parser for bibtex entries;
wenzelm
parents: 57912
diff changeset
    27
  {
f05ccce3eca2 SideKick parser for bibtex entries;
wenzelm
parents: 57912
diff changeset
    28
    val data = new SideKickParsedData(buffer.getName)
f05ccce3eca2 SideKick parser for bibtex entries;
wenzelm
parents: 57912
diff changeset
    29
    data.getAsset(data.root).setEnd(int_to_pos(buffer.getLength))
f05ccce3eca2 SideKick parser for bibtex entries;
wenzelm
parents: 57912
diff changeset
    30
    data
f05ccce3eca2 SideKick parser for bibtex entries;
wenzelm
parents: 57912
diff changeset
    31
  }
f05ccce3eca2 SideKick parser for bibtex entries;
wenzelm
parents: 57912
diff changeset
    32
58747
c680f181b32e tuned rendering;
wenzelm
parents: 58743
diff changeset
    33
  class Keyword_Asset(keyword: String, text: String, range: Text.Range) extends IAsset
40452
45e7c2889d2f misc tuning and simplification, using Isabelle_Sidekick.Asset (not sidekick.Asset, which is dynamically dispatched to slightly different semantics);
wenzelm
parents: 39624
diff changeset
    34
  {
59286
ac74eedb910a GUI.imitate_font: more explicit result size, e.g. relevant for caching;
wenzelm
parents: 59183
diff changeset
    35
    private val css = GUI.imitate_font_css((new JLabel).getFont, Font_Info.main_family())
59183
ec83638b6bfb imitate font more carefully: err on smaller size;
wenzelm
parents: 59091
diff changeset
    36
58747
c680f181b32e tuned rendering;
wenzelm
parents: 58743
diff changeset
    37
    protected var _name = text
c680f181b32e tuned rendering;
wenzelm
parents: 58743
diff changeset
    38
    protected var _start = int_to_pos(range.start)
c680f181b32e tuned rendering;
wenzelm
parents: 58743
diff changeset
    39
    protected var _end = int_to_pos(range.stop)
40452
45e7c2889d2f misc tuning and simplification, using Isabelle_Sidekick.Asset (not sidekick.Asset, which is dynamically dispatched to slightly different semantics);
wenzelm
parents: 39624
diff changeset
    40
    override def getIcon: Icon = null
53973
78bbe75c8437 enforce IsabelleText font for better symbol coverage, especially on Windows;
wenzelm
parents: 53281
diff changeset
    41
    override def getShortString: String =
59933
07a7544c0535 allow prefix before keyword, notably 'private';
wenzelm
parents: 59286
diff changeset
    42
    {
07a7544c0535 allow prefix before keyword, notably 'private';
wenzelm
parents: 59286
diff changeset
    43
      val n = keyword.length
07a7544c0535 allow prefix before keyword, notably 'private';
wenzelm
parents: 59286
diff changeset
    44
      val s =
07a7544c0535 allow prefix before keyword, notably 'private';
wenzelm
parents: 59286
diff changeset
    45
        _name.indexOf(keyword) match {
07a7544c0535 allow prefix before keyword, notably 'private';
wenzelm
parents: 59286
diff changeset
    46
          case i if i >= 0 && n > 0 =>
62113
16de2a9b5b3d tuned -- according to ML version;
wenzelm
parents: 61871
diff changeset
    47
            HTML.output(_name.substring(0, i)) +
16de2a9b5b3d tuned -- according to ML version;
wenzelm
parents: 61871
diff changeset
    48
            "<b>" + HTML.output(keyword) + "</b>" +
16de2a9b5b3d tuned -- according to ML version;
wenzelm
parents: 61871
diff changeset
    49
            HTML.output(_name.substring(i + n))
16de2a9b5b3d tuned -- according to ML version;
wenzelm
parents: 61871
diff changeset
    50
          case _ => HTML.output(_name)
59933
07a7544c0535 allow prefix before keyword, notably 'private';
wenzelm
parents: 59286
diff changeset
    51
        }
07a7544c0535 allow prefix before keyword, notably 'private';
wenzelm
parents: 59286
diff changeset
    52
      "<html><span style=\"" + css + "\">" + s + "</span></html>"
07a7544c0535 allow prefix before keyword, notably 'private';
wenzelm
parents: 59286
diff changeset
    53
    }
40452
45e7c2889d2f misc tuning and simplification, using Isabelle_Sidekick.Asset (not sidekick.Asset, which is dynamically dispatched to slightly different semantics);
wenzelm
parents: 39624
diff changeset
    54
    override def getLongString: String = _name
45e7c2889d2f misc tuning and simplification, using Isabelle_Sidekick.Asset (not sidekick.Asset, which is dynamically dispatched to slightly different semantics);
wenzelm
parents: 39624
diff changeset
    55
    override def getName: String = _name
45e7c2889d2f misc tuning and simplification, using Isabelle_Sidekick.Asset (not sidekick.Asset, which is dynamically dispatched to slightly different semantics);
wenzelm
parents: 39624
diff changeset
    56
    override def setName(name: String) = _name = name
45e7c2889d2f misc tuning and simplification, using Isabelle_Sidekick.Asset (not sidekick.Asset, which is dynamically dispatched to slightly different semantics);
wenzelm
parents: 39624
diff changeset
    57
    override def getStart: Position = _start
45e7c2889d2f misc tuning and simplification, using Isabelle_Sidekick.Asset (not sidekick.Asset, which is dynamically dispatched to slightly different semantics);
wenzelm
parents: 39624
diff changeset
    58
    override def setStart(start: Position) = _start = start
45e7c2889d2f misc tuning and simplification, using Isabelle_Sidekick.Asset (not sidekick.Asset, which is dynamically dispatched to slightly different semantics);
wenzelm
parents: 39624
diff changeset
    59
    override def getEnd: Position = _end
45e7c2889d2f misc tuning and simplification, using Isabelle_Sidekick.Asset (not sidekick.Asset, which is dynamically dispatched to slightly different semantics);
wenzelm
parents: 39624
diff changeset
    60
    override def setEnd(end: Position) = _end = end
57912
wenzelm
parents: 57904
diff changeset
    61
    override def toString: String = _name
40452
45e7c2889d2f misc tuning and simplification, using Isabelle_Sidekick.Asset (not sidekick.Asset, which is dynamically dispatched to slightly different semantics);
wenzelm
parents: 39624
diff changeset
    62
  }
51618
a3577cd80c41 tuned signature -- avoid intrusion of slightly odd Swing structures into pure Markup_Tree;
wenzelm
parents: 51493
diff changeset
    63
58747
c680f181b32e tuned rendering;
wenzelm
parents: 58743
diff changeset
    64
  class Asset(name: String, range: Text.Range) extends Keyword_Asset("", name, range)
c680f181b32e tuned rendering;
wenzelm
parents: 58743
diff changeset
    65
51618
a3577cd80c41 tuned signature -- avoid intrusion of slightly odd Swing structures into pure Markup_Tree;
wenzelm
parents: 51493
diff changeset
    66
  def swing_markup_tree(tree: Markup_Tree, parent: DefaultMutableTreeNode,
a3577cd80c41 tuned signature -- avoid intrusion of slightly odd Swing structures into pure Markup_Tree;
wenzelm
parents: 51493
diff changeset
    67
    swing_node: Text.Info[List[XML.Elem]] => DefaultMutableTreeNode)
a3577cd80c41 tuned signature -- avoid intrusion of slightly odd Swing structures into pure Markup_Tree;
wenzelm
parents: 51493
diff changeset
    68
  {
a3577cd80c41 tuned signature -- avoid intrusion of slightly odd Swing structures into pure Markup_Tree;
wenzelm
parents: 51493
diff changeset
    69
    for ((_, entry) <- tree.branches) {
a3577cd80c41 tuned signature -- avoid intrusion of slightly odd Swing structures into pure Markup_Tree;
wenzelm
parents: 51493
diff changeset
    70
      val node = swing_node(Text.Info(entry.range, entry.markup))
a3577cd80c41 tuned signature -- avoid intrusion of slightly odd Swing structures into pure Markup_Tree;
wenzelm
parents: 51493
diff changeset
    71
      swing_markup_tree(entry.subtree, node, swing_node)
a3577cd80c41 tuned signature -- avoid intrusion of slightly odd Swing structures into pure Markup_Tree;
wenzelm
parents: 51493
diff changeset
    72
      parent.add(node)
a3577cd80c41 tuned signature -- avoid intrusion of slightly odd Swing structures into pure Markup_Tree;
wenzelm
parents: 51493
diff changeset
    73
    }
a3577cd80c41 tuned signature -- avoid intrusion of slightly odd Swing structures into pure Markup_Tree;
wenzelm
parents: 51493
diff changeset
    74
  }
36738
dce592144219 support several sidekick parsers -- very basic default parser;
wenzelm
parents: 36737
diff changeset
    75
}
dce592144219 support several sidekick parsers -- very basic default parser;
wenzelm
parents: 36737
diff changeset
    76
dce592144219 support several sidekick parsers -- very basic default parser;
wenzelm
parents: 36737
diff changeset
    77
53274
1760c01f1c78 maintain Completion_Popup.Text_Area as client property like Document_View;
wenzelm
parents: 53233
diff changeset
    78
class Isabelle_Sidekick(name: String) extends SideKickParser(name)
34625
799a40faa4f1 completion: decode symbols only if isabelle encoding is active (to prevent unicode chars written back to file);
wenzelm
parents: 34612
diff changeset
    79
{
53274
1760c01f1c78 maintain Completion_Popup.Text_Area as client property like Document_View;
wenzelm
parents: 53233
diff changeset
    80
  override def supportsCompletion = false
1760c01f1c78 maintain Completion_Popup.Text_Area as client property like Document_View;
wenzelm
parents: 53233
diff changeset
    81
1760c01f1c78 maintain Completion_Popup.Text_Area as client property like Document_View;
wenzelm
parents: 53233
diff changeset
    82
34417
bce2f2ea9819 misc tuning and adaption according to original IsabelleParser --
wenzelm
parents: 34408
diff changeset
    83
  /* parsing */
bce2f2ea9819 misc tuning and adaption according to original IsabelleParser --
wenzelm
parents: 34408
diff changeset
    84
36759
wenzelm
parents: 36738
diff changeset
    85
  @volatile protected var stopped = false
34503
7d0726f19d04 tuned whitespace;
wenzelm
parents: 34485
diff changeset
    86
  override def stop() = { stopped = true }
34401
44241a37b74a structure of markup-tree in scala, keep track of swing-nodes in background
immler@in.tum.de
parents: 34393
diff changeset
    87
48717
622251b2b0f1 clarified Sidekick configuration, including minor modes;
wenzelm
parents: 47749
diff changeset
    88
  def parser(buffer: Buffer, syntax: Outer_Syntax, data: SideKickParsedData): Boolean = false
36759
wenzelm
parents: 36738
diff changeset
    89
53274
1760c01f1c78 maintain Completion_Popup.Text_Area as client property like Document_View;
wenzelm
parents: 53233
diff changeset
    90
  def parse(buffer: Buffer, error_source: errorlist.DefaultErrorSource): SideKickParsedData =
34625
799a40faa4f1 completion: decode symbols only if isabelle encoding is active (to prevent unicode chars written back to file);
wenzelm
parents: 34612
diff changeset
    91
  {
34417
bce2f2ea9819 misc tuning and adaption according to original IsabelleParser --
wenzelm
parents: 34408
diff changeset
    92
    stopped = false
34625
799a40faa4f1 completion: decode symbols only if isabelle encoding is active (to prevent unicode chars written back to file);
wenzelm
parents: 34612
diff changeset
    93
38640
105d1f112da5 sporadic locking of jEdit buffer;
wenzelm
parents: 38577
diff changeset
    94
    // FIXME lock buffer (!??)
58526
f05ccce3eca2 SideKick parser for bibtex entries;
wenzelm
parents: 57912
diff changeset
    95
    val data = Isabelle_Sidekick.root_data(buffer)
60272
4f72b00d9952 no GUI_Thread for SideKick parsers (in contrast to 4c8205fe3644), to avoid danger of deadlock due to nested context switch;
wenzelm
parents: 59933
diff changeset
    96
    val syntax = Isabelle.buffer_syntax(buffer)
48717
622251b2b0f1 clarified Sidekick configuration, including minor modes;
wenzelm
parents: 47749
diff changeset
    97
    val ok =
622251b2b0f1 clarified Sidekick configuration, including minor modes;
wenzelm
parents: 47749
diff changeset
    98
      if (syntax.isDefined) {
622251b2b0f1 clarified Sidekick configuration, including minor modes;
wenzelm
parents: 47749
diff changeset
    99
        val ok = parser(buffer, syntax.get, data)
58526
f05ccce3eca2 SideKick parser for bibtex entries;
wenzelm
parents: 57912
diff changeset
   100
        if (stopped) { data.root.add(new DefaultMutableTreeNode("<stopped>")); true }
48717
622251b2b0f1 clarified Sidekick configuration, including minor modes;
wenzelm
parents: 47749
diff changeset
   101
        else ok
622251b2b0f1 clarified Sidekick configuration, including minor modes;
wenzelm
parents: 47749
diff changeset
   102
      }
622251b2b0f1 clarified Sidekick configuration, including minor modes;
wenzelm
parents: 47749
diff changeset
   103
      else false
58526
f05ccce3eca2 SideKick parser for bibtex entries;
wenzelm
parents: 57912
diff changeset
   104
    if (!ok) data.root.add(new DefaultMutableTreeNode("<ignored>"))
48717
622251b2b0f1 clarified Sidekick configuration, including minor modes;
wenzelm
parents: 47749
diff changeset
   105
34417
bce2f2ea9819 misc tuning and adaption according to original IsabelleParser --
wenzelm
parents: 34408
diff changeset
   106
    data
bce2f2ea9819 misc tuning and adaption according to original IsabelleParser --
wenzelm
parents: 34408
diff changeset
   107
  }
34393
f0e1608a774f basic tree structure for sidekick
immler@in.tum.de
parents:
diff changeset
   108
}
36738
dce592144219 support several sidekick parsers -- very basic default parser;
wenzelm
parents: 36737
diff changeset
   109
dce592144219 support several sidekick parsers -- very basic default parser;
wenzelm
parents: 36737
diff changeset
   110
48718
73e6c22e2d94 more structural parsing for minor modes;
wenzelm
parents: 48717
diff changeset
   111
class Isabelle_Sidekick_Structure(
73e6c22e2d94 more structural parsing for minor modes;
wenzelm
parents: 48717
diff changeset
   112
    name: String,
63606
fc3a23763617 support for context block structure in Sidekick;
wenzelm
parents: 63605
diff changeset
   113
    node_name: Buffer => Option[Document.Node.Name],
fc3a23763617 support for context block structure in Sidekick;
wenzelm
parents: 63605
diff changeset
   114
    parse: (Outer_Syntax, Document.Node.Name, CharSequence) => List[Document_Structure.Document])
53274
1760c01f1c78 maintain Completion_Popup.Text_Area as client property like Document_View;
wenzelm
parents: 53233
diff changeset
   115
  extends Isabelle_Sidekick(name)
36759
wenzelm
parents: 36738
diff changeset
   116
{
48717
622251b2b0f1 clarified Sidekick configuration, including minor modes;
wenzelm
parents: 47749
diff changeset
   117
  override def parser(buffer: Buffer, syntax: Outer_Syntax, data: SideKickParsedData): Boolean =
36759
wenzelm
parents: 36738
diff changeset
   118
  {
58743
c07a59140fee clarified tree root;
wenzelm
parents: 58707
diff changeset
   119
    def make_tree(
c07a59140fee clarified tree root;
wenzelm
parents: 58707
diff changeset
   120
      parent: DefaultMutableTreeNode,
c07a59140fee clarified tree root;
wenzelm
parents: 58707
diff changeset
   121
      offset: Text.Offset,
63604
d8de4f8b95eb clarified modules;
wenzelm
parents: 62113
diff changeset
   122
      documents: List[Document_Structure.Document])
58743
c07a59140fee clarified tree root;
wenzelm
parents: 58707
diff changeset
   123
    {
c07a59140fee clarified tree root;
wenzelm
parents: 58707
diff changeset
   124
      (offset /: documents) { case (i, document) =>
c07a59140fee clarified tree root;
wenzelm
parents: 58707
diff changeset
   125
        document match {
63604
d8de4f8b95eb clarified modules;
wenzelm
parents: 62113
diff changeset
   126
          case Document_Structure.Block(name, text, body) =>
58747
c680f181b32e tuned rendering;
wenzelm
parents: 58743
diff changeset
   127
            val range = Text.Range(i, i + document.length)
58743
c07a59140fee clarified tree root;
wenzelm
parents: 58707
diff changeset
   128
            val node =
c07a59140fee clarified tree root;
wenzelm
parents: 58707
diff changeset
   129
              new DefaultMutableTreeNode(
58747
c680f181b32e tuned rendering;
wenzelm
parents: 58743
diff changeset
   130
                new Isabelle_Sidekick.Keyword_Asset(name, Library.first_line(text), range))
58743
c07a59140fee clarified tree root;
wenzelm
parents: 58707
diff changeset
   131
            parent.add(node)
c07a59140fee clarified tree root;
wenzelm
parents: 58707
diff changeset
   132
            make_tree(node, i, body)
c07a59140fee clarified tree root;
wenzelm
parents: 58707
diff changeset
   133
          case _ =>
c07a59140fee clarified tree root;
wenzelm
parents: 58707
diff changeset
   134
        }
c07a59140fee clarified tree root;
wenzelm
parents: 58707
diff changeset
   135
        i + document.length
40455
e035dad8eca2 default Sidekick parser based on section headings;
wenzelm
parents: 40452
diff changeset
   136
      }
58743
c07a59140fee clarified tree root;
wenzelm
parents: 58707
diff changeset
   137
    }
40455
e035dad8eca2 default Sidekick parser based on section headings;
wenzelm
parents: 40452
diff changeset
   138
48718
73e6c22e2d94 more structural parsing for minor modes;
wenzelm
parents: 48717
diff changeset
   139
    node_name(buffer) match {
73e6c22e2d94 more structural parsing for minor modes;
wenzelm
parents: 48717
diff changeset
   140
      case Some(name) =>
63606
fc3a23763617 support for context block structure in Sidekick;
wenzelm
parents: 63605
diff changeset
   141
        make_tree(data.root, 0, parse(syntax, name, JEdit_Lib.buffer_text(buffer)))
48717
622251b2b0f1 clarified Sidekick configuration, including minor modes;
wenzelm
parents: 47749
diff changeset
   142
        true
63606
fc3a23763617 support for context block structure in Sidekick;
wenzelm
parents: 63605
diff changeset
   143
      case None =>
fc3a23763617 support for context block structure in Sidekick;
wenzelm
parents: 63605
diff changeset
   144
        false
48717
622251b2b0f1 clarified Sidekick configuration, including minor modes;
wenzelm
parents: 47749
diff changeset
   145
    }
36759
wenzelm
parents: 36738
diff changeset
   146
  }
wenzelm
parents: 36738
diff changeset
   147
}
36738
dce592144219 support several sidekick parsers -- very basic default parser;
wenzelm
parents: 36737
diff changeset
   148
53274
1760c01f1c78 maintain Completion_Popup.Text_Area as client property like Document_View;
wenzelm
parents: 53233
diff changeset
   149
class Isabelle_Sidekick_Default extends
63606
fc3a23763617 support for context block structure in Sidekick;
wenzelm
parents: 63605
diff changeset
   150
  Isabelle_Sidekick_Structure("isabelle",
fc3a23763617 support for context block structure in Sidekick;
wenzelm
parents: 63605
diff changeset
   151
    PIDE.resources.theory_node_name, Document_Structure.parse_sections _)
fc3a23763617 support for context block structure in Sidekick;
wenzelm
parents: 63605
diff changeset
   152
fc3a23763617 support for context block structure in Sidekick;
wenzelm
parents: 63605
diff changeset
   153
class Isabelle_Sidekick_Context extends
fc3a23763617 support for context block structure in Sidekick;
wenzelm
parents: 63605
diff changeset
   154
  Isabelle_Sidekick_Structure("isabelle-context",
fc3a23763617 support for context block structure in Sidekick;
wenzelm
parents: 63605
diff changeset
   155
    PIDE.resources.theory_node_name, Document_Structure.parse_blocks _)
48717
622251b2b0f1 clarified Sidekick configuration, including minor modes;
wenzelm
parents: 47749
diff changeset
   156
53274
1760c01f1c78 maintain Completion_Popup.Text_Area as client property like Document_View;
wenzelm
parents: 53233
diff changeset
   157
class Isabelle_Sidekick_Options extends
63606
fc3a23763617 support for context block structure in Sidekick;
wenzelm
parents: 63605
diff changeset
   158
  Isabelle_Sidekick_Structure("isabelle-options",
fc3a23763617 support for context block structure in Sidekick;
wenzelm
parents: 63605
diff changeset
   159
    _ => Some(Document.Node.Name("options")), Document_Structure.parse_sections _)
48718
73e6c22e2d94 more structural parsing for minor modes;
wenzelm
parents: 48717
diff changeset
   160
53274
1760c01f1c78 maintain Completion_Popup.Text_Area as client property like Document_View;
wenzelm
parents: 53233
diff changeset
   161
class Isabelle_Sidekick_Root extends
63606
fc3a23763617 support for context block structure in Sidekick;
wenzelm
parents: 63605
diff changeset
   162
  Isabelle_Sidekick_Structure("isabelle-root",
fc3a23763617 support for context block structure in Sidekick;
wenzelm
parents: 63605
diff changeset
   163
    _ => Some(Document.Node.Name("ROOT")), Document_Structure.parse_sections _)
48717
622251b2b0f1 clarified Sidekick configuration, including minor modes;
wenzelm
parents: 47749
diff changeset
   164
63610
4b40b8196dc7 Sidekick parser for isabelle-ml and sml mode;
wenzelm
parents: 63606
diff changeset
   165
class Isabelle_Sidekick_ML extends
4b40b8196dc7 Sidekick parser for isabelle-ml and sml mode;
wenzelm
parents: 63606
diff changeset
   166
  Isabelle_Sidekick_Structure("isabelle-ml",
4b40b8196dc7 Sidekick parser for isabelle-ml and sml mode;
wenzelm
parents: 63606
diff changeset
   167
    buffer => Some(PIDE.resources.node_name(buffer)),
4b40b8196dc7 Sidekick parser for isabelle-ml and sml mode;
wenzelm
parents: 63606
diff changeset
   168
    (_, _, text) => Document_Structure.parse_ml_sections(false, text))
4b40b8196dc7 Sidekick parser for isabelle-ml and sml mode;
wenzelm
parents: 63606
diff changeset
   169
4b40b8196dc7 Sidekick parser for isabelle-ml and sml mode;
wenzelm
parents: 63606
diff changeset
   170
class Isabelle_Sidekick_SML extends
4b40b8196dc7 Sidekick parser for isabelle-ml and sml mode;
wenzelm
parents: 63606
diff changeset
   171
  Isabelle_Sidekick_Structure("isabelle-sml",
4b40b8196dc7 Sidekick parser for isabelle-ml and sml mode;
wenzelm
parents: 63606
diff changeset
   172
    buffer => Some(PIDE.resources.node_name(buffer)),
4b40b8196dc7 Sidekick parser for isabelle-ml and sml mode;
wenzelm
parents: 63606
diff changeset
   173
    (_, _, text) => Document_Structure.parse_ml_sections(true, text))
4b40b8196dc7 Sidekick parser for isabelle-ml and sml mode;
wenzelm
parents: 63606
diff changeset
   174
48717
622251b2b0f1 clarified Sidekick configuration, including minor modes;
wenzelm
parents: 47749
diff changeset
   175
53281
251e1a2aa792 clarified SideKick parser name, which serves as quasi "mode" here;
wenzelm
parents: 53274
diff changeset
   176
class Isabelle_Sidekick_Markup extends Isabelle_Sidekick("isabelle-markup")
36759
wenzelm
parents: 36738
diff changeset
   177
{
48717
622251b2b0f1 clarified Sidekick configuration, including minor modes;
wenzelm
parents: 47749
diff changeset
   178
  override def parser(buffer: Buffer, syntax: Outer_Syntax, data: SideKickParsedData): Boolean =
36759
wenzelm
parents: 36738
diff changeset
   179
  {
55513
6d21415e3909 recovered Isabelle_Sidekick_Markup from 9c53198dbb1c: snapshot requires Swing_Thread;
wenzelm
parents: 55432
diff changeset
   180
    val opt_snapshot =
60272
4f72b00d9952 no GUI_Thread for SideKick parsers (in contrast to 4c8205fe3644), to avoid danger of deadlock due to nested context switch;
wenzelm
parents: 59933
diff changeset
   181
      PIDE.document_model(buffer) match {
4f72b00d9952 no GUI_Thread for SideKick parsers (in contrast to 4c8205fe3644), to avoid danger of deadlock due to nested context switch;
wenzelm
parents: 59933
diff changeset
   182
        case Some(model) if model.is_theory => Some(model.snapshot)
4f72b00d9952 no GUI_Thread for SideKick parsers (in contrast to 4c8205fe3644), to avoid danger of deadlock due to nested context switch;
wenzelm
parents: 59933
diff changeset
   183
        case _ => None
55513
6d21415e3909 recovered Isabelle_Sidekick_Markup from 9c53198dbb1c: snapshot requires Swing_Thread;
wenzelm
parents: 55432
diff changeset
   184
      }
6d21415e3909 recovered Isabelle_Sidekick_Markup from 9c53198dbb1c: snapshot requires Swing_Thread;
wenzelm
parents: 55432
diff changeset
   185
    opt_snapshot match {
6d21415e3909 recovered Isabelle_Sidekick_Markup from 9c53198dbb1c: snapshot requires Swing_Thread;
wenzelm
parents: 55432
diff changeset
   186
      case Some(snapshot) =>
56373
0605d90be6fc tuned signature -- more explicit iterator terminology;
wenzelm
parents: 56301
diff changeset
   187
        for ((command, command_start) <- snapshot.node.command_iterator() if !stopped) {
55650
349afd0fa0c4 tuned signature;
wenzelm
parents: 55513
diff changeset
   188
          val markup =
56301
1da7b4c33db9 more frugal merge of markup trees: filter wrt. subsequent query;
wenzelm
parents: 56299
diff changeset
   189
            snapshot.state.command_markup(
1da7b4c33db9 more frugal merge of markup trees: filter wrt. subsequent query;
wenzelm
parents: 56299
diff changeset
   190
              snapshot.version, command, Command.Markup_Index.markup,
56743
81370dfadb1d tuned signature;
wenzelm
parents: 56609
diff changeset
   191
                command.range, Markup.Elements.full)
58526
f05ccce3eca2 SideKick parser for bibtex entries;
wenzelm
parents: 57912
diff changeset
   192
          Isabelle_Sidekick.swing_markup_tree(markup, data.root,
f05ccce3eca2 SideKick parser for bibtex entries;
wenzelm
parents: 57912
diff changeset
   193
            (info: Text.Info[List[XML.Elem]]) =>
48717
622251b2b0f1 clarified Sidekick configuration, including minor modes;
wenzelm
parents: 47749
diff changeset
   194
              {
622251b2b0f1 clarified Sidekick configuration, including minor modes;
wenzelm
parents: 47749
diff changeset
   195
                val range = info.range + command_start
622251b2b0f1 clarified Sidekick configuration, including minor modes;
wenzelm
parents: 47749
diff changeset
   196
                val content = command.source(info.range).replace('\n', ' ')
622251b2b0f1 clarified Sidekick configuration, including minor modes;
wenzelm
parents: 47749
diff changeset
   197
                val info_text =
61871
2cb4a2970941 more explicit Pretty.Tree, like in ML;
wenzelm
parents: 60272
diff changeset
   198
                  Pretty.formatted(Library.separate(Pretty.fbrk, info.info), margin = 40.0)
51493
59d8a1031c00 allow fractional pretty margin -- avoid premature rounding;
wenzelm
parents: 50725
diff changeset
   199
                    .mkString
36738
dce592144219 support several sidekick parsers -- very basic default parser;
wenzelm
parents: 36737
diff changeset
   200
48717
622251b2b0f1 clarified Sidekick configuration, including minor modes;
wenzelm
parents: 47749
diff changeset
   201
                new DefaultMutableTreeNode(
58747
c680f181b32e tuned rendering;
wenzelm
parents: 58743
diff changeset
   202
                  new Isabelle_Sidekick.Asset(command.toString, range) {
48717
622251b2b0f1 clarified Sidekick configuration, including minor modes;
wenzelm
parents: 47749
diff changeset
   203
                    override def getShortString: String = content
622251b2b0f1 clarified Sidekick configuration, including minor modes;
wenzelm
parents: 47749
diff changeset
   204
                    override def getLongString: String = info_text
57912
wenzelm
parents: 57904
diff changeset
   205
                    override def toString: String = quote(content) + " " + range.toString
48717
622251b2b0f1 clarified Sidekick configuration, including minor modes;
wenzelm
parents: 47749
diff changeset
   206
                  })
40452
45e7c2889d2f misc tuning and simplification, using Isabelle_Sidekick.Asset (not sidekick.Asset, which is dynamically dispatched to slightly different semantics);
wenzelm
parents: 39624
diff changeset
   207
              })
48717
622251b2b0f1 clarified Sidekick configuration, including minor modes;
wenzelm
parents: 47749
diff changeset
   208
        }
622251b2b0f1 clarified Sidekick configuration, including minor modes;
wenzelm
parents: 47749
diff changeset
   209
        true
55513
6d21415e3909 recovered Isabelle_Sidekick_Markup from 9c53198dbb1c: snapshot requires Swing_Thread;
wenzelm
parents: 55432
diff changeset
   210
      case None => false
36759
wenzelm
parents: 36738
diff changeset
   211
    }
wenzelm
parents: 36738
diff changeset
   212
  }
wenzelm
parents: 36738
diff changeset
   213
}
36738
dce592144219 support several sidekick parsers -- very basic default parser;
wenzelm
parents: 36737
diff changeset
   214
52539
7658f8d7b2dc minimal jedit mode for Isabelle NEWS;
wenzelm
parents: 51618
diff changeset
   215
53274
1760c01f1c78 maintain Completion_Popup.Text_Area as client property like Document_View;
wenzelm
parents: 53233
diff changeset
   216
class Isabelle_Sidekick_News extends Isabelle_Sidekick("isabelle-news")
52539
7658f8d7b2dc minimal jedit mode for Isabelle NEWS;
wenzelm
parents: 51618
diff changeset
   217
{
53274
1760c01f1c78 maintain Completion_Popup.Text_Area as client property like Document_View;
wenzelm
parents: 53233
diff changeset
   218
  private val Heading1 = """^New in (.*)\w*$""".r
1760c01f1c78 maintain Completion_Popup.Text_Area as client property like Document_View;
wenzelm
parents: 53233
diff changeset
   219
  private val Heading2 = """^\*\*\*\w*(.*)\w*\*\*\*\w*$""".r
52539
7658f8d7b2dc minimal jedit mode for Isabelle NEWS;
wenzelm
parents: 51618
diff changeset
   220
7658f8d7b2dc minimal jedit mode for Isabelle NEWS;
wenzelm
parents: 51618
diff changeset
   221
  private def make_node(s: String, start: Text.Offset, stop: Text.Offset): DefaultMutableTreeNode =
58747
c680f181b32e tuned rendering;
wenzelm
parents: 58743
diff changeset
   222
    new DefaultMutableTreeNode(new Isabelle_Sidekick.Asset(s, Text.Range(start, stop)))
52539
7658f8d7b2dc minimal jedit mode for Isabelle NEWS;
wenzelm
parents: 51618
diff changeset
   223
7658f8d7b2dc minimal jedit mode for Isabelle NEWS;
wenzelm
parents: 51618
diff changeset
   224
  override def parser(buffer: Buffer, syntax: Outer_Syntax, data: SideKickParsedData): Boolean =
7658f8d7b2dc minimal jedit mode for Isabelle NEWS;
wenzelm
parents: 51618
diff changeset
   225
  {
7658f8d7b2dc minimal jedit mode for Isabelle NEWS;
wenzelm
parents: 51618
diff changeset
   226
    var offset = 0
58542
19e062fbfea0 more advanced NEWS tree structure and folding;
wenzelm
parents: 58539
diff changeset
   227
    var end_offset = 0
19e062fbfea0 more advanced NEWS tree structure and folding;
wenzelm
parents: 58539
diff changeset
   228
19e062fbfea0 more advanced NEWS tree structure and folding;
wenzelm
parents: 58539
diff changeset
   229
    var start1: Option[(Int, String, Vector[DefaultMutableTreeNode])] = None
19e062fbfea0 more advanced NEWS tree structure and folding;
wenzelm
parents: 58539
diff changeset
   230
    var start2: Option[(Int, String)] = None
19e062fbfea0 more advanced NEWS tree structure and folding;
wenzelm
parents: 58539
diff changeset
   231
19e062fbfea0 more advanced NEWS tree structure and folding;
wenzelm
parents: 58539
diff changeset
   232
    def close1: Unit =
19e062fbfea0 more advanced NEWS tree structure and folding;
wenzelm
parents: 58539
diff changeset
   233
      start1 match {
19e062fbfea0 more advanced NEWS tree structure and folding;
wenzelm
parents: 58539
diff changeset
   234
        case Some((start_offset, s, body)) =>
19e062fbfea0 more advanced NEWS tree structure and folding;
wenzelm
parents: 58539
diff changeset
   235
          val node = make_node(s, start_offset, end_offset)
19e062fbfea0 more advanced NEWS tree structure and folding;
wenzelm
parents: 58539
diff changeset
   236
          body.foreach(node.add(_))
19e062fbfea0 more advanced NEWS tree structure and folding;
wenzelm
parents: 58539
diff changeset
   237
          data.root.add(node)
19e062fbfea0 more advanced NEWS tree structure and folding;
wenzelm
parents: 58539
diff changeset
   238
          start1 = None
19e062fbfea0 more advanced NEWS tree structure and folding;
wenzelm
parents: 58539
diff changeset
   239
        case None =>
19e062fbfea0 more advanced NEWS tree structure and folding;
wenzelm
parents: 58539
diff changeset
   240
      }
19e062fbfea0 more advanced NEWS tree structure and folding;
wenzelm
parents: 58539
diff changeset
   241
19e062fbfea0 more advanced NEWS tree structure and folding;
wenzelm
parents: 58539
diff changeset
   242
    def close2: Unit =
19e062fbfea0 more advanced NEWS tree structure and folding;
wenzelm
parents: 58539
diff changeset
   243
      start2 match {
19e062fbfea0 more advanced NEWS tree structure and folding;
wenzelm
parents: 58539
diff changeset
   244
        case Some((start_offset, s)) =>
19e062fbfea0 more advanced NEWS tree structure and folding;
wenzelm
parents: 58539
diff changeset
   245
          start1 match {
19e062fbfea0 more advanced NEWS tree structure and folding;
wenzelm
parents: 58539
diff changeset
   246
            case Some((start_offset1, s1, body)) =>
19e062fbfea0 more advanced NEWS tree structure and folding;
wenzelm
parents: 58539
diff changeset
   247
              val node = make_node(s, start_offset, end_offset)
19e062fbfea0 more advanced NEWS tree structure and folding;
wenzelm
parents: 58539
diff changeset
   248
              start1 = Some((start_offset1, s1, body :+ node))
19e062fbfea0 more advanced NEWS tree structure and folding;
wenzelm
parents: 58539
diff changeset
   249
            case None =>
19e062fbfea0 more advanced NEWS tree structure and folding;
wenzelm
parents: 58539
diff changeset
   250
          }
19e062fbfea0 more advanced NEWS tree structure and folding;
wenzelm
parents: 58539
diff changeset
   251
          start2 = None
19e062fbfea0 more advanced NEWS tree structure and folding;
wenzelm
parents: 58539
diff changeset
   252
        case None =>
19e062fbfea0 more advanced NEWS tree structure and folding;
wenzelm
parents: 58539
diff changeset
   253
      }
52539
7658f8d7b2dc minimal jedit mode for Isabelle NEWS;
wenzelm
parents: 51618
diff changeset
   254
7658f8d7b2dc minimal jedit mode for Isabelle NEWS;
wenzelm
parents: 51618
diff changeset
   255
    for (line <- split_lines(JEdit_Lib.buffer_text(buffer)) if !stopped) {
7658f8d7b2dc minimal jedit mode for Isabelle NEWS;
wenzelm
parents: 51618
diff changeset
   256
      line match {
58542
19e062fbfea0 more advanced NEWS tree structure and folding;
wenzelm
parents: 58539
diff changeset
   257
        case Heading1(s) => close2; close1; start1 = Some((offset, s, Vector()))
19e062fbfea0 more advanced NEWS tree structure and folding;
wenzelm
parents: 58539
diff changeset
   258
        case Heading2(s) => close2; start2 = Some((offset, s))
52539
7658f8d7b2dc minimal jedit mode for Isabelle NEWS;
wenzelm
parents: 51618
diff changeset
   259
        case _ =>
7658f8d7b2dc minimal jedit mode for Isabelle NEWS;
wenzelm
parents: 51618
diff changeset
   260
      }
7658f8d7b2dc minimal jedit mode for Isabelle NEWS;
wenzelm
parents: 51618
diff changeset
   261
      offset += line.length + 1
58542
19e062fbfea0 more advanced NEWS tree structure and folding;
wenzelm
parents: 58539
diff changeset
   262
      if (!line.forall(Character.isSpaceChar(_))) end_offset = offset
52539
7658f8d7b2dc minimal jedit mode for Isabelle NEWS;
wenzelm
parents: 51618
diff changeset
   263
    }
58542
19e062fbfea0 more advanced NEWS tree structure and folding;
wenzelm
parents: 58539
diff changeset
   264
    if (!stopped) { close2; close1 }
52539
7658f8d7b2dc minimal jedit mode for Isabelle NEWS;
wenzelm
parents: 51618
diff changeset
   265
7658f8d7b2dc minimal jedit mode for Isabelle NEWS;
wenzelm
parents: 51618
diff changeset
   266
    true
7658f8d7b2dc minimal jedit mode for Isabelle NEWS;
wenzelm
parents: 51618
diff changeset
   267
  }
7658f8d7b2dc minimal jedit mode for Isabelle NEWS;
wenzelm
parents: 51618
diff changeset
   268
}
7658f8d7b2dc minimal jedit mode for Isabelle NEWS;
wenzelm
parents: 51618
diff changeset
   269