src/Tools/jEdit/src/rendering.scala
author wenzelm
Mon Aug 10 14:13:49 2015 +0200 (2015-08-10)
changeset 60874 7865e03a7fc1
parent 60215 5fb4990dfc73
child 60876 52edced9cce5
permissions -rw-r--r--
tuned signature;
     1 /*  Title:      Tools/jEdit/src/rendering.scala
     2     Author:     Makarius
     3 
     4 Isabelle-specific implementation of quasi-abstract rendering and
     5 markup interpretation.
     6 */
     7 
     8 package isabelle.jedit
     9 
    10 
    11 import isabelle._
    12 
    13 import java.awt.Color
    14 import javax.swing.Icon
    15 
    16 import org.gjt.sp.jedit.syntax.{Token => JEditToken}
    17 import org.gjt.sp.jedit.{jEdit, View}
    18 
    19 import scala.collection.immutable.SortedMap
    20 
    21 
    22 object Rendering
    23 {
    24   def apply(snapshot: Document.Snapshot, options: Options): Rendering =
    25     new Rendering(snapshot, options)
    26 
    27 
    28   /* message priorities */
    29 
    30   private val state_pri = 1
    31   private val writeln_pri = 2
    32   private val information_pri = 3
    33   private val tracing_pri = 4
    34   private val warning_pri = 5
    35   private val legacy_pri = 6
    36   private val error_pri = 7
    37 
    38   private val message_pri = Map(
    39     Markup.STATE -> state_pri,
    40     Markup.STATE_MESSAGE -> state_pri,
    41     Markup.WRITELN -> writeln_pri,
    42     Markup.WRITELN_MESSAGE -> writeln_pri,
    43     Markup.INFORMATION -> information_pri,
    44     Markup.INFORMATION_MESSAGE -> information_pri,
    45     Markup.TRACING -> tracing_pri,
    46     Markup.TRACING_MESSAGE -> tracing_pri,
    47     Markup.WARNING -> warning_pri,
    48     Markup.WARNING_MESSAGE -> warning_pri,
    49     Markup.LEGACY -> legacy_pri,
    50     Markup.LEGACY_MESSAGE -> legacy_pri,
    51     Markup.ERROR -> error_pri,
    52     Markup.ERROR_MESSAGE -> error_pri)
    53 
    54 
    55   /* popup window bounds */
    56 
    57   def popup_bounds: Double = (PIDE.options.real("jedit_popup_bounds") max 0.2) min 0.8
    58 
    59 
    60   /* Isabelle/Isar token markup */
    61 
    62   private val command_style: Map[String, Byte] =
    63   {
    64     import JEditToken._
    65     Map[String, Byte](
    66       Keyword.THY_END -> KEYWORD2,
    67       Keyword.PRF_ASM -> KEYWORD3,
    68       Keyword.PRF_ASM_GOAL -> KEYWORD3
    69     ).withDefaultValue(KEYWORD1)
    70   }
    71 
    72   private val token_style: Map[Token.Kind.Value, Byte] =
    73   {
    74     import JEditToken._
    75     Map[Token.Kind.Value, Byte](
    76       Token.Kind.KEYWORD -> KEYWORD2,
    77       Token.Kind.IDENT -> NULL,
    78       Token.Kind.LONG_IDENT -> NULL,
    79       Token.Kind.SYM_IDENT -> NULL,
    80       Token.Kind.VAR -> NULL,
    81       Token.Kind.TYPE_IDENT -> NULL,
    82       Token.Kind.TYPE_VAR -> NULL,
    83       Token.Kind.NAT -> NULL,
    84       Token.Kind.FLOAT -> NULL,
    85       Token.Kind.SPACE -> NULL,
    86       Token.Kind.STRING -> LITERAL1,
    87       Token.Kind.ALT_STRING -> LITERAL2,
    88       Token.Kind.VERBATIM -> COMMENT3,
    89       Token.Kind.CARTOUCHE -> COMMENT4,
    90       Token.Kind.COMMENT -> COMMENT1,
    91       Token.Kind.ERROR -> INVALID
    92     ).withDefaultValue(NULL)
    93   }
    94 
    95   def token_markup(syntax: Outer_Syntax, token: Token): Byte =
    96     if (token.is_command) command_style(syntax.keywords.command_kind(token.content).getOrElse(""))
    97     else if (token.is_delimiter) JEditToken.OPERATOR
    98     else token_style(token.kind)
    99 
   100 
   101   /* Isabelle/ML token markup */
   102 
   103   private val ml_token_style: Map[ML_Lex.Kind.Value, Byte] =
   104   {
   105     import JEditToken._
   106     Map[ML_Lex.Kind.Value, Byte](
   107       ML_Lex.Kind.KEYWORD -> NULL,
   108       ML_Lex.Kind.IDENT -> NULL,
   109       ML_Lex.Kind.LONG_IDENT -> NULL,
   110       ML_Lex.Kind.TYPE_VAR -> NULL,
   111       ML_Lex.Kind.WORD -> DIGIT,
   112       ML_Lex.Kind.INT -> DIGIT,
   113       ML_Lex.Kind.REAL -> DIGIT,
   114       ML_Lex.Kind.CHAR -> LITERAL2,
   115       ML_Lex.Kind.STRING -> LITERAL1,
   116       ML_Lex.Kind.SPACE -> NULL,
   117       ML_Lex.Kind.CARTOUCHE -> COMMENT4,
   118       ML_Lex.Kind.COMMENT -> COMMENT1,
   119       ML_Lex.Kind.ANTIQ -> NULL,
   120       ML_Lex.Kind.ANTIQ_START -> LITERAL4,
   121       ML_Lex.Kind.ANTIQ_STOP -> LITERAL4,
   122       ML_Lex.Kind.ANTIQ_OTHER -> NULL,
   123       ML_Lex.Kind.ANTIQ_STRING -> NULL,
   124       ML_Lex.Kind.ANTIQ_ALT_STRING -> NULL,
   125       ML_Lex.Kind.ANTIQ_CARTOUCHE -> NULL,
   126       ML_Lex.Kind.ERROR -> INVALID
   127     ).withDefaultValue(NULL)
   128   }
   129 
   130   def ml_token_markup(token: ML_Lex.Token): Byte =
   131     if (!token.is_keyword) ml_token_style(token.kind)
   132     else if (token.is_delimiter) JEditToken.OPERATOR
   133     else if (ML_Lex.keywords2(token.source)) JEditToken.KEYWORD2
   134     else if (ML_Lex.keywords3(token.source)) JEditToken.KEYWORD3
   135     else JEditToken.KEYWORD1
   136 
   137 
   138   /* markup elements */
   139 
   140   private val semantic_completion_elements =
   141     Markup.Elements(Markup.COMPLETION, Markup.NO_COMPLETION)
   142 
   143   private val language_context_elements =
   144     Markup.Elements(Markup.STRING, Markup.ALT_STRING, Markup.VERBATIM,
   145       Markup.CARTOUCHE, Markup.COMMENT, Markup.LANGUAGE,
   146       Markup.ML_STRING, Markup.ML_CARTOUCHE, Markup.ML_COMMENT)
   147 
   148   private val language_elements = Markup.Elements(Markup.LANGUAGE)
   149 
   150   private val citation_elements = Markup.Elements(Markup.CITATION)
   151 
   152   private val highlight_elements =
   153     Markup.Elements(Markup.EXPRESSION, Markup.CITATION, Markup.LANGUAGE, Markup.ML_TYPING,
   154       Markup.TOKEN_RANGE, Markup.ENTITY, Markup.PATH, Markup.URL, Markup.SORTING,
   155       Markup.TYPING, Markup.FREE, Markup.SKOLEM, Markup.BOUND,
   156       Markup.VAR, Markup.TFREE, Markup.TVAR)
   157 
   158   private val hyperlink_elements =
   159     Markup.Elements(Markup.ENTITY, Markup.PATH, Markup.POSITION, Markup.CITATION, Markup.URL)
   160 
   161   private val active_elements =
   162     Markup.Elements(Markup.DIALOG, Markup.BROWSER, Markup.GRAPHVIEW,
   163       Markup.SENDBACK, Markup.SIMP_TRACE_PANEL)
   164 
   165   private val tooltip_message_elements =
   166     Markup.Elements(Markup.WRITELN, Markup.INFORMATION, Markup.WARNING, Markup.LEGACY, Markup.ERROR,
   167       Markup.BAD)
   168 
   169   private val tooltip_descriptions =
   170     Map(
   171       Markup.EXPRESSION -> "expression",
   172       Markup.CITATION -> "citation",
   173       Markup.TOKEN_RANGE -> "inner syntax token",
   174       Markup.FREE -> "free variable",
   175       Markup.SKOLEM -> "skolem variable",
   176       Markup.BOUND -> "bound variable",
   177       Markup.VAR -> "schematic variable",
   178       Markup.TFREE -> "free type variable",
   179       Markup.TVAR -> "schematic type variable")
   180 
   181   private val tooltip_elements =
   182     Markup.Elements(Markup.LANGUAGE, Markup.TIMING, Markup.ENTITY, Markup.SORTING,
   183       Markup.TYPING, Markup.ML_TYPING, Markup.PATH, Markup.URL) ++
   184     Markup.Elements(tooltip_descriptions.keySet)
   185 
   186   private val gutter_elements =
   187     Markup.Elements(Markup.WRITELN, Markup.INFORMATION, Markup.WARNING, Markup.LEGACY, Markup.ERROR)
   188 
   189   private val squiggly_elements =
   190     Markup.Elements(Markup.WRITELN, Markup.INFORMATION, Markup.WARNING, Markup.LEGACY, Markup.ERROR)
   191 
   192   private val line_background_elements =
   193     Markup.Elements(Markup.WRITELN_MESSAGE, Markup.STATE_MESSAGE, Markup.INFORMATION_MESSAGE,
   194       Markup.TRACING_MESSAGE, Markup.WARNING_MESSAGE, Markup.LEGACY_MESSAGE,
   195       Markup.ERROR_MESSAGE)
   196 
   197   private val separator_elements =
   198     Markup.Elements(Markup.SEPARATOR)
   199 
   200   private val background_elements =
   201     Protocol.proper_status_elements + Markup.WRITELN_MESSAGE +
   202       Markup.STATE_MESSAGE + Markup.INFORMATION_MESSAGE +
   203       Markup.TRACING_MESSAGE + Markup.WARNING_MESSAGE +
   204       Markup.LEGACY_MESSAGE + Markup.ERROR_MESSAGE +
   205       Markup.BAD + Markup.INTENSIFY ++ active_elements
   206 
   207   private val foreground_elements =
   208     Markup.Elements(Markup.STRING, Markup.ALT_STRING, Markup.VERBATIM,
   209       Markup.CARTOUCHE, Markup.ANTIQUOTED)
   210 
   211   private val bullet_elements =
   212     Markup.Elements(Markup.BULLET)
   213 
   214   private val fold_depth_elements =
   215     Markup.Elements(Markup.TEXT_FOLD, Markup.GOAL, Markup.SUBGOAL)
   216 }
   217 
   218 
   219 class Rendering private(val snapshot: Document.Snapshot, val options: Options)
   220 {
   221   override def toString: String = "Rendering(" + snapshot.toString + ")"
   222 
   223 
   224   /* colors */
   225 
   226   def color_value(s: String): Color = Color_Value(options.string(s))
   227 
   228   val outdated_color = color_value("outdated_color")
   229   val unprocessed_color = color_value("unprocessed_color")
   230   val unprocessed1_color = color_value("unprocessed1_color")
   231   val running_color = color_value("running_color")
   232   val running1_color = color_value("running1_color")
   233   val bullet_color = color_value("bullet_color")
   234   val tooltip_color = color_value("tooltip_color")
   235   val writeln_color = color_value("writeln_color")
   236   val information_color = color_value("information_color")
   237   val warning_color = color_value("warning_color")
   238   val legacy_color = color_value("legacy_color")
   239   val error_color = color_value("error_color")
   240   val writeln_message_color = color_value("writeln_message_color")
   241   val state_message_color = color_value("state_message_color")
   242   val information_message_color = color_value("information_message_color")
   243   val tracing_message_color = color_value("tracing_message_color")
   244   val warning_message_color = color_value("warning_message_color")
   245   val legacy_message_color = color_value("legacy_message_color")
   246   val error_message_color = color_value("error_message_color")
   247   val spell_checker_color = color_value("spell_checker_color")
   248   val bad_color = color_value("bad_color")
   249   val intensify_color = color_value("intensify_color")
   250   val quoted_color = color_value("quoted_color")
   251   val antiquoted_color = color_value("antiquoted_color")
   252   val antiquote_color = color_value("antiquote_color")
   253   val highlight_color = color_value("highlight_color")
   254   val hyperlink_color = color_value("hyperlink_color")
   255   val active_color = color_value("active_color")
   256   val active_hover_color = color_value("active_hover_color")
   257   val active_result_color = color_value("active_result_color")
   258   val keyword1_color = color_value("keyword1_color")
   259   val keyword2_color = color_value("keyword2_color")
   260   val keyword3_color = color_value("keyword3_color")
   261   val quasi_keyword_color = color_value("quasi_keyword_color")
   262   val improper_color = color_value("improper_color")
   263   val operator_color = color_value("operator_color")
   264   val caret_invisible_color = color_value("caret_invisible_color")
   265   val completion_color = color_value("completion_color")
   266   val search_color = color_value("search_color")
   267 
   268   val tfree_color = color_value("tfree_color")
   269   val tvar_color = color_value("tvar_color")
   270   val free_color = color_value("free_color")
   271   val skolem_color = color_value("skolem_color")
   272   val bound_color = color_value("bound_color")
   273   val var_color = color_value("var_color")
   274   val inner_numeral_color = color_value("inner_numeral_color")
   275   val inner_quoted_color = color_value("inner_quoted_color")
   276   val inner_cartouche_color = color_value("inner_cartouche_color")
   277   val inner_comment_color = color_value("inner_comment_color")
   278   val dynamic_color = color_value("dynamic_color")
   279 
   280 
   281   /* completion */
   282 
   283   def semantic_completion(range: Text.Range): Option[Text.Info[Completion.Semantic]] =
   284     if (snapshot.is_outdated) None
   285     else {
   286       snapshot.select(range, Rendering.semantic_completion_elements, _ =>
   287         {
   288           case Completion.Semantic.Info(info) => Some(info)
   289           case _ => None
   290         }).headOption.map(_.info)
   291     }
   292 
   293   def language_context(range: Text.Range): Option[Completion.Language_Context] =
   294     snapshot.select(range, Rendering.language_context_elements, _ =>
   295       {
   296         case Text.Info(_, XML.Elem(Markup.Language(language, symbols, antiquotes, delimited), _)) =>
   297           if (delimited) Some(Completion.Language_Context(language, symbols, antiquotes))
   298           else None
   299         case Text.Info(_, elem)
   300         if elem.name == Markup.ML_STRING ||
   301           elem.name == Markup.ML_CARTOUCHE ||
   302           elem.name == Markup.ML_COMMENT =>
   303           Some(Completion.Language_Context.ML_inner)
   304         case Text.Info(_, _) =>
   305           Some(Completion.Language_Context.inner)
   306       }).headOption.map(_.info)
   307 
   308   def language_path(range: Text.Range): Option[Text.Range] =
   309     snapshot.select(range, Rendering.language_elements, _ =>
   310       {
   311         case Text.Info(info_range, XML.Elem(Markup.Language(Markup.Language.PATH, _, _, _), _)) =>
   312           Some(snapshot.convert(info_range))
   313         case _ => None
   314       }).headOption.map(_.info)
   315 
   316   def citation(range: Text.Range): Option[Text.Info[String]] =
   317     snapshot.select(range, Rendering.citation_elements, _ =>
   318       {
   319         case Text.Info(info_range, XML.Elem(Markup.Citation(name), _)) =>
   320           Some(Text.Info(snapshot.convert(info_range), name))
   321         case _ => None
   322       }).headOption.map(_.info)
   323 
   324 
   325   /* spell checker */
   326 
   327   private lazy val spell_checker_elements =
   328     Markup.Elements(space_explode(',', options.string("spell_checker_elements")): _*)
   329 
   330   def spell_checker_ranges(range: Text.Range): List[Text.Range] =
   331     snapshot.select(range, spell_checker_elements, _ => _ => Some(())).map(_.range)
   332 
   333   def spell_checker_point(range: Text.Range): Option[Text.Range] =
   334     snapshot.select(range, spell_checker_elements, _ =>
   335       {
   336         case info => Some(snapshot.convert(info.range))
   337       }).headOption.map(_.info)
   338 
   339 
   340   /* command status overview */
   341 
   342   def overview_limit: Int = options.int("jedit_text_overview_limit")
   343 
   344   def overview_color(range: Text.Range): Option[Color] =
   345   {
   346     if (snapshot.is_outdated) None
   347     else {
   348       val results =
   349         snapshot.cumulate[List[Markup]](range, Nil, Protocol.liberal_status_elements, _ =>
   350           {
   351             case (status, Text.Info(_, elem)) => Some(elem.markup :: status)
   352           }, status = true)
   353       if (results.isEmpty) None
   354       else {
   355         val status = Protocol.Status.make(results.iterator.flatMap(_.info))
   356 
   357         if (status.is_running) Some(running_color)
   358         else if (status.is_failed) Some(error_color)
   359         else if (status.is_warned) Some(warning_color)
   360         else if (status.is_unprocessed) Some(unprocessed_color)
   361         else None
   362       }
   363     }
   364   }
   365 
   366 
   367   /* highlighted area */
   368 
   369   def highlight(range: Text.Range): Option[Text.Info[Color]] =
   370     snapshot.select(range, Rendering.highlight_elements, _ =>
   371       {
   372         case info => Some(Text.Info(snapshot.convert(info.range), highlight_color))
   373       }).headOption.map(_.info)
   374 
   375 
   376   /* hyperlinks */
   377 
   378   private def jedit_file(name: String): String =
   379     if (Path.is_valid(name))
   380       PIDE.resources.append(snapshot.node_name.master_dir, Path.explode(name))
   381     else name
   382 
   383   def hyperlink(range: Text.Range): Option[Text.Info[PIDE.editor.Hyperlink]] =
   384   {
   385     snapshot.cumulate[Vector[Text.Info[PIDE.editor.Hyperlink]]](
   386       range, Vector.empty, Rendering.hyperlink_elements, _ =>
   387         {
   388           case (links, Text.Info(info_range, XML.Elem(Markup.Path(name), _))) =>
   389             val link = PIDE.editor.hyperlink_file(jedit_file(name))
   390             Some(links :+ Text.Info(snapshot.convert(info_range), link))
   391 
   392           case (links, Text.Info(info_range, XML.Elem(Markup.Url(name), _))) =>
   393             val link = PIDE.editor.hyperlink_url(name)
   394             Some(links :+ Text.Info(snapshot.convert(info_range), link))
   395 
   396           case (links, Text.Info(info_range, XML.Elem(Markup(Markup.ENTITY, props), _)))
   397           if !props.exists(
   398             { case (Markup.KIND, Markup.ML_OPEN) => true
   399               case (Markup.KIND, Markup.ML_STRUCTURE) => true
   400               case _ => false }) =>
   401             val opt_link = PIDE.editor.hyperlink_def_position(snapshot, props)
   402             opt_link.map(link => links :+ Text.Info(snapshot.convert(info_range), link))
   403 
   404           case (links, Text.Info(info_range, XML.Elem(Markup(Markup.POSITION, props), _))) =>
   405             val opt_link = PIDE.editor.hyperlink_position(snapshot, props)
   406             opt_link.map(link => links :+ Text.Info(snapshot.convert(info_range), link))
   407 
   408           case (links, Text.Info(info_range, XML.Elem(Markup.Citation(name), _))) =>
   409             val opt_link =
   410               Bibtex_JEdit.entries_iterator.collectFirst(
   411                 { case (a, buffer, offset) if a == name =>
   412                     PIDE.editor.hyperlink_buffer(buffer, offset) })
   413             opt_link.map(link => links :+ Text.Info(snapshot.convert(info_range), link))
   414 
   415           case _ => None
   416         }) match { case Text.Info(_, _ :+ info) :: _ => Some(info) case _ => None }
   417   }
   418 
   419 
   420   /* active elements */
   421 
   422   def active(range: Text.Range): Option[Text.Info[XML.Elem]] =
   423     snapshot.select(range, Rendering.active_elements, command_states =>
   424       {
   425         case Text.Info(info_range, elem) =>
   426           if (elem.name == Markup.DIALOG) {
   427             elem match {
   428               case Protocol.Dialog(_, serial, _)
   429               if !command_states.exists(st => st.results.defined(serial)) =>
   430                 Some(Text.Info(snapshot.convert(info_range), elem))
   431               case _ => None
   432             }
   433           }
   434           else Some(Text.Info(snapshot.convert(info_range), elem))
   435       }).headOption.map(_.info)
   436 
   437   def command_results(range: Text.Range): Command.Results =
   438     Command.State.merge_results(
   439       snapshot.select[List[Command.State]](range, Markup.Elements.full, command_states =>
   440         { case _ => Some(command_states) }).flatMap(_.info))
   441 
   442 
   443   /* tooltip messages */
   444 
   445   def tooltip_message(range: Text.Range): Option[Text.Info[XML.Body]] =
   446   {
   447     val results =
   448       snapshot.cumulate[List[Text.Info[Command.Results.Entry]]](
   449         range, Nil, Rendering.tooltip_message_elements, _ =>
   450         {
   451           case (msgs, Text.Info(info_range, msg @ XML.Elem(Markup(Markup.BAD, _), body)))
   452           if body.nonEmpty =>
   453             val entry: Command.Results.Entry = (Document_ID.make(), msg)
   454             Some(Text.Info(snapshot.convert(info_range), entry) :: msgs)
   455 
   456           case (msgs, Text.Info(info_range,
   457             XML.Elem(Markup(name, props @ Markup.Serial(serial)), body))) =>
   458             val entry: Command.Results.Entry =
   459               serial -> XML.Elem(Markup(Markup.message(name), props), body)
   460             Some(Text.Info(snapshot.convert(info_range), entry) :: msgs)
   461 
   462           case _ => None
   463         }).flatMap(_.info)
   464     if (results.isEmpty) None
   465     else {
   466       val r = Text.Range(results.head.range.start, results.last.range.stop)
   467       val msgs = Command.Results.make(results.map(_.info))
   468       Some(Text.Info(r, Pretty.separate(msgs.iterator.map(_._2).toList)))
   469     }
   470   }
   471 
   472 
   473   /* tooltips */
   474 
   475   private def pretty_typing(kind: String, body: XML.Body): XML.Tree =
   476     Pretty.block(XML.Text(kind) :: Pretty.Break(1) :: body)
   477 
   478   private def timing_threshold: Double = options.real("jedit_timing_threshold")
   479 
   480   def tooltip(range: Text.Range): Option[Text.Info[XML.Body]] =
   481   {
   482     def add(prev: Text.Info[(Timing, Vector[(Boolean, XML.Tree)])],
   483       r0: Text.Range, p: (Boolean, XML.Tree)): Text.Info[(Timing, Vector[(Boolean, XML.Tree)])] =
   484     {
   485       val r = snapshot.convert(r0)
   486       val (t, info) = prev.info
   487       if (prev.range == r)
   488         Text.Info(r, (t, info :+ p))
   489       else Text.Info(r, (t, Vector(p)))
   490     }
   491 
   492     val results =
   493       snapshot.cumulate[Text.Info[(Timing, Vector[(Boolean, XML.Tree)])]](
   494         range, Text.Info(range, (Timing.zero, Vector.empty)), Rendering.tooltip_elements, _ =>
   495         {
   496           case (Text.Info(r, (t1, info)), Text.Info(_, XML.Elem(Markup.Timing(t2), _))) =>
   497             Some(Text.Info(r, (t1 + t2, info)))
   498           case (prev, Text.Info(r, XML.Elem(Markup.Entity(kind, name), _))) =>
   499             val kind1 = Word.implode(Word.explode('_', kind))
   500             val txt1 =
   501               if (name == "") kind1
   502               else kind1 + " " + quote(name)
   503             val t = prev.info._1
   504             val txt2 =
   505               if (kind == Markup.COMMAND && t.elapsed.seconds >= timing_threshold)
   506                 "\n" + t.message
   507               else ""
   508             Some(add(prev, r, (true, XML.Text(txt1 + txt2))))
   509           case (prev, Text.Info(r, XML.Elem(Markup.Path(name), _))) =>
   510             val file = jedit_file(name)
   511             val text =
   512               if (name == file) "file " + quote(file)
   513               else "path " + quote(name) + "\nfile " + quote(file)
   514             Some(add(prev, r, (true, XML.Text(text))))
   515           case (prev, Text.Info(r, XML.Elem(Markup.Url(name), _))) =>
   516             Some(add(prev, r, (true, XML.Text("URL " + quote(name)))))
   517           case (prev, Text.Info(r, XML.Elem(Markup(name, _), body)))
   518           if name == Markup.SORTING || name == Markup.TYPING =>
   519             Some(add(prev, r, (true, pretty_typing("::", body))))
   520           case (prev, Text.Info(r, XML.Elem(Markup(Markup.ML_TYPING, _), body))) =>
   521             Some(add(prev, r, (false, pretty_typing("ML:", body))))
   522           case (prev, Text.Info(r, XML.Elem(Markup.Language(language, _, _, _), _))) =>
   523             Some(add(prev, r, (true, XML.Text("language: " + language))))
   524           case (prev, Text.Info(r, XML.Elem(Markup(name, _), _))) =>
   525             Rendering.tooltip_descriptions.get(name).
   526               map(descr => add(prev, r, (true, XML.Text(descr))))
   527         }).map(_.info)
   528 
   529     results.map(_.info).flatMap(res => res._2.toList) match {
   530       case Nil => None
   531       case tips =>
   532         val r = Text.Range(results.head.range.start, results.last.range.stop)
   533         val all_tips = (tips.filter(_._1) ++ tips.filter(!_._1).lastOption.toList).map(_._2)
   534         Some(Text.Info(r, Library.separate(Pretty.FBreak, all_tips)))
   535     }
   536   }
   537 
   538   def tooltip_margin: Int = options.int("jedit_tooltip_margin")
   539 
   540   lazy val tooltip_close_icon = JEdit_Lib.load_icon(options.string("tooltip_close_icon"))
   541   lazy val tooltip_detach_icon = JEdit_Lib.load_icon(options.string("tooltip_detach_icon"))
   542 
   543 
   544   /* gutter */
   545 
   546   private def gutter_message_pri(msg: XML.Tree): Int =
   547     if (Protocol.is_error(msg)) Rendering.error_pri
   548     else if (Protocol.is_legacy(msg)) Rendering.legacy_pri
   549     else if (Protocol.is_warning(msg)) Rendering.warning_pri
   550     else if (Protocol.is_information(msg)) Rendering.information_pri
   551     else 0
   552 
   553   private lazy val gutter_message_content = Map(
   554     Rendering.information_pri ->
   555       (JEdit_Lib.load_icon(options.string("gutter_information_icon")), information_message_color),
   556     Rendering.warning_pri ->
   557       (JEdit_Lib.load_icon(options.string("gutter_warning_icon")), warning_message_color),
   558     Rendering.legacy_pri ->
   559       (JEdit_Lib.load_icon(options.string("gutter_legacy_icon")), warning_message_color),
   560     Rendering.error_pri ->
   561       (JEdit_Lib.load_icon(options.string("gutter_error_icon")), error_message_color))
   562 
   563   def gutter_content(range: Text.Range): Option[(Icon, Color)] =
   564   {
   565     val pris =
   566       snapshot.cumulate[Int](range, 0, Rendering.gutter_elements, _ =>
   567         {
   568           case (pri, Text.Info(_, msg @ XML.Elem(Markup(_, Markup.Serial(serial)), _))) =>
   569             Some(pri max gutter_message_pri(msg))
   570           case _ => None
   571         }).map(_.info)
   572 
   573     gutter_message_content.get((0 /: pris)(_ max _))
   574   }
   575 
   576 
   577   /* squiggly underline */
   578 
   579   private lazy val squiggly_colors = Map(
   580     Rendering.writeln_pri -> writeln_color,
   581     Rendering.information_pri -> information_color,
   582     Rendering.warning_pri -> warning_color,
   583     Rendering.legacy_pri -> legacy_color,
   584     Rendering.error_pri -> error_color)
   585 
   586   def squiggly_underline(range: Text.Range): List[Text.Info[Color]] =
   587   {
   588     val results =
   589       snapshot.cumulate[Int](range, 0, Rendering.squiggly_elements, _ =>
   590         {
   591           case (pri, Text.Info(_, elem)) => Some(pri max Rendering.message_pri(elem.name))
   592         })
   593     for {
   594       Text.Info(r, pri) <- results
   595       color <- squiggly_colors.get(pri)
   596     } yield Text.Info(r, color)
   597   }
   598 
   599 
   600   /* message output */
   601 
   602   private lazy val message_colors = Map(
   603     Rendering.writeln_pri -> writeln_message_color,
   604     Rendering.state_pri -> state_message_color,
   605     Rendering.information_pri -> information_message_color,
   606     Rendering.tracing_pri -> tracing_message_color,
   607     Rendering.warning_pri -> warning_message_color,
   608     Rendering.legacy_pri -> legacy_message_color,
   609     Rendering.error_pri -> error_message_color)
   610 
   611   def line_background(range: Text.Range): Option[(Color, Boolean)] =
   612   {
   613     val results =
   614       snapshot.cumulate[Int](range, 0, Rendering.line_background_elements, _ =>
   615         {
   616           case (pri, Text.Info(_, elem)) => Some(pri max Rendering.message_pri(elem.name))
   617         })
   618     val pri = (0 /: results) { case (p1, Text.Info(_, p2)) => p1 max p2 }
   619 
   620     val is_separator =
   621       pri > 0 &&
   622       snapshot.cumulate[Boolean](range, false, Rendering.separator_elements, _ =>
   623         {
   624           case _ => Some(true)
   625         }).exists(_.info)
   626 
   627     message_colors.get(pri).map((_, is_separator))
   628   }
   629 
   630   def output_messages(results: Command.Results): List[XML.Tree] =
   631   {
   632     val (states, other) =
   633       results.iterator.map(_._2).filterNot(Protocol.is_result(_)).toList
   634         .partition(Protocol.is_state(_))
   635     states ::: other
   636   }
   637 
   638 
   639   /* text background */
   640 
   641   def background(range: Text.Range): List[Text.Info[Color]] =
   642   {
   643     if (snapshot.is_outdated && snapshot.is_loaded) List(Text.Info(range, outdated_color))
   644     else
   645       for {
   646         Text.Info(r, result) <-
   647           snapshot.cumulate[(List[Markup], Option[Color])](
   648             range, (List(Markup.Empty), None), Rendering.background_elements,
   649             command_states =>
   650               {
   651                 case (((status, color), Text.Info(_, XML.Elem(markup, _))))
   652                 if status.nonEmpty && Protocol.proper_status_elements(markup.name) =>
   653                   Some((markup :: status, color))
   654                 case (_, Text.Info(_, XML.Elem(Markup(Markup.BAD, _), _))) =>
   655                   Some((Nil, Some(bad_color)))
   656                 case (_, Text.Info(_, XML.Elem(Markup(Markup.INTENSIFY, _), _))) =>
   657                   Some((Nil, Some(intensify_color)))
   658                 case (acc, Text.Info(_, Protocol.Dialog(_, serial, result))) =>
   659                   command_states.collectFirst(
   660                     { case st if st.results.defined(serial) => st.results.get(serial).get }) match
   661                   {
   662                     case Some(Protocol.Dialog_Result(res)) if res == result =>
   663                       Some((Nil, Some(active_result_color)))
   664                     case _ =>
   665                       Some((Nil, Some(active_color)))
   666                   }
   667                 case (_, Text.Info(_, elem)) =>
   668                   if (Rendering.active_elements(elem.name)) Some((Nil, Some(active_color)))
   669                   else None
   670               })
   671         color <-
   672           (result match {
   673             case (markups, opt_color) if markups.nonEmpty =>
   674               val status = Protocol.Status.make(markups.iterator)
   675               if (status.is_unprocessed) Some(unprocessed1_color)
   676               else if (status.is_running) Some(running1_color)
   677               else opt_color
   678             case (_, opt_color) => opt_color
   679           })
   680       } yield Text.Info(r, color)
   681   }
   682 
   683 
   684   /* text foreground */
   685 
   686   def foreground(range: Text.Range): List[Text.Info[Color]] =
   687     snapshot.select(range, Rendering.foreground_elements, _ =>
   688       {
   689         case Text.Info(_, elem) =>
   690           if (elem.name == Markup.ANTIQUOTED) Some(antiquoted_color) else Some(quoted_color)
   691       })
   692 
   693 
   694   /* text color */
   695 
   696   private lazy val text_colors: Map[String, Color] = Map(
   697       Markup.KEYWORD1 -> keyword1_color,
   698       Markup.KEYWORD2 -> keyword2_color,
   699       Markup.KEYWORD3 -> keyword3_color,
   700       Markup.QUASI_KEYWORD -> quasi_keyword_color,
   701       Markup.IMPROPER -> improper_color,
   702       Markup.OPERATOR -> operator_color,
   703       Markup.STRING -> Color.BLACK,
   704       Markup.ALT_STRING -> Color.BLACK,
   705       Markup.VERBATIM -> Color.BLACK,
   706       Markup.CARTOUCHE -> Color.BLACK,
   707       Markup.LITERAL -> keyword1_color,
   708       Markup.DELIMITER -> Color.BLACK,
   709       Markup.TFREE -> tfree_color,
   710       Markup.TVAR -> tvar_color,
   711       Markup.FREE -> free_color,
   712       Markup.SKOLEM -> skolem_color,
   713       Markup.BOUND -> bound_color,
   714       Markup.VAR -> var_color,
   715       Markup.INNER_STRING -> inner_quoted_color,
   716       Markup.INNER_CARTOUCHE -> inner_cartouche_color,
   717       Markup.INNER_COMMENT -> inner_comment_color,
   718       Markup.DYNAMIC_FACT -> dynamic_color,
   719       Markup.ANTIQUOTE -> antiquote_color,
   720       Markup.ML_KEYWORD1 -> keyword1_color,
   721       Markup.ML_KEYWORD2 -> keyword2_color,
   722       Markup.ML_KEYWORD3 -> keyword3_color,
   723       Markup.ML_DELIMITER -> Color.BLACK,
   724       Markup.ML_NUMERAL -> inner_numeral_color,
   725       Markup.ML_CHAR -> inner_quoted_color,
   726       Markup.ML_STRING -> inner_quoted_color,
   727       Markup.ML_CARTOUCHE -> inner_cartouche_color,
   728       Markup.ML_COMMENT -> inner_comment_color,
   729       Markup.SML_STRING -> inner_quoted_color,
   730       Markup.SML_COMMENT -> inner_comment_color)
   731 
   732   private lazy val text_color_elements =
   733     Markup.Elements(text_colors.keySet)
   734 
   735   def text_color(range: Text.Range, color: Color): List[Text.Info[Color]] =
   736   {
   737     if (color == Token_Markup.hidden_color) List(Text.Info(range, color))
   738     else
   739       snapshot.cumulate(range, color, text_color_elements, _ =>
   740         {
   741           case (_, Text.Info(_, elem)) => text_colors.get(elem.name)
   742         })
   743   }
   744 
   745 
   746   /* virtual bullets */
   747 
   748   def bullet(range: Text.Range): List[Text.Info[Color]] =
   749     snapshot.select(range, Rendering.bullet_elements, _ => _ => Some(bullet_color))
   750 
   751 
   752   /* text folds */
   753 
   754   def fold_depth(range: Text.Range): List[Text.Info[Int]] =
   755     snapshot.cumulate[Int](range, 0, Rendering.fold_depth_elements, _ =>
   756       {
   757         case (depth, _) => Some(depth + 1)
   758       })
   759 }