fix #13362: Misra report on command line #7096

ludviggunne · 2024-12-11T13:59:04Z

WIP. Will add tests and HTML output.

lib/cppcheck.cpp

lib/errorlogger.cpp

lib/cppcheck.cpp

ludviggunne · 2024-12-26T11:45:53Z

@firewave I seem to be missing something with the CMake build, could you point me in the right direction? As I understand it all the lib/ sources should be available in the GUI.

/~https://github.com/danmar/cppcheck/actions/runs/12446323642/job/34748592068?pr=7096#step:12:141

ludviggunne · 2024-12-27T10:24:14Z

@firewave I seem to be missing something with the CMake build, could you point me in the right direction? As I understand it all the lib/ sources should be available in the GUI.

/~https://github.com/danmar/cppcheck/actions/runs/12446323642/job/34748592068?pr=7096#step:12:141

Nevermind, found the problem.

cli/cmdlineparser.cpp

test/testcmdlineparser.cpp

danmar

Please add a line in the releasenotes file also.

lib/checkers.h

lib/utils.cpp

danmar · 2025-01-09T20:31:49Z

lib/checkers.cpp

@@ -2096,3 +2097,183 @@ std::vector<checkers::Info> checkers::certCppInfo{
    {"MSC53-CPP", "L2"},
    {"MSC54-CPP", "L2"},
 };
+
+namespace checkers {


this file is autogenerated so don't change this file. Next time I autogenerate this file to make it uptodate this code will be removed it will be a mess.

Do you have a preference for which file these functions should be in?

hmm ideally I think it would be better if this information was dynamic. cppcheck could fetch the list of checkers from premiumaddon at runtime. but that does not feel like a refactoring you should make in this PR.

Hm, I'm not sure if we're talking about the same functions. The functions I added don't depend on the premiumCheckers map. Or am I missing something?

Do you have a preference for which file these functions should be in?

I suggest that it is added in the ErrorLogger.

I've been working on moving this logic to ErrorLogger, unfortunatley it seems to be necessary to drag in a bunch of dependencies for the gui tests. Maybe these functions could be in its own file/some other file?

This reverts commit 24485853ad1cfa4d4a43aa1036fe9491e27b056f.

danmar · 2025-01-20T10:14:05Z

cli/cmdlineparser.cpp

@@ -1824,6 +1847,15 @@ void CmdLineParser::printHelp() const
        "                         currently only possible to apply the base paths to\n"
        "                         files that are on a lower level in the directory tree.\n"
        "    --report-progress    Report progress messages while checking a file (single job only).\n"
+        "    --report-type=<type> Add guideline and classification fields for specified coding standard.\n"
+        "                         The available report types are:\n"
+        "                          * normal           Default, only show cppcheck error ID and severity)\n"


The ")" seems redundant:

Suggested change

" * normal Default, only show cppcheck error ID and severity)\n"

" * normal Default, only show cppcheck error ID and severity\n"

danmar · 2025-01-20T10:42:52Z

man/cppcheck.1.xml

+        </term>
+        <listitem>
+          <para>Add guideline and classification fields for specified coding standard. The available report types are:
+            <glosslist><glossentry><glossterm>normal</glossterm><glossdef><para>Default, only show cppcheck error ID and severity)</para></glossdef></glossentry><glossentry><glossterm>autosar</glossterm><glossdef><para>Autosar</para></glossdef></glossentry><glossentry><glossterm>certC</glossterm><glossdef><para>Cert C</para></glossdef></glossentry><glossentry><glossterm>certCpp</glossterm><glossdef><para>Cert Cpp</para></glossdef></glossentry><glossentry><glossterm>misraC</glossterm><glossdef><para>Misra C</para></glossdef></glossentry><glossentry><glossterm>misraCpp2008</glossterm><glossdef><para>Misra C++ 2008</para></glossdef></glossentry><glossentry><glossterm>misraCpp2023</glossterm><glossdef><para>Misra C++ 2023</para></glossdef></glossentry></glosslist>


hmm I would rather add some newlines here I think if each option was on a separate line that would be more readable.

danmar · 2025-01-20T10:47:14Z

lib/utils.h

 */
-CPPCHECKLIB std::vector<std::string> splitString(const std::string& str, char sep);
+template<template<class ...> class T = std::vector>
+T<std::string> splitString(const std::string& str, char sep)


As far as I see T is always std::vector so I don't see a good reason to make it a template.

danmar · 2025-01-20T10:55:04Z

lib/settings.h

@@ -28,6 +28,7 @@
 #include "platform.h"
 #include "standards.h"
 #include "suppressions.h"
+#include "errorlogger.h"


You don't have to include errorlogger.h here. As far as I see you can have a forward declaration of ReportType in settings.h and initialize the Settings::reportType in the constructor. That would probably reduce the dependencies.

danmar · 2025-01-20T10:56:20Z

lib/settings.h

+    ReportType reportType = ReportType::normal;
+
+    /** @brief Maps cppcheck error ids to guidelines */
+    std::map<std::string, std::string> guidelineMapping;


basically if this guidelineMapping map is created and used in ErrorLogger only it feels like it should be in ErrorLogger. But I don't know if there are problems to move it?

danmar · 2025-01-20T10:59:38Z

gui/resultsview.h

@@ -22,6 +22,7 @@

 #include "report.h"
 #include "showtypes.h"
+#include "common.h"


it seems unfortunate to replace the forward declaration with a include here.

danmar · 2025-01-20T11:02:27Z

gui/common.h

@@ -24,6 +24,8 @@
 #include <QMap>
 #include <QString>

+#include "errorlogger.h"


I have a feeling that maybe it's better that errorlogger.h is included explicitly when needed.

ludviggunne force-pushed the 13362 branch from 3746e04 to 71c596c Compare December 11, 2024 14:31

danmar reviewed Dec 11, 2024

View reviewed changes

lib/cppcheck.cpp Outdated Show resolved Hide resolved

lib/cppcheck.cpp Outdated Show resolved Hide resolved

lib/errorlogger.cpp Show resolved Hide resolved

lib/cppcheck.cpp Outdated Show resolved Hide resolved

ludviggunne force-pushed the 13362 branch 3 times, most recently from 70c91e1 to aed1653 Compare December 21, 2024 15:19

firewave reviewed Dec 27, 2024

View reviewed changes

cli/cmdlineparser.cpp Show resolved Hide resolved

firewave reviewed Dec 27, 2024

View reviewed changes

test/testcmdlineparser.cpp Show resolved Hide resolved

ludviggunne force-pushed the 13362 branch from a450db3 to 09a8e7e Compare December 27, 2024 16:57

danmar reviewed Dec 30, 2024

View reviewed changes

lib/checkers.h Outdated Show resolved Hide resolved

lib/utils.cpp Outdated Show resolved Hide resolved

lib/utils.cpp Outdated Show resolved Hide resolved

lib/utils.cpp Outdated Show resolved Hide resolved

ludviggunne force-pushed the 13362 branch 2 times, most recently from d4e9dec to d337781 Compare January 8, 2025 16:37

ludviggunne marked this pull request as ready for review January 9, 2025 13:33

danmar reviewed Jan 9, 2025

View reviewed changes

ludviggunne force-pushed the 13362 branch from d337781 to 8d47d7d Compare January 12, 2025 14:46

ludviggunne added 14 commits January 18, 2025 14:06

add command line option and setting for report-type

30d5440

add classification and guideline fields to ErrorMessage

7148104

set classification and guideline for ErrorMessage

eee69e5

update make dependencies

2699d11

add guidline/classification to xml output

dc5b54e

show classification and guideline in stderr

1652e5a

set guidline/classification for cert c/c++

ff5f3bf

add description for report-type option

d943057

fix warning

ab45d00

fix warning

3ef82a5

use existing split function

dbd8abb

hoist stoi calls

1baccfc

decouple guideline/classification logic from ErrorMessage

cae8682

add vector variant of splitString

50b90e2

ludviggunne added 18 commits January 18, 2025 14:06

movec reporttype logic to checkers.*

2061c60

use library ReportType in GUI

914b65f

formatting

f3067cc

use library getGuideline/getClassification in GUI

5faf85f

set message guideline/classification in StdLogger::reportErr

9b013d1

move guideline mapping to library

ca160c6

update cmake dependencies for gui tests

0c84359

add uint8_t base for ReportType

f7a90f5

add FALLTHROUGH macro

66271b5

add cmdlineparser tests

09167fc

add errorlogger tests

56a1b58

add defaultReportType test

78e16a7

update cppcheck manual and cli usage

a8e19ad

refactor splitString

49fe94a

explicit ReportType values

9ee60f6

update releasenotes.txt

c4f6bf4

update .ts files

277169a

Revert "update .ts files"

e245967

This reverts commit 24485853ad1cfa4d4a43aa1036fe9491e27b056f.

ludviggunne force-pushed the 13362 branch 3 times, most recently from 2ecfb14 to e997eb9 Compare January 18, 2025 15:18

change default template argument for splitString

b955c4f

ludviggunne force-pushed the 13362 branch from e997eb9 to b5d0944 Compare January 19, 2025 10:47

move guideline/classification functions to errorlogger

d808b30

ludviggunne force-pushed the 13362 branch from b5d0944 to d808b30 Compare January 19, 2025 10:52

add CPPCHECKLIB to declarations

8f6d965

ludviggunne force-pushed the 13362 branch from 4f2c095 to 9d98a3e Compare January 19, 2025 13:08

remove some unused includes

78b6a52

ludviggunne force-pushed the 13362 branch from 9d98a3e to 78b6a52 Compare January 19, 2025 14:31

danmar reviewed Jan 20, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix #13362: Misra report on command line #7096

fix #13362: Misra report on command line #7096

ludviggunne commented Dec 11, 2024

ludviggunne commented Dec 26, 2024

ludviggunne commented Dec 27, 2024

danmar left a comment

danmar Jan 9, 2025

ludviggunne Jan 10, 2025

danmar Jan 11, 2025

ludviggunne Jan 11, 2025

danmar Jan 11, 2025 •

edited

Loading

ludviggunne Jan 12, 2025

danmar Jan 20, 2025

danmar Jan 20, 2025

danmar Jan 20, 2025

danmar Jan 20, 2025

danmar Jan 20, 2025

danmar Jan 20, 2025

danmar Jan 20, 2025

	" * normal Default, only show cppcheck error ID and severity)\n"
	" * normal Default, only show cppcheck error ID and severity\n"

fix #13362: Misra report on command line #7096

Are you sure you want to change the base?

fix #13362: Misra report on command line #7096

Conversation

ludviggunne commented Dec 11, 2024

ludviggunne commented Dec 26, 2024

ludviggunne commented Dec 27, 2024

danmar left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

danmar Jan 11, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

danmar Jan 11, 2025 •

edited

Loading