Fixed 3133 (Improve Check: Found obsolete function)

seb777 · seb777 · commit 1d9a99012bfc · 2011-10-09T10:31:21.000+02:00
- add check for std::gets
- improve check when multiple obsolete functions are used
- remove false positive (declared functions)
diff --git a/lib/checkobsoletefunctions.cpp b/lib/checkobsoletefunctions.cpp
@@ -45,10 +45,13 @@ void CheckObsoleteFunctions::obsoleteFunctions()
 
     for (const Token *tok = _tokenizer->tokens(); tok; tok = tok->next())
     {
-        if (tok->isName() && tok->varId()==0 && tok->strAt(1) == "(" && !Token::Match(tok->previous(), ".|::|:|,"))
+
+        if (tok->isName() && tok->varId()==0 && tok->strAt(1) == "(" &&
+            (!Token::Match(tok->previous(), ".|::|:|,") || Token::simpleMatch(tok->previous()->previous(), "std :: gets")))
         {
             // function declaration?
-            if (symbolDatabase->findFunctionByToken(tok))
+            if ((tok->previous() && (tok->previous()->str() == "*" || tok->previous()->isName()))
+                || symbolDatabase->findFunctionByToken(tok))
             {
                 _obsoleteStandardFunctions.erase(tok->str());
                 _obsoletePosixFunctions.erase(tok->str());
@@ -61,7 +64,6 @@ void CheckObsoleteFunctions::obsoleteFunctions()
                 // If checking an old code base it might be uninteresting to update obsolete functions.
                 // Therefore this is "information"
                 reportError(tok->tokAt(1), Severity::style, "obsoleteFunctions"+it->first, it->second);
-                break;
             }
             else
             {
@@ -73,7 +75,6 @@ void CheckObsoleteFunctions::obsoleteFunctions()
                         // If checking an old code base it might be uninteresting to update obsolete functions.
                         // Therefore this is "information"
                         reportError(tok->tokAt(1), Severity::style, "obsoleteFunctions"+it->first, it->second);
-                        break;
                     }
                 }
                 if (_settings->c99)
@@ -82,7 +83,6 @@ void CheckObsoleteFunctions::obsoleteFunctions()
                     if (it != _obsoleteC99Functions.end())
                     {
                         reportError(tok->tokAt(1), Severity::style, "obsoleteFunctions"+it->first, it->second);
-                        break;
                     }
                 }
             }
diff --git a/test/testobsoletefunctions.cpp b/test/testobsoletefunctions.cpp
@@ -53,6 +53,16 @@ class TestObsoleteFunctions : public TestFixture
 
         // declared function ticket #3121
         TEST_CASE(test_declared_function);
+
+        // test std::gets
+        TEST_CASE(test_std_gets);
+
+        // multiple use of obsolete functions
+        TEST_CASE(test_multiple);
+
+        // c declared function
+        TEST_CASE(test_c_declaration);
+
     }
 
     void check(const char code[])
@@ -242,6 +252,46 @@ class TestObsoleteFunctions : public TestFixture
               "}\n");
         ASSERT_EQUALS("", errout.str());
     }
+
+    // test std::gets
+    void test_std_gets()
+    {
+        check("void f(char * str)\n"
+              "{\n"
+              "    char *x = std::gets(str);\n"
+              "}\n");
+        ASSERT_EQUALS("[test.cpp:3]: (style) Found obsolete function 'gets'. It is recommended to use the function 'fgets' instead\n", errout.str());
+    }
+
+    // multiple use
+    void test_multiple()
+    {
+        check("void f(char * str)\n"
+              "{\n"
+              "    char *x = std::gets(str);\n"
+              "    usleep( 1000 );\n"
+              "}\n");
+        ASSERT_EQUALS("[test.cpp:3]: (style) Found obsolete function 'gets'. It is recommended to use the function 'fgets' instead\n[test.cpp:4]: (style) Found obsolete function 'usleep'. It is recommended that new applications use the 'nanosleep' or 'setitimer' function\n", errout.str());
+    }
+
+    void test_c_declaration()
+    {
+        check("char * gets ( char * c ) ;\n"
+              "int main ()\n"
+              "{\n"
+              "    char s [ 10 ] ;\n"
+              "    gets ( s ) ;\n"
+              "}\n");
+        ASSERT_EQUALS("", errout.str());
+
+        check("int getcontext(ucontext_t *ucp);\n"
+              "int f (ucontext_t *ucp)\n"
+              "{\n"
+              "    getcontext ( ucp ) ;\n"
+              "}\n");
+        ASSERT_EQUALS("", errout.str());
+    }
+
 };
 
 REGISTER_TEST(TestObsoleteFunctions)

Original file line number	Diff line number	Diff line change
`@@ -45,10 +45,13 @@ void CheckObsoleteFunctions::obsoleteFunctions()`
`45`	`45`
`46`	`46`	`for (const Token *tok = _tokenizer->tokens(); tok; tok = tok->next())`
`47`	`47`	`{`
`48`		`- if (tok->isName() && tok->varId()==0 && tok->strAt(1) == "(" && !Token::Match(tok->previous(), ".\|::\|:\|,"))`
	`48`	`+`
	`49`	`+ if (tok->isName() && tok->varId()==0 && tok->strAt(1) == "(" &&`
	`50`	`+ (!Token::Match(tok->previous(), ".\|::\|:\|,") \|\| Token::simpleMatch(tok->previous()->previous(), "std :: gets")))`
`49`	`51`	`{`
`50`	`52`	`// function declaration?`
`51`		`- if (symbolDatabase->findFunctionByToken(tok))`
	`53`	`+ if ((tok->previous() && (tok->previous()->str() == "*" \|\| tok->previous()->isName()))`
	`54`	`+ \|\| symbolDatabase->findFunctionByToken(tok))`
`52`	`55`	`{`
`53`	`56`	`_obsoleteStandardFunctions.erase(tok->str());`
`54`	`57`	`_obsoletePosixFunctions.erase(tok->str());`
`@@ -61,7 +64,6 @@ void CheckObsoleteFunctions::obsoleteFunctions()`
`61`	`64`	`// If checking an old code base it might be uninteresting to update obsolete functions.`
`62`	`65`	`// Therefore this is "information"`
`63`	`66`	`reportError(tok->tokAt(1), Severity::style, "obsoleteFunctions"+it->first, it->second);`
`64`		`- break;`
`65`	`67`	`}`
`66`	`68`	`else`
`67`	`69`	`{`
`@@ -73,7 +75,6 @@ void CheckObsoleteFunctions::obsoleteFunctions()`
`73`	`75`	`// If checking an old code base it might be uninteresting to update obsolete functions.`
`74`	`76`	`// Therefore this is "information"`
`75`	`77`	`reportError(tok->tokAt(1), Severity::style, "obsoleteFunctions"+it->first, it->second);`
`76`		`- break;`
`77`	`78`	`}`
`78`	`79`	`}`
`79`	`80`	`if (_settings->c99)`
`@@ -82,7 +83,6 @@ void CheckObsoleteFunctions::obsoleteFunctions()`
`82`	`83`	`if (it != _obsoleteC99Functions.end())`
`83`	`84`	`{`
`84`	`85`	`reportError(tok->tokAt(1), Severity::style, "obsoleteFunctions"+it->first, it->second);`
`85`		`- break;`
`86`	`86`	`}`
`87`	`87`	`}`
`88`	`88`	`}`