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