/* Title: Tools/VSCode/src/server.scala
Author: Makarius
Server for VS Code Language Server Protocol 2.0/3.0, see also
https://github.com/Microsoft/language-server-protocol
https://github.com/Microsoft/language-server-protocol/blob/master/protocol.md
PIDE protocol extensions depend on system option "vscode_pide_extensions".
*/
package isabelle.vscode
import isabelle._
import java.io.{PrintStream, OutputStream, File => JFile}
import scala.annotation.tailrec
import scala.collection.mutable
object Server
{
type Editor = isabelle.Editor[Unit]
/* Isabelle tool wrapper */
private lazy val default_logic = Isabelle_System.getenv("ISABELLE_LOGIC")
val isabelle_tool = Isabelle_Tool("vscode_server", "VSCode Language Server for PIDE", args =>
{
try {
var all_known = false
var log_file: Option[Path] = None
var dirs: List[Path] = Nil
var logic = default_logic
var modes: List[String] = Nil
var options = Options.init()
var system_mode = false
var verbose = false
val getopts = Getopts("""
Usage: isabelle vscode_server [OPTIONS]
Options are:
-A explore theory name space of all known sessions (potentially slow)
-L FILE enable logging on FILE
-d DIR include session directory
-l NAME logic session name (default ISABELLE_LOGIC=""" + quote(default_logic) + """)
-m MODE add print mode for output
-o OPTION override Isabelle system OPTION (via NAME=VAL or NAME)
-s system build mode for session image
-v verbose logging
Run the VSCode Language Server protocol (JSON RPC) over stdin/stdout.
""",
"A" -> (_ => all_known = true),
"L:" -> (arg => log_file = Some(Path.explode(File.standard_path(arg)))),
"d:" -> (arg => dirs = dirs ::: List(Path.explode(File.standard_path(arg)))),
"l:" -> (arg => logic = arg),
"m:" -> (arg => modes = arg :: modes),
"o:" -> (arg => options = options + arg),
"s" -> (_ => system_mode = true),
"v" -> (_ => verbose = true))
val more_args = getopts(args)
if (more_args.nonEmpty) getopts.usage()
val log = Logger.make(log_file)
val channel = new Channel(System.in, System.out, log, verbose)
val server =
new Server(channel, options, session_name = logic, session_dirs = dirs,
all_known = all_known, modes = modes, system_mode = system_mode, log = log)
// prevent spurious garbage on the main protocol channel
val orig_out = System.out
try {
System.setOut(new PrintStream(new OutputStream { def write(n: Int) {} }))
server.start()
}
finally { System.setOut(orig_out) }
}
catch {
case exn: Throwable =>
val channel = new Channel(System.in, System.out, No_Logger)
channel.error_message(Exn.message(exn))
throw(exn)
}
})
}
class Server(
val channel: Channel,
options: Options,
session_name: String = Server.default_logic,
session_dirs: List[Path] = Nil,
all_known: Boolean = false,
modes: List[String] = Nil,
system_mode: Boolean = false,
log: Logger = No_Logger)
{
server =>
/* prover session */
private val session_ = Synchronized(None: Option[Session])
def session: Session = session_.value getOrElse error("Server inactive")
def resources: VSCode_Resources = session.resources.asInstanceOf[VSCode_Resources]
def rendering_offset(node_pos: Line.Node_Position): Option[(VSCode_Rendering, Text.Offset)] =
for {
model <- resources.get_model(new JFile(node_pos.name))
rendering = model.rendering()
offset <- model.content.doc.offset(node_pos.pos)
} yield (rendering, offset)
private val dynamic_output = Dynamic_Output(server)
/* input from client or file-system */
private val delay_input: Standard_Thread.Delay =
Standard_Thread.delay_last(options.seconds("vscode_input_delay"), channel.Error_Logger)
{ resources.flush_input(session) }
private val delay_load: Standard_Thread.Delay =
Standard_Thread.delay_last(options.seconds("vscode_load_delay"), channel.Error_Logger) {
val (invoke_input, invoke_load) =
resources.resolve_dependencies(session, editor, file_watcher)
if (invoke_input) delay_input.invoke()
if (invoke_load) delay_load.invoke
}
private val file_watcher =
File_Watcher(sync_documents(_), options.seconds("vscode_load_delay"))
private def close_document(file: JFile)
{
if (resources.close_model(file)) {
file_watcher.register_parent(file)
sync_documents(Set(file))
delay_input.invoke()
delay_output.invoke()
}
}
private def sync_documents(changed: Set[JFile])
{
resources.sync_models(changed)
delay_input.invoke()
delay_output.invoke()
}
private def change_document(file: JFile, changes: List[Protocol.TextDocumentChange])
{
val norm_changes = new mutable.ListBuffer[Protocol.TextDocumentChange]
@tailrec def norm(chs: List[Protocol.TextDocumentChange])
{
if (chs.nonEmpty) {
val (full_texts, rest1) = chs.span(_.range.isEmpty)
val (edits, rest2) = rest1.span(_.range.nonEmpty)
norm_changes ++= full_texts
norm_changes ++= edits.sortBy(_.range.get.start)(Line.Position.Ordering).reverse
norm(rest2)
}
}
norm(changes)
norm_changes.foreach(change =>
resources.change_model(session, editor, file, change.text, change.range))
delay_input.invoke()
delay_output.invoke()
}
/* caret handling */
private val delay_caret_update: Standard_Thread.Delay =
Standard_Thread.delay_last(options.seconds("vscode_input_delay"), channel.Error_Logger)
{ session.caret_focus.post(Session.Caret_Focus) }
private def update_caret(caret: Option[(JFile, Line.Position)])
{
resources.update_caret(caret)
delay_caret_update.invoke()
delay_input.invoke()
}
/* preview */
private lazy val preview_panel = new Preview_Panel(resources)
private lazy val delay_preview: Standard_Thread.Delay =
Standard_Thread.delay_last(options.seconds("vscode_output_delay"), channel.Error_Logger)
{
if (preview_panel.flush(channel)) delay_preview.invoke()
}
private def request_preview(file: JFile, column: Int)
{
preview_panel.request(file, column)
delay_preview.invoke()
}
/* output to client */
private val delay_output: Standard_Thread.Delay =
Standard_Thread.delay_last(options.seconds("vscode_output_delay"), channel.Error_Logger)
{
if (resources.flush_output(channel)) delay_output.invoke()
}
def update_output(changed_nodes: Traversable[JFile])
{
resources.update_output(changed_nodes)
delay_output.invoke()
}
def update_output_visible()
{
resources.update_output_visible()
delay_output.invoke()
}
private val prover_output =
Session.Consumer[Session.Commands_Changed](getClass.getName) {
case changed =>
update_output(changed.nodes.toList.map(resources.node_file(_)))
}
private val syslog =
Session.Consumer[Prover.Message](getClass.getName) {
case output: Prover.Output if output.is_syslog =>
channel.log_writeln(resources.output_xml(output.message))
case _ =>
}
/* init and exit */
def init(id: Protocol.Id)
{
def reply(err: String)
{
channel.write(Protocol.Initialize.reply(id, err))
if (err == "")
channel.writeln("Welcome to Isabelle/" + session_name + " (" + Distribution.version + ")")
else channel.error_message(err)
}
val try_session =
try {
if (!Build.build(options = options, build_heap = true, no_build = true,
system_mode = system_mode, dirs = session_dirs, sessions = List(session_name)).ok)
{
val start_msg = "Build started for Isabelle/" + session_name + " ..."
val fail_msg = "Session build failed -- prover process remains inactive!"
val progress = channel.make_progress(verbose = true)
progress.echo(start_msg); channel.writeln(start_msg)
if (!Build.build(options = options, progress = progress, build_heap = true,
system_mode = system_mode, dirs = session_dirs, sessions = List(session_name)).ok)
{
progress.echo(fail_msg); error(fail_msg)
}
}
val session_base =
Sessions.session_base(options, session_name, dirs = session_dirs, all_known = all_known)
val resources = new VSCode_Resources(options, session_base, log)
{
override def commit(change: Session.Change): Unit =
if (change.deps_changed || undefined_blobs(change.version.nodes).nonEmpty)
delay_load.invoke()
}
val session_options = options.bool("editor_output_state") = true
Some(new Session(session_options, resources))
}
catch { case ERROR(msg) => reply(msg); None }
for (session <- try_session) {
session_.change(_ => Some(session))
session.commands_changed += prover_output
session.all_messages += syslog
dynamic_output.init()
var session_phase: Session.Consumer[Session.Phase] = null
session_phase =
Session.Consumer(getClass.getName) {
case Session.Ready =>
session.phase_changed -= session_phase
reply("")
case Session.Terminated(result) if !result.ok =>
session.phase_changed -= session_phase
reply("Prover startup failed: return code " + result.rc)
case _ =>
}
session.phase_changed += session_phase
Isabelle_Process.start(session, options,
logic = session_name, dirs = session_dirs, modes = modes)
}
}
def shutdown(id: Protocol.Id)
{
def reply(err: String): Unit = channel.write(Protocol.Shutdown.reply(id, err))
session_.change({
case Some(session) =>
session.commands_changed -= prover_output
session.all_messages -= syslog
dynamic_output.exit()
delay_load.revoke()
file_watcher.shutdown()
delay_input.revoke()
delay_output.revoke()
delay_caret_update.revoke()
delay_preview.revoke()
val rc = session.stop()
if (rc == 0) reply("") else reply("Prover shutdown failed: return code " + rc)
None
case None =>
reply("Prover inactive")
None
})
}
def exit() {
log("\n")
sys.exit(if (session_.value.isDefined) 1 else 0)
}
/* completion */
def completion(id: Protocol.Id, node_pos: Line.Node_Position)
{
val result =
(for ((rendering, offset) <- rendering_offset(node_pos))
yield rendering.completion(node_pos.pos, offset)) getOrElse Nil
channel.write(Protocol.Completion.reply(id, result))
}
/* spell-checker dictionary */
def update_dictionary(include: Boolean, permanent: Boolean)
{
for {
spell_checker <- resources.spell_checker.get
caret <- resources.get_caret()
rendering = caret.model.rendering()
range = rendering.before_caret_range(caret.offset)
Text.Info(_, word) <- Spell_Checker.current_word(rendering, range)
} {
spell_checker.update(word, include, permanent)
update_output_visible()
}
}
def reset_dictionary()
{
for (spell_checker <- resources.spell_checker.get)
{
spell_checker.reset()
update_output_visible()
}
}
/* hover */
def hover(id: Protocol.Id, node_pos: Line.Node_Position)
{
val result =
for {
(rendering, offset) <- rendering_offset(node_pos)
info <- rendering.tooltips(VSCode_Rendering.tooltip_elements, Text.Range(offset, offset + 1))
} yield {
val range = rendering.model.content.doc.range(info.range)
val contents =
info.info.map(t => Protocol.MarkedString(resources.output_pretty_tooltip(List(t))))
(range, contents)
}
channel.write(Protocol.Hover.reply(id, result))
}
/* goto definition */
def goto_definition(id: Protocol.Id, node_pos: Line.Node_Position)
{
val result =
(for ((rendering, offset) <- rendering_offset(node_pos))
yield rendering.hyperlinks(Text.Range(offset, offset + 1))) getOrElse Nil
channel.write(Protocol.GotoDefinition.reply(id, result))
}
/* document highlights */
def document_highlights(id: Protocol.Id, node_pos: Line.Node_Position)
{
val result =
(for ((rendering, offset) <- rendering_offset(node_pos))
yield {
val model = rendering.model
rendering.caret_focus_ranges(Text.Range(offset, offset + 1), model.content.text_range)
.map(r => Protocol.DocumentHighlight.text(model.content.doc.range(r)))
}) getOrElse Nil
channel.write(Protocol.DocumentHighlights.reply(id, result))
}
/* main loop */
def start()
{
log("Server started " + Date.now())
def handle(json: JSON.T)
{
try {
json match {
case Protocol.Initialize(id) => init(id)
case Protocol.Initialized(()) =>
case Protocol.Shutdown(id) => shutdown(id)
case Protocol.Exit(()) => exit()
case Protocol.DidOpenTextDocument(file, _, _, text) =>
change_document(file, List(Protocol.TextDocumentChange(None, text)))
case Protocol.DidChangeTextDocument(file, _, changes) => change_document(file, changes)
case Protocol.DidCloseTextDocument(file) => close_document(file)
case Protocol.Completion(id, node_pos) => completion(id, node_pos)
case Protocol.Include_Word(()) => update_dictionary(true, false)
case Protocol.Include_Word_Permanently(()) => update_dictionary(true, true)
case Protocol.Exclude_Word(()) => update_dictionary(false, false)
case Protocol.Exclude_Word_Permanently(()) => update_dictionary(false, true)
case Protocol.Reset_Words(()) => reset_dictionary()
case Protocol.Hover(id, node_pos) => hover(id, node_pos)
case Protocol.GotoDefinition(id, node_pos) => goto_definition(id, node_pos)
case Protocol.DocumentHighlights(id, node_pos) => document_highlights(id, node_pos)
case Protocol.Caret_Update(caret) => update_caret(caret)
case Protocol.State_Init(()) => State_Panel.init(server)
case Protocol.State_Exit(id) => State_Panel.exit(id)
case Protocol.State_Locate(id) => State_Panel.locate(id)
case Protocol.State_Update(id) => State_Panel.update(id)
case Protocol.State_Auto_Update(id, enabled) => State_Panel.auto_update(id, enabled)
case Protocol.Preview_Request(file, column) => request_preview(file, column)
case Protocol.Symbols_Request(()) => channel.write(Protocol.Symbols())
case _ => log("### IGNORED")
}
}
catch { case exn: Throwable => channel.log_error_message(Exn.message(exn)) }
}
@tailrec def loop()
{
channel.read() match {
case Some(json) =>
json match {
case bulk: List[_] => bulk.foreach(handle(_))
case _ => handle(json)
}
loop()
case None => log("### TERMINATE")
}
}
loop()
}
/* abstract editor operations */
object editor extends Server.Editor
{
/* session */
override def session: Session = server.session
override def flush(): Unit = resources.flush_input(session)
override def invoke(): Unit = delay_input.invoke()
/* current situation */
override def current_node(context: Unit): Option[Document.Node.Name] =
resources.get_caret().map(_.model.node_name)
override def current_node_snapshot(context: Unit): Option[Document.Snapshot] =
resources.get_caret().map(_.model.snapshot())
override def node_snapshot(name: Document.Node.Name): Document.Snapshot =
{
resources.get_model(name) match {
case Some(model) => model.snapshot()
case None => session.snapshot(name)
}
}
def current_command(snapshot: Document.Snapshot): Option[Command] =
{
resources.get_caret() match {
case Some(caret) => snapshot.current_command(caret.node_name, caret.offset)
case None => None
}
}
override def current_command(context: Unit, snapshot: Document.Snapshot): Option[Command] =
current_command(snapshot)
/* overlays */
override def node_overlays(name: Document.Node.Name): Document.Node.Overlays =
resources.node_overlays(name)
override def insert_overlay(command: Command, fn: String, args: List[String]): Unit =
resources.insert_overlay(command, fn, args)
override def remove_overlay(command: Command, fn: String, args: List[String]): Unit =
resources.remove_overlay(command, fn, args)
/* hyperlinks */
override def hyperlink_command(
focus: Boolean, snapshot: Document.Snapshot, id: Document_ID.Generic,
offset: Symbol.Offset = 0): Option[Hyperlink] =
{
if (snapshot.is_outdated) None
else
snapshot.find_command_position(id, offset).map(node_pos =>
new Hyperlink {
def follow(unit: Unit) { channel.write(Protocol.Caret_Update(node_pos, focus)) }
})
}
/* dispatcher thread */
override def assert_dispatcher[A](body: => A): A = session.assert_dispatcher(body)
override def require_dispatcher[A](body: => A): A = session.require_dispatcher(body)
override def send_dispatcher(body: => Unit): Unit = session.send_dispatcher(body)
override def send_wait_dispatcher(body: => Unit): Unit = session.send_wait_dispatcher(body)
}
}