Merge pull request #5645 from Aghassi/sourcekit-docs-complete.open

Author: swift-ci

tools/SourceKit/docs/Protocol.md

@@ -38,6 +38,11 @@ must be given either the path to a file (`key.sourcefile`), or some text
 (`key.sourcetext`). `key.sourcefile` is ignored when `key.sourcetext` is also
 provided.
 
+| Request Name | Request Key | Description |
+| -------------:|:------------|:------------|
+| `codecomplete` | `codecomplete` | Returns a list of completions. |
+| `open` | `codecomplete.open` | Given a file will open a code-completion session which can be filtered using `codecomplete.update`. Each session must be closed using `codecomplete.close`. |
+
 ### Request
 
 ```
@@ -54,6 +59,22 @@ provided.
 }
 ```
 
+`codecomplete.open`
+```
+{
+    <key.request>:          (UID) <source.request.codecomplete.open>
+    [opt] <key.sourcetext>: (string)   // Source contents.
+    [opt] <key.sourcefile>: (string)   // Absolute path to the file.
+    <key.offset>:           (int64)    // Byte offset of code-completion point inside the source contents.
+    [opt] <key.codecomplete.options>:    (dict)     // An options dictionary containing keys.
+    [opt] <key.compilerargs> [string*] // Array of zero or more strings for the compiler arguments,
+                                       // e.g ["-sdk", "/path/to/sdk"]. If key.sourcefile is provided,
+                                       // these must include the path to that file.
+    [opt] <key.not_recommended> [bool] // True if this result is to be avoided, e.g. because
+                                       // the declaration is unavailable.
+}
+```
+
 ### Response
 
 ```
@@ -75,6 +96,24 @@ completion-result ::=
 }
 ```
 
+```
+completion.open-result ::=
+{
+  <key.kind>:           (UID)         // UID for the declaration kind (function, class, etc.).
+  <key.name>:           (string)      // Name of the word being completed
+  <key.sourcetext>:     (string)      // Text to be inserted in source.
+  <key.description>:    (string)      // Text to be displayed in code-completion window.
+  <key.typename>:       (string)      // Text describing the type of the result.
+  <key.context>:        (UID)         // Semantic context of the code completion result.
+  <key.num_bytes_to_erase>: (int64)   // Number of bytes to the left of the cursor that should be erased before inserting this completion result.
+  <key.substructure>:   (dictionary)  // Contains an array of dictionaries representing ranges of structural elements in the result description, such as the parameters of a function
+      - <key.nameoffset>  (int64)     // The offset location of the given parameter
+      - <key.namelength>  (int64)     // The length of the given parameter
+      - <key.bodyoffset>  (int64)     // The `nameoffset` + the indentation inside the body of the file
+      - <key.bodylength>  (int64)     // The `namelength` + the indentation inside the body of the file
+}
+```
+
 ### Testing
 
 ```