src/Tools/jEdit/src/text_area_painter.scala
author wenzelm
Sat Jun 18 21:03:52 2011 +0200 (2011-06-18)
changeset 43448 90aec5043461
parent 43435 ae6b0c3e58a8
child 43450 b6b09fc8d671
permissions -rw-r--r--
more robust caret painting wrt. surrogate characters;
discontinued glyphvector drawing -- less special cases;
     1 /*  Title:      Tools/jEdit/src/text_area_painter.scala
     2     Author:     Makarius
     3 
     4 Painter setup for main jEdit text area.
     5 */
     6 
     7 package isabelle.jedit
     8 
     9 
    10 import isabelle._
    11 
    12 import java.awt.{Graphics2D, Shape}
    13 import java.awt.font.TextAttribute
    14 import java.text.AttributedString
    15 import java.util.ArrayList
    16 
    17 import org.gjt.sp.jedit.Debug
    18 import org.gjt.sp.jedit.syntax.{DisplayTokenHandler, Chunk}
    19 import org.gjt.sp.jedit.textarea.{TextAreaExtension, TextAreaPainter, JEditTextArea}
    20 
    21 
    22 class Text_Area_Painter(doc_view: Document_View)
    23 {
    24   private val model = doc_view.model
    25   private val buffer = model.buffer
    26   private val text_area = doc_view.text_area
    27 
    28 
    29   /* original painters */
    30 
    31   private def pick_extension(name: String): TextAreaExtension =
    32   {
    33     text_area.getPainter.getExtensions.iterator.filter(x => x.getClass.getName == name).toList
    34     match {
    35       case List(x) => x
    36       case _ => error("Expected exactly one " + name)
    37     }
    38   }
    39 
    40   private val orig_text_painter =
    41     pick_extension("org.gjt.sp.jedit.textarea.TextAreaPainter$PaintText")
    42 
    43 
    44   /* common painter state */
    45 
    46   @volatile private var painter_snapshot: Document.Snapshot = null
    47   @volatile private var painter_clip: Shape = null
    48 
    49   private val set_state = new TextAreaExtension
    50   {
    51     override def paintScreenLineRange(gfx: Graphics2D,
    52       first_line: Int, last_line: Int, physical_lines: Array[Int],
    53       start: Array[Int], end: Array[Int], y: Int, line_height: Int)
    54     {
    55       doc_view.robust_body(()) {
    56         painter_snapshot = doc_view.update_snapshot()
    57         painter_clip = gfx.getClip
    58       }
    59     }
    60   }
    61 
    62   private val reset_state = new TextAreaExtension
    63   {
    64     override def paintScreenLineRange(gfx: Graphics2D,
    65       first_line: Int, last_line: Int, physical_lines: Array[Int],
    66       start: Array[Int], end: Array[Int], y: Int, line_height: Int)
    67     {
    68       doc_view.robust_body(()) {
    69         painter_snapshot = null
    70         painter_clip = null
    71       }
    72     }
    73   }
    74 
    75 
    76   /* text background */
    77 
    78   private val background_painter = new TextAreaExtension
    79   {
    80     override def paintScreenLineRange(gfx: Graphics2D,
    81       first_line: Int, last_line: Int, physical_lines: Array[Int],
    82       start: Array[Int], end: Array[Int], y: Int, line_height: Int)
    83     {
    84       doc_view.robust_body(()) {
    85         val snapshot = painter_snapshot
    86         val ascent = text_area.getPainter.getFontMetrics.getAscent
    87 
    88         for (i <- 0 until physical_lines.length) {
    89           if (physical_lines(i) != -1) {
    90             val line_range = doc_view.proper_line_range(start(i), end(i))
    91 
    92             // background color: status
    93             for {
    94               (command, command_start) <- snapshot.node.command_range(snapshot.revert(line_range))
    95               if !command.is_ignored
    96               range <- line_range.try_restrict(snapshot.convert(command.range + command_start))
    97               r <- Isabelle.gfx_range(text_area, range)
    98               color <- Isabelle_Markup.status_color(snapshot, command)
    99             } {
   100               gfx.setColor(color)
   101               gfx.fillRect(r.x, y + i * line_height, r.length, line_height)
   102             }
   103 
   104             // background color (1): markup
   105             for {
   106               Text.Info(range, Some(color)) <-
   107                 snapshot.select_markup(line_range)(Isabelle_Markup.background1).iterator
   108               r <- Isabelle.gfx_range(text_area, range)
   109             } {
   110               gfx.setColor(color)
   111               gfx.fillRect(r.x, y + i * line_height, r.length, line_height)
   112             }
   113 
   114             // background color (2): markup
   115             for {
   116               Text.Info(range, Some(color)) <-
   117                 snapshot.select_markup(line_range)(Isabelle_Markup.background2).iterator
   118               r <- Isabelle.gfx_range(text_area, range)
   119             } {
   120               gfx.setColor(color)
   121               gfx.fillRect(r.x + 2, y + i * line_height + 2, r.length - 4, line_height - 4)
   122             }
   123 
   124             // squiggly underline
   125             for {
   126               Text.Info(range, Some(color)) <-
   127                 snapshot.select_markup(line_range)(Isabelle_Markup.message).iterator
   128               r <- Isabelle.gfx_range(text_area, range)
   129             } {
   130               gfx.setColor(color)
   131               val x0 = (r.x / 2) * 2
   132               val y0 = r.y + ascent + 1
   133               for (x1 <- Range(x0, x0 + r.length, 2)) {
   134                 val y1 = if (x1 % 4 < 2) y0 else y0 + 1
   135                 gfx.drawLine(x1, y1, x1 + 1, y1)
   136               }
   137             }
   138           }
   139         }
   140       }
   141     }
   142   }
   143 
   144 
   145   /* text */
   146 
   147   def char_width(): Int =
   148   {
   149     val painter = text_area.getPainter
   150     val font = painter.getFont
   151     val font_context = painter.getFontRenderContext
   152     font.getStringBounds(" ", font_context).getWidth.round.toInt
   153   }
   154 
   155   private def line_infos(physical_lines: Iterator[Int]): Map[Text.Offset, Chunk] =
   156   {
   157     val painter = text_area.getPainter
   158     val font = painter.getFont
   159     val font_context = painter.getFontRenderContext
   160 
   161     // see org.gjt.sp.jedit.textarea.TextArea.propertiesChanged
   162     // see org.gjt.sp.jedit.textarea.TextArea.setMaxLineLength
   163     val margin =
   164       if (buffer.getStringProperty("wrap") != "soft") 0.0f
   165       else {
   166         val max = buffer.getIntegerProperty("maxLineLen", 0)
   167         if (max > 0) font.getStringBounds(" " * max, font_context).getWidth.toInt
   168         else painter.getWidth - char_width() * 3
   169       }.toFloat
   170 
   171     val out = new ArrayList[Chunk]
   172     val handler = new DisplayTokenHandler
   173 
   174     var result = Map[Text.Offset, Chunk]()
   175     for (line <- physical_lines) {
   176       out.clear
   177       handler.init(painter.getStyles, font_context, painter, out, margin)
   178       buffer.markTokens(line, handler)
   179 
   180       val line_start = buffer.getLineStartOffset(line)
   181       for (i <- 0 until out.size) {
   182         val chunk = out.get(i)
   183         result += (line_start + chunk.offset -> chunk)
   184       }
   185     }
   186     result
   187   }
   188 
   189   private def paint_chunk_list(
   190     gfx: Graphics2D, offset: Text.Offset, head: Chunk, x: Float, y: Float): Float =
   191   {
   192     val clip_rect = gfx.getClipBounds
   193     val painter = text_area.getPainter
   194     val font_context = painter.getFontRenderContext
   195 
   196     var w = 0.0f
   197     var chunk_offset = offset
   198     var chunk = head
   199     while (chunk != null) {
   200       val chunk_length = if (chunk.str == null) 0 else chunk.str.length
   201 
   202       if (x + w + chunk.width > clip_rect.x &&
   203           x + w < clip_rect.x + clip_rect.width &&
   204           chunk.accessable && chunk.visible)
   205       {
   206         val chunk_range = Text.Range(chunk_offset, chunk_offset + chunk_length)
   207         val chunk_font = chunk.style.getFont
   208         val chunk_color = chunk.style.getForegroundColor
   209 
   210         val caret_range =
   211           if (text_area.hasFocus) doc_view.caret_range()
   212           else Text.Range(-1)
   213 
   214         val markup =
   215           for {
   216             x <- painter_snapshot.select_markup(chunk_range)(Isabelle_Markup.text_color)
   217             y <- x.try_restrict(chunk_range)
   218           } yield y
   219 
   220         gfx.setFont(chunk_font)
   221         if (markup.isEmpty)
   222           gfx.drawString(chunk.str, x.toInt, y.toInt)
   223         else {
   224           var x1 = x + w
   225           for {
   226             Text.Info(range, info) <-
   227               Iterator(Text.Info(Text.Range(chunk_range.start, markup.head.range.start), None)) ++
   228               markup.iterator ++
   229               Iterator(Text.Info(Text.Range(markup.last.range.stop, chunk_range.stop), None))
   230             if !range.is_singularity
   231           } {
   232             val str = chunk.str.substring(range.start - chunk_offset, range.stop - chunk_offset)
   233             gfx.setColor(info.getOrElse(chunk_color))
   234 
   235             range.try_restrict(caret_range) match {
   236               case Some(r) if !r.is_singularity =>
   237                 val astr = new AttributedString(str)
   238                 val i = r.start - range.start
   239                 val j = r.stop - range.start
   240                 astr.addAttribute(TextAttribute.FONT, chunk_font)
   241                 astr.addAttribute(TextAttribute.FOREGROUND, painter.getCaretColor, i, j)
   242                 astr.addAttribute(TextAttribute.SWAP_COLORS, TextAttribute.SWAP_COLORS_ON, i, j)
   243                 gfx.drawString(astr.getIterator, x1.toInt, y.toInt)
   244               case _ =>
   245                 gfx.drawString(str, x1.toInt, y.toInt)
   246             }
   247             x1 += chunk_font.getStringBounds(str, font_context).getWidth.toFloat
   248           }
   249         }
   250       }
   251       w += chunk.width
   252       chunk_offset += chunk_length
   253       chunk = chunk.next.asInstanceOf[Chunk]
   254     }
   255     w
   256   }
   257 
   258   private val text_painter = new TextAreaExtension
   259   {
   260     override def paintScreenLineRange(gfx: Graphics2D,
   261       first_line: Int, last_line: Int, physical_lines: Array[Int],
   262       start: Array[Int], end: Array[Int], y: Int, line_height: Int)
   263     {
   264       doc_view.robust_body(()) {
   265         val clip = gfx.getClip
   266         val x0 = text_area.getHorizontalOffset
   267         val fm = text_area.getPainter.getFontMetrics
   268         var y0 = y + fm.getHeight - (fm.getLeading + 1) - fm.getDescent
   269 
   270         val infos = line_infos(physical_lines.iterator.filter(i => i != -1))
   271         for (i <- 0 until physical_lines.length) {
   272           if (physical_lines(i) != -1) {
   273             val x1 =
   274               infos.get(start(i)) match {
   275                 case None => x0
   276                 case Some(chunk) =>
   277                   gfx.clipRect(x0, y + line_height * i, Integer.MAX_VALUE, line_height)
   278                   val w = paint_chunk_list(gfx, start(i), chunk, x0, y0).toInt
   279                   x0 + w.toInt
   280               }
   281             gfx.clipRect(x1, 0, Integer.MAX_VALUE, Integer.MAX_VALUE)
   282             orig_text_painter.paintValidLine(gfx,
   283               first_line + i, physical_lines(i), start(i), end(i), y + line_height * i)
   284             gfx.setClip(clip)
   285           }
   286           y0 += line_height
   287         }
   288       }
   289     }
   290   }
   291 
   292 
   293   /* foreground */
   294 
   295   private val foreground_painter = new TextAreaExtension
   296   {
   297     override def paintScreenLineRange(gfx: Graphics2D,
   298       first_line: Int, last_line: Int, physical_lines: Array[Int],
   299       start: Array[Int], end: Array[Int], y: Int, line_height: Int)
   300     {
   301       doc_view.robust_body(()) {
   302         val snapshot = painter_snapshot
   303 
   304         for (i <- 0 until physical_lines.length) {
   305           if (physical_lines(i) != -1) {
   306             val line_range = doc_view.proper_line_range(start(i), end(i))
   307 
   308             // highlighted range -- potentially from other snapshot
   309             doc_view.highlight_range match {
   310               case Some((range, color)) if line_range.overlaps(range) =>
   311                 Isabelle.gfx_range(text_area, line_range.restrict(range)) match {
   312                   case None =>
   313                   case Some(r) =>
   314                     gfx.setColor(color)
   315                     gfx.fillRect(r.x, y + i * line_height, r.length, line_height)
   316                 }
   317               case _ =>
   318             }
   319           }
   320         }
   321       }
   322     }
   323   }
   324 
   325 
   326   /* caret -- outside of text range */
   327 
   328   private class Caret_Painter(before: Boolean) extends TextAreaExtension
   329   {
   330     override def paintValidLine(gfx: Graphics2D,
   331       screen_line: Int, physical_line: Int, start: Int, end: Int, y: Int)
   332     {
   333       doc_view.robust_body(()) {
   334         if (before) gfx.clipRect(0, 0, 0, 0)
   335         else gfx.setClip(painter_clip)
   336       }
   337     }
   338   }
   339 
   340   private val before_caret_painter1 = new Caret_Painter(true)
   341   private val after_caret_painter1 = new Caret_Painter(false)
   342   private val before_caret_painter2 = new Caret_Painter(true)
   343   private val after_caret_painter2 = new Caret_Painter(false)
   344 
   345   private val caret_painter = new TextAreaExtension
   346   {
   347     override def paintValidLine(gfx: Graphics2D,
   348       screen_line: Int, physical_line: Int, start: Int, end: Int, y: Int)
   349     {
   350       doc_view.robust_body(()) {
   351         if (text_area.hasFocus) {
   352           val caret = text_area.getCaretPosition
   353           if (start <= caret && caret == end - 1) {
   354             val painter = text_area.getPainter
   355             val fm = painter.getFontMetrics
   356 
   357             val offset = caret - text_area.getLineStartOffset(physical_line)
   358             val x = text_area.offsetToXY(physical_line, offset).x
   359             gfx.setColor(painter.getCaretColor)
   360             gfx.drawRect(x, y, char_width() - 1, fm.getHeight - 1)
   361           }
   362         }
   363       }
   364     }
   365   }
   366 
   367 
   368   /* activation */
   369 
   370   def activate()
   371   {
   372     val painter = text_area.getPainter
   373     painter.addExtension(TextAreaPainter.LOWEST_LAYER, set_state)
   374     painter.addExtension(TextAreaPainter.LINE_BACKGROUND_LAYER + 1, background_painter)
   375     painter.addExtension(TextAreaPainter.TEXT_LAYER, text_painter)
   376     painter.addExtension(TextAreaPainter.CARET_LAYER - 1, before_caret_painter1)
   377     painter.addExtension(TextAreaPainter.CARET_LAYER + 1, after_caret_painter1)
   378     painter.addExtension(TextAreaPainter.BLOCK_CARET_LAYER - 1, before_caret_painter2)
   379     painter.addExtension(TextAreaPainter.BLOCK_CARET_LAYER + 1, after_caret_painter2)
   380     painter.addExtension(TextAreaPainter.BLOCK_CARET_LAYER + 2, caret_painter)
   381     painter.addExtension(500, foreground_painter)
   382     painter.addExtension(TextAreaPainter.HIGHEST_LAYER, reset_state)
   383     painter.removeExtension(orig_text_painter)
   384   }
   385 
   386   def deactivate()
   387   {
   388     val painter = text_area.getPainter
   389     painter.addExtension(TextAreaPainter.TEXT_LAYER, orig_text_painter)
   390     painter.removeExtension(reset_state)
   391     painter.removeExtension(foreground_painter)
   392     painter.removeExtension(caret_painter)
   393     painter.removeExtension(after_caret_painter2)
   394     painter.removeExtension(before_caret_painter2)
   395     painter.removeExtension(after_caret_painter1)
   396     painter.removeExtension(before_caret_painter1)
   397     painter.removeExtension(text_painter)
   398     painter.removeExtension(background_painter)
   399     painter.removeExtension(set_state)
   400   }
   401 }
   402