src/Doc/System/Server.thy
author wenzelm
Sat Mar 24 21:14:49 2018 +0100 (14 months ago)
changeset 67946 e1e57c288e45
parent 67944 cb2b1a75ff59
child 68106 a514e29db980
permissions -rw-r--r--
session tmp_dir is default master_dir;
     1 (*:maxLineLen=78:*)
     2 
     3 theory Server
     4 imports Base
     5 begin
     6 
     7 chapter \<open>The Isabelle server\<close>
     8 
     9 text \<open>
    10   An Isabelle session requires at least two processes, which are both rather
    11   heavy: Isabelle/Scala for the system infrastructure and Isabelle/ML for the
    12   logic session (e.g.\ HOL). In principle, these processes can be invoked
    13   directly on the command-line, e.g.\ via @{tool java}, @{tool scala}, @{tool
    14   process}, @{tool console}, but this approach is inadequate for reactive
    15   applications that require quick responses from the prover.
    16 
    17   In contrast, the Isabelle server exposes Isabelle/Scala as a
    18   ``terminate-stay-resident'' application that manages multiple logic
    19   \<^emph>\<open>sessions\<close> and concurrent tasks to use \<^emph>\<open>theories\<close>. This provides an
    20   analogous to @{ML Thy_Info.use_theories} in Isabelle/ML, but with full
    21   concurrency and Isabelle/PIDE markup.
    22 
    23   The client/server arrangement via TCP sockets also opens possibilities for
    24   remote Isabelle services that are accessed by local applications, e.g.\ via
    25   an SSH tunnel.
    26 \<close>
    27 
    28 
    29 section \<open>Command-line tools\<close>
    30 
    31 subsection \<open>Server \label{sec:tool-server}\<close>
    32 
    33 text \<open>
    34   The @{tool_def server} tool manages resident server processes:
    35   @{verbatim [display]
    36 \<open>Usage: isabelle server [OPTIONS]
    37 
    38   Options are:
    39     -L FILE      logging on FILE
    40     -c           console interaction with specified server
    41     -l           list servers (alternative operation)
    42     -n NAME      explicit server name (default: isabelle)
    43     -p PORT      explicit server port
    44     -s           assume existing server, no implicit startup
    45     -x           exit specified server (alternative operation)
    46 
    47   Manage resident Isabelle servers.\<close>}
    48 
    49   The main operation of \<^verbatim>\<open>isabelle server\<close> is to ensure that a named server is
    50   running, either by finding an already running process (according to the
    51   central database file @{path "$ISABELLE_HOME_USER/servers.db"}) or by
    52   becoming itself a new server that accepts connections on a particular TCP
    53   socket. The server name and its address are printed as initial output line.
    54   If another server instance is already running, the current
    55   \<^verbatim>\<open>isabelle server\<close> process will terminate; otherwise, it keeps running as a
    56   new server process until an explicit \<^verbatim>\<open>shutdown\<close> command is received.
    57   Further details of the server socket protocol are explained in
    58   \secref{sec:server-protocol}.
    59 
    60   Other server management operations are invoked via options \<^verbatim>\<open>-l\<close> and \<^verbatim>\<open>-x\<close>
    61   (see below).
    62 
    63   \<^medskip>
    64   Option \<^verbatim>\<open>-n\<close> specifies an alternative server name: at most one process for
    65   each name may run, but each server instance supports multiple connections
    66   and logic sessions.
    67 
    68   \<^medskip>
    69   Option \<^verbatim>\<open>-p\<close> specifies an explicit TCP port for the server socket (which is
    70   always on \<^verbatim>\<open>localhost\<close>): the default is to let the operating system assign a
    71   free port number.
    72 
    73   \<^medskip>
    74   Option \<^verbatim>\<open>-s\<close> strictly assumes that the specified server process is already
    75   running, skipping the optional server startup phase.
    76 
    77   \<^medskip>
    78   Option \<^verbatim>\<open>-c\<close> connects the console in/out channels after the initial check
    79   for a suitable server process. Also note that the @{tool client} tool
    80   (\secref{sec:tool-client}) provides a command-line editor to interact with
    81   the server.
    82 
    83   \<^medskip>
    84   Option \<^verbatim>\<open>-L\<close> specifies a log file for exceptional output of internal server
    85   and session operations.
    86 
    87   \<^medskip>
    88   Operation \<^verbatim>\<open>-l\<close> lists all active server processes with their connection
    89   details.
    90 
    91   \<^medskip>
    92   Operation \<^verbatim>\<open>-x\<close> exits the specified server process by sending it a
    93   \<^verbatim>\<open>shutdown\<close> command.
    94 \<close>
    95 
    96 
    97 subsection \<open>Client \label{sec:tool-client}\<close>
    98 
    99 text \<open>
   100   The @{tool_def client} tool provides console interaction for Isabelle
   101   servers:
   102   @{verbatim [display]
   103 \<open>Usage: isabelle client [OPTIONS]
   104 
   105   Options are:
   106     -n NAME      explicit server name
   107     -p PORT      explicit server port
   108 
   109   Console interaction for Isabelle server (with line-editor).\<close>}
   110 
   111   This is a wrapper to \<^verbatim>\<open>isabelle server -s -c\<close> for interactive
   112   experimentation, which uses @{setting ISABELLE_LINE_EDITOR} if available.
   113   The server name is sufficient for identification, as the client can
   114   determine the connection details from the local database of active servers.
   115 
   116   \<^medskip>
   117   Option \<^verbatim>\<open>-n\<close> specifies an explicit server name as in @{tool server}.
   118 
   119   \<^medskip>
   120   Option \<^verbatim>\<open>-p\<close> specifies an explicit server port as in @{tool server}.
   121 \<close>
   122 
   123 
   124 subsection \<open>Examples\<close>
   125 
   126 text \<open>
   127   Ensure that a particular server instance is running in the background:
   128   @{verbatim [display] \<open>isabelle server -n test &\<close>}
   129 
   130   The first line of output presents the connection details:\<^footnote>\<open>This information
   131   may be used in other TCP clients, without access to Isabelle/Scala and the
   132   underlying database of running servers.\<close>
   133   @{verbatim [display] \<open>server "test" = 127.0.0.1:4711 (password "XYZ")\<close>}
   134 
   135   \<^medskip>
   136   List available server processes:
   137   @{verbatim [display] \<open>isabelle server -l\<close>}
   138 
   139   \<^medskip>
   140   Connect the command-line client to the above test server:
   141   @{verbatim [display] \<open>isabelle client -n test\<close>}
   142 
   143   Interaction now works on a line-by-line basis, with commands like \<^verbatim>\<open>help\<close> or
   144   \<^verbatim>\<open>echo\<close>. For example, some JSON values may be echoed like this:
   145 
   146   @{verbatim [display]
   147 \<open>echo 42
   148 echo [1, 2, 3]
   149 echo {"a": "text", "b": true, "c": 42}\<close>}
   150 
   151   Closing the connection (via CTRL-D) leaves the server running: it is
   152   possible to reconnect again, and have multiple connections at the same time.
   153 
   154   \<^medskip>
   155   Exit the named server on the command-line:
   156   @{verbatim [display] \<open>isabelle server -n test -x\<close>}
   157 \<close>
   158 
   159 
   160 section \<open>Protocol messages \label{sec:server-protocol}\<close>
   161 
   162 text \<open>
   163   The Isabelle server listens on a regular TCP socket, using a line-oriented
   164   protocol of structured messages. Input \<^emph>\<open>commands\<close> and output \<^emph>\<open>results\<close>
   165   (via \<^verbatim>\<open>OK\<close> or \<^verbatim>\<open>ERROR\<close>) are strictly alternating on the toplevel, but
   166   commands may also return a \<^emph>\<open>task\<close> identifier to indicate an ongoing
   167   asynchronous process that is joined later (via \<^verbatim>\<open>FINISHED\<close> or \<^verbatim>\<open>FAILED\<close>).
   168   Asynchronous \<^verbatim>\<open>NOTE\<close> messages may occur at any time: they are independent of
   169   the main command-result protocol.
   170 
   171   For example, the synchronous \<^verbatim>\<open>echo\<close> command immediately returns its
   172   argument as \<^verbatim>\<open>OK\<close> result. In contrast, the asynchronous \<^verbatim>\<open>session_build\<close>
   173   command returns \<^verbatim>\<open>OK {"task":\<close>\<open>id\<close>\<^verbatim>\<open>}\<close> and continues in the background. It
   174   will eventually produce \<^verbatim>\<open>FINISHED {"task":\<close>\<open>id\<close>\<^verbatim>\<open>,\<close>\<open>\<dots>\<close>\<^verbatim>\<open>}\<close> or
   175   \<^verbatim>\<open>FAILED {"task":\<close>\<open>id\<close>\<^verbatim>\<open>,\<close>\<open>\<dots>\<close>\<^verbatim>\<open>}\<close> with the final result. Intermediately, it
   176   may emit asynchronous messages of the form \<^verbatim>\<open>NOTE {"task":\<close>\<open>id\<close>\<^verbatim>\<open>,\<close>\<open>\<dots>\<close>\<^verbatim>\<open>}\<close>
   177   to inform about its progress. Due to the explicit task identifier, the
   178   client can show these messages in the proper context, e.g.\ a GUI window for
   179   this particular session build job.
   180 
   181   \medskip Subsequently, the protocol message formats are described in further
   182   detail.
   183 \<close>
   184 
   185 
   186 subsection \<open>Byte messages\<close>
   187 
   188 text \<open>
   189   The client-server connection is a raw byte-channel for bidirectional
   190   communication, but the Isabelle server always works with messages of a
   191   particular length. Messages are written as a single chunk that is flushed
   192   immediately.
   193 
   194   Message boundaries are determined as follows:
   195 
   196     \<^item> A \<^emph>\<open>short message\<close> consists of a single line: it is a sequence of
   197     arbitrary bytes excluding CR (13) and LF (10), and terminated by CR-LF or
   198     just LF.
   199 
   200     \<^item> A \<^emph>\<open>long message\<close> starts with a single that consists only of decimal
   201     digits: these are interpreted as length of the subsequent block of
   202     arbitrary bytes. A final line-terminator (as above) may be included here,
   203     but is not required.
   204 
   205   Messages in JSON format (see below) always fit on a single line, due to
   206   escaping of newline characters within string literals. This is convenient
   207   for interactive experimentation, but it can impact performance for very long
   208   messages. If the message byte-length is given on the preceding line, the
   209   server can read the message more efficiently as a single block.
   210 \<close>
   211 
   212 
   213 subsection \<open>Text messages\<close>
   214 
   215 text \<open>
   216   Messages are read and written as byte streams (with byte lengths), but the
   217   content is always interpreted as plain text in terms of the UTF-8
   218   encoding.\<^footnote>\<open>See also the ``UTF-8 Everywhere Manifesto''
   219   \<^url>\<open>http://utf8everywhere.org\<close>.\<close>
   220 
   221   Note that line-endings and other formatting characters are invariant wrt.
   222   UTF-8 representation of text: thus implementations are free to determine the
   223   overall message structure before or after applying the text encoding.
   224 \<close>
   225 
   226 
   227 subsection \<open>Input and output messages \label{sec:input-output-messages}\<close>
   228 
   229 text \<open>
   230   Server input and output messages have a uniform format as follows:
   231 
   232     \<^item> \<open>name argument\<close> such that:
   233 
   234     \<^item> \<open>name\<close> is the longest prefix consisting of ASCII letters, digits,
   235     ``\<^verbatim>\<open>_\<close>'', ``\<^verbatim>\<open>.\<close>'',
   236 
   237     \<^item> the separator between \<open>name\<close> and \<open>argument\<close> is the longest possible
   238     sequence of ASCII blanks (it could be empty, e.g.\ when the argument
   239     starts with a quote or bracket),
   240 
   241     \<^item> \<open>argument\<close> is the rest of the message without line terminator.
   242 
   243   \<^medskip>
   244   Input messages are sent from the client to the server. Here the \<open>name\<close>
   245   specifies a \<^emph>\<open>server command\<close>: the list of known commands may be
   246   retrieved via the \<^verbatim>\<open>help\<close> command.
   247 
   248   \<^medskip>
   249   Output messages are sent from the server to the client. Here the \<open>name\<close>
   250   specifies the \<^emph>\<open>server reply\<close>, which always has a specific meaning as
   251   follows:
   252 
   253     \<^item> synchronous results: \<^verbatim>\<open>OK\<close> or \<^verbatim>\<open>ERROR\<close>
   254     \<^item> asynchronous results: \<^verbatim>\<open>FINISHED\<close> or \<^verbatim>\<open>FAILED\<close>
   255     \<^item> intermediate notifications: \<^verbatim>\<open>NOTE\<close>
   256 
   257   \<^medskip>
   258   The \<open>argument\<close> format is uniform for both input and output messages:
   259 
   260     \<^item> empty argument (Scala type \<^verbatim>\<open>Unit\<close>)
   261     \<^item> XML element in YXML notation (Scala type \<^verbatim>\<open>XML.Elem\<close>)
   262     \<^item> JSON value (Scala type \<^verbatim>\<open>JSON.T\<close>)
   263 
   264   JSON values may consist of objects (records), arrays (lists), strings,
   265   numbers, bools, null.\<^footnote>\<open>See also the official specification
   266   \<^url>\<open>https://www.json.org\<close> and unofficial explorations ``Parsing JSON is a
   267   Minefield'' \<^url>\<open>http://seriot.ch/parsing_json.php\<close>.\<close> Since JSON requires
   268   explicit quotes and backslash-escapes to represent arbitrary text, the YXML
   269   notation for XML trees (\secref{sec:yxml-vs-xml}) works better
   270   for large messages with a lot of PIDE markup.
   271 
   272   Nonetheless, the most common commands use JSON by default: big chunks of
   273   text (theory sources etc.) are taken from the underlying file-system and
   274   results are pre-formatted for plain-text output, without PIDE markup
   275   information. This is a concession to simplicity: the server imitates the
   276   appearance of command-line tools on top of the Isabelle/PIDE infrastructure.
   277 \<close>
   278 
   279 
   280 subsection \<open>Initial password exchange\<close>
   281 
   282 text \<open>
   283   Whenever a new client opens the server socket, the initial message needs to
   284   be its unique password. The server replies either with \<^verbatim>\<open>OK\<close> (and some
   285   information about the Isabelle version) or by silent disconnection of what
   286   is considered an illegal connection attempt. Note that @{tool client}
   287   already presents the correct password internally.
   288 
   289   Server passwords are created as Universally Unique Identifier (UUID) in
   290   Isabelle/Scala and stored in a per-user database, with restricted
   291   file-system access only for the current user. The Isabelle/Scala server
   292   implementation is careful to expose the password only on private output
   293   channels, and not on a process command-line (which is accessible to other
   294   users, e.g.\ via the \<^verbatim>\<open>ps\<close> command).
   295 \<close>
   296 
   297 
   298 subsection \<open>Synchronous commands\<close>
   299 
   300 text \<open>
   301   A \<^emph>\<open>synchronous command\<close> corresponds to regular function application in
   302   Isabelle/Scala, with single argument and result (regular or error). Both the
   303   argument and the result may consist of type \<^verbatim>\<open>Unit\<close>, \<^verbatim>\<open>XML.Elem\<close>, \<^verbatim>\<open>JSON.T\<close>.
   304   An error result typically consists of a JSON object with error message and
   305   potentially further result fields (this resembles exceptions in Scala).
   306 
   307   These are the protocol exchanges for both cases of command execution:
   308   \begin{center}
   309   \begin{tabular}{rl}
   310   \<^bold>\<open>input:\<close> & \<open>command argument\<close> \\
   311   (a) regular \<^bold>\<open>output:\<close> & \<^verbatim>\<open>OK\<close> \<open>result\<close> \\
   312   (b) error \<^bold>\<open>output:\<close> & \<^verbatim>\<open>ERROR\<close> \<open>result\<close> \\
   313   \end{tabular}
   314   \end{center}
   315 \<close>
   316 
   317 
   318 subsection \<open>Asynchronous commands\<close>
   319 
   320 text \<open>
   321   An \<^emph>\<open>asynchronous command\<close> corresponds to an ongoing process that finishes
   322   or fails eventually, while emitting arbitrary notifications in between.
   323   Formally, it starts as synchronous command with immediate result \<^verbatim>\<open>OK\<close>
   324   giving the \<^verbatim>\<open>task\<close> identifier, or an immediate \<^verbatim>\<open>ERROR\<close> that indicates bad
   325   command syntax. For a running task, the termination is indicated later by
   326   \<^verbatim>\<open>FINISHED\<close> or \<^verbatim>\<open>FAILED\<close>, together with its ultimate result value.
   327 
   328   These are the protocol exchanges for various cases of command task
   329   execution:
   330 
   331   \begin{center}
   332   \begin{tabular}{rl}
   333   \<^bold>\<open>input:\<close> & \<open>command argument\<close> \\
   334   immediate \<^bold>\<open>output:\<close> & \<^verbatim>\<open>OK {"task":\<close>\<open>id\<close>\<^verbatim>\<open>}\<close> \\
   335   intermediate \<^bold>\<open>output:\<close> & \<^verbatim>\<open>NOTE {"task":\<close>\<open>id\<close>\<^verbatim>\<open>,\<close>\<open>\<dots>\<close>\<^verbatim>\<open>}\<close> \\
   336   (a) regular \<^bold>\<open>output:\<close> & \<^verbatim>\<open>FINISHED {"task":\<close>\<open>id\<close>\<^verbatim>\<open>,\<close>\<open>\<dots>\<close>\<^verbatim>\<open>}\<close> \\
   337   (b) error \<^bold>\<open>output:\<close> & \<^verbatim>\<open>FAILED {"task":\<close>\<open>id\<close>\<^verbatim>\<open>,\<close>\<open>\<dots>\<close>\<^verbatim>\<open>}\<close> \\[3ex]
   338   \<^bold>\<open>input:\<close> & \<open>command argument\<close> \\
   339   immediate \<^bold>\<open>output:\<close> & \<^verbatim>\<open>ERROR\<close>~\<open>\<dots>\<close> \\
   340   \end{tabular}
   341   \end{center}
   342 
   343   All asynchronous messages are decorated with the task identifier that was
   344   revealed in the immediate (synchronous) result. Thus the client can
   345   invoke further asynchronous commands and still dispatch the resulting stream of
   346   asynchronous messages properly.
   347 
   348   The synchronous command \<^verbatim>\<open>cancel {"task":\<close>~\<open>id\<close>\<^verbatim>\<open>}\<close> tells the specified task
   349   to terminate prematurely: usually causing a \<^verbatim>\<open>FAILED\<close> result, but this is
   350   not guaranteed: the cancel event may come too late or the running process
   351   may just ignore it.
   352 \<close>
   353 
   354 
   355 section \<open>Types for JSON values \label{sec:json-types}\<close>
   356 
   357 text \<open>
   358   In order to specify concrete JSON types for command arguments and result
   359   messages, the following type definition language shall be used:
   360 
   361   \<^rail>\<open>
   362     @{syntax type_def}: @'type' @{syntax name} '=' @{syntax type}
   363     ;
   364     @{syntax type}: @{syntax name} | @{syntax value} | 'any' | 'null' |
   365       'bool' | 'int' | 'long' | 'double' | 'string' | '[' @{syntax type} ']' |
   366       '{' (@{syntax field_type} ',' *) '}' |
   367       @{syntax type} '\<oplus>' @{syntax type} |
   368       @{syntax type} '|' @{syntax type} |
   369       '(' @{syntax type} ')'
   370     ;
   371     @{syntax field_type}: @{syntax name} ('?'?) ':' @{syntax type}
   372   \<close>
   373 
   374   This is a simplified variation of TypeScript
   375   interfaces.\<^footnote>\<open>\<^url>\<open>https://www.typescriptlang.org/docs/handbook/interfaces.html\<close>\<close>
   376   The meaning of these types is specified wrt. the Isabelle/Scala
   377   implementation as follows.
   378 
   379   \<^item> A \<open>name\<close> refers to a type defined elsewhere. The environment of type
   380   definitions is given informally: put into proper foundational order, it
   381   needs to specify a strongly normalizing system of syntactic abbreviations;
   382   type definitions may not be recursive.
   383 
   384   \<^item> A \<open>value\<close> in JSON notation represents the singleton type of the given
   385   item. For example, the string \<^verbatim>\<open>"error"\<close> can be used as type for a slot that
   386   is guaranteed to contain that constant.
   387 
   388   \<^item> Type \<open>any\<close> is the super type of all other types: it is an untyped slot in
   389   the specification and corresponds to \<^verbatim>\<open>Any\<close> or \<^verbatim>\<open>JSON.T\<close> in Isabelle/Scala.
   390 
   391   \<^item> Type \<open>null\<close> is the type of the improper value \<open>null\<close>; it corresponds to
   392   type \<^verbatim>\<open>Null\<close> in Scala and is normally not used in Isabelle/Scala.\<^footnote>\<open>See also
   393   ``Null References: The Billion Dollar Mistake'' by Tony Hoare
   394   \<^url>\<open>https://www.infoq.com/presentations/Null-References-The-Billion-Dollar-Mistake-Tony-Hoare\<close>.\<close>
   395 
   396   \<^item> Type \<open>bool\<close> is the type of the truth values \<^verbatim>\<open>true\<close> and \<^verbatim>\<open>false\<close>; it
   397   corresponds to \<^verbatim>\<open>Boolean\<close> in Scala.
   398 
   399   \<^item> Types \<open>int\<close>, \<open>long\<close>, \<open>double\<close> are specific versions of the generic
   400   \<open>number\<close> type, corresponding to \<^verbatim>\<open>Int\<close>, \<^verbatim>\<open>Long\<close>, \<^verbatim>\<open>Double\<close> in Scala, but
   401   \<^verbatim>\<open>Long\<close> is limited to 53 bit precision.\<^footnote>\<open>Implementations of JSON typically
   402   standardize \<open>number\<close> to \<^verbatim>\<open>Double\<close>, which can absorb \<^verbatim>\<open>Int\<close> faithfully, but
   403   not all of \<^verbatim>\<open>Long\<close>.\<close>
   404 
   405   \<^item> Type \<open>string\<close> represents Unicode text; it corresponds to type \<^verbatim>\<open>String\<close> in
   406   Scala.
   407 
   408   \<^item> Type \<open>[t]\<close> is the array (or list) type over \<open>t\<close>; it corresponds to
   409   \<^verbatim>\<open>List[t]\<close> in Scala. The list type is co-variant as usual (i.e.\ monotonic
   410   wrt. the subtype relation).
   411 
   412   \<^item> Object types describe the possible content of JSON records, with field
   413   names and types. A question mark after a field name means that it is
   414   optional. In Scala this could refer to an explicit type \<^verbatim>\<open>Option[t]\<close>, e.g.\
   415   \<open>{a: int, b?: string}\<close> corresponding to a Scala case class with arguments
   416   \<^verbatim>\<open>a: Int\<close>, \<^verbatim>\<open>b: Option[String]\<close>.
   417 
   418   Alternatively, optional fields can have a default value. If nothing else is
   419   specified, a standard ``empty value'' is used for each type, i.e.\ \<^verbatim>\<open>0\<close> for
   420   the number types, \<^verbatim>\<open>false\<close> for \<open>bool\<close>, or the empty string, array, object
   421   etc.
   422 
   423   Object types are \<^emph>\<open>permissive\<close> in the sense that only the specified field
   424   names need to conform to the given types, but unspecified fields may be
   425   present as well.
   426 
   427   \<^item> The type expression \<open>t\<^sub>1 \<oplus> t\<^sub>2\<close> only works for two object types with
   428   disjoint field names: it is the concatenation of the respective @{syntax
   429   field_type} specifications taken together. For example: \<open>{task: string} \<oplus>
   430   {ok: bool}\<close> is the equivalent to \<open>{task: string, ok: bool}\<close>.
   431 
   432   \<^item> The type expression \<open>t\<^sub>1 | t\<^sub>2\<close> is the disjoint union of two types, either
   433   one of the two cases may occur.
   434 
   435   \<^item> Parentheses \<open>(t)\<close> merely group type expressions syntactically.
   436 
   437 
   438   These types correspond to JSON values in an obvious manner, which is not
   439   further described here. For example, the JSON array \<^verbatim>\<open>[1, 2, 3]\<close> conforms to
   440   types \<open>[int]\<close>, \<open>[long]\<close>, \<open>[double]\<close>, \<open>[any]\<close>, \<open>any\<close>.
   441 
   442   Note that JSON objects require field names to be quoted, but the type
   443   language omits quotes for clarity. Thus the object \<^verbatim>\<open>{"a": 42, "b": "xyz"}\<close>
   444   conforms to the type \<open>{a: int, b: string}\<close>, for example.
   445 
   446   \<^medskip>
   447   The absence of an argument or result is represented by the Scala type
   448   \<^verbatim>\<open>Unit\<close>: it is written as empty text in the message \<open>argument\<close>
   449   (\secref{sec:input-output-messages}). This is not part of the JSON language.
   450 
   451   Server replies have name tags like \<^verbatim>\<open>OK\<close>, \<^verbatim>\<open>ERROR\<close>: these are used literally
   452   together with type specifications to indicate the particular name with the
   453   type of its argument, e.g.\ \<^verbatim>\<open>OK\<close>~\<open>[string]\<close> for a regular result that is a
   454   list (JSON array) of strings.
   455 
   456   \<^bigskip>
   457   Here are some common type definitions, for use in particular specifications
   458   of command arguments and results.
   459 
   460   \<^item> \<^bold>\<open>type\<close>~\<open>position = {line?: int, offset?: int, end_offset?: int, file?:
   461   string, id?: long}\<close> describes a source position within Isabelle text. Only
   462   the \<open>line\<close> and \<open>file\<close> fields make immediate sense to external programs.
   463   Detailed \<open>offset\<close> and \<open>end_offset\<close> positions are counted according to
   464   Isabelle symbols, see @{ML_type Symbol.symbol} in Isabelle/ML @{cite
   465   "isabelle-implementation"}. The position \<open>id\<close> belongs to the representation
   466   of command transactions in the Isabelle/PIDE protocol: it normally does not
   467   occur in externalized positions.
   468 
   469   \<^item> \<^bold>\<open>type\<close>~\<open>message = {kind: string, message: string, pos?: position}\<close> where
   470   the \<open>kind\<close> provides some hint about the role and importance of the message.
   471   The main message kinds are \<^verbatim>\<open>writeln\<close> (for regular output), \<^verbatim>\<open>warning\<close>,
   472   \<^verbatim>\<open>error\<close>.
   473 
   474   \<^item> \<^bold>\<open>type\<close>~\<open>error_message = {kind:\<close>~\<^verbatim>\<open>"error"\<close>\<open>, message: string}\<close> refers to
   475   error messages in particular. These occur routinely with \<^verbatim>\<open>ERROR\<close> or
   476   \<^verbatim>\<open>FAILED\<close> replies, but also as initial command syntax errors (which are
   477   omitted in the command specifications below).
   478 
   479   \<^item> \<^bold>\<open>type\<close>~\<open>theory_progress = {kind:\<close>~\<^verbatim>\<open>"writeln"\<close>\<open>, message: string, theory:
   480   string, session: string}\<close> reports formal progress in loading theories (e.g.\
   481   when building a session image). Apart from a regular output message, it also
   482   reveals the formal theory name (e.g.\ \<^verbatim>\<open>"HOL.Nat"\<close>) and session name (e.g.\
   483   \<^verbatim>\<open>"HOL"\<close>). Note that some rare theory names lack a proper session prefix,
   484   e.g. theory \<^verbatim>\<open>"Main"\<close> in session \<^verbatim>\<open>"HOL"\<close>.
   485 
   486   \<^item> \<^bold>\<open>type\<close>~\<open>timing = {elapsed: double, cpu: double, gc: double}\<close> refers to
   487   common Isabelle timing information in seconds, usually with a precision of
   488   three digits after the point (whole milliseconds).
   489 
   490   \<^item> \<^bold>\<open>type\<close>~\<open>uuid = string\<close> refers to a Universally Unique Identifier (UUID)
   491   as plain text.\<^footnote>\<open>See \<^url>\<open>https://www.ietf.org/rfc/rfc4122.txt\<close> and
   492   \<^url>\<open>https://docs.oracle.com/javase/8/docs/api/java/util/UUID.html\<close>.\<close> Such
   493   identifiers are created as private random numbers of the server and only
   494   revealed to the client that creates a certain resource (e.g.\ task or
   495   session). A client may disclose this information for use in a different
   496   client connection: this allows to share sessions between multiple
   497   connections.
   498 
   499   Client commands need to provide syntactically wellformed UUIDs: this is
   500   trivial to achieve by using only identifiers that have been produced by the
   501   server beforehand.
   502 
   503   \<^item> \<^bold>\<open>type\<close>~\<open>task = {task: uuid}\<close> identifies a newly created asynchronous task
   504   and thus allows the client to control it by the \<^verbatim>\<open>cancel\<close> command. The same
   505   task identification is included in all messages produced by this task.
   506 
   507   \<^item> \<^bold>\<open>type\<close> \<open>session_id = {session_id: uuid}\<close> identifies a newly created PIDE
   508   session managed by the server. Sessions are independent of client
   509   connections and may be shared by different clients, as long as the internal
   510   session identifier is known.
   511 
   512   \<^item> \<^bold>\<open>type\<close> \<open>node = {node_name: string, theory_name: string}\<close> represents the
   513   internal node name of a theory. The \<open>node_name\<close> is derived from the
   514   canonical theory file-name (e.g.\ \<^verbatim>\<open>"~~/src/HOL/ex/Seq.thy"\<close> after
   515   normalization within the file-system). The \<open>theory_name\<close> is the
   516   session-qualified theory name (e.g.\ \<^verbatim>\<open>HOL-ex.Seq\<close>).
   517 
   518   \<^item> \<^bold>\<open>type\<close> \<open>node_status = {ok: bool, total: int, unprocessed: int, running:
   519   int, warned: int, failed: int, finished: int, consolidated: bool}\<close>
   520   represents a formal theory node status of the PIDE document model. Fields
   521   \<open>total\<close>, \<open>unprocessed\<close>, \<open>running\<close>, \<open>warned\<close>, \<open>failed\<close>, \<open>finished\<close> account
   522   for individual commands within a theory node; \<open>ok\<close> is an abstraction for
   523   \<open>failed = 0\<close>. The \<open>consolidated\<close> flag indicates whether the outermost theory
   524   command structure has finished (or failed) and the final \<^theory_text>\<open>end\<close> command has
   525   been checked.
   526 \<close>
   527 
   528 
   529 section \<open>Server commands and results\<close>
   530 
   531 text \<open>
   532   Here follows an overview of particular Isabelle server commands with their
   533   results, which are usually represented as JSON values with types according
   534   to \secref{sec:json-types}. The general format of input and output messages
   535   is described in \secref{sec:input-output-messages}. The relevant
   536   Isabelle/Scala source files are:
   537 
   538   \<^medskip>
   539   \begin{tabular}{l}
   540   \<^file>\<open>$ISABELLE_HOME/src/Pure/Tools/server_commands.scala\<close> \\
   541   \<^file>\<open>$ISABELLE_HOME/src/Pure/Tools/server.scala\<close> \\
   542   \<^file>\<open>$ISABELLE_HOME/src/Pure/General/json.scala\<close> \\
   543   \end{tabular}
   544 \<close>
   545 
   546 
   547 subsection \<open>Command \<^verbatim>\<open>help\<close>\<close>
   548 
   549 text \<open>
   550   \begin{tabular}{ll}
   551   regular result: & \<^verbatim>\<open>OK\<close> \<open>[string]\<close> \\
   552   \end{tabular}
   553   \<^medskip>
   554 
   555   The \<^verbatim>\<open>help\<close> command has no argument and returns the list of server command
   556   names. This is occasionally useful for interactive experimentation (see also
   557   @{tool client} in \secref{sec:tool-client}).
   558 \<close>
   559 
   560 
   561 subsection \<open>Command \<^verbatim>\<open>echo\<close>\<close>
   562 
   563 text \<open>
   564   \begin{tabular}{ll}
   565   argument: & \<open>any\<close> \\
   566   regular result: & \<^verbatim>\<open>OK\<close> \<open>any\<close> \\
   567   \end{tabular}
   568   \<^medskip>
   569 
   570   The \<^verbatim>\<open>echo\<close> command is the identity function: it returns its argument as
   571   regular result. This is occasionally useful for testing and interactive
   572   experimentation (see also @{tool client} in \secref{sec:tool-client}).
   573 
   574   The Scala type of \<^verbatim>\<open>echo\<close> is actually more general than given above:
   575   \<^verbatim>\<open>Unit\<close>, \<^verbatim>\<open>XML.Elem\<close>, \<^verbatim>\<open>JSON.T\<close> work uniformly. Note that \<^verbatim>\<open>XML.Elem\<close> might
   576   be difficult to type on the console in its YXML syntax
   577   (\secref{sec:yxml-vs-xml}).
   578 \<close>
   579 
   580 
   581 subsection \<open>Command \<^verbatim>\<open>shutdown\<close>\<close>
   582 
   583 text \<open>
   584   \begin{tabular}{ll}
   585   regular result: & \<^verbatim>\<open>OK\<close> \\
   586   \end{tabular}
   587   \<^medskip>
   588 
   589   The \<^verbatim>\<open>shutdown\<close> command has no argument and result value. It forces a
   590   shutdown of the connected server process, stopping all open sessions and
   591   closing the server socket. This may disrupt pending commands on other
   592   connections!
   593 
   594   \<^medskip>
   595   The command-line invocation \<^verbatim>\<open>isabelle server -x\<close> opens a server connection
   596   and issues a \<^verbatim>\<open>shutdown\<close> command (see also \secref{sec:tool-server}).
   597 \<close>
   598 
   599 
   600 subsection \<open>Command \<^verbatim>\<open>cancel\<close>\<close>
   601 
   602 text \<open>
   603   \begin{tabular}{ll}
   604   argument: & \<open>task\<close> \\
   605   regular result: & \<^verbatim>\<open>OK\<close> \\
   606   \end{tabular}
   607   \<^medskip>
   608 
   609   The command \<^verbatim>\<open>cancel {"task":\<close>~\<open>id\<close>\<^verbatim>\<open>}\<close> attempts to cancel the specified
   610   task.
   611 
   612   Cancellation is merely a hint that the client prefers an ongoing process to
   613   be stopped. The command always succeeds formally, but it may get ignored by
   614   a task that is still running; it might also refer to a non-existing or
   615   no-longer existing task (without producing an error).
   616 
   617   Successful cancellation typically leads to an asynchronous failure of type
   618   \<^verbatim>\<open>FAILED {\<close>\<open>task: uuid, message:\<close>~\<^verbatim>\<open>"Interrupt"}\<close>. A different message is
   619   also possible, depending how the task handles the event.
   620 \<close>
   621 
   622 
   623 subsection \<open>Command \<^verbatim>\<open>session_build\<close> \label{sec:command-session-build}\<close>
   624 
   625 text \<open>
   626   \begin{tabular}{lll}
   627   argument: & \<open>session_build_args\<close> \\
   628   immediate result: & \<^verbatim>\<open>OK\<close> \<open>task\<close> \\
   629   notifications: & \<^verbatim>\<open>NOTE\<close> \<open>task \<oplus> (theory_progress | message)\<close> \\
   630   regular result: & \<^verbatim>\<open>FINISHED\<close> \<open>task \<oplus> session_build_results\<close> \\
   631   error result: & \<^verbatim>\<open>FAILED\<close> \<open>task \<oplus> error_message \<oplus> session_build_results\<close> \\[2ex]
   632   \end{tabular}
   633 
   634   \begin{tabular}{lll}
   635   \<^bold>\<open>type\<close> \<open>session_build_args =\<close> \\
   636   \quad\<open>{session: string,\<close> \\
   637   \quad~~\<open>preferences?: string,\<close> & \<^bold>\<open>default:\<close> server preferences \\
   638   \quad~~\<open>options?: [string],\<close> \\
   639   \quad~~\<open>dirs?: [string],\<close> \\
   640   \quad~~\<open>include_sessions: [string],\<close> \\
   641   \quad~~\<open>system_mode?: bool,\<close> \\
   642   \quad~~\<open>verbose?: bool}\<close> \\[2ex]
   643   \end{tabular}
   644 
   645   \begin{tabular}{ll}
   646   \<^bold>\<open>type\<close> \<open>session_build_result =\<close> \\
   647   \quad\<open>{session: string,\<close> \\
   648   \quad~~\<open>ok: bool,\<close> \\
   649   \quad~~\<open>return_code: int,\<close> \\
   650   \quad~~\<open>timeout: bool,\<close> \\
   651   \quad~~\<open>timing: timing}\<close> \\[2ex]
   652 
   653   \<^bold>\<open>type\<close> \<open>session_build_results =\<close> \\
   654   \quad\<open>{ok: bool,\<close> \\
   655   \quad~~\<open>return_code: int,\<close> \\
   656   \quad~~\<open>sessions: [session_build_result]}\<close> \\
   657   \end{tabular}
   658 \<close>
   659 
   660 text \<open>
   661   The \<^verbatim>\<open>session_build\<close> command prepares a session image for interactive use of
   662   theories. This is a limited version of command-line tool @{tool build}
   663   (\secref{sec:tool-build}), with specific options to request a formal context
   664   for an interactive PIDE session.
   665 
   666   The build process is asynchronous, with notifications that inform about the
   667   progress of loaded theories. Some further informative messages are output as
   668   well.
   669 
   670   Coordination of independent build processes is at the discretion of the
   671   client (or end-user), just as for @{tool build} and @{tool jedit}. There is
   672   no built-in coordination of conflicting builds with overlapping hierarchies
   673   of session images. In the worst case, a session image produced by one task
   674   may get overwritten by another task!
   675 \<close>
   676 
   677 
   678 subsubsection \<open>Arguments\<close>
   679 
   680 text \<open>
   681   The \<open>session\<close> field specifies the target session name. The build process
   682   will produce all required ancestor images according to the overall session
   683   graph.
   684 
   685   \<^medskip>
   686   The environment of Isabelle system options is determined from \<open>preferences\<close>
   687   that are augmented by \<open>options\<close>, which is a list individual updates of the
   688   form the \<open>name\<close>\<^verbatim>\<open>=\<close>\<open>value\<close> or \<open>name\<close> (the latter abbreviates
   689   \<open>name\<close>\<^verbatim>\<open>=true\<close>); see also command-line option \<^verbatim>\<open>-o\<close> for @{tool build}. The
   690   preferences are loaded from the file
   691   \<^path>\<open>$ISABELLE_HOME_USER/etc/preferences\<close> by default, but the client may
   692   provide alternative contents for it (as text, not a file-name). This could
   693   be relevant in situations where client and server run in different
   694   operating-system contexts.
   695 
   696   \<^medskip>
   697   The \<open>dirs\<close> field specifies additional directories for session ROOT and ROOTS
   698   files (\secref{sec:session-root}). This augments the name space of available
   699   sessions; see also option \<^verbatim>\<open>-d\<close> in @{tool build}.
   700 
   701   \<^medskip>
   702   The \<open>include_sessions\<close> field specifies sessions whose theories should be
   703   included in the overall name space of session-qualified theory names. This
   704   corresponds to a \<^bold>\<open>sessions\<close> specification in ROOT files
   705   (\secref{sec:session-root}). It enables the \<^verbatim>\<open>use_theories\<close> command
   706   (\secref{sec:command-use-theories}) to refer to sources from other sessions
   707   in a robust manner, instead of relying on directory locations.
   708 
   709   \<^medskip>
   710   The \<open>system_mode\<close> field set to \<^verbatim>\<open>true\<close> stores resulting session images and
   711   log files in @{path "$ISABELLE_HOME/heaps"} instead of the default location
   712   @{setting ISABELLE_OUTPUT} (which is normally in @{setting
   713   ISABELLE_HOME_USER}). See also option \<^verbatim>\<open>-s\<close> in @{tool build}.
   714 
   715   \<^medskip>
   716   The \<open>verbose\<close> field set to \<^verbatim>\<open>true\<close> yields extra verbosity. The effect is
   717   similar to option \<^verbatim>\<open>-v\<close> in @{tool build}.
   718 \<close>
   719 
   720 
   721 subsubsection \<open>Intermediate output\<close>
   722 
   723 text \<open>
   724   The asynchronous notifications of command \<^verbatim>\<open>session_build\<close> mainly serve as
   725   progress indicator: the output resembles that of the session build window of
   726   Isabelle/jEdit after startup @{cite "isabelle-jedit"}.
   727 
   728   For the client it is usually sufficient to print the messages in plain text,
   729   but note that \<open>theory_progress\<close> also reveals formal \<open>theory\<close> and
   730   \<open>session\<close> names directly.
   731 \<close>
   732 
   733 
   734 subsubsection \<open>Results\<close>
   735 
   736 text \<open>
   737   The overall \<open>session_build_results\<close> contain both a summary and an entry
   738   \<open>session_build_result\<close> for each session in the build hierarchy. The result
   739   is always provided, independently of overall success (\<^verbatim>\<open>FINISHED\<close> task) or
   740   failure (\<^verbatim>\<open>FAILED\<close> task).
   741 
   742   The \<open>ok\<close> field tells abstractly, whether all required session builds came
   743   out as \<open>ok\<close>, i.e.\ with zero \<open>return_code\<close>. A non-zero \<open>return_code\<close>
   744   indicates an error according to usual POSIX conventions for process exit.
   745 
   746   The individual \<open>session_build_result\<close> entries provide extra fields:
   747 
   748   \<^item> \<open>timeout\<close> tells if the build process was aborted after running too long,
   749 
   750   \<^item> \<open>timing\<close> gives the overall process timing in the usual Isabelle format
   751   with elapsed, CPU, GC time.
   752 \<close>
   753 
   754 
   755 subsubsection \<open>Examples\<close>
   756 
   757 text \<open>
   758   Build of a session image from the Isabelle distribution:
   759   @{verbatim [display] \<open>session_build {"session": "HOL-Word"}\<close>}
   760 
   761   Build a session image from the Archive of Formal Proofs:
   762   @{verbatim [display] \<open>session_build {"session": "Coinductive", "dirs": ["$AFP_BASE/thys"]}\<close>}
   763 \<close>
   764 
   765 
   766 subsection \<open>Command \<^verbatim>\<open>session_start\<close> \label{sec:command-session-start}\<close>
   767 
   768 text \<open>
   769   \begin{tabular}{lll}
   770   argument: & \<open>session_build_args \<oplus> {print_mode?: [string]}\<close> \\
   771   immediate result: & \<^verbatim>\<open>OK\<close> \<open>task\<close> \\
   772   notifications: & \<^verbatim>\<open>NOTE\<close> \<open>task \<oplus> (theory_progress | message)\<close> \\
   773   regular result: & \<^verbatim>\<open>FINISHED\<close> \<open>task \<oplus> session_id \<oplus> {tmp_dir: string}\<close> \\
   774   error result: & \<^verbatim>\<open>FAILED\<close> \<open>task \<oplus> error_message\<close> \\[2ex]
   775   \end{tabular}
   776 
   777   \<^medskip>
   778   The \<^verbatim>\<open>session_start\<close> command starts a new Isabelle/PIDE session with
   779   underlying Isabelle/ML process, based on a session image that it produces on
   780   demand using \<^verbatim>\<open>session_build\<close>. Thus it accepts all \<open>session_build_args\<close> and
   781   produces similar notifications, but the detailed \<open>session_build_results\<close> are
   782   omitted.
   783 
   784   The session build and startup process is asynchronous: when the task is
   785   finished, the session remains active for commands, until a \<^verbatim>\<open>session_stop\<close>
   786   or \<^verbatim>\<open>shutdown\<close> command is sent to the server.
   787 
   788   Sessions are independent of client connections: it is possible to start a
   789   session and later apply \<^verbatim>\<open>use_theories\<close> on different connections, as long as
   790   the internal session identifier is known: shared theory imports will be used
   791   only once (and persist until purged explicitly).
   792 \<close>
   793 
   794 
   795 subsubsection \<open>Arguments\<close>
   796 
   797 text \<open>
   798   Most arguments are shared with \<^verbatim>\<open>session_build\<close>
   799   (\secref{sec:command-session-build}).
   800 
   801   \<^medskip>
   802   The \<open>print_mode\<close> field adds identifiers of print modes to be made active for
   803   this session. For example, \<^verbatim>\<open>"print_mode": ["ASCII"]\<close> prefers ASCII
   804   replacement syntax over mathematical Isabelle symbols. See also option \<^verbatim>\<open>-m\<close>
   805   in @{tool process} (\secref{sec:tool-process}).
   806 \<close>
   807 
   808 
   809 subsubsection \<open>Results\<close>
   810 
   811 text \<open>
   812   The \<open>session_id\<close> provides the internal identification of the session object
   813   within the sever process. It can remain active as long as the server is
   814   running, independently of the current client connection.
   815 
   816   \<^medskip>
   817   The \<open>tmp_dir\<close> field refers to a temporary directory that is specifically
   818   created for this session and deleted after it has been stopped. This may
   819   serve as auxiliary file-space for the \<^verbatim>\<open>use_theories\<close> command, but
   820   concurrent use requires some care in naming temporary files, e.g.\ by
   821   using sub-directories with globally unique names.
   822 
   823   As \<open>tmp_dir\<close> is the default \<open>master_dir\<close> for commands \<^verbatim>\<open>use_theories\<close> and
   824   \<^verbatim>\<open>purge_theories\<close>, theory files copied there may be used without further
   825   path specification.
   826 \<close>
   827 
   828 
   829 subsection \<open>Examples\<close>
   830 
   831 text \<open>
   832   Start a default Isabelle/HOL session:
   833   @{verbatim [display] \<open>session_start {"session": "HOL"}\<close>}
   834 
   835   Start a session from the Archive of Formal Proofs:
   836   @{verbatim [display] \<open>session_start {"session": "Coinductive", "dirs": ["$AFP_BASE/thys"]}\<close>}
   837 \<close>
   838 
   839 
   840 subsection \<open>Command \<^verbatim>\<open>session_stop\<close>\<close>
   841 
   842 text \<open>
   843   \begin{tabular}{ll}
   844   argument: & \<open>session_id\<close> \\
   845   immediate result: & \<^verbatim>\<open>OK\<close> \<open>task\<close> \\
   846   regular result: & \<^verbatim>\<open>FINISHED\<close> \<open>task \<oplus> session_stop_result\<close> \\
   847   error result: & \<^verbatim>\<open>FAILED\<close> \<open>task \<oplus> error_message \<oplus> session_stop_result\<close> \\[2ex]
   848   \end{tabular}
   849 
   850   \begin{tabular}{l}
   851   \<^bold>\<open>type\<close> \<open>session_stop_result = {ok: bool, return_code: int}\<close>
   852   \end{tabular}
   853 
   854   \<^medskip>
   855   The \<^verbatim>\<open>session_stop\<close> command forces a shutdown of the identified PIDE
   856   session. This asynchronous tasks usually finishes quickly. Failure only
   857   happens in unusual situations, according to the return code of the
   858   underlying Isabelle/ML process.
   859 \<close>
   860 
   861 
   862 subsubsection \<open>Arguments\<close>
   863 
   864 text \<open>
   865   The \<open>session_id\<close> provides the UUID originally created by the server for this
   866   session.
   867 \<close>
   868 
   869 
   870 subsubsection \<open>Results\<close>
   871 
   872 text \<open>
   873   The \<open>ok\<close> field tells abstractly, whether the Isabelle/ML process has
   874   terminated properly.
   875 
   876   The \<open>return_code\<close> field expresses this information according to usual POSIX
   877   conventions for process exit.
   878 \<close>
   879 
   880 
   881 subsection \<open>Command \<^verbatim>\<open>use_theories\<close> \label{sec:command-use-theories}\<close>
   882 
   883 text \<open>
   884   \begin{tabular}{ll}
   885   argument: & \<open>use_theories_arguments\<close> \\
   886   immediate result: & \<^verbatim>\<open>OK\<close> \<open>task\<close> \\
   887   regular result: & \<^verbatim>\<open>FINISHED\<close> \<open>use_theories_results\<close> \\
   888   \end{tabular}
   889 
   890   \begin{tabular}{ll}
   891   \<^bold>\<open>type\<close> \<open>use_theories_arguments =\<close> \\
   892   \quad\<open>{session_id: uuid,\<close> \\
   893   \quad~~\<open>theories: [string],\<close> \\
   894   \quad~~\<open>master_dir?: string,\<close> & \<^bold>\<open>default:\<close> session \<open>tmp_dir\<close> \\
   895   \quad~~\<open>pretty_margin?: double\<close> & \<^bold>\<open>default:\<close> \<^verbatim>\<open>76\<close> \\
   896   \quad~~\<open>unicode_symbols?: bool}\<close> \\[2ex]
   897   \end{tabular}
   898 
   899   \begin{tabular}{ll}
   900   \<^bold>\<open>type\<close> \<open>use_theories_results =\<close> \\
   901   \quad\<open>{ok: bool,\<close> \\
   902   \quad~~\<open>errors: [message],\<close> \\
   903   \quad~~\<open>nodes: [node \<oplus> {status: node_status, messages: [message]}]}\<close> \\
   904   \end{tabular}
   905 
   906   \<^medskip>
   907   The \<^verbatim>\<open>use_theories\<close> command updates the identified session by adding the
   908   current version of theory files to it, while dependencies are resolved
   909   implicitly. The command succeeds eventually, when all theories have been
   910   \<^emph>\<open>consolidated\<close> in the sense the formal \<open>node_status\<close>
   911   (\secref{sec:json-types}): the outermost command structure has finished (or
   912   failed) and the final \<^theory_text>\<open>end\<close> command of each theory has been checked.
   913 
   914   Already used theories persist in the session until purged explicitly
   915   (\secref{sec:command-purge-theories}). This also means that repeated
   916   invocations of \<^verbatim>\<open>use_theories\<close> are idempotent: it could make sense to do
   917   that with different values for \<open>pretty_margin\<close> or \<open>unicode_symbols\<close> to get
   918   different formatting for \<open>errors\<close> or \<open>messages\<close>.
   919 \<close>
   920 
   921 
   922 subsubsection \<open>Arguments\<close>
   923 
   924 text \<open>
   925   The \<open>session_id\<close> is the identifier provided by the server, when the session
   926   was created (possibly on a different client connection).
   927 
   928   \<^medskip>
   929   The \<open>theories\<close> field specifies theory names as in theory \<^theory_text>\<open>imports\<close> or in
   930   ROOT \<^bold>\<open>theories\<close>.
   931 
   932   \<^medskip>
   933   The \<open>master_dir\<close> field specifies the master directory of imported theories:
   934   it acts like the ``current working directory'' for locating theory files.
   935   This is irrelevant for \<open>theories\<close> with an absolute path name (e.g.\
   936   \<^verbatim>\<open>"~~/src/HOL/ex/Seq.thy"\<close>) or session-qualified theory name (e.g.\
   937   \<^verbatim>\<open>"HOL-ex/Seq"\<close>).
   938 
   939   \<^medskip>
   940   The \<open>pretty_margin\<close> field specifies the line width for pretty-printing. The
   941   default is suitable for classic console output. Formatting happens at the
   942   end of \<^verbatim>\<open>use_theories\<close>, when all prover messages are exported to the client.
   943 
   944   \<^medskip>
   945   The \<open>unicode_symbols\<close> field set to \<^verbatim>\<open>true\<close> renders message output for direct
   946   output on a Unicode capable channel, ideally with the Isabelle fonts as in
   947   Isabelle/jEdit. The default is to keep the symbolic representation of
   948   Isabelle text, e.g.\ \<^verbatim>\<open>\<forall>\<close> instead of its rendering as \<open>\<forall>\<close>. This means the
   949   client needs to perform its own rendering before presenting it to the
   950   end-user.
   951 \<close>
   952 
   953 
   954 subsubsection \<open>Results\<close>
   955 
   956 text \<open>
   957   The \<open>ok\<close> field indicates overall success of processing the specified
   958   theories with all their dependencies.
   959 
   960   When \<open>ok\<close> is \<^verbatim>\<open>false\<close>, the \<open>errors\<close> field lists all errors cumulatively
   961   (including imported theories). The messages contain position information for
   962   the original theory nodes.
   963 
   964   \<^medskip>
   965   The \<open>nodes\<close> field provides detailed information about each imported theory
   966   node. The individual fields are as follows:
   967 
   968   \<^item> \<open>node_name\<close>: the canonical name for the theory node, based on its
   969   file-system location;
   970 
   971   \<^item> \<open>theory_name\<close>: the logical theory name;
   972 
   973   \<^item> \<open>status\<close>: the overall node status, e.g.\ see the visualization in the
   974   \<open>Theories\<close> panel of Isabelle/jEdit @{cite "isabelle-jedit"};
   975 
   976   \<^item> \<open>messages\<close>: the main bulk of prover messages produced in this theory
   977   (with kind \<^verbatim>\<open>writeln\<close>, \<^verbatim>\<open>warning\<close>, \<^verbatim>\<open>error\<close>).
   978 \<close>
   979 
   980 
   981 subsubsection \<open>Examples\<close>
   982 
   983 text \<open>
   984   Process some example theory from the Isabelle distribution, within the
   985   context of an already started session for Isabelle/HOL (see also
   986   \secref{sec:command-session-start}):
   987   @{verbatim [display] \<open>use_theories {"session_id": ..., "theories": ["~~/src/HOL/ex/Seq"]}\<close>}
   988 
   989   \<^medskip>
   990   Process some example theories in the context of their (single) parent
   991   session:
   992 
   993   @{verbatim [display] \<open>session_start {"session": "HOL-Library"}
   994 use_theories {"session_id": ..., "theories": ["~~/src/HOL/Unix/Unix"]}
   995 session_stop {"session_id": ...}\<close>}
   996 
   997   \<^medskip>
   998   Process some example theories that import other theories via
   999   session-qualified theory names:
  1000 
  1001   @{verbatim [display] \<open>session_start {"session": "HOL", "include_sessions": ["HOL-Unix"]}
  1002 use_theories {"session_id": ..., "theories": ["HOL-Unix.Unix"]}
  1003 session_stop {"session_id": ...}\<close>}
  1004 \<close>
  1005 
  1006 
  1007 subsection \<open>Command \<^verbatim>\<open>purge_theories\<close> \label{sec:command-purge-theories}\<close>
  1008 
  1009 text \<open>
  1010   \begin{tabular}{ll}
  1011   argument: & \<open>purge_theories_arguments\<close> \\
  1012   regular result: & \<^verbatim>\<open>OK\<close> \<open>purge_theories_result\<close> \\
  1013   \end{tabular}
  1014 
  1015   \begin{tabular}{lll}
  1016   \<^bold>\<open>type\<close> \<open>purge_theories_arguments =\<close> \\
  1017   \quad\<open>{session_id: uuid,\<close> \\
  1018   \quad~~\<open>theories: [string],\<close> \\
  1019   \quad~~\<open>master_dir?: string,\<close> & \<^bold>\<open>default:\<close> session \<open>tmp_dir\<close> \\
  1020   \quad~~\<open>all?: bool}\<close> \\[2ex]
  1021   \end{tabular}
  1022 
  1023   \begin{tabular}{ll}
  1024   \<^bold>\<open>type\<close> \<open>purge_theories_result = {purged: [string]}\<close> \\
  1025   \end{tabular}
  1026 
  1027   \<^medskip>
  1028   The \<^verbatim>\<open>purge_theories\<close> command updates the identified session by removing
  1029   theories that are no longer required: theories that are used in pending
  1030   \<^verbatim>\<open>use_theories\<close> tasks or imported by other theories are retained.
  1031 \<close>
  1032 
  1033 
  1034 subsubsection \<open>Arguments\<close>
  1035 
  1036 text \<open>
  1037   The \<open>session_id\<close> is the identifier provided by the server, when the session
  1038   was created (possibly on a different client connection).
  1039 
  1040   \<^medskip>
  1041   The \<open>theories\<close> field specifies theory names to be purged: imported
  1042   dependencies are \<^emph>\<open>not\<close> completed. Instead it is possible to provide the
  1043   already completed import graph returned by \<^verbatim>\<open>use_theories\<close> as \<open>nodes\<close> /
  1044   \<open>node_name\<close>.
  1045 
  1046   \<^medskip>
  1047   The \<open>master_dir\<close> field specifies the master directory as in \<^verbatim>\<open>use_theories\<close>.
  1048   This is irrelevant, when passing fully-qualified theory node names (e.g.\
  1049   \<open>node_name\<close> from \<open>nodes\<close> in \<open>use_theories_results\<close>).
  1050 
  1051   \<^medskip>
  1052   The \<open>all\<close> field set to \<^verbatim>\<open>true\<close> attempts to purge all presently loaded
  1053   theories.
  1054 \<close>
  1055 
  1056 
  1057 subsubsection \<open>Results\<close>
  1058 
  1059 text \<open>
  1060   The \<open>purged\<close> field gives the theory nodes that were actually removed.
  1061 
  1062   \<^medskip>
  1063   The \<open>retained\<close> field gives the remaining theory nodes, i.e.\ the complement
  1064   of \<open>purged\<close>.
  1065 \<close>
  1066 
  1067 end