diagnostic.h

Go to the documentation of this file.

/*
 * Copyright 2026 The A11 Authors
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 
#ifndef A11_FLOW_DIAGNOSTIC_H_
#define A11_FLOW_DIAGNOSTIC_H_
 
#include <cstddef>
#include <string>
#include <string_view>
#include <vector>
 
#include <absl/types/span.h>
 
namespace a11::flow {
 
enum class Severity {
  kError,
  kWarning,
  kWeakWarning,
  kInformation,
};
 
enum class Family {
  kSyntax,
  kForm,
  kName,
  kSequence,
  kBarrier,
  kUnused,
};
 
struct Position {
  size_t offset = 0;
  int line = 1;
  int column = 1;
};
 
struct Range {
  Position start;
  Position end;
};
 
struct Edit {
  size_t start = 0;
  size_t end = 0;
  std::string text;
};
 
struct Fix {
  std::string label;
  std::vector<Edit> edits;
};
 
struct Diagnostic {
  std::string code;
  Severity severity = Severity::kError;
  Family family = Family::kSyntax;
  Range range;
  std::string message;
  std::string flow;
  std::vector<Fix> fixes;
};
 
std::string_view SeverityName(Severity severity);
 
std::string_view FamilyName(Family family);
 
Severity SeverityFromName(std::string_view name);
 
Family FamilyFromName(std::string_view name);
 
struct CodeInfo {
  std::string_view code;
  Family family;
  Severity severity;
  std::string_view summary;
};
 
const Diagnostic* absl_nullable FirstError(
    absl::Span<const Diagnostic> diagnostics);
 
absl::Span<const CodeInfo> KnownCodes();
 
const CodeInfo* absl_nullable FindCode(std::string_view code);
 
class LineIndex {
 public:
  explicit LineIndex(std::string_view source);
 
  [[nodiscard]] Position At(size_t offset) const;
 
  [[nodiscard]] Range Between(size_t start, size_t end) const;
 
  [[nodiscard]] size_t LineCount() const { return line_starts_.size(); }
 
  [[nodiscard]] size_t LineStart(int line) const;
 
 private:
  size_t length_ = 0;
  std::string_view source_;
  std::vector<size_t> line_starts_;
};
 
void SortDiagnostics(std::vector<Diagnostic>& diagnostics);
 
}  // namespace a11::flow
 
#endif  // A11_FLOW_DIAGNOSTIC_H_