2011-08-18 23:46:31 +02:00
/*
2010-08-31 20:32:26 +02:00
* Cppcheck - A tool for static C / C + + code analysis
2023-01-28 10:16:34 +01:00
* Copyright ( C ) 2007 - 2023 Cppcheck team .
2010-08-31 20:32:26 +02: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
* along with this program . If not , see < http : //www.gnu.org/licenses/>.
*/
2013-09-04 06:18:22 +02:00
# include "cmdlineparser.h"
2017-05-27 04:33:47 +02:00
# include "check.h"
2022-02-23 09:04:35 +01:00
# include "config.h"
2014-05-25 08:47:37 +02:00
# include "cppcheckexecutor.h"
2023-04-30 07:33:19 +02:00
# include "errorlogger.h"
2022-01-27 19:03:20 +01:00
# include "errortypes.h"
2013-09-04 06:18:22 +02:00
# include "filelister.h"
2017-05-27 04:33:47 +02:00
# include "importproject.h"
2013-09-04 06:18:22 +02:00
# include "path.h"
2017-05-27 04:33:47 +02:00
# include "platform.h"
2013-09-04 06:18:22 +02:00
# include "settings.h"
2017-05-27 04:33:47 +02:00
# include "standards.h"
# include "suppressions.h"
# include "timer.h"
2017-04-01 18:27:53 +02:00
# include "utils.h"
2013-09-04 06:18:22 +02:00
2012-01-12 21:21:51 +01:00
# include <algorithm>
2022-01-27 19:03:20 +01:00
# include <climits>
2017-05-27 04:33:47 +02:00
# include <cstdio>
2013-09-04 06:18:22 +02:00
# include <cstdlib> // EXIT_FAILURE
2017-05-27 04:33:47 +02:00
# include <cstring>
2023-03-02 21:50:14 +01:00
# include <fstream> // IWYU pragma: keep
2017-05-27 04:33:47 +02:00
# include <iostream>
2023-03-02 21:50:14 +01:00
# include <iterator>
2017-05-27 04:33:47 +02:00
# include <list>
# include <set>
2022-09-16 07:15:49 +02:00
# include <sstream> // IWYU pragma: keep
2023-03-02 21:50:14 +01:00
# include <unordered_set>
2022-08-14 12:44:19 +02:00
# include <utility>
2010-08-31 20:32:26 +02:00
2011-02-14 19:37:58 +01:00
# ifdef HAVE_RULES
2015-11-15 11:16:12 +01:00
// xml is used for rules
2013-02-16 19:01:34 +01:00
# include <tinyxml2.h>
2011-02-12 08:06:59 +01:00
# endif
2010-08-31 20:32:26 +02:00
2022-12-19 22:28:36 +01:00
static bool addFilesToList ( const std : : string & fileList , std : : vector < std : : string > & pathNames )
2010-08-31 20:32:26 +02:00
{
2019-11-20 15:37:09 +01:00
std : : istream * files ;
std : : ifstream infile ;
if ( fileList = = " - " ) { // read from stdin
files = & std : : cin ;
2011-10-13 20:53:06 +02:00
} else {
2019-11-20 15:37:09 +01:00
infile . open ( fileList ) ;
2022-12-19 22:28:36 +01:00
if ( ! infile . is_open ( ) )
return false ;
2019-11-20 15:37:09 +01:00
files = & infile ;
2011-09-26 11:04:16 +02:00
}
2019-11-20 15:37:09 +01:00
if ( files & & * files ) {
std : : string fileName ;
2022-09-10 11:25:15 +02:00
// cppcheck-suppress accessMoved - FP
2019-11-20 15:37:09 +01:00
while ( std : : getline ( * files , fileName ) ) { // next line
2022-09-10 11:25:15 +02:00
// cppcheck-suppress accessMoved - FP
2019-11-20 15:37:09 +01:00
if ( ! fileName . empty ( ) ) {
2022-09-10 11:25:15 +02:00
pathNames . emplace_back ( std : : move ( fileName ) ) ;
2010-08-31 20:32:26 +02:00
}
}
}
2022-12-19 22:28:36 +01:00
return true ;
2010-08-31 20:32:26 +02:00
}
2023-03-02 22:05:41 +01:00
static bool addIncludePathsToList ( const std : : string & fileList , std : : list < std : : string > & pathNames )
2011-10-22 21:24:23 +02:00
{
2019-11-20 15:37:09 +01:00
std : : ifstream files ( fileList ) ;
if ( files ) {
std : : string pathName ;
2022-09-10 11:25:15 +02:00
// cppcheck-suppress accessMoved - FP
2019-11-20 15:37:09 +01:00
while ( std : : getline ( files , pathName ) ) { // next line
if ( ! pathName . empty ( ) ) {
pathName = Path : : removeQuotationMarks ( pathName ) ;
pathName = Path : : fromNativeSeparators ( pathName ) ;
2012-02-05 15:28:37 +01:00
// If path doesn't end with / or \, add it
2019-11-20 15:37:09 +01:00
if ( ! endsWith ( pathName , ' / ' ) )
pathName + = ' / ' ;
2012-02-05 15:28:37 +01:00
2023-03-02 22:05:41 +01:00
pathNames . emplace_back ( std : : move ( pathName ) ) ;
2011-10-22 21:24:23 +02:00
}
}
2018-09-04 16:37:43 +02:00
return true ;
2011-10-22 21:24:23 +02:00
}
2018-09-04 16:37:43 +02:00
return false ;
2011-10-22 21:24:23 +02:00
}
2023-03-02 22:05:41 +01:00
static bool addPathsToSet ( const std : : string & fileName , std : : set < std : : string > & set )
2014-03-10 15:49:02 +01:00
{
std : : list < std : : string > templist ;
2023-03-02 22:05:41 +01:00
if ( ! addIncludePathsToList ( fileName , templist ) )
2018-09-04 16:37:43 +02:00
return false ;
2023-03-02 22:05:41 +01:00
set . insert ( templist . cbegin ( ) , templist . cend ( ) ) ;
2018-09-04 16:37:43 +02:00
return true ;
2014-03-10 15:49:02 +01:00
}
2023-04-30 20:56:54 +02:00
CmdLineParser : : CmdLineParser ( Settings & settings , Suppressions & suppressions , Suppressions & suppressionsNoFail )
2018-08-18 15:45:42 +02:00
: mSettings ( settings )
2023-04-30 20:56:54 +02:00
, mSuppressions ( suppressions )
, mSuppressionsNoFail ( suppressionsNoFail )
2021-08-07 20:51:18 +02:00
{ }
2010-08-31 20:32:26 +02:00
2018-04-23 12:39:47 +02:00
void CmdLineParser : : printMessage ( const std : : string & message )
2010-09-10 17:39:36 +02:00
{
2021-10-30 13:30:48 +02:00
std : : cout < < " cppcheck: " < < message < < std : : endl ;
2010-09-10 17:39:36 +02:00
}
2021-10-30 13:30:48 +02:00
void CmdLineParser : : printError ( const std : : string & message )
2015-11-20 12:01:04 +01:00
{
2021-10-30 13:30:48 +02:00
printMessage ( " error: " + message ) ;
2015-11-20 12:01:04 +01:00
}
2023-01-27 10:46:48 +01:00
# if defined(_WIN64) || defined(_WIN32)
bool CmdLineParser : : SHOW_DEF_PLATFORM_MSG = true ;
# endif
2022-12-19 22:28:36 +01:00
// TODO: normalize/simplify/native all path parameters
// TODO: error out on all missing given files/paths
2018-04-23 12:39:47 +02:00
bool CmdLineParser : : parseFromArgs ( int argc , const char * const argv [ ] )
2010-08-31 20:32:26 +02:00
{
2023-01-27 10:46:48 +01:00
# if defined(_WIN64) || defined(_WIN32)
bool default_platform = true ;
# endif
2013-06-08 16:46:54 +02:00
bool def = false ;
bool maxconfigs = false ;
2023-05-26 06:55:36 +02:00
mSettings . exename = Path : : getCurrentExecutablePath ( argv [ 0 ] ) ;
2019-04-14 15:00:03 +02:00
2011-10-13 20:53:06 +02:00
for ( int i = 1 ; i < argc ; i + + ) {
2015-11-20 12:01:04 +01:00
if ( argv [ i ] [ 0 ] = = ' - ' ) {
2020-04-26 10:20:56 +02:00
// User define
if ( std : : strncmp ( argv [ i ] , " -D " , 2 ) = = 0 ) {
std : : string define ;
2015-11-20 12:01:04 +01:00
2020-04-26 10:20:56 +02:00
// "-D define"
if ( std : : strcmp ( argv [ i ] , " -D " ) = = 0 ) {
+ + i ;
if ( i > = argc | | argv [ i ] [ 0 ] = = ' - ' ) {
2021-10-30 13:30:48 +02:00
printError ( " argument to '-D' is missing. " ) ;
2020-04-26 10:20:56 +02:00
return false ;
}
2019-01-14 08:29:32 +01:00
2020-04-26 10:20:56 +02:00
define = argv [ i ] ;
}
// "-Ddefine"
else {
define = 2 + argv [ i ] ;
}
2015-11-20 12:01:04 +01:00
2020-04-26 10:20:56 +02:00
// No "=", append a "=1"
if ( define . find ( ' = ' ) = = std : : string : : npos )
define + = " =1 " ;
2019-02-03 17:51:02 +01:00
2023-03-07 12:11:21 +01:00
if ( ! mSettings . userDefines . empty ( ) )
mSettings . userDefines + = " ; " ;
mSettings . userDefines + = define ;
2019-02-09 14:40:50 +01:00
2020-04-26 10:20:56 +02:00
def = true ;
2015-11-20 12:01:04 +01:00
}
2020-04-26 10:20:56 +02:00
// -E
else if ( std : : strcmp ( argv [ i ] , " -E " ) = = 0 ) {
2023-03-07 12:11:21 +01:00
mSettings . preprocessOnly = true ;
mSettings . quiet = true ;
2020-04-26 10:20:56 +02:00
}
2015-11-20 12:01:04 +01:00
2020-04-26 10:20:56 +02:00
// Include paths
else if ( std : : strncmp ( argv [ i ] , " -I " , 2 ) = = 0 ) {
std : : string path ;
2020-02-12 16:30:18 +01:00
2020-04-26 10:20:56 +02:00
// "-I path/"
if ( std : : strcmp ( argv [ i ] , " -I " ) = = 0 ) {
+ + i ;
2015-11-20 12:01:04 +01:00
if ( i > = argc | | argv [ i ] [ 0 ] = = ' - ' ) {
2021-10-30 13:30:48 +02:00
printError ( " argument to '-I' is missing. " ) ;
2015-11-20 12:01:04 +01:00
return false ;
}
2020-04-26 10:20:56 +02:00
path = argv [ i ] ;
2015-11-20 12:01:04 +01:00
}
2014-03-16 12:04:13 +01:00
2020-04-26 10:20:56 +02:00
// "-Ipath/"
2015-11-20 12:01:04 +01:00
else {
2020-04-26 10:20:56 +02:00
path = 2 + argv [ i ] ;
2012-09-11 08:53:27 +02:00
}
2020-04-26 10:20:56 +02:00
path = Path : : removeQuotationMarks ( path ) ;
path = Path : : fromNativeSeparators ( path ) ;
2012-09-11 08:53:27 +02:00
2020-04-26 10:20:56 +02:00
// If path doesn't end with / or \, add it
if ( ! endsWith ( path , ' / ' ) )
path + = ' / ' ;
2012-09-10 18:51:32 +02:00
2023-03-07 12:11:21 +01:00
mSettings . includePaths . emplace_back ( std : : move ( path ) ) ;
2010-12-04 13:13:44 +01:00
}
2020-04-26 10:20:56 +02:00
// User undef
else if ( std : : strncmp ( argv [ i ] , " -U " , 2 ) = = 0 ) {
std : : string undef ;
// "-U undef"
if ( std : : strcmp ( argv [ i ] , " -U " ) = = 0 ) {
+ + i ;
if ( i > = argc | | argv [ i ] [ 0 ] = = ' - ' ) {
2021-10-30 13:30:48 +02:00
printError ( " argument to '-U' is missing. " ) ;
2020-04-26 10:20:56 +02:00
return false ;
2015-11-20 12:01:04 +01:00
}
2012-01-12 21:21:51 +01:00
2020-04-26 10:20:56 +02:00
undef = argv [ i ] ;
2015-11-20 12:01:04 +01:00
}
2020-04-26 10:20:56 +02:00
// "-Uundef"
else {
undef = 2 + argv [ i ] ;
2015-11-20 12:01:04 +01:00
}
2011-01-28 12:18:07 +01:00
2023-03-07 12:11:21 +01:00
mSettings . userUndefs . insert ( std : : move ( undef ) ) ;
2018-04-09 06:43:48 +02:00
}
2020-04-26 10:20:56 +02:00
else if ( std : : strncmp ( argv [ i ] , " --addon= " , 8 ) = = 0 )
2023-03-07 12:11:21 +01:00
mSettings . addons . emplace ( argv [ i ] + 8 ) ;
2011-02-16 10:26:40 +01:00
2020-04-26 10:20:56 +02:00
else if ( std : : strncmp ( argv [ i ] , " --addon-python= " , 15 ) = = 0 )
2023-03-07 12:11:21 +01:00
mSettings . addonPython . assign ( argv [ i ] + 15 ) ;
2015-11-20 12:01:04 +01:00
2020-04-26 10:20:56 +02:00
// Check configuration
else if ( std : : strcmp ( argv [ i ] , " --check-config " ) = = 0 )
2023-03-07 12:11:21 +01:00
mSettings . checkConfiguration = true ;
2015-11-20 12:01:04 +01:00
2023-04-09 13:48:13 +02:00
// Check code exhaustively
else if ( std : : strcmp ( argv [ i ] , " --check-level=exhaustive " ) = = 0 )
mSettings . setCheckLevelExhaustive ( ) ;
// Check code with normal analysis
else if ( std : : strcmp ( argv [ i ] , " --check-level=normal " ) = = 0 )
mSettings . setCheckLevelNormal ( ) ;
2020-04-26 10:20:56 +02:00
// Check library definitions
2021-01-12 20:53:05 +01:00
else if ( std : : strcmp ( argv [ i ] , " --check-library " ) = = 0 ) {
2023-03-07 12:11:21 +01:00
mSettings . checkLibrary = true ;
2021-01-12 20:53:05 +01:00
}
2011-02-02 13:04:50 +01:00
2022-12-30 21:21:05 +01:00
else if ( std : : strncmp ( argv [ i ] , " --checks-max-time= " , 18 ) = = 0 ) {
2023-06-28 19:52:33 +02:00
if ( ! parseNumberArg ( argv [ i ] , 18 , mSettings . checksMaxTime , true ) )
2023-04-08 22:29:09 +02:00
return false ;
2022-12-30 21:21:05 +01:00
}
2022-08-20 20:54:31 +02:00
else if ( std : : strcmp ( argv [ i ] , " --clang " ) = = 0 ) {
2023-03-07 12:11:21 +01:00
mSettings . clang = true ;
2022-08-20 20:54:31 +02:00
}
else if ( std : : strncmp ( argv [ i ] , " --clang= " , 8 ) = = 0 ) {
2023-03-07 12:11:21 +01:00
mSettings . clang = true ;
mSettings . clangExecutable = argv [ i ] + 8 ;
2020-09-06 07:46:51 +02:00
}
2017-05-30 15:04:28 +02:00
2020-04-26 10:20:56 +02:00
else if ( std : : strncmp ( argv [ i ] , " --config-exclude= " , 17 ) = = 0 ) {
2023-03-07 12:11:21 +01:00
mSettings . configExcludePaths . insert ( Path : : fromNativeSeparators ( argv [ i ] + 17 ) ) ;
2017-05-16 14:07:23 +02:00
}
2020-04-26 10:20:56 +02:00
else if ( std : : strncmp ( argv [ i ] , " --config-excludes-file= " , 23 ) = = 0 ) {
// open this file and read every input file (1 file name per line)
const std : : string cfgExcludesFile ( 23 + argv [ i ] ) ;
2023-03-07 12:11:21 +01:00
if ( ! addPathsToSet ( cfgExcludesFile , mSettings . configExcludePaths ) ) {
2021-10-30 13:30:48 +02:00
printError ( " unable to open config excludes file at ' " + cfgExcludesFile + " ' " ) ;
2015-11-20 12:01:04 +01:00
return false ;
}
2020-04-26 10:20:56 +02:00
}
2010-08-31 20:32:26 +02:00
2020-04-26 10:20:56 +02:00
else if ( std : : strncmp ( argv [ i ] , " --cppcheck-build-dir= " , 21 ) = = 0 ) {
2023-03-07 12:11:21 +01:00
mSettings . buildDir = Path : : fromNativeSeparators ( argv [ i ] + 21 ) ;
if ( endsWith ( mSettings . buildDir , ' / ' ) )
mSettings . buildDir . pop_back ( ) ;
2023-08-04 17:38:43 +02:00
2023-08-23 11:22:41 +02:00
if ( ! Path : : isDirectory ( mSettings . buildDir ) ) {
2023-08-04 17:38:43 +02:00
printError ( " Directory ' " + mSettings . buildDir + " ' specified by --cppcheck-build-dir argument has to be existent. " ) ;
return false ;
}
2011-11-12 10:43:26 +01:00
}
2010-08-31 20:32:26 +02:00
2020-04-26 10:20:56 +02:00
// Show --debug output after the first simplifications
else if ( std : : strcmp ( argv [ i ] , " --debug " ) = = 0 | |
std : : strcmp ( argv [ i ] , " --debug-normal " ) = = 0 )
2023-03-07 12:11:21 +01:00
mSettings . debugnormal = true ;
2020-01-10 08:57:37 +01:00
2020-05-30 11:23:22 +02:00
// Flag used for various purposes during debugging
else if ( std : : strcmp ( argv [ i ] , " --debug-simplified " ) = = 0 )
2023-03-07 12:11:21 +01:00
mSettings . debugSimplified = true ;
2020-05-30 11:23:22 +02:00
2020-04-26 10:20:56 +02:00
// Show template information
else if ( std : : strcmp ( argv [ i ] , " --debug-template " ) = = 0 )
2023-03-07 12:11:21 +01:00
mSettings . debugtemplate = true ;
2010-08-31 20:32:26 +02:00
2020-04-26 10:20:56 +02:00
// Show debug warnings
else if ( std : : strcmp ( argv [ i ] , " --debug-warnings " ) = = 0 )
2023-03-07 12:11:21 +01:00
mSettings . debugwarnings = true ;
2020-04-26 10:20:56 +02:00
2023-01-21 10:39:44 +01:00
else if ( std : : strncmp ( argv [ i ] , " --disable= " , 10 ) = = 0 ) {
2023-03-07 12:11:21 +01:00
const std : : string errmsg = mSettings . removeEnabled ( argv [ i ] + 10 ) ;
2023-01-21 10:39:44 +01:00
if ( ! errmsg . empty ( ) ) {
printError ( errmsg ) ;
return false ;
}
}
2020-04-26 10:20:56 +02:00
// documentation..
else if ( std : : strcmp ( argv [ i ] , " --doc " ) = = 0 ) {
std : : ostringstream doc ;
// Get documentation..
for ( const Check * it : Check : : instances ( ) ) {
const std : : string & name ( it - > name ( ) ) ;
const std : : string info ( it - > classInfo ( ) ) ;
if ( ! name . empty ( ) & & ! info . empty ( ) )
doc < < " ## " < < name < < " ## \n "
< < info < < " \n " ;
}
std : : cout < < doc . str ( ) ;
mExitAfterPrint = true ;
return true ;
2015-11-20 12:01:04 +01:00
}
2011-01-17 20:03:22 +01:00
2020-04-26 10:20:56 +02:00
// dump cppcheck data
else if ( std : : strcmp ( argv [ i ] , " --dump " ) = = 0 )
2023-03-07 12:11:21 +01:00
mSettings . dump = true ;
2020-04-26 10:20:56 +02:00
2015-11-20 12:01:04 +01:00
else if ( std : : strncmp ( argv [ i ] , " --enable= " , 9 ) = = 0 ) {
2023-01-21 10:39:44 +01:00
const std : : string enable_arg = argv [ i ] + 9 ;
2023-03-07 12:11:21 +01:00
const std : : string errmsg = mSettings . addEnabled ( enable_arg ) ;
2015-11-20 12:01:04 +01:00
if ( ! errmsg . empty ( ) ) {
2021-10-30 13:30:48 +02:00
printError ( errmsg ) ;
2011-01-17 20:03:22 +01:00
return false ;
}
2015-11-20 12:01:04 +01:00
// when "style" is enabled, also enable "warning", "performance" and "portability"
2023-01-21 10:39:44 +01:00
if ( enable_arg . find ( " style " ) ! = std : : string : : npos ) {
2023-03-07 12:11:21 +01:00
mSettings . addEnabled ( " warning " ) ;
mSettings . addEnabled ( " performance " ) ;
mSettings . addEnabled ( " portability " ) ;
2015-11-20 12:01:04 +01:00
}
2023-03-09 20:04:20 +01:00
if ( enable_arg . find ( " information " ) ! = std : : string : : npos ) {
2023-03-10 00:39:29 +01:00
mSettings . addEnabled ( " missingInclude " ) ;
2023-03-09 20:04:20 +01:00
printMessage ( " '--enable=information' will no longer implicitly enable 'missingInclude' starting with 2.16. Please enable it explicitly if you require it. " ) ;
}
2011-01-17 20:03:22 +01:00
}
2015-11-20 12:01:04 +01:00
2020-04-26 10:20:56 +02:00
// print all possible error messages..
else if ( std : : strcmp ( argv [ i ] , " --errorlist " ) = = 0 ) {
mShowErrorMessages = true ;
2023-03-07 12:11:21 +01:00
mSettings . xml = true ;
2020-04-26 10:20:56 +02:00
mExitAfterPrint = true ;
}
2015-11-20 12:01:04 +01:00
// --error-exitcode=1
else if ( std : : strncmp ( argv [ i ] , " --error-exitcode= " , 17 ) = = 0 ) {
2023-04-08 22:29:09 +02:00
if ( ! parseNumberArg ( argv [ i ] , 17 , mSettings . exitCode ) )
2015-11-20 12:01:04 +01:00
return false ;
2011-01-17 20:03:22 +01:00
}
2020-04-26 10:20:56 +02:00
// Exception handling inside cppcheck client
2022-08-20 20:54:31 +02:00
else if ( std : : strcmp ( argv [ i ] , " --exception-handling " ) = = 0 ) {
2023-03-07 12:11:21 +01:00
mSettings . exceptionHandling = true ;
2022-08-20 20:54:31 +02:00
}
2010-08-31 20:32:26 +02:00
2022-08-20 20:54:31 +02:00
// Exception handling inside cppcheck client
2020-04-26 10:20:56 +02:00
else if ( std : : strncmp ( argv [ i ] , " --exception-handling= " , 21 ) = = 0 ) {
2022-08-20 20:54:31 +02:00
const std : : string exceptionOutfilename = argv [ i ] + 21 ;
if ( exceptionOutfilename ! = " stderr " & & exceptionOutfilename ! = " stdout " ) {
printError ( " invalid '--exception-handling' argument " ) ;
return false ;
}
2023-03-07 12:11:21 +01:00
mSettings . exceptionHandling = true ;
2022-08-20 20:54:31 +02:00
CppCheckExecutor : : setExceptionOutput ( ( exceptionOutfilename = = " stderr " ) ? stderr : stdout ) ;
2016-01-02 11:48:36 +01:00
}
2020-04-26 10:20:56 +02:00
// Filter errors
else if ( std : : strncmp ( argv [ i ] , " --exitcode-suppressions= " , 24 ) = = 0 ) {
// exitcode-suppressions=filename.txt
std : : string filename = 24 + argv [ i ] ;
2011-01-31 14:25:51 +01:00
2020-04-26 10:20:56 +02:00
std : : ifstream f ( filename ) ;
if ( ! f . is_open ( ) ) {
2021-10-30 13:30:48 +02:00
printError ( " couldn't open the file: \" " + filename + " \" . " ) ;
2018-09-04 16:37:43 +02:00
return false ;
}
2023-04-30 20:56:54 +02:00
const std : : string errmsg ( mSuppressionsNoFail . parseFile ( f ) ) ;
2020-04-26 10:20:56 +02:00
if ( ! errmsg . empty ( ) ) {
2021-10-30 13:30:48 +02:00
printError ( errmsg ) ;
2018-09-04 16:37:43 +02:00
return false ;
}
2011-01-31 14:25:51 +01:00
}
2020-04-26 10:20:56 +02:00
// use a file filter
else if ( std : : strncmp ( argv [ i ] , " --file-filter= " , 14 ) = = 0 )
2023-03-07 12:11:21 +01:00
mSettings . fileFilters . emplace_back ( argv [ i ] + 14 ) ;
2020-04-26 10:20:56 +02:00
2015-11-20 12:01:04 +01:00
// file list specified
2022-12-19 22:28:36 +01:00
else if ( std : : strncmp ( argv [ i ] , " --file-list= " , 12 ) = = 0 ) {
2015-11-20 12:01:04 +01:00
// open this file and read every input file (1 file name per line)
2022-12-19 22:28:36 +01:00
const std : : string fileList = argv [ i ] + 12 ;
if ( ! addFilesToList ( fileList , mPathNames ) ) {
printError ( " couldn't open the file: \" " + fileList + " \" . " ) ;
return false ;
}
}
2020-04-26 10:20:56 +02:00
// Force checking of files that have "too many" configurations
else if ( std : : strcmp ( argv [ i ] , " -f " ) = = 0 | | std : : strcmp ( argv [ i ] , " --force " ) = = 0 )
2023-03-07 12:11:21 +01:00
mSettings . force = true ;
2020-04-26 10:20:56 +02:00
// Print help
else if ( std : : strcmp ( argv [ i ] , " -h " ) = = 0 | | std : : strcmp ( argv [ i ] , " --help " ) = = 0 ) {
mPathNames . clear ( ) ;
mShowHelp = true ;
mExitAfterPrint = true ;
break ;
2011-01-31 14:25:51 +01:00
}
2015-11-20 12:01:04 +01:00
// Ignored paths
else if ( std : : strncmp ( argv [ i ] , " -i " , 2 ) = = 0 ) {
std : : string path ;
2011-01-31 14:25:51 +01:00
2015-11-20 12:01:04 +01:00
// "-i path/"
if ( std : : strcmp ( argv [ i ] , " -i " ) = = 0 ) {
+ + i ;
if ( i > = argc | | argv [ i ] [ 0 ] = = ' - ' ) {
2021-10-30 13:30:48 +02:00
printError ( " argument to '-i' is missing. " ) ;
2015-11-20 12:01:04 +01:00
return false ;
}
path = argv [ i ] ;
2011-02-03 13:43:42 +01:00
}
2011-01-31 14:25:51 +01:00
2015-11-20 12:01:04 +01:00
// "-ipath/"
else {
path = 2 + argv [ i ] ;
}
2010-08-31 20:32:26 +02:00
2015-11-20 12:01:04 +01:00
if ( ! path . empty ( ) ) {
path = Path : : removeQuotationMarks ( path ) ;
path = Path : : fromNativeSeparators ( path ) ;
path = Path : : simplifyPath ( path ) ;
2011-10-16 12:54:58 +02:00
2023-08-23 11:22:41 +02:00
if ( Path : : isDirectory ( path ) ) {
2015-11-20 12:01:04 +01:00
// If directory name doesn't end with / or \, add it
2018-03-30 21:04:32 +02:00
if ( ! endsWith ( path , ' / ' ) )
2015-11-20 12:01:04 +01:00
path + = ' / ' ;
}
2022-09-10 11:25:15 +02:00
mIgnoredPaths . emplace_back ( std : : move ( path ) ) ;
2015-11-20 12:01:04 +01:00
}
2010-08-31 20:32:26 +02:00
}
2016-08-07 15:45:36 +02:00
2020-04-26 10:20:56 +02:00
else if ( std : : strncmp ( argv [ i ] , " --include= " , 10 ) = = 0 ) {
2023-03-07 12:11:21 +01:00
mSettings . userIncludes . emplace_back ( Path : : fromNativeSeparators ( argv [ i ] + 10 ) ) ;
2020-04-26 10:20:56 +02:00
}
else if ( std : : strncmp ( argv [ i ] , " --includes-file= " , 16 ) = = 0 ) {
// open this file and read every input file (1 file name per line)
const std : : string includesFile ( 16 + argv [ i ] ) ;
2023-03-07 12:11:21 +01:00
if ( ! addIncludePathsToList ( includesFile , mSettings . includePaths ) ) {
2021-10-30 13:30:48 +02:00
printError ( " unable to open includes file at ' " + includesFile + " ' " ) ;
2020-04-26 10:20:56 +02:00
return false ;
}
}
// Inconclusive checking
else if ( std : : strcmp ( argv [ i ] , " --inconclusive " ) = = 0 )
2023-03-07 12:11:21 +01:00
mSettings . certainty . enable ( Certainty : : inconclusive ) ;
2020-04-26 10:20:56 +02:00
// Enables inline suppressions.
else if ( std : : strcmp ( argv [ i ] , " --inline-suppr " ) = = 0 )
2023-03-07 12:11:21 +01:00
mSettings . inlineSuppressions = true ;
2020-04-26 10:20:56 +02:00
// Checking threads
else if ( std : : strncmp ( argv [ i ] , " -j " , 2 ) = = 0 ) {
std : : string numberString ;
// "-j 3"
if ( std : : strcmp ( argv [ i ] , " -j " ) = = 0 ) {
+ + i ;
if ( i > = argc | | argv [ i ] [ 0 ] = = ' - ' ) {
2021-10-30 13:30:48 +02:00
printError ( " argument to '-j' is missing. " ) ;
2020-04-26 10:20:56 +02:00
return false ;
}
numberString = argv [ i ] ;
}
// "-j3"
else
numberString = argv [ i ] + 2 ;
2023-04-08 22:29:09 +02:00
unsigned int tmp ;
std : : string err ;
if ( ! strToInt ( numberString , tmp , & err ) ) {
printError ( " argument to '-j' is not valid - " + err + " . " ) ;
2020-04-26 10:20:56 +02:00
return false ;
}
2023-08-14 11:55:32 +02:00
if ( tmp = = 0 ) {
// TODO: implement get CPU logical core count and use that.
// Usually, -j 0 would mean "use all available cores," but
// if we get a 0, we just stall and don't do any work.
printError ( " argument for '-j' must be greater than 0. " ) ;
return false ;
}
if ( tmp > 1024 ) {
// Almost nobody has 1024 logical cores, but somebody out
// there does.
printError ( " argument for '-j' is allowed to be 1024 at max. " ) ;
2020-04-26 10:20:56 +02:00
return false ;
}
2023-04-08 22:29:09 +02:00
mSettings . jobs = tmp ;
2020-04-26 10:20:56 +02:00
}
2022-02-23 09:04:35 +01:00
# ifdef THREADING_MODEL_FORK
2020-04-26 10:20:56 +02:00
else if ( std : : strncmp ( argv [ i ] , " -l " , 2 ) = = 0 ) {
std : : string numberString ;
// "-l 3"
if ( std : : strcmp ( argv [ i ] , " -l " ) = = 0 ) {
+ + i ;
if ( i > = argc | | argv [ i ] [ 0 ] = = ' - ' ) {
2021-10-30 13:30:48 +02:00
printError ( " argument to '-l' is missing. " ) ;
2020-04-26 10:20:56 +02:00
return false ;
}
numberString = argv [ i ] ;
}
// "-l3"
else
numberString = argv [ i ] + 2 ;
2023-04-08 22:29:09 +02:00
int tmp ;
std : : string err ;
if ( ! strToInt ( numberString , tmp , & err ) ) {
printError ( " argument to '-l' is not valid - " + err + " . " ) ;
2020-04-26 10:20:56 +02:00
return false ;
}
2023-04-08 22:29:09 +02:00
mSettings . loadAverage = tmp ;
2020-04-26 10:20:56 +02:00
}
2022-02-23 09:04:35 +01:00
# endif
2020-04-26 10:20:56 +02:00
// Enforce language (--language=, -x)
else if ( std : : strncmp ( argv [ i ] , " --language= " , 11 ) = = 0 | | std : : strcmp ( argv [ i ] , " -x " ) = = 0 ) {
std : : string str ;
if ( argv [ i ] [ 2 ] ) {
str = argv [ i ] + 11 ;
} else {
i + + ;
if ( i > = argc | | argv [ i ] [ 0 ] = = ' - ' ) {
2021-10-30 13:30:48 +02:00
printError ( " no language given to '-x' option. " ) ;
2020-04-26 10:20:56 +02:00
return false ;
}
str = argv [ i ] ;
}
if ( str = = " c " )
2023-03-07 12:11:21 +01:00
mSettings . enforcedLang = Settings : : Language : : C ;
2020-04-26 10:20:56 +02:00
else if ( str = = " c++ " )
2023-03-07 12:11:21 +01:00
mSettings . enforcedLang = Settings : : Language : : CPP ;
2020-04-26 10:20:56 +02:00
else {
2021-10-30 13:30:48 +02:00
printError ( " unknown language ' " + str + " ' enforced. " ) ;
2020-04-26 10:20:56 +02:00
return false ;
}
}
2015-11-20 12:01:04 +01:00
// --library
else if ( std : : strncmp ( argv [ i ] , " --library= " , 10 ) = = 0 ) {
2023-03-07 12:11:21 +01:00
mSettings . libraries . emplace_back ( argv [ i ] + 10 ) ;
2015-11-20 12:01:04 +01:00
}
2010-08-31 20:32:26 +02:00
2020-04-26 10:20:56 +02:00
// Set maximum number of #ifdef configurations to check
else if ( std : : strncmp ( argv [ i ] , " --max-configs= " , 14 ) = = 0 ) {
2023-04-08 22:29:09 +02:00
int tmp ;
if ( ! parseNumberArg ( argv [ i ] , 14 , tmp ) )
2020-04-26 10:20:56 +02:00
return false ;
2023-04-08 22:29:09 +02:00
if ( tmp < 1 ) {
2021-10-30 13:30:48 +02:00
printError ( " argument to '--max-configs=' must be greater than 0. " ) ;
2020-04-26 10:20:56 +02:00
return false ;
}
2023-04-08 22:29:09 +02:00
mSettings . maxConfigs = tmp ;
mSettings . force = false ;
2020-04-26 10:20:56 +02:00
maxconfigs = true ;
}
// max ctu depth
2023-04-08 22:29:09 +02:00
else if ( std : : strncmp ( argv [ i ] , " --max-ctu-depth= " , 16 ) = = 0 ) {
if ( ! parseNumberArg ( argv [ i ] , 16 , mSettings . maxCtuDepth ) )
return false ;
}
2020-04-26 10:20:56 +02:00
// Write results in file
else if ( std : : strncmp ( argv [ i ] , " --output-file= " , 14 ) = = 0 )
2023-03-07 12:11:21 +01:00
mSettings . outputFile = Path : : simplifyPath ( Path : : fromNativeSeparators ( argv [ i ] + 14 ) ) ;
2020-04-26 10:20:56 +02:00
2022-10-04 14:02:55 +02:00
// Experimental: limit execution time for extended valueflow analysis. basic valueflow analysis
// is always executed.
2023-04-08 22:29:09 +02:00
else if ( std : : strncmp ( argv [ i ] , " --performance-valueflow-max-time= " , 33 ) = = 0 ) {
if ( ! parseNumberArg ( argv [ i ] , 33 , mSettings . performanceValueFlowMaxTime , true ) )
return false ;
}
2022-10-04 14:02:55 +02:00
2023-04-08 22:29:09 +02:00
else if ( std : : strncmp ( argv [ i ] , " --performance-valueflow-max-if-count= " , 37 ) = = 0 ) {
if ( ! parseNumberArg ( argv [ i ] , 37 , mSettings . performanceValueFlowMaxIfCount , true ) )
return false ;
}
2023-04-01 20:58:15 +02:00
2020-04-26 10:20:56 +02:00
// Specify platform
else if ( std : : strncmp ( argv [ i ] , " --platform= " , 11 ) = = 0 ) {
const std : : string platform ( 11 + argv [ i ] ) ;
2023-02-08 20:30:43 +01:00
std : : string errstr ;
const std : : vector < std : : string > paths = { argv [ 0 ] } ;
2023-03-07 12:11:21 +01:00
if ( ! mSettings . platform . set ( platform , errstr , paths ) ) {
2023-02-08 20:30:43 +01:00
printError ( errstr ) ;
2020-04-26 10:20:56 +02:00
return false ;
}
2023-01-26 22:05:40 +01:00
2023-01-27 10:46:48 +01:00
# if defined(_WIN64) || defined(_WIN32)
default_platform = false ;
# endif
2023-01-26 22:05:40 +01:00
// TODO: remove
// these are loaded via external files and thus have Settings::PlatformFile set instead.
// override the type so they behave like the regular platforms.
if ( platform = = " unix32-unsigned " )
2023-03-07 12:11:21 +01:00
mSettings . platform . type = cppcheck : : Platform : : Type : : Unix32 ;
2023-01-26 22:05:40 +01:00
else if ( platform = = " unix64-unsigned " )
2023-03-07 12:11:21 +01:00
mSettings . platform . type = cppcheck : : Platform : : Type : : Unix64 ;
2020-04-26 10:20:56 +02:00
}
// Write results in results.plist
else if ( std : : strncmp ( argv [ i ] , " --plist-output= " , 15 ) = = 0 ) {
2023-03-07 12:11:21 +01:00
mSettings . plistOutput = Path : : simplifyPath ( Path : : fromNativeSeparators ( argv [ i ] + 15 ) ) ;
if ( mSettings . plistOutput . empty ( ) )
mSettings . plistOutput = " ./ " ;
else if ( ! endsWith ( mSettings . plistOutput , ' / ' ) )
mSettings . plistOutput + = ' / ' ;
2020-11-13 15:52:24 +01:00
2023-03-07 12:11:21 +01:00
const std : : string plistOutput = Path : : toNativeSeparators ( mSettings . plistOutput ) ;
2023-08-23 11:22:41 +02:00
if ( ! Path : : isDirectory ( plistOutput ) ) {
2021-10-30 13:30:48 +02:00
std : : string message ( " plist folder does not exist: \" " ) ;
2020-11-13 15:52:57 +01:00
message + = plistOutput ;
message + = " \" . " ;
2021-10-30 13:30:48 +02:00
printError ( message ) ;
2020-11-13 15:52:57 +01:00
return false ;
2020-11-13 15:52:24 +01:00
}
2020-04-26 10:20:56 +02:00
}
2022-08-24 08:46:35 +02:00
// Special Cppcheck Premium options
else if ( std : : strncmp ( argv [ i ] , " --premium= " , 10 ) = = 0 & & isCppcheckPremium ( ) ) {
2023-03-07 12:11:21 +01:00
if ( ! mSettings . premiumArgs . empty ( ) )
mSettings . premiumArgs + = " " ;
2022-10-31 15:04:16 +01:00
const std : : string p ( argv [ i ] + 10 ) ;
2023-03-07 12:11:21 +01:00
mSettings . premiumArgs + = " -- " + p ;
2023-08-23 10:28:02 +02:00
if ( p = = " misra-c-2012 " | | p = = " misra-c-2023 " )
2023-03-07 12:11:21 +01:00
mSettings . addons . emplace ( " misra " ) ;
2022-08-24 08:46:35 +02:00
}
2016-08-13 10:50:03 +02:00
// --project
else if ( std : : strncmp ( argv [ i ] , " --project= " , 10 ) = = 0 ) {
2023-03-07 12:11:21 +01:00
mSettings . checkAllConfigurations = false ; // Can be overridden with --max-configs or --force
2023-02-08 20:30:43 +01:00
std : : string projectFile = argv [ i ] + 10 ;
2023-03-07 12:11:21 +01:00
ImportProject : : Type projType = mSettings . project . import ( projectFile , & mSettings ) ;
mSettings . project . projectType = projType ;
2019-01-31 20:40:15 +01:00
if ( projType = = ImportProject : : Type : : CPPCHECK_GUI ) {
2023-03-07 12:11:21 +01:00
mPathNames = mSettings . project . guiProject . pathNames ;
for ( const std : : string & lib : mSettings . project . guiProject . libraries )
mSettings . libraries . emplace_back ( lib ) ;
2019-01-31 20:40:15 +01:00
2023-03-07 12:11:21 +01:00
const auto & excludedPaths = mSettings . project . guiProject . excludedPaths ;
2022-12-30 15:13:47 +01:00
std : : copy ( excludedPaths . cbegin ( ) , excludedPaths . cend ( ) , std : : back_inserter ( mIgnoredPaths ) ) ;
2019-04-07 12:31:52 +02:00
2023-03-07 12:11:21 +01:00
std : : string platform ( mSettings . project . guiProject . platform ) ;
2023-02-08 20:30:43 +01:00
// keep existing platform from command-line intact
if ( ! platform . empty ( ) ) {
if ( platform = = " Unspecified " ) {
printMessage ( " 'Unspecified' is a deprecated platform type and will be removed in Cppcheck 2.14. Please use 'unspecified' instead. " ) ;
platform = " unspecified " ;
}
std : : string errstr ;
const std : : vector < std : : string > paths = { projectFile , argv [ 0 ] } ;
2023-03-07 12:11:21 +01:00
if ( ! mSettings . platform . set ( platform , errstr , paths ) ) {
2023-02-08 20:30:43 +01:00
printError ( errstr ) ;
return false ;
}
2019-01-31 20:40:15 +01:00
}
2023-03-07 12:11:21 +01:00
if ( ! mSettings . project . guiProject . projectFile . empty ( ) ) {
projectFile = mSettings . project . guiProject . projectFile ;
projType = mSettings . project . import ( mSettings . project . guiProject . projectFile , & mSettings ) ;
2023-02-08 20:30:43 +01:00
}
2019-01-31 20:40:15 +01:00
}
if ( projType = = ImportProject : : Type : : VS_SLN | | projType = = ImportProject : : Type : : VS_VCXPROJ ) {
2023-03-07 12:11:21 +01:00
if ( mSettings . project . guiProject . analyzeAllVsConfigs = = " false " )
mSettings . project . selectOneVsConfig ( mSettings . platform . type ) ;
if ( ! CppCheckExecutor : : tryLoadLibrary ( mSettings . library , argv [ 0 ] , " windows.cfg " ) ) {
2017-08-22 17:09:02 +02:00
// This shouldn't happen normally.
2021-10-30 13:30:48 +02:00
printError ( " failed to load 'windows.cfg'. Your Cppcheck installation is broken. Please re-install. " ) ;
2017-08-22 17:09:02 +02:00
return false ;
}
}
2019-01-31 20:40:15 +01:00
if ( projType = = ImportProject : : Type : : MISSING ) {
2021-12-19 12:36:11 +01:00
printError ( " failed to open project ' " + projectFile + " '. The file does not exist. " ) ;
2018-07-25 16:26:25 +02:00
return false ;
}
2019-01-31 20:40:15 +01:00
if ( projType = = ImportProject : : Type : : UNKNOWN ) {
2021-10-30 13:30:48 +02:00
printError ( " failed to load project ' " + projectFile + " '. The format is unknown. " ) ;
2018-07-25 16:26:25 +02:00
return false ;
}
2021-12-19 12:36:11 +01:00
if ( projType = = ImportProject : : Type : : FAILURE ) {
printError ( " failed to load project ' " + projectFile + " '. An error occurred. " ) ;
return false ;
}
2016-08-13 10:50:03 +02:00
}
2020-04-19 18:19:28 +02:00
// --project-configuration
else if ( std : : strncmp ( argv [ i ] , " --project-configuration= " , 24 ) = = 0 ) {
mVSConfig = argv [ i ] + 24 ;
2023-03-07 12:11:21 +01:00
if ( ! mVSConfig . empty ( ) & & ( mSettings . project . projectType = = ImportProject : : Type : : VS_SLN | | mSettings . project . projectType = = ImportProject : : Type : : VS_VCXPROJ ) )
mSettings . project . ignoreOtherConfigs ( mVSConfig ) ;
2020-04-19 18:19:28 +02:00
}
2020-04-26 10:20:56 +02:00
// Only print something when there are errors
else if ( std : : strcmp ( argv [ i ] , " -q " ) = = 0 | | std : : strcmp ( argv [ i ] , " --quiet " ) = = 0 )
2023-03-07 12:11:21 +01:00
mSettings . quiet = true ;
2020-04-26 10:20:56 +02:00
// Output relative paths
else if ( std : : strcmp ( argv [ i ] , " -rp " ) = = 0 | | std : : strcmp ( argv [ i ] , " --relative-paths " ) = = 0 )
2023-03-07 12:11:21 +01:00
mSettings . relativePaths = true ;
2020-04-26 10:20:56 +02:00
else if ( std : : strncmp ( argv [ i ] , " -rp= " , 4 ) = = 0 | | std : : strncmp ( argv [ i ] , " --relative-paths= " , 17 ) = = 0 ) {
2023-03-07 12:11:21 +01:00
mSettings . relativePaths = true ;
2020-04-26 10:20:56 +02:00
if ( argv [ i ] [ argv [ i ] [ 3 ] = = ' = ' ? 4 : 17 ] ! = 0 ) {
std : : string paths = argv [ i ] + ( argv [ i ] [ 3 ] = = ' = ' ? 4 : 17 ) ;
for ( ; ; ) {
const std : : string : : size_type pos = paths . find ( ' ; ' ) ;
if ( pos = = std : : string : : npos ) {
2023-03-07 12:11:21 +01:00
mSettings . basePaths . emplace_back ( Path : : fromNativeSeparators ( paths ) ) ;
2020-04-26 10:20:56 +02:00
break ;
}
2023-03-07 12:11:21 +01:00
mSettings . basePaths . emplace_back ( Path : : fromNativeSeparators ( paths . substr ( 0 , pos ) ) ) ;
2020-04-26 10:20:56 +02:00
paths . erase ( 0 , pos + 1 ) ;
}
} else {
2021-10-30 13:30:48 +02:00
printError ( " no paths specified for the ' " + std : : string ( argv [ i ] ) + " ' option. " ) ;
2020-04-26 10:20:56 +02:00
return false ;
}
}
2015-11-20 12:01:04 +01:00
// Report progress
else if ( std : : strcmp ( argv [ i ] , " --report-progress " ) = = 0 ) {
2023-08-23 11:20:20 +02:00
mSettings . reportProgress = 10 ;
}
else if ( std : : strncmp ( argv [ i ] , " --report-progress= " , 18 ) = = 0 ) {
int tmp ;
if ( ! parseNumberArg ( argv [ i ] , 18 , tmp , true ) )
return false ;
mSettings . reportProgress = tmp ;
2015-11-20 12:01:04 +01:00
}
2020-04-26 10:20:56 +02:00
# ifdef HAVE_RULES
// Rule given at command line
else if ( std : : strncmp ( argv [ i ] , " --rule= " , 7 ) = = 0 ) {
Settings : : Rule rule ;
rule . pattern = 7 + argv [ i ] ;
2023-03-07 12:11:21 +01:00
mSettings . rules . emplace_back ( std : : move ( rule ) ) ;
2020-04-26 10:20:56 +02:00
}
// Rule file
else if ( std : : strncmp ( argv [ i ] , " --rule-file= " , 12 ) = = 0 ) {
tinyxml2 : : XMLDocument doc ;
if ( doc . LoadFile ( 12 + argv [ i ] ) = = tinyxml2 : : XML_SUCCESS ) {
tinyxml2 : : XMLElement * node = doc . FirstChildElement ( ) ;
2022-06-22 00:03:18 +02:00
if ( node & & strcmp ( node - > Value ( ) , " rules " ) = = 0 )
2022-06-22 08:46:48 +02:00
node = node - > FirstChildElement ( " rule " ) ;
2020-04-26 10:20:56 +02:00
for ( ; node & & strcmp ( node - > Value ( ) , " rule " ) = = 0 ; node = node - > NextSiblingElement ( ) ) {
Settings : : Rule rule ;
2023-05-22 19:53:51 +02:00
const tinyxml2 : : XMLElement * tokenlist = node - > FirstChildElement ( " tokenlist " ) ;
2020-04-26 10:20:56 +02:00
if ( tokenlist )
rule . tokenlist = tokenlist - > GetText ( ) ;
2023-05-22 19:53:51 +02:00
const tinyxml2 : : XMLElement * pattern = node - > FirstChildElement ( " pattern " ) ;
2020-04-26 10:20:56 +02:00
if ( pattern ) {
rule . pattern = pattern - > GetText ( ) ;
}
tinyxml2 : : XMLElement * message = node - > FirstChildElement ( " message " ) ;
if ( message ) {
2023-05-22 19:53:51 +02:00
const tinyxml2 : : XMLElement * severity = message - > FirstChildElement ( " severity " ) ;
2020-04-26 10:20:56 +02:00
if ( severity )
rule . severity = Severity : : fromString ( severity - > GetText ( ) ) ;
2023-05-22 19:53:51 +02:00
const tinyxml2 : : XMLElement * id = message - > FirstChildElement ( " id " ) ;
2020-04-26 10:20:56 +02:00
if ( id )
rule . id = id - > GetText ( ) ;
2023-05-22 19:53:51 +02:00
const tinyxml2 : : XMLElement * summary = message - > FirstChildElement ( " summary " ) ;
2020-04-26 10:20:56 +02:00
if ( summary )
rule . summary = summary - > GetText ( ) ? summary - > GetText ( ) : " " ;
}
if ( ! rule . pattern . empty ( ) )
2023-03-07 12:11:21 +01:00
mSettings . rules . emplace_back ( std : : move ( rule ) ) ;
2020-04-26 10:20:56 +02:00
}
} else {
2021-10-30 13:30:48 +02:00
printError ( " unable to load rule-file: " + std : : string ( 12 + argv [ i ] ) ) ;
2020-04-26 10:20:56 +02:00
return false ;
}
}
# endif
// show timing information..
else if ( std : : strncmp ( argv [ i ] , " --showtime= " , 11 ) = = 0 ) {
const std : : string showtimeMode = argv [ i ] + 11 ;
if ( showtimeMode = = " file " )
2023-03-07 12:11:21 +01:00
mSettings . showtime = SHOWTIME_MODES : : SHOWTIME_FILE ;
2023-05-11 14:04:22 +02:00
else if ( showtimeMode = = " file-total " )
mSettings . showtime = SHOWTIME_MODES : : SHOWTIME_FILE_TOTAL ;
2020-04-26 10:20:56 +02:00
else if ( showtimeMode = = " summary " )
2023-03-07 12:11:21 +01:00
mSettings . showtime = SHOWTIME_MODES : : SHOWTIME_SUMMARY ;
2020-04-26 10:20:56 +02:00
else if ( showtimeMode = = " top5 " )
2023-03-07 12:11:21 +01:00
mSettings . showtime = SHOWTIME_MODES : : SHOWTIME_TOP5 ;
2020-04-26 10:20:56 +02:00
else if ( showtimeMode . empty ( ) )
2023-03-07 12:11:21 +01:00
mSettings . showtime = SHOWTIME_MODES : : SHOWTIME_NONE ;
2020-04-26 10:20:56 +02:00
else {
2023-05-11 14:04:22 +02:00
printError ( " unrecognized showtime mode: \" " + showtimeMode + " \" . Supported modes: file, file-total, summary, top5. " ) ;
2020-04-26 10:20:56 +02:00
return false ;
}
}
2015-11-20 12:01:04 +01:00
// --std
2022-04-15 16:17:36 +02:00
else if ( std : : strncmp ( argv [ i ] , " --std= " , 6 ) = = 0 ) {
const std : : string std = argv [ i ] + 6 ;
// TODO: print error when standard is unknown
if ( std : : strncmp ( std . c_str ( ) , " c++ " , 3 ) = = 0 ) {
2023-03-07 12:11:21 +01:00
mSettings . standards . cpp = Standards : : getCPP ( std ) ;
2022-04-15 16:17:36 +02:00
}
else if ( std : : strncmp ( std . c_str ( ) , " c " , 1 ) = = 0 ) {
2023-03-07 12:11:21 +01:00
mSettings . standards . c = Standards : : getC ( std ) ;
2022-04-15 16:17:36 +02:00
}
else {
printError ( " unknown --std value ' " + std + " ' " ) ;
return false ;
}
2015-11-20 12:01:04 +01:00
}
2020-04-26 10:20:56 +02:00
else if ( std : : strncmp ( argv [ i ] , " --suppress= " , 11 ) = = 0 ) {
const std : : string suppression = argv [ i ] + 11 ;
2023-04-30 20:56:54 +02:00
const std : : string errmsg ( mSuppressions . addSuppressionLine ( suppression ) ) ;
2020-04-26 10:20:56 +02:00
if ( ! errmsg . empty ( ) ) {
2021-10-30 13:30:48 +02:00
printError ( errmsg ) ;
2020-04-26 10:20:56 +02:00
return false ;
}
}
// Filter errors
else if ( std : : strncmp ( argv [ i ] , " --suppressions-list= " , 20 ) = = 0 ) {
std : : string filename = argv [ i ] + 20 ;
std : : ifstream f ( filename ) ;
if ( ! f . is_open ( ) ) {
2021-10-30 13:30:48 +02:00
std : : string message ( " couldn't open the file: \" " ) ;
2020-04-26 10:20:56 +02:00
message + = filename ;
message + = " \" . " ;
2022-12-30 15:13:47 +01:00
if ( std : : count ( filename . cbegin ( ) , filename . cend ( ) , ' , ' ) > 0 | |
std : : count ( filename . cbegin ( ) , filename . cend ( ) , ' . ' ) > 1 ) {
2020-04-26 10:20:56 +02:00
// If user tried to pass multiple files (we can only guess that)
// e.g. like this: --suppressions-list=a.txt,b.txt
// print more detailed error message to tell user how he can solve the problem
message + = " \n If you want to pass two files, you can do it e.g. like this: " ;
message + = " \n cppcheck --suppressions-list=a.txt --suppressions-list=b.txt file.cpp " ;
}
2021-10-30 13:30:48 +02:00
printError ( message ) ;
2020-04-26 10:20:56 +02:00
return false ;
}
2023-04-30 20:56:54 +02:00
const std : : string errmsg ( mSuppressions . parseFile ( f ) ) ;
2020-04-26 10:20:56 +02:00
if ( ! errmsg . empty ( ) ) {
2021-10-30 13:30:48 +02:00
printError ( errmsg ) ;
2020-04-26 10:20:56 +02:00
return false ;
}
}
else if ( std : : strncmp ( argv [ i ] , " --suppress-xml= " , 15 ) = = 0 ) {
const char * filename = argv [ i ] + 15 ;
2023-04-30 20:56:54 +02:00
const std : : string errmsg ( mSuppressions . parseXmlFile ( filename ) ) ;
2020-04-26 10:20:56 +02:00
if ( ! errmsg . empty ( ) ) {
2021-10-30 13:30:48 +02:00
printError ( errmsg ) ;
2020-04-26 10:20:56 +02:00
return false ;
}
}
2015-11-20 12:01:04 +01:00
// Output formatter
else if ( std : : strcmp ( argv [ i ] , " --template " ) = = 0 | |
std : : strncmp ( argv [ i ] , " --template= " , 11 ) = = 0 ) {
2018-04-23 12:21:18 +02:00
// "--template format"
2015-11-20 12:01:04 +01:00
if ( argv [ i ] [ 10 ] = = ' = ' )
2023-03-07 12:11:21 +01:00
mSettings . templateFormat = argv [ i ] + 11 ;
2015-11-20 12:01:04 +01:00
else if ( ( i + 1 ) < argc & & argv [ i + 1 ] [ 0 ] ! = ' - ' ) {
2023-08-18 11:59:14 +02:00
printMessage ( " '--template <template>' is deprecated and will be removed in 2.13 - please use '--template=<template>' instead " ) ;
2015-11-20 12:01:04 +01:00
+ + i ;
2023-03-07 12:11:21 +01:00
mSettings . templateFormat = argv [ i ] ;
2015-11-20 12:01:04 +01:00
} else {
2021-10-30 13:30:48 +02:00
printError ( " argument to '--template' is missing. " ) ;
2010-08-31 20:32:26 +02:00
return false ;
}
2023-04-08 22:19:52 +02:00
// TODO: bail out when no placeholders are found?
2010-08-31 20:32:26 +02:00
2023-03-07 12:11:21 +01:00
if ( mSettings . templateFormat = = " gcc " ) {
mSettings . templateFormat = " {bold}{file}:{line}:{column}: {magenta}warning:{default} {message} [{id}]{reset} \\ n{code} " ;
mSettings . templateLocation = " {bold}{file}:{line}:{column}: {dim}note:{reset} {info} \\ n{code} " ;
} else if ( mSettings . templateFormat = = " daca2 " ) {
mSettings . daca = true ;
mSettings . templateFormat = " {file}:{line}:{column}: {severity}:{inconclusive:inconclusive:} {message} [{id}] " ;
mSettings . templateLocation = " {file}:{line}:{column}: note: {info} " ;
} else if ( mSettings . templateFormat = = " vs " )
mSettings . templateFormat = " {file}({line}): {severity}: {message} " ;
else if ( mSettings . templateFormat = = " edit " )
mSettings . templateFormat = " {file} +{line}: {severity}: {message} " ;
else if ( mSettings . templateFormat = = " cppcheck1 " )
mSettings . templateFormat = " {callstack}: ({severity}{inconclusive:, inconclusive}) {message} " ;
else if ( mSettings . templateFormat = = " selfcheck " ) {
mSettings . templateFormat = " {file}:{line}:{column}: {severity}:{inconclusive:inconclusive:} {message} [{id}] \\ n{code} " ;
mSettings . templateLocation = " {file}:{line}:{column}: note: {info} \\ n{code} " ;
mSettings . daca = true ;
2021-01-09 20:32:38 +01:00
}
2018-04-23 12:21:18 +02:00
}
else if ( std : : strcmp ( argv [ i ] , " --template-location " ) = = 0 | |
std : : strncmp ( argv [ i ] , " --template-location= " , 20 ) = = 0 ) {
// "--template-location format"
if ( argv [ i ] [ 19 ] = = ' = ' )
2023-03-07 12:11:21 +01:00
mSettings . templateLocation = argv [ i ] + 20 ;
2018-04-23 12:21:18 +02:00
else if ( ( i + 1 ) < argc & & argv [ i + 1 ] [ 0 ] ! = ' - ' ) {
2023-08-18 11:59:14 +02:00
printMessage ( " '--template-location <template>' is deprecated and will be removed in 2.13 - please use '--template-location=<template>' instead " ) ;
2018-04-23 12:21:18 +02:00
+ + i ;
2023-03-07 12:11:21 +01:00
mSettings . templateLocation = argv [ i ] ;
2018-04-23 12:21:18 +02:00
} else {
2023-04-08 22:19:52 +02:00
printError ( " argument to '--template-location' is missing. " ) ;
2018-04-23 12:21:18 +02:00
return false ;
}
2023-04-08 22:19:52 +02:00
// TODO: bail out when no placeholders are found?
2010-08-31 20:32:26 +02:00
}
2022-12-30 21:21:05 +01:00
else if ( std : : strncmp ( argv [ i ] , " --template-max-time= " , 20 ) = = 0 ) {
2023-04-08 22:29:09 +02:00
if ( ! parseNumberArg ( argv [ i ] , 20 , mSettings . templateMaxTime ) )
return false ;
2022-12-30 21:21:05 +01:00
}
else if ( std : : strncmp ( argv [ i ] , " --typedef-max-time= " , 19 ) = = 0 ) {
2023-04-08 22:29:09 +02:00
if ( ! parseNumberArg ( argv [ i ] , 19 , mSettings . typedefMaxTime ) )
return false ;
2022-12-30 21:21:05 +01:00
}
2022-12-20 20:51:08 +01:00
else if ( std : : strncmp ( argv [ i ] , " --valueflow-max-iterations= " , 27 ) = = 0 ) {
2023-04-08 22:29:09 +02:00
if ( ! parseNumberArg ( argv [ i ] , 27 , mSettings . valueFlowMaxIterations ) )
2022-12-20 20:51:08 +01:00
return false ;
}
2020-04-26 10:20:56 +02:00
else if ( std : : strcmp ( argv [ i ] , " -v " ) = = 0 | | std : : strcmp ( argv [ i ] , " --verbose " ) = = 0 )
2023-03-07 12:11:21 +01:00
mSettings . verbose = true ;
2010-08-31 20:32:26 +02:00
2020-04-26 10:20:56 +02:00
else if ( std : : strcmp ( argv [ i ] , " --version " ) = = 0 ) {
mShowVersion = true ;
2018-08-18 15:45:42 +02:00
mExitAfterPrint = true ;
2023-03-07 12:11:21 +01:00
mSettings . loadCppcheckCfg ( ) ;
2015-11-20 12:01:04 +01:00
return true ;
}
2020-04-26 10:20:56 +02:00
// Write results in results.xml
else if ( std : : strcmp ( argv [ i ] , " --xml " ) = = 0 )
2023-03-07 12:11:21 +01:00
mSettings . xml = true ;
2010-12-12 11:56:22 +01:00
2020-04-26 10:20:56 +02:00
// Define the XML file version (and enable XML output)
else if ( std : : strncmp ( argv [ i ] , " --xml-version= " , 14 ) = = 0 ) {
2023-04-08 22:29:09 +02:00
int tmp ;
if ( ! parseNumberArg ( argv [ i ] , 14 , tmp ) )
2015-11-20 12:01:04 +01:00
return false ;
2023-04-08 22:29:09 +02:00
if ( tmp ! = 2 ) {
2020-04-26 10:20:56 +02:00
// We only have xml version 2
2021-10-30 13:30:48 +02:00
printError ( " '--xml-version' can only be 2. " ) ;
2015-11-20 12:01:04 +01:00
return false ;
2010-12-12 11:56:22 +01:00
}
2023-04-08 22:29:09 +02:00
mSettings . xml_version = tmp ;
2020-04-26 10:20:56 +02:00
// Enable also XML if version is set
2023-03-07 12:11:21 +01:00
mSettings . xml = true ;
2011-10-05 07:37:43 +02:00
}
2015-11-20 12:01:04 +01:00
else {
2021-10-30 13:30:48 +02:00
std : : string message ( " unrecognized command line option: \" " ) ;
2015-11-20 12:01:04 +01:00
message + = argv [ i ] ;
message + = " \" . " ;
2021-10-30 13:30:48 +02:00
printError ( message ) ;
2011-10-05 07:37:43 +02:00
return false ;
}
2010-09-06 19:12:40 +02:00
}
2010-09-06 19:15:21 +02:00
2011-10-13 20:53:06 +02:00
else {
2020-05-11 13:48:54 +02:00
mPathNames . emplace_back ( Path : : fromNativeSeparators ( Path : : removeQuotationMarks ( argv [ i ] ) ) ) ;
2011-03-28 21:26:14 +02:00
}
2010-08-31 20:32:26 +02:00
}
2023-03-07 12:11:21 +01:00
mSettings . loadCppcheckCfg ( ) ;
2021-11-05 18:57:26 +01:00
2019-08-18 07:50:50 +02:00
// Default template format..
2023-03-07 12:11:21 +01:00
if ( mSettings . templateFormat . empty ( ) ) {
mSettings . templateFormat = " {bold}{file}:{line}:{column}: {red}{inconclusive:{magenta}}{severity}:{inconclusive: inconclusive:}{default} {message} [{id}]{reset} \\ n{code} " ;
if ( mSettings . templateLocation . empty ( ) )
mSettings . templateLocation = " {bold}{file}:{line}:{column}: {dim}note:{reset} {info} \\ n{code} " ;
2019-08-18 07:50:50 +02:00
}
2023-04-08 22:19:52 +02:00
// replace static parts of the templates
substituteTemplateFormatStatic ( mSettings . templateFormat ) ;
substituteTemplateLocationStatic ( mSettings . templateLocation ) ;
2019-08-18 07:50:50 +02:00
2023-03-07 12:11:21 +01:00
mSettings . project . ignorePaths ( mIgnoredPaths ) ;
2016-08-13 10:50:03 +02:00
2023-03-07 12:11:21 +01:00
if ( mSettings . force | | maxconfigs )
mSettings . checkAllConfigurations = true ;
2019-11-09 17:51:16 +01:00
2023-03-07 12:11:21 +01:00
if ( mSettings . force )
mSettings . maxConfigs = INT_MAX ;
2013-06-08 16:46:54 +02:00
2023-03-07 12:11:21 +01:00
else if ( ( def | | mSettings . preprocessOnly ) & & ! maxconfigs )
mSettings . maxConfigs = 1U ;
2016-01-02 11:48:36 +01:00
2023-07-25 12:00:23 +02:00
if ( mSettings . checks . isEnabled ( Checks : : unusedFunction ) & & mSettings . jobs > 1 & & mSettings . buildDir . empty ( ) ) {
2021-10-30 13:30:48 +02:00
printMessage ( " unusedFunction check can't be used with '-j' option. Disabling unusedFunction check. " ) ;
2010-08-31 20:32:26 +02:00
}
2014-05-18 13:45:26 +02:00
if ( argc < = 1 ) {
2018-08-18 15:45:42 +02:00
mShowHelp = true ;
mExitAfterPrint = true ;
2014-05-18 13:45:26 +02:00
}
2010-09-06 21:31:06 +02:00
2018-08-18 15:45:42 +02:00
if ( mShowHelp ) {
2018-04-23 12:39:47 +02:00
printHelp ( ) ;
2011-01-27 10:14:08 +01:00
return true ;
2010-09-06 21:31:06 +02:00
}
2011-01-27 10:14:08 +01:00
2023-01-27 10:46:48 +01:00
# if defined(_WIN64)
2023-05-11 14:35:56 +02:00
if ( SHOW_DEF_PLATFORM_MSG & & default_platform & & ! mSettings . quiet )
2023-01-27 10:46:48 +01:00
printMessage ( " Windows 64-bit binaries currently default to the 'win64' platform. Starting with Cppcheck 2.13 they will default to 'native' instead. Please specify '--platform=win64' explicitly if you rely on this. " ) ;
# elif defined(_WIN32)
2023-05-11 14:35:56 +02:00
if ( SHOW_DEF_PLATFORM_MSG & & default_platform & & ! mSettings . quiet )
2023-01-27 10:46:48 +01:00
printMessage ( " Windows 32-bit binaries currently default to the 'win32A' platform. Starting with Cppcheck 2.13 they will default to 'native' instead. Please specify '--platform=win32A' explicitly if you rely on this. " ) ;
# endif
2011-01-27 10:14:08 +01:00
// Print error only if we have "real" command and expect files
2023-03-07 12:11:21 +01:00
if ( ! mExitAfterPrint & & mPathNames . empty ( ) & & mSettings . project . fileSettings . empty ( ) ) {
2021-10-30 13:30:48 +02:00
printError ( " no C or C++ source files found. " ) ;
2010-08-31 20:32:26 +02:00
return false ;
}
2012-04-06 10:49:21 +02:00
// Use paths _pathnames if no base paths for relative path output are given
2023-03-07 12:11:21 +01:00
if ( mSettings . basePaths . empty ( ) & & mSettings . relativePaths )
mSettings . basePaths = mPathNames ;
2012-04-06 10:49:21 +02:00
2010-08-31 20:32:26 +02:00
return true ;
}
2018-04-23 12:39:47 +02:00
void CmdLineParser : : printHelp ( )
2010-08-31 20:32:26 +02:00
{
2022-09-02 18:10:23 +02:00
const std : : string manualUrl ( isCppcheckPremium ( ) ?
" https://cppcheck.sourceforge.io/manual.pdf " :
" https://files.cppchecksolutions.com/manual.pdf " ) ;
2015-07-25 17:17:52 +02:00
std : : cout < < " Cppcheck - A tool for static C/C++ code analysis \n "
2021-08-07 20:51:18 +02:00
" \n "
" Syntax: \n "
" cppcheck [OPTIONS] [files or paths] \n "
" \n "
2021-08-09 10:46:56 +02:00
" If a directory is given instead of a filename, *.cpp, *.cxx, *.cc, *.c++, *.c, *.ipp, \n "
" *.ixx, *.tpp, and *.txx files are checked recursively from the given directory. \n \n "
2021-08-07 20:51:18 +02:00
" Options: \n "
" --addon=<addon> \n "
2022-07-29 16:46:36 +02:00
" Execute addon. i.e. --addon=misra. If options must be \n "
2021-08-07 20:51:18 +02:00
" provided a json configuration is needed. \n "
" --addon-python=<python interpreter> \n "
" You can specify the python interpreter either in the \n "
" addon json files or through this command line option. \n "
" If not present, Cppcheck will try \" python3 \" first and \n "
" then \" python \" . \n "
" --cppcheck-build-dir=<dir> \n "
" Cppcheck work folder. Advantages: \n "
" * whole program analysis \n "
" * faster analysis; Cppcheck will reuse the results if \n "
" the hash for a file is unchanged. \n "
" * some useful debug information, i.e. commands used to \n "
" execute clang/clang-tidy/addons. \n "
" --check-config Check cppcheck configuration. The normal code \n "
" analysis is disabled by this flag. \n "
2023-04-09 13:48:13 +02:00
" --check-level=<level> \n "
" Configure how much checking you want: \n "
" * normal: Cppcheck uses some compromises in the checking so \n "
" the checking will finish in reasonable time. \n "
" * exhaustive: deeper analysis that you choose when you can \n "
" wait. \n "
" The default choice is 'normal'. \n "
2021-08-07 20:51:18 +02:00
" --check-library Show information messages when library files have \n "
" incomplete info. \n "
" --clang=<path> Experimental: Use Clang parser instead of the builtin Cppcheck \n "
" parser. Takes the executable as optional parameter and \n "
" defaults to `clang`. Cppcheck will run the given Clang \n "
" executable, import the Clang AST and convert it into \n "
" Cppcheck data. After that the normal Cppcheck analysis is \n "
" used. You must have the executable in PATH if no path is \n "
" given. \n "
" --config-exclude=<dir> \n "
" Path (prefix) to be excluded from configuration \n "
" checking. Preprocessor configurations defined in \n "
" headers (but not sources) matching the prefix will not \n "
" be considered for evaluation. \n "
" --config-excludes-file=<file> \n "
" A file that contains a list of config-excludes \n "
2023-01-21 10:39:44 +01:00
" --disable=<id> Disable individual checks. \n "
" Please refer to the documentation of --enable=<id> \n "
2023-03-06 11:25:07 +01:00
" for further details. \n "
2021-08-07 20:51:18 +02:00
" --dump Dump xml data for each translation unit. The dump \n "
" files have the extension .dump and contain ast, \n "
" tokenlist, symboldatabase, valueflow. \n "
" -D<ID> Define preprocessor symbol. Unless --max-configs or \n "
" --force is used, Cppcheck will only check the given \n "
" configuration when -D is used. \n "
" Example: '-DDEBUG=1 -D__cplusplus'. \n "
" -E Print preprocessor output on stdout and don't do any \n "
" further processing. \n "
" --enable=<id> Enable additional checks. The available ids are: \n "
" * all \n "
" Enable all checks. It is recommended to only \n "
" use --enable=all when the whole program is \n "
" scanned, because this enables unusedFunction. \n "
" * warning \n "
" Enable warning messages \n "
" * style \n "
" Enable all coding style checks. All messages \n "
2021-09-22 20:06:42 +02:00
" with the severities 'style', 'warning', \n "
" 'performance' and 'portability' are enabled. \n "
2021-08-07 20:51:18 +02:00
" * performance \n "
" Enable performance messages \n "
" * portability \n "
" Enable portability messages \n "
" * information \n "
" Enable information messages \n "
" * unusedFunction \n "
2022-01-18 11:46:34 +01:00
" Check for unused functions. It is recommended \n "
2021-08-07 20:51:18 +02:00
" to only enable this when the whole program is \n "
" scanned. \n "
" * missingInclude \n "
2023-03-04 09:02:35 +01:00
" Warn if there are missing includes. \n "
2021-08-07 20:51:18 +02:00
" Several ids can be given if you separate them with \n "
" commas. See also --std \n "
" --error-exitcode=<n> If errors are found, integer [n] is returned instead of \n "
" the default '0'. ' " < < EXIT_FAILURE < < " ' is returned \n "
" if arguments are not valid or if no input files are \n "
" provided. Note that your operating system can modify \n "
" this value, e.g. '256' can become '0'. \n "
" --errorlist Print a list of all the error messages in XML format. \n "
" --exitcode-suppressions=<file> \n "
" Used when certain messages should be displayed but \n "
" should not cause a non-zero exitcode. \n "
" --file-filter=<str> Analyze only those files matching the given filter str \n "
2021-11-23 22:51:45 +01:00
" Can be used multiple times \n "
2021-08-07 20:51:18 +02:00
" Example: --file-filter=*bar.cpp analyzes only files \n "
" that end with bar.cpp. \n "
" --file-list=<file> Specify the files to check in a text file. Add one \n "
" filename per line. When file is '-,' the file list will \n "
" be read from standard input. \n "
" -f, --force Force checking of all configurations in files. If used \n "
" together with '--max-configs=', the last option is the \n "
" one that is effective. \n "
" -h, --help Print this help. \n "
" -I <dir> Give path to search for include files. Give several -I \n "
" parameters to give several paths. First given path is \n "
" searched for contained header files first. If paths are \n "
" relative to source files, this is not needed. \n "
" --includes-file=<file> \n "
" Specify directory paths to search for included header \n "
" files in a text file. Add one include path per line. \n "
" First given path is searched for contained header \n "
" files first. If paths are relative to source files, \n "
" this is not needed. \n "
" --include=<file> \n "
" Force inclusion of a file before the checked file. \n "
" -i <dir or file> Give a source file or source file directory to exclude \n "
" from the check. This applies only to source files so \n "
" header files included by source files are not matched. \n "
" Directory name is matched to all parts of the path. \n "
" --inconclusive Allow that Cppcheck reports even though the analysis is \n "
" inconclusive. \n "
" There are false positives with this option. Each result \n "
" must be carefully investigated before you know if it is \n "
" good or bad. \n "
" --inline-suppr Enable inline suppressions. Use them by placing one or \n "
" more comments, like: '// cppcheck-suppress warningId' \n "
" on the lines before the warning to suppress. \n "
" -j <jobs> Start <jobs> threads to do the checking simultaneously. \n "
2015-11-20 12:01:04 +01:00
# ifdef THREADING_MODEL_FORK
2021-08-07 20:51:18 +02:00
" -l <load> Specifies that no new threads should be started if \n "
" there are other threads running and the load average is \n "
" at least <load>. \n "
2015-11-20 12:01:04 +01:00
# endif
2021-08-07 20:51:18 +02:00
" --language=<language>, -x <language> \n "
" Forces cppcheck to check all files as the given \n "
" language. Valid values are: c, c++ \n "
" --library=<cfg> Load file <cfg> that contains information about types \n "
" and functions. With such information Cppcheck \n "
" understands your code better and therefore you \n "
" get better results. The std.cfg file that is \n "
" distributed with Cppcheck is loaded automatically. \n "
" For more information about library files, read the \n "
" manual. \n "
" --max-configs=<limit> \n "
" Maximum number of configurations to check in a file \n "
" before skipping it. Default is '12'. If used together \n "
" with '--force', the last option is the one that is \n "
" effective. \n "
2022-08-24 08:54:47 +02:00
" --max-ctu-depth=N Max depth in whole program analysis. The default value \n "
" is 2. A larger value will mean more errors can be found \n "
" but also means the analysis will be slower. \n "
" --output-file=<file> Write results to file, rather than standard error. \n "
2021-08-07 20:51:18 +02:00
" --platform=<type>, --platform=<file> \n "
" Specifies platform specific types and sizes. The \n "
" available builtin platforms are: \n "
" * unix32 \n "
" 32 bit unix variant \n "
" * unix64 \n "
" 64 bit unix variant \n "
" * win32A \n "
" 32 bit Windows ASCII character encoding \n "
" * win32W \n "
" 32 bit Windows UNICODE character encoding \n "
" * win64 \n "
" 64 bit Windows \n "
" * avr8 \n "
" 8 bit AVR microcontrollers \n "
" * elbrus-e1cp \n "
" Elbrus e1c+ architecture \n "
" * pic8 \n "
" 8 bit PIC microcontrollers \n "
" Baseline and mid-range architectures \n "
" * pic8-enhanced \n "
" 8 bit PIC microcontrollers \n "
" Enhanced mid-range and high end (PIC18) architectures \n "
" * pic16 \n "
" 16 bit PIC microcontrollers \n "
" * mips32 \n "
" 32 bit MIPS microcontrollers \n "
" * native \n "
" Type sizes of host system are assumed, but no \n "
" further assumptions. \n "
" * unspecified \n "
" Unknown type sizes \n "
" --plist-output=<path> \n "
2022-08-24 08:46:35 +02:00
" Generate Clang-plist output files in folder. \n " ;
if ( isCppcheckPremium ( ) ) {
std : : cout < < " --premium=<option> \n "
2022-08-25 22:35:53 +02:00
< < " Coding standards: \n "
< < " * autosar Autosar (partial) \n "
< < " * cert-c-2016 Cert C 2016 checking \n "
< < " * cert-c++-2016 Cert C++ 2016 checking (partial) \n "
< < " * misra-c-2012 Misra C 2012 \n "
2023-08-23 10:28:02 +02:00
< < " * misra-c-2023 Misra C 2023 \n "
2022-08-25 22:35:53 +02:00
< < " * misra-c++-2008 Misra C++ 2008 (partial) \n "
< < " Other: \n "
< < " * bughunting Soundy analysis \n "
< < " * cert-c-int-precision=BITS Integer precision to use in Cert C analysis. \n " ;
2022-08-24 08:46:35 +02:00
}
std : : cout < <
2022-08-24 08:54:47 +02:00
" --project=<file> Run Cppcheck on project. The <file> can be a Visual \n "
" Studio Solution (*.sln), Visual Studio Project \n "
" (*.vcxproj), compile database (compile_commands.json), \n "
" or Borland C++ Builder 6 (*.bpr). The files to analyse, \n "
" include paths, defines, platform and undefines in \n "
" the specified file will be used. \n "
" --project-configuration=<config> \n "
" If used together with a Visual Studio Solution (*.sln) \n "
" or Visual Studio Project (*.vcxproj) you can limit \n "
" the configuration cppcheck should check. \n "
" For example: '--project-configuration=Release|Win32' \n "
2022-08-24 08:46:35 +02:00
" -q, --quiet Do not show progress reports. \n "
2023-08-05 19:18:10 +02:00
" Note that this option is not mutually exclusive with --verbose. \n "
2022-08-24 08:46:35 +02:00
" -rp=<paths>, --relative-paths=<paths> \n "
" Use relative paths in output. When given, <paths> are \n "
" used as base. You can separate multiple paths by ';'. \n "
" Otherwise path where source files are searched is used. \n "
" We use string comparison to create relative paths, so \n "
" using e.g. ~ for home folder does not work. It is \n "
" currently only possible to apply the base paths to \n "
" files that are on a lower level in the directory tree. \n "
2023-08-23 11:20:20 +02:00
" --report-progress Report progress messages while checking a file (single job only). \n "
2011-05-01 11:44:47 +02:00
# ifdef HAVE_RULES
2021-08-07 20:51:18 +02:00
" --rule=<rule> Match regular expression. \n "
" --rule-file=<file> Use given rule file. For more information, see: \n "
" http://sourceforge.net/projects/cppcheck/files/Articles/ \n "
2011-05-01 11:44:47 +02:00
# endif
2021-08-07 20:51:18 +02:00
" --std=<id> Set standard. \n "
" The available options are: \n "
" * c89 \n "
" C code is C89 compatible \n "
" * c99 \n "
" C code is C99 compatible \n "
" * c11 \n "
" C code is C11 compatible (default) \n "
" * c++03 \n "
" C++ code is C++03 compatible \n "
" * c++11 \n "
" C++ code is C++11 compatible \n "
" * c++14 \n "
" C++ code is C++14 compatible \n "
" * c++17 \n "
" C++ code is C++17 compatible \n "
" * c++20 \n "
" C++ code is C++20 compatible (default) \n "
" --suppress=<spec> Suppress warnings that match <spec>. The format of \n "
" <spec> is: \n "
" [error id]:[filename]:[line] \n "
" The [filename] and [line] are optional. If [error id] \n "
" is a wildcard '*', all error ids match. \n "
" --suppressions-list=<file> \n "
" Suppress warnings listed in the file. Each suppression \n "
" is in the same format as <spec> above. \n "
" --suppress-xml=<file> \n "
" Suppress warnings listed in a xml file. XML file should \n "
" follow the manual.pdf format specified in section. \n "
" `6.4 XML suppressions` . \n "
" --template='<text>' Format the error messages. Available fields: \n "
" {file} file name \n "
" {line} line number \n "
" {column} column number \n "
" {callstack} show a callstack. Example: \n "
" [file.c:1] -> [file.c:100] \n "
" {inconclusive:text} if warning is inconclusive, text \n "
" is written \n "
" {severity} severity \n "
" {message} warning message \n "
" {id} warning id \n "
" {cwe} CWE id (Common Weakness Enumeration) \n "
" {code} show the real code \n "
" \\ t insert tab \n "
" \\ n insert newline \n "
" \\ r insert carriage return \n "
" Example formats: \n "
" '{file}:{line},{severity},{id},{message}' or \n "
" '{file}({line}):({severity}) {message}' or \n "
" '{callstack} {message}' \n "
" Pre-defined templates: gcc (default), cppcheck1 (old default), vs, edit. \n "
// Note: template daca2 also exists, but is for internal use (cppcheck scripts).
" --template-location='<text>' \n "
" Format error message location. If this is not provided \n "
" then no extra location info is shown. \n "
" Available fields: \n "
" {file} file name \n "
" {line} line number \n "
" {column} column number \n "
" {info} location info \n "
" {code} show the real code \n "
" \\ t insert tab \n "
" \\ n insert newline \n "
" \\ r insert carriage return \n "
" Example format (gcc-like): \n "
" '{file}:{line}:{column}: note: {info} \\ n{code}' \n "
" -U<ID> Undefine preprocessor symbol. Use -U to explicitly \n "
" hide certain #ifdef <ID> code paths from checking. \n "
" Example: '-UDEBUG' \n "
" -v, --verbose Output more detailed error information. \n "
2023-08-05 19:18:10 +02:00
" Note that this option is not mutually exclusive with --quiet. \n "
2021-08-07 20:51:18 +02:00
" --version Print out version number. \n "
" --xml Write results in xml format to error stream (stderr). \n "
" \n "
" Example usage: \n "
" # Recursively check the current folder. Print the progress on the screen and \n "
" # write errors to a file: \n "
" cppcheck . 2> err.txt \n "
" \n "
" # Recursively check ../myproject/ and don't print progress: \n "
" cppcheck --quiet ../myproject/ \n "
" \n "
" # Check test.cpp, enable all checks: \n "
" cppcheck --enable=all --inconclusive --library=posix test.cpp \n "
" \n "
" # Check f.cpp and search include files from inc1/ and inc2/: \n "
" cppcheck -I inc1/ -I inc2/ f.cpp \n "
" \n "
" For more information: \n "
2022-09-02 18:10:23 +02:00
" " < < manualUrl < < " \n "
2022-09-03 17:30:17 +02:00
" \n "
" Many thanks to the 3rd party libraries we use: \n "
" * tinyxml2 -- loading project/library/ctu files. \n "
" * picojson -- loading compile database. \n "
" * pcre -- rules. \n "
" * qt -- used in GUI \n " ;
2010-08-31 20:32:26 +02:00
}
2022-08-24 08:46:35 +02:00
bool CmdLineParser : : isCppcheckPremium ( ) const {
2023-03-07 12:11:21 +01:00
if ( mSettings . cppcheckCfgProductName . empty ( ) )
mSettings . loadCppcheckCfg ( ) ;
return mSettings . cppcheckCfgProductName . compare ( 0 , 16 , " Cppcheck Premium " ) = = 0 ;
2022-08-24 08:46:35 +02:00
}