src/Tools/jEdit/src/document_view.scala
author wenzelm
Sat Sep 21 20:58:32 2013 +0200 (2013-09-21)
changeset 53780 ef62204a126b
parent 53274 1760c01f1c78
child 54325 2c4155003352
permissions -rw-r--r--
caret range of active text area counts as visible (e.g. relevant for Output after scrolling outside of text view);
     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 
    84     val active_caret =
    85       if (text_area.getView != null && text_area.getView.getTextArea == text_area)
    86         List(JEdit_Lib.point_range(model.buffer, text_area.getCaretPosition))
    87       else Nil
    88 
    89     val buffer_range = JEdit_Lib.buffer_range(model.buffer)
    90     val visible_lines =
    91       (for {
    92         i <- 0 until text_area.getVisibleLines
    93         start = text_area.getScreenLineStartOffset(i)
    94         stop = text_area.getScreenLineEndOffset(i)
    95         if start >= 0 && stop >= 0
    96         range <- buffer_range.try_restrict(Text.Range(start, stop))
    97         if !range.is_singularity
    98       }
    99       yield range).toList
   100 
   101     Text.Perspective(active_caret ::: visible_lines)
   102   }
   103 
   104   private def update_perspective = new TextAreaExtension
   105   {
   106     override def paintScreenLineRange(gfx: Graphics2D,
   107       first_line: Int, last_line: Int, physical_lines: Array[Int],
   108       start: Array[Int], end: Array[Int], y: Int, line_height: Int)
   109     {
   110       // no robust_body
   111       model.update_perspective()
   112     }
   113   }
   114 
   115 
   116   /* gutter */
   117 
   118   private val gutter_painter = new TextAreaExtension
   119   {
   120     override def paintScreenLineRange(gfx: Graphics2D,
   121       first_line: Int, last_line: Int, physical_lines: Array[Int],
   122       start: Array[Int], end: Array[Int], y: Int, line_height: Int)
   123     {
   124       rich_text_area.robust_body(()) {
   125         Swing_Thread.assert()
   126 
   127         val gutter = text_area.getGutter
   128         val width = GutterOptionPane.getSelectionAreaWidth
   129         val border_width = jEdit.getIntegerProperty("view.gutter.borderWidth", 3)
   130         val FOLD_MARKER_SIZE = 12
   131 
   132         if (gutter.isSelectionAreaEnabled && !gutter.isExpanded && width >= 12 && line_height >= 12) {
   133           val buffer = model.buffer
   134           JEdit_Lib.buffer_lock(buffer) {
   135             val rendering = get_rendering()
   136 
   137             for (i <- 0 until physical_lines.length) {
   138               if (physical_lines(i) != -1) {
   139                 val line_range = Text.Range(start(i), end(i))
   140 
   141                 // gutter icons
   142                 rendering.gutter_message(line_range) match {
   143                   case Some(icon) =>
   144                     val x0 = (FOLD_MARKER_SIZE + width - border_width - icon.getIconWidth) max 10
   145                     val y0 = y + i * line_height + (((line_height - icon.getIconHeight) / 2) max 0)
   146                     icon.paintIcon(gutter, gfx, x0, y0)
   147                   case None =>
   148                 }
   149               }
   150             }
   151           }
   152         }
   153       }
   154     }
   155   }
   156 
   157 
   158   /* key listener */
   159 
   160   private val key_listener =
   161     JEdit_Lib.key_listener(
   162       key_pressed = (evt: KeyEvent) =>
   163         {
   164           if (evt.getKeyCode == KeyEvent.VK_ESCAPE && PIDE.dismissed_popups(text_area.getView))
   165             evt.consume
   166         }
   167     )
   168 
   169 
   170   /* caret handling */
   171 
   172   private val delay_caret_update =
   173     Swing_Thread.delay_last(PIDE.options.seconds("editor_input_delay")) {
   174       session.caret_focus.event(Session.Caret_Focus)
   175     }
   176 
   177   private val caret_listener = new CaretListener {
   178     override def caretUpdate(e: CaretEvent) { delay_caret_update.invoke() }
   179   }
   180 
   181 
   182   /* text status overview left of scrollbar */
   183 
   184   private object overview extends Text_Overview(this)
   185   {
   186     val delay_repaint =
   187       Swing_Thread.delay_first(PIDE.options.seconds("editor_update_delay")) { repaint() }
   188   }
   189 
   190 
   191   /* main actor */
   192 
   193   private val main_actor = actor {
   194     loop {
   195       react {
   196         case _: Session.Raw_Edits =>
   197           Swing_Thread.later {
   198             overview.delay_repaint.postpone(PIDE.options.seconds("editor_input_delay"))
   199           }
   200 
   201         case changed: Session.Commands_Changed =>
   202           val buffer = model.buffer
   203           Swing_Thread.later {
   204             JEdit_Lib.buffer_lock(buffer) {
   205               if (model.buffer == text_area.getBuffer) {
   206                 val snapshot = model.snapshot()
   207 
   208                 if (changed.assignment ||
   209                     (changed.nodes.contains(model.node_name) &&
   210                      changed.commands.exists(snapshot.node.commands.contains)))
   211                   Swing_Thread.later { overview.delay_repaint.invoke() }
   212 
   213                 val visible_lines = text_area.getVisibleLines
   214                 if (visible_lines > 0) {
   215                   if (changed.assignment) text_area.invalidateScreenLineRange(0, visible_lines)
   216                   else {
   217                     val visible_range = JEdit_Lib.visible_range(text_area).get
   218                     val visible_cmds =
   219                       snapshot.node.command_range(snapshot.revert(visible_range)).map(_._1)
   220                     if (visible_cmds.exists(changed.commands)) {
   221                       for {
   222                         line <- 0 until visible_lines
   223                         start = text_area.getScreenLineStartOffset(line) if start >= 0
   224                         end = text_area.getScreenLineEndOffset(line) if end >= 0
   225                         range = Text.Range(start, end)
   226                         line_cmds = snapshot.node.command_range(snapshot.revert(range)).map(_._1)
   227                         if line_cmds.exists(changed.commands)
   228                       } text_area.invalidateScreenLineRange(line, line)
   229                     }
   230                   }
   231                 }
   232               }
   233             }
   234           }
   235 
   236         case bad => System.err.println("command_change_actor: ignoring bad message " + bad)
   237       }
   238     }
   239   }
   240 
   241 
   242   /* activation */
   243 
   244   private def activate()
   245   {
   246     val painter = text_area.getPainter
   247 
   248     painter.addExtension(TextAreaPainter.LOWEST_LAYER, update_perspective)
   249     rich_text_area.activate()
   250     text_area.getGutter.addExtension(gutter_painter)
   251     text_area.addKeyListener(key_listener)
   252     text_area.addCaretListener(caret_listener)
   253     text_area.addLeftOfScrollBar(overview)
   254     session.raw_edits += main_actor
   255     session.commands_changed += main_actor
   256   }
   257 
   258   private def deactivate()
   259   {
   260     val painter = text_area.getPainter
   261 
   262     session.raw_edits -= main_actor
   263     session.commands_changed -= main_actor
   264     text_area.removeLeftOfScrollBar(overview); overview.delay_repaint.revoke()
   265     text_area.removeCaretListener(caret_listener); delay_caret_update.revoke()
   266     text_area.removeKeyListener(key_listener)
   267     text_area.getGutter.removeExtension(gutter_painter)
   268     rich_text_area.deactivate()
   269     painter.removeExtension(update_perspective)
   270   }
   271 }