[analyzer][PlistMacroExpansion] Part 1.: New expand-macros flag

[Szelethus]

Summary

This is the first part of the implementation of the inclusion of macro expansions into the plist output.

This approach is very much different to what HTMLRewrite does -- the motivation behind this was that

• I really wanted to avoid const_cast,
• This patch aims to only expand macros relevant to the bugpath, so there's no point in lexing everything.

Sadly, it seems like I couldn't get away with a solution not re-implementing parts of the preprocessor -- macro arguments are expanded manually and somewhat painfully, but I am very confident about it's stability and correctness.

How I'm planning to do this:

• A new analyzer option was added to turn macro expansions on.
• BugReporter will compact the bugpath when that flag is enabled, thus creating PathDiagnosticMacroPieces. (fun fact: they were never created for plists before!)
• (Implemented in a separate patch) When a macro is emitted,
  1. a lexer is created to acquire the macro's name and arguments.
  2. The actual definition of the macro can be acquired from the Preprocessor.
     1. Should one of the tokens of the definition the parameter of the current macro, it has to be replaced manually with the information we gathered by lexing.
     2. Should one of them be be a macro, it will be expanded recursively. The information about parameters is passed on.

[Szelethus]

We need your all-seeing hawk eye!

[whisperity]

Your code looks good, just minor comments going on inline.
Trying to think of more cases to test for, in case someone generously misuses FLMs, as seen here in an example if you scroll down a bit: https://gcc.gnu.org/onlinedocs/cpp/Macro-Arguments.html#Macro-Arguments
Maybe one or two tests cases for this should be added, but I believe all corners are covered other than this.

I also very much like the idea of only lexxing out relevans macros.

Could you please run some tests on our usuals and upload a few cases (or a plist-to-html of your test file analysed) so we can see how nicely these relevant macros are handled?

(The whole thing, however, is generally disgusting. I'd've expected the Preprocessor to readily contain a lot of stuff that's going on here.)

include/clang/StaticAnalyzer/Core/AnalyzerOptions.h

689 ↗

(On Diff #167803)

Returns with true

lib/StaticAnalyzer/Core/PlistDiagnostics.cpp

261 ↗

(On Diff #167803)

move move move like in your other self-defined type below

292 ↗

(On Diff #167803)

the location of what?

298 ↗

(On Diff #167803)

the ranges of what?

668 ↗

(On Diff #167803)

You have two records named "MacroArgsInfo" and "MacroNameAndArgsInfo", this is confusing. A different name should be for this class here... maybe the later used MacroArgMap is good, and then the struct's field should be renamed ArgMap or just Args.

680 ↗

(On Diff #167803)

move string argument into local member (See https://www.bfilipek.com/2018/08/init-string-member.html, it's fascinating and me and @gamesh411 just found this again yesterday night.)

711–712 ↗

(On Diff #167803)

Indentation of these lines is wrong.

723 ↗

(On Diff #167803)

"this is a" or "macro is function-like"

725 ↗

(On Diff #167803)

its

726 ↗

(On Diff #167803)

What's a "\"super\" macro"? Maybe "outer" (or "outermost") is the word you wanted to use here?

737 ↗

(On Diff #167803)

Unnecessary ; at the end?

756 ↗

(On Diff #167803)

&& "Ill-formed input: macro args were never closed!"

765 ↗

(On Diff #167803)

Token& so copies are explicitly not created?

796 ↗

(On Diff #167803)

Okay, this looks nasty. I get that pointer offsetting is commutative, but... this is nasty.

Also, what's the difference between using .data() and .begin()? Lexer's this overload takes three const char* params. Maybe this extra variable here is useless and you could just pass BufferInfo.data() + LocInfo.second to the constructor below.

796 ↗

(On Diff #167803)

Or we need a better name or a comment here.

test/Analysis/plist-macros-with-expansion.cpp

24 ↗

(On Diff #167803)

Why do we use the HTML entity tag ' instead of '? Is the PList output expanded this much?

[Szelethus]

• Fixes according to @whisperity's comments
• New test cases for
  • commas in brackets,
  • commas in braces,
  • macro arguments left empty.

(The whole thing, however, is generally disgusting. I'd've expected the Preprocessor to readily contain a lot of stuff that's going on here.)

Don't even get me started.

[Szelethus]

lib/StaticAnalyzer/Core/PlistDiagnostics.cpp

292 ↗

(On Diff #167803)

This is fairly obvious from the context, and is used throughout the whole file, so I'm leaving this one as is.

737 ↗

(On Diff #167803)

It is actually necessary ^-^

765 ↗

(On Diff #167803)

I've seen Token being copied all over the place in other files, but after looking at it's implementation, const ref should be better.

test/Analysis/plist-macros-with-expansion.cpp

24 ↗

(On Diff #167803)

Yup, unfortunately.

[donat.nagy]

What would happen if this checker encounters a variadic macro (introduced to the standard in in C++11, see syntax (3) and (4) here) or the # and ## preprocessor operators?

lib/StaticAnalyzer/Core/PlistDiagnostics.cpp

755 ↗

(On Diff #167924)

I fear that this does not handle nested parentheses correctly; e.g. in a case like MACRO_ONE(foo, MACRO_TWO(bar, baz), spam), it does not skip , spam).

[Szelethus]

• Prettified the RUN: lines,
• Fixed a crash with variadic macros,
• Added TODOs to handle # and ##,
• Added an expected plist output.

I initially justified the size of this patch due to how intertwined everything is, but given that there's still some work left to do, I might end up splitting it up.

In D52742#1252441, @donat.nagy wrote:

What would happen if this checker encounters a variadic macro (introduced to the standard in in C++11, see syntax (3) and (4) here) or the # and ## preprocessor operators?

Spot on observation, but it'll probably be the task of a followup patch.

[Szelethus]

lib/StaticAnalyzer/Core/PlistDiagnostics.cpp

755 ↗

(On Diff #167924)

And rightfully so, nice catch!

[Szelethus]

I initially justified the size of this patch due to how intertwined everything is, but given that there's still some work left to do, I might end up splitting it up.

I wouldn't enjoy reviewing a patch of this size very much, so I decided to split this up into 3 parts. This one will only contain the new flag.

[whisperity]

test/Analysis/Inputs/expected-plists/plist-macros-with-expansion.cpp.plist

6 ↗

(On Diff #167992)

You are diffing against a hardcoded output file which contains a git hash! Won't this break at the next commit?!

[Szelethus]

test/Analysis/Inputs/expected-plists/plist-macros-with-expansion.cpp.plist

6 ↗

(On Diff #167992)

I'm actually using %diff_plist!

// Check the actual plist output.
//   RUN: cat %t.plist | %diff_plist \
//   RUN:   %S/Inputs/expected-plists/plist-macros-with-expansion.cpp.plist

Here's the patch that implemented it (should jump to the config file): D52036#change-mOw5EmE2OiVA

[xazax.hun]

test/Analysis/Inputs/expected-plists/plist-macros-with-expansion.cpp.plist

6 ↗

(On Diff #167992)

Even if it will not break the build I would prefer to remove the non-official fork/mirror links from the test file.

[whisperity]

test/Analysis/Inputs/expected-plists/plist-macros-with-expansion.cpp.plist

346 ↗

(On Diff #168320)

Same here, as @xazax.hun mentioned. (Damn when I make a checker I'll be careful to ensure my paths don't contain swearwords... 😜 )

Maybe we should carefully analyse what is exactly needed from the plist and throw the rest, just to make the whole file smaller. Plists are pretty bloaty already...

[Szelethus]

Removed the version entry from the plist file.

[NoQ]

lib/StaticAnalyzer/Core/AnalyzerOptions.cpp

469 ↗

(On Diff #167803)

Should we say something about plists in the option name?

test/Analysis/Inputs/expected-plists/plist-macros-with-expansion.cpp.plist

44–54 ↗

(On Diff #169858)

Because we're adding an element of an <array> rather than a key of a <dict>, I'm not entirely sure this is backwards compatible. Clients may crash if they iterate over the path array and encounter an unexpected element kind. Is it going to be bad for your use case if we put expansions into a separate array alongside the path array?

[Szelethus]

lib/StaticAnalyzer/Core/AnalyzerOptions.cpp

469 ↗

(On Diff #167803)

Sure, but should my AnalyzerOptions refactoring effort go through first, I intend emit warnings if flags aren't set correctly (eg. the output isn't set to plist but this flag is enabled). Should probably rename "serialize-stats" too then.

http://lists.llvm.org/pipermail/cfe-dev/2018-October/059842.html

test/Analysis/Inputs/expected-plists/plist-macros-with-expansion.cpp.plist

44–54 ↗

(On Diff #169858)

It shouldn't be :)

[Szelethus]

Added a new macro_expansions key on the same level at path and notes, under which the macro expansions are listed, as suggested by @NoQ.

There were a couple ways to make this happen. I could've changed how macro pieces are made in BugReporter, so that they are created but the path isn't compacted, but then the BugReporter's implementation would be complicated by doing specific things for specific output formats. I instead decided to manually flatten macro pieces in PlistDiagnostics.

Since FlushDiagnosticsImpl was already super long, I decided to move both the logic of this patch and the logic for notes into a separate function.

[NoQ]

lib/StaticAnalyzer/Core/AnalyzerOptions.cpp

471 ↗

(On Diff #170509)

Yup, np, let's wait until it lands then.

test/Analysis/Inputs/expected-plists/plist-macros-with-expansion.cpp.plist

17–18 ↗

(On Diff #170509)

They look empty. I don't think this is intended.

[NoQ]

test/Analysis/Inputs/expected-plists/plist-macros-with-expansion.cpp.plist

17–18 ↗

(On Diff #170509)

Oh, wait, right, those are not implemented yet!

[Szelethus]

@xazax.hun observed that the way diagnostics looks like is this:

diagnostics
  report 1
    notes
    macro_expansions
    path
    executed_lines
  report 2
    ...

Buuuut, if I didn't insist on this structure, but rather print macros at the end of the report, we wouldn't need all this hackery (converting an immutable container into a mutable one, and then actually modifying the path). This however does imply that macro pieces have to be collected, which would imply the need for adding yet another parameter to every single function in this file. I think the time has come to collect them in a class, so I'll put this patch on hold.

Mind you, the rest of the patches don't contain logic that depends on this patch.

[Szelethus]

Changes according to my last comment.

[xazax.hun]

LGTM! Thanks, I think it is much easier to understand what is going on this way.

[Szelethus]

lib/StaticAnalyzer/Core/AnalyzerOptions.cpp

471 ↗

(On Diff #170509)

I'll commit as is, because D53277 is blocked by D53276, and I'd very much like to get this project out of the way as soon as possible.

cfe/trunk/include/clang/StaticAnalyzer/Core/AnalyzerOptions.h

private:
   Optional<bool> WidenLoops;
 
   /// \sa shouldUnrollLoops
   Optional<bool> UnrollLoops;
 
   /// \sa shouldDisplayNotesAsEvents
   Optional<bool> DisplayNotesAsEvents;
 
+  /// \sa shouldDisplayMacroExpansions
+  Optional<bool> DisplayMacroExpansions;
+
   /// \sa shouldAggressivelySimplifyBinaryOperation
   Optional<bool> AggressiveBinaryOperationSimplification;
 
   /// \sa shouldEagerlyAssume
   Optional<bool> EagerlyAssumeBinOpBifurcation;
 
   /// \sa getCTUDir
   Optional<StringRef> CTUDir;
public:
   /// Returns true if the bug reporter should transparently treat extra note
   /// diagnostic pieces as event diagnostic pieces. Useful when the diagnostic
   /// consumer doesn't support the extra note pieces.
   ///
   /// This is controlled by the 'extra-notes-as-events' option, which defaults
   /// to false when unset.
   bool shouldDisplayNotesAsEvents();
 
+  /// Returns true if macros related to the bugpath should be expanded and
+  /// included in the plist output.
+  ///
+  /// This is controlled by the 'expand-macros' option, which defaults to false
+  /// when unset.
+  bool shouldDisplayMacroExpansions();
+
   /// Returns true if SValBuilder should rearrange comparisons and additive
   /// operations of symbolic expressions which consist of a sum of a symbol and
   /// a concrete integer into the format where symbols are on the left-hand
   /// side and the integer is on the right. This is only done if both symbols
   /// and both concrete integers are signed, greater than or equal to the
   /// quarter of the minimum value of the type and less than or equal to the
   /// quarter of the maximum value of that type.
   ///

cfe/trunk/lib/StaticAnalyzer/Core/AnalyzerOptions.cpp

 
 bool AnalyzerOptions::shouldDisplayNotesAsEvents() {
   if (!DisplayNotesAsEvents.hasValue())
     DisplayNotesAsEvents =
         getBooleanOption("notes-as-events", /*Default=*/false);
   return DisplayNotesAsEvents.getValue();
 }
 
+bool AnalyzerOptions::shouldDisplayMacroExpansions() {
+  if (!DisplayMacroExpansions.hasValue())
+    DisplayMacroExpansions =
+        getBooleanOption("expand-macros", /*Default=*/false);
+  return DisplayMacroExpansions.getValue();
+}
+
 bool AnalyzerOptions::shouldAggressivelySimplifyBinaryOperation() {
   if (!AggressiveBinaryOperationSimplification.hasValue())
     AggressiveBinaryOperationSimplification =
       getBooleanOption("aggressive-binary-operation-simplification",
                        /*Default=*/false);
   return AggressiveBinaryOperationSimplification.getValue();
 }
 

cfe/trunk/lib/StaticAnalyzer/Core/BugReporter.cpp

if (ep->hasCallStackHint())
         // one. Since we traverse the path backwards, do not add the message
         // if one has been previously added.
         if  (!CP->hasCallStackMessage())
           CP->setCallStackMessage(stackMsg);
       }
   }
 }
 
-static void CompactPathDiagnostic(PathPieces &path, const SourceManager& SM);
+static void CompactMacroExpandedPieces(PathPieces &path,
+                                       const SourceManager& SM);
 
 
 std::shared_ptr<PathDiagnosticControlFlowPiece> generateDiagForSwitchOP(
   const ExplodedNode *N,
   const CFGBlock *Dst,
   const SourceManager &SM,
   const LocationContext *LC,
   PathDiagnosticBuilder &PDB,
if (AddPathEdges) {
     // Add an edge to the start of the function.
     // We'll prune it out later, but it helps make diagnostics more uniform.
     const StackFrameContext *CalleeLC = PDB.LC->getStackFrame();
     const Decl *D = CalleeLC->getDecl();
     addEdgeToPath(PD->getActivePath(), PrevLoc,
                   PathDiagnosticLocation::createBegin(D, SM));
   }
 
-  if (!AddPathEdges && GenerateDiagnostics)
-    CompactPathDiagnostic(PD->getMutablePieces(), SM);
 
   // Finally, prune the diagnostic path of uninteresting stuff.
   if (!PD->path.empty()) {
     if (R->shouldPrunePath() && Opts.shouldPrunePaths()) {
       bool stillHasNotes =
           removeUnneededCalls(PD->getMutablePieces(), R, LCM);
       assert(stillHasNotes);
       (void)stillHasNotes;
if (!PD->path.empty()) {
     }
 
     // Remove messages that are basically the same, and edges that may not
     // make sense.
     // We have to do this after edge optimization in the Extensive mode.
     removeRedundantMsgs(PD->getMutablePieces());
     removeEdgesToDefaultInitializers(PD->getMutablePieces());
   }
+
+  if (GenerateDiagnostics && Opts.shouldDisplayMacroExpansions())
+    CompactMacroExpandedPieces(PD->getMutablePieces(), SM);
+
   return PD;
 }
 
 
 //===----------------------------------------------------------------------===//
 // Methods for BugType and subclasses.
 //===----------------------------------------------------------------------===//
 
OrigN = *std::min_element(OrigN->pred_begin(), OrigN->pred_end(),
                           PriorityCompare<false>(PriorityMap));
   }
 
   GraphWrapper.Graph = std::move(GNew);
 
   return true;
 }
 
-/// CompactPathDiagnostic - This function postprocesses a PathDiagnostic object
-///  and collapses PathDiagosticPieces that are expanded by macros.
-static void CompactPathDiagnostic(PathPieces &path, const SourceManager& SM) {
+/// CompactMacroExpandedPieces - This function postprocesses a PathDiagnostic
+/// object and collapses PathDiagosticPieces that are expanded by macros.
+static void CompactMacroExpandedPieces(PathPieces &path,
+                                       const SourceManager& SM) {
   using MacroStackTy =
       std::vector<
           std::pair<std::shared_ptr<PathDiagnosticMacroPiece>, SourceLocation>>;
 
   using PiecesTy = std::vector<std::shared_ptr<PathDiagnosticPiece>>;
 
   MacroStackTy MacroStack;
   PiecesTy Pieces;
 
   for (PathPieces::const_iterator I = path.begin(), E = path.end();
        I != E; ++I) {
     const auto &piece = *I;
 
     // Recursively compact calls.
     if (auto *call = dyn_cast<PathDiagnosticCallPiece>(&*piece)) {
-      CompactPathDiagnostic(call->path, SM);
+      CompactMacroExpandedPieces(call->path, SM);
     }
 
     // Get the location of the PathDiagnosticPiece.
     const FullSourceLoc Loc = piece->getLocation().asLocation();
 
     // Determine the instantiation location, which is the location we group
     // related PathDiagnosticPieces.
     SourceLocation InstantiationLoc = Loc.isMacroID() ?

cfe/trunk/lib/StaticAnalyzer/Core/PlistDiagnostics.cpp

 
 namespace {
 
 /// A helper class for emitting a single report.
 class PlistPrinter {
   const FIDMap& FM;
   AnalyzerOptions &AnOpts;
   const Preprocessor &PP;
+  llvm::SmallVector<const PathDiagnosticMacroPiece *, 0> MacroPieces;
 
 public:
   PlistPrinter(const FIDMap& FM, AnalyzerOptions &AnOpts,
                const Preprocessor &PP)
     : FM(FM), AnOpts(AnOpts), PP(PP) {
   }
 
   void ReportDiag(raw_ostream &o, const PathDiagnosticPiece& P) {
     ReportPiece(o, P, /*indent*/ 4, /*depth*/ 0, /*includeControlFlow*/ true);
 
     // Don't emit a warning about an unused private field.
     (void)AnOpts;
   }
 
+  /// Print the expansions of the collected macro pieces.
+  ///
+  /// Each time ReportDiag is called on a PathDiagnosticMacroPiece (or, if one
+  /// is found through a call piece, etc), it's subpieces are reported, and the
+  /// piece itself is collected. Call this function after the entire bugpath
+  /// was reported.
+  void ReportMacroExpansions(raw_ostream &o, unsigned indent);
+
 private:
   void ReportPiece(raw_ostream &o, const PathDiagnosticPiece &P,
                    unsigned indent, unsigned depth, bool includeControlFlow,
                    bool isKeyEvent = false) {
     switch (P.getKind()) {
       case PathDiagnosticPiece::ControlFlow:
         if (includeControlFlow)
           ReportControlFlow(o, cast<PathDiagnosticControlFlowPiece>(P), indent);
         break;
       case PathDiagnosticPiece::Call:
         ReportCall(o, cast<PathDiagnosticCallPiece>(P), indent,
                    depth);
         break;
       case PathDiagnosticPiece::Event:
         ReportEvent(o, cast<PathDiagnosticEventPiece>(P), indent, depth,
                     isKeyEvent);
         break;
       case PathDiagnosticPiece::Macro:
-        ReportMacro(o, cast<PathDiagnosticMacroPiece>(P), indent, depth);
+        ReportMacroSubPieces(o, cast<PathDiagnosticMacroPiece>(P), indent,
+                             depth);
         break;
       case PathDiagnosticPiece::Note:
         ReportNote(o, cast<PathDiagnosticNotePiece>(P), indent);
         break;
     }
   }
 
   void EmitRanges(raw_ostream &o, const ArrayRef<SourceRange> Ranges,
                   unsigned indent);
   void EmitMessage(raw_ostream &o, StringRef Message, unsigned indent);
 
   void ReportControlFlow(raw_ostream &o,
                          const PathDiagnosticControlFlowPiece& P,
                          unsigned indent);
   void ReportEvent(raw_ostream &o, const PathDiagnosticEventPiece& P,
                    unsigned indent, unsigned depth, bool isKeyEvent = false);
   void ReportCall(raw_ostream &o, const PathDiagnosticCallPiece &P,
                   unsigned indent, unsigned depth);
-  void ReportMacro(raw_ostream &o, const PathDiagnosticMacroPiece& P,
+  void ReportMacroSubPieces(raw_ostream &o, const PathDiagnosticMacroPiece& P,
                             unsigned indent, unsigned depth);
   void ReportNote(raw_ostream &o, const PathDiagnosticNotePiece& P,
                   unsigned indent);
 };
 
 } // end of anonymous namespace
 
+namespace {
+
+struct ExpansionInfo {
+  std::string MacroName;
+  std::string Expansion;
+  ExpansionInfo(std::string N, std::string E)
+    : MacroName(std::move(N)), Expansion(std::move(E)) {}
+};
+
+} // end of anonymous namespace
+
 static void printBugPath(llvm::raw_ostream &o, const FIDMap& FM,
                          AnalyzerOptions &AnOpts,
                          const Preprocessor &PP,
                          const PathPieces &Path);
 
 /// Print coverage information to output stream {@code o}.
 /// May modify the used list of files {@code Fids} by inserting new ones.
 static void printCoverage(const PathDiagnostic *D,
                           unsigned InputIndentLevel,
                           SmallVectorImpl<FileID> &Fids,
                           FIDMap &FM,
                           llvm::raw_fd_ostream &o);
+
+static ExpansionInfo getExpandedMacro(SourceLocation MacroLoc,
+                                      const Preprocessor &PP);
+
 //===----------------------------------------------------------------------===//
 // Methods of PlistPrinter.
 //===----------------------------------------------------------------------===//
 
 void PlistPrinter::EmitRanges(raw_ostream &o,
                               const ArrayRef<SourceRange> Ranges,
                               unsigned indent) {
 
for (PathPieces::const_iterator I = P.path.begin(), E = P.path.end();I!=E;++I)
     ReportPiece(o, **I, indent, depth, /*includeControlFlow*/ true);
 
   --depth;
 
   if (auto callExit = P.getCallExitEvent())
     ReportPiece(o, *callExit, indent, depth, /*includeControlFlow*/ true);
 }
 
-void PlistPrinter::ReportMacro(raw_ostream &o,
+void PlistPrinter::ReportMacroSubPieces(raw_ostream &o,
                                         const PathDiagnosticMacroPiece& P,
                                         unsigned indent, unsigned depth) {
+  MacroPieces.push_back(&P);
 
-  for (PathPieces::const_iterator I = P.subPieces.begin(), E=P.subPieces.end();
-       I!=E; ++I) {
+  for (PathPieces::const_iterator I = P.subPieces.begin(),
+                                  E = P.subPieces.end();
+       I != E; ++I) {
     ReportPiece(o, **I, indent, depth, /*includeControlFlow*/ false);
   }
 }
 
+void PlistPrinter::ReportMacroExpansions(raw_ostream &o, unsigned indent) {
+
+  for (const PathDiagnosticMacroPiece *P : MacroPieces) {
+    const SourceManager &SM = PP.getSourceManager();
+    ExpansionInfo EI = getExpandedMacro(P->getLocation().asLocation(), PP);
+
+    Indent(o, indent) << "<dict>\n";
+    ++indent;
+
+    // Output the location.
+    FullSourceLoc L = P->getLocation().asLocation();
+
+    Indent(o, indent) << "<key>location</key>\n";
+    EmitLocation(o, SM, L, FM, indent);
+
+    // Output the ranges (if any).
+    ArrayRef<SourceRange> Ranges = P->getRanges();
+    EmitRanges(o, Ranges, indent);
+
+    // Output the macro name.
+    Indent(o, indent) << "<key>name</key>";
+    EmitString(o, EI.MacroName) << '\n';
+
+    // Output what it expands into.
+    Indent(o, indent) << "<key>expansion</key>";
+    EmitString(o, EI.Expansion) << '\n';
+
+    // Finish up.
+    --indent;
+    Indent(o, indent);
+    o << "</dict>\n";
+  }
+}
+
 void PlistPrinter::ReportNote(raw_ostream &o, const PathDiagnosticNotePiece& P,
                               unsigned indent) {
 
   const SourceManager &SM = PP.getSourceManager();
 
   Indent(o, indent) << "<dict>\n";
   ++indent;
 
void PlistPrinter::ReportNote(raw_ostream &o, const PathDiagnosticNotePiece& P,
   --indent;
   Indent(o, indent); o << "</dict>\n";
 }
 
 //===----------------------------------------------------------------------===//
 // Static function definitions.
 //===----------------------------------------------------------------------===//
 
+static ExpansionInfo getExpandedMacro(SourceLocation MacroLoc,
+                                      const Preprocessor &PP) {
+  // TODO: Implement macro expansion.
+  return { "", "" };
+}
+
 /// Print coverage information to output stream {@code o}.
 /// May modify the used list of files {@code Fids} by inserting new ones.
 static void printCoverage(const PathDiagnostic *D,
                           unsigned InputIndentLevel,
                           SmallVectorImpl<FileID> &Fids,
                           FIDMap &FM,
                           llvm::raw_fd_ostream &o) {
   unsigned IndentLevel = InputIndentLevel;
static void printBugPath(llvm::raw_ostream &o, const FIDMap& FM,
   o << "   <key>path</key>\n";
 
   o << "   <array>\n";
 
   for (PathPieces::const_iterator E = Path.end(); I != E; ++I)
     Printer.ReportDiag(o, **I);
 
   o << "   </array>\n";
+
+  if (!AnOpts.shouldDisplayMacroExpansions())
+    return;
+
+  o << "   <key>macro_expansions</key>\n"
+       "   <array>\n";
+  Printer.ReportMacroExpansions(o, /* indent */ 4);
+  o << "   </array>\n";
 }
 
 //===----------------------------------------------------------------------===//
 // Methods of PlistDiagnostics.
 //===----------------------------------------------------------------------===//
 
 PlistDiagnostics::PlistDiagnostics(AnalyzerOptions &AnalyzerOpts,
                                    const std::string& output,

cfe/trunk/test/Analysis/Inputs/expected-plists/plist-macros-with-expansion.cpp.plist

+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple Computer//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+ <key>diagnostics</key>
+ <array>
+  <dict>
+   <key>path</key>
+   <array>
+    <dict>
+     <key>kind</key><string>control</string>
+     <key>edges</key>
+      <array>
+       <dict>
+        <key>start</key>
+         <array>
+          <dict>
+           <key>line</key><integer>25</integer>
+           <key>col</key><integer>3</integer>
+           <key>file</key><integer>0</integer>
+          </dict>
+          <dict>
+           <key>line</key><integer>25</integer>
+           <key>col</key><integer>5</integer>
+           <key>file</key><integer>0</integer>
+          </dict>
+         </array>
+        <key>end</key>
+         <array>
+          <dict>
+           <key>line</key><integer>26</integer>
+           <key>col</key><integer>3</integer>
+           <key>file</key><integer>0</integer>
+          </dict>
+          <dict>
+           <key>line</key><integer>26</integer>
+           <key>col</key><integer>21</integer>
+           <key>file</key><integer>0</integer>
+          </dict>
+         </array>
+       </dict>
+      </array>
+    </dict>
+    <dict>
+     <key>kind</key><string>event</string>
+     <key>location</key>
+     <dict>
+      <key>line</key><integer>26</integer>
+      <key>col</key><integer>3</integer>
+      <key>file</key><integer>0</integer>
+     </dict>
+     <key>ranges</key>
+     <array>
+       <array>
+        <dict>
+         <key>line</key><integer>26</integer>
+         <key>col</key><integer>3</integer>
+         <key>file</key><integer>0</integer>
+        </dict>
+        <dict>
+         <key>line</key><integer>26</integer>
+         <key>col</key><integer>21</integer>
+         <key>file</key><integer>0</integer>
+        </dict>
+       </array>
+     </array>
+     <key>depth</key><integer>0</integer>
+     <key>extended_message</key>
+     <string>Null pointer value stored to &apos;ptr&apos;</string>
+     <key>message</key>
+     <string>Null pointer value stored to &apos;ptr&apos;</string>
+    </dict>
+    <dict>
+     <key>kind</key><string>control</string>
+     <key>edges</key>
+      <array>
+       <dict>
+        <key>start</key>
+         <array>
+          <dict>
+           <key>line</key><integer>27</integer>
+           <key>col</key><integer>3</integer>
+           <key>file</key><integer>0</integer>
+          </dict>
+          <dict>
+           <key>line</key><integer>27</integer>
+           <key>col</key><integer>3</integer>
+           <key>file</key><integer>0</integer>
+          </dict>
+         </array>
+        <key>end</key>
+         <array>
+          <dict>
+           <key>line</key><integer>27</integer>
+           <key>col</key><integer>8</integer>
+           <key>file</key><integer>0</integer>
+          </dict>
+          <dict>
+           <key>line</key><integer>27</integer>
+           <key>col</key><integer>8</integer>
+           <key>file</key><integer>0</integer>
+          </dict>
+         </array>
+       </dict>
+      </array>
+    </dict>
+    <dict>
+     <key>kind</key><string>event</string>
+     <key>location</key>
+     <dict>
+      <key>line</key><integer>27</integer>
+      <key>col</key><integer>8</integer>
+      <key>file</key><integer>0</integer>
+     </dict>
+     <key>ranges</key>
+     <array>
+       <array>
+        <dict>
+         <key>line</key><integer>27</integer>
+         <key>col</key><integer>4</integer>
+         <key>file</key><integer>0</integer>
+        </dict>
+        <dict>
+         <key>line</key><integer>27</integer>
+         <key>col</key><integer>6</integer>
+         <key>file</key><integer>0</integer>
+        </dict>
+       </array>
+     </array>
+     <key>depth</key><integer>0</integer>
+     <key>extended_message</key>
+     <string>Dereference of null pointer (loaded from variable &apos;ptr&apos;)</string>
+     <key>message</key>
+     <string>Dereference of null pointer (loaded from variable &apos;ptr&apos;)</string>
+    </dict>
+   </array>
+   <key>macro_expansions</key>
+   <array>
+    <dict>
+     <key>location</key>
+     <dict>
+      <key>line</key><integer>26</integer>
+      <key>col</key><integer>3</integer>
+      <key>file</key><integer>0</integer>
+     </dict>
+     <key>name</key><string></string>
+     <key>expansion</key><string></string>
+    </dict>
+   </array>
+   <key>description</key><string>Dereference of null pointer (loaded from variable &apos;ptr&apos;)</string>
+   <key>category</key><string>Logic error</string>
+   <key>type</key><string>Dereference of null pointer</string>
+   <key>check_name</key><string>core.NullDereference</string>
+   <!-- This hash is experimental and going to change! -->
+   <key>issue_hash_content_of_line_in_context</key><string>f8fbc46cc5afbb056d92bd3d3d702781</string>
+  <key>issue_context_kind</key><string>function</string>
+  <key>issue_context</key><string>nonFunctionLikeMacroTest</string>
+  <key>issue_hash_function_offset</key><string>3</string>
+  <key>location</key>
+  <dict>
+   <key>line</key><integer>27</integer>
+   <key>col</key><integer>8</integer>
+   <key>file</key><integer>0</integer>
+  </dict>
+  <key>ExecutedLines</key>
+  <dict>
+   <key>0</key>
+   <array>
+    <integer>24</integer>
+    <integer>25</integer>
+    <integer>26</integer>
+    <integer>27</integer>
+   </array>
+  </dict>
+  </dict>
+  <dict>
+   <key>path</key>
+   <array>
+    <dict>
+     <key>kind</key><string>control</string>
+     <key>edges</key>
+      <array>
+       <dict>
+        <key>start</key>
+         <array>
+          <dict>
+           <key>line</key><integer>38</integer>
+           <key>col</key><integer>3</integer>
+           <key>file</key><integer>0</integer>
+          </dict>
+          <dict>
+           <key>line</key><integer>38</integer>
+           <key>col</key><integer>5</integer>
+           <key>file</key><integer>0</integer>
+          </dict>
+         </array>
+        <key>end</key>
+         <array>
+          <dict>
+           <key>line</key><integer>39</integer>
+           <key>col</key><integer>3</integer>
+           <key>file</key><integer>0</integer>
+          </dict>
+          <dict>
+           <key>line</key><integer>39</integer>
+           <key>col</key><integer>39</integer>
+           <key>file</key><integer>0</integer>
+          </dict>
+         </array>
+       </dict>
+      </array>
+    </dict>
+    <dict>
+     <key>kind</key><string>event</string>
+     <key>location</key>
+     <dict>
+      <key>line</key><integer>39</integer>
+      <key>col</key><integer>3</integer>
+      <key>file</key><integer>0</integer>
+     </dict>
+     <key>ranges</key>
+     <array>
+       <array>
+        <dict>
+         <key>line</key><integer>39</integer>
+         <key>col</key><integer>3</integer>
+         <key>file</key><integer>0</integer>
+        </dict>
+        <dict>
+         <key>line</key><integer>39</integer>
+         <key>col</key><integer>39</integer>
+         <key>file</key><integer>0</integer>
+        </dict>
+       </array>
+     </array>
+     <key>depth</key><integer>0</integer>
+     <key>extended_message</key>
+     <string>Null pointer value stored to &apos;ptr&apos;</string>
+     <key>message</key>
+     <string>Null pointer value stored to &apos;ptr&apos;</string>
+    </dict>
+    <dict>
+     <key>kind</key><string>control</string>
+     <key>edges</key>
+      <array>
+       <dict>
+        <key>start</key>
+         <array>
+          <dict>
+           <key>line</key><integer>40</integer>
+           <key>col</key><integer>3</integer>
+           <key>file</key><integer>0</integer>
+          </dict>
+          <dict>
+           <key>line</key><integer>40</integer>
+           <key>col</key><integer>3</integer>
+           <key>file</key><integer>0</integer>
+          </dict>
+         </array>
+        <key>end</key>
+         <array>
+          <dict>
+           <key>line</key><integer>40</integer>
+           <key>col</key><integer>8</integer>
+           <key>file</key><integer>0</integer>
+          </dict>
+          <dict>
+           <key>line</key><integer>40</integer>
+           <key>col</key><integer>8</integer>
+           <key>file</key><integer>0</integer>
+          </dict>
+         </array>
+       </dict>
+      </array>
+    </dict>
+    <dict>
+     <key>kind</key><string>event</string>
+     <key>location</key>
+     <dict>
+      <key>line</key><integer>40</integer>
+      <key>col</key><integer>8</integer>
+      <key>file</key><integer>0</integer>
+     </dict>
+     <key>ranges</key>
+     <array>
+       <array>
+        <dict>
+         <key>line</key><integer>40</integer>
+         <key>col</key><integer>4</integer>
+         <key>file</key><integer>0</integer>
+        </dict>
+        <dict>
+         <key>line</key><integer>40</integer>
+         <key>col</key><integer>6</integer>
+         <key>file</key><integer>0</integer>
+        </dict>
+       </array>
+     </array>
+     <key>depth</key><integer>0</integer>
+     <key>extended_message</key>
+     <string>Dereference of null pointer (loaded from variable &apos;ptr&apos;)</string>
+     <key>message</key>
+     <string>Dereference of null pointer (loaded from variable &apos;ptr&apos;)</string>
+    </dict>
+   </array>
+   <key>macro_expansions</key>
+   <array>
+    <dict>
+     <key>location</key>
+     <dict>
+      <key>line</key><integer>39</integer>
+      <key>col</key><integer>3</integer>
+      <key>file</key><integer>0</integer>
+     </dict>
+     <key>name</key><string></string>
+     <key>expansion</key><string></string>
+    </dict>
+   </array>
+   <key>description</key><string>Dereference of null pointer (loaded from variable &apos;ptr&apos;)</string>
+   <key>category</key><string>Logic error</string>
+   <key>type</key><string>Dereference of null pointer</string>
+   <key>check_name</key><string>core.NullDereference</string>
+   <!-- This hash is experimental and going to change! -->
+   <key>issue_hash_content_of_line_in_context</key><string>d5eba61193b41c27fc7b2705cbd607ba</string>
+  <key>issue_context_kind</key><string>function</string>
+  <key>issue_context</key><string>nonFunctionLikeNestedMacroTest</string>
+  <key>issue_hash_function_offset</key><string>3</string>
+  <key>location</key>
+  <dict>
+   <key>line</key><integer>40</integer>
+   <key>col</key><integer>8</integer>
+   <key>file</key><integer>0</integer>
+  </dict>
+  <key>ExecutedLines</key>
+  <dict>
+   <key>0</key>
+   <array>
+    <integer>37</integer>
+    <integer>38</integer>
+    <integer>39</integer>
+    <integer>40</integer>
+   </array>
+  </dict>
+  </dict>
+ </array>
+ <key>files</key>
+ <array>
+  <string>/home/eumakri/Documents/2codechecker_dev_env/llvm/tools/clang/test/Analysis/plist-macros-with-expansion.cpp</string>
+ </array>
+</dict>
+</plist>

cfe/trunk/test/Analysis/plist-macros-with-expansion.cpp

+// RUN: %clang_analyze_cc1 -analyzer-checker=core -verify %s
+//
+// RUN: %clang_analyze_cc1 -analyzer-checker=core %s  \
+// RUN:   -analyzer-output=plist -o %t.plist \
+// RUN:   -analyzer-config expand-macros=true
+//
+// Check the actual plist output.
+//   RUN: cat %t.plist | %diff_plist \
+//   RUN:   %S/Inputs/expected-plists/plist-macros-with-expansion.cpp.plist
+//
+// Check the macro expansions from the plist output here, to make the test more
+// understandable.
+//   RUN: FileCheck --input-file=%t.plist %s
+
+void print(const void*);
+
+//===----------------------------------------------------------------------===//
+// Tests for non-function-like macro expansions.
+//===----------------------------------------------------------------------===//
+
+#define SET_PTR_VAR_TO_NULL \
+  ptr = 0
+
+void nonFunctionLikeMacroTest() {
+  int *ptr;
+  SET_PTR_VAR_TO_NULL;
+  *ptr = 5; // expected-warning{{Dereference of null pointer}}
+}
+
+// CHECK: <key>name</key><string></string>
+// CHECK-NEXT: <key>expansion</key><string></string>
+
+#define NULL 0
+#define SET_PTR_VAR_TO_NULL_WITH_NESTED_MACRO \
+  ptr = NULL
+
+void nonFunctionLikeNestedMacroTest() {
+  int *ptr;
+  SET_PTR_VAR_TO_NULL_WITH_NESTED_MACRO;
+  *ptr = 5; // expected-warning{{Dereference of null pointer}}
+}
+
+// CHECK: <key>name</key><string></string>
+// CHECK-NEXT: <key>expansion</key><string></string>