src/Tools/jEdit/src/syntax_style.scala
author wenzelm
Sun, 13 Jan 2019 16:57:25 +0100
changeset 69644 f044766cd94f
parent 67130 b023f64e0d16
child 69969 c211db89f916
permissions -rw-r--r--
File Browser is open by default;
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
65258
a0701669d159 clarified modules;
wenzelm
parents:
diff changeset
     1
/*  Title:      Tools/jEdit/src/syntax_style.scala
a0701669d159 clarified modules;
wenzelm
parents:
diff changeset
     2
    Author:     Makarius
a0701669d159 clarified modules;
wenzelm
parents:
diff changeset
     3
a0701669d159 clarified modules;
wenzelm
parents:
diff changeset
     4
Support for extended syntax styles: subscript, superscript, bold, user fonts.
a0701669d159 clarified modules;
wenzelm
parents:
diff changeset
     5
*/
a0701669d159 clarified modules;
wenzelm
parents:
diff changeset
     6
a0701669d159 clarified modules;
wenzelm
parents:
diff changeset
     7
package isabelle.jedit
a0701669d159 clarified modules;
wenzelm
parents:
diff changeset
     8
a0701669d159 clarified modules;
wenzelm
parents:
diff changeset
     9
a0701669d159 clarified modules;
wenzelm
parents:
diff changeset
    10
import isabelle._
a0701669d159 clarified modules;
wenzelm
parents:
diff changeset
    11
a0701669d159 clarified modules;
wenzelm
parents:
diff changeset
    12
import java.awt.{Font, Color}
a0701669d159 clarified modules;
wenzelm
parents:
diff changeset
    13
import java.awt.font.TextAttribute
a0701669d159 clarified modules;
wenzelm
parents:
diff changeset
    14
import java.awt.geom.AffineTransform
a0701669d159 clarified modules;
wenzelm
parents:
diff changeset
    15
a0701669d159 clarified modules;
wenzelm
parents:
diff changeset
    16
import org.gjt.sp.util.SyntaxUtilities
a0701669d159 clarified modules;
wenzelm
parents:
diff changeset
    17
import org.gjt.sp.jedit.syntax.{Token => JEditToken, SyntaxStyle}
65259
41d12227d5dc clarified modules;
wenzelm
parents: 65258
diff changeset
    18
import org.gjt.sp.jedit.textarea.TextArea
65258
a0701669d159 clarified modules;
wenzelm
parents:
diff changeset
    19
a0701669d159 clarified modules;
wenzelm
parents:
diff changeset
    20
a0701669d159 clarified modules;
wenzelm
parents:
diff changeset
    21
object Syntax_Style
a0701669d159 clarified modules;
wenzelm
parents:
diff changeset
    22
{
65259
41d12227d5dc clarified modules;
wenzelm
parents: 65258
diff changeset
    23
  /* extended syntax styles */
41d12227d5dc clarified modules;
wenzelm
parents: 65258
diff changeset
    24
65258
a0701669d159 clarified modules;
wenzelm
parents:
diff changeset
    25
  private val plain_range: Int = JEditToken.ID_COUNT
a0701669d159 clarified modules;
wenzelm
parents:
diff changeset
    26
  private def check_range(i: Int) { require(0 <= i && i < plain_range) }
a0701669d159 clarified modules;
wenzelm
parents:
diff changeset
    27
a0701669d159 clarified modules;
wenzelm
parents:
diff changeset
    28
  def subscript(i: Byte): Byte = { check_range(i); (i + plain_range).toByte }
a0701669d159 clarified modules;
wenzelm
parents:
diff changeset
    29
  def superscript(i: Byte): Byte = { check_range(i); (i + 2 * plain_range).toByte }
a0701669d159 clarified modules;
wenzelm
parents:
diff changeset
    30
  def bold(i: Byte): Byte = { check_range(i); (i + 3 * plain_range).toByte }
a0701669d159 clarified modules;
wenzelm
parents:
diff changeset
    31
  def user_font(idx: Int, i: Byte): Byte = { check_range(i); (i + (4 + idx) * plain_range).toByte }
a0701669d159 clarified modules;
wenzelm
parents:
diff changeset
    32
  val hidden: Byte = (6 * plain_range).toByte
67128
4d91b6d5d49c clarified control style;
wenzelm
parents: 67127
diff changeset
    33
  val control: Byte = (hidden + JEditToken.DIGIT).toByte
65258
a0701669d159 clarified modules;
wenzelm
parents:
diff changeset
    34
a0701669d159 clarified modules;
wenzelm
parents:
diff changeset
    35
  private def font_style(style: SyntaxStyle, f: Font => Font): SyntaxStyle =
a0701669d159 clarified modules;
wenzelm
parents:
diff changeset
    36
    new SyntaxStyle(style.getForegroundColor, style.getBackgroundColor, f(style.getFont))
a0701669d159 clarified modules;
wenzelm
parents:
diff changeset
    37
a0701669d159 clarified modules;
wenzelm
parents:
diff changeset
    38
  private def script_style(style: SyntaxStyle, i: Int): SyntaxStyle =
a0701669d159 clarified modules;
wenzelm
parents:
diff changeset
    39
  {
a0701669d159 clarified modules;
wenzelm
parents:
diff changeset
    40
    font_style(style, font0 =>
a0701669d159 clarified modules;
wenzelm
parents:
diff changeset
    41
      {
a0701669d159 clarified modules;
wenzelm
parents:
diff changeset
    42
        import scala.collection.JavaConversions._
a0701669d159 clarified modules;
wenzelm
parents:
diff changeset
    43
        val font1 = font0.deriveFont(Map(TextAttribute.SUPERSCRIPT -> new java.lang.Integer(i)))
a0701669d159 clarified modules;
wenzelm
parents:
diff changeset
    44
a0701669d159 clarified modules;
wenzelm
parents:
diff changeset
    45
        def shift(y: Float): Font =
a0701669d159 clarified modules;
wenzelm
parents:
diff changeset
    46
          GUI.transform_font(font1, AffineTransform.getTranslateInstance(0.0, y.toDouble))
a0701669d159 clarified modules;
wenzelm
parents:
diff changeset
    47
a0701669d159 clarified modules;
wenzelm
parents:
diff changeset
    48
        val m0 = GUI.line_metrics(font0)
a0701669d159 clarified modules;
wenzelm
parents:
diff changeset
    49
        val m1 = GUI.line_metrics(font1)
a0701669d159 clarified modules;
wenzelm
parents:
diff changeset
    50
        val a = m1.getAscent - m0.getAscent
a0701669d159 clarified modules;
wenzelm
parents:
diff changeset
    51
        val b = (m1.getDescent + m1.getLeading) - (m0.getDescent + m0.getLeading)
a0701669d159 clarified modules;
wenzelm
parents:
diff changeset
    52
        if (a > 0.0f) shift(a)
a0701669d159 clarified modules;
wenzelm
parents:
diff changeset
    53
        else if (b > 0.0f) shift(- b)
a0701669d159 clarified modules;
wenzelm
parents:
diff changeset
    54
        else font1
a0701669d159 clarified modules;
wenzelm
parents:
diff changeset
    55
      })
a0701669d159 clarified modules;
wenzelm
parents:
diff changeset
    56
  }
a0701669d159 clarified modules;
wenzelm
parents:
diff changeset
    57
a0701669d159 clarified modules;
wenzelm
parents:
diff changeset
    58
  private def bold_style(style: SyntaxStyle): SyntaxStyle =
a0701669d159 clarified modules;
wenzelm
parents:
diff changeset
    59
    font_style(style, font => font.deriveFont(if (font.isBold) Font.PLAIN else Font.BOLD))
a0701669d159 clarified modules;
wenzelm
parents:
diff changeset
    60
a0701669d159 clarified modules;
wenzelm
parents:
diff changeset
    61
  val hidden_color: Color = new Color(255, 255, 255, 0)
a0701669d159 clarified modules;
wenzelm
parents:
diff changeset
    62
65261
034c49653a8e clarified initialization;
wenzelm
parents: 65259
diff changeset
    63
  object Extender extends SyntaxUtilities.StyleExtender
65258
a0701669d159 clarified modules;
wenzelm
parents:
diff changeset
    64
  {
a0701669d159 clarified modules;
wenzelm
parents:
diff changeset
    65
    val max_user_fonts = 2
a0701669d159 clarified modules;
wenzelm
parents:
diff changeset
    66
    if (Symbol.font_names.length > max_user_fonts)
a0701669d159 clarified modules;
wenzelm
parents:
diff changeset
    67
      error("Too many user symbol fonts (" + max_user_fonts + " permitted): " +
a0701669d159 clarified modules;
wenzelm
parents:
diff changeset
    68
        Symbol.font_names.mkString(", "))
a0701669d159 clarified modules;
wenzelm
parents:
diff changeset
    69
a0701669d159 clarified modules;
wenzelm
parents:
diff changeset
    70
    override def extendStyles(styles: Array[SyntaxStyle]): Array[SyntaxStyle] =
a0701669d159 clarified modules;
wenzelm
parents:
diff changeset
    71
    {
67128
4d91b6d5d49c clarified control style;
wenzelm
parents: 67127
diff changeset
    72
      val style0 = styles(0)
4d91b6d5d49c clarified control style;
wenzelm
parents: 67127
diff changeset
    73
      val font0 = style0.getFont
4d91b6d5d49c clarified control style;
wenzelm
parents: 67127
diff changeset
    74
4d91b6d5d49c clarified control style;
wenzelm
parents: 67127
diff changeset
    75
      val new_styles = Array.fill[SyntaxStyle](java.lang.Byte.MAX_VALUE)(styles(0))
65258
a0701669d159 clarified modules;
wenzelm
parents:
diff changeset
    76
      for (i <- 0 until plain_range) {
a0701669d159 clarified modules;
wenzelm
parents:
diff changeset
    77
        val style = styles(i)
a0701669d159 clarified modules;
wenzelm
parents:
diff changeset
    78
        new_styles(i) = style
a0701669d159 clarified modules;
wenzelm
parents:
diff changeset
    79
        new_styles(subscript(i.toByte)) = script_style(style, -1)
a0701669d159 clarified modules;
wenzelm
parents:
diff changeset
    80
        new_styles(superscript(i.toByte)) = script_style(style, 1)
a0701669d159 clarified modules;
wenzelm
parents:
diff changeset
    81
        new_styles(bold(i.toByte)) = bold_style(style)
a0701669d159 clarified modules;
wenzelm
parents:
diff changeset
    82
        for (idx <- 0 until max_user_fonts)
a0701669d159 clarified modules;
wenzelm
parents:
diff changeset
    83
          new_styles(user_font(idx, i.toByte)) = style
a0701669d159 clarified modules;
wenzelm
parents:
diff changeset
    84
        for ((family, idx) <- Symbol.font_index)
a0701669d159 clarified modules;
wenzelm
parents:
diff changeset
    85
          new_styles(user_font(idx, i.toByte)) = font_style(style, GUI.imitate_font(_, family))
a0701669d159 clarified modules;
wenzelm
parents:
diff changeset
    86
      }
a0701669d159 clarified modules;
wenzelm
parents:
diff changeset
    87
      new_styles(hidden) =
a0701669d159 clarified modules;
wenzelm
parents:
diff changeset
    88
        new SyntaxStyle(hidden_color, null,
67128
4d91b6d5d49c clarified control style;
wenzelm
parents: 67127
diff changeset
    89
          GUI.transform_font(new Font(font0.getFamily, 0, 1),
4d91b6d5d49c clarified control style;
wenzelm
parents: 67127
diff changeset
    90
            AffineTransform.getScaleInstance(1.0, font0.getSize.toDouble)))
4d91b6d5d49c clarified control style;
wenzelm
parents: 67127
diff changeset
    91
      new_styles(control) =
4d91b6d5d49c clarified control style;
wenzelm
parents: 67127
diff changeset
    92
        new SyntaxStyle(style0.getForegroundColor, style0.getBackgroundColor,
4d91b6d5d49c clarified control style;
wenzelm
parents: 67127
diff changeset
    93
          { val font_style =
4d91b6d5d49c clarified control style;
wenzelm
parents: 67127
diff changeset
    94
              (if (font0.isItalic) 0 else Font.ITALIC) |
4d91b6d5d49c clarified control style;
wenzelm
parents: 67127
diff changeset
    95
              (if (font0.isBold) 0 else Font.BOLD)
4d91b6d5d49c clarified control style;
wenzelm
parents: 67127
diff changeset
    96
            new Font(font0.getFamily, font_style, font0.getSize) })
65258
a0701669d159 clarified modules;
wenzelm
parents:
diff changeset
    97
      new_styles
a0701669d159 clarified modules;
wenzelm
parents:
diff changeset
    98
    }
a0701669d159 clarified modules;
wenzelm
parents:
diff changeset
    99
  }
a0701669d159 clarified modules;
wenzelm
parents:
diff changeset
   100
67127
cf111622c9f8 font style for literal control symbols, notably for antiquotations;
wenzelm
parents: 67125
diff changeset
   101
  private def control_style(sym: String): Option[Byte => Byte] =
cf111622c9f8 font style for literal control symbols, notably for antiquotations;
wenzelm
parents: 67125
diff changeset
   102
    if (sym == Symbol.sub_decoded) Some(subscript(_))
cf111622c9f8 font style for literal control symbols, notably for antiquotations;
wenzelm
parents: 67125
diff changeset
   103
    else if (sym == Symbol.sup_decoded) Some(superscript(_))
cf111622c9f8 font style for literal control symbols, notably for antiquotations;
wenzelm
parents: 67125
diff changeset
   104
    else if (sym == Symbol.bold_decoded) Some(bold(_))
cf111622c9f8 font style for literal control symbols, notably for antiquotations;
wenzelm
parents: 67125
diff changeset
   105
    else None
cf111622c9f8 font style for literal control symbols, notably for antiquotations;
wenzelm
parents: 67125
diff changeset
   106
65258
a0701669d159 clarified modules;
wenzelm
parents:
diff changeset
   107
  def extended(text: CharSequence): Map[Text.Offset, Byte => Byte] =
a0701669d159 clarified modules;
wenzelm
parents:
diff changeset
   108
  {
a0701669d159 clarified modules;
wenzelm
parents:
diff changeset
   109
    var result = Map[Text.Offset, Byte => Byte]()
a0701669d159 clarified modules;
wenzelm
parents:
diff changeset
   110
    def mark(start: Text.Offset, stop: Text.Offset, style: Byte => Byte)
a0701669d159 clarified modules;
wenzelm
parents:
diff changeset
   111
    {
a0701669d159 clarified modules;
wenzelm
parents:
diff changeset
   112
      for (i <- start until stop) result += (i -> style)
a0701669d159 clarified modules;
wenzelm
parents:
diff changeset
   113
    }
67127
cf111622c9f8 font style for literal control symbols, notably for antiquotations;
wenzelm
parents: 67125
diff changeset
   114
65258
a0701669d159 clarified modules;
wenzelm
parents:
diff changeset
   115
    var offset = 0
67128
4d91b6d5d49c clarified control style;
wenzelm
parents: 67127
diff changeset
   116
    var control_sym = ""
65258
a0701669d159 clarified modules;
wenzelm
parents:
diff changeset
   117
    for (sym <- Symbol.iterator(text)) {
67127
cf111622c9f8 font style for literal control symbols, notably for antiquotations;
wenzelm
parents: 67125
diff changeset
   118
      val end_offset = offset + sym.length
cf111622c9f8 font style for literal control symbols, notably for antiquotations;
wenzelm
parents: 67125
diff changeset
   119
67128
4d91b6d5d49c clarified control style;
wenzelm
parents: 67127
diff changeset
   120
      if (control_style(sym).isDefined) control_sym = sym
4d91b6d5d49c clarified control style;
wenzelm
parents: 67127
diff changeset
   121
      else if (control_sym != "") {
66006
cec184536dfd uniform notion of Symbol.is_controllable (see also 265d9300d523);
wenzelm
parents: 65997
diff changeset
   122
        if (Symbol.is_controllable(sym) && !Symbol.fonts.isDefinedAt(sym)) {
67128
4d91b6d5d49c clarified control style;
wenzelm
parents: 67127
diff changeset
   123
          mark(offset - control_sym.length, offset, _ => hidden)
4d91b6d5d49c clarified control style;
wenzelm
parents: 67127
diff changeset
   124
          mark(offset, end_offset, control_style(control_sym).get)
65258
a0701669d159 clarified modules;
wenzelm
parents:
diff changeset
   125
        }
67128
4d91b6d5d49c clarified control style;
wenzelm
parents: 67127
diff changeset
   126
        control_sym = ""
65258
a0701669d159 clarified modules;
wenzelm
parents:
diff changeset
   127
      }
67127
cf111622c9f8 font style for literal control symbols, notably for antiquotations;
wenzelm
parents: 67125
diff changeset
   128
cf111622c9f8 font style for literal control symbols, notably for antiquotations;
wenzelm
parents: 67125
diff changeset
   129
      if (Symbol.is_control_encoded(sym)) {
cf111622c9f8 font style for literal control symbols, notably for antiquotations;
wenzelm
parents: 67125
diff changeset
   130
        val a = offset + Symbol.control_prefix.length
cf111622c9f8 font style for literal control symbols, notably for antiquotations;
wenzelm
parents: 67125
diff changeset
   131
        val b = end_offset - Symbol.control_suffix.length
cf111622c9f8 font style for literal control symbols, notably for antiquotations;
wenzelm
parents: 67125
diff changeset
   132
        mark(offset, a, _ => hidden)
67128
4d91b6d5d49c clarified control style;
wenzelm
parents: 67127
diff changeset
   133
        mark(a, b, _ => control)
67127
cf111622c9f8 font style for literal control symbols, notably for antiquotations;
wenzelm
parents: 67125
diff changeset
   134
        mark(b, end_offset, _ => hidden)
cf111622c9f8 font style for literal control symbols, notably for antiquotations;
wenzelm
parents: 67125
diff changeset
   135
      }
cf111622c9f8 font style for literal control symbols, notably for antiquotations;
wenzelm
parents: 67125
diff changeset
   136
65258
a0701669d159 clarified modules;
wenzelm
parents:
diff changeset
   137
      Symbol.lookup_font(sym) match {
67127
cf111622c9f8 font style for literal control symbols, notably for antiquotations;
wenzelm
parents: 67125
diff changeset
   138
        case Some(idx) => mark(offset, end_offset, user_font(idx, _))
65258
a0701669d159 clarified modules;
wenzelm
parents:
diff changeset
   139
        case _ =>
a0701669d159 clarified modules;
wenzelm
parents:
diff changeset
   140
      }
67127
cf111622c9f8 font style for literal control symbols, notably for antiquotations;
wenzelm
parents: 67125
diff changeset
   141
cf111622c9f8 font style for literal control symbols, notably for antiquotations;
wenzelm
parents: 67125
diff changeset
   142
      offset = end_offset
65258
a0701669d159 clarified modules;
wenzelm
parents:
diff changeset
   143
    }
67127
cf111622c9f8 font style for literal control symbols, notably for antiquotations;
wenzelm
parents: 67125
diff changeset
   144
65258
a0701669d159 clarified modules;
wenzelm
parents:
diff changeset
   145
    result
a0701669d159 clarified modules;
wenzelm
parents:
diff changeset
   146
  }
65259
41d12227d5dc clarified modules;
wenzelm
parents: 65258
diff changeset
   147
41d12227d5dc clarified modules;
wenzelm
parents: 65258
diff changeset
   148
41d12227d5dc clarified modules;
wenzelm
parents: 65258
diff changeset
   149
  /* editing support for control symbols */
41d12227d5dc clarified modules;
wenzelm
parents: 65258
diff changeset
   150
41d12227d5dc clarified modules;
wenzelm
parents: 65258
diff changeset
   151
  def edit_control_style(text_area: TextArea, control: String)
41d12227d5dc clarified modules;
wenzelm
parents: 65258
diff changeset
   152
  {
41d12227d5dc clarified modules;
wenzelm
parents: 65258
diff changeset
   153
    GUI_Thread.assert {}
41d12227d5dc clarified modules;
wenzelm
parents: 65258
diff changeset
   154
41d12227d5dc clarified modules;
wenzelm
parents: 65258
diff changeset
   155
    val buffer = text_area.getBuffer
41d12227d5dc clarified modules;
wenzelm
parents: 65258
diff changeset
   156
67130
b023f64e0d16 tuned signature;
wenzelm
parents: 67128
diff changeset
   157
    val control_decoded = Isabelle_Encoding.perhaps_decode(buffer, control)
65259
41d12227d5dc clarified modules;
wenzelm
parents: 65258
diff changeset
   158
41d12227d5dc clarified modules;
wenzelm
parents: 65258
diff changeset
   159
    def update_style(text: String): String =
41d12227d5dc clarified modules;
wenzelm
parents: 65258
diff changeset
   160
    {
41d12227d5dc clarified modules;
wenzelm
parents: 65258
diff changeset
   161
      val result = new StringBuilder
65997
e3dc9ea67a62 output control symbols like ML version, with optionally hidden source;
wenzelm
parents: 65265
diff changeset
   162
      for (sym <- Symbol.iterator(text) if !HTML.is_control(sym)) {
65259
41d12227d5dc clarified modules;
wenzelm
parents: 65258
diff changeset
   163
        if (Symbol.is_controllable(sym)) result ++= control_decoded
41d12227d5dc clarified modules;
wenzelm
parents: 65258
diff changeset
   164
        result ++= sym
41d12227d5dc clarified modules;
wenzelm
parents: 65258
diff changeset
   165
      }
41d12227d5dc clarified modules;
wenzelm
parents: 65258
diff changeset
   166
      result.toString
41d12227d5dc clarified modules;
wenzelm
parents: 65258
diff changeset
   167
    }
41d12227d5dc clarified modules;
wenzelm
parents: 65258
diff changeset
   168
41d12227d5dc clarified modules;
wenzelm
parents: 65258
diff changeset
   169
    text_area.getSelection.foreach(sel => {
41d12227d5dc clarified modules;
wenzelm
parents: 65258
diff changeset
   170
      val before = JEdit_Lib.point_range(buffer, sel.getStart - 1)
67014
e6a695d6a6b2 tuned signature;
wenzelm
parents: 66006
diff changeset
   171
      JEdit_Lib.get_text(buffer, before) match {
65997
e3dc9ea67a62 output control symbols like ML version, with optionally hidden source;
wenzelm
parents: 65265
diff changeset
   172
        case Some(s) if HTML.is_control(s) =>
65259
41d12227d5dc clarified modules;
wenzelm
parents: 65258
diff changeset
   173
          text_area.extendSelection(before.start, before.stop)
41d12227d5dc clarified modules;
wenzelm
parents: 65258
diff changeset
   174
        case _ =>
41d12227d5dc clarified modules;
wenzelm
parents: 65258
diff changeset
   175
      }
41d12227d5dc clarified modules;
wenzelm
parents: 65258
diff changeset
   176
    })
41d12227d5dc clarified modules;
wenzelm
parents: 65258
diff changeset
   177
41d12227d5dc clarified modules;
wenzelm
parents: 65258
diff changeset
   178
    text_area.getSelection.toList match {
41d12227d5dc clarified modules;
wenzelm
parents: 65258
diff changeset
   179
      case Nil =>
41d12227d5dc clarified modules;
wenzelm
parents: 65258
diff changeset
   180
        text_area.setSelectedText(control_decoded)
41d12227d5dc clarified modules;
wenzelm
parents: 65258
diff changeset
   181
      case sels =>
41d12227d5dc clarified modules;
wenzelm
parents: 65258
diff changeset
   182
        JEdit_Lib.buffer_edit(buffer) {
41d12227d5dc clarified modules;
wenzelm
parents: 65258
diff changeset
   183
          sels.foreach(sel =>
41d12227d5dc clarified modules;
wenzelm
parents: 65258
diff changeset
   184
            text_area.setSelectedText(sel, update_style(text_area.getSelectedText(sel))))
41d12227d5dc clarified modules;
wenzelm
parents: 65258
diff changeset
   185
        }
41d12227d5dc clarified modules;
wenzelm
parents: 65258
diff changeset
   186
    }
41d12227d5dc clarified modules;
wenzelm
parents: 65258
diff changeset
   187
  }
65258
a0701669d159 clarified modules;
wenzelm
parents:
diff changeset
   188
}