nullability/inference/infer_tu.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_INFERENCE_INFER_TU_H_
#define CRUBIT_NULLABILITY_INFERENCE_INFER_TU_H_

#include <string>

#include "absl/container/flat_hash_map.h"
#include "nullability/inference/inference.proto.h"
#include "nullability/pragma.h"
#include "clang/AST/ASTContext.h"
#include "clang/AST/DeclBase.h"
#include "llvm/ADT/STLFunctionalExtras.h"

namespace clang::tidy::nullability {

// Map from USR to a map from slot number to an inference for that slot.
using InferenceResults =
    absl::flat_hash_map<std::string, absl::flat_hash_map<Slot, SlotInference>>;

// Performs nullability inference within the scope of a single translation unit.
//
// This is not as powerful as running inference over the whole codebase, but is
// useful in observing the behavior of the inference system.
// It also lets us write tests for the whole inference system.
//
// If Filter is provided, only considers decls that return true.
InferenceResults inferTU(
    ASTContext &, const NullabilityPragmas &, unsigned Iterations = 1,
    llvm::function_ref<bool(const Decl &)> Filter = nullptr);

}  // namespace clang::tidy::nullability

#endif