TokenDiagnostic.swift

//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 2023 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See https://swift.org/LICENSE.txt for license information
// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//

/// If the token has an error that's inherent to the token itself and not its
/// surrounding structure, this defines the type of the error.
/// `byteOffset` specifies at which offset the error occurred.
public struct TokenDiagnostic: Hashable, Sendable {
  public enum Severity: Comparable, Sendable {
    case warning
    case error
  }

  /// Each diagnostic kind is uniquely represented by a value in this enum.
  public enum Kind: Sendable {
    // Please order these alphabetically

    case editorPlaceholder
    case equalMustHaveConsistentWhitespaceOnBothSides
    case expectedBinaryExponentInHexFloatLiteral
    case expectedClosingBraceInUnicodeEscape
    case expectedDigitInFloatLiteral
    case expectedHexCodeInUnicodeEscape
    case expectedHexDigitInHexLiteral
    case extraneousLeadingWhitespaceError
    case extraneousLeadingWhitespaceWarning
    case extraneousTrailingWhitespaceError
    case extraneousTrailingWhitespaceWarning
    case insufficientIndentationInMultilineStringLiteral
    case invalidBackslashInRawIdentifier
    case invalidBinaryDigitInIntegerLiteral
    case invalidCharacter
    case invalidDecimalDigitInIntegerLiteral
    case invalidEscapeSequenceInStringLiteral
    case invalidFloatingPointExponentCharacter
    case invalidFloatingPointExponentDigit
    case invalidHexDigitInIntegerLiteral
    case invalidIdentifierStartCharacter
    case invalidNumberOfHexDigitsInUnicodeEscape
    case invalidOctalDigitInIntegerLiteral
    case invalidUtf8
    case invalidWhitespaceInRawIdentifier
    case multilineRegexClosingNotOnNewline
    case nonBreakingSpace
    case nulCharacter
    case rawIdentifierCannotBeAllWhitespace
    case rawIdentifierCannotBeEmpty
    case rawIdentifierCannotBeOperator
    case sourceConflictMarker
    case spaceAtEndOfRegexLiteral
    case spaceAtStartOfRegexLiteral
    /// The lexer discovered an error but was not able to represent the offset of the error because it would overflow `LexerErrorOffset`.
    case tokenDiagnosticOffsetOverflow
    case unexpectedBlockCommentEnd
    case unicodeCurlyQuote
    case unprintableAsciiCharacter
    case unterminatedBlockComment

    /// The severity of the diagnostic, i.e. whether it’s a warning or error.
    var severity: Severity {
      switch self {
      case .editorPlaceholder: return .error
      case .equalMustHaveConsistentWhitespaceOnBothSides: return .error
      case .expectedBinaryExponentInHexFloatLiteral: return .error
      case .expectedClosingBraceInUnicodeEscape: return .error
      case .expectedDigitInFloatLiteral: return .error
      case .expectedHexCodeInUnicodeEscape: return .error
      case .expectedHexDigitInHexLiteral: return .error
      case .extraneousLeadingWhitespaceError: return .error
      case .extraneousLeadingWhitespaceWarning: return .warning
      case .extraneousTrailingWhitespaceError: return .error
      case .extraneousTrailingWhitespaceWarning: return .warning
      case .insufficientIndentationInMultilineStringLiteral: return .error
      case .invalidBackslashInRawIdentifier: return .error
      case .invalidBinaryDigitInIntegerLiteral: return .error
      case .invalidCharacter: return .error
      case .invalidDecimalDigitInIntegerLiteral: return .error
      case .invalidEscapeSequenceInStringLiteral: return .error
      case .invalidFloatingPointExponentCharacter: return .error
      case .invalidFloatingPointExponentDigit: return .error
      case .invalidHexDigitInIntegerLiteral: return .error
      case .invalidIdentifierStartCharacter: return .error
      case .invalidNumberOfHexDigitsInUnicodeEscape: return .error
      case .invalidOctalDigitInIntegerLiteral: return .error
      case .invalidUtf8: return .error
      case .invalidWhitespaceInRawIdentifier: return .error
      case .multilineRegexClosingNotOnNewline: return .error
      case .nonBreakingSpace: return .warning
      case .nulCharacter: return .warning
      case .rawIdentifierCannotBeAllWhitespace: return .error
      case .rawIdentifierCannotBeEmpty: return .error
      case .rawIdentifierCannotBeOperator: return .error
      case .sourceConflictMarker: return .error
      case .spaceAtEndOfRegexLiteral: return .error
      case .spaceAtStartOfRegexLiteral: return .error
      case .tokenDiagnosticOffsetOverflow: return .error
      case .unexpectedBlockCommentEnd: return .error
      case .unicodeCurlyQuote: return .error
      case .unprintableAsciiCharacter: return .error
      case .unterminatedBlockComment: return .error
      }
    }
  }

  /// The unique kind of this diagnostic.
  ///
  /// This kind determines the message that will be shown by the diagnostic.
  public let kind: Kind

  /// The offset at which the error is, in bytes relative to the token's leading
  /// trivia start (i.e. relative to the token's `position`)
  public let byteOffset: UInt16

  /// Construct a diagnostic of the given `kind` that is anchored at `byteOffset`,
  /// measured in UTF-8 bytes relative to the leading trivia start of the token
  /// this diagnostic will be attached to.
  public init(_ kind: Kind, byteOffset: UInt16) {
    self.kind = kind
    self.byteOffset = byteOffset
  }

  /// Construct a diagnostic of the given `kind` that is anchored at `byteOffset`,
  /// measured in UTF-8 bytes relative to the leading trivia start of the token
  /// this diagnostic will be attached to.
  ///
  /// Since the offset within the token is represented by 16 bits only,
  /// diagnostics that are more than 2^16 bytes from the token's start cannot
  /// be represented. In that case, emit a `tokenDiagnosticOffsetOverflow`
  /// diagnostic at the token’s start. 2^16 is quite a lot of characters for
  /// a single token (even when we include comments as trivia), so we don’t
  /// expect to hit this case most of the time.
  public init(_ kind: Kind, byteOffset: Int) {
    precondition(byteOffset >= 0)
    // `UInt16.max` gets optimized to a constant
    if byteOffset > UInt16.max {
      self.kind = .tokenDiagnosticOffsetOverflow
      self.byteOffset = 0
    } else {
      self.kind = kind
      self.byteOffset = UInt16(byteOffset)
    }
  }

  /// Picks the more severe error of `lhs` and `rhs`, preferring `lhs` if they
  /// have the same severity.
  public init?(combining lhs: TokenDiagnostic?, _ rhs: TokenDiagnostic?) {
    switch (lhs, rhs) {
    case (let lhs?, let rhs?):
      if rhs.severity > lhs.severity {
        // Prefer the rhs if it is more severe, otherwise continue using lhs.
        self = rhs
      } else {
        self = lhs
      }
    case (let lhs?, nil):
      self = lhs
    case (nil, let rhs?):
      self = rhs
    case (nil, nil):
      return nil
    }
  }

  /// The severity of the diagnostic, i.e. whether it’s a warning or error.
  public var severity: Severity {
    return kind.severity
  }
}