{"id":7301,"date":"2015-12-03T11:57:00","date_gmt":"2015-12-03T18:57:00","guid":{"rendered":"https:\/\/blogs.msdn.microsoft.com\/vcblog\/2015\/12\/03\/c-core-guidelines-checkers-available-for-vs-2015-update-1\/"},"modified":"2021-10-05T13:58:48","modified_gmt":"2021-10-05T13:58:48","slug":"c-core-guidelines-checkers-available-for-vs-2015-update-1","status":"publish","type":"post","link":"https:\/\/devblogs.microsoft.com\/cppblog\/c-core-guidelines-checkers-available-for-vs-2015-update-1\/","title":{"rendered":"C++ Core Guidelines Checkers available for VS 2015 Update 1"},"content":{"rendered":"

[This post was written by\u00a0Andrew Pardoe and Neil MacIntosh]<\/span><\/p>\n

Update: The CppCoreCheck tools are now part of VS 2017:\u00a0https:\/\/blogs.msdn.microsoft.com\/vcblog\/2016\/10\/12\/cppcorecheck<\/a>.<\/span><\/p>\n

Back in September at\u00a0<\/span>CppCon 2015<\/a><\/span>\u00a0<\/span>Neil announced that we would be shipping new code analysis tools for C++ that would enforce some of the rules in the C++ Core Guidelines. (A video of the talk is available here:\u00a0<\/span><\/span>https:\/\/www.youtube.com\/watch?v=rKlHvAw1z50<\/a>\u00a0<\/span>and slides are available on the\u00a0<\/span><\/span>ISOCpp GitHub repo<\/a>.)<\/span><\/p>\n

Earlier this week we made the first set of those code analysis tools freely available as a NuGet package that can be installed by users of Visual Studio 2015 Update 1. The package currently contains checkers for the\u00a0<\/span><\/span>Bounds<\/a>\u00a0<\/span>and\u00a0<\/span><\/span>Type<\/a>\u00a0<\/span>profiles.\u00a0<\/span>Tooling for the<\/span>\u00a0<\/span><\/span>Lifetime profile<\/a><\/span>\u00a0<\/span>demonstrated in Herb Sutter’s plenary talk (video at\u00a0<\/span><\/span><\/span>https:\/\/www.youtube.com\/watch?v=hEx5DNLWGgA<\/a>) will be made available in a future release of the code analysis tools.<\/span><\/p>\n

The package is named \u201cMicrosoft.CppCoreCheck\u201d, and a direct link to the package is here:\u00a0<\/span><\/span>http:\/\/www.nuget.org\/packages\/Microsoft.CppCoreCheck<\/a>.<\/span><\/p>\n

To enable the new code analysis tools, simply install the NuGet packages to each C++ project that you want checked within Visual Studio. <\/span><\/p>\n

\"Image<\/a><\/span><\/p>\n

\"Image<\/a><\/span><\/p>\n

The NuGet package adds an additional MSBuild targets file that gets invoked when you have code analysis enabled on your project. This targets file adds the CppCoreCheck as an additional plugin to the\u00a0PREfast code analysis tool.\u00a0You can enable code analysis by selecting the checkbox in the Code Analysis section of the project Properties dialog. It doesn’t matter what rule set you select–the CppCoreCheck rule sets will always run when Code Analysis is enabled.<\/span><\/p>\n

\"Image<\/a>\nThese tools are an important first step in ensuring that users of Visual Studio can benefit from enforcement of the C++ Core Guidelines. Please note that they require Visual Studio 2015 Update 1 and will not work with earlier releases.<\/span><\/p>\n

Here’s an example of the kind of issues that the tools will find:<\/span><\/p>\n

void<\/span> main()<\/span>\n{<\/span>\n\u00a0\u00a0\u00a0 int<\/span> arr[10];\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\/\/ BAD, warning 26494 will be fired<\/span><\/span>\n\u00a0\u00a0\u00a0\u00a0int<\/span>* p = arr;\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \/\/ BAD, warning 26485 will be fired<\/span><\/span><\/span><\/p>\n

\u00a0\u00a0\u00a0 [[suppress(bounds.1)]] \/\/\u00a0This attribute suppresses Bounds rule #1<\/span><\/span>\n\u00a0\u00a0\u00a0 {<\/span>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 int<\/span>* q = p + 1;\u00a0\u00a0\u00a0 \/\/ BAD, warning 26481 would be fired<\/span><\/span>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 p = q++;\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \/\/ BAD, warning 26481 would be fired<\/span><\/span>\n\u00a0\u00a0\u00a0 }<\/span>\n}<\/span><\/p>\n

There are a few interesting things to note here. First, let’s look at the full description of the warnings that will come from this code sample:<\/span><\/p>\n