author | wenzelm |
Sat, 31 Dec 2016 15:18:04 +0100 | |
changeset 64724 | 44dbf8cc2d7f |
parent 64722 | 6df73de0d3c7 |
child 64725 | 38305f56c769 |
permissions | -rw-r--r-- |
64605 | 1 |
/* Title: Tools/VSCode/src/server.scala |
2 |
Author: Makarius |
|
3 |
||
4 |
Server for VS Code Language Server Protocol 2.0, see also |
|
5 |
https://github.com/Microsoft/language-server-protocol |
|
6 |
https://github.com/Microsoft/language-server-protocol/blob/master/protocol.md |
|
7 |
*/ |
|
8 |
||
9 |
package isabelle.vscode |
|
10 |
||
11 |
||
12 |
import isabelle._ |
|
13 |
||
64710 | 14 |
import java.io.{PrintStream, OutputStream, File => JFile} |
64605 | 15 |
|
16 |
import scala.annotation.tailrec |
|
17 |
||
18 |
||
19 |
object Server |
|
20 |
{ |
|
21 |
/* Isabelle tool wrapper */ |
|
22 |
||
64618 | 23 |
private val default_text_length = "UTF-16" |
64605 | 24 |
private lazy val default_logic = Isabelle_System.getenv("ISABELLE_LOGIC") |
25 |
||
26 |
val isabelle_tool = Isabelle_Tool("vscode_server", "VSCode Language Server for PIDE", args => |
|
27 |
{ |
|
64644 | 28 |
try { |
29 |
var log_file: Option[Path] = None |
|
64682 | 30 |
var text_length = Text.Length.encoding(default_text_length) |
64644 | 31 |
var dirs: List[Path] = Nil |
32 |
var logic = default_logic |
|
33 |
var modes: List[String] = Nil |
|
34 |
var options = Options.init() |
|
64605 | 35 |
|
64644 | 36 |
def text_length_choice: String = |
64682 | 37 |
commas(Text.Length.encodings.map( |
64644 | 38 |
{ case (a, _) => if (a == default_text_length) a + " (default)" else a })) |
64618 | 39 |
|
64644 | 40 |
val getopts = Getopts(""" |
64605 | 41 |
Usage: isabelle vscode_server [OPTIONS] |
42 |
||
43 |
Options are: |
|
44 |
-L FILE enable logging on FILE |
|
64618 | 45 |
-T LENGTH text length encoding: """ + text_length_choice + """ |
64605 | 46 |
-d DIR include session directory |
47 |
-l NAME logic session name (default ISABELLE_LOGIC=""" + quote(logic) + """) |
|
48 |
-m MODE add print mode for output |
|
49 |
-o OPTION override Isabelle system OPTION (via NAME=VAL or NAME) |
|
50 |
||
51 |
Run the VSCode Language Server protocol (JSON RPC) over stdin/stdout. |
|
52 |
""", |
|
64644 | 53 |
"L:" -> (arg => log_file = Some(Path.explode(arg))), |
64682 | 54 |
"T:" -> (arg => Text.Length.encoding(arg)), |
64644 | 55 |
"d:" -> (arg => dirs = dirs ::: List(Path.explode(arg))), |
56 |
"l:" -> (arg => logic = arg), |
|
57 |
"m:" -> (arg => modes = arg :: modes), |
|
58 |
"o:" -> (arg => options = options + arg)) |
|
64605 | 59 |
|
64644 | 60 |
val more_args = getopts(args) |
61 |
if (more_args.nonEmpty) getopts.usage() |
|
62 |
||
63 |
if (!Build.build(options = options, build_heap = true, no_build = true, |
|
64 |
dirs = dirs, sessions = List(logic)).ok) |
|
65 |
error("Missing logic image " + quote(logic)) |
|
64605 | 66 |
|
64717 | 67 |
val log = Logger.make(log_file) |
68 |
val channel = new Channel(System.in, System.out, log) |
|
69 |
val server = new Server(channel, options, text_length, logic, dirs, modes, log) |
|
64605 | 70 |
|
64644 | 71 |
// prevent spurious garbage on the main protocol channel |
72 |
val orig_out = System.out |
|
73 |
try { |
|
74 |
System.setOut(new PrintStream(new OutputStream { def write(n: Int) {} })) |
|
75 |
server.start() |
|
76 |
} |
|
77 |
finally { System.setOut(orig_out) } |
|
64605 | 78 |
} |
64644 | 79 |
catch { |
80 |
case exn: Throwable => |
|
64717 | 81 |
val channel = new Channel(System.in, System.out, No_Logger) |
64644 | 82 |
channel.error_message(Exn.message(exn)) |
83 |
throw(exn) |
|
84 |
} |
|
64605 | 85 |
}) |
86 |
} |
|
87 |
||
88 |
class Server( |
|
89 |
channel: Channel, |
|
90 |
options: Options, |
|
64682 | 91 |
text_length: Text.Length = Text.Length.encoding(Server.default_text_length), |
64605 | 92 |
session_name: String = Server.default_logic, |
93 |
session_dirs: List[Path] = Nil, |
|
64717 | 94 |
modes: List[String] = Nil, |
95 |
log: Logger = No_Logger) |
|
64605 | 96 |
{ |
64703 | 97 |
/* server session */ |
64605 | 98 |
|
64703 | 99 |
private val session_ = Synchronized(None: Option[Session]) |
100 |
def session: Session = session_.value getOrElse error("Server inactive") |
|
64623 | 101 |
def resources: VSCode_Resources = session.resources.asInstanceOf[VSCode_Resources] |
64605 | 102 |
|
64651 | 103 |
def rendering_offset(node_pos: Line.Node_Position): Option[(VSCode_Rendering, Text.Offset)] = |
64649 | 104 |
for { |
64703 | 105 |
model <- resources.get_model(node_pos.name) |
64704 | 106 |
rendering = model.rendering() |
64683
c0c09b6dfbe0
clarified signature: maintan Text.Length within Line.Document;
wenzelm
parents:
64682
diff
changeset
|
107 |
offset <- model.doc.offset(node_pos.pos) |
64649 | 108 |
} yield (rendering, offset) |
109 |
||
64605 | 110 |
|
64710 | 111 |
/* document content */ |
64679
b2bf280b7e13
more uniform treatment of input/output wrt. client;
wenzelm
parents:
64673
diff
changeset
|
112 |
|
64703 | 113 |
private def update_document(uri: String, text: String) |
64679
b2bf280b7e13
more uniform treatment of input/output wrt. client;
wenzelm
parents:
64673
diff
changeset
|
114 |
{ |
64709 | 115 |
resources.update_model(session, uri, text) |
64679
b2bf280b7e13
more uniform treatment of input/output wrt. client;
wenzelm
parents:
64673
diff
changeset
|
116 |
delay_input.invoke() |
b2bf280b7e13
more uniform treatment of input/output wrt. client;
wenzelm
parents:
64673
diff
changeset
|
117 |
} |
b2bf280b7e13
more uniform treatment of input/output wrt. client;
wenzelm
parents:
64673
diff
changeset
|
118 |
|
64710 | 119 |
private def close_document(uri: String) |
120 |
{ |
|
121 |
resources.close_model(uri) match { |
|
122 |
case Some(model) => |
|
123 |
model.register(watcher) |
|
124 |
sync_external(Set(model.file)) |
|
125 |
case None => |
|
126 |
} |
|
127 |
} |
|
128 |
||
129 |
private def sync_external(changed: Set[JFile]): Unit = |
|
64722 | 130 |
if (resources.sync_models(changed)) delay_input.invoke() |
64710 | 131 |
|
132 |
private val watcher = File_Watcher(sync_external(_)) |
|
133 |
||
134 |
||
135 |
/* input from client */ |
|
136 |
||
137 |
private val delay_input = |
|
138 |
Standard_Thread.delay_last(options.seconds("vscode_input_delay")) |
|
139 |
{ resources.flush_input(session) } |
|
140 |
||
64679
b2bf280b7e13
more uniform treatment of input/output wrt. client;
wenzelm
parents:
64673
diff
changeset
|
141 |
|
b2bf280b7e13
more uniform treatment of input/output wrt. client;
wenzelm
parents:
64673
diff
changeset
|
142 |
/* output to client */ |
b2bf280b7e13
more uniform treatment of input/output wrt. client;
wenzelm
parents:
64673
diff
changeset
|
143 |
|
b2bf280b7e13
more uniform treatment of input/output wrt. client;
wenzelm
parents:
64673
diff
changeset
|
144 |
private val commands_changed = |
b2bf280b7e13
more uniform treatment of input/output wrt. client;
wenzelm
parents:
64673
diff
changeset
|
145 |
Session.Consumer[Session.Commands_Changed](getClass.getName) { |
64703 | 146 |
case changed if changed.nodes.nonEmpty => |
64708 | 147 |
resources.update_output(changed.nodes.toList.map(_.node)) |
64679
b2bf280b7e13
more uniform treatment of input/output wrt. client;
wenzelm
parents:
64673
diff
changeset
|
148 |
delay_output.invoke() |
64703 | 149 |
case _ => |
64679
b2bf280b7e13
more uniform treatment of input/output wrt. client;
wenzelm
parents:
64673
diff
changeset
|
150 |
} |
b2bf280b7e13
more uniform treatment of input/output wrt. client;
wenzelm
parents:
64673
diff
changeset
|
151 |
|
64691
db2b21a52f20
prefer stable state -- reduce repeated diagnostics;
wenzelm
parents:
64690
diff
changeset
|
152 |
private val delay_output: Standard_Thread.Delay = |
64703 | 153 |
Standard_Thread.delay_last(options.seconds("vscode_output_delay")) |
154 |
{ |
|
64691
db2b21a52f20
prefer stable state -- reduce repeated diagnostics;
wenzelm
parents:
64690
diff
changeset
|
155 |
if (session.current_state().stable_tip_version.isEmpty) delay_output.invoke() |
64703 | 156 |
else resources.flush_output(channel) |
64679
b2bf280b7e13
more uniform treatment of input/output wrt. client;
wenzelm
parents:
64673
diff
changeset
|
157 |
} |
b2bf280b7e13
more uniform treatment of input/output wrt. client;
wenzelm
parents:
64673
diff
changeset
|
158 |
|
b2bf280b7e13
more uniform treatment of input/output wrt. client;
wenzelm
parents:
64673
diff
changeset
|
159 |
|
64710 | 160 |
/* file watcher */ |
161 |
||
162 |
||
64692 | 163 |
/* syslog */ |
164 |
||
165 |
private val all_messages = |
|
166 |
Session.Consumer[Prover.Message](getClass.getName) { |
|
167 |
case output: Prover.Output if output.is_syslog => |
|
168 |
channel.log_writeln(XML.content(output.message)) |
|
169 |
case _ => |
|
170 |
} |
|
171 |
||
172 |
||
64605 | 173 |
/* init and exit */ |
174 |
||
64641 | 175 |
def init(id: Protocol.Id) |
64605 | 176 |
{ |
64641 | 177 |
def reply(err: String) |
178 |
{ |
|
179 |
channel.write(Protocol.Initialize.reply(id, err)) |
|
64642
c231206a84c8
display messages, according to regular Isabelle Output;
wenzelm
parents:
64641
diff
changeset
|
180 |
if (err == "") |
c231206a84c8
display messages, according to regular Isabelle Output;
wenzelm
parents:
64641
diff
changeset
|
181 |
channel.writeln("Welcome to Isabelle/" + session_name + " (" + Distribution.version + ")") |
c231206a84c8
display messages, according to regular Isabelle Output;
wenzelm
parents:
64641
diff
changeset
|
182 |
else channel.error_message(err) |
64641 | 183 |
} |
184 |
||
64643 | 185 |
val try_session = |
186 |
try { |
|
187 |
val content = Build.session_content(options, false, session_dirs, session_name) |
|
188 |
val resources = |
|
64720 | 189 |
new VSCode_Resources(options, text_length, content.loaded_theories, |
190 |
content.known_theories, content.syntax, log) |
|
64605 | 191 |
|
64643 | 192 |
Some(new Session(resources) { |
193 |
override def output_delay = options.seconds("editor_output_delay") |
|
194 |
override def prune_delay = options.seconds("editor_prune_delay") |
|
195 |
override def syslog_limit = options.int("editor_syslog_limit") |
|
196 |
override def reparse_limit = options.int("editor_reparse_limit") |
|
197 |
}) |
|
64605 | 198 |
} |
64643 | 199 |
catch { case ERROR(msg) => reply(msg); None } |
64605 | 200 |
|
64643 | 201 |
for (session <- try_session) { |
202 |
var session_phase: Session.Consumer[Session.Phase] = null |
|
203 |
session_phase = |
|
204 |
Session.Consumer(getClass.getName) { |
|
205 |
case Session.Ready => |
|
206 |
session.phase_changed -= session_phase |
|
207 |
session.update_options(options) |
|
208 |
reply("") |
|
209 |
case Session.Failed => |
|
210 |
session.phase_changed -= session_phase |
|
211 |
reply("Prover startup failed") |
|
212 |
case _ => |
|
213 |
} |
|
214 |
session.phase_changed += session_phase |
|
64605 | 215 |
|
64679
b2bf280b7e13
more uniform treatment of input/output wrt. client;
wenzelm
parents:
64673
diff
changeset
|
216 |
session.commands_changed += commands_changed |
64692 | 217 |
session.all_messages += all_messages |
64679
b2bf280b7e13
more uniform treatment of input/output wrt. client;
wenzelm
parents:
64673
diff
changeset
|
218 |
|
64643 | 219 |
session.start(receiver => |
220 |
Isabelle_Process(options = options, logic = session_name, dirs = session_dirs, |
|
221 |
modes = modes, receiver = receiver)) |
|
64605 | 222 |
|
64703 | 223 |
session_.change(_ => Some(session)) |
64643 | 224 |
} |
64605 | 225 |
} |
226 |
||
64641 | 227 |
def shutdown(id: Protocol.Id) |
64605 | 228 |
{ |
64641 | 229 |
def reply(err: String): Unit = channel.write(Protocol.Shutdown.reply(id, err)) |
230 |
||
64703 | 231 |
session_.change({ |
232 |
case Some(session) => |
|
233 |
var session_phase: Session.Consumer[Session.Phase] = null |
|
234 |
session_phase = |
|
235 |
Session.Consumer(getClass.getName) { |
|
236 |
case Session.Inactive => |
|
237 |
session.phase_changed -= session_phase |
|
238 |
session.commands_changed -= commands_changed |
|
239 |
session.all_messages -= all_messages |
|
240 |
reply("") |
|
241 |
case _ => |
|
242 |
} |
|
243 |
session.phase_changed += session_phase |
|
244 |
session.stop() |
|
245 |
delay_input.revoke() |
|
246 |
delay_output.revoke() |
|
64710 | 247 |
watcher.shutdown() |
64703 | 248 |
None |
249 |
case None => |
|
250 |
reply("Prover inactive") |
|
251 |
None |
|
252 |
}) |
|
64605 | 253 |
} |
254 |
||
64646 | 255 |
def exit() { |
64717 | 256 |
log("\n") |
64703 | 257 |
sys.exit(if (session_.value.isDefined) 1 else 0) |
64646 | 258 |
} |
64605 | 259 |
|
260 |
||
64622
529bbb8977c7
more uniform rendering for Isabelle/jEdit and Isabelle/VSCode;
wenzelm
parents:
64618
diff
changeset
|
261 |
/* hover */ |
64605 | 262 |
|
64651 | 263 |
def hover(id: Protocol.Id, node_pos: Line.Node_Position) |
64641 | 264 |
{ |
265 |
val result = |
|
266 |
for { |
|
64651 | 267 |
(rendering, offset) <- rendering_offset(node_pos) |
64641 | 268 |
info <- rendering.tooltip(Text.Range(offset, offset + 1)) |
269 |
} yield { |
|
64649 | 270 |
val doc = rendering.model.doc |
64683
c0c09b6dfbe0
clarified signature: maintan Text.Length within Line.Document;
wenzelm
parents:
64682
diff
changeset
|
271 |
val range = doc.range(info.range) |
64641 | 272 |
val s = Pretty.string_of(info.info, margin = rendering.tooltip_margin) |
64679
b2bf280b7e13
more uniform treatment of input/output wrt. client;
wenzelm
parents:
64673
diff
changeset
|
273 |
(range, List("```\n" + s + "\n```")) // FIXME proper content format |
64641 | 274 |
} |
275 |
channel.write(Protocol.Hover.reply(id, result)) |
|
276 |
} |
|
64605 | 277 |
|
278 |
||
64648
5d7f741aaccb
basic support for hyperlinks / Goto Definition Request;
wenzelm
parents:
64646
diff
changeset
|
279 |
/* goto definition */ |
5d7f741aaccb
basic support for hyperlinks / Goto Definition Request;
wenzelm
parents:
64646
diff
changeset
|
280 |
|
64651 | 281 |
def goto_definition(id: Protocol.Id, node_pos: Line.Node_Position) |
64648
5d7f741aaccb
basic support for hyperlinks / Goto Definition Request;
wenzelm
parents:
64646
diff
changeset
|
282 |
{ |
5d7f741aaccb
basic support for hyperlinks / Goto Definition Request;
wenzelm
parents:
64646
diff
changeset
|
283 |
val result = |
64651 | 284 |
(for ((rendering, offset) <- rendering_offset(node_pos)) |
64649 | 285 |
yield rendering.hyperlinks(Text.Range(offset, offset + 1))) getOrElse Nil |
64648
5d7f741aaccb
basic support for hyperlinks / Goto Definition Request;
wenzelm
parents:
64646
diff
changeset
|
286 |
channel.write(Protocol.GotoDefinition.reply(id, result)) |
5d7f741aaccb
basic support for hyperlinks / Goto Definition Request;
wenzelm
parents:
64646
diff
changeset
|
287 |
} |
5d7f741aaccb
basic support for hyperlinks / Goto Definition Request;
wenzelm
parents:
64646
diff
changeset
|
288 |
|
5d7f741aaccb
basic support for hyperlinks / Goto Definition Request;
wenzelm
parents:
64646
diff
changeset
|
289 |
|
64605 | 290 |
/* main loop */ |
291 |
||
292 |
def start() |
|
293 |
{ |
|
64717 | 294 |
log("Server started " + Date.now()) |
64605 | 295 |
|
296 |
def handle(json: JSON.T) |
|
297 |
{ |
|
298 |
try { |
|
299 |
json match { |
|
64641 | 300 |
case Protocol.Initialize(id) => init(id) |
301 |
case Protocol.Shutdown(id) => shutdown(id) |
|
64645 | 302 |
case Protocol.Exit(()) => exit() |
64605 | 303 |
case Protocol.DidOpenTextDocument(uri, lang, version, text) => |
304 |
update_document(uri, text) |
|
305 |
case Protocol.DidChangeTextDocument(uri, version, List(Protocol.TextDocumentContent(text))) => |
|
306 |
update_document(uri, text) |
|
64710 | 307 |
case Protocol.DidCloseTextDocument(uri) => |
308 |
close_document(uri) |
|
64651 | 309 |
case Protocol.Hover(id, node_pos) => hover(id, node_pos) |
310 |
case Protocol.GotoDefinition(id, node_pos) => goto_definition(id, node_pos) |
|
64717 | 311 |
case _ => log("### IGNORED") |
64605 | 312 |
} |
313 |
} |
|
64687 | 314 |
catch { case exn: Throwable => channel.log_error_message(Exn.message(exn)) } |
64605 | 315 |
} |
316 |
||
317 |
@tailrec def loop() |
|
318 |
{ |
|
319 |
channel.read() match { |
|
320 |
case Some(json) => |
|
321 |
json match { |
|
322 |
case bulk: List[_] => bulk.foreach(handle(_)) |
|
323 |
case _ => handle(json) |
|
324 |
} |
|
325 |
loop() |
|
64717 | 326 |
case None => log("### TERMINATE") |
64605 | 327 |
} |
328 |
} |
|
329 |
loop() |
|
330 |
} |
|
331 |
} |