//===- PrintPasses.h - Determining whether/when to print IR ---------------===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//

#ifndef LLVM_IR_PRINTPASSES_H
#define LLVM_IR_PRINTPASSES_H

#include "llvm/ADT/StringRef.h"
#include "llvm/Support/CommandLine.h"
#include <vector>

namespace llvm {

enum class ChangePrinter {
  None,
  Verbose,
  Quiet,
  DiffVerbose,
  DiffQuiet,
  ColourDiffVerbose,
  ColourDiffQuiet,
  DotCfgVerbose,
  DotCfgQuiet
};

extern LLVM_ABI cl::opt<ChangePrinter> PrintChanged;

// Returns true if printing before/after some pass is enabled, whether all
// passes or a specific pass.
LLVM_ABI bool shouldPrintBeforeSomePass();
LLVM_ABI bool shouldPrintAfterSomePass();

// Returns true if we should print before/after a specific pass. The argument
// should be the pass ID, e.g. "instcombine".
LLVM_ABI bool shouldPrintBeforePass(StringRef PassID);
LLVM_ABI bool shouldPrintAfterPass(StringRef PassID);

// Returns true if we should print before/after all passes.
LLVM_ABI bool shouldPrintBeforeAll();
LLVM_ABI bool shouldPrintAfterAll();

// The list of passes to print before/after, if we only want to print
// before/after specific passes.
LLVM_ABI std::vector<std::string> printBeforePasses();
LLVM_ABI std::vector<std::string> printAfterPasses();

// Returns true if we should always print the entire module.
LLVM_ABI bool forcePrintModuleIR();

// Returns true if we should print the entire function for loop passes.
LLVM_ABI bool forcePrintFuncIR();

// Return true if -filter-passes is empty or contains the pass name.
LLVM_ABI bool isPassInPrintList(StringRef PassName);
LLVM_ABI bool isFilterPassesEmpty();

// Returns true if we should print the function.
LLVM_ABI bool isFunctionInPrintList(StringRef FunctionName);

// Ensure temporary files exist, creating or re-using them.  \p FD contains
// file descriptors (-1 indicates that the file should be created) and
// \p SR contains the corresponding initial content.  \p FileName will have
// the filenames filled in when creating files.  Return first error code (if
// any) and stop.
LLVM_ABI std::error_code prepareTempFiles(SmallVector<int> &FD,
                                          ArrayRef<StringRef> SR,
                                          SmallVector<std::string> &FileName);

// Remove the temporary files in \p FileName.  Typically used in conjunction
// with prepareTempFiles.  Return first error code (if any) and stop..
LLVM_ABI std::error_code cleanUpTempFiles(ArrayRef<std::string> FileName);

// Perform a system based diff between \p Before and \p After, using \p
// OldLineFormat, \p NewLineFormat, and \p UnchangedLineFormat to control the
// formatting of the output. Return an error message for any failures instead
// of the diff.
LLVM_ABI std::string doSystemDiff(StringRef Before, StringRef After,
                                  StringRef OldLineFormat,
                                  StringRef NewLineFormat,
                                  StringRef UnchangedLineFormat);

// Report a -print-changed diff for one pass over one IR unit (function or
// module). IsInteresting is isPassInPrintList(PassID); ShouldReport is whether
// the unit passed all filters (Before/After are only set then).
LLVM_ABI void reportChangedIR(StringRef Before, StringRef After,
                              StringRef PassName, StringRef PassID,
                              StringRef IRName, bool IsInteresting,
                              bool ShouldReport);

} // namespace llvm

#endif // LLVM_IR_PRINTPASSES_H