/*
* Cppcheck - A tool for static C/C++ code analysis
* Copyright (C) 2007-2026 Cppcheck team.
*
* 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
* along with this program. If not, see .
*/
#ifdef CHECK_INTERNAL
#include "checkinternal.h"
#include "fixture.h"
#include "helpers.h"
#include "settings.h"
#include
class TestInternal : public TestFixture {
public:
TestInternal() : TestFixture("TestInternal") {}
private:
/*const*/ Settings settings;
void run() override {
ASSERT_EQUALS("", settings.addEnabled("internal"));
mNewTemplate = true;
TEST_CASE(simplePatternInTokenMatch);
TEST_CASE(complexPatternInTokenSimpleMatch);
TEST_CASE(simplePatternSquareBrackets);
TEST_CASE(simplePatternAlternatives);
TEST_CASE(missingPercentCharacter);
TEST_CASE(unknownPattern);
TEST_CASE(redundantNextPrevious);
TEST_CASE(internalError);
TEST_CASE(orInComplexPattern);
TEST_CASE(extraWhitespace);
TEST_CASE(checkRedundantTokCheck);
}
#define check(...) check_(__FILE__, __LINE__, __VA_ARGS__)
template
void check_(const char* file, int line, const char (&code)[size]) {
// Tokenize..
SimpleTokenizer tokenizer(settings, *this);
ASSERT_LOC(tokenizer.tokenize(code), file, line);
CheckInternal check;
runChecks(check, tokenizer, *this);
}
void simplePatternInTokenMatch() {
check("void f() {\n"
" const Token *tok;\n"
" Token::Match(tok, \";\");\n"
"}");
ASSERT_EQUALS("[test.cpp:3:5]: (warning) Found simple pattern inside Token::Match() call: \";\" [simplePatternError]\n", errout_str());
check("void f() {\n"
" const Token *tok;\n"
" Token::Match(tok, \"%type%\");\n"
"}");
ASSERT_EQUALS("", errout_str());
check("void f() {\n"
" const Token *tok;\n"
" Token::Match(tok, \"%or%\");\n"
"}");
ASSERT_EQUALS("[test.cpp:3:5]: (warning) Found simple pattern inside Token::Match() call: \"%or%\" [simplePatternError]\n", errout_str());
check("void f() {\n"
" const Token *tok;\n"
" Token::findmatch(tok, \";\");\n"
"}");
ASSERT_EQUALS("[test.cpp:3:5]: (warning) Found simple pattern inside Token::findmatch() call: \";\" [simplePatternError]\n", errout_str());
}
void complexPatternInTokenSimpleMatch() {
check("void f() {\n"
" const Token *tok;\n"
" Token::simpleMatch(tok, \"%type%\");\n"
"}");
ASSERT_EQUALS("[test.cpp:3:5]: (error) Found complex pattern inside Token::simpleMatch() call: \"%type%\" [complexPatternError]\n", errout_str());
check("void f() {\n"
" const Token *tok;\n"
" Token::findsimplematch(tok, \"%type%\");\n"
"}");
ASSERT_EQUALS("[test.cpp:3:5]: (error) Found complex pattern inside Token::findsimplematch() call: \"%type%\" [complexPatternError]\n", errout_str());
check("void f() {\n"
" const Token *tok;\n"
" Token::findsimplematch(tok, \"} !!else\");\n"
"}");
ASSERT_EQUALS("[test.cpp:3:5]: (error) Found complex pattern inside Token::findsimplematch() call: \"} !!else\" [complexPatternError]\n", errout_str());
check("void f() {\n"
" const Token *tok;\n"
" Token::findsimplematch(tok, \"foobar\");\n"
"}");
ASSERT_EQUALS("", errout_str());
check("void f() {\n"
" const Token *tok;\n"
" Token::findsimplematch(tok, \"%\");\n"
"}");
ASSERT_EQUALS("", errout_str());
}
void simplePatternSquareBrackets() {
check("void f() {\n"
" const Token *tok;\n"
" Token::simpleMatch(tok, \"[\");\n"
"}");
ASSERT_EQUALS("", errout_str());
check("void f() {\n"
" const Token *tok;\n"
" Token::simpleMatch(tok, \"[ ]\");\n"
"}");
ASSERT_EQUALS("", errout_str());
check("void f() {\n"
" const Token *tok;\n"
" Token::simpleMatch(tok, \"[]\");\n"
"}");
ASSERT_EQUALS("[test.cpp:3:5]: (error) Found complex pattern inside Token::simpleMatch() call: \"[]\" [complexPatternError]\n", errout_str());
check("void f() {\n"
" const Token *tok;\n"
" Token::simpleMatch(tok, \"] [\");\n"
"}");
ASSERT_EQUALS("", errout_str());
check("void f() {\n"
" const Token *tok;\n"
" Token::simpleMatch(tok, \"] [ [abc]\");\n"
"}");
ASSERT_EQUALS("[test.cpp:3:5]: (error) Found complex pattern inside Token::simpleMatch() call: \"] [ [abc]\" [complexPatternError]\n", errout_str());
check("void f() {\n"
" const Token *tok;\n"
" Token::simpleMatch(tok, \"[.,;]\");\n"
"}");
ASSERT_EQUALS("[test.cpp:3:5]: (error) Found complex pattern inside Token::simpleMatch() call: \"[.,;]\" [complexPatternError]\n", errout_str());
}
void simplePatternAlternatives() {
check("void f() {\n"
" const Token *tok;\n"
" Token::simpleMatch(tok, \"||\");\n"
"}");
ASSERT_EQUALS("", errout_str());
check("void f() {\n"
" const Token *tok;\n"
" Token::simpleMatch(tok, \"|\");\n"
"}");
ASSERT_EQUALS("", errout_str());
check("void f() {\n"
" const Token *tok;\n"
" Token::simpleMatch(tok, \"a|b\");\n"
"}");
ASSERT_EQUALS("[test.cpp:3:5]: (error) Found complex pattern inside Token::simpleMatch() call: \"a|b\" [complexPatternError]\n", errout_str());
check("void f() {\n"
" const Token *tok;\n"
" Token::simpleMatch(tok, \"|= 0\");\n"
"}");
ASSERT_EQUALS("", errout_str());
check("void f() {\n"
" const Token *tok;\n"
" Token::simpleMatch(tok, \"| 0 )\");\n"
"}");
ASSERT_EQUALS("", errout_str());
}
void missingPercentCharacter() {
check("void f() {\n"
" const Token *tok;\n"
" Token::Match(tok, \"%type%\");\n"
"}");
ASSERT_EQUALS("", errout_str());
check("void f() {\n"
" const Token *tok;\n"
" Token::Match(tok, \"foo %type% bar\");\n"
"}");
ASSERT_EQUALS("", errout_str());
// Missing % at the end of string
check("void f() {\n"
" const Token *tok;\n"
" Token::Match(tok, \"%type\");\n"
"}");
ASSERT_EQUALS("[test.cpp:3:5]: (error) Missing percent end character in Token::Match() pattern: \"%type\" [missingPercentCharacter]\n", errout_str());
// Missing % in the middle of a pattern
check("void f() {\n"
" const Token *tok;\n"
" Token::Match(tok, \"foo %type bar\");\n"
"}");
ASSERT_EQUALS("[test.cpp:3:5]: (error) Missing percent end character in Token::Match() pattern: \"foo %type bar\" [missingPercentCharacter]\n", errout_str());
// Bei quiet on single %
check("void f() {\n"
" const Token *tok;\n"
" Token::Match(tok, \"foo % %type% bar\");\n"
"}");
ASSERT_EQUALS("", errout_str());
check("void f() {\n"
" const Token *tok;\n"
" Token::Match(tok, \"foo % %type % bar\");\n"
"}");
ASSERT_EQUALS("[test.cpp:3:5]: (error) Missing percent end character in Token::Match() pattern: \"foo % %type % bar\" [missingPercentCharacter]\n"
"[test.cpp:3:5]: (error) Unknown pattern used: \"%type %\" [unknownPattern]\n", errout_str());
// Find missing % also in 'alternatives' pattern
check("void f() {\n"
" const Token *tok;\n"
" Token::Match(tok, \"foo|%type|bar\");\n"
"}");
ASSERT_EQUALS("[test.cpp:3:5]: (error) Missing percent end character in Token::Match() pattern: \"foo|%type|bar\" [missingPercentCharacter]\n"
, errout_str());
// Make sure we don't take %or% for a broken %oror%
check("void f() {\n"
" const Token *tok;\n"
" Token::Match(tok, \"foo|%oror%|bar\");\n"
"}");
ASSERT_EQUALS("", errout_str());
}
void unknownPattern() {
check("void f() {\n"
" Token::Match(tok, \"%typ%\");\n"
"}");
ASSERT_EQUALS("[test.cpp:2:5]: (error) Unknown pattern used: \"%typ%\" [unknownPattern]\n", errout_str());
// Make sure we don't take %or% for a broken %oror%
check("void f() {\n"
" Token::Match(tok, \"%type%\");\n"
"}");
ASSERT_EQUALS("", errout_str());
}
void redundantNextPrevious() {
check("void f() {\n"
" return tok->next()->previous();\n"
"}");
ASSERT_EQUALS("[test.cpp:2:17]: (style) Call to 'Token::next()' followed by 'Token::previous()' can be simplified. [redundantNextPrevious]\n", errout_str());
check("void f() {\n"
" return tok->tokAt(5)->previous();\n"
"}");
ASSERT_EQUALS("[test.cpp:2:17]: (style) Call to 'Token::tokAt()' followed by 'Token::previous()' can be simplified. [redundantNextPrevious]\n", errout_str());
check("void f() {\n"
" return tok->previous()->linkAt(5);\n"
"}");
ASSERT_EQUALS("[test.cpp:2:17]: (style) Call to 'Token::previous()' followed by 'Token::linkAt()' can be simplified. [redundantNextPrevious]\n", errout_str());
check("void f() {\n"
" tok->next()->previous(foo);\n"
"}");
ASSERT_EQUALS("", errout_str());
check("void f() {\n"
" return tok->next()->next();\n"
"}");
ASSERT_EQUALS("[test.cpp:2:17]: (style) Call to 'Token::next()' followed by 'Token::next()' can be simplified. [redundantNextPrevious]\n", errout_str());
check("void f() {\n"
" return tok->previous()->previous();\n"
"}");
ASSERT_EQUALS("[test.cpp:2:17]: (style) Call to 'Token::previous()' followed by 'Token::previous()' can be simplified. [redundantNextPrevious]\n", errout_str());
check("void f() {\n"
" return tok->tokAt(foo+bar)->tokAt();\n"
"}");
ASSERT_EQUALS("[test.cpp:2:17]: (style) Call to 'Token::tokAt()' followed by 'Token::tokAt()' can be simplified. [redundantNextPrevious]\n", errout_str());
check("void f() {\n"
" return tok->tokAt(foo+bar)->link();\n"
"}");
ASSERT_EQUALS("[test.cpp:2:17]: (style) Call to 'Token::tokAt()' followed by 'Token::link()' can be simplified. [redundantNextPrevious]\n", errout_str());
check("void f() {\n"
" tok->tokAt(foo+bar)->link(foo);\n"
"}");
ASSERT_EQUALS("", errout_str());
check("void f() {\n"
" return tok->next()->next()->str();\n"
"}");
ASSERT_EQUALS("[test.cpp:2:17]: (style) Call to 'Token::next()' followed by 'Token::next()' can be simplified. [redundantNextPrevious]\n"
"[test.cpp:2:25]: (style) Call to 'Token::next()' followed by 'Token::str()' can be simplified. [redundantNextPrevious]\n",
errout_str());
check("void f() {\n"
" return tok->previous()->next()->str();\n"
"}");
ASSERT_EQUALS("[test.cpp:2:17]: (style) Call to 'Token::previous()' followed by 'Token::next()' can be simplified. [redundantNextPrevious]\n"
"[test.cpp:2:29]: (style) Call to 'Token::next()' followed by 'Token::str()' can be simplified. [redundantNextPrevious]\n",
errout_str());
}
void internalError() {
// Make sure cppcheck does not raise an internal error of Token::Match ( Ticket #3727 )
check("class DELPHICLASS X;\n"
"class Y {\n"
"private:\n"
" X* x;\n"
"};\n"
"class Z {\n"
" char z[1];\n"
" Z(){\n"
" z[0] = 0;\n"
" }\n"
"};");
ASSERT_EQUALS("", errout_str());
}
void orInComplexPattern() {
check("void f() {\n"
" Token::Match(tok, \"||\");\n"
"}");
ASSERT_EQUALS("[test.cpp:2:5]: (error) Token::Match() pattern \"||\" contains \"||\" or \"|\". Replace it by \"%oror%\" or \"%or%\". [orInComplexPattern]\n", errout_str());
check("void f() {\n"
" Token::Match(tok, \"|\");\n"
"}");
ASSERT_EQUALS("[test.cpp:2:5]: (error) Token::Match() pattern \"|\" contains \"||\" or \"|\". Replace it by \"%oror%\" or \"%or%\". [orInComplexPattern]\n", errout_str());
check("void f() {\n"
" Token::Match(tok, \"[|+-]\");\n"
"}");
ASSERT_EQUALS("", errout_str());
check("void f() {\n"
" Token::Match(tok, \"foo | bar\");\n"
"}");
ASSERT_EQUALS("[test.cpp:2:5]: (error) Token::Match() pattern \"foo | bar\" contains \"||\" or \"|\". Replace it by \"%oror%\" or \"%or%\". [orInComplexPattern]\n", errout_str());
check("void f() {\n"
" Token::Match(tok, \"foo |\");\n"
"}");
ASSERT_EQUALS("[test.cpp:2:5]: (error) Token::Match() pattern \"foo |\" contains \"||\" or \"|\". Replace it by \"%oror%\" or \"%or%\". [orInComplexPattern]\n", errout_str());
check("void f() {\n"
" Token::Match(tok, \"bar foo|\");\n"
"}");
ASSERT_EQUALS("", errout_str());
}
void extraWhitespace() {
// whitespace at the end
check("void f() {\n"
" const Token *tok;\n"
" Token::Match(tok, \"%str% \");\n"
"}");
ASSERT_EQUALS("[test.cpp:3:5]: (warning) Found extra whitespace inside Token::Match() call: \"%str% \" [extraWhitespaceError]\n", errout_str());
// whitespace at the begin
check("void f() {\n"
" const Token *tok;\n"
" Token::Match(tok, \" %str%\");\n"
"}");
ASSERT_EQUALS("[test.cpp:3:5]: (warning) Found extra whitespace inside Token::Match() call: \" %str%\" [extraWhitespaceError]\n", errout_str());
// two whitespaces or more
check("void f() {\n"
" const Token *tok;\n"
" Token::Match(tok, \"%str% bar\");\n"
"}");
ASSERT_EQUALS("[test.cpp:3:5]: (warning) Found extra whitespace inside Token::Match() call: \"%str% bar\" [extraWhitespaceError]\n", errout_str());
// test simpleMatch
check("void f() {\n"
" const Token *tok;\n"
" Token::simpleMatch(tok, \"foobar \");\n"
"}");
ASSERT_EQUALS("[test.cpp:3:5]: (warning) Found extra whitespace inside Token::simpleMatch() call: \"foobar \" [extraWhitespaceError]\n", errout_str());
// test findmatch
check("void f() {\n"
" const Token *tok;\n"
" Token::findmatch(tok, \"%str% \");\n"
"}");
ASSERT_EQUALS("[test.cpp:3:5]: (warning) Found extra whitespace inside Token::findmatch() call: \"%str% \" [extraWhitespaceError]\n", errout_str());
// test findsimplematch
check("void f() {\n"
" const Token *tok;\n"
" Token::findsimplematch(tok, \"foobar \");\n"
"}");
ASSERT_EQUALS("[test.cpp:3:5]: (warning) Found extra whitespace inside Token::findsimplematch() call: \"foobar \" [extraWhitespaceError]\n", errout_str());
}
void checkRedundantTokCheck() {
// findsimplematch
check("void f() {\n"
" const Token *tok;\n"
" if(tok && Token::findsimplematch(tok, \"foobar\")) {};\n"
"}");
ASSERT_EQUALS("[test.cpp:3:38]: (style) Unnecessary check of \"tok\", match-function already checks if it is null. [redundantTokCheck]\n", errout_str());
// findmatch
check("void f() {\n"
" const Token *tok;\n"
" if(tok && Token::findmatch(tok, \"%str% foobar\")) {};\n"
"}");
ASSERT_EQUALS("[test.cpp:3:32]: (style) Unnecessary check of \"tok\", match-function already checks if it is null. [redundantTokCheck]\n", errout_str());
// Match
check("void f() {\n"
" const Token *tok;\n"
" if(tok && Token::Match(tok, \"5str% foobar\")) {};\n"
"}");
ASSERT_EQUALS("[test.cpp:3:28]: (style) Unnecessary check of \"tok\", match-function already checks if it is null. [redundantTokCheck]\n", errout_str());
check("void f() {\n"
" const Token *tok;\n"
" if(a && tok && Token::Match(tok, \"5str% foobar\")) {};\n"
"}");
ASSERT_EQUALS("[test.cpp:3:33]: (style) Unnecessary check of \"tok\", match-function already checks if it is null. [redundantTokCheck]\n", errout_str());
check("void f() {\n"
" const Token *tok;\n"
" if(a && b && tok && Token::Match(tok, \"5str% foobar\")) {};\n"
"}");
ASSERT_EQUALS("[test.cpp:3:38]: (style) Unnecessary check of \"tok\", match-function already checks if it is null. [redundantTokCheck]\n", errout_str());
check("void f() {\n"
" const Token *tok;\n"
" if(a && b && c && tok && Token::Match(tok, \"5str% foobar\")) {};\n"
"}");
ASSERT_EQUALS("[test.cpp:3:43]: (style) Unnecessary check of \"tok\", match-function already checks if it is null. [redundantTokCheck]\n", errout_str());
check("void f() {\n"
" const Token *tok;\n"
" if(a && b && c && tok && d && Token::Match(tok, \"5str% foobar\")) {};\n"
"}");
ASSERT_EQUALS("", errout_str());
// simpleMatch
check("void f() {\n"
" const Token *tok;\n"
" if(tok && Token::simpleMatch(tok, \"foobar\")) {};\n"
"}");
ASSERT_EQUALS("[test.cpp:3:34]: (style) Unnecessary check of \"tok\", match-function already checks if it is null. [redundantTokCheck]\n", errout_str());
// Match
check("void f() {\n"
" const Token *tok;\n"
" if(tok->previous() && Token::Match(tok->previous(), \"5str% foobar\")) {};\n"
"}");
ASSERT_EQUALS("[test.cpp:3:53]: (style) Unnecessary check of \"tok->previous()\", match-function already checks if it is null. [redundantTokCheck]\n", errout_str());
// don't report:
// tok->previous() vs tok
check("void f() {\n"
" const Token *tok;\n"
" if(tok->previous() && Token::Match(tok, \"5str% foobar\")) {};\n"
"}");
ASSERT_EQUALS("", errout_str());
// tok vs tok->previous())
check("void f() {\n"
" const Token *tok;\n"
" if(tok && Token::Match(tok->previous(), \"5str% foobar\")) {};\n"
"}");
ASSERT_EQUALS("", errout_str());
// tok->previous() vs tok->previous()->previous())
check("void f() {\n"
" const Token *tok;\n"
" if(tok->previous() && Token::Match(tok->previous()->previous(), \"5str% foobar\")) {};\n"
"}");
ASSERT_EQUALS("[test.cpp:3:45]: (style) Call to 'Token::previous()' followed by 'Token::previous()' can be simplified. [redundantNextPrevious]\n", errout_str());
// if a && fn(a) triggers, make sure !a || !fn(a) triggers as well!
check("void f() {\n"
" const Token *tok;\n"
" if(!tok || !Token::simpleMatch(tok, \"foobar\")) {};\n"
"}");
ASSERT_EQUALS("[test.cpp:3:36]: (style) Unnecessary check of \"tok\", match-function already checks if it is null. [redundantTokCheck]\n", errout_str());
check("void f() {\n"
" const Token *tok;\n"
" if(a || !tok || !Token::simpleMatch(tok, \"foobar\")) {};\n"
"}");
ASSERT_EQUALS("[test.cpp:3:41]: (style) Unnecessary check of \"tok\", match-function already checks if it is null. [redundantTokCheck]\n", errout_str());
// if tok || !Token::simpleMatch...
check("void f() {\n"
" const Token *tok;\n"
" if(tok || !Token::simpleMatch(tok, \"foobar\")) {};\n"
"}");
ASSERT_EQUALS("", errout_str());
// if !tok || Token::simpleMatch...
check("void f() {\n"
" const Token *tok;\n"
" if(!tok || Token::simpleMatch(tok, \"foobar\")) {};\n"
"}");
ASSERT_EQUALS("", errout_str());
// something more complex
check("void f() {\n"
" const Token *tok;\n"
" if(!tok->previous()->previous() || !Token::simpleMatch(tok->previous()->previous(), \"foobar\")) {};\n"
"}");
ASSERT_EQUALS("[test.cpp:3:14]: (style) Call to 'Token::previous()' followed by 'Token::previous()' can be simplified. [redundantNextPrevious]\n"
"[test.cpp:3:65]: (style) Call to 'Token::previous()' followed by 'Token::previous()' can be simplified. [redundantNextPrevious]\n"
"[test.cpp:3:85]: (style) Unnecessary check of \"tok->previous()->previous()\", match-function already checks if it is null. [redundantTokCheck]\n", errout_str());
}
};
REGISTER_TEST(TestInternal)
#endif // #ifdef CHECK_INTERNAL