src/Tools/VSCode/src/vscode_rendering.scala
author wenzelm
Sun Mar 05 22:32:33 2017 +0100 (2017-03-05)
changeset 65122 1edb570f5b17
parent 65120 db6cc23fcf33
child 65134 511bf19348d3
permissions -rw-r--r--
decorations for dotted underline: less intrusive;
tuned;
wenzelm@64622
     1
/*  Title:      Tools/VSCode/src/vscode_rendering.scala
wenzelm@64622
     2
    Author:     Makarius
wenzelm@64622
     3
wenzelm@64622
     4
Isabelle/VSCode-specific implementation of quasi-abstract rendering and
wenzelm@64622
     5
markup interpretation.
wenzelm@64622
     6
*/
wenzelm@64622
     7
wenzelm@64622
     8
package isabelle.vscode
wenzelm@64622
     9
wenzelm@64622
    10
wenzelm@64622
    11
import isabelle._
wenzelm@64622
    12
wenzelm@64778
    13
import java.io.{File => JFile}
wenzelm@64778
    14
wenzelm@64778
    15
wenzelm@64648
    16
object VSCode_Rendering
wenzelm@64648
    17
{
wenzelm@65104
    18
  /* decorations */
wenzelm@65104
    19
wenzelm@65122
    20
  private def color_decorations(prefix: String, types: Set[Rendering.Color.Value],
wenzelm@65104
    21
    colors: List[Text.Info[Rendering.Color.Value]]): List[Document_Model.Decoration] =
wenzelm@65104
    22
  {
wenzelm@65104
    23
    val color_ranges =
wenzelm@65104
    24
      (Map.empty[Rendering.Color.Value, List[Text.Range]] /: colors) {
wenzelm@65104
    25
        case (m, Text.Info(range, c)) => m + (c -> (range :: m.getOrElse(c, Nil)))
wenzelm@65104
    26
      }
wenzelm@65105
    27
    types.toList.map(c =>
wenzelm@65105
    28
      Document_Model.Decoration(prefix + c.toString,
wenzelm@65105
    29
        color_ranges.getOrElse(c, Nil).reverse.map(r => Text.Info(r, Nil: List[XML.Body]))))
wenzelm@65104
    30
  }
wenzelm@65104
    31
wenzelm@65122
    32
  private val dotted_colors =
wenzelm@65122
    33
    Set(Rendering.Color.writeln, Rendering.Color.information)
wenzelm@65122
    34
wenzelm@65104
    35
wenzelm@64679
    36
  /* diagnostic messages */
wenzelm@64679
    37
wenzelm@64679
    38
  private val message_severity =
wenzelm@64679
    39
    Map(
wenzelm@65122
    40
      Markup.WRITELN -> Protocol.DiagnosticSeverity.Hint,
wenzelm@65122
    41
      Markup.INFORMATION -> Protocol.DiagnosticSeverity.Hint,
wenzelm@64679
    42
      Markup.WARNING -> Protocol.DiagnosticSeverity.Warning,
wenzelm@64679
    43
      Markup.LEGACY -> Protocol.DiagnosticSeverity.Warning,
wenzelm@65095
    44
      Markup.ERROR -> Protocol.DiagnosticSeverity.Error)
wenzelm@64679
    45
wenzelm@64679
    46
wenzelm@64679
    47
  /* markup elements */
wenzelm@64679
    48
wenzelm@64679
    49
  private val diagnostics_elements =
wenzelm@65095
    50
    Markup.Elements(Markup.WRITELN, Markup.INFORMATION, Markup.WARNING, Markup.LEGACY, Markup.ERROR)
wenzelm@65095
    51
wenzelm@65122
    52
  private val dotted_elements =
wenzelm@65122
    53
    Markup.Elements(Markup.WRITELN, Markup.INFORMATION)
wenzelm@65122
    54
wenzelm@65106
    55
  private val hover_message_elements = Markup.Elements(Markup.BAD)
wenzelm@64679
    56
wenzelm@64648
    57
  private val hyperlink_elements =
wenzelm@64833
    58
    Markup.Elements(Markup.ENTITY, Markup.PATH, Markup.POSITION, Markup.CITATION)
wenzelm@64648
    59
}
wenzelm@64622
    60
wenzelm@64649
    61
class VSCode_Rendering(
wenzelm@64649
    62
    val model: Document_Model,
wenzelm@64649
    63
    snapshot: Document.Snapshot,
wenzelm@64702
    64
    resources: VSCode_Resources)
wenzelm@64704
    65
  extends Rendering(snapshot, resources.options, resources)
wenzelm@64622
    66
{
wenzelm@64877
    67
  /* completion */
wenzelm@64877
    68
wenzelm@64877
    69
  def completion(range: Text.Range): List[Protocol.CompletionItem] =
wenzelm@64877
    70
    semantic_completion(None, range) match {
wenzelm@64877
    71
      case Some(Text.Info(complete_range, names: Completion.Names)) =>
wenzelm@64877
    72
        model.content.try_get_text(complete_range) match {
wenzelm@64877
    73
          case Some(original) =>
wenzelm@64877
    74
            names.complete(complete_range, Completion.History.empty,
wenzelm@64877
    75
                resources.decode_text, original) match {
wenzelm@64877
    76
              case Some(result) =>
wenzelm@64877
    77
                result.items.map(item =>
wenzelm@64877
    78
                  Protocol.CompletionItem(
wenzelm@64877
    79
                    label = item.replacement,
wenzelm@64877
    80
                    detail = Some(item.description.mkString(" ")),
wenzelm@64877
    81
                    range = Some(model.content.doc.range(item.range))))
wenzelm@64877
    82
              case None => Nil
wenzelm@64877
    83
            }
wenzelm@64877
    84
          case None => Nil
wenzelm@64877
    85
        }
wenzelm@64877
    86
      case _ => Nil
wenzelm@64877
    87
    }
wenzelm@64877
    88
wenzelm@64877
    89
wenzelm@64679
    90
  /* diagnostics */
wenzelm@64679
    91
wenzelm@64679
    92
  def diagnostics: List[Text.Info[Command.Results]] =
wenzelm@64679
    93
    snapshot.cumulate[Command.Results](
wenzelm@64830
    94
      model.content.text_range, Command.Results.empty, VSCode_Rendering.diagnostics_elements, _ =>
wenzelm@64679
    95
      {
wenzelm@64679
    96
        case (res, Text.Info(_, msg @ XML.Elem(Markup(_, Markup.Serial(i)), body)))
wenzelm@64679
    97
        if body.nonEmpty => Some(res + (i -> msg))
wenzelm@64679
    98
wenzelm@64679
    99
        case _ => None
wenzelm@64802
   100
      }).filterNot(info => info.info.is_empty)
wenzelm@64679
   101
wenzelm@64679
   102
  def diagnostics_output(results: List[Text.Info[Command.Results]]): List[Protocol.Diagnostic] =
wenzelm@64679
   103
  {
wenzelm@64679
   104
    (for {
wenzelm@64679
   105
      Text.Info(text_range, res) <- results.iterator
wenzelm@64830
   106
      range = model.content.doc.range(text_range)
wenzelm@64679
   107
      (_, XML.Elem(Markup(name, _), body)) <- res.iterator
wenzelm@64679
   108
    } yield {
wenzelm@65107
   109
      val message = resources.output_pretty_message(body)
wenzelm@64679
   110
      val severity = VSCode_Rendering.message_severity.get(name)
wenzelm@64679
   111
      Protocol.Diagnostic(range, message, severity = severity)
wenzelm@64679
   112
    }).toList
wenzelm@64679
   113
  }
wenzelm@64679
   114
wenzelm@64679
   115
wenzelm@65122
   116
  /* dotted underline */
wenzelm@65122
   117
wenzelm@65122
   118
  def dotted(range: Text.Range): List[Text.Info[Rendering.Color.Value]] =
wenzelm@65122
   119
    message_underline_color(VSCode_Rendering.dotted_elements, range)
wenzelm@65122
   120
wenzelm@65122
   121
wenzelm@65095
   122
  /* decorations */
wenzelm@65095
   123
wenzelm@65106
   124
  def hover_message: Document_Model.Decoration =
wenzelm@65106
   125
  {
wenzelm@65106
   126
    val results =
wenzelm@65106
   127
      snapshot.cumulate[Command.Results](
wenzelm@65106
   128
        model.content.text_range, Command.Results.empty,
wenzelm@65106
   129
        VSCode_Rendering.hover_message_elements, _ =>
wenzelm@65106
   130
          {
wenzelm@65106
   131
            case (msgs, Text.Info(_, XML.Elem(Markup(name, props @ Markup.Serial(serial)), body)))
wenzelm@65106
   132
            if body.nonEmpty =>
wenzelm@65106
   133
              Some(msgs + (serial -> XML.Elem(Markup(Markup.message(name), props), body)))
wenzelm@65106
   134
wenzelm@65106
   135
            case _ => None
wenzelm@65106
   136
          })
wenzelm@65106
   137
    val content =
wenzelm@65106
   138
      for (Text.Info(r, msgs) <- results if !msgs.is_empty)
wenzelm@65106
   139
      yield Text.Info(r, (for ((_, t) <- msgs.iterator) yield List(t)).toList)
wenzelm@65106
   140
    Document_Model.Decoration("hover_message", content)
wenzelm@65106
   141
  }
wenzelm@65106
   142
wenzelm@65120
   143
  def decorations: List[Document_Model.Decoration] = // list of canonical length and order
wenzelm@65106
   144
    hover_message ::
wenzelm@65104
   145
    VSCode_Rendering.color_decorations("background_", Rendering.Color.background,
wenzelm@65104
   146
      background(model.content.text_range, Set.empty)) :::
wenzelm@65104
   147
    VSCode_Rendering.color_decorations("foreground_", Rendering.Color.foreground,
wenzelm@65122
   148
      foreground(model.content.text_range)) :::
wenzelm@65122
   149
    VSCode_Rendering.color_decorations("dotted_", VSCode_Rendering.dotted_colors,
wenzelm@65122
   150
      dotted(model.content.text_range))
wenzelm@65095
   151
wenzelm@65095
   152
  def decoration_output(decoration: Document_Model.Decoration): Protocol.Decoration =
wenzelm@65095
   153
  {
wenzelm@65095
   154
    val content =
wenzelm@65105
   155
      for (Text.Info(text_range, msgs) <- decoration.content)
wenzelm@65095
   156
      yield {
wenzelm@65095
   157
        val range = model.content.doc.range(text_range)
wenzelm@65105
   158
        Protocol.DecorationOptions(range,
wenzelm@65107
   159
          msgs.map(msg => Protocol.MarkedString(resources.output_pretty_tooltip(msg))))
wenzelm@65095
   160
      }
wenzelm@65095
   161
    Protocol.Decoration(decoration.typ, content)
wenzelm@65095
   162
  }
wenzelm@65095
   163
wenzelm@65095
   164
wenzelm@64622
   165
  /* tooltips */
wenzelm@64622
   166
wenzelm@64622
   167
  def timing_threshold: Double = options.real("vscode_timing_threshold")
wenzelm@64648
   168
wenzelm@64648
   169
wenzelm@64648
   170
  /* hyperlinks */
wenzelm@64648
   171
wenzelm@64667
   172
  def hyperlink_source_file(source_name: String, line1: Int, range: Symbol.Range)
wenzelm@64667
   173
    : Option[Line.Node_Range] =
wenzelm@64667
   174
  {
wenzelm@64775
   175
    for {
wenzelm@64779
   176
      platform_path <- resources.source_file(source_name)
wenzelm@64778
   177
      file <-
wenzelm@64779
   178
        (try { Some(new JFile(platform_path).getCanonicalFile) }
wenzelm@64778
   179
         catch { case ERROR(_) => None })
wenzelm@64775
   180
    }
wenzelm@64667
   181
    yield {
wenzelm@64778
   182
      Line.Node_Range(file.getPath,
wenzelm@64841
   183
        if (range.start > 0) {
wenzelm@64841
   184
          resources.get_file_content(file) match {
wenzelm@64841
   185
            case Some(text) =>
wenzelm@64841
   186
              val chunk = Symbol.Text_Chunk(text)
wenzelm@64841
   187
              val doc = Line.Document(text, resources.text_length)
wenzelm@64841
   188
              doc.range(chunk.decode(range))
wenzelm@64841
   189
            case _ =>
wenzelm@64841
   190
              Line.Range(Line.Position((line1 - 1) max 0))
wenzelm@64841
   191
          }
wenzelm@64841
   192
        }
wenzelm@64841
   193
        else Line.Range(Line.Position((line1 - 1) max 0)))
wenzelm@64667
   194
    }
wenzelm@64667
   195
  }
wenzelm@64667
   196
wenzelm@64667
   197
  def hyperlink_command(id: Document_ID.Generic, range: Symbol.Range): Option[Line.Node_Range] =
wenzelm@64667
   198
  {
wenzelm@64667
   199
    if (snapshot.is_outdated) None
wenzelm@64667
   200
    else
wenzelm@64667
   201
      for {
wenzelm@64667
   202
        start <- snapshot.find_command_position(id, range.start)
wenzelm@64667
   203
        stop <- snapshot.find_command_position(id, range.stop)
wenzelm@64667
   204
      } yield Line.Node_Range(start.name, Line.Range(start.pos, stop.pos))
wenzelm@64667
   205
  }
wenzelm@64667
   206
wenzelm@64667
   207
  def hyperlink_position(pos: Position.T): Option[Line.Node_Range] =
wenzelm@64667
   208
    pos match {
wenzelm@64667
   209
      case Position.Item_File(name, line, range) => hyperlink_source_file(name, line, range)
wenzelm@64667
   210
      case Position.Item_Id(id, range) => hyperlink_command(id, range)
wenzelm@64667
   211
      case _ => None
wenzelm@64667
   212
    }
wenzelm@64667
   213
wenzelm@64667
   214
  def hyperlink_def_position(pos: Position.T): Option[Line.Node_Range] =
wenzelm@64667
   215
    pos match {
wenzelm@64667
   216
      case Position.Item_Def_File(name, line, range) => hyperlink_source_file(name, line, range)
wenzelm@64667
   217
      case Position.Item_Def_Id(id, range) => hyperlink_command(id, range)
wenzelm@64667
   218
      case _ => None
wenzelm@64667
   219
    }
wenzelm@64667
   220
wenzelm@64651
   221
  def hyperlinks(range: Text.Range): List[Line.Node_Range] =
wenzelm@64648
   222
  {
wenzelm@64651
   223
    snapshot.cumulate[List[Line.Node_Range]](
wenzelm@64648
   224
      range, Nil, VSCode_Rendering.hyperlink_elements, _ =>
wenzelm@64648
   225
        {
wenzelm@64648
   226
          case (links, Text.Info(_, XML.Elem(Markup.Path(name), _))) =>
wenzelm@64759
   227
            val file = resources.append_file(snapshot.node_name.master_dir, name)
wenzelm@64654
   228
            Some(Line.Node_Range(file) :: links)
wenzelm@64648
   229
wenzelm@64667
   230
          case (links, Text.Info(info_range, XML.Elem(Markup(Markup.ENTITY, props), _))) =>
wenzelm@64667
   231
            hyperlink_def_position(props).map(_ :: links)
wenzelm@64667
   232
wenzelm@64667
   233
          case (links, Text.Info(info_range, XML.Elem(Markup(Markup.POSITION, props), _))) =>
wenzelm@64667
   234
            hyperlink_position(props).map(_ :: links)
wenzelm@64648
   235
wenzelm@64833
   236
          case (links, Text.Info(info_range, XML.Elem(Markup.Citation(name), _))) =>
wenzelm@64833
   237
            val iterator =
wenzelm@64833
   238
              for {
wenzelm@64833
   239
                Text.Info(entry_range, (entry, model)) <- resources.bibtex_entries_iterator
wenzelm@64833
   240
                if entry == name
wenzelm@64833
   241
              } yield Line.Node_Range(model.node_name.node, model.content.doc.range(entry_range))
wenzelm@64833
   242
            if (iterator.isEmpty) None else Some((links /: iterator)(_ :+ _))
wenzelm@64833
   243
wenzelm@64648
   244
          case _ => None
wenzelm@64648
   245
        }) match { case Text.Info(_, links) :: _ => links.reverse case _ => Nil }
wenzelm@64648
   246
  }
wenzelm@64622
   247
}