src/Tools/jEdit/src/document_view.scala
author wenzelm
Sun Jul 07 18:04:46 2013 +0200 (2013-07-07)
changeset 52548 a1a8248a4677
parent 52479 bb516d01d259
child 52759 a20631db9c8a
permissions -rw-r--r--
some attempts to avoid sandwiching of actions stemming from single ESCAPE key event, to avoid potential conflict with ongoing text selection;
     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, KeyAdapter}
    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, 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 = new KeyAdapter {
   153     override def keyTyped(evt: KeyEvent)
   154     {
   155       if (evt.getKeyChar == 27 && Pretty_Tooltip.dismissed_all())
   156         evt.consume
   157     }
   158   }
   159 
   160 
   161   /* caret handling */
   162 
   163   private val delay_caret_update =
   164     Swing_Thread.delay_last(PIDE.options.seconds("editor_input_delay")) {
   165       session.caret_focus.event(Session.Caret_Focus)
   166     }
   167 
   168   private val caret_listener = new CaretListener {
   169     override def caretUpdate(e: CaretEvent) { delay_caret_update.invoke() }
   170   }
   171 
   172 
   173   /* text status overview left of scrollbar */
   174 
   175   private object overview extends Text_Overview(this)
   176   {
   177     val delay_repaint =
   178       Swing_Thread.delay_first(PIDE.options.seconds("editor_update_delay")) { repaint() }
   179   }
   180 
   181 
   182   /* main actor */
   183 
   184   private val main_actor = actor {
   185     loop {
   186       react {
   187         case _: Session.Raw_Edits =>
   188           Swing_Thread.later {
   189             overview.delay_repaint.postpone(PIDE.options.seconds("editor_input_delay"))
   190           }
   191 
   192         case changed: Session.Commands_Changed =>
   193           val buffer = model.buffer
   194           Swing_Thread.later {
   195             JEdit_Lib.buffer_lock(buffer) {
   196               if (model.buffer == text_area.getBuffer) {
   197                 val snapshot = model.snapshot()
   198 
   199                 if (changed.assignment ||
   200                     (changed.nodes.contains(model.name) &&
   201                      changed.commands.exists(snapshot.node.commands.contains)))
   202                   Swing_Thread.later { overview.delay_repaint.invoke() }
   203 
   204                 val visible_lines = text_area.getVisibleLines
   205                 if (visible_lines > 0) {
   206                   if (changed.assignment) text_area.invalidateScreenLineRange(0, visible_lines)
   207                   else {
   208                     val visible_range = JEdit_Lib.visible_range(text_area).get
   209                     val visible_cmds =
   210                       snapshot.node.command_range(snapshot.revert(visible_range)).map(_._1)
   211                     if (visible_cmds.exists(changed.commands)) {
   212                       for {
   213                         line <- 0 until visible_lines
   214                         start = text_area.getScreenLineStartOffset(line) if start >= 0
   215                         end = text_area.getScreenLineEndOffset(line) if end >= 0
   216                         range = Text.Range(start, end)
   217                         line_cmds = snapshot.node.command_range(snapshot.revert(range)).map(_._1)
   218                         if line_cmds.exists(changed.commands)
   219                       } text_area.invalidateScreenLineRange(line, line)
   220                     }
   221                   }
   222                 }
   223               }
   224             }
   225           }
   226 
   227         case bad => System.err.println("command_change_actor: ignoring bad message " + bad)
   228       }
   229     }
   230   }
   231 
   232 
   233   /* activation */
   234 
   235   private def activate()
   236   {
   237     val painter = text_area.getPainter
   238 
   239     painter.addExtension(TextAreaPainter.LOWEST_LAYER, update_perspective)
   240     rich_text_area.activate()
   241     text_area.getGutter.addExtension(gutter_painter)
   242     text_area.addKeyListener(key_listener)
   243     text_area.addCaretListener(caret_listener)
   244     text_area.addLeftOfScrollBar(overview)
   245     session.raw_edits += main_actor
   246     session.commands_changed += main_actor
   247   }
   248 
   249   private def deactivate()
   250   {
   251     val painter = text_area.getPainter
   252 
   253     session.raw_edits -= main_actor
   254     session.commands_changed -= main_actor
   255     text_area.removeLeftOfScrollBar(overview); overview.delay_repaint.revoke()
   256     text_area.removeCaretListener(caret_listener); delay_caret_update.revoke()
   257     text_area.removeKeyListener(key_listener)
   258     text_area.getGutter.removeExtension(gutter_painter)
   259     rich_text_area.deactivate()
   260     painter.removeExtension(update_perspective)
   261   }
   262 }