src/Tools/jEdit/src/document_view.scala
author wenzelm
Thu Aug 29 12:38:33 2013 +0200 (2013-08-29)
changeset 53274 1760c01f1c78
parent 53272 0dfd78ff7696
child 53780 ef62204a126b
permissions -rw-r--r--
maintain Completion_Popup.Text_Area as client property like Document_View;
global Completion_Popup.Text_Area init/exit like SideKickPlugin;
eliminated old SideKick completion -- cover all Isabelle modes uniformly;
dynamic lookup of Isabelle.mode_syntax -- NB: buffer mode might be undefined in intermediate stages;
     1 /*  Title:      Tools/jEdit/src/document_view.scala
     2     Author:     Fabian Immler, TU Munich
     3     Author:     Makarius
     4 
     5 Document view connected to jEdit text area.
     6 */
     7 
     8 package isabelle.jedit
     9 
    10 
    11 import isabelle._
    12 
    13 import scala.collection.mutable
    14 import scala.collection.immutable.SortedMap
    15 import scala.actors.Actor._
    16 
    17 import java.lang.System
    18 import java.text.BreakIterator
    19 import java.awt.{Color, Graphics2D, Point}
    20 import java.awt.event.KeyEvent
    21 import javax.swing.event.{CaretListener, CaretEvent}
    22 
    23 import org.gjt.sp.jedit.{jEdit, Debug}
    24 import org.gjt.sp.jedit.gui.RolloverButton
    25 import org.gjt.sp.jedit.options.GutterOptionPane
    26 import org.gjt.sp.jedit.textarea.{JEditTextArea, TextArea, TextAreaExtension, TextAreaPainter}
    27 import org.gjt.sp.jedit.syntax.SyntaxStyle
    28 
    29 
    30 object Document_View
    31 {
    32   /* document view of text area */
    33 
    34   private val key = new Object
    35 
    36   def apply(text_area: JEditTextArea): Option[Document_View] =
    37   {
    38     Swing_Thread.require()
    39     text_area.getClientProperty(key) match {
    40       case doc_view: Document_View => Some(doc_view)
    41       case _ => None
    42     }
    43   }
    44 
    45   def exit(text_area: JEditTextArea)
    46   {
    47     Swing_Thread.require()
    48     apply(text_area) match {
    49       case None =>
    50       case Some(doc_view) =>
    51         doc_view.deactivate()
    52         text_area.putClientProperty(key, null)
    53     }
    54   }
    55 
    56   def init(model: Document_Model, text_area: JEditTextArea): Document_View =
    57   {
    58     exit(text_area)
    59     val doc_view = new Document_View(model, text_area)
    60     text_area.putClientProperty(key, doc_view)
    61     doc_view.activate()
    62     doc_view
    63   }
    64 }
    65 
    66 
    67 class Document_View(val model: Document_Model, val text_area: JEditTextArea)
    68 {
    69   private val session = model.session
    70 
    71   def get_rendering(): Rendering = Rendering(model.snapshot(), PIDE.options.value)
    72 
    73   val rich_text_area =
    74     new Rich_Text_Area(text_area.getView, text_area, get_rendering _, () => (),
    75       caret_visible = true, enable_hovering = false)
    76 
    77 
    78   /* perspective */
    79 
    80   def perspective(): Text.Perspective =
    81   {
    82     Swing_Thread.require()
    83     val buffer_range = JEdit_Lib.buffer_range(model.buffer)
    84     Text.Perspective(
    85       for {
    86         i <- 0 until text_area.getVisibleLines
    87         start = text_area.getScreenLineStartOffset(i)
    88         stop = text_area.getScreenLineEndOffset(i)
    89         if start >= 0 && stop >= 0
    90         range <- buffer_range.try_restrict(Text.Range(start, stop))
    91         if !range.is_singularity
    92       }
    93       yield range)
    94   }
    95 
    96   private def update_perspective = new TextAreaExtension
    97   {
    98     override def paintScreenLineRange(gfx: Graphics2D,
    99       first_line: Int, last_line: Int, physical_lines: Array[Int],
   100       start: Array[Int], end: Array[Int], y: Int, line_height: Int)
   101     {
   102       // no robust_body
   103       model.update_perspective()
   104     }
   105   }
   106 
   107 
   108   /* gutter */
   109 
   110   private val gutter_painter = new TextAreaExtension
   111   {
   112     override def paintScreenLineRange(gfx: Graphics2D,
   113       first_line: Int, last_line: Int, physical_lines: Array[Int],
   114       start: Array[Int], end: Array[Int], y: Int, line_height: Int)
   115     {
   116       rich_text_area.robust_body(()) {
   117         Swing_Thread.assert()
   118 
   119         val gutter = text_area.getGutter
   120         val width = GutterOptionPane.getSelectionAreaWidth
   121         val border_width = jEdit.getIntegerProperty("view.gutter.borderWidth", 3)
   122         val FOLD_MARKER_SIZE = 12
   123 
   124         if (gutter.isSelectionAreaEnabled && !gutter.isExpanded && width >= 12 && line_height >= 12) {
   125           val buffer = model.buffer
   126           JEdit_Lib.buffer_lock(buffer) {
   127             val rendering = get_rendering()
   128 
   129             for (i <- 0 until physical_lines.length) {
   130               if (physical_lines(i) != -1) {
   131                 val line_range = Text.Range(start(i), end(i))
   132 
   133                 // gutter icons
   134                 rendering.gutter_message(line_range) match {
   135                   case Some(icon) =>
   136                     val x0 = (FOLD_MARKER_SIZE + width - border_width - icon.getIconWidth) max 10
   137                     val y0 = y + i * line_height + (((line_height - icon.getIconHeight) / 2) max 0)
   138                     icon.paintIcon(gutter, gfx, x0, y0)
   139                   case None =>
   140                 }
   141               }
   142             }
   143           }
   144         }
   145       }
   146     }
   147   }
   148 
   149 
   150   /* key listener */
   151 
   152   private val key_listener =
   153     JEdit_Lib.key_listener(
   154       key_pressed = (evt: KeyEvent) =>
   155         {
   156           if (evt.getKeyCode == KeyEvent.VK_ESCAPE && PIDE.dismissed_popups(text_area.getView))
   157             evt.consume
   158         }
   159     )
   160 
   161 
   162   /* caret handling */
   163 
   164   private val delay_caret_update =
   165     Swing_Thread.delay_last(PIDE.options.seconds("editor_input_delay")) {
   166       session.caret_focus.event(Session.Caret_Focus)
   167     }
   168 
   169   private val caret_listener = new CaretListener {
   170     override def caretUpdate(e: CaretEvent) { delay_caret_update.invoke() }
   171   }
   172 
   173 
   174   /* text status overview left of scrollbar */
   175 
   176   private object overview extends Text_Overview(this)
   177   {
   178     val delay_repaint =
   179       Swing_Thread.delay_first(PIDE.options.seconds("editor_update_delay")) { repaint() }
   180   }
   181 
   182 
   183   /* main actor */
   184 
   185   private val main_actor = actor {
   186     loop {
   187       react {
   188         case _: Session.Raw_Edits =>
   189           Swing_Thread.later {
   190             overview.delay_repaint.postpone(PIDE.options.seconds("editor_input_delay"))
   191           }
   192 
   193         case changed: Session.Commands_Changed =>
   194           val buffer = model.buffer
   195           Swing_Thread.later {
   196             JEdit_Lib.buffer_lock(buffer) {
   197               if (model.buffer == text_area.getBuffer) {
   198                 val snapshot = model.snapshot()
   199 
   200                 if (changed.assignment ||
   201                     (changed.nodes.contains(model.node_name) &&
   202                      changed.commands.exists(snapshot.node.commands.contains)))
   203                   Swing_Thread.later { overview.delay_repaint.invoke() }
   204 
   205                 val visible_lines = text_area.getVisibleLines
   206                 if (visible_lines > 0) {
   207                   if (changed.assignment) text_area.invalidateScreenLineRange(0, visible_lines)
   208                   else {
   209                     val visible_range = JEdit_Lib.visible_range(text_area).get
   210                     val visible_cmds =
   211                       snapshot.node.command_range(snapshot.revert(visible_range)).map(_._1)
   212                     if (visible_cmds.exists(changed.commands)) {
   213                       for {
   214                         line <- 0 until visible_lines
   215                         start = text_area.getScreenLineStartOffset(line) if start >= 0
   216                         end = text_area.getScreenLineEndOffset(line) if end >= 0
   217                         range = Text.Range(start, end)
   218                         line_cmds = snapshot.node.command_range(snapshot.revert(range)).map(_._1)
   219                         if line_cmds.exists(changed.commands)
   220                       } text_area.invalidateScreenLineRange(line, line)
   221                     }
   222                   }
   223                 }
   224               }
   225             }
   226           }
   227 
   228         case bad => System.err.println("command_change_actor: ignoring bad message " + bad)
   229       }
   230     }
   231   }
   232 
   233 
   234   /* activation */
   235 
   236   private def activate()
   237   {
   238     val painter = text_area.getPainter
   239 
   240     painter.addExtension(TextAreaPainter.LOWEST_LAYER, update_perspective)
   241     rich_text_area.activate()
   242     text_area.getGutter.addExtension(gutter_painter)
   243     text_area.addKeyListener(key_listener)
   244     text_area.addCaretListener(caret_listener)
   245     text_area.addLeftOfScrollBar(overview)
   246     session.raw_edits += main_actor
   247     session.commands_changed += main_actor
   248   }
   249 
   250   private def deactivate()
   251   {
   252     val painter = text_area.getPainter
   253 
   254     session.raw_edits -= main_actor
   255     session.commands_changed -= main_actor
   256     text_area.removeLeftOfScrollBar(overview); overview.delay_repaint.revoke()
   257     text_area.removeCaretListener(caret_listener); delay_caret_update.revoke()
   258     text_area.removeKeyListener(key_listener)
   259     text_area.getGutter.removeExtension(gutter_painter)
   260     rich_text_area.deactivate()
   261     painter.removeExtension(update_perspective)
   262   }
   263 }