2009-02-10 20:40:21 +01:00
|
|
|
/*
|
|
|
|
* Cppcheck - A tool for static C/C++ code analysis
|
2015-11-18 20:04:50 +01:00
|
|
|
* Copyright (C) 2007-2015 Cppcheck team.
|
2009-02-10 20:40:21 +01:00
|
|
|
*
|
|
|
|
* This program is free software: you can redistribute it and/or modify
|
|
|
|
* it under the terms of the GNU General Public License as published by
|
|
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
|
|
* (at your option) any later version.
|
|
|
|
*
|
|
|
|
* This program is distributed in the hope that it will be useful,
|
|
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
* GNU General Public License for more details.
|
|
|
|
*
|
|
|
|
* You should have received a copy of the GNU General Public License
|
2009-09-27 17:08:31 +02:00
|
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
2009-02-10 20:40:21 +01:00
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
|
|
//---------------------------------------------------------------------------
|
|
|
|
#ifndef checkstlH
|
|
|
|
#define checkstlH
|
|
|
|
//---------------------------------------------------------------------------
|
|
|
|
|
2012-06-10 14:19:09 +02:00
|
|
|
#include "config.h"
|
2009-03-18 22:40:38 +01:00
|
|
|
#include "check.h"
|
|
|
|
|
2009-02-10 20:40:21 +01:00
|
|
|
|
2009-07-17 10:49:01 +02:00
|
|
|
/// @addtogroup Checks
|
|
|
|
/// @{
|
|
|
|
|
|
|
|
|
2010-01-22 19:29:24 +01:00
|
|
|
/** @brief %Check STL usage (invalidation of iterators, mismatching containers, etc) */
|
2012-06-10 14:19:09 +02:00
|
|
|
class CPPCHECKLIB CheckStl : public Check {
|
2009-02-10 20:40:21 +01:00
|
|
|
public:
|
2009-03-21 07:53:23 +01:00
|
|
|
/** This constructor is used when registering the CheckClass */
|
2014-11-20 14:20:09 +01:00
|
|
|
CheckStl() : Check(myName()) {
|
2013-08-07 16:27:37 +02:00
|
|
|
}
|
2009-03-20 17:15:51 +01:00
|
|
|
|
2010-03-17 22:16:18 +01:00
|
|
|
/** This constructor is used when running checks. */
|
2009-03-20 17:15:51 +01:00
|
|
|
CheckStl(const Tokenizer *tokenizer, const Settings *settings, ErrorLogger *errorLogger)
|
2014-11-20 14:20:09 +01:00
|
|
|
: Check(myName(), tokenizer, settings, errorLogger) {
|
2013-08-07 16:27:37 +02:00
|
|
|
}
|
2009-03-18 22:40:38 +01:00
|
|
|
|
2010-10-15 18:37:48 +02:00
|
|
|
/** Simplified checks. The token list is simplified. */
|
2014-11-20 14:20:09 +01:00
|
|
|
void runSimplifiedChecks(const Tokenizer *tokenizer, const Settings *settings, ErrorLogger *errorLogger) {
|
2012-09-10 19:02:32 +02:00
|
|
|
if (!tokenizer->isCPP())
|
|
|
|
return;
|
|
|
|
|
2009-03-20 17:15:51 +01:00
|
|
|
CheckStl checkStl(tokenizer, settings, errorLogger);
|
|
|
|
|
|
|
|
checkStl.stlOutOfBounds();
|
|
|
|
checkStl.iterators();
|
2009-10-18 18:42:01 +02:00
|
|
|
checkStl.mismatchingContainers();
|
2009-03-20 17:15:51 +01:00
|
|
|
checkStl.erase();
|
|
|
|
checkStl.pushback();
|
2013-02-10 07:43:09 +01:00
|
|
|
checkStl.stlBoundaries();
|
2010-02-27 21:26:11 +01:00
|
|
|
checkStl.if_find();
|
2010-10-17 19:18:46 +02:00
|
|
|
checkStl.string_c_str();
|
2011-06-16 20:26:00 +02:00
|
|
|
checkStl.checkAutoPointer();
|
2011-10-24 23:25:23 +02:00
|
|
|
checkStl.uselessCalls();
|
2013-04-05 06:14:59 +02:00
|
|
|
checkStl.checkDereferenceInvalidIterator();
|
2009-12-28 18:06:26 +01:00
|
|
|
|
2010-04-21 08:38:25 +02:00
|
|
|
// Style check
|
|
|
|
checkStl.size();
|
2010-09-16 18:49:23 +02:00
|
|
|
checkStl.redundantCondition();
|
2010-10-10 10:52:41 +02:00
|
|
|
checkStl.missingComparison();
|
2014-03-03 18:27:45 +01:00
|
|
|
checkStl.readingEmptyStlContainer();
|
2009-03-18 22:40:38 +01:00
|
|
|
}
|
2009-02-10 20:40:21 +01:00
|
|
|
|
2009-02-10 20:56:00 +01:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Finds errors like this:
|
|
|
|
* for (unsigned ii = 0; ii <= foo.size(); ++ii)
|
|
|
|
*/
|
|
|
|
void stlOutOfBounds();
|
|
|
|
|
2009-02-11 06:08:29 +01:00
|
|
|
/**
|
|
|
|
* Finds errors like this:
|
|
|
|
* for (it = foo.begin(); it != bar.end(); ++it)
|
|
|
|
*/
|
2009-02-10 20:40:21 +01:00
|
|
|
void iterators();
|
|
|
|
|
2009-10-18 18:42:01 +02:00
|
|
|
/**
|
|
|
|
* Mismatching containers:
|
|
|
|
* std::find(foo.begin(), bar.end(), x)
|
|
|
|
*/
|
|
|
|
void mismatchingContainers();
|
|
|
|
|
2009-02-11 06:08:29 +01:00
|
|
|
/**
|
2010-10-15 18:37:48 +02:00
|
|
|
* Dangerous usage of erase. The iterator is invalidated by erase so
|
|
|
|
* it is bad to dereference it after the erase.
|
2009-02-11 06:08:29 +01:00
|
|
|
*/
|
|
|
|
void erase();
|
2015-07-23 18:53:31 +02:00
|
|
|
void eraseCheckLoopVar(const Scope &scope, const Variable *var);
|
2010-10-05 20:54:13 +02:00
|
|
|
|
2009-02-11 06:08:29 +01:00
|
|
|
|
2009-02-18 20:57:43 +01:00
|
|
|
/**
|
2009-10-15 21:29:56 +02:00
|
|
|
* Dangerous usage of push_back and insert
|
2009-02-18 20:57:43 +01:00
|
|
|
*/
|
|
|
|
void pushback();
|
|
|
|
|
2009-04-13 17:48:13 +02:00
|
|
|
/**
|
|
|
|
* bad condition.. "it < alist.end()"
|
|
|
|
*/
|
2013-02-10 07:43:09 +01:00
|
|
|
void stlBoundaries();
|
2009-11-02 20:25:08 +01:00
|
|
|
|
2010-02-27 21:26:11 +01:00
|
|
|
/** if (a.find(x)) - possibly incorrect condition */
|
|
|
|
void if_find();
|
|
|
|
|
2009-12-19 15:24:59 +01:00
|
|
|
/**
|
|
|
|
* Suggest using empty() instead of checking size() against zero for containers.
|
|
|
|
* Item 4 from Scott Meyers book "Effective STL".
|
|
|
|
*/
|
|
|
|
void size();
|
|
|
|
|
2010-09-16 18:49:23 +02:00
|
|
|
/**
|
|
|
|
* Check for redundant condition 'if (ints.find(1) != ints.end()) ints.remove(123);'
|
|
|
|
* */
|
|
|
|
void redundantCondition();
|
|
|
|
|
2010-10-10 10:52:41 +02:00
|
|
|
/**
|
|
|
|
* @brief Missing inner comparison, when incrementing iterator inside loop
|
|
|
|
* Dangers:
|
|
|
|
* - may increment iterator beyond end
|
|
|
|
* - may unintentionally skip elements in list/set etc
|
|
|
|
*/
|
|
|
|
void missingComparison();
|
|
|
|
|
2010-10-17 19:18:46 +02:00
|
|
|
/** Check for common mistakes when using the function string::c_str() */
|
|
|
|
void string_c_str();
|
|
|
|
|
2011-06-16 20:26:00 +02:00
|
|
|
/** @brief %Check for use and copy auto pointer */
|
|
|
|
void checkAutoPointer();
|
|
|
|
|
2011-10-24 23:25:23 +02:00
|
|
|
/** @brief %Check calls that using them is useless */
|
|
|
|
void uselessCalls();
|
|
|
|
|
2013-06-12 22:13:05 +02:00
|
|
|
/** @brief %Check for dereferencing an iterator that is invalid */
|
2013-04-05 06:14:59 +02:00
|
|
|
void checkDereferenceInvalidIterator();
|
2011-10-24 23:25:23 +02:00
|
|
|
|
2012-10-14 11:16:48 +02:00
|
|
|
/**
|
|
|
|
* Dereferencing an erased iterator
|
2012-10-24 01:20:14 +02:00
|
|
|
* @param erased token where the erase occurs
|
|
|
|
* @param deref token where the dereference occurs
|
2012-10-14 11:16:48 +02:00
|
|
|
* @param itername iterator name
|
|
|
|
*/
|
2012-10-17 00:29:06 +02:00
|
|
|
void dereferenceErasedError(const Token* erased, const Token* deref, const std::string &itername);
|
2011-06-16 20:26:00 +02:00
|
|
|
|
2014-03-03 18:27:45 +01:00
|
|
|
/** @brief Reading from empty stl container */
|
|
|
|
void readingEmptyStlContainer();
|
|
|
|
|
2009-02-10 20:40:21 +01:00
|
|
|
private:
|
2015-05-02 13:54:13 +02:00
|
|
|
void readingEmptyStlContainer_parseUsage(const Token* tok, bool map, std::set<unsigned int>& empty, bool noerror);
|
|
|
|
|
2012-03-27 19:40:39 +02:00
|
|
|
void missingComparisonError(const Token *incrementToken1, const Token *incrementToken2);
|
|
|
|
void string_c_strThrowError(const Token *tok);
|
|
|
|
void string_c_strError(const Token *tok);
|
|
|
|
void string_c_strReturn(const Token *tok);
|
|
|
|
void string_c_strParam(const Token *tok, unsigned int number);
|
|
|
|
|
2012-02-25 12:43:27 +01:00
|
|
|
void stlOutOfBoundsError(const Token *tok, const std::string &num, const std::string &var, bool at);
|
2010-04-17 13:37:04 +02:00
|
|
|
void invalidIteratorError(const Token *tok, const std::string &iteratorName);
|
2009-03-20 20:09:44 +01:00
|
|
|
void iteratorsError(const Token *tok, const std::string &container1, const std::string &container2);
|
2009-10-18 18:42:01 +02:00
|
|
|
void mismatchingContainersError(const Token *tok);
|
2009-10-21 20:15:11 +02:00
|
|
|
void invalidIteratorError(const Token *tok, const std::string &func, const std::string &iterator_name);
|
2012-10-14 11:16:48 +02:00
|
|
|
void invalidPointerError(const Token *tok, const std::string &func, const std::string &pointer_name);
|
2013-02-10 07:43:09 +01:00
|
|
|
void stlBoundariesError(const Token *tok, const std::string &container_name);
|
2010-02-27 21:26:11 +01:00
|
|
|
void if_findError(const Token *tok, bool str);
|
2009-12-19 15:24:59 +01:00
|
|
|
void sizeError(const Token *tok);
|
2010-09-16 18:49:23 +02:00
|
|
|
void redundantIfRemoveError(const Token *tok);
|
2009-03-20 20:09:44 +01:00
|
|
|
|
2011-06-16 20:26:00 +02:00
|
|
|
void autoPointerError(const Token *tok);
|
|
|
|
void autoPointerContainerError(const Token *tok);
|
|
|
|
void autoPointerArrayError(const Token *tok);
|
2015-03-19 06:41:54 +01:00
|
|
|
void autoPointerMallocError(const Token *tok, const std::string& allocFunction);
|
2011-06-16 20:26:00 +02:00
|
|
|
|
2011-10-31 21:32:30 +01:00
|
|
|
void uselessCallsReturnValueError(const Token *tok, const std::string &varname, const std::string &function);
|
|
|
|
void uselessCallsSwapError(const Token *tok, const std::string &varname);
|
2012-04-04 19:40:28 +02:00
|
|
|
void uselessCallsSubstrError(const Token *tok, bool empty);
|
2012-07-12 12:23:52 +02:00
|
|
|
void uselessCallsEmptyError(const Token *tok);
|
2012-09-07 14:23:32 +02:00
|
|
|
void uselessCallsRemoveError(const Token *tok, const std::string& function);
|
2011-10-24 23:25:23 +02:00
|
|
|
|
2013-04-05 06:14:59 +02:00
|
|
|
void dereferenceInvalidIteratorError(const Token* deref, const std::string &itername);
|
|
|
|
|
2014-03-03 18:27:45 +01:00
|
|
|
void readingEmptyStlContainerError(const Token *tok);
|
|
|
|
|
2014-11-20 14:20:09 +01:00
|
|
|
void getErrorMessages(ErrorLogger *errorLogger, const Settings *settings) const {
|
2010-12-29 12:43:29 +01:00
|
|
|
CheckStl c(0, settings, errorLogger);
|
|
|
|
c.invalidIteratorError(0, "iterator");
|
|
|
|
c.iteratorsError(0, "container1", "container2");
|
|
|
|
c.mismatchingContainersError(0);
|
2012-10-14 11:16:48 +02:00
|
|
|
c.dereferenceErasedError(0, 0, "iter");
|
2012-02-25 12:43:27 +01:00
|
|
|
c.stlOutOfBoundsError(0, "i", "foo", false);
|
2010-12-29 12:43:29 +01:00
|
|
|
c.invalidIteratorError(0, "push_back|push_front|insert", "iterator");
|
2012-10-14 11:16:48 +02:00
|
|
|
c.invalidPointerError(0, "push_back", "pointer");
|
2013-02-10 07:43:09 +01:00
|
|
|
c.stlBoundariesError(0, "container");
|
2010-12-29 12:43:29 +01:00
|
|
|
c.if_findError(0, false);
|
|
|
|
c.if_findError(0, true);
|
|
|
|
c.string_c_strError(0);
|
2012-02-25 12:43:27 +01:00
|
|
|
c.string_c_strReturn(0);
|
|
|
|
c.string_c_strParam(0, 0);
|
2010-12-29 12:43:29 +01:00
|
|
|
c.sizeError(0);
|
2012-10-14 11:16:48 +02:00
|
|
|
c.missingComparisonError(0, 0);
|
2010-12-29 12:43:29 +01:00
|
|
|
c.redundantIfRemoveError(0);
|
2011-06-16 20:26:00 +02:00
|
|
|
c.autoPointerError(0);
|
|
|
|
c.autoPointerContainerError(0);
|
|
|
|
c.autoPointerArrayError(0);
|
2015-03-19 06:41:54 +01:00
|
|
|
c.autoPointerMallocError(0, "malloc");
|
2011-10-31 21:32:30 +01:00
|
|
|
c.uselessCallsReturnValueError(0, "str", "find");
|
|
|
|
c.uselessCallsSwapError(0, "str");
|
2012-04-04 19:40:28 +02:00
|
|
|
c.uselessCallsSubstrError(0, false);
|
2012-07-12 12:23:52 +02:00
|
|
|
c.uselessCallsEmptyError(0);
|
2012-09-07 14:23:32 +02:00
|
|
|
c.uselessCallsRemoveError(0, "remove");
|
2013-04-05 06:14:59 +02:00
|
|
|
c.dereferenceInvalidIteratorError(0, "i");
|
2014-03-03 18:27:45 +01:00
|
|
|
c.readingEmptyStlContainerError(0);
|
2009-03-21 14:07:51 +01:00
|
|
|
}
|
2009-06-12 12:19:37 +02:00
|
|
|
|
2014-11-20 14:20:09 +01:00
|
|
|
static std::string myName() {
|
2009-06-12 15:20:08 +02:00
|
|
|
return "STL usage";
|
|
|
|
}
|
|
|
|
|
2014-11-20 14:20:09 +01:00
|
|
|
std::string classInfo() const {
|
2009-06-12 15:20:08 +02:00
|
|
|
return "Check for invalid usage of STL:\n"
|
2014-09-30 14:56:12 +02:00
|
|
|
"- out of bounds errors\n"
|
|
|
|
"- misuse of iterators when iterating through a container\n"
|
|
|
|
"- mismatching containers in calls\n"
|
|
|
|
"- dereferencing an erased iterator\n"
|
|
|
|
"- for vectors: using iterator/pointer after push_back has been used\n"
|
|
|
|
"- optimisation: use empty() instead of size() to guarantee fast code\n"
|
|
|
|
"- suspicious condition when using find\n"
|
|
|
|
"- redundant condition\n"
|
|
|
|
"- common mistakes when using string::c_str()\n"
|
|
|
|
"- using auto pointer (auto_ptr)\n"
|
|
|
|
"- useless calls of string and STL functions\n"
|
|
|
|
"- dereferencing an invalid iterator\n"
|
|
|
|
"- reading from empty STL container\n";
|
2009-06-12 12:19:37 +02:00
|
|
|
}
|
2009-02-10 20:40:21 +01:00
|
|
|
};
|
2009-07-17 10:49:01 +02:00
|
|
|
/// @}
|
2009-02-10 20:40:21 +01:00
|
|
|
//---------------------------------------------------------------------------
|
2013-09-04 20:59:49 +02:00
|
|
|
#endif // checkstlH
|