chore: Simplify APIs to resolve source locations

robertoraggi · robertoraggi · commit 7d409ddd86d0 · 2024-11-01T19:56:49.000+01:00
diff --git a/packages/cxx-gen-ast/src/gen_ast_encoder_cc.ts b/packages/cxx-gen-ast/src/gen_ast_encoder_cc.ts
@@ -264,36 +264,34 @@ auto ASTEncoder::encodeSourceLocation(const SourceLocation& loc)
     return {};
   }
 
-  std::string_view fileName;
-  std::uint32_t line = 0, column = 0;
-  unit_->getTokenStartPosition(loc, &line, &column, &fileName);
+  const auto start = unit_->tokenStartPosition(loc);
 
   flatbuffers::Offset<io::SourceLine> sourceLineOffset;
 
-  auto key = std::tuple(fileName, line);
+  auto key = std::tuple(start.fileName, start.line);
 
   if (sourceLines_.contains(key)) {
     sourceLineOffset = sourceLines_.at(key).o;
   } else {
     flatbuffers::Offset<flatbuffers::String> fileNameOffset;
 
-    if (sourceFiles_.contains(fileName)) {
-      fileNameOffset = sourceFiles_.at(fileName);
+    if (sourceFiles_.contains(start.fileName)) {
+      fileNameOffset = sourceFiles_.at(start.fileName);
     } else {
-      fileNameOffset = fbb_.CreateString(fileName);
-      sourceFiles_.emplace(fileName, fileNameOffset.o);
+      fileNameOffset = fbb_.CreateString(start.fileName);
+      sourceFiles_.emplace(start.fileName, fileNameOffset.o);
     }
 
     io::SourceLineBuilder sourceLineBuilder{fbb_};
     sourceLineBuilder.add_file_name(fileNameOffset);
-    sourceLineBuilder.add_line(line);
+    sourceLineBuilder.add_line(start.line);
     sourceLineOffset = sourceLineBuilder.Finish();
     sourceLines_.emplace(std::move(key), sourceLineOffset.o);
   }
 
   io::SourceLocationBuilder sourceLocationBuilder{fbb_};
   sourceLocationBuilder.add_source_line(sourceLineOffset);
-  sourceLocationBuilder.add_column(column);
+  sourceLocationBuilder.add_column(start.column);
 
   auto offset = sourceLocationBuilder.Finish();
 
diff --git a/src/frontend/cxx/cxx_document.cc b/src/frontend/cxx/cxx_document.cc
@@ -47,27 +47,17 @@ struct Diagnostics final : cxx::DiagnosticsClient {
   Vector<lsp::Diagnostic> diagnostics{messages};
 
   void report(const cxx::Diagnostic& diag) override {
-    std::string_view fileName;
-    std::uint32_t line = 0;
-    std::uint32_t column = 0;
-
-    preprocessor()->getTokenStartPosition(diag.token(), &line, &column,
-                                          &fileName);
-
-    std::uint32_t endLine = 0;
-    std::uint32_t endColumn = 0;
-
-    preprocessor()->getTokenEndPosition(diag.token(), &endLine, &endColumn,
-                                        nullptr);
+    auto start = preprocessor()->tokenStartPosition(diag.token());
+    auto end = preprocessor()->tokenEndPosition(diag.token());
 
     auto tmp = json::object();
 
     auto d = diagnostics.emplace_back();
 
-    int s = std::max(int(line) - 1, 0);
-    int sc = std::max(int(column) - 1, 0);
-    int e = std::max(int(endLine) - 1, 0);
-    int ec = std::max(int(endColumn) - 1, 0);
+    int s = std::max(int(start.line) - 1, 0);
+    int sc = std::max(int(start.column) - 1, 0);
+    int e = std::max(int(end.line) - 1, 0);
+    int ec = std::max(int(end.column) - 1, 0);
 
     d.message(diag.message());
     d.range().start(lsp::Position(tmp).line(s).character(sc));
diff --git a/src/frontend/cxx/verify_diagnostics_client.cc b/src/frontend/cxx/verify_diagnostics_client.cc
@@ -20,6 +20,8 @@
 
 #include "verify_diagnostics_client.h"
 
+#include <cxx/source_location.h>
+
 namespace cxx {
 
 auto VerifyDiagnosticsClient::verify() const -> bool { return verify_; }
@@ -46,11 +48,8 @@ void VerifyDiagnosticsClient::handleComment(Preprocessor* preprocessor,
     return;
   }
 
-  std::string_view fileName;
-  unsigned line = 0;
-  unsigned column = 0;
-
-  preprocessor->getTokenStartPosition(token, &line, &column, &fileName);
+  const auto pos = preprocessor->tokenStartPosition(token);
+  auto line = pos.line;
 
   Severity severity = Severity::Error;
 
@@ -67,7 +66,7 @@ void VerifyDiagnosticsClient::handleComment(Preprocessor* preprocessor,
   const auto& message = match[3];
 
   expectedDiagnostics_.push_back(
-      {token, severity, std::string(fileName), message, line});
+      {token, severity, std::string(pos.fileName), message, line});
 }
 
 auto VerifyDiagnosticsClient::hasErrors() const -> bool {
@@ -121,15 +120,11 @@ auto VerifyDiagnosticsClient::findDiagnostic(const ExpectedDiagnostic& expected)
       return false;
     }
 
-    unsigned line = 0;
-    unsigned column = 0;
-    std::string_view fileName;
-
-    preprocessor()->getTokenStartPosition(d.token(), &line, &column, &fileName);
+    const auto pos = preprocessor()->tokenStartPosition(d.token());
 
-    if (line != expected.line) return false;
+    if (pos.line != expected.line) return false;
 
-    if (fileName != expected.fileName) return false;
+    if (pos.fileName != expected.fileName) return false;
 
     if (d.message() != expected.message) return false;
 
diff --git a/src/parser/cxx/diagnostics_client.cc b/src/parser/cxx/diagnostics_client.cc
@@ -22,6 +22,7 @@
 
 // cxx
 #include <cxx/preprocessor.h>
+#include <cxx/source_location.h>
 
 #include <cctype>
 #include <cstdlib>
@@ -50,19 +51,15 @@ void DiagnosticsClient::report(const Diagnostic& diag) {
       break;
   }  // switch
 
-  std::string_view fileName;
-  std::uint32_t line = 0;
-  std::uint32_t column = 0;
+  const auto pos = preprocessor_->tokenStartPosition(diag.token());
 
-  preprocessor_->getTokenStartPosition(diag.token(), &line, &column, &fileName);
-
-  if (!fileName.empty()) {
-    std::cerr << std::format("{}:{}:{}: {}\n", fileName, line, column,
-                             diag.message());
+  if (!pos.fileName.empty()) {
+    std::cerr << std::format("{}:{}:{}: {}\n", pos.fileName, pos.line,
+                             pos.column, diag.message());
 
     const auto textLine = preprocessor_->getTextLine(diag.token());
 
-    const auto end = std::max(0, static_cast<int>(column) - 1);
+    const auto end = std::max(0, static_cast<int>(pos.column) - 1);
 
     std::string indent{textLine.substr(0, end)};
 
diff --git a/src/parser/cxx/flatbuffers/ast_encoder.cc b/src/parser/cxx/flatbuffers/ast_encoder.cc
@@ -90,36 +90,34 @@ auto ASTEncoder::encodeSourceLocation(const SourceLocation& loc)
     return {};
   }
 
-  std::string_view fileName;
-  std::uint32_t line = 0, column = 0;
-  unit_->getTokenStartPosition(loc, &line, &column, &fileName);
+  const auto start = unit_->tokenStartPosition(loc);
 
   flatbuffers::Offset<io::SourceLine> sourceLineOffset;
 
-  auto key = std::tuple(fileName, line);
+  auto key = std::tuple(start.fileName, start.line);
 
   if (sourceLines_.contains(key)) {
     sourceLineOffset = sourceLines_.at(key).o;
   } else {
     flatbuffers::Offset<flatbuffers::String> fileNameOffset;
 
-    if (sourceFiles_.contains(fileName)) {
-      fileNameOffset = sourceFiles_.at(fileName);
+    if (sourceFiles_.contains(start.fileName)) {
+      fileNameOffset = sourceFiles_.at(start.fileName);
     } else {
-      fileNameOffset = fbb_.CreateString(fileName);
-      sourceFiles_.emplace(fileName, fileNameOffset.o);
+      fileNameOffset = fbb_.CreateString(start.fileName);
+      sourceFiles_.emplace(start.fileName, fileNameOffset.o);
     }
 
     io::SourceLineBuilder sourceLineBuilder{fbb_};
     sourceLineBuilder.add_file_name(fileNameOffset);
-    sourceLineBuilder.add_line(line);
+    sourceLineBuilder.add_line(start.line);
     sourceLineOffset = sourceLineBuilder.Finish();
     sourceLines_.emplace(std::move(key), sourceLineOffset.o);
   }
 
   io::SourceLocationBuilder sourceLocationBuilder{fbb_};
   sourceLocationBuilder.add_source_line(sourceLineOffset);
-  sourceLocationBuilder.add_column(column);
+  sourceLocationBuilder.add_column(start.column);
 
   auto offset = sourceLocationBuilder.Finish();
 
diff --git a/src/parser/cxx/preprocessor.cc b/src/parser/cxx/preprocessor.cc
@@ -1313,11 +1313,9 @@ void Preprocessor::Private::initialize() {
       "__LINE__",
       [this](const MacroExpansionContext &context) -> const TokList * {
         auto ts = context.ts;
-        unsigned line = 0;
-        preprocessor_->getTokenStartPosition(ts->tok->token(), &line, nullptr,
-                                             nullptr);
-        auto tk =
-            gen(TokenKind::T_INTEGER_LITERAL, string(std::to_string(line)));
+        const auto start = preprocessor_->tokenStartPosition(ts->tok->token());
+        auto tk = gen(TokenKind::T_INTEGER_LITERAL,
+                      string(std::to_string(start.line)));
         tk->sourceFile = ts->tok->sourceFile;
         tk->space = true;
         return cons(tk, ts->next);
@@ -2936,15 +2934,8 @@ void Preprocessor::getPreprocessedText(const std::vector<Token> &tokens,
       if (lastFileId != std::numeric_limits<std::uint32_t>::max()) {
         out << '\n';
       }
-      const auto &sourceFile = *d->sourceFiles_[fileId - 1];
-      std::uint32_t line = 0, column = 0;
-      getTokenStartPosition(token, &line, &column, nullptr);
-#if true
-      out << std::format("# {} \"{}\"\n", line, sourceFile.fileName);
-#else
-      out << std::format("# {} \"{}:{}:{}\"\n", line, sourceFile.fileName, line,
-                         column);
-#endif
+      const auto pos = tokenStartPosition(token);
+      out << std::format("# {} \"{}\"\n", pos.line, pos.fileName);
       lastFileId = fileId;
       atStartOfLine = true;
     } else if (token.startOfLine()) {
@@ -2968,10 +2959,9 @@ void Preprocessor::getPreprocessedText(const std::vector<Token> &tokens,
     }
 
     if (atStartOfLine) {
-      std::uint32_t line = 0, column = 0;
-      getTokenStartPosition(token, &line, &column, nullptr);
-      if (column > 0) {
-        for (std::uint32_t i = 0; i < column - 1; ++i) {
+      const auto pos = tokenStartPosition(token);
+      if (pos.column > 0) {
+        for (std::uint32_t i = 0; i < pos.column - 1; ++i) {
           out << ' ';
         }
       }
@@ -3059,44 +3049,42 @@ void Preprocessor::printMacros(std::ostream &out) const {
   }
 }
 
-void Preprocessor::getTokenStartPosition(const Token &token, unsigned *line,
-                                         unsigned *column,
-                                         std::string_view *fileName) const {
+auto Preprocessor::tokenStartPosition(const Token &token) const
+    -> SourcePosition {
   if (token.fileId() == 0) {
-    if (line) *line = 0;
-    if (column) *column = 0;
-    if (fileName) *fileName = std::string_view();
-    return;
+    return {};
   }
 
   auto &sourceFile = *d->sourceFiles_[token.fileId() - 1];
-  sourceFile.getTokenStartPosition(token.offset(), line, column, fileName);
+  SourcePosition pos;
+  sourceFile.getTokenStartPosition(token.offset(), &pos.line, &pos.column,
+                                   &pos.fileName);
+  return pos;
 }
 
-void Preprocessor::getTokenEndPosition(const Token &token, unsigned *line,
-                                       unsigned *column,
-                                       std::string_view *fileName) const {
+auto Preprocessor::tokenEndPosition(const Token &token) const
+    -> SourcePosition {
   if (token.fileId() == 0) {
-    if (line) *line = 0;
-    if (column) *column = 0;
-    if (fileName) *fileName = std::string_view();
-    return;
+    return {};
   }
 
   auto &sourceFile = *d->sourceFiles_[token.fileId() - 1];
-  sourceFile.getTokenStartPosition(token.offset() + token.length(), line,
-                                   column, fileName);
+
+  SourcePosition pos;
+  sourceFile.getTokenStartPosition(token.offset() + token.length(), &pos.line,
+                                   &pos.column, &pos.fileName);
+  return pos;
 }
 
 auto Preprocessor::getTextLine(const Token &token) const -> std::string_view {
   if (token.fileId() == 0) return {};
   const SourceFile *file = d->sourceFiles_[token.fileId() - 1].get();
-  unsigned line = 0;
-  getTokenStartPosition(token, &line, nullptr, nullptr);
+  const auto pos = tokenStartPosition(token);
   std::string_view source = file->source;
   const auto &lines = file->lines;
-  const auto start = lines.at(line - 1);
-  const auto end = line < lines.size() ? lines.at(line) : source.length();
+  const auto start = lines.at(pos.line - 1);
+  const auto end =
+      pos.line < lines.size() ? lines.at(pos.line) : source.length();
   auto textLine = source.substr(start, end - start);
   while (!textLine.empty()) {
     auto ch = textLine.back();
diff --git a/src/parser/cxx/preprocessor.h b/src/parser/cxx/preprocessor.h
@@ -37,6 +37,7 @@ class DiagnosticsClient;
 class CommentHandler;
 class Preprocessor;
 class PreprocessorDelegate;
+class SourcePosition;
 
 class CommentHandler {
  public:
@@ -135,12 +136,11 @@ class Preprocessor {
 
   void printMacros(std::ostream &out) const;
 
-  void getTokenStartPosition(const Token &token, unsigned *line,
-                             unsigned *column,
-                             std::string_view *fileName) const;
+  [[nodiscard]] auto tokenStartPosition(const Token &token) const
+      -> SourcePosition;
 
-  void getTokenEndPosition(const Token &token, unsigned *line, unsigned *column,
-                           std::string_view *fileName) const;
+  [[nodiscard]] auto tokenEndPosition(const Token &token) const
+      -> SourcePosition;
 
   [[nodiscard]] auto getTextLine(const Token &token) const -> std::string_view;
 
diff --git a/src/parser/cxx/source_location.h b/src/parser/cxx/source_location.h
@@ -20,7 +20,9 @@
 
 #pragma once
 
+#include <cstdint>
 #include <functional>
+#include <string_view>
 #include <tuple>
 
 namespace cxx {
@@ -71,6 +73,13 @@ class SourceLocation {
   }
 };
 
+class SourcePosition {
+ public:
+  std::string_view fileName;
+  std::uint32_t line = 0;
+  std::uint32_t column = 0;
+};
+
 }  // namespace cxx
 
 template <>
diff --git a/src/parser/cxx/translation_unit.cc b/src/parser/cxx/translation_unit.cc
@@ -108,16 +108,14 @@ auto TranslationUnit::tokenText(SourceLocation loc) const
   }  // switch
 }
 
-void TranslationUnit::getTokenStartPosition(SourceLocation loc, unsigned* line,
-                                            unsigned* column,
-                                            std::string_view* fileName) const {
-  preprocessor_->getTokenStartPosition(tokenAt(loc), line, column, fileName);
+auto TranslationUnit::tokenStartPosition(SourceLocation loc) const
+    -> SourcePosition {
+  return preprocessor_->tokenStartPosition(tokenAt(loc));
 }
 
-void TranslationUnit::getTokenEndPosition(SourceLocation loc, unsigned* line,
-                                          unsigned* column,
-                                          std::string_view* fileName) const {
-  preprocessor_->getTokenEndPosition(tokenAt(loc), line, column, fileName);
+auto TranslationUnit::tokenEndPosition(SourceLocation loc) const
+    -> SourcePosition {
+  return preprocessor_->tokenEndPosition(tokenAt(loc));
 }
 
 void TranslationUnit::parse(const ParserConfiguration& config) {
diff --git a/src/parser/cxx/translation_unit.h b/src/parser/cxx/translation_unit.h
