Home | History | Annotate | Download | only in BugReporter
      1 //===--- PathDiagnostic.h - Path-Specific Diagnostic Handling ---*- C++ -*-===//
      2 //
      3 //                     The LLVM Compiler Infrastructure
      4 //
      5 // This file is distributed under the University of Illinois Open Source
      6 // License. See LICENSE.TXT for details.
      7 //
      8 //===----------------------------------------------------------------------===//
      9 //
     10 //  This file defines the PathDiagnostic-related interfaces.
     11 //
     12 //===----------------------------------------------------------------------===//
     13 
     14 #ifndef LLVM_CLANG_PATH_DIAGNOSTIC_H
     15 #define LLVM_CLANG_PATH_DIAGNOSTIC_H
     16 
     17 #include "clang/Basic/SourceLocation.h"
     18 #include "clang/Analysis/ProgramPoint.h"
     19 #include "llvm/ADT/FoldingSet.h"
     20 #include "llvm/ADT/IntrusiveRefCntPtr.h"
     21 #include "llvm/ADT/PointerUnion.h"
     22 #include "llvm/ADT/Optional.h"
     23 #include <deque>
     24 #include <iterator>
     25 #include <string>
     26 #include <vector>
     27 
     28 namespace clang {
     29 
     30 class AnalysisDeclContext;
     31 class BinaryOperator;
     32 class CompoundStmt;
     33 class Decl;
     34 class LocationContext;
     35 class MemberExpr;
     36 class ParentMap;
     37 class ProgramPoint;
     38 class SourceManager;
     39 class Stmt;
     40 
     41 namespace ento {
     42 
     43 class ExplodedNode;
     44 class SymExpr;
     45 typedef const SymExpr* SymbolRef;
     46 
     47 //===----------------------------------------------------------------------===//
     48 // High-level interface for handlers of path-sensitive diagnostics.
     49 //===----------------------------------------------------------------------===//
     50 
     51 class PathDiagnostic;
     52 
     53 class PathDiagnosticConsumer {
     54 public:
     55   class PDFileEntry : public llvm::FoldingSetNode {
     56   public:
     57     PDFileEntry(llvm::FoldingSetNodeID &NodeID) : NodeID(NodeID) {}
     58 
     59     typedef std::vector<std::pair<StringRef, StringRef> > ConsumerFiles;
     60 
     61     /// \brief A vector of <consumer,file> pairs.
     62     ConsumerFiles files;
     63 
     64     /// \brief A precomputed hash tag used for uniquing PDFileEntry objects.
     65     const llvm::FoldingSetNodeID NodeID;
     66 
     67     /// \brief Used for profiling in the FoldingSet.
     68     void Profile(llvm::FoldingSetNodeID &ID) { ID = NodeID; }
     69   };
     70 
     71   struct FilesMade : public llvm::FoldingSet<PDFileEntry> {
     72     llvm::BumpPtrAllocator Alloc;
     73 
     74     void addDiagnostic(const PathDiagnostic &PD,
     75                        StringRef ConsumerName,
     76                        StringRef fileName);
     77 
     78     PDFileEntry::ConsumerFiles *getFiles(const PathDiagnostic &PD);
     79   };
     80 
     81 private:
     82   virtual void anchor();
     83 public:
     84   PathDiagnosticConsumer() : flushed(false) {}
     85   virtual ~PathDiagnosticConsumer();
     86 
     87   void FlushDiagnostics(FilesMade *FilesMade);
     88 
     89   virtual void FlushDiagnosticsImpl(std::vector<const PathDiagnostic *> &Diags,
     90                                     FilesMade *filesMade) = 0;
     91 
     92   virtual StringRef getName() const = 0;
     93 
     94   void HandlePathDiagnostic(PathDiagnostic *D);
     95 
     96   enum PathGenerationScheme { None, Minimal, Extensive };
     97   virtual PathGenerationScheme getGenerationScheme() const { return Minimal; }
     98   virtual bool supportsLogicalOpControlFlow() const { return false; }
     99   virtual bool supportsAllBlockEdges() const { return false; }
    100 
    101   /// Return true if the PathDiagnosticConsumer supports individual
    102   /// PathDiagnostics that span multiple files.
    103   virtual bool supportsCrossFileDiagnostics() const { return false; }
    104 
    105 protected:
    106   bool flushed;
    107   llvm::FoldingSet<PathDiagnostic> Diags;
    108 };
    109 
    110 //===----------------------------------------------------------------------===//
    111 // Path-sensitive diagnostics.
    112 //===----------------------------------------------------------------------===//
    113 
    114 class PathDiagnosticRange : public SourceRange {
    115 public:
    116   bool isPoint;
    117 
    118   PathDiagnosticRange(const SourceRange &R, bool isP = false)
    119     : SourceRange(R), isPoint(isP) {}
    120 
    121   PathDiagnosticRange() : isPoint(false) {}
    122 };
    123 
    124 typedef llvm::PointerUnion<const LocationContext*, AnalysisDeclContext*>
    125                                                    LocationOrAnalysisDeclContext;
    126 
    127 class PathDiagnosticLocation {
    128 private:
    129   enum Kind { RangeK, SingleLocK, StmtK, DeclK } K;
    130   const Stmt *S;
    131   const Decl *D;
    132   const SourceManager *SM;
    133   FullSourceLoc Loc;
    134   PathDiagnosticRange Range;
    135 
    136   PathDiagnosticLocation(SourceLocation L, const SourceManager &sm,
    137                          Kind kind)
    138     : K(kind), S(0), D(0), SM(&sm),
    139       Loc(genLocation(L)), Range(genRange()) {
    140     assert(Loc.isValid());
    141     assert(Range.isValid());
    142   }
    143 
    144   FullSourceLoc
    145     genLocation(SourceLocation L = SourceLocation(),
    146                 LocationOrAnalysisDeclContext LAC = (AnalysisDeclContext*)0) const;
    147 
    148   PathDiagnosticRange
    149     genRange(LocationOrAnalysisDeclContext LAC = (AnalysisDeclContext*)0) const;
    150 
    151 public:
    152   /// Create an invalid location.
    153   PathDiagnosticLocation()
    154     : K(SingleLocK), S(0), D(0), SM(0) {}
    155 
    156   /// Create a location corresponding to the given statement.
    157   PathDiagnosticLocation(const Stmt *s,
    158                          const SourceManager &sm,
    159                          LocationOrAnalysisDeclContext lac)
    160     : K(StmtK), S(s), D(0), SM(&sm),
    161       Loc(genLocation(SourceLocation(), lac)),
    162       Range(genRange(lac)) {
    163     assert(S);
    164     assert(Loc.isValid());
    165     assert(Range.isValid());
    166   }
    167 
    168   /// Create a location corresponding to the given declaration.
    169   PathDiagnosticLocation(const Decl *d, const SourceManager &sm)
    170     : K(DeclK), S(0), D(d), SM(&sm),
    171       Loc(genLocation()), Range(genRange()) {
    172     assert(D);
    173     assert(Loc.isValid());
    174     assert(Range.isValid());
    175   }
    176 
    177   /// Create a location at an explicit offset in the source.
    178   ///
    179   /// This should only be used if there are no more appropriate constructors.
    180   PathDiagnosticLocation(SourceLocation loc, const SourceManager &sm)
    181     : K(SingleLocK), S(0), D(0), SM(&sm), Loc(loc, sm), Range(genRange()) {
    182     assert(Loc.isValid());
    183     assert(Range.isValid());
    184   }
    185 
    186   /// Create a location corresponding to the given declaration.
    187   static PathDiagnosticLocation create(const Decl *D,
    188                                        const SourceManager &SM) {
    189     return PathDiagnosticLocation(D, SM);
    190   }
    191 
    192   /// Create a location for the beginning of the declaration.
    193   static PathDiagnosticLocation createBegin(const Decl *D,
    194                                             const SourceManager &SM);
    195 
    196   /// Create a location for the beginning of the statement.
    197   static PathDiagnosticLocation createBegin(const Stmt *S,
    198                                             const SourceManager &SM,
    199                                             const LocationOrAnalysisDeclContext LAC);
    200 
    201   /// Create a location for the end of the statement.
    202   ///
    203   /// If the statement is a CompoundStatement, the location will point to the
    204   /// closing brace instead of following it.
    205   static PathDiagnosticLocation createEnd(const Stmt *S,
    206                                           const SourceManager &SM,
    207                                        const LocationOrAnalysisDeclContext LAC);
    208 
    209   /// Create the location for the operator of the binary expression.
    210   /// Assumes the statement has a valid location.
    211   static PathDiagnosticLocation createOperatorLoc(const BinaryOperator *BO,
    212                                                   const SourceManager &SM);
    213 
    214   /// For member expressions, return the location of the '.' or '->'.
    215   /// Assumes the statement has a valid location.
    216   static PathDiagnosticLocation createMemberLoc(const MemberExpr *ME,
    217                                                 const SourceManager &SM);
    218 
    219   /// Create a location for the beginning of the compound statement.
    220   /// Assumes the statement has a valid location.
    221   static PathDiagnosticLocation createBeginBrace(const CompoundStmt *CS,
    222                                                  const SourceManager &SM);
    223 
    224   /// Create a location for the end of the compound statement.
    225   /// Assumes the statement has a valid location.
    226   static PathDiagnosticLocation createEndBrace(const CompoundStmt *CS,
    227                                                const SourceManager &SM);
    228 
    229   /// Create a location for the beginning of the enclosing declaration body.
    230   /// Defaults to the beginning of the first statement in the declaration body.
    231   static PathDiagnosticLocation createDeclBegin(const LocationContext *LC,
    232                                                 const SourceManager &SM);
    233 
    234   /// Constructs a location for the end of the enclosing declaration body.
    235   /// Defaults to the end of brace.
    236   static PathDiagnosticLocation createDeclEnd(const LocationContext *LC,
    237                                                    const SourceManager &SM);
    238 
    239   /// Create a location corresponding to the given valid ExplodedNode.
    240   static PathDiagnosticLocation create(const ProgramPoint& P,
    241                                        const SourceManager &SMng);
    242 
    243   /// Create a location corresponding to the next valid ExplodedNode as end
    244   /// of path location.
    245   static PathDiagnosticLocation createEndOfPath(const ExplodedNode* N,
    246                                                 const SourceManager &SM);
    247 
    248   /// Convert the given location into a single kind location.
    249   static PathDiagnosticLocation createSingleLocation(
    250                                              const PathDiagnosticLocation &PDL);
    251 
    252   bool operator==(const PathDiagnosticLocation &X) const {
    253     return K == X.K && Loc == X.Loc && Range == X.Range;
    254   }
    255 
    256   bool operator!=(const PathDiagnosticLocation &X) const {
    257     return !(*this == X);
    258   }
    259 
    260   bool isValid() const {
    261     return SM != 0;
    262   }
    263 
    264   FullSourceLoc asLocation() const {
    265     return Loc;
    266   }
    267 
    268   PathDiagnosticRange asRange() const {
    269     return Range;
    270   }
    271 
    272   const Stmt *asStmt() const { assert(isValid()); return S; }
    273   const Decl *asDecl() const { assert(isValid()); return D; }
    274 
    275   bool hasRange() const { return K == StmtK || K == RangeK || K == DeclK; }
    276 
    277   void invalidate() {
    278     *this = PathDiagnosticLocation();
    279   }
    280 
    281   void flatten();
    282 
    283   const SourceManager& getManager() const { assert(isValid()); return *SM; }
    284 
    285   void Profile(llvm::FoldingSetNodeID &ID) const;
    286 };
    287 
    288 class PathDiagnosticLocationPair {
    289 private:
    290   PathDiagnosticLocation Start, End;
    291 public:
    292   PathDiagnosticLocationPair(const PathDiagnosticLocation &start,
    293                              const PathDiagnosticLocation &end)
    294     : Start(start), End(end) {}
    295 
    296   const PathDiagnosticLocation &getStart() const { return Start; }
    297   const PathDiagnosticLocation &getEnd() const { return End; }
    298 
    299   void flatten() {
    300     Start.flatten();
    301     End.flatten();
    302   }
    303 
    304   void Profile(llvm::FoldingSetNodeID &ID) const {
    305     Start.Profile(ID);
    306     End.Profile(ID);
    307   }
    308 };
    309 
    310 //===----------------------------------------------------------------------===//
    311 // Path "pieces" for path-sensitive diagnostics.
    312 //===----------------------------------------------------------------------===//
    313 
    314 class PathDiagnosticPiece : public RefCountedBaseVPTR {
    315 public:
    316   enum Kind { ControlFlow, Event, Macro, Call };
    317   enum DisplayHint { Above, Below };
    318 
    319 private:
    320   const std::string str;
    321   const Kind kind;
    322   const DisplayHint Hint;
    323   std::vector<SourceRange> ranges;
    324 
    325   // Do not implement:
    326   PathDiagnosticPiece();
    327   PathDiagnosticPiece(const PathDiagnosticPiece &P);
    328   PathDiagnosticPiece& operator=(const PathDiagnosticPiece &P);
    329 
    330 protected:
    331   PathDiagnosticPiece(StringRef s, Kind k, DisplayHint hint = Below);
    332 
    333   PathDiagnosticPiece(Kind k, DisplayHint hint = Below);
    334 
    335 public:
    336   virtual ~PathDiagnosticPiece();
    337 
    338   llvm::StringRef getString() const { return str; }
    339 
    340   /// getDisplayHint - Return a hint indicating where the diagnostic should
    341   ///  be displayed by the PathDiagnosticConsumer.
    342   DisplayHint getDisplayHint() const { return Hint; }
    343 
    344   virtual PathDiagnosticLocation getLocation() const = 0;
    345   virtual void flattenLocations() = 0;
    346 
    347   Kind getKind() const { return kind; }
    348 
    349   void addRange(SourceRange R) {
    350     if (!R.isValid())
    351       return;
    352     ranges.push_back(R);
    353   }
    354 
    355   void addRange(SourceLocation B, SourceLocation E) {
    356     if (!B.isValid() || !E.isValid())
    357       return;
    358     ranges.push_back(SourceRange(B,E));
    359   }
    360 
    361   /// Return the SourceRanges associated with this PathDiagnosticPiece.
    362   ArrayRef<SourceRange> getRanges() const { return ranges; }
    363 
    364   static inline bool classof(const PathDiagnosticPiece *P) {
    365     return true;
    366   }
    367 
    368   virtual void Profile(llvm::FoldingSetNodeID &ID) const;
    369 };
    370 
    371 
    372 class PathPieces : public std::deque<IntrusiveRefCntPtr<PathDiagnosticPiece> > {
    373   void flattenTo(PathPieces &Primary, PathPieces &Current,
    374                  bool ShouldFlattenMacros) const;
    375 public:
    376   ~PathPieces();
    377 
    378   PathPieces flatten(bool ShouldFlattenMacros) const {
    379     PathPieces Result;
    380     flattenTo(Result, Result, ShouldFlattenMacros);
    381     return Result;
    382   }
    383 };
    384 
    385 class PathDiagnosticSpotPiece : public PathDiagnosticPiece {
    386 private:
    387   PathDiagnosticLocation Pos;
    388 public:
    389   PathDiagnosticSpotPiece(const PathDiagnosticLocation &pos,
    390                           StringRef s,
    391                           PathDiagnosticPiece::Kind k,
    392                           bool addPosRange = true)
    393   : PathDiagnosticPiece(s, k), Pos(pos) {
    394     assert(Pos.isValid() && Pos.asLocation().isValid() &&
    395            "PathDiagnosticSpotPiece's must have a valid location.");
    396     if (addPosRange && Pos.hasRange()) addRange(Pos.asRange());
    397   }
    398 
    399   PathDiagnosticLocation getLocation() const { return Pos; }
    400   virtual void flattenLocations() { Pos.flatten(); }
    401 
    402   virtual void Profile(llvm::FoldingSetNodeID &ID) const;
    403 };
    404 
    405 /// \brief Interface for classes constructing Stack hints.
    406 ///
    407 /// If a PathDiagnosticEvent occurs in a different frame than the final
    408 /// diagnostic the hints can be used to summarize the effect of the call.
    409 class StackHintGenerator {
    410 public:
    411   virtual ~StackHintGenerator() = 0;
    412 
    413   /// \brief Construct the Diagnostic message for the given ExplodedNode.
    414   virtual std::string getMessage(const ExplodedNode *N) = 0;
    415 };
    416 
    417 /// \brief Constructs a Stack hint for the given symbol.
    418 ///
    419 /// The class knows how to construct the stack hint message based on
    420 /// traversing the CallExpr associated with the call and checking if the given
    421 /// symbol is returned or is one of the arguments.
    422 /// The hint can be customized by redefining 'getMessageForX()' methods.
    423 class StackHintGeneratorForSymbol : public StackHintGenerator {
    424 private:
    425   SymbolRef Sym;
    426   std::string Msg;
    427 
    428 public:
    429   StackHintGeneratorForSymbol(SymbolRef S, StringRef M) : Sym(S), Msg(M) {}
    430   virtual ~StackHintGeneratorForSymbol() {}
    431 
    432   /// \brief Search the call expression for the symbol Sym and dispatch the
    433   /// 'getMessageForX()' methods to construct a specific message.
    434   virtual std::string getMessage(const ExplodedNode *N);
    435 
    436   /// Prints the ordinal form of the given integer,
    437   /// only valid for ValNo : ValNo > 0.
    438   void printOrdinal(unsigned ValNo, llvm::raw_svector_ostream &Out);
    439 
    440   /// Produces the message of the following form:
    441   ///   'Msg via Nth parameter'
    442   virtual std::string getMessageForArg(const Expr *ArgE, unsigned ArgIndex);
    443   virtual std::string getMessageForReturn(const CallExpr *CallExpr) {
    444     return Msg;
    445   }
    446   virtual std::string getMessageForSymbolNotFound() {
    447     return Msg;
    448   }
    449 };
    450 
    451 class PathDiagnosticEventPiece : public PathDiagnosticSpotPiece {
    452   llvm::Optional<bool> IsPrunable;
    453 
    454   /// If the event occurs in a different frame than the final diagnostic,
    455   /// supply a message that will be used to construct an extra hint on the
    456   /// returns from all the calls on the stack from this event to the final
    457   /// diagnostic.
    458   llvm::OwningPtr<StackHintGenerator> CallStackHint;
    459 
    460 public:
    461   PathDiagnosticEventPiece(const PathDiagnosticLocation &pos,
    462                            StringRef s, bool addPosRange = true,
    463                            StackHintGenerator *stackHint = 0)
    464     : PathDiagnosticSpotPiece(pos, s, Event, addPosRange),
    465       CallStackHint(stackHint) {}
    466 
    467   ~PathDiagnosticEventPiece();
    468 
    469   /// Mark the diagnostic piece as being potentially prunable.  This
    470   /// flag may have been previously set, at which point it will not
    471   /// be reset unless one specifies to do so.
    472   void setPrunable(bool isPrunable, bool override = false) {
    473     if (IsPrunable.hasValue() && !override)
    474      return;
    475     IsPrunable = isPrunable;
    476   }
    477 
    478   /// Return true if the diagnostic piece is prunable.
    479   bool isPrunable() const {
    480     return IsPrunable.hasValue() ? IsPrunable.getValue() : false;
    481   }
    482 
    483   bool hasCallStackHint() {
    484     return (CallStackHint != 0);
    485   }
    486 
    487   /// Produce the hint for the given node. The node contains
    488   /// information about the call for which the diagnostic can be generated.
    489   std::string getCallStackMessage(const ExplodedNode *N) {
    490     if (CallStackHint)
    491       return CallStackHint->getMessage(N);
    492     return "";
    493   }
    494 
    495   static inline bool classof(const PathDiagnosticPiece *P) {
    496     return P->getKind() == Event;
    497   }
    498 };
    499 
    500 class PathDiagnosticCallPiece : public PathDiagnosticPiece {
    501   PathDiagnosticCallPiece(const Decl *callerD,
    502                           const PathDiagnosticLocation &callReturnPos)
    503     : PathDiagnosticPiece(Call), Caller(callerD), Callee(0),
    504       NoExit(false), callReturn(callReturnPos) {}
    505 
    506   PathDiagnosticCallPiece(PathPieces &oldPath, const Decl *caller)
    507     : PathDiagnosticPiece(Call), Caller(caller), Callee(0),
    508       NoExit(true), path(oldPath) {}
    509 
    510   const Decl *Caller;
    511   const Decl *Callee;
    512 
    513   // Flag signifying that this diagnostic has only call enter and no matching
    514   // call exit.
    515   bool NoExit;
    516 
    517   // The custom string, which should appear after the call Return Diagnostic.
    518   // TODO: Should we allow multiple diagnostics?
    519   std::string CallStackMessage;
    520 
    521 public:
    522   PathDiagnosticLocation callEnter;
    523   PathDiagnosticLocation callEnterWithin;
    524   PathDiagnosticLocation callReturn;
    525   PathPieces path;
    526 
    527   virtual ~PathDiagnosticCallPiece();
    528 
    529   const Decl *getCaller() const { return Caller; }
    530 
    531   const Decl *getCallee() const { return Callee; }
    532   void setCallee(const CallEnter &CE, const SourceManager &SM);
    533 
    534   bool hasCallStackMessage() { return !CallStackMessage.empty(); }
    535   void setCallStackMessage(StringRef st) {
    536     CallStackMessage = st;
    537   }
    538 
    539   virtual PathDiagnosticLocation getLocation() const {
    540     return callEnter;
    541   }
    542 
    543   IntrusiveRefCntPtr<PathDiagnosticEventPiece> getCallEnterEvent() const;
    544   IntrusiveRefCntPtr<PathDiagnosticEventPiece>
    545     getCallEnterWithinCallerEvent() const;
    546   IntrusiveRefCntPtr<PathDiagnosticEventPiece> getCallExitEvent() const;
    547 
    548   virtual void flattenLocations() {
    549     callEnter.flatten();
    550     callReturn.flatten();
    551     for (PathPieces::iterator I = path.begin(),
    552          E = path.end(); I != E; ++I) (*I)->flattenLocations();
    553   }
    554 
    555   static PathDiagnosticCallPiece *construct(const ExplodedNode *N,
    556                                             const CallExitEnd &CE,
    557                                             const SourceManager &SM);
    558 
    559   static PathDiagnosticCallPiece *construct(PathPieces &pieces,
    560                                             const Decl *caller);
    561 
    562   virtual void Profile(llvm::FoldingSetNodeID &ID) const;
    563 
    564   static inline bool classof(const PathDiagnosticPiece *P) {
    565     return P->getKind() == Call;
    566   }
    567 };
    568 
    569 class PathDiagnosticControlFlowPiece : public PathDiagnosticPiece {
    570   std::vector<PathDiagnosticLocationPair> LPairs;
    571 public:
    572   PathDiagnosticControlFlowPiece(const PathDiagnosticLocation &startPos,
    573                                  const PathDiagnosticLocation &endPos,
    574                                  StringRef s)
    575     : PathDiagnosticPiece(s, ControlFlow) {
    576       LPairs.push_back(PathDiagnosticLocationPair(startPos, endPos));
    577     }
    578 
    579   PathDiagnosticControlFlowPiece(const PathDiagnosticLocation &startPos,
    580                                  const PathDiagnosticLocation &endPos)
    581     : PathDiagnosticPiece(ControlFlow) {
    582       LPairs.push_back(PathDiagnosticLocationPair(startPos, endPos));
    583     }
    584 
    585   ~PathDiagnosticControlFlowPiece();
    586 
    587   PathDiagnosticLocation getStartLocation() const {
    588     assert(!LPairs.empty() &&
    589            "PathDiagnosticControlFlowPiece needs at least one location.");
    590     return LPairs[0].getStart();
    591   }
    592 
    593   PathDiagnosticLocation getEndLocation() const {
    594     assert(!LPairs.empty() &&
    595            "PathDiagnosticControlFlowPiece needs at least one location.");
    596     return LPairs[0].getEnd();
    597   }
    598 
    599   void push_back(const PathDiagnosticLocationPair &X) { LPairs.push_back(X); }
    600 
    601   virtual PathDiagnosticLocation getLocation() const {
    602     return getStartLocation();
    603   }
    604 
    605   typedef std::vector<PathDiagnosticLocationPair>::iterator iterator;
    606   iterator begin() { return LPairs.begin(); }
    607   iterator end()   { return LPairs.end(); }
    608 
    609   virtual void flattenLocations() {
    610     for (iterator I=begin(), E=end(); I!=E; ++I) I->flatten();
    611   }
    612 
    613   typedef std::vector<PathDiagnosticLocationPair>::const_iterator
    614           const_iterator;
    615   const_iterator begin() const { return LPairs.begin(); }
    616   const_iterator end() const   { return LPairs.end(); }
    617 
    618   static inline bool classof(const PathDiagnosticPiece *P) {
    619     return P->getKind() == ControlFlow;
    620   }
    621 
    622   virtual void Profile(llvm::FoldingSetNodeID &ID) const;
    623 };
    624 
    625 class PathDiagnosticMacroPiece : public PathDiagnosticSpotPiece {
    626 public:
    627   PathDiagnosticMacroPiece(const PathDiagnosticLocation &pos)
    628     : PathDiagnosticSpotPiece(pos, "", Macro) {}
    629 
    630   ~PathDiagnosticMacroPiece();
    631 
    632   PathPieces subPieces;
    633 
    634   bool containsEvent() const;
    635 
    636   virtual void flattenLocations() {
    637     PathDiagnosticSpotPiece::flattenLocations();
    638     for (PathPieces::iterator I = subPieces.begin(),
    639          E = subPieces.end(); I != E; ++I) (*I)->flattenLocations();
    640   }
    641 
    642   static inline bool classof(const PathDiagnosticPiece *P) {
    643     return P->getKind() == Macro;
    644   }
    645 
    646   virtual void Profile(llvm::FoldingSetNodeID &ID) const;
    647 };
    648 
    649 /// PathDiagnostic - PathDiagnostic objects represent a single path-sensitive
    650 ///  diagnostic.  It represents an ordered-collection of PathDiagnosticPieces,
    651 ///  each which represent the pieces of the path.
    652 class PathDiagnostic : public llvm::FoldingSetNode {
    653   const Decl *DeclWithIssue;
    654   std::string BugType;
    655   std::string VerboseDesc;
    656   std::string ShortDesc;
    657   std::string Category;
    658   std::deque<std::string> OtherDesc;
    659   PathDiagnosticLocation Loc;
    660   PathPieces pathImpl;
    661   llvm::SmallVector<PathPieces *, 3> pathStack;
    662 
    663   PathDiagnostic(); // Do not implement.
    664 public:
    665   PathDiagnostic(const Decl *DeclWithIssue, StringRef bugtype,
    666                  StringRef verboseDesc, StringRef shortDesc,
    667                  StringRef category);
    668 
    669   ~PathDiagnostic();
    670 
    671   const PathPieces &path;
    672 
    673   /// Return the path currently used by builders for constructing the
    674   /// PathDiagnostic.
    675   PathPieces &getActivePath() {
    676     if (pathStack.empty())
    677       return pathImpl;
    678     return *pathStack.back();
    679   }
    680 
    681   /// Return a mutable version of 'path'.
    682   PathPieces &getMutablePieces() {
    683     return pathImpl;
    684   }
    685 
    686   /// Return the unrolled size of the path.
    687   unsigned full_size();
    688 
    689   void pushActivePath(PathPieces *p) { pathStack.push_back(p); }
    690   void popActivePath() { if (!pathStack.empty()) pathStack.pop_back(); }
    691 
    692   bool isWithinCall() const { return !pathStack.empty(); }
    693 
    694   void setEndOfPath(PathDiagnosticPiece *EndPiece) {
    695     assert(!Loc.isValid() && "End location already set!");
    696     Loc = EndPiece->getLocation();
    697     assert(Loc.isValid() && "Invalid location for end-of-path piece");
    698     getActivePath().push_back(EndPiece);
    699   }
    700 
    701   void resetPath() {
    702     pathStack.clear();
    703     pathImpl.clear();
    704     Loc = PathDiagnosticLocation();
    705   }
    706 
    707   StringRef getVerboseDescription() const { return VerboseDesc; }
    708   StringRef getShortDescription() const {
    709     return ShortDesc.empty() ? VerboseDesc : ShortDesc;
    710   }
    711   StringRef getBugType() const { return BugType; }
    712   StringRef getCategory() const { return Category; }
    713 
    714   /// Return the semantic context where an issue occurred.  If the
    715   /// issue occurs along a path, this represents the "central" area
    716   /// where the bug manifests.
    717   const Decl *getDeclWithIssue() const { return DeclWithIssue; }
    718 
    719   typedef std::deque<std::string>::const_iterator meta_iterator;
    720   meta_iterator meta_begin() const { return OtherDesc.begin(); }
    721   meta_iterator meta_end() const { return OtherDesc.end(); }
    722   void addMeta(StringRef s) { OtherDesc.push_back(s); }
    723 
    724   PathDiagnosticLocation getLocation() const {
    725     assert(Loc.isValid() && "No end-of-path location set yet!");
    726     return Loc;
    727   }
    728 
    729   void flattenLocations() {
    730     Loc.flatten();
    731     for (PathPieces::iterator I = pathImpl.begin(), E = pathImpl.end();
    732          I != E; ++I) (*I)->flattenLocations();
    733   }
    734 
    735   /// Profiles the diagnostic, independent of the path it references.
    736   ///
    737   /// This can be used to merge diagnostics that refer to the same issue
    738   /// along different paths.
    739   void Profile(llvm::FoldingSetNodeID &ID) const;
    740 
    741   /// Profiles the diagnostic, including its path.
    742   ///
    743   /// Two diagnostics with the same issue along different paths will generate
    744   /// different profiles.
    745   void FullProfile(llvm::FoldingSetNodeID &ID) const;
    746 };
    747 
    748 } // end GR namespace
    749 
    750 } //end clang namespace
    751 
    752 #endif
    753