wasm: create workspace to hold all open documents (C++ half)

In the VS Code extension, in order to have a .js file lint using an
open config file, we need to be able to correlate documents together. Do
this by creating a workspace abstraction to hold all the documents in
the C++ half.

A future commit will expose workspaces to the JavaScript half.

This commit should not change behavior.

Author: strager

src/c-api.cpp

@@ -1,7 +1,10 @@
 // Copyright (C) 2020  Matthew "strager" Glazar
 // See end of file for extended copyright information.
 
+#include <algorithm>
 #include <cstddef>
+#include <memory>
+#include <quick-lint-js/assert.h>
 #include <quick-lint-js/c-api-error-reporter.h>
 #include <quick-lint-js/c-api.h>
 #include <quick-lint-js/char8.h>
@@ -13,6 +16,7 @@
 #include <quick-lint-js/padded-string.h>
 #include <quick-lint-js/parse.h>
 #include <quick-lint-js/web-demo-location.h>
+#include <vector>
 
 namespace quick_lint_js {
 namespace {
@@ -39,12 +43,34 @@ class qljs_document_base {
 }
 }
 
+struct qljs_vscode_workspace {
+ public:
+  qljs_vscode_document* create_source_document();
+
+  void destroy_document(qljs_vscode_document*);
+
+ private:
+  std::vector<std::unique_ptr<qljs_vscode_document>> documents_;
+};
+
+qljs_vscode_workspace* qljs_vscode_create_workspace() {
+  qljs_vscode_workspace* workspace = new qljs_vscode_workspace();
+  return workspace;
+}
+
+void qljs_vscode_destroy_workspace(qljs_vscode_workspace* workspace) {
+  delete workspace;
+}
+
 struct qljs_vscode_document final
     : public quick_lint_js::qljs_document_base<
           quick_lint_js::lsp_locator,
           quick_lint_js::c_api_error_reporter<qljs_vscode_diagnostic,
                                               quick_lint_js::lsp_locator>> {
  public:
+  explicit qljs_vscode_document(qljs_vscode_workspace* workspace)
+      : workspace(workspace) {}
+
   void replace_text(int start_line, int start_character, int end_line,
                     int end_character,
                     quick_lint_js::string8_view replacement) {
@@ -57,14 +83,34 @@ struct qljs_vscode_document final
         },
         replacement);
   }
+
+  qljs_vscode_workspace* workspace;
 };
 
-qljs_vscode_document* qljs_vscode_create_document(void) {
-  qljs_vscode_document* p = new qljs_vscode_document();
-  return p;
+qljs_vscode_document* qljs_vscode_workspace::create_source_document() {
+  std::unique_ptr<qljs_vscode_document>& doc = this->documents_.emplace_back(
+      std::make_unique<qljs_vscode_document>(this));
+  return doc.get();
+}
+
+void qljs_vscode_workspace::destroy_document(qljs_vscode_document* doc) {
+  auto doc_it = std::find_if(
+      this->documents_.begin(), this->documents_.end(),
+      [&](const std::unique_ptr<qljs_vscode_document>& existing_doc) {
+        return existing_doc.get() == doc;
+      });
+  QLJS_ASSERT(doc_it != this->documents_.end());
+  this->documents_.erase(doc_it);
+}
+
+qljs_vscode_document* qljs_vscode_create_source_document(
+    qljs_vscode_workspace* workspace) {
+  return workspace->create_source_document();
 }
 
-void qljs_vscode_destroy_document(qljs_vscode_document* p) { delete p; }
+void qljs_vscode_destroy_document(qljs_vscode_document* p) {
+  p->workspace->destroy_document(p);
+}
 
 void qljs_vscode_replace_text(qljs_vscode_document* p, int start_line,
                               int start_character, int end_line,

src/quick-lint-js/c-api.h

@@ -15,7 +15,11 @@ typedef enum qljs_severity {
   qljs_severity_warning = 2,
 } qljs_severity;
 
+typedef struct qljs_vscode_workspace qljs_vscode_workspace;
 typedef struct qljs_vscode_document qljs_vscode_document;
+qljs_vscode_workspace* qljs_vscode_create_workspace();
+void qljs_vscode_destroy_workspace(qljs_vscode_workspace*);
+
 struct qljs_vscode_diagnostic {
   const char* message;
   const char* code;
@@ -25,7 +29,8 @@ struct qljs_vscode_diagnostic {
   int end_line;
   int end_character;
 };
-qljs_vscode_document* qljs_vscode_create_document(void);
+qljs_vscode_document* qljs_vscode_create_source_document(
+    qljs_vscode_workspace*);
 void qljs_vscode_destroy_document(qljs_vscode_document*);
 void qljs_vscode_replace_text(qljs_vscode_document*, int start_line,
                               int start_character, int end_line,

test/test-c-api.cpp

@@ -8,10 +8,12 @@
 namespace quick_lint_js {
 namespace {
 TEST(test_c_api_vscode, empty_document_has_no_diagnostics) {
-  qljs_vscode_document* p = qljs_vscode_create_document();
+  qljs_vscode_workspace* workspace = qljs_vscode_create_workspace();
+  qljs_vscode_document* p = qljs_vscode_create_source_document(workspace);
   const qljs_vscode_diagnostic* diagnostics = qljs_vscode_lint(p);
   EXPECT_EQ(diagnostics[0].message, nullptr);
   qljs_vscode_destroy_document(p);
+  qljs_vscode_destroy_workspace(workspace);
 }
 
 TEST(test_c_api_web_demo, empty_document_has_no_diagnostics) {
@@ -22,7 +24,8 @@ TEST(test_c_api_web_demo, empty_document_has_no_diagnostics) {
 }
 
 TEST(test_c_api_vscode, lint_error_after_text_insertion) {
-  qljs_vscode_document* p = qljs_vscode_create_document();
+  qljs_vscode_workspace* workspace = qljs_vscode_create_workspace();
+  qljs_vscode_document* p = qljs_vscode_create_source_document(workspace);
 
   const char8* document_text = u8"let x;let x;";
   qljs_vscode_replace_text(p, /*start_line=*/0, /*start_character=*/0,
@@ -41,6 +44,7 @@ TEST(test_c_api_vscode, lint_error_after_text_insertion) {
   EXPECT_EQ(diagnostics[0].end_character, strlen(u8"let x;let x"));
 
   qljs_vscode_destroy_document(p);
+  qljs_vscode_destroy_workspace(workspace);
 }
 
 TEST(test_c_api_web_demo, lint_error_after_text_insertion) {
@@ -62,7 +66,8 @@ TEST(test_c_api_web_demo, lint_error_after_text_insertion) {
 }
 
 TEST(test_c_api_vscode, lint_new_error_after_second_text_insertion) {
-  qljs_vscode_document* p = qljs_vscode_create_document();
+  qljs_vscode_workspace* workspace = qljs_vscode_create_workspace();
+  qljs_vscode_document* p = qljs_vscode_create_source_document(workspace);
 
   const char8* document_text = u8"let x;";
   qljs_vscode_replace_text(p, /*start_line=*/0, /*start_character=*/0,
@@ -88,6 +93,7 @@ TEST(test_c_api_vscode, lint_new_error_after_second_text_insertion) {
   EXPECT_EQ(diagnostics[0].end_character, strlen(u8"let x;let x"));
 
   qljs_vscode_destroy_document(p);
+  qljs_vscode_destroy_workspace(workspace);
 }
 
 TEST(test_c_api_web_demo, lint_new_error_after_second_text_insertion) {
@@ -114,7 +120,8 @@ TEST(test_c_api_web_demo, lint_new_error_after_second_text_insertion) {
 }
 
 TEST(test_c_api_vscode, diagnostic_severity) {
-  qljs_vscode_document* p = qljs_vscode_create_document();
+  qljs_vscode_workspace* workspace = qljs_vscode_create_workspace();
+  qljs_vscode_document* p = qljs_vscode_create_source_document(workspace);
 
   const char8* document_text = u8"let x;let x;\nundeclaredVariable;";
   qljs_vscode_replace_text(p, /*start_line=*/0, /*start_character=*/0,
@@ -132,6 +139,19 @@ TEST(test_c_api_vscode, diagnostic_severity) {
   EXPECT_EQ(diagnostics[1].severity, qljs_severity_warning);
 
   qljs_vscode_destroy_document(p);
+  qljs_vscode_destroy_workspace(workspace);
+}
+
+TEST(test_c_api_vscode,
+     destroying_workspace_makes_destroying_documents_unnecessary) {
+  qljs_vscode_workspace* workspace = qljs_vscode_create_workspace();
+  [[maybe_unused]] qljs_vscode_document* doc1 =
+      qljs_vscode_create_source_document(workspace);
+  [[maybe_unused]] qljs_vscode_document* doc2 =
+      qljs_vscode_create_source_document(workspace);
+  qljs_vscode_destroy_workspace(workspace);
+  // Leak checkers such as AddressSantizers would report a leak and fail the
+  // test.
 }
 }
 }

wasm/CMakeLists.txt

@@ -12,7 +12,7 @@ if (EMSCRIPTEN)
     quick-lint-js-vscode
     PRIVATE
     quick-lint-js-lib
-    "-sEXPORTED_FUNCTIONS=[\"_qljs_vscode_create_document\",\"_qljs_vscode_destroy_document\",\"_qljs_vscode_replace_text\",\"_qljs_vscode_lint\",\"_qljs_web_demo_create_document\",\"_qljs_web_demo_destroy_document\",\"_qljs_web_demo_set_text\",\"_qljs_web_demo_lint\",\"_malloc\",\"_free\"]"
+    "-sEXPORTED_FUNCTIONS=[\"_qljs_vscode_create_workspace\",\"_qljs_vscode_destroy_workspace\",\"_qljs_vscode_create_source_document\",\"_qljs_vscode_destroy_document\",\"_qljs_vscode_replace_text\",\"_qljs_vscode_lint\",\"_qljs_web_demo_create_document\",\"_qljs_web_demo_destroy_document\",\"_qljs_web_demo_set_text\",\"_qljs_web_demo_lint\",\"_malloc\",\"_free\"]"
     -sASSERTIONS=0
     -sSTANDALONE_WASM=1
     --no-entry

wasm/quick-lint-js.js

@@ -498,8 +498,12 @@ class Process {
 
     this._malloc = wrap("malloc");
     this._free = wrap("free");
-    this._vscodeCreateDocument = wrap("qljs_vscode_create_document");
+    this._vscodeCreateSourceDocument = wrap(
+      "qljs_vscode_create_source_document"
+    );
+    this._vscodeCreateWorkspace = wrap("qljs_vscode_create_workspace");
     this._vscodeDestroyDocument = wrap("qljs_vscode_destroy_document");
+    this._vscodeDestroyWorkspace = wrap("qljs_vscode_destroy_workspace");
     this._vscodeLint = wrap("qljs_vscode_lint");
     this._vscodeReplaceText = wrap("qljs_vscode_replace_text");
     this._webDemoCreateDocument = wrap("qljs_web_demo_create_document");
@@ -526,8 +530,10 @@ class Process {
     // Make future calls crash and also reduce memory usage.
     this._malloc = tainted;
     this._free = tainted;
-    this._vscodeCreateDocument = tainted;
+    this._vscodeCreateSourceDocument = tainted;
+    this._vscodeCreateWorkspace = tainted;
     this._vscodeDestroyDocument = tainted;
+    this._vscodeDestroyWorkspace = tainted;
     this._vscodeLint = tainted;
     this._vscodeReplaceText = tainted;
     this._webDemoCreateDocument = tainted;
@@ -552,7 +558,10 @@ class Process {
 class DocumentForVSCode {
   constructor(process) {
     this._process = process;
-    this._wasmDoc = this._process._vscodeCreateDocument();
+    this._wasmWorkspace = this._process._vscodeCreateWorkspace();
+    this._wasmDoc = this._process._vscodeCreateSourceDocument(
+      this._wasmWorkspace
+    );
   }
 
   replaceText(range, replacementText) {
@@ -637,6 +646,8 @@ class DocumentForVSCode {
   dispose() {
     this._process._vscodeDestroyDocument(this._wasmDoc);
     this._wasmDoc = null;
+    this._process._vscodeDestroyWorkspace(this._wasmWorkspace);
+    this._wasmWorkspace = null;
   }
 
   get process() {