nullability_verification/pointer_nullability_diagnosis.h

// Part of the Crubit project, under the Apache License v2.0 with LLVM
// Exceptions. See /LICENSE for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception

#ifndef CRUBIT_NULLABILITY_VERIFICATION_POINTER_NULLABILITY_DIAGNOSIS_H_
#define CRUBIT_NULLABILITY_VERIFICATION_POINTER_NULLABILITY_DIAGNOSIS_H_

#include "clang/AST/ASTContext.h"
#include "clang/AST/Stmt.h"
#include "clang/Analysis/FlowSensitive/DataflowEnvironment.h"
#include "clang/Analysis/FlowSensitive/MatchSwitch.h"
#include "llvm/ADT/Optional.h"

namespace clang {
namespace tidy {
namespace nullability {

/// Checks that nullable pointers are used safely, using nullability information
/// that is collected by `PointerNullabilityAnalysis`.
///
/// Examples of null safety violations include dereferencing nullable pointers
/// without null checks, and assignments between pointers of incompatible
/// nullability.
class PointerNullabilityDiagnoser {
 public:
  PointerNullabilityDiagnoser();

  /// Returns the pointer to the statement if null safety is violated, otherwise
  /// the optional is empty.
  ///
  /// TODO(b/233582219): Extend diagnosis to return more information, e.g. the
  /// type of violation.
  llvm::Optional<const Stmt*> diagnose(const Stmt* Stmt, ASTContext& Ctx,
                                       const dataflow::Environment& Env) {
    return Diagnoser(*Stmt, Ctx, Env);
  }

 private:
  dataflow::MatchSwitch<const dataflow::Environment,
                        llvm::Optional<const Stmt*>>
      Diagnoser;
};

}  // namespace nullability
}  // namespace tidy
}  // namespace clang

#endif  // CRUBIT_NULLABILITY_VERIFICATION_POINTER_NULLABILITY_DIAGNOSIS_H_