Rename 'vscode' module to 'c-api'

strager · strager · commit c91250843b8f · 2021-05-12T20:20:08.000-07:00
I want to generalize the qljs_vscode_* and &lt;quick-lint-js/vscode.h&gt; APIs
to be usable in more contexts. (For example, it'd be nice if the web
demo used the same code.)

Rename vscode.h to c-api.h, and rename qljs_vscode_* to qljs_*.

qljs_vscode_diagnostic keeps its name because the location information
it conveys is specific to what VS Code expects. Other consumers of the
API might want different formats.

This commit should not change behavior.
diff --git a/plugin/vscode/CMakeLists.txt b/plugin/vscode/CMakeLists.txt
@@ -11,7 +11,7 @@ if (EMSCRIPTEN)
     quick-lint-js-vscode
     PRIVATE
     quick-lint-js-lib
-    "-sEXPORTED_FUNCTIONS=[\"_qljs_vscode_create_parser\",\"_qljs_vscode_destroy_parser\",\"_qljs_vscode_replace_text\",\"_qljs_vscode_lint\",\"_malloc\",\"_free\"]"
+    "-sEXPORTED_FUNCTIONS=[\"_qljs_create_parser\",\"_qljs_destroy_parser\",\"_qljs_replace_text\",\"_qljs_lint_vscode\",\"_malloc\",\"_free\"]"
     -sASSERTIONS=0
     -sSTANDALONE_WASM=1
     --no-entry
diff --git a/plugin/vscode/quick-lint-js.js b/plugin/vscode/quick-lint-js.js
@@ -115,20 +115,20 @@ class Process {
     this._malloc = wrap(wasmInstance.exports.malloc, "malloc");
     this._free = wrap(wasmInstance.exports.free, "free");
     this._createParser = wrap(
-      wasmInstance.exports.qljs_vscode_create_parser,
-      "qljs_vscode_create_parser"
+      wasmInstance.exports.qljs_create_parser,
+      "qljs_create_parser"
     );
     this._destroyParser = wrap(
-      wasmInstance.exports.qljs_vscode_destroy_parser,
-      "qljs_vscode_destroy_parser"
+      wasmInstance.exports.qljs_destroy_parser,
+      "qljs_destroy_parser"
     );
     this._replaceText = wrap(
-      wasmInstance.exports.qljs_vscode_replace_text,
-      "qljs_vscode_replace_text"
+      wasmInstance.exports.qljs_replace_text,
+      "qljs_replace_text"
     );
-    this._lint = wrap(
-      wasmInstance.exports.qljs_vscode_lint,
-      "qljs_vscode_lint"
+    this._lintVSCode = wrap(
+      wasmInstance.exports.qljs_lint_vscode,
+      "qljs_lint_vscode"
     );
   }
 
@@ -161,7 +161,7 @@ class Parser {
   }
 
   lint() {
-    let diagnosticsPointer = this._process._lint(this._parser);
+    let diagnosticsPointer = this._process._lintVSCode(this._parser);
 
     let rawDiagnosticsU32 = new Uint32Array(
       this._process._heap,
diff --git a/plugin/vscode/test/other-tests.js b/plugin/vscode/test/other-tests.js
@@ -266,9 +266,9 @@ let tests = {
     let rng = new ExhaustiveRNG();
     injectFaults(
       (functionName) => {
-        // TODO(strager): Figure out why qljs_vscode_create_parser failures
+        // TODO(strager): Figure out why qljs_create_parser failures
         // cause this test to fail.
-        if (functionName !== "qljs_vscode_create_parser") {
+        if (functionName !== "qljs_create_parser") {
           let shouldCrash = rng.nextCoinFlip();
           coinFlips.push(shouldCrash);
           if (shouldCrash) {
diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt
@@ -29,6 +29,7 @@ quick_lint_js_add_library(
   assert.cpp
   buffering-error-reporter.cpp
   byte-buffer.cpp
+  c-api.cpp
   char8.cpp
   cli-location.cpp
   crash.cpp
@@ -61,6 +62,7 @@ quick_lint_js_add_library(
   quick-lint-js/buffering-error-reporter.h
   quick-lint-js/buffering-visitor.h
   quick-lint-js/byte-buffer.h
+  quick-lint-js/c-api.h
   quick-lint-js/char8.h
   quick-lint-js/cli-location.h
   quick-lint-js/constant-divider.h
@@ -113,7 +115,6 @@ quick_lint_js_add_library(
   quick-lint-js/vim-location.h
   quick-lint-js/vim-qflist-json-error-reporter.h
   quick-lint-js/vscode-error-reporter.h
-  quick-lint-js/vscode.h
   quick-lint-js/warning.h
   quick-lint-js/wasm-demo-error-reporter.h
   quick-lint-js/wasm-demo-location.h
@@ -126,7 +127,6 @@ quick_lint_js_add_library(
   vim-location.cpp
   vim-qflist-json-error-reporter.cpp
   vscode-error-reporter.cpp
-  vscode.cpp
   wasm-demo-error-reporter.cpp
   wasm-demo-location.cpp
 )
diff --git a/src/c-api.cpp b/src/c-api.cpp
@@ -2,6 +2,7 @@
 // See end of file for extended copyright information.
 
 #include <cstddef>
+#include <quick-lint-js/c-api.h>
 #include <quick-lint-js/char8.h>
 #include <quick-lint-js/error.h>
 #include <quick-lint-js/lint.h>
@@ -10,11 +11,10 @@
 #include <quick-lint-js/padded-string.h>
 #include <quick-lint-js/parse.h>
 #include <quick-lint-js/vscode-error-reporter.h>
-#include <quick-lint-js/vscode.h>
 
-struct qljs_vscode_parser {
+struct qljs_parser {
  public:
-  const qljs_vscode_diagnostic* lint() {
+  const qljs_vscode_diagnostic* lint_vscode() {
     return this->error_reporter_.get_diagnostics();
   }
 
@@ -45,27 +45,26 @@ struct qljs_vscode_parser {
   quick_lint_js::vscode_error_reporter error_reporter_;
 };
 
-qljs_vscode_parser* qljs_vscode_create_parser(void) {
-  qljs_vscode_parser* p = new qljs_vscode_parser();
+qljs_parser* qljs_create_parser(void) {
+  qljs_parser* p = new qljs_parser();
   return p;
 }
 
-void qljs_vscode_destroy_parser(qljs_vscode_parser* p) { delete p; }
+void qljs_destroy_parser(qljs_parser* p) { delete p; }
 
-void qljs_vscode_replace_text(qljs_vscode_parser* p, int start_line,
-                              int start_character, int end_line,
-                              int end_character,
-                              const void* replacement_text_utf_8,
-                              size_t replacement_text_byte_count) {
+void qljs_replace_text(qljs_parser* p, int start_line, int start_character,
+                       int end_line, int end_character,
+                       const void* replacement_text_utf_8,
+                       size_t replacement_text_byte_count) {
   p->replace_text(
       start_line, start_character, end_line, end_character,
       quick_lint_js::string8_view(
           reinterpret_cast<const quick_lint_js::char8*>(replacement_text_utf_8),
           replacement_text_byte_count));
 }
 
-const qljs_vscode_diagnostic* qljs_vscode_lint(qljs_vscode_parser* p) {
-  return p->lint();
+const qljs_vscode_diagnostic* qljs_lint_vscode(qljs_parser* p) {
+  return p->lint_vscode();
 }
 
 // quick-lint-js finds bugs in JavaScript programs.
diff --git a/src/quick-lint-js/c-api.h b/src/quick-lint-js/c-api.h
@@ -1,42 +1,42 @@
 // Copyright (C) 2020  Matthew Glazar
 // See end of file for extended copyright information.
 
-#ifndef QUICK_LINT_JS_VSCODE_H
-#define QUICK_LINT_JS_VSCODE_H
+#ifndef QUICK_LINT_JS_C_API_H
+#define QUICK_LINT_JS_C_API_H
 
 #include <stddef.h>
 
 #if defined(__cplusplus)
 extern "C" {
 #endif
 
-typedef struct qljs_vscode_parser qljs_vscode_parser;
+typedef struct qljs_parser qljs_parser;
 
-typedef enum qljs_vscode_severity {
-  qljs_vscode_severity_error = 1,
-  qljs_vscode_severity_warning = 2,
-} qljs_vscode_severity;
+typedef enum qljs_severity {
+  qljs_severity_error = 1,
+  qljs_severity_warning = 2,
+} qljs_severity;
 
-qljs_vscode_parser* qljs_vscode_create_parser(void);
-void qljs_vscode_destroy_parser(qljs_vscode_parser*);
+qljs_parser* qljs_create_parser(void);
 
-void qljs_vscode_replace_text(qljs_vscode_parser*, int start_line,
-                              int start_character, int end_line,
-                              int end_character,
-                              const void* replacement_text_utf_8,
-                              size_t replacement_text_byte_count);
+void qljs_destroy_parser(qljs_parser*);
+
+void qljs_replace_text(qljs_parser*, int start_line, int start_character,
+                       int end_line, int end_character,
+                       const void* replacement_text_utf_8,
+                       size_t replacement_text_byte_count);
 
 struct qljs_vscode_diagnostic {
   const char* message;
   const char* code;
-  qljs_vscode_severity severity;
+  qljs_severity severity;
   int start_line;
   int start_character;
   int end_line;
   int end_character;
 };
 
-const qljs_vscode_diagnostic* qljs_vscode_lint(qljs_vscode_parser*);
+const qljs_vscode_diagnostic* qljs_lint_vscode(qljs_parser*);
 
 #if defined(__cplusplus)
 }
diff --git a/src/vscode-error-reporter.cpp b/src/vscode-error-reporter.cpp
@@ -3,6 +3,7 @@
 
 #include <iostream>
 #include <memory>
+#include <quick-lint-js/c-api.h>
 #include <quick-lint-js/error.h>
 #include <quick-lint-js/location.h>
 #include <quick-lint-js/lsp-location.h>
@@ -12,7 +13,6 @@
 #include <quick-lint-js/token.h>
 #include <quick-lint-js/unreachable.h>
 #include <quick-lint-js/vscode-error-reporter.h>
-#include <quick-lint-js/vscode.h>
 #include <string>
 
 namespace quick_lint_js {
@@ -79,16 +79,16 @@ void vscode_error_formatter::write_message_part(severity sev,
 
 void vscode_error_formatter::write_after_message(
     severity sev, const source_code_span &origin) {
-  qljs_vscode_severity diag_severity = qljs_vscode_severity_error;
+  qljs_severity diag_severity = qljs_severity_error;
   switch (sev) {
   case severity::note:
     // Don't write notes. Only write the main message.
     return;
   case severity::error:
-    diag_severity = qljs_vscode_severity_error;
+    diag_severity = qljs_severity_error;
     break;
   case severity::warning:
-    diag_severity = qljs_vscode_severity_warning;
+    diag_severity = qljs_severity_warning;
     break;
   }
   qljs_vscode_diagnostic &diag = this->reporter_->diagnostics_.emplace_back();
diff --git a/test/CMakeLists.txt b/test/CMakeLists.txt
@@ -28,6 +28,7 @@ quick_lint_js_add_executable(
   test-buffering-error-reporter.cpp
   test-buffering-visitor.cpp
   test-byte-buffer.cpp
+  test-c-api.cpp
   test-cli-location.cpp
   test-constant-divider.cpp
   test-crash.cpp
@@ -75,7 +76,6 @@ quick_lint_js_add_executable(
   test-vim-location.cpp
   test-vim-qflist-json-error-reporter.cpp
   test-vscode-error-reporter.cpp
-  test-vscode.cpp
   test-wasm-demo-error-reporter.cpp
   test-wasm-demo-location.cpp
   test-write-integer.cpp
diff --git a/test/test-c-api.cpp b/test/test-c-api.cpp
@@ -2,26 +2,26 @@
 // See end of file for extended copyright information.
 
 #include <gtest/gtest.h>
+#include <quick-lint-js/c-api.h>
 #include <quick-lint-js/char8.h>
-#include <quick-lint-js/vscode.h>
 
 namespace quick_lint_js {
 namespace {
-TEST(test_vscode, empty_document_has_no_diagnostics) {
-  qljs_vscode_parser* p = qljs_vscode_create_parser();
-  const qljs_vscode_diagnostic* diagnostics = qljs_vscode_lint(p);
+TEST(test_c_api, empty_document_has_no_diagnostics) {
+  qljs_parser* p = qljs_create_parser();
+  const qljs_vscode_diagnostic* diagnostics = qljs_lint_vscode(p);
   EXPECT_EQ(diagnostics[0].message, nullptr);
-  qljs_vscode_destroy_parser(p);
+  qljs_destroy_parser(p);
 }
 
-TEST(test_vscode, lint_error_after_text_insertion) {
-  qljs_vscode_parser* p = qljs_vscode_create_parser();
+TEST(test_c_api, lint_error_after_text_insertion) {
+  qljs_parser* p = qljs_create_parser();
 
   const char8* document_text = u8"let x;let x;";
-  qljs_vscode_replace_text(p, /*start_line=*/0, /*start_character=*/0,
-                           /*end_line=*/1, /*end_character=*/0, document_text,
-                           strlen(document_text));
-  const qljs_vscode_diagnostic* diagnostics = qljs_vscode_lint(p);
+  qljs_replace_text(p, /*start_line=*/0, /*start_character=*/0,
+                    /*end_line=*/1, /*end_character=*/0, document_text,
+                    strlen(document_text));
+  const qljs_vscode_diagnostic* diagnostics = qljs_lint_vscode(p);
   EXPECT_NE(diagnostics[0].message, nullptr);
   EXPECT_EQ(diagnostics[1].message, nullptr);
   EXPECT_EQ(diagnostics[1].code, nullptr);
@@ -33,24 +33,24 @@ TEST(test_vscode, lint_error_after_text_insertion) {
   EXPECT_EQ(diagnostics[0].end_line, 0);
   EXPECT_EQ(diagnostics[0].end_character, strlen(u8"let x;let x"));
 
-  qljs_vscode_destroy_parser(p);
+  qljs_destroy_parser(p);
 }
 
-TEST(test_vscode, lint_new_error_after_second_text_insertion) {
-  qljs_vscode_parser* p = qljs_vscode_create_parser();
+TEST(test_c_api, lint_new_error_after_second_text_insertion) {
+  qljs_parser* p = qljs_create_parser();
 
   const char8* document_text = u8"let x;";
-  qljs_vscode_replace_text(p, /*start_line=*/0, /*start_character=*/0,
-                           /*end_line=*/1, /*end_character=*/0, document_text,
-                           strlen(document_text));
-  const qljs_vscode_diagnostic* diagnostics = qljs_vscode_lint(p);
+  qljs_replace_text(p, /*start_line=*/0, /*start_character=*/0,
+                    /*end_line=*/1, /*end_character=*/0, document_text,
+                    strlen(document_text));
+  const qljs_vscode_diagnostic* diagnostics = qljs_lint_vscode(p);
   EXPECT_EQ(diagnostics[0].message, nullptr);
 
-  qljs_vscode_replace_text(p, /*start_line=*/0, /*start_character=*/0,
-                           /*end_line=*/0, /*end_character=*/0, document_text,
-                           strlen(document_text));
+  qljs_replace_text(p, /*start_line=*/0, /*start_character=*/0,
+                    /*end_line=*/0, /*end_character=*/0, document_text,
+                    strlen(document_text));
   // Parser's text: let x;let x;
-  diagnostics = qljs_vscode_lint(p);
+  diagnostics = qljs_lint_vscode(p);
   EXPECT_NE(diagnostics[0].message, nullptr);
   EXPECT_EQ(diagnostics[1].message, nullptr);
   EXPECT_EQ(diagnostics[1].code, nullptr);
@@ -62,28 +62,28 @@ TEST(test_vscode, lint_new_error_after_second_text_insertion) {
   EXPECT_EQ(diagnostics[0].end_line, 0);
   EXPECT_EQ(diagnostics[0].end_character, strlen(u8"let x;let x"));
 
-  qljs_vscode_destroy_parser(p);
+  qljs_destroy_parser(p);
 }
 
-TEST(test_vscode, diagnostic_severity) {
-  qljs_vscode_parser* p = qljs_vscode_create_parser();
+TEST(test_c_api, diagnostic_severity) {
+  qljs_parser* p = qljs_create_parser();
 
   const char8* document_text = u8"let x;let x;\nundeclaredVariable;";
-  qljs_vscode_replace_text(p, /*start_line=*/0, /*start_character=*/0,
-                           /*end_line=*/1, /*end_character=*/0, document_text,
-                           strlen(document_text));
-  const qljs_vscode_diagnostic* diagnostics = qljs_vscode_lint(p);
+  qljs_replace_text(p, /*start_line=*/0, /*start_character=*/0,
+                    /*end_line=*/1, /*end_character=*/0, document_text,
+                    strlen(document_text));
+  const qljs_vscode_diagnostic* diagnostics = qljs_lint_vscode(p);
   EXPECT_NE(diagnostics[0].message, nullptr);
   EXPECT_NE(diagnostics[0].code, nullptr);
   EXPECT_NE(diagnostics[1].message, nullptr);
   EXPECT_NE(diagnostics[1].code, nullptr);
   EXPECT_EQ(diagnostics[2].message, nullptr);
   EXPECT_EQ(diagnostics[2].code, nullptr);
 
-  EXPECT_EQ(diagnostics[0].severity, qljs_vscode_severity_error);
-  EXPECT_EQ(diagnostics[1].severity, qljs_vscode_severity_warning);
+  EXPECT_EQ(diagnostics[0].severity, qljs_severity_error);
+  EXPECT_EQ(diagnostics[1].severity, qljs_severity_warning);
 
-  qljs_vscode_destroy_parser(p);
+  qljs_destroy_parser(p);
 }
 }
 }
diff --git a/test/test-vscode-error-reporter.cpp b/test/test-vscode-error-reporter.cpp
