Skip to content

CmdLineParser: deprecated --template <template> and --template-location <template> #5331

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
danmar merged 1 commit into from
Aug 18, 2023
+20 −14
Merged

CmdLineParser: deprecated --template <template> and --template-location <template> #5331

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions cli/cmdlineparser.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -899,14 +899,14 @@ bool CmdLineParser::parseFromArgs(int argc, const char* const argv[])
}
}

// TODO: deprecate "--template <template>"
// Output formatter
else if (std::strcmp(argv[i], "--template") == 0 ||
std::strncmp(argv[i], "--template=", 11) == 0) {
// "--template format"
if (argv[i][10] == '=')
mSettings.templateFormat = argv[i] + 11;
else if ((i+1) < argc && argv[i+1][0] != '-') {
printMessage("'--template <template>' is deprecated and will be removed in 2.13 - please use '--template=<template>' instead");
++i;
mSettings.templateFormat = argv[i];
} else {
Expand Down Expand Up @@ -935,13 +935,13 @@ bool CmdLineParser::parseFromArgs(int argc, const char* const argv[])
}
}

// TODO: deprecate "--template-location <template>"
else if (std::strcmp(argv[i], "--template-location") == 0 ||
std::strncmp(argv[i], "--template-location=", 20) == 0) {
// "--template-location format"
if (argv[i][19] == '=')
mSettings.templateLocation = argv[i] + 20;
else if ((i+1) < argc && argv[i+1][0] != '-') {
printMessage("'--template-location <template>' is deprecated and will be removed in 2.13 - please use '--template-location=<template>' instead");
++i;
mSettings.templateLocation = argv[i];
} else {
Expand Down
4 changes: 3 additions & 1 deletion releasenotes.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
release notes for cppcheck-2.12
Release Notes for Cppcheck 2.12

New checks:
- uselessOverride finds overriding functions that either duplicate code from or delegate back to the base class implementation
Expand All @@ -14,6 +14,8 @@ Changed interface:

Deprecations:
- The qmake build system has been deprecated and will be removed in a future version.
- Command-line option '--template <template>' is deprecated and will be removed in 2.13 - please use '--template=<template>' instead.
- Command-line option '--template-location <template>' is deprecated and will be removed in 2.13 - please use '--template-location=<template>' instead.

Other:
- "USE_QT6=On" will no longer fallback to Qt5 when Qt6 is not found.
26 changes: 15 additions & 11 deletions test/testcmdlineparser.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1335,43 +1335,43 @@ class TestCmdlineParser : public TestFixture {

void templates() {
REDIRECT;
const char * const argv[] = {"cppcheck", "--template", "{file}:{line},{severity},{id},{message}", "--template-location={file}:{line}:{column} {info}", "file.cpp"};
const char * const argv[] = {"cppcheck", "--template={file}:{line},{severity},{id},{message}", "--template-location={file}:{line}:{column} {info}", "file.cpp"};
settings->templateFormat.clear();
settings->templateLocation.clear();
ASSERT(parser->parseFromArgs(5, argv));
ASSERT(parser->parseFromArgs(4, argv));
ASSERT_EQUALS("{file}:{line},{severity},{id},{message}", settings->templateFormat);
ASSERT_EQUALS("{file}:{line}:{column} {info}", settings->templateLocation);
ASSERT_EQUALS("", GET_REDIRECT_OUTPUT);
}

void templatesGcc() {
REDIRECT;
const char * const argv[] = {"cppcheck", "--template", "gcc", "file.cpp"};
const char * const argv[] = {"cppcheck", "--template=gcc", "file.cpp"};
settings->templateFormat.clear();
settings->templateLocation.clear();
ASSERT(parser->parseFromArgs(4, argv));
ASSERT(parser->parseFromArgs(3, argv));
ASSERT_EQUALS("{file}:{line}:{column}: warning: {message} [{id}]\n{code}", settings->templateFormat);
ASSERT_EQUALS("{file}:{line}:{column}: note: {info}\n{code}", settings->templateLocation);
ASSERT_EQUALS("", GET_REDIRECT_OUTPUT);
}

void templatesVs() {
REDIRECT;
const char * const argv[] = {"cppcheck", "--template", "vs", "file.cpp"};
const char * const argv[] = {"cppcheck", "--template=vs", "file.cpp"};
settings->templateFormat.clear();
settings->templateLocation.clear();
ASSERT(parser->parseFromArgs(4, argv));
ASSERT(parser->parseFromArgs(3, argv));
ASSERT_EQUALS("{file}({line}): {severity}: {message}", settings->templateFormat);
ASSERT_EQUALS("", settings->templateLocation);
ASSERT_EQUALS("", GET_REDIRECT_OUTPUT);
}

void templatesEdit() {
REDIRECT;
const char * const argv[] = {"cppcheck", "--template", "edit", "file.cpp"};
const char * const argv[] = {"cppcheck", "--template=edit", "file.cpp"};
settings->templateFormat.clear();
settings->templateLocation.clear();
ASSERT(parser->parseFromArgs(4, argv));
ASSERT(parser->parseFromArgs(3, argv));
ASSERT_EQUALS("{file} +{line}: {severity}: {message}", settings->templateFormat);
ASSERT_EQUALS("", settings->templateLocation);
ASSERT_EQUALS("", GET_REDIRECT_OUTPUT);
Expand Down Expand Up @@ -1439,7 +1439,9 @@ class TestCmdlineParser : public TestFixture {
ASSERT(!parser->parseFromArgs(3, argv));
ASSERT_EQUALS("file.cpp", settings->templateFormat);
ASSERT_EQUALS("", settings->templateLocation);
TODO_ASSERT_EQUALS("cppcheck: error: argument to '--template' is missing.\n", "cppcheck: error: no C or C++ source files found.\n", GET_REDIRECT_OUTPUT);
TODO_ASSERT_EQUALS("cppcheck: error: argument to '--template' is missing.\n",
"cppcheck: '--template <template>' is deprecated and will be removed in 2.13 - please use '--template=<template>' instead\n"
"cppcheck: error: no C or C++ source files found.\n", GET_REDIRECT_OUTPUT);
}

// will use the default
Expand All @@ -1462,7 +1464,7 @@ class TestCmdlineParser : public TestFixture {
ASSERT_EQUALS("cppcheck: error: argument to '--template-location' is missing.\n", GET_REDIRECT_OUTPUT);
}

// TODO: will not error out as he next option does not start with a "-"
// TODO: will not error out as the next option does not start with a "-"
void templateLocationInvalid2() {
REDIRECT;
settings->templateFormat.clear();
Expand All @@ -1471,7 +1473,9 @@ class TestCmdlineParser : public TestFixture {
ASSERT(!parser->parseFromArgs(3, argv));
ASSERT_EQUALS("{file}:{line}:{column}: {inconclusive:}{severity}:{inconclusive: inconclusive:} {message} [{id}]\n{code}", settings->templateFormat);
ASSERT_EQUALS("file.cpp", settings->templateLocation);
TODO_ASSERT_EQUALS("", "cppcheck: error: no C or C++ source files found.\n", GET_REDIRECT_OUTPUT);
TODO_ASSERT_EQUALS("",
"cppcheck: '--template-location <template>' is deprecated and will be removed in 2.13 - please use '--template-location=<template>' instead\n"
"cppcheck: error: no C or C++ source files found.\n", GET_REDIRECT_OUTPUT);
}

// will use the default
Expand Down