src/Tools/jEdit/src/rendering.scala
author wenzelm
Thu Apr 14 22:55:53 2016 +0200 (2016-04-14)
changeset 62986 9d2fae6b31cc
parent 62806 de9bf8171626
child 62988 224e8d8a4fb8
permissions -rw-r--r--
background color for entity def/ref focus;
     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
    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_keyword && token.source == Symbol.comment_decoded) JEditToken.NULL
    98     else if (token.is_delimiter) JEditToken.OPERATOR
    99     else token_style(token.kind)
   100 
   101 
   102   /* Isabelle/ML token markup */
   103 
   104   private val ml_token_style: Map[ML_Lex.Kind.Value, Byte] =
   105   {
   106     import JEditToken._
   107     Map[ML_Lex.Kind.Value, Byte](
   108       ML_Lex.Kind.KEYWORD -> NULL,
   109       ML_Lex.Kind.IDENT -> NULL,
   110       ML_Lex.Kind.LONG_IDENT -> NULL,
   111       ML_Lex.Kind.TYPE_VAR -> NULL,
   112       ML_Lex.Kind.WORD -> DIGIT,
   113       ML_Lex.Kind.INT -> DIGIT,
   114       ML_Lex.Kind.REAL -> DIGIT,
   115       ML_Lex.Kind.CHAR -> LITERAL2,
   116       ML_Lex.Kind.STRING -> LITERAL1,
   117       ML_Lex.Kind.SPACE -> NULL,
   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_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 breakpoint_elements = Markup.Elements(Markup.ML_BREAKPOINT)
   153 
   154   private val caret_focus_elements = Markup.Elements(Markup.ENTITY)
   155 
   156   private val highlight_elements =
   157     Markup.Elements(Markup.EXPRESSION, Markup.CITATION, Markup.LANGUAGE, Markup.ML_TYPING,
   158       Markup.TOKEN_RANGE, Markup.ENTITY, Markup.PATH, Markup.DOC, Markup.URL, Markup.SORTING,
   159       Markup.TYPING, Markup.FREE, Markup.SKOLEM, Markup.BOUND,
   160       Markup.VAR, Markup.TFREE, Markup.TVAR, Markup.ML_BREAKPOINT,
   161       Markup.MARKDOWN_PARAGRAPH, Markup.Markdown_List.name)
   162 
   163   private val hyperlink_elements =
   164     Markup.Elements(Markup.ENTITY, Markup.PATH, Markup.DOC, Markup.POSITION,
   165       Markup.CITATION, Markup.URL)
   166 
   167   private val active_elements =
   168     Markup.Elements(Markup.DIALOG, Markup.BROWSER, Markup.GRAPHVIEW,
   169       Markup.SENDBACK, Markup.SIMP_TRACE_PANEL)
   170 
   171   private val tooltip_message_elements =
   172     Markup.Elements(Markup.WRITELN, Markup.INFORMATION, Markup.WARNING, Markup.LEGACY, Markup.ERROR,
   173       Markup.BAD)
   174 
   175   private val tooltip_descriptions =
   176     Map(
   177       Markup.CITATION -> "citation",
   178       Markup.TOKEN_RANGE -> "inner syntax token",
   179       Markup.FREE -> "free variable",
   180       Markup.SKOLEM -> "skolem variable",
   181       Markup.BOUND -> "bound variable",
   182       Markup.VAR -> "schematic variable",
   183       Markup.TFREE -> "free type variable",
   184       Markup.TVAR -> "schematic type variable")
   185 
   186   private val tooltip_elements =
   187     Markup.Elements(Markup.LANGUAGE, Markup.EXPRESSION, Markup.TIMING, Markup.ENTITY,
   188       Markup.SORTING, Markup.TYPING, Markup.ML_TYPING, Markup.ML_BREAKPOINT, Markup.PATH,
   189       Markup.DOC, Markup.URL, Markup.MARKDOWN_PARAGRAPH, Markup.Markdown_List.name) ++
   190     Markup.Elements(tooltip_descriptions.keySet)
   191 
   192   private val gutter_elements =
   193     Markup.Elements(Markup.WRITELN, Markup.INFORMATION, Markup.WARNING, Markup.LEGACY, Markup.ERROR)
   194 
   195   private val squiggly_elements =
   196     Markup.Elements(Markup.WRITELN, Markup.INFORMATION, Markup.WARNING, Markup.LEGACY, Markup.ERROR)
   197 
   198   private val line_background_elements =
   199     Markup.Elements(Markup.WRITELN_MESSAGE, Markup.STATE_MESSAGE, Markup.INFORMATION_MESSAGE,
   200       Markup.TRACING_MESSAGE, Markup.WARNING_MESSAGE, Markup.LEGACY_MESSAGE,
   201       Markup.ERROR_MESSAGE)
   202 
   203   private val separator_elements =
   204     Markup.Elements(Markup.SEPARATOR)
   205 
   206   private val background_elements =
   207     Protocol.proper_status_elements + Markup.WRITELN_MESSAGE +
   208       Markup.STATE_MESSAGE + Markup.INFORMATION_MESSAGE +
   209       Markup.TRACING_MESSAGE + Markup.WARNING_MESSAGE +
   210       Markup.LEGACY_MESSAGE + Markup.ERROR_MESSAGE +
   211       Markup.BAD + Markup.INTENSIFY + Markup.ENTITY +
   212       Markup.Markdown_Item.name ++ active_elements
   213 
   214   private val foreground_elements =
   215     Markup.Elements(Markup.STRING, Markup.ALT_STRING, Markup.VERBATIM,
   216       Markup.CARTOUCHE, Markup.ANTIQUOTED)
   217 
   218   private val bullet_elements =
   219     Markup.Elements(Markup.BULLET, Markup.ML_BREAKPOINT)
   220 
   221   private val fold_depth_elements =
   222     Markup.Elements(Markup.TEXT_FOLD, Markup.GOAL, Markup.SUBGOAL)
   223 }
   224 
   225 
   226 class Rendering private(val snapshot: Document.Snapshot, val options: Options)
   227 {
   228   override def toString: String = "Rendering(" + snapshot.toString + ")"
   229 
   230 
   231   /* colors */
   232 
   233   def color_value(s: String): Color = Color_Value(options.string(s))
   234 
   235   val outdated_color = color_value("outdated_color")
   236   val unprocessed_color = color_value("unprocessed_color")
   237   val unprocessed1_color = color_value("unprocessed1_color")
   238   val running_color = color_value("running_color")
   239   val running1_color = color_value("running1_color")
   240   val bullet_color = color_value("bullet_color")
   241   val tooltip_color = color_value("tooltip_color")
   242   val writeln_color = color_value("writeln_color")
   243   val information_color = color_value("information_color")
   244   val warning_color = color_value("warning_color")
   245   val legacy_color = color_value("legacy_color")
   246   val error_color = color_value("error_color")
   247   val writeln_message_color = color_value("writeln_message_color")
   248   val information_message_color = color_value("information_message_color")
   249   val tracing_message_color = color_value("tracing_message_color")
   250   val warning_message_color = color_value("warning_message_color")
   251   val legacy_message_color = color_value("legacy_message_color")
   252   val error_message_color = color_value("error_message_color")
   253   val spell_checker_color = color_value("spell_checker_color")
   254   val bad_color = color_value("bad_color")
   255   val intensify_color = color_value("intensify_color")
   256   val entity_def_color = color_value("entity_def_color")
   257   val entity_ref_color = color_value("entity_ref_color")
   258   val breakpoint_disabled_color = color_value("breakpoint_disabled_color")
   259   val breakpoint_enabled_color = color_value("breakpoint_enabled_color")
   260   val caret_debugger_color = color_value("caret_debugger_color")
   261   val quoted_color = color_value("quoted_color")
   262   val antiquoted_color = color_value("antiquoted_color")
   263   val antiquote_color = color_value("antiquote_color")
   264   val highlight_color = color_value("highlight_color")
   265   val hyperlink_color = color_value("hyperlink_color")
   266   val active_color = color_value("active_color")
   267   val active_hover_color = color_value("active_hover_color")
   268   val active_result_color = color_value("active_result_color")
   269   val keyword1_color = color_value("keyword1_color")
   270   val keyword2_color = color_value("keyword2_color")
   271   val keyword3_color = color_value("keyword3_color")
   272   val quasi_keyword_color = color_value("quasi_keyword_color")
   273   val improper_color = color_value("improper_color")
   274   val operator_color = color_value("operator_color")
   275   val caret_invisible_color = color_value("caret_invisible_color")
   276   val completion_color = color_value("completion_color")
   277   val search_color = color_value("search_color")
   278 
   279   val tfree_color = color_value("tfree_color")
   280   val tvar_color = color_value("tvar_color")
   281   val free_color = color_value("free_color")
   282   val skolem_color = color_value("skolem_color")
   283   val bound_color = color_value("bound_color")
   284   val var_color = color_value("var_color")
   285   val inner_numeral_color = color_value("inner_numeral_color")
   286   val inner_quoted_color = color_value("inner_quoted_color")
   287   val inner_cartouche_color = color_value("inner_cartouche_color")
   288   val inner_comment_color = color_value("inner_comment_color")
   289   val dynamic_color = color_value("dynamic_color")
   290 
   291   val markdown_item_color1 = color_value("markdown_item_color1")
   292   val markdown_item_color2 = color_value("markdown_item_color2")
   293   val markdown_item_color3 = color_value("markdown_item_color3")
   294   val markdown_item_color4 = color_value("markdown_item_color4")
   295 
   296 
   297   /* completion */
   298 
   299   def semantic_completion(completed_range: Option[Text.Range], range: Text.Range)
   300       : Option[Text.Info[Completion.Semantic]] =
   301     if (snapshot.is_outdated) None
   302     else {
   303       snapshot.select(range, Rendering.semantic_completion_elements, _ =>
   304         {
   305           case Completion.Semantic.Info(info) =>
   306             completed_range match {
   307               case Some(range0) if range0.contains(info.range) && range0 != info.range => None
   308               case _ => Some(info)
   309             }
   310           case _ => None
   311         }).headOption.map(_.info)
   312     }
   313 
   314   def language_context(range: Text.Range): Option[Completion.Language_Context] =
   315     snapshot.select(range, Rendering.language_context_elements, _ =>
   316       {
   317         case Text.Info(_, XML.Elem(Markup.Language(language, symbols, antiquotes, delimited), _)) =>
   318           if (delimited) Some(Completion.Language_Context(language, symbols, antiquotes))
   319           else None
   320         case Text.Info(_, elem)
   321         if elem.name == Markup.ML_STRING || elem.name == Markup.ML_COMMENT =>
   322           Some(Completion.Language_Context.ML_inner)
   323         case Text.Info(_, _) =>
   324           Some(Completion.Language_Context.inner)
   325       }).headOption.map(_.info)
   326 
   327   def language_path(range: Text.Range): Option[Text.Range] =
   328     snapshot.select(range, Rendering.language_elements, _ =>
   329       {
   330         case Text.Info(info_range, XML.Elem(Markup.Language(Markup.Language.PATH, _, _, _), _)) =>
   331           Some(snapshot.convert(info_range))
   332         case _ => None
   333       }).headOption.map(_.info)
   334 
   335   def citation(range: Text.Range): Option[Text.Info[String]] =
   336     snapshot.select(range, Rendering.citation_elements, _ =>
   337       {
   338         case Text.Info(info_range, XML.Elem(Markup.Citation(name), _)) =>
   339           Some(Text.Info(snapshot.convert(info_range), name))
   340         case _ => None
   341       }).headOption.map(_.info)
   342 
   343 
   344   /* spell checker */
   345 
   346   private lazy val spell_checker_elements =
   347     Markup.Elements(space_explode(',', options.string("spell_checker_elements")): _*)
   348 
   349   def spell_checker_ranges(range: Text.Range): List[Text.Range] =
   350     snapshot.select(range, spell_checker_elements, _ => _ => Some(())).map(_.range)
   351 
   352   def spell_checker_point(range: Text.Range): Option[Text.Range] =
   353     snapshot.select(range, spell_checker_elements, _ =>
   354       {
   355         case info => Some(snapshot.convert(info.range))
   356       }).headOption.map(_.info)
   357 
   358 
   359   /* breakpoints */
   360 
   361   def breakpoint(range: Text.Range): Option[(Command, Long)] =
   362     if (snapshot.is_outdated) None
   363     else
   364       snapshot.select(range, Rendering.breakpoint_elements, command_states =>
   365         {
   366           case Text.Info(_, Protocol.ML_Breakpoint(breakpoint)) =>
   367             command_states match {
   368               case st :: _ => Some((st.command, breakpoint))
   369               case _ => None
   370             }
   371           case _ => None
   372         }).headOption.map(_.info)
   373 
   374 
   375   /* command status overview */
   376 
   377   def overview_color(range: Text.Range): Option[Color] =
   378   {
   379     if (snapshot.is_outdated) None
   380     else {
   381       val results =
   382         snapshot.cumulate[List[Markup]](range, Nil, Protocol.liberal_status_elements, _ =>
   383           {
   384             case (status, Text.Info(_, elem)) => Some(elem.markup :: status)
   385           }, status = true)
   386       if (results.isEmpty) None
   387       else {
   388         val status = Protocol.Status.make(results.iterator.flatMap(_.info))
   389 
   390         if (status.is_running) Some(running_color)
   391         else if (status.is_failed) Some(error_color)
   392         else if (status.is_warned) Some(warning_color)
   393         else if (status.is_unprocessed) Some(unprocessed_color)
   394         else None
   395       }
   396     }
   397   }
   398 
   399 
   400   /* caret focus */
   401 
   402   def caret_focus(caret_range: Text.Range, visible_range: Text.Range): Set[Long] =
   403   {
   404     val focus_results =
   405       snapshot.cumulate[Set[Long]](caret_range, Set.empty, Rendering.caret_focus_elements, _ =>
   406           {
   407             case (serials, Text.Info(_, XML.Elem(Markup(Markup.ENTITY, props), _))) =>
   408               props match {
   409                 case Markup.Entity.Def(i) => Some(serials + i)
   410                 case Markup.Entity.Ref(i) => Some(serials + i)
   411                 case _ => None
   412               }
   413             case _ => None
   414           })
   415     val focus = (Set.empty[Long] /: focus_results){ case (s1, Text.Info(_, s2)) => s1 ++ s2 }
   416 
   417     val visible =
   418       focus.nonEmpty &&
   419         snapshot.cumulate[Boolean](visible_range, false, Rendering.caret_focus_elements, _ =>
   420             {
   421               case (_, Text.Info(_, XML.Elem(Markup(Markup.ENTITY, props), _))) =>
   422                 props match {
   423                   case Markup.Entity.Def(i) if focus(i) => Some(true)
   424                   case _ => None
   425                 }
   426             }).exists({ case Text.Info(_, visible) => visible })
   427     if (visible) focus else Set.empty[Long]
   428   }
   429 
   430 
   431   /* highlighted area */
   432 
   433   def highlight(range: Text.Range): Option[Text.Info[Color]] =
   434     snapshot.select(range, Rendering.highlight_elements, _ =>
   435       {
   436         case info => Some(Text.Info(snapshot.convert(info.range), highlight_color))
   437       }).headOption.map(_.info)
   438 
   439 
   440   /* hyperlinks */
   441 
   442   private def jedit_file(name: String): String =
   443     if (Path.is_valid(name))
   444       PIDE.resources.append(snapshot.node_name.master_dir, Path.explode(name))
   445     else name
   446 
   447   def hyperlink(range: Text.Range): Option[Text.Info[PIDE.editor.Hyperlink]] =
   448   {
   449     snapshot.cumulate[Vector[Text.Info[PIDE.editor.Hyperlink]]](
   450       range, Vector.empty, Rendering.hyperlink_elements, _ =>
   451         {
   452           case (links, Text.Info(info_range, XML.Elem(Markup.Path(name), _))) =>
   453             val link = PIDE.editor.hyperlink_file(true, jedit_file(name))
   454             Some(links :+ Text.Info(snapshot.convert(info_range), link))
   455 
   456           case (links, Text.Info(info_range, XML.Elem(Markup.Doc(name), _))) =>
   457             PIDE.editor.hyperlink_doc(name).map(link =>
   458               (links :+ Text.Info(snapshot.convert(info_range), link)))
   459 
   460           case (links, Text.Info(info_range, XML.Elem(Markup.Url(name), _))) =>
   461             val link = PIDE.editor.hyperlink_url(name)
   462             Some(links :+ Text.Info(snapshot.convert(info_range), link))
   463 
   464           case (links, Text.Info(info_range, XML.Elem(Markup(Markup.ENTITY, props), _)))
   465           if !props.exists(
   466             { case (Markup.KIND, Markup.ML_OPEN) => true
   467               case (Markup.KIND, Markup.ML_STRUCTURE) => true
   468               case _ => false }) =>
   469             val opt_link = PIDE.editor.hyperlink_def_position(true, snapshot, props)
   470             opt_link.map(link => links :+ Text.Info(snapshot.convert(info_range), link))
   471 
   472           case (links, Text.Info(info_range, XML.Elem(Markup(Markup.POSITION, props), _))) =>
   473             val opt_link = PIDE.editor.hyperlink_position(true, snapshot, props)
   474             opt_link.map(link => links :+ Text.Info(snapshot.convert(info_range), link))
   475 
   476           case (links, Text.Info(info_range, XML.Elem(Markup.Citation(name), _))) =>
   477             val opt_link =
   478               Bibtex_JEdit.entries_iterator.collectFirst(
   479                 { case (a, buffer, offset) if a == name =>
   480                     PIDE.editor.hyperlink_buffer(true, buffer, offset) })
   481             opt_link.map(link => links :+ Text.Info(snapshot.convert(info_range), link))
   482 
   483           case _ => None
   484         }) match { case Text.Info(_, _ :+ info) :: _ => Some(info) case _ => None }
   485   }
   486 
   487 
   488   /* active elements */
   489 
   490   def active(range: Text.Range): Option[Text.Info[XML.Elem]] =
   491     snapshot.select(range, Rendering.active_elements, command_states =>
   492       {
   493         case Text.Info(info_range, elem) =>
   494           if (elem.name == Markup.DIALOG) {
   495             elem match {
   496               case Protocol.Dialog(_, serial, _)
   497               if !command_states.exists(st => st.results.defined(serial)) =>
   498                 Some(Text.Info(snapshot.convert(info_range), elem))
   499               case _ => None
   500             }
   501           }
   502           else Some(Text.Info(snapshot.convert(info_range), elem))
   503       }).headOption.map(_.info)
   504 
   505   def command_results(range: Text.Range): Command.Results =
   506     Command.State.merge_results(
   507       snapshot.select[List[Command.State]](range, Markup.Elements.full, command_states =>
   508         { case _ => Some(command_states) }).flatMap(_.info))
   509 
   510 
   511   /* tooltip messages */
   512 
   513   def tooltip_message(range: Text.Range): Option[Text.Info[XML.Body]] =
   514   {
   515     val results =
   516       snapshot.cumulate[List[Text.Info[Command.Results.Entry]]](
   517         range, Nil, Rendering.tooltip_message_elements, _ =>
   518         {
   519           case (msgs, Text.Info(info_range, msg @ XML.Elem(Markup(Markup.BAD, _), body)))
   520           if body.nonEmpty =>
   521             val entry: Command.Results.Entry = (Document_ID.make(), msg)
   522             Some(Text.Info(snapshot.convert(info_range), entry) :: msgs)
   523 
   524           case (msgs, Text.Info(info_range,
   525             XML.Elem(Markup(name, props @ Markup.Serial(serial)), body))) =>
   526             val entry: Command.Results.Entry =
   527               serial -> XML.Elem(Markup(Markup.message(name), props), body)
   528             Some(Text.Info(snapshot.convert(info_range), entry) :: msgs)
   529 
   530           case _ => None
   531         }).flatMap(_.info)
   532     if (results.isEmpty) None
   533     else {
   534       val r = Text.Range(results.head.range.start, results.last.range.stop)
   535       val msgs = Command.Results.make(results.map(_.info))
   536       Some(Text.Info(r, Pretty.separate(msgs.iterator.map(_._2).toList)))
   537     }
   538   }
   539 
   540 
   541   /* tooltips */
   542 
   543   private def pretty_typing(kind: String, body: XML.Body): XML.Tree =
   544     Pretty.block(XML.Text(kind) :: Pretty.brk(1) :: body)
   545 
   546   private def timing_threshold: Double = options.real("jedit_timing_threshold")
   547 
   548   def tooltip(range: Text.Range): Option[Text.Info[XML.Body]] =
   549   {
   550     def add(prev: Text.Info[(Timing, Vector[(Boolean, XML.Tree)])],
   551       r0: Text.Range, p: (Boolean, XML.Tree)): Text.Info[(Timing, Vector[(Boolean, XML.Tree)])] =
   552     {
   553       val r = snapshot.convert(r0)
   554       val (t, info) = prev.info
   555       if (prev.range == r)
   556         Text.Info(r, (t, info :+ p))
   557       else Text.Info(r, (t, Vector(p)))
   558     }
   559 
   560     val results =
   561       snapshot.cumulate[Text.Info[(Timing, Vector[(Boolean, XML.Tree)])]](
   562         range, Text.Info(range, (Timing.zero, Vector.empty)), Rendering.tooltip_elements, _ =>
   563         {
   564           case (Text.Info(r, (t1, info)), Text.Info(_, XML.Elem(Markup.Timing(t2), _))) =>
   565             Some(Text.Info(r, (t1 + t2, info)))
   566 
   567           case (prev, Text.Info(r, XML.Elem(Markup.Entity(kind, name), _))) =>
   568             val kind1 = Word.implode(Word.explode('_', kind))
   569             val txt1 =
   570               if (name == "") kind1
   571               else kind1 + " " + quote(name)
   572             val t = prev.info._1
   573             val txt2 =
   574               if (kind == Markup.COMMAND && t.elapsed.seconds >= timing_threshold)
   575                 "\n" + t.message
   576               else ""
   577             Some(add(prev, r, (true, XML.Text(txt1 + txt2))))
   578 
   579           case (prev, Text.Info(r, XML.Elem(Markup.Path(name), _))) =>
   580             val file = jedit_file(name)
   581             val text =
   582               if (name == file) "file " + quote(file)
   583               else "path " + quote(name) + "\nfile " + quote(file)
   584             Some(add(prev, r, (true, XML.Text(text))))
   585 
   586           case (prev, Text.Info(r, XML.Elem(Markup.Doc(name), _))) =>
   587             val text = "doc " + quote(name)
   588             Some(add(prev, r, (true, XML.Text(text))))
   589 
   590           case (prev, Text.Info(r, XML.Elem(Markup.Url(name), _))) =>
   591             Some(add(prev, r, (true, XML.Text("URL " + quote(name)))))
   592 
   593           case (prev, Text.Info(r, XML.Elem(Markup(name, _), body)))
   594           if name == Markup.SORTING || name == Markup.TYPING =>
   595             Some(add(prev, r, (true, pretty_typing("::", body))))
   596 
   597           case (prev, Text.Info(r, XML.Elem(Markup(Markup.ML_TYPING, _), body))) =>
   598             Some(add(prev, r, (false, pretty_typing("ML:", body))))
   599 
   600           case (prev, Text.Info(r, Protocol.ML_Breakpoint(breakpoint))) =>
   601             val text =
   602               if (Debugger.breakpoint_state(breakpoint)) "breakpoint (enabled)"
   603               else "breakpoint (disabled)"
   604             Some(add(prev, r, (true, XML.Text(text))))
   605 
   606           case (prev, Text.Info(r, XML.Elem(Markup.Language(language, _, _, _), _))) =>
   607             val lang = Word.implode(Word.explode('_', language))
   608             Some(add(prev, r, (true, XML.Text("language: " + lang))))
   609 
   610           case (prev, Text.Info(r, XML.Elem(Markup.Expression(kind), _))) =>
   611             val descr = if (kind == "") "expression" else "expression: " + kind
   612             Some(add(prev, r, (true, XML.Text(descr))))
   613 
   614           case (prev, Text.Info(r, XML.Elem(Markup(Markup.MARKDOWN_PARAGRAPH, _), _))) =>
   615             Some(add(prev, r, (true, XML.Text("Markdown: paragraph"))))
   616           case (prev, Text.Info(r, XML.Elem(Markup.Markdown_List(kind), _))) =>
   617             Some(add(prev, r, (true, XML.Text("Markdown: " + kind))))
   618 
   619           case (prev, Text.Info(r, XML.Elem(Markup(name, _), _))) =>
   620             Rendering.tooltip_descriptions.get(name).
   621               map(descr => add(prev, r, (true, XML.Text(descr))))
   622         }).map(_.info)
   623 
   624     results.map(_.info).flatMap(res => res._2.toList) match {
   625       case Nil => None
   626       case tips =>
   627         val r = Text.Range(results.head.range.start, results.last.range.stop)
   628         val all_tips = (tips.filter(_._1) ++ tips.filter(!_._1).lastOption.toList).map(_._2)
   629         Some(Text.Info(r, Library.separate(Pretty.fbrk, all_tips)))
   630     }
   631   }
   632 
   633   def tooltip_margin: Int = options.int("jedit_tooltip_margin")
   634 
   635   lazy val tooltip_close_icon = JEdit_Lib.load_icon(options.string("tooltip_close_icon"))
   636   lazy val tooltip_detach_icon = JEdit_Lib.load_icon(options.string("tooltip_detach_icon"))
   637 
   638 
   639   /* gutter */
   640 
   641   private def gutter_message_pri(msg: XML.Tree): Int =
   642     if (Protocol.is_error(msg)) Rendering.error_pri
   643     else if (Protocol.is_legacy(msg)) Rendering.legacy_pri
   644     else if (Protocol.is_warning(msg)) Rendering.warning_pri
   645     else if (Protocol.is_information(msg)) Rendering.information_pri
   646     else 0
   647 
   648   private lazy val gutter_message_content = Map(
   649     Rendering.information_pri ->
   650       (JEdit_Lib.load_icon(options.string("gutter_information_icon")), information_message_color),
   651     Rendering.warning_pri ->
   652       (JEdit_Lib.load_icon(options.string("gutter_warning_icon")), warning_message_color),
   653     Rendering.legacy_pri ->
   654       (JEdit_Lib.load_icon(options.string("gutter_legacy_icon")), warning_message_color),
   655     Rendering.error_pri ->
   656       (JEdit_Lib.load_icon(options.string("gutter_error_icon")), error_message_color))
   657 
   658   def gutter_content(range: Text.Range): Option[(Icon, Color)] =
   659   {
   660     val pris =
   661       snapshot.cumulate[Int](range, 0, Rendering.gutter_elements, _ =>
   662         {
   663           case (pri, Text.Info(_, msg @ XML.Elem(Markup(_, Markup.Serial(serial)), _))) =>
   664             Some(pri max gutter_message_pri(msg))
   665           case _ => None
   666         }).map(_.info)
   667 
   668     gutter_message_content.get((0 /: pris)(_ max _))
   669   }
   670 
   671 
   672   /* squiggly underline */
   673 
   674   private lazy val squiggly_colors = Map(
   675     Rendering.writeln_pri -> writeln_color,
   676     Rendering.information_pri -> information_color,
   677     Rendering.warning_pri -> warning_color,
   678     Rendering.legacy_pri -> legacy_color,
   679     Rendering.error_pri -> error_color)
   680 
   681   def squiggly_underline(range: Text.Range): List[Text.Info[Color]] =
   682   {
   683     val results =
   684       snapshot.cumulate[Int](range, 0, Rendering.squiggly_elements, _ =>
   685         {
   686           case (pri, Text.Info(_, elem)) => Some(pri max Rendering.message_pri(elem.name))
   687         })
   688     for {
   689       Text.Info(r, pri) <- results
   690       color <- squiggly_colors.get(pri)
   691     } yield Text.Info(r, color)
   692   }
   693 
   694 
   695   /* message output */
   696 
   697   private lazy val message_colors = Map(
   698     Rendering.writeln_pri -> writeln_message_color,
   699     Rendering.information_pri -> information_message_color,
   700     Rendering.tracing_pri -> tracing_message_color,
   701     Rendering.warning_pri -> warning_message_color,
   702     Rendering.legacy_pri -> legacy_message_color,
   703     Rendering.error_pri -> error_message_color)
   704 
   705   def line_background(range: Text.Range): Option[(Color, Boolean)] =
   706   {
   707     val results =
   708       snapshot.cumulate[Int](range, 0, Rendering.line_background_elements, _ =>
   709         {
   710           case (pri, Text.Info(_, elem)) => Some(pri max Rendering.message_pri(elem.name))
   711         })
   712     val pri = (0 /: results) { case (p1, Text.Info(_, p2)) => p1 max p2 }
   713 
   714     message_colors.get(pri).map(message_color =>
   715       {
   716         val is_separator =
   717           snapshot.cumulate[Boolean](range, false, Rendering.separator_elements, _ =>
   718             {
   719               case _ => Some(true)
   720             }).exists(_.info)
   721         (message_color, is_separator)
   722       })
   723   }
   724 
   725   def output_messages(results: Command.Results): List[XML.Tree] =
   726   {
   727     val (states, other) =
   728       results.iterator.map(_._2).filterNot(Protocol.is_result(_)).toList
   729         .partition(Protocol.is_state(_))
   730     states ::: other
   731   }
   732 
   733 
   734   /* text background */
   735 
   736   def background(range: Text.Range, focus: Set[Long]): List[Text.Info[Color]] =
   737   {
   738     for {
   739       Text.Info(r, result) <-
   740         snapshot.cumulate[(List[Markup], Option[Color])](
   741           range, (List(Markup.Empty), None), Rendering.background_elements,
   742           command_states =>
   743             {
   744               case (((status, color), Text.Info(_, XML.Elem(markup, _))))
   745               if status.nonEmpty && Protocol.proper_status_elements(markup.name) =>
   746                 Some((markup :: status, color))
   747               case (_, Text.Info(_, XML.Elem(Markup(Markup.BAD, _), _))) =>
   748                 Some((Nil, Some(bad_color)))
   749               case (_, Text.Info(_, XML.Elem(Markup(Markup.INTENSIFY, _), _))) =>
   750                 Some((Nil, Some(intensify_color)))
   751               case (_, Text.Info(_, XML.Elem(Markup(Markup.ENTITY, props), _))) =>
   752                 props match {
   753                   case Markup.Entity.Def(i) if focus(i) =>
   754                     Some((Nil, Some(entity_def_color)))
   755                   case Markup.Entity.Ref(i) if focus(i) =>
   756                     Some((Nil, Some(entity_ref_color)))
   757                   case _ => None
   758                 }
   759               case (_, Text.Info(_, XML.Elem(Markup.Markdown_Item(depth), _))) =>
   760                 val color =
   761                   depth match {
   762                     case 1 => markdown_item_color1
   763                     case 2 => markdown_item_color2
   764                     case 3 => markdown_item_color3
   765                     case _ => markdown_item_color4
   766                   }
   767                 Some((Nil, Some(color)))
   768               case (acc, Text.Info(_, Protocol.Dialog(_, serial, result))) =>
   769                 command_states.collectFirst(
   770                   { case st if st.results.defined(serial) => st.results.get(serial).get }) match
   771                 {
   772                   case Some(Protocol.Dialog_Result(res)) if res == result =>
   773                     Some((Nil, Some(active_result_color)))
   774                   case _ =>
   775                     Some((Nil, Some(active_color)))
   776                 }
   777               case (_, Text.Info(_, elem)) =>
   778                 if (Rendering.active_elements(elem.name)) Some((Nil, Some(active_color)))
   779                 else None
   780             })
   781       color <-
   782         (result match {
   783           case (markups, opt_color) if markups.nonEmpty =>
   784             val status = Protocol.Status.make(markups.iterator)
   785             if (status.is_unprocessed) Some(unprocessed1_color)
   786             else if (status.is_running) Some(running1_color)
   787             else opt_color
   788           case (_, opt_color) => opt_color
   789         })
   790     } yield Text.Info(r, color)
   791   }
   792 
   793 
   794   /* text foreground */
   795 
   796   def foreground(range: Text.Range): List[Text.Info[Color]] =
   797     snapshot.select(range, Rendering.foreground_elements, _ =>
   798       {
   799         case Text.Info(_, elem) =>
   800           if (elem.name == Markup.ANTIQUOTED) Some(antiquoted_color) else Some(quoted_color)
   801       })
   802 
   803 
   804   /* text color */
   805 
   806   val foreground_color = jEdit.getColorProperty("view.fgColor")
   807 
   808   private lazy val text_colors: Map[String, Color] = Map(
   809       Markup.KEYWORD1 -> keyword1_color,
   810       Markup.KEYWORD2 -> keyword2_color,
   811       Markup.KEYWORD3 -> keyword3_color,
   812       Markup.QUASI_KEYWORD -> quasi_keyword_color,
   813       Markup.IMPROPER -> improper_color,
   814       Markup.OPERATOR -> operator_color,
   815       Markup.STRING -> foreground_color,
   816       Markup.ALT_STRING -> foreground_color,
   817       Markup.VERBATIM -> foreground_color,
   818       Markup.CARTOUCHE -> foreground_color,
   819       Markup.LITERAL -> keyword1_color,
   820       Markup.DELIMITER -> foreground_color,
   821       Markup.TFREE -> tfree_color,
   822       Markup.TVAR -> tvar_color,
   823       Markup.FREE -> free_color,
   824       Markup.SKOLEM -> skolem_color,
   825       Markup.BOUND -> bound_color,
   826       Markup.VAR -> var_color,
   827       Markup.INNER_STRING -> inner_quoted_color,
   828       Markup.INNER_CARTOUCHE -> inner_cartouche_color,
   829       Markup.INNER_COMMENT -> inner_comment_color,
   830       Markup.DYNAMIC_FACT -> dynamic_color,
   831       Markup.ANTIQUOTE -> antiquote_color,
   832       Markup.ML_KEYWORD1 -> keyword1_color,
   833       Markup.ML_KEYWORD2 -> keyword2_color,
   834       Markup.ML_KEYWORD3 -> keyword3_color,
   835       Markup.ML_DELIMITER -> foreground_color,
   836       Markup.ML_NUMERAL -> inner_numeral_color,
   837       Markup.ML_CHAR -> inner_quoted_color,
   838       Markup.ML_STRING -> inner_quoted_color,
   839       Markup.ML_COMMENT -> inner_comment_color,
   840       Markup.SML_STRING -> inner_quoted_color,
   841       Markup.SML_COMMENT -> inner_comment_color)
   842 
   843   private lazy val text_color_elements =
   844     Markup.Elements(text_colors.keySet)
   845 
   846   def text_color(range: Text.Range, color: Color): List[Text.Info[Color]] =
   847   {
   848     if (color == Token_Markup.hidden_color) List(Text.Info(range, color))
   849     else
   850       snapshot.cumulate(range, color, text_color_elements, _ =>
   851         {
   852           case (_, Text.Info(_, elem)) => text_colors.get(elem.name)
   853         })
   854   }
   855 
   856 
   857   /* virtual bullets */
   858 
   859   def bullet(range: Text.Range): List[Text.Info[Color]] =
   860     snapshot.select(range, Rendering.bullet_elements, _ =>
   861       {
   862         case Text.Info(_, Protocol.ML_Breakpoint(breakpoint)) =>
   863           Debugger.active_breakpoint_state(breakpoint).map(b =>
   864             if (b) breakpoint_enabled_color else breakpoint_disabled_color)
   865         case _ => Some(bullet_color)
   866       })
   867 
   868 
   869   /* text folds */
   870 
   871   def fold_depth(range: Text.Range): List[Text.Info[Int]] =
   872     snapshot.cumulate[Int](range, 0, Rendering.fold_depth_elements, _ =>
   873       {
   874         case (depth, _) => Some(depth + 1)
   875       })
   876 }