src/Tools/jEdit/src/documentation_dockable.scala
author wenzelm
Sat, 05 Apr 2014 18:14:54 +0200
changeset 56422 7490555d7dff
parent 55877 65c9968286d5
child 56423 c2f52824dbb2
permissions -rw-r--r--
clarified Doc entry: more explicit path; allow plain files as Doc; refer to official jEdit documentation;
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
52445
18a720984855 dockable window for Isabelle documentation;
wenzelm
parents:
diff changeset
     1
/*  Title:      Tools/jEdit/src/documentation_dockable.scala
18a720984855 dockable window for Isabelle documentation;
wenzelm
parents:
diff changeset
     2
    Author:     Makarius
18a720984855 dockable window for Isabelle documentation;
wenzelm
parents:
diff changeset
     3
18a720984855 dockable window for Isabelle documentation;
wenzelm
parents:
diff changeset
     4
Dockable window for Isabelle documentation.
18a720984855 dockable window for Isabelle documentation;
wenzelm
parents:
diff changeset
     5
*/
18a720984855 dockable window for Isabelle documentation;
wenzelm
parents:
diff changeset
     6
18a720984855 dockable window for Isabelle documentation;
wenzelm
parents:
diff changeset
     7
package isabelle.jedit
18a720984855 dockable window for Isabelle documentation;
wenzelm
parents:
diff changeset
     8
18a720984855 dockable window for Isabelle documentation;
wenzelm
parents:
diff changeset
     9
18a720984855 dockable window for Isabelle documentation;
wenzelm
parents:
diff changeset
    10
import isabelle._
18a720984855 dockable window for Isabelle documentation;
wenzelm
parents:
diff changeset
    11
18a720984855 dockable window for Isabelle documentation;
wenzelm
parents:
diff changeset
    12
import java.awt.{Dimension, GridLayout}
54686
070d5e856798 directly react on click, assuming that document view operation is mostly idempotent;
wenzelm
parents: 53177
diff changeset
    13
import java.awt.event.{MouseEvent, MouseAdapter}
54687
795f8d3e06c9 no keyboard control -- avoid confusion about meaning of selection;
wenzelm
parents: 54686
diff changeset
    14
import javax.swing.{JTree, JScrollPane, JComponent}
52445
18a720984855 dockable window for Isabelle documentation;
wenzelm
parents:
diff changeset
    15
import javax.swing.tree.{DefaultMutableTreeNode, TreeSelectionModel}
18a720984855 dockable window for Isabelle documentation;
wenzelm
parents:
diff changeset
    16
import javax.swing.event.{TreeSelectionEvent, TreeSelectionListener}
18a720984855 dockable window for Isabelle documentation;
wenzelm
parents:
diff changeset
    17
18a720984855 dockable window for Isabelle documentation;
wenzelm
parents:
diff changeset
    18
import org.gjt.sp.jedit.{View, OperatingSystem}
18a720984855 dockable window for Isabelle documentation;
wenzelm
parents:
diff changeset
    19
18a720984855 dockable window for Isabelle documentation;
wenzelm
parents:
diff changeset
    20
18a720984855 dockable window for Isabelle documentation;
wenzelm
parents:
diff changeset
    21
class Documentation_Dockable(view: View, position: String) extends Dockable(view, position)
18a720984855 dockable window for Isabelle documentation;
wenzelm
parents:
diff changeset
    22
{
18a720984855 dockable window for Isabelle documentation;
wenzelm
parents:
diff changeset
    23
  private val docs = Doc.contents()
18a720984855 dockable window for Isabelle documentation;
wenzelm
parents:
diff changeset
    24
56422
7490555d7dff clarified Doc entry: more explicit path;
wenzelm
parents: 55877
diff changeset
    25
  private case class Documentation(name: String, title: String, path: Path)
52445
18a720984855 dockable window for Isabelle documentation;
wenzelm
parents:
diff changeset
    26
  {
18a720984855 dockable window for Isabelle documentation;
wenzelm
parents:
diff changeset
    27
    override def toString =
18a720984855 dockable window for Isabelle documentation;
wenzelm
parents:
diff changeset
    28
      "<html><b>" + HTML.encode(name) + "</b>:  " + HTML.encode(title) + "</html>"
18a720984855 dockable window for Isabelle documentation;
wenzelm
parents:
diff changeset
    29
  }
18a720984855 dockable window for Isabelle documentation;
wenzelm
parents:
diff changeset
    30
52542
19d674acb764 more release notes according to availability in proper release vs. repository clone;
wenzelm
parents: 52541
diff changeset
    31
  private case class Text_File(name: String, path: Path)
52541
97c950217d7f quick access to release notes (imitating website/documentation.html);
wenzelm
parents: 52447
diff changeset
    32
  {
52542
19d674acb764 more release notes according to availability in proper release vs. repository clone;
wenzelm
parents: 52541
diff changeset
    33
    override def toString = name
52541
97c950217d7f quick access to release notes (imitating website/documentation.html);
wenzelm
parents: 52447
diff changeset
    34
  }
97c950217d7f quick access to release notes (imitating website/documentation.html);
wenzelm
parents: 52447
diff changeset
    35
52445
18a720984855 dockable window for Isabelle documentation;
wenzelm
parents:
diff changeset
    36
  private val root = new DefaultMutableTreeNode
18a720984855 dockable window for Isabelle documentation;
wenzelm
parents:
diff changeset
    37
  docs foreach {
18a720984855 dockable window for Isabelle documentation;
wenzelm
parents:
diff changeset
    38
    case Doc.Section(text) =>
18a720984855 dockable window for Isabelle documentation;
wenzelm
parents:
diff changeset
    39
      root.add(new DefaultMutableTreeNode(text))
56422
7490555d7dff clarified Doc entry: more explicit path;
wenzelm
parents: 55877
diff changeset
    40
    case Doc.Doc(name, title, path) =>
52445
18a720984855 dockable window for Isabelle documentation;
wenzelm
parents:
diff changeset
    41
      root.getLastChild.asInstanceOf[DefaultMutableTreeNode]
56422
7490555d7dff clarified Doc entry: more explicit path;
wenzelm
parents: 55877
diff changeset
    42
        .add(new DefaultMutableTreeNode(Documentation(name, title, path)))
52542
19d674acb764 more release notes according to availability in proper release vs. repository clone;
wenzelm
parents: 52541
diff changeset
    43
    case Doc.Text_File(name: String, path: Path) =>
52541
97c950217d7f quick access to release notes (imitating website/documentation.html);
wenzelm
parents: 52447
diff changeset
    44
      root.getLastChild.asInstanceOf[DefaultMutableTreeNode]
52542
19d674acb764 more release notes according to availability in proper release vs. repository clone;
wenzelm
parents: 52541
diff changeset
    45
        .add(new DefaultMutableTreeNode(Text_File(name, path.expand)))
52541
97c950217d7f quick access to release notes (imitating website/documentation.html);
wenzelm
parents: 52447
diff changeset
    46
  }
97c950217d7f quick access to release notes (imitating website/documentation.html);
wenzelm
parents: 52447
diff changeset
    47
52445
18a720984855 dockable window for Isabelle documentation;
wenzelm
parents:
diff changeset
    48
  private val tree = new JTree(root)
54687
795f8d3e06c9 no keyboard control -- avoid confusion about meaning of selection;
wenzelm
parents: 54686
diff changeset
    49
795f8d3e06c9 no keyboard control -- avoid confusion about meaning of selection;
wenzelm
parents: 54686
diff changeset
    50
  for (cond <-
795f8d3e06c9 no keyboard control -- avoid confusion about meaning of selection;
wenzelm
parents: 54686
diff changeset
    51
    List(JComponent.WHEN_FOCUSED,
795f8d3e06c9 no keyboard control -- avoid confusion about meaning of selection;
wenzelm
parents: 54686
diff changeset
    52
      JComponent.WHEN_ANCESTOR_OF_FOCUSED_COMPONENT,
795f8d3e06c9 no keyboard control -- avoid confusion about meaning of selection;
wenzelm
parents: 54686
diff changeset
    53
      JComponent.WHEN_IN_FOCUSED_WINDOW)) tree.setInputMap(cond, null)
795f8d3e06c9 no keyboard control -- avoid confusion about meaning of selection;
wenzelm
parents: 54686
diff changeset
    54
52445
18a720984855 dockable window for Isabelle documentation;
wenzelm
parents:
diff changeset
    55
  if (!OperatingSystem.isMacOSLF)
18a720984855 dockable window for Isabelle documentation;
wenzelm
parents:
diff changeset
    56
    tree.putClientProperty("JTree.lineStyle", "Angled")
18a720984855 dockable window for Isabelle documentation;
wenzelm
parents:
diff changeset
    57
  tree.getSelectionModel.setSelectionMode(TreeSelectionModel.SINGLE_TREE_SELECTION)
54686
070d5e856798 directly react on click, assuming that document view operation is mostly idempotent;
wenzelm
parents: 53177
diff changeset
    58
  tree.addMouseListener(new MouseAdapter {
070d5e856798 directly react on click, assuming that document view operation is mostly idempotent;
wenzelm
parents: 53177
diff changeset
    59
    override def mouseClicked(e: MouseEvent) {
070d5e856798 directly react on click, assuming that document view operation is mostly idempotent;
wenzelm
parents: 53177
diff changeset
    60
      val click = tree.getPathForLocation(e.getX, e.getY)
070d5e856798 directly react on click, assuming that document view operation is mostly idempotent;
wenzelm
parents: 53177
diff changeset
    61
      if (click != null && e.getClickCount == 1) {
070d5e856798 directly react on click, assuming that document view operation is mostly idempotent;
wenzelm
parents: 53177
diff changeset
    62
        (click.getLastPathComponent, tree.getLastSelectedPathComponent) match {
070d5e856798 directly react on click, assuming that document view operation is mostly idempotent;
wenzelm
parents: 53177
diff changeset
    63
          case (node: DefaultMutableTreeNode, node1: DefaultMutableTreeNode) if node == node1 =>
52445
18a720984855 dockable window for Isabelle documentation;
wenzelm
parents:
diff changeset
    64
            node.getUserObject match {
52542
19d674acb764 more release notes according to availability in proper release vs. repository clone;
wenzelm
parents: 52541
diff changeset
    65
              case Text_File(_, path) =>
55877
65c9968286d5 tuned signature;
wenzelm
parents: 54687
diff changeset
    66
                PIDE.editor.goto_file(view, Isabelle_System.platform_path(path))
56422
7490555d7dff clarified Doc entry: more explicit path;
wenzelm
parents: 55877
diff changeset
    67
              case Documentation(_, _, path) =>
7490555d7dff clarified Doc entry: more explicit path;
wenzelm
parents: 55877
diff changeset
    68
                if (path.is_file)
7490555d7dff clarified Doc entry: more explicit path;
wenzelm
parents: 55877
diff changeset
    69
                  PIDE.editor.goto_file(view, Isabelle_System.platform_path(path))
7490555d7dff clarified Doc entry: more explicit path;
wenzelm
parents: 55877
diff changeset
    70
                else {
7490555d7dff clarified Doc entry: more explicit path;
wenzelm
parents: 55877
diff changeset
    71
                  default_thread_pool.submit(() =>
7490555d7dff clarified Doc entry: more explicit path;
wenzelm
parents: 55877
diff changeset
    72
                    try { Doc.view(path) }
7490555d7dff clarified Doc entry: more explicit path;
wenzelm
parents: 55877
diff changeset
    73
                    catch {
7490555d7dff clarified Doc entry: more explicit path;
wenzelm
parents: 55877
diff changeset
    74
                      case exn: Throwable =>
7490555d7dff clarified Doc entry: more explicit path;
wenzelm
parents: 55877
diff changeset
    75
                        GUI.error_dialog(view,
7490555d7dff clarified Doc entry: more explicit path;
wenzelm
parents: 55877
diff changeset
    76
                          "Documentation error", GUI.scrollable_text(Exn.message(exn)))
7490555d7dff clarified Doc entry: more explicit path;
wenzelm
parents: 55877
diff changeset
    77
                    })
7490555d7dff clarified Doc entry: more explicit path;
wenzelm
parents: 55877
diff changeset
    78
                }
52445
18a720984855 dockable window for Isabelle documentation;
wenzelm
parents:
diff changeset
    79
              case _ =>
18a720984855 dockable window for Isabelle documentation;
wenzelm
parents:
diff changeset
    80
            }
18a720984855 dockable window for Isabelle documentation;
wenzelm
parents:
diff changeset
    81
          case _ =>
18a720984855 dockable window for Isabelle documentation;
wenzelm
parents:
diff changeset
    82
        }
18a720984855 dockable window for Isabelle documentation;
wenzelm
parents:
diff changeset
    83
      }
54686
070d5e856798 directly react on click, assuming that document view operation is mostly idempotent;
wenzelm
parents: 53177
diff changeset
    84
    }
070d5e856798 directly react on click, assuming that document view operation is mostly idempotent;
wenzelm
parents: 53177
diff changeset
    85
  })
52445
18a720984855 dockable window for Isabelle documentation;
wenzelm
parents:
diff changeset
    86
  tree.setRootVisible(false)
18a720984855 dockable window for Isabelle documentation;
wenzelm
parents:
diff changeset
    87
  tree.setVisibleRowCount(docs.length)
18a720984855 dockable window for Isabelle documentation;
wenzelm
parents:
diff changeset
    88
  (0 until docs.length).foreach(tree.expandRow)
18a720984855 dockable window for Isabelle documentation;
wenzelm
parents:
diff changeset
    89
18a720984855 dockable window for Isabelle documentation;
wenzelm
parents:
diff changeset
    90
  private val tree_view = new JScrollPane(tree)
18a720984855 dockable window for Isabelle documentation;
wenzelm
parents:
diff changeset
    91
  tree_view.setMinimumSize(new Dimension(100, 50))
18a720984855 dockable window for Isabelle documentation;
wenzelm
parents:
diff changeset
    92
18a720984855 dockable window for Isabelle documentation;
wenzelm
parents:
diff changeset
    93
  set_content(tree_view)
18a720984855 dockable window for Isabelle documentation;
wenzelm
parents:
diff changeset
    94
}