src/Tools/jEdit/src/rendering.scala
author wenzelm
Fri Jun 28 14:05:12 2013 +0200 (2013-06-28 ago)
changeset 52471 ff0e0bb81597
parent 52102 59cc8881e911
child 52472 3a43a8b1ecb0
permissions -rw-r--r--
support for idea-icons (using ideaIC-129.354/platform/icons/src from IntelliJ IDEA Community Edition 12.1.2);
     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, GUIUtilities}
    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 writeln_pri = 1
    31   private val tracing_pri = 2
    32   private val warning_pri = 3
    33   private val legacy_pri = 4
    34   private val error_pri = 5
    35 
    36   private val message_pri = Map(
    37     Markup.WRITELN -> writeln_pri, Markup.WRITELN_MESSAGE -> writeln_pri,
    38     Markup.TRACING -> tracing_pri, Markup.TRACING_MESSAGE -> tracing_pri,
    39     Markup.WARNING -> warning_pri, Markup.WARNING_MESSAGE -> warning_pri,
    40     Markup.ERROR -> error_pri, Markup.ERROR_MESSAGE -> error_pri)
    41 
    42 
    43   /* icons */
    44 
    45   def load_icon(name: String): Icon =
    46   {
    47     val name1 =
    48       if (name.startsWith("idea-icons/")) {
    49         val file =
    50           Isabelle_System.platform_file_url(Path.explode("$JEDIT_HOME/dist/jars/idea-icons.jar"))
    51         "jar:" + file + "!/" + name
    52       }
    53       else name
    54     val icon = GUIUtilities.loadIcon(name1)
    55     if (icon.getIconWidth < 0 || icon.getIconHeight < 0) error("Bad icon: " + name)
    56     else icon
    57   }
    58 
    59   private val gutter_icons = Map(
    60     warning_pri -> load_icon("16x16/status/dialog-information.png"),
    61     legacy_pri -> load_icon("16x16/status/dialog-warning.png"),
    62     error_pri -> load_icon("16x16/status/dialog-error.png"))
    63 
    64   val tooltip_close_icon = load_icon("16x16/actions/document-close.png")
    65   val tooltip_detach_icon = load_icon("16x16/actions/window-new.png")
    66 
    67 
    68   /* jEdit font */
    69 
    70   def font_family(): String = jEdit.getProperty("view.font")
    71 
    72   def font_size(scale: String): Float =
    73     (jEdit.getIntegerProperty("view.fontsize", 16) * PIDE.options.real(scale)).toFloat
    74 
    75 
    76   /* token markup -- text styles */
    77 
    78   private val command_style: Map[String, Byte] =
    79   {
    80     import JEditToken._
    81     Map[String, Byte](
    82       Keyword.THY_END -> KEYWORD2,
    83       Keyword.THY_SCRIPT -> LABEL,
    84       Keyword.PRF_SCRIPT -> DIGIT,
    85       Keyword.PRF_ASM -> KEYWORD3,
    86       Keyword.PRF_ASM_GOAL -> KEYWORD3
    87     ).withDefaultValue(KEYWORD1)
    88   }
    89 
    90   private val token_style: Map[Token.Kind.Value, Byte] =
    91   {
    92     import JEditToken._
    93     Map[Token.Kind.Value, Byte](
    94       Token.Kind.KEYWORD -> KEYWORD2,
    95       Token.Kind.IDENT -> NULL,
    96       Token.Kind.LONG_IDENT -> NULL,
    97       Token.Kind.SYM_IDENT -> NULL,
    98       Token.Kind.VAR -> NULL,
    99       Token.Kind.TYPE_IDENT -> NULL,
   100       Token.Kind.TYPE_VAR -> NULL,
   101       Token.Kind.NAT -> NULL,
   102       Token.Kind.FLOAT -> NULL,
   103       Token.Kind.STRING -> LITERAL1,
   104       Token.Kind.ALT_STRING -> LITERAL2,
   105       Token.Kind.VERBATIM -> COMMENT3,
   106       Token.Kind.SPACE -> NULL,
   107       Token.Kind.COMMENT -> COMMENT1,
   108       Token.Kind.ERROR -> INVALID
   109     ).withDefaultValue(NULL)
   110   }
   111 
   112   def token_markup(syntax: Outer_Syntax, token: Token): Byte =
   113     if (token.is_command) command_style(syntax.keyword_kind(token.content).getOrElse(""))
   114     else if (token.is_operator) JEditToken.OPERATOR
   115     else token_style(token.kind)
   116 }
   117 
   118 
   119 class Rendering private(val snapshot: Document.Snapshot, val options: Options)
   120 {
   121   /* colors */
   122 
   123   def color_value(s: String): Color = Color_Value(options.string(s))
   124 
   125   val outdated_color = color_value("outdated_color")
   126   val unprocessed_color = color_value("unprocessed_color")
   127   val unprocessed1_color = color_value("unprocessed1_color")
   128   val running_color = color_value("running_color")
   129   val running1_color = color_value("running1_color")
   130   val light_color = color_value("light_color")
   131   val bullet_color = color_value("bullet_color")
   132   val tooltip_color = color_value("tooltip_color")
   133   val writeln_color = color_value("writeln_color")
   134   val warning_color = color_value("warning_color")
   135   val error_color = color_value("error_color")
   136   val error1_color = color_value("error1_color")
   137   val writeln_message_color = color_value("writeln_message_color")
   138   val tracing_message_color = color_value("tracing_message_color")
   139   val warning_message_color = color_value("warning_message_color")
   140   val error_message_color = color_value("error_message_color")
   141   val bad_color = color_value("bad_color")
   142   val intensify_color = color_value("intensify_color")
   143   val quoted_color = color_value("quoted_color")
   144   val antiquoted_color = color_value("antiquoted_color")
   145   val highlight_color = color_value("highlight_color")
   146   val hyperlink_color = color_value("hyperlink_color")
   147   val active_color = color_value("active_color")
   148   val active_hover_color = color_value("active_hover_color")
   149   val active_result_color = color_value("active_result_color")
   150   val keyword1_color = color_value("keyword1_color")
   151   val keyword2_color = color_value("keyword2_color")
   152 
   153   val tfree_color = color_value("tfree_color")
   154   val tvar_color = color_value("tvar_color")
   155   val free_color = color_value("free_color")
   156   val skolem_color = color_value("skolem_color")
   157   val bound_color = color_value("bound_color")
   158   val var_color = color_value("var_color")
   159   val inner_numeral_color = color_value("inner_numeral_color")
   160   val inner_quoted_color = color_value("inner_quoted_color")
   161   val inner_comment_color = color_value("inner_comment_color")
   162   val dynamic_color = color_value("dynamic_color")
   163 
   164 
   165   /* command overview */
   166 
   167   val overview_limit = options.int("jedit_text_overview_limit")
   168 
   169   private val overview_include = Protocol.command_status_markup + Markup.WARNING + Markup.ERROR
   170 
   171   def overview_color(range: Text.Range): Option[Color] =
   172   {
   173     if (snapshot.is_outdated) None
   174     else {
   175       val results =
   176         snapshot.cumulate_markup[(Protocol.Status, Int)](
   177           range, (Protocol.Status.init, 0), Some(overview_include), _ =>
   178           {
   179             case ((status, pri), Text.Info(_, XML.Elem(markup, _)))
   180             if overview_include(markup.name) =>
   181               if (markup.name == Markup.WARNING || markup.name == Markup.ERROR)
   182                 (status, pri max Rendering.message_pri(markup.name))
   183               else (Protocol.command_status(status, markup), pri)
   184           })
   185       if (results.isEmpty) None
   186       else {
   187         val (status, pri) =
   188           ((Protocol.Status.init, 0) /: results) {
   189             case ((s1, p1), Text.Info(_, (s2, p2))) => (s1 + s2, p1 max p2) }
   190 
   191         if (status.is_running) Some(running_color)
   192         else if (pri == Rendering.warning_pri) Some(warning_color)
   193         else if (pri == Rendering.error_pri) Some(error_color)
   194         else if (status.is_unprocessed) Some(unprocessed_color)
   195         else if (status.is_failed) Some(error_color)
   196         else None
   197       }
   198     }
   199   }
   200 
   201 
   202   /* markup selectors */
   203 
   204   private val highlight_include =
   205     Set(Markup.SORT, Markup.TYP, Markup.TERM, Markup.PROP, Markup.ML_TYPING, Markup.TOKEN_RANGE,
   206       Markup.ENTITY, Markup.PATH, Markup.SORTING, Markup.TYPING, Markup.FREE, Markup.SKOLEM,
   207       Markup.BOUND, Markup.VAR, Markup.TFREE, Markup.TVAR, Markup.ML_SOURCE, Markup.DOCUMENT_SOURCE)
   208 
   209   def highlight(range: Text.Range): Option[Text.Info[Color]] =
   210   {
   211     snapshot.select_markup(range, Some(highlight_include), _ =>
   212         {
   213           case Text.Info(info_range, XML.Elem(Markup(name, _), _)) if highlight_include(name) =>
   214             Text.Info(snapshot.convert(info_range), highlight_color)
   215         }) match { case Text.Info(_, info) #:: _ => Some(info) case _ => None }
   216   }
   217 
   218 
   219   private val hyperlink_include = Set(Markup.ENTITY, Markup.PATH)
   220 
   221   def hyperlink(range: Text.Range): Option[Text.Info[Hyperlink]] =
   222   {
   223     snapshot.cumulate_markup[List[Text.Info[Hyperlink]]](range, Nil, Some(hyperlink_include), _ =>
   224         {
   225           case (links, Text.Info(info_range, XML.Elem(Markup.Path(name), _)))
   226           if Path.is_ok(name) =>
   227             val jedit_file = PIDE.thy_load.append(snapshot.node_name.dir, Path.explode(name))
   228             Text.Info(snapshot.convert(info_range), Hyperlink(jedit_file, 0, 0)) :: links
   229 
   230           case (links, Text.Info(info_range, XML.Elem(Markup(Markup.ENTITY, props), _)))
   231           if !props.exists(
   232             { case (Markup.KIND, Markup.ML_OPEN) => true
   233               case (Markup.KIND, Markup.ML_STRUCT) => true
   234               case _ => false }) =>
   235 
   236             props match {
   237               case Position.Def_Line_File(line, name) if Path.is_ok(name) =>
   238                 Isabelle_System.source_file(Path.explode(name)) match {
   239                   case Some(path) =>
   240                     val jedit_file = Isabelle_System.platform_path(path)
   241                     Text.Info(snapshot.convert(info_range), Hyperlink(jedit_file, line, 0)) :: links
   242                   case None => links
   243                 }
   244 
   245               case Position.Def_Id_Offset(id, offset) =>
   246                 snapshot.state.find_command(snapshot.version, id) match {
   247                   case Some((node, command)) =>
   248                     val sources =
   249                       node.commands.iterator.takeWhile(_ != command).map(_.source) ++
   250                         Iterator.single(command.source(Text.Range(0, command.decode(offset))))
   251                     val (line, column) = ((1, 1) /: sources)(Symbol.advance_line_column)
   252                     Text.Info(snapshot.convert(info_range),
   253                       Hyperlink(command.node_name.node, line, column)) :: links
   254                   case None => links
   255                 }
   256 
   257               case _ => links
   258             }
   259         }) match { case Text.Info(_, info :: _) #:: _ => Some(info) case _ => None }
   260   }
   261 
   262 
   263   private val active_include =
   264     Set(Markup.BROWSER, Markup.GRAPHVIEW, Markup.SENDBACK, Markup.DIALOG)
   265 
   266   def active(range: Text.Range): Option[Text.Info[XML.Elem]] =
   267     snapshot.select_markup(range, Some(active_include), command_state =>
   268         {
   269           case Text.Info(info_range, elem @ Protocol.Dialog(_, serial, _))
   270           if !command_state.results.defined(serial) =>
   271             Text.Info(snapshot.convert(info_range), elem)
   272           case Text.Info(info_range, elem @ XML.Elem(Markup(name, _), _))
   273           if name == Markup.BROWSER || name == Markup.GRAPHVIEW || name == Markup.SENDBACK =>
   274             Text.Info(snapshot.convert(info_range), elem)
   275         }) match { case Text.Info(_, info) #:: _ => Some(info) case _ => None }
   276 
   277 
   278   def command_results(range: Text.Range): Command.Results =
   279   {
   280     val results =
   281       snapshot.select_markup[Command.Results](range, None, command_state =>
   282         { case _ => command_state.results }).map(_.info)
   283     (Command.Results.empty /: results)(_ ++ _)
   284   }
   285 
   286   def tooltip_message(range: Text.Range): Option[Text.Info[XML.Body]] =
   287   {
   288     val results =
   289       snapshot.cumulate_markup[List[Text.Info[Command.Results.Entry]]](range, Nil,
   290         Some(Set(Markup.WRITELN, Markup.WARNING, Markup.ERROR, Markup.BAD)), _ =>
   291         {
   292           case (msgs, Text.Info(info_range,
   293             XML.Elem(Markup(name, props @ Markup.Serial(serial)), body)))
   294           if name == Markup.WRITELN || name == Markup.WARNING || name == Markup.ERROR =>
   295             val entry: Command.Results.Entry =
   296               (serial -> XML.Elem(Markup(Markup.message(name), props), body))
   297             Text.Info(snapshot.convert(info_range), entry) :: msgs
   298 
   299           case (msgs, Text.Info(info_range, msg @ XML.Elem(Markup(Markup.BAD, _), body)))
   300           if !body.isEmpty =>
   301             val entry: Command.Results.Entry = (Document.new_id(), msg)
   302             Text.Info(snapshot.convert(info_range), entry) :: msgs
   303         }).toList.flatMap(_.info)
   304     if (results.isEmpty) None
   305     else {
   306       val r = Text.Range(results.head.range.start, results.last.range.stop)
   307       val msgs = Command.Results.make(results.map(_.info))
   308       Some(Text.Info(r, Pretty.separate(msgs.entries.map(_._2).toList)))
   309     }
   310   }
   311 
   312 
   313   private val tooltips: Map[String, String] =
   314     Map(
   315       Markup.SORT -> "sort",
   316       Markup.TYP -> "type",
   317       Markup.TERM -> "term",
   318       Markup.PROP -> "proposition",
   319       Markup.TOKEN_RANGE -> "inner syntax token",
   320       Markup.FREE -> "free variable",
   321       Markup.SKOLEM -> "skolem variable",
   322       Markup.BOUND -> "bound variable",
   323       Markup.VAR -> "schematic variable",
   324       Markup.TFREE -> "free type variable",
   325       Markup.TVAR -> "schematic type variable",
   326       Markup.ML_SOURCE -> "ML source",
   327       Markup.DOCUMENT_SOURCE -> "document source")
   328 
   329   private val tooltip_elements =
   330     Set(Markup.TIMING, Markup.ENTITY, Markup.SORTING, Markup.TYPING,
   331       Markup.ML_TYPING, Markup.PATH) ++ tooltips.keys
   332 
   333   private def pretty_typing(kind: String, body: XML.Body): XML.Tree =
   334     Pretty.block(XML.Text(kind) :: Pretty.Break(1) :: body)
   335 
   336   private val timing_threshold: Double = options.real("jedit_timing_threshold")
   337 
   338   def tooltip(range: Text.Range): Option[Text.Info[XML.Body]] =
   339   {
   340     def add(prev: Text.Info[(Timing, List[(Boolean, XML.Tree)])],
   341       r0: Text.Range, p: (Boolean, XML.Tree)): Text.Info[(Timing, List[(Boolean, XML.Tree)])] =
   342     {
   343       val r = snapshot.convert(r0)
   344       val (t, info) = prev.info
   345       if (prev.range == r) Text.Info(r, (t, p :: info)) else Text.Info(r, (t, List(p)))
   346     }
   347 
   348     val results =
   349       snapshot.cumulate_markup[Text.Info[(Timing, List[(Boolean, XML.Tree)])]](
   350         range, Text.Info(range, (Timing.zero, Nil)), Some(tooltip_elements), _ =>
   351         {
   352           case (Text.Info(r, (t1, info)), Text.Info(_, XML.Elem(Markup.Timing(t2), _))) =>
   353             Text.Info(r, (t1 + t2, info))
   354           case (prev, Text.Info(r, XML.Elem(Markup.Entity(kind, name), _))) =>
   355             val kind1 = space_explode('_', kind).mkString(" ")
   356             val txt1 = kind1 + " " + quote(name)
   357             val t = prev.info._1
   358             val txt2 =
   359               if (kind == Markup.COMMAND && t.elapsed.seconds >= timing_threshold)
   360                 "\n" + t.message
   361               else ""
   362             add(prev, r, (true, XML.Text(txt1 + txt2)))
   363           case (prev, Text.Info(r, XML.Elem(Markup.Path(name), _)))
   364           if Path.is_ok(name) =>
   365             val jedit_file = PIDE.thy_load.append(snapshot.node_name.dir, Path.explode(name))
   366             add(prev, r, (true, XML.Text("file " + quote(jedit_file))))
   367           case (prev, Text.Info(r, XML.Elem(Markup(name, _), body)))
   368           if name == Markup.SORTING || name == Markup.TYPING =>
   369             add(prev, r, (true, pretty_typing("::", body)))
   370           case (prev, Text.Info(r, XML.Elem(Markup(Markup.ML_TYPING, _), body))) =>
   371             add(prev, r, (false, pretty_typing("ML:", body)))
   372           case (prev, Text.Info(r, XML.Elem(Markup(name, _), _)))
   373           if tooltips.isDefinedAt(name) =>
   374             add(prev, r, (true, XML.Text(tooltips(name))))
   375         }).toList.map(_.info)
   376 
   377     results.map(_.info).flatMap(_._2) match {
   378       case Nil => None
   379       case tips =>
   380         val r = Text.Range(results.head.range.start, results.last.range.stop)
   381         val all_tips = (tips.filter(_._1) ++ tips.filter(!_._1).lastOption.toList).map(_._2)
   382         Some(Text.Info(r, Library.separate(Pretty.FBreak, all_tips)))
   383     }
   384   }
   385 
   386   val tooltip_margin: Int = options.int("jedit_tooltip_margin")
   387   val tooltip_bounds: Double = (options.real("jedit_tooltip_bounds") max 0.2) min 0.8
   388 
   389 
   390   def gutter_message(range: Text.Range): Option[Icon] =
   391   {
   392     val results =
   393       snapshot.cumulate_markup[Int](range, 0, Some(Set(Markup.WARNING, Markup.ERROR)), _ =>
   394         {
   395           case (pri, Text.Info(_, XML.Elem(Markup(Markup.WARNING, _), body))) =>
   396             body match {
   397               case List(XML.Elem(Markup(Markup.LEGACY, _), _)) =>
   398                 pri max Rendering.legacy_pri
   399               case _ => pri max Rendering.warning_pri
   400             }
   401           case (pri, Text.Info(_, XML.Elem(Markup(Markup.ERROR, _), _))) =>
   402             pri max Rendering.error_pri
   403         })
   404     val pri = (0 /: results) { case (p1, Text.Info(_, p2)) => p1 max p2 }
   405     Rendering.gutter_icons.get(pri)
   406   }
   407 
   408 
   409   private val squiggly_colors = Map(
   410     Rendering.writeln_pri -> writeln_color,
   411     Rendering.warning_pri -> warning_color,
   412     Rendering.error_pri -> error_color)
   413 
   414   def squiggly_underline(range: Text.Range): Stream[Text.Info[Color]] =
   415   {
   416     val results =
   417       snapshot.cumulate_markup[Int](range, 0,
   418         Some(Set(Markup.WRITELN, Markup.WARNING, Markup.ERROR)), _ =>
   419         {
   420           case (pri, Text.Info(_, XML.Elem(Markup(name, _), _)))
   421           if name == Markup.WRITELN ||
   422             name == Markup.WARNING ||
   423             name == Markup.ERROR => pri max Rendering.message_pri(name)
   424         })
   425     for {
   426       Text.Info(r, pri) <- results
   427       color <- squiggly_colors.get(pri)
   428     } yield Text.Info(r, color)
   429   }
   430 
   431 
   432   private val messages_include =
   433     Set(Markup.WRITELN_MESSAGE, Markup.TRACING_MESSAGE, Markup.WARNING_MESSAGE, Markup.ERROR_MESSAGE)
   434 
   435   private val message_colors = Map(
   436     Rendering.writeln_pri -> writeln_message_color,
   437     Rendering.tracing_pri -> tracing_message_color,
   438     Rendering.warning_pri -> warning_message_color,
   439     Rendering.error_pri -> error_message_color)
   440 
   441   def line_background(range: Text.Range): Option[(Color, Boolean)] =
   442   {
   443     val results =
   444       snapshot.cumulate_markup[Int](range, 0, Some(messages_include), _ =>
   445         {
   446           case (pri, Text.Info(_, XML.Elem(Markup(name, _), _)))
   447           if name == Markup.WRITELN_MESSAGE ||
   448             name == Markup.TRACING_MESSAGE ||
   449             name == Markup.WARNING_MESSAGE ||
   450             name == Markup.ERROR_MESSAGE => pri max Rendering.message_pri(name)
   451         })
   452     val pri = (0 /: results) { case (p1, Text.Info(_, p2)) => p1 max p2 }
   453 
   454     val is_separator = pri > 0 &&
   455       snapshot.cumulate_markup[Boolean](range, false, Some(Set(Markup.SEPARATOR)), _ =>
   456         {
   457           case (_, Text.Info(_, XML.Elem(Markup(Markup.SEPARATOR, _), _))) => true
   458         }).exists(_.info)
   459 
   460     message_colors.get(pri).map((_, is_separator))
   461   }
   462 
   463 
   464   def output_messages(st: Command.State): List[XML.Tree] =
   465   {
   466     st.results.entries.map(_._2).filterNot(Protocol.is_result(_)).toList
   467   }
   468 
   469 
   470   private val background1_include =
   471     Protocol.command_status_markup + Markup.WRITELN_MESSAGE + Markup.TRACING_MESSAGE +
   472       Markup.WARNING_MESSAGE + Markup.ERROR_MESSAGE + Markup.BAD + Markup.INTENSIFY ++
   473       active_include
   474 
   475   def background1(range: Text.Range): Stream[Text.Info[Color]] =
   476   {
   477     if (snapshot.is_outdated) Stream(Text.Info(range, outdated_color))
   478     else
   479       for {
   480         Text.Info(r, result) <-
   481           snapshot.cumulate_markup[(Option[Protocol.Status], Option[Color])](
   482             range, (Some(Protocol.Status.init), None), Some(background1_include), command_state =>
   483             {
   484               case (((Some(status), color), Text.Info(_, XML.Elem(markup, _))))
   485               if (Protocol.command_status_markup(markup.name)) =>
   486                 (Some(Protocol.command_status(status, markup)), color)
   487               case (_, Text.Info(_, XML.Elem(Markup(Markup.BAD, _), _))) =>
   488                 (None, Some(bad_color))
   489               case (_, Text.Info(_, XML.Elem(Markup(Markup.INTENSIFY, _), _))) =>
   490                 (None, Some(intensify_color))
   491               case (acc, Text.Info(_, Protocol.Dialog(_, serial, result))) =>
   492                 command_state.results.get(serial) match {
   493                   case Some(Protocol.Dialog_Result(res)) if res == result =>
   494                     (None, Some(active_result_color))
   495                   case _ =>
   496                     (None, Some(active_color))
   497                 }
   498               case (_, Text.Info(_, XML.Elem(markup, _))) if active_include(markup.name) =>
   499                 (None, Some(active_color))
   500             })
   501         color <-
   502           (result match {
   503             case (Some(status), opt_color) =>
   504               if (status.is_unprocessed) Some(unprocessed1_color)
   505               else if (status.is_running) Some(running1_color)
   506               else opt_color
   507             case (_, opt_color) => opt_color
   508           })
   509       } yield Text.Info(r, color)
   510   }
   511 
   512 
   513   def background2(range: Text.Range): Stream[Text.Info[Color]] =
   514     snapshot.select_markup(range, Some(Set(Markup.TOKEN_RANGE)), _ =>
   515       {
   516         case Text.Info(_, XML.Elem(Markup(Markup.TOKEN_RANGE, _), _)) => light_color
   517       })
   518 
   519 
   520   def bullet(range: Text.Range): Stream[Text.Info[Color]] =
   521     snapshot.select_markup(range, Some(Set(Markup.BULLET)), _ =>
   522       {
   523         case Text.Info(_, XML.Elem(Markup(Markup.BULLET, _), _)) => bullet_color
   524       })
   525 
   526 
   527   private val foreground_elements =
   528     Set(Markup.STRING, Markup.ALTSTRING, Markup.VERBATIM, Markup.ANTIQ)
   529 
   530   def foreground(range: Text.Range): Stream[Text.Info[Color]] =
   531     snapshot.select_markup(range, Some(foreground_elements), _ =>
   532       {
   533         case Text.Info(_, XML.Elem(Markup(Markup.STRING, _), _)) => quoted_color
   534         case Text.Info(_, XML.Elem(Markup(Markup.ALTSTRING, _), _)) => quoted_color
   535         case Text.Info(_, XML.Elem(Markup(Markup.VERBATIM, _), _)) => quoted_color
   536         case Text.Info(_, XML.Elem(Markup(Markup.ANTIQ, _), _)) => antiquoted_color
   537       })
   538 
   539 
   540   private val text_colors: Map[String, Color] = Map(
   541       Markup.KEYWORD1 -> keyword1_color,
   542       Markup.KEYWORD2 -> keyword2_color,
   543       Markup.STRING -> Color.BLACK,
   544       Markup.ALTSTRING -> Color.BLACK,
   545       Markup.VERBATIM -> Color.BLACK,
   546       Markup.LITERAL -> keyword1_color,
   547       Markup.DELIMITER -> Color.BLACK,
   548       Markup.TFREE -> tfree_color,
   549       Markup.TVAR -> tvar_color,
   550       Markup.FREE -> free_color,
   551       Markup.SKOLEM -> skolem_color,
   552       Markup.BOUND -> bound_color,
   553       Markup.VAR -> var_color,
   554       Markup.INNER_STRING -> inner_quoted_color,
   555       Markup.INNER_COMMENT -> inner_comment_color,
   556       Markup.DYNAMIC_FACT -> dynamic_color,
   557       Markup.ML_KEYWORD -> keyword1_color,
   558       Markup.ML_DELIMITER -> Color.BLACK,
   559       Markup.ML_NUMERAL -> inner_numeral_color,
   560       Markup.ML_CHAR -> inner_quoted_color,
   561       Markup.ML_STRING -> inner_quoted_color,
   562       Markup.ML_COMMENT -> inner_comment_color)
   563 
   564   private val text_color_elements = text_colors.keySet
   565 
   566   def text_color(range: Text.Range, color: Color)
   567       : Stream[Text.Info[Color]] =
   568   {
   569     if (color == Token_Markup.hidden_color) Stream(Text.Info(range, color))
   570     else
   571       snapshot.cumulate_markup(range, color, Some(text_color_elements), _ =>
   572         {
   573           case (_, Text.Info(_, XML.Elem(Markup(m, _), _)))
   574           if text_colors.isDefinedAt(m) => text_colors(m)
   575         })
   576   }
   577 
   578 
   579   /* nested text structure -- folds */
   580 
   581   private val fold_depth_include = Set(Markup.TEXT_FOLD, Markup.GOAL, Markup.SUBGOAL)
   582 
   583   def fold_depth(range: Text.Range): Stream[Text.Info[Int]] =
   584     snapshot.cumulate_markup[Int](range, 0, Some(fold_depth_include), _ =>
   585       {
   586         case (depth, Text.Info(_, XML.Elem(Markup(name, _), _)))
   587         if fold_depth_include(name) => depth + 1
   588       })
   589 }