1 //===- CheckerDocumentation.cpp - Documentation checker ---------*- C++ -*-===//
8 //===----------------------------------------------------------------------===//
13 //===----------------------------------------------------------------------===//
33 /// as reporting bugs. Most of the callbacks are targeted at path-sensitive
46                                        check::Bind,
51                                        eval::Call,
60   /// \brief Pre-visit the Statement.
73   /// \brief Post-visit the Statement.
83   /// \brief Pre-visit the Objective C message.
85   /// This will be called before the analyzer core processes the method call.
86   /// This is called for any action which produces an Objective-C message send,
92   /// \brief Post-visit the Objective C message.
98   /// \brief Visit an Objective-C message whose receiver is nil.
100   /// This will be called when the analyzer core processes a method call whose
102   /// check{Pre/Post}Call will not be called.
107   /// \brief Pre-visit an abstract "call" event.
112   /// Note that this includes ALL cross-body invocations, so if you want to
117   void checkPreCall(const CallEvent &Call, CheckerContext &C) const {}  in checkPreCall()  argument
119   /// \brief Post-visit an abstract "call" event.
123   void checkPostCall(const CallEvent &Call, CheckerContext &C) const {}  in checkPostCall()  argument
125   /// \brief Pre-visit of the condition statement of a branch (such as IfStmt).
144   /// \param S   The bind is performed while processing the statement S.
146   /// check::Bind
180   /// - the symbolic execution graph is fully explored.
199   /// \brief Evaluates function call.
206   /// \returns true if the call has been successfully evaluated
207   /// and false otherwise. Note, that only one checker can evaluate a call. If
208   /// more than one checker claims that they can evaluate the same call the
211   /// eval::Call
243   /// This can occur in many different ways: an explicit bind, a blanket
245   /// call whose behavior the analyzer cannot model perfectly.
250   ///        For a function call, this would be the arguments. For a bind, this
254   ///        by this change. For a simple bind, this list will be the same as
255   ///        \p ExplicitRegions, since a bind does not affect the contents of
257   /// \param Call The opaque call triggering this invalidation. Will be 0 if the
258   ///        change was not triggered by a call.
269                        const CallEvent *Call) const {  in checkRegionChanges()
278   /// function call the analyzer cannot model.
282   /// \param Call The corresponding CallEvent, if the symbols escape as
283   /// parameters to the given call.
288                                      const CallEvent *Call,  in checkPointerEscape()  argument
299                                      const CallEvent *Call,  in checkConstPointerEscape()  argument