[arcmt] Add some additional driver flags to optionally emit or save the pre-migration ARC errors.

-arcmt-migrate-emit-errors : Emits the pre-migration ARC errors but it doesn't affect anything else
-arcmt-migrate-report-output : Writes out the pre-migration ARC errors to the provided plist file

rdar://9791454

git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@135491 91177308-0d34-0410-b5e6-96231b3b80d8

Author: akyrtzi

include/clang/ARCMigrate/ARCMT.h

@@ -28,10 +28,19 @@ namespace arcmt {
 /// It then checks the AST and produces errors/warning for ARC migration issues
 /// that the user needs to handle manually.
 ///
+/// \param emitPremigrationARCErrors if true all ARC errors will get emitted
+/// even if the migrator can fix them, but the function will still return false
+/// if all ARC errors can be fixed.
+///
+/// \param plistOut if non-empty, it is the file path to store the plist with
+/// the pre-migration ARC diagnostics.
+///
 /// \returns false if no error is produced, true otherwise.
 bool checkForManualIssues(CompilerInvocation &CI,
                           llvm::StringRef Filename, InputKind Kind,
-                          DiagnosticClient *DiagClient);
+                          DiagnosticClient *DiagClient,
+                          bool emitPremigrationARCErrors = false,
+                          llvm::StringRef plistOut = llvm::StringRef());
 
 /// \brief Works similar to checkForManualIssues but instead of checking, it
 /// applies automatic modifications to source files to conform to ARC.
@@ -44,11 +53,20 @@ bool applyTransformations(CompilerInvocation &origCI,
 /// \brief Applies automatic modifications and produces temporary files
 /// and metadata into the \arg outputDir path.
 ///
+/// \param emitPremigrationARCErrors if true all ARC errors will get emitted
+/// even if the migrator can fix them, but the function will still return false
+/// if all ARC errors can be fixed.
+///
+/// \param plistOut if non-empty, it is the file path to store the plist with
+/// the pre-migration ARC diagnostics.
+///
 /// \returns false if no error is produced, true otherwise.
 bool migrateWithTemporaryFiles(CompilerInvocation &origCI,
                                llvm::StringRef Filename, InputKind Kind,
                                DiagnosticClient *DiagClient,
-                               llvm::StringRef outputDir);
+                               llvm::StringRef outputDir,
+                               bool emitPremigrationARCErrors,
+                               llvm::StringRef plistOut);
 
 /// \brief Get the set of file remappings from the \arg outputDir path that
 /// migrateWithTemporaryFiles produced.

include/clang/ARCMigrate/ARCMTActions.h

@@ -34,11 +34,15 @@ class ModifyAction : public WrapperFrontendAction {
 
 class MigrateAction : public WrapperFrontendAction {
   std::string MigrateDir;
+  std::string PlistOut;
+  bool EmitPremigrationARCErros;
 protected:
   virtual bool BeginInvocation(CompilerInstance &CI);
 
 public:
-  MigrateAction(FrontendAction *WrappedAction, llvm::StringRef migrateDir);
+  MigrateAction(FrontendAction *WrappedAction, llvm::StringRef migrateDir,
+                llvm::StringRef plistOut,
+                bool emitPremigrationARCErrors);
 };
 
 }

include/clang/Driver/CC1Options.td

@@ -394,6 +394,10 @@ def arcmt_migrate : Flag<"-arcmt-migrate">,
   HelpText<"Apply modifications and produces temporary files that conform to ARC">;
 def arcmt_migrate_directory : Separate<"-arcmt-migrate-directory">,
   HelpText<"Directory for temporary files produced during ARC migration">;
+def arcmt_migrate_report_output : Separate<"-arcmt-migrate-report-output">,
+  HelpText<"Output path for the plist report">;
+def arcmt_migrate_emit_arc_errors : Flag<"-arcmt-migrate-emit-errors">,
+  HelpText<"Emit ARC errors even if the migrator can fix them">;
 
 def import_module : Separate<"-import-module">,
   HelpText<"Import a module definition file">;

include/clang/Driver/Options.td

@@ -122,6 +122,10 @@ def ccc_arcmt_migrate : Separate<"-ccc-arcmt-migrate">, CCCDriverOpt,
   HelpText<"Apply modifications and produces temporary files that conform to ARC">;
 def ccc_arcmt_migrate_EQ : Joined<"-ccc-arcmt-migrate=">, CCCDriverOpt,
   Alias<ccc_arcmt_migrate>;
+def arcmt_migrate_report_output : Separate<"-arcmt-migrate-report-output">,
+  HelpText<"Output path for the plist report">;
+def arcmt_migrate_emit_arc_errors : Flag<"-arcmt-migrate-emit-errors">,
+  HelpText<"Emit ARC errors even if the migrator can fix them">;
 
 // Make sure all other -ccc- options are rejected.
 def ccc_ : Joined<"-ccc-">, Group<ccc_Group>, Flags<[Unsupported]>;

include/clang/Frontend/FrontendOptions.h

@@ -75,6 +75,8 @@ class FrontendOptions {
   unsigned ShowVersion : 1;                ///< Show the -version text.
   unsigned FixWhatYouCan : 1;              ///< Apply fixes even if there are
                                            /// unfixable errors.
+  unsigned ARCMTMigrateEmitARCErrors : 1;  /// Emit ARC errors even if the
+                                           /// migrator can fix them
 
   enum {
     ARCMT_None,
@@ -84,6 +86,7 @@ class FrontendOptions {
   } ARCMTAction;
 
   std::string ARCMTMigrateDir;
+  std::string ARCMTMigrateReportOut;
 
   /// The input files and their types.
   std::vector<std::pair<InputKind, std::string> > Inputs;
@@ -140,6 +143,7 @@ class FrontendOptions {
     ShowTimers = 0;
     ShowVersion = 0;
     ARCMTAction = ARCMT_None;
+    ARCMTMigrateEmitARCErrors = 0;
   }
 
   /// getInputKindForExtension - Return the appropriate input kind for a file

lib/ARCMigrate/ARCMT.cpp

@@ -10,6 +10,7 @@
 #include "Internals.h"
 #include "clang/Frontend/ASTUnit.h"
 #include "clang/Frontend/CompilerInstance.h"
+#include "clang/Frontend/TextDiagnosticPrinter.h"
 #include "clang/Frontend/Utils.h"
 #include "clang/AST/ASTConsumer.h"
 #include "clang/Rewrite/Rewriter.h"
@@ -194,13 +195,29 @@ CompilerInvocation *createInvocationForMigration(CompilerInvocation &origCI) {
   return CInvok.take();
 }
 
+void emitPremigrationErrors(const CapturedDiagList &arcDiags,
+                            const DiagnosticOptions &diagOpts,
+                            Preprocessor &PP) {
+  TextDiagnosticPrinter printer(llvm::errs(), diagOpts);
+  llvm::IntrusiveRefCntPtr<DiagnosticIDs> DiagID(new DiagnosticIDs());
+  llvm::IntrusiveRefCntPtr<Diagnostic> Diags(
+                   new Diagnostic(DiagID, &printer, /*ShouldOwnClient=*/false));
+  Diags->setSourceManager(&PP.getSourceManager());
+  
+  printer.BeginSourceFile(PP.getLangOptions(), &PP);
+  arcDiags.reportDiagnostics(*Diags);
+  printer.EndSourceFile();
+}
+
 //===----------------------------------------------------------------------===//
 // checkForManualIssues.
 //===----------------------------------------------------------------------===//
 
 bool arcmt::checkForManualIssues(CompilerInvocation &origCI,
                                  llvm::StringRef Filename, InputKind Kind,
-                                 DiagnosticClient *DiagClient) {
+                                 DiagnosticClient *DiagClient,
+                                 bool emitPremigrationARCErrors,
+                                 llvm::StringRef plistOut) {
   if (!origCI.getLangOpts().ObjC1)
     return false;
 
@@ -241,6 +258,18 @@ bool arcmt::checkForManualIssues(CompilerInvocation &origCI,
     return true;
   }
 
+  if (emitPremigrationARCErrors)
+    emitPremigrationErrors(capturedDiags, origCI.getDiagnosticOpts(),
+                           Unit->getPreprocessor());
+  if (!plistOut.empty()) {
+    llvm::SmallVector<StoredDiagnostic, 8> arcDiags;
+    for (CapturedDiagList::iterator
+           I = capturedDiags.begin(), E = capturedDiags.end(); I != E; ++I)
+      arcDiags.push_back(*I);
+    writeARCDiagsToPlist(plistOut, arcDiags,
+                         Ctx.getSourceManager(), Ctx.getLangOptions());
+  }
+
   // After parsing of source files ended, we want to reuse the
   // diagnostics objects to emit further diagnostics.
   // We call BeginSourceFile because DiagnosticClient requires that 
@@ -276,13 +305,16 @@ bool arcmt::checkForManualIssues(CompilerInvocation &origCI,
 static bool applyTransforms(CompilerInvocation &origCI,
                             llvm::StringRef Filename, InputKind Kind,
                             DiagnosticClient *DiagClient,
-                            llvm::StringRef outputDir) {
+                            llvm::StringRef outputDir,
+                            bool emitPremigrationARCErrors,
+                            llvm::StringRef plistOut) {
   if (!origCI.getLangOpts().ObjC1)
     return false;
 
   // Make sure checking is successful first.
   CompilerInvocation CInvokForCheck(origCI);
-  if (arcmt::checkForManualIssues(CInvokForCheck, Filename, Kind, DiagClient))
+  if (arcmt::checkForManualIssues(CInvokForCheck, Filename, Kind, DiagClient,
+                                  emitPremigrationARCErrors, plistOut))
     return true;
 
   CompilerInvocation CInvok(origCI);
@@ -317,15 +349,19 @@ static bool applyTransforms(CompilerInvocation &origCI,
 bool arcmt::applyTransformations(CompilerInvocation &origCI,
                                  llvm::StringRef Filename, InputKind Kind,
                                  DiagnosticClient *DiagClient) {
-  return applyTransforms(origCI, Filename, Kind, DiagClient, llvm::StringRef());
+  return applyTransforms(origCI, Filename, Kind, DiagClient,
+                         llvm::StringRef(), false, llvm::StringRef());
 }
 
 bool arcmt::migrateWithTemporaryFiles(CompilerInvocation &origCI,
                                       llvm::StringRef Filename, InputKind Kind,
                                       DiagnosticClient *DiagClient,
-                                      llvm::StringRef outputDir) {
+                                      llvm::StringRef outputDir,
+                                      bool emitPremigrationARCErrors,
+                                      llvm::StringRef plistOut) {
   assert(!outputDir.empty() && "Expected output directory path");
-  return applyTransforms(origCI, Filename, Kind, DiagClient, outputDir);
+  return applyTransforms(origCI, Filename, Kind, DiagClient,
+                         outputDir, emitPremigrationARCErrors, plistOut);
 }
 
 bool arcmt::getFileRemappings(std::vector<std::pair<std::string,std::string> > &

lib/ARCMigrate/ARCMTActions.cpp

@@ -38,16 +38,26 @@ ModifyAction::ModifyAction(FrontendAction *WrappedAction)
   : WrapperFrontendAction(WrappedAction) {}
 
 bool MigrateAction::BeginInvocation(CompilerInstance &CI) {
-  return !arcmt::migrateWithTemporaryFiles(CI.getInvocation(),
+  if (arcmt::migrateWithTemporaryFiles(CI.getInvocation(),
                                            getCurrentFile(),
                                            getCurrentFileKind(),
                                            CI.getDiagnostics().getClient(),
-                                           MigrateDir);
+                                           MigrateDir,
+                                           EmitPremigrationARCErros,
+                                           PlistOut))
+    return false; // errors, stop the action.
+
+  // We only want to see diagnostics emitted by migrateWithTemporaryFiles.
+  CI.getDiagnostics().setIgnoreAllWarnings(true);
+  return true;
 }
 
 MigrateAction::MigrateAction(FrontendAction *WrappedAction,
-                             llvm::StringRef migrateDir)
-  : WrapperFrontendAction(WrappedAction), MigrateDir(migrateDir) {
+                             llvm::StringRef migrateDir,
+                             llvm::StringRef plistOut,
+                             bool emitPremigrationARCErrors)
+  : WrapperFrontendAction(WrappedAction), MigrateDir(migrateDir),
+    PlistOut(plistOut), EmitPremigrationARCErros(emitPremigrationARCErrors) {
   if (MigrateDir.empty())
     MigrateDir = "."; // user current directory if none is given.
 }

lib/ARCMigrate/Internals.h

@@ -32,8 +32,16 @@ class CapturedDiagList {
   void reportDiagnostics(Diagnostic &diags) const;
 
   bool hasErrors() const;
+
+  typedef ListTy::const_iterator iterator;
+  iterator begin() const { return List.begin(); }
+  iterator end()   const { return List.end();   }
 };
 
+void writeARCDiagsToPlist(const std::string &outPath,
+                          llvm::ArrayRef<StoredDiagnostic> diags,
+                          SourceManager &SM, const LangOptions &LangOpts);
+
 class TransformActions {
   Diagnostic &Diags;
   CapturedDiagList &CapturedDiags;