Compile CalcManager project with or without precompiled headers (#436)

Fixes #324 .

Description of the changes:
In an effort to support other compilers (#109), this change reworks how precompiled headers are handled. For toolchains where precompiled headers are not used, there is unnecessary compilation cost because each source file explicity includes the pch, meaning all system headers in the pch were recompiled for each translation unit. This change modifies the project's files so that each translation unit includes a minimal set of dependent headers. For MSVC users, the precompiled headers option is still enabled and the precompiled header is added to each translation unit using the compiler's Forced Includes option. The end result is that MSVC users still see the same build times, but other toolchains are free to use or not use precompiled headers.

Risks introduced
Given that our CI build uses MSVC, this change introduces the risk that a system header is added to the pch and the CalcManager project builds correctly, but builds could be broken for other toolsets that don't use pch. We know we want to add support for Clang in our CI build (#211). It seems reasonable to also compile without precompiled headers there so that we can regression test this setup.

How changes were validated:
Rebuild CalcManager project. Compile time: ~4.5s.
Disable precompiled headers, keeping explicit include for pch in each source file. Compile time: ~13s.
Remove explicit pch inclusion and add the appropriate headers to each translation unit to allow the project to compile. Compile time: ~8s.
Re-enable pch and include it using the Forced Includes compiler option. MSVC compile time: ~4.5s.
Minor changes
Delete 'targetver.h'. I found this while looking around for system headers in the project. It's unused and unreferenced so let's remove it.

src/CalcManager/CEngine/CalcInput.cpp

@@ -1,7 +1,7 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
-#include "pch.h"
+#include <sstream>
 #include "Header Files/CalcEngine.h"
 
 using namespace std;

src/CalcManager/CEngine/CalcUtils.cpp

@@ -1,7 +1,6 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
-#include "pch.h"
 #include "Header Files/CalcEngine.h"
 #include "Header Files/CalcUtils.h"
 

src/CalcManager/CEngine/History.cpp

@@ -1,7 +1,6 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
-#include "pch.h"
 #include "Header Files/CalcEngine.h"
 #include "Command.h"
 #include "CalculatorVector.h"

src/CalcManager/CEngine/Number.cpp

@@ -1,6 +1,6 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 
-#include "pch.h"
+#include <algorithm>
 #include "Header Files/Number.h"
 
 using namespace std;

src/CalcManager/CEngine/Rational.cpp

@@ -1,6 +1,6 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 
-#include "pch.h"
+#include <intsafe.h>
 #include "Header Files/Rational.h"
 
 using namespace std;

src/CalcManager/CEngine/RationalMath.cpp

@@ -1,7 +1,6 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
-#include "pch.h"
 #include "Header Files/RationalMath.h"
 
 using namespace std;

src/CalcManager/CEngine/calc.cpp

@@ -1,9 +1,8 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
-#include "pch.h"
+#include <cassert>
 #include "Header Files/CalcEngine.h"
-
 #include "CalculatorResource.h"
 
 using namespace std;

src/CalcManager/CEngine/scicomm.cpp

@@ -12,7 +12,8 @@
 *
 * Author:
 \****************************************************************************/
-#include "pch.h"
+
+#include <string>
 #include "Header Files/CalcEngine.h"
 #include "Header Files/CalcUtils.h"
 

src/CalcManager/CEngine/scidisp.cpp

@@ -12,7 +12,9 @@
 *
 * Author:
 \****************************************************************************/
-#include "pch.h"
+
+#include <sstream>
+#include <regex>
 #include "Header Files/CalcEngine.h"
 
 using namespace std;

src/CalcManager/CEngine/scifunc.cpp

@@ -16,7 +16,6 @@
 /***                                                                    ***/
 /***                                                                    ***/
 /**************************************************************************/
-#include "pch.h"
 #include "Header Files/CalcEngine.h"
 
 using namespace std;

src/CalcManager/CEngine/scioper.cpp

@@ -1,7 +1,6 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
-#include "pch.h"
 #include "Header Files/CalcEngine.h"
 
 using namespace CalcEngine;

src/CalcManager/CEngine/sciset.cpp

@@ -1,7 +1,6 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
-#include "pch.h"
 #include "Header Files/CalcEngine.h"
 
 using namespace CalcEngine;

src/CalcManager/CalcManager.vcxproj

@@ -157,6 +157,7 @@
       <AdditionalIncludeDirectories>$(SolutionDir)..\src\;%(AdditionalIncludeDirectories)</AdditionalIncludeDirectories>
       <WarningLevel>Level4</WarningLevel>
       <TreatWarningAsError>true</TreatWarningAsError>
+      <ForcedIncludeFiles>pch.h</ForcedIncludeFiles>
     </ClCompile>
     <Link>
       <SubSystem>Console</SubSystem>
@@ -173,6 +174,7 @@
       <AdditionalIncludeDirectories>$(SolutionDir)..\src\;%(AdditionalIncludeDirectories)</AdditionalIncludeDirectories>
       <WarningLevel>Level4</WarningLevel>
       <TreatWarningAsError>true</TreatWarningAsError>
+      <ForcedIncludeFiles>pch.h</ForcedIncludeFiles>
     </ClCompile>
     <Link>
       <SubSystem>Console</SubSystem>
@@ -189,6 +191,7 @@
       <AdditionalIncludeDirectories>$(SolutionDir)..\src\;%(AdditionalIncludeDirectories)</AdditionalIncludeDirectories>
       <WarningLevel>Level4</WarningLevel>
       <TreatWarningAsError>true</TreatWarningAsError>
+      <ForcedIncludeFiles>pch.h</ForcedIncludeFiles>
     </ClCompile>
     <Link>
       <SubSystem>Console</SubSystem>
@@ -205,6 +208,7 @@
       <AdditionalIncludeDirectories>$(SolutionDir)..\src\;%(AdditionalIncludeDirectories)</AdditionalIncludeDirectories>
       <WarningLevel>Level4</WarningLevel>
       <TreatWarningAsError>true</TreatWarningAsError>
+      <ForcedIncludeFiles>pch.h</ForcedIncludeFiles>
     </ClCompile>
     <Link>
       <SubSystem>Console</SubSystem>
@@ -222,6 +226,7 @@
       <AdditionalIncludeDirectories>$(SolutionDir)..\src\;%(AdditionalIncludeDirectories)</AdditionalIncludeDirectories>
       <WarningLevel>Level4</WarningLevel>
       <TreatWarningAsError>true</TreatWarningAsError>
+      <ForcedIncludeFiles>pch.h</ForcedIncludeFiles>
     </ClCompile>
     <Link>
       <SubSystem>Console</SubSystem>
@@ -238,6 +243,7 @@
       <AdditionalIncludeDirectories>$(SolutionDir)..\src\;%(AdditionalIncludeDirectories)</AdditionalIncludeDirectories>
       <WarningLevel>Level4</WarningLevel>
       <TreatWarningAsError>true</TreatWarningAsError>
+      <ForcedIncludeFiles>pch.h</ForcedIncludeFiles>
     </ClCompile>
     <Link>
       <SubSystem>Console</SubSystem>
@@ -254,6 +260,7 @@
       <AdditionalIncludeDirectories>$(SolutionDir)..\src\;%(AdditionalIncludeDirectories)</AdditionalIncludeDirectories>
       <WarningLevel>Level4</WarningLevel>
       <TreatWarningAsError>true</TreatWarningAsError>
+      <ForcedIncludeFiles>pch.h</ForcedIncludeFiles>
     </ClCompile>
     <Link>
       <SubSystem>Console</SubSystem>
@@ -270,6 +277,7 @@
       <AdditionalIncludeDirectories>$(SolutionDir)..\src\;%(AdditionalIncludeDirectories)</AdditionalIncludeDirectories>
       <WarningLevel>Level4</WarningLevel>
       <TreatWarningAsError>true</TreatWarningAsError>
+      <ForcedIncludeFiles>pch.h</ForcedIncludeFiles>
     </ClCompile>
     <Link>
       <SubSystem>Console</SubSystem>
@@ -278,7 +286,6 @@
     </Link>
   </ItemDefinitionGroup>
   <ItemGroup>
-    <ClInclude Include="CalcException.h" />
     <ClInclude Include="CalculatorHistory.h" />
     <ClInclude Include="CalculatorManager.h" />
     <ClInclude Include="CalculatorResource.h" />

src/CalcManager/CalculatorHistory.cpp

@@ -1,7 +1,7 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
+// Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
-#include "pch.h"
+#include <cassert>
 #include "CalculatorHistory.h"
 
 using namespace std;

src/CalcManager/CalculatorManager.cpp

@@ -1,7 +1,7 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
-#include "pch.h"
+#include <climits> // for UCHAR_MAX
 #include "Header Files/CalcEngine.h"
 #include "CalculatorManager.h"
 #include "CalculatorResource.h"

src/CalcManager/CalculatorVector.h

@@ -1,9 +1,14 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
+// Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
 #pragma once
 
+#include <string>
+#include <vector>
+#include <winerror.h>
 #include "Ratpack/CalcErr.h"
+#include <stdexcept> // for std::out_of_range
+#include <sal.h> // for SAL
 
 template <typename TType>
 class CalculatorVector

src/CalcManager/Command.h

@@ -1,4 +1,4 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
+// Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
 #pragma once

src/CalcManager/ExpressionCommand.cpp

@@ -1,7 +1,7 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
-#include "pch.h"
+#include <string>
 #include "Header Files/CCommand.h"
 #include "CalculatorVector.h"
 #include "ExpressionCommand.h"

src/CalcManager/ExpressionCommandInterface.h

@@ -1,7 +1,9 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
+// Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
 #pragma once
+
+#include <memory> // for std::shared_ptr
 #include "CalculatorVector.h"
 #include "Command.h"
 

src/CalcManager/Header Files/CCommand.h

@@ -13,6 +13,8 @@
 *
 \****************************************************************************/
 
+#pragma once
+
 // The following are the valid id's which can be passed to CCalcEngine::ProcessCommand
 
 #define IDM_HEX           313

src/CalcManager/Header Files/EngineStrings.h

@@ -13,6 +13,11 @@
 * Created: 13-Feb-2008
 *
 \****************************************************************************/
+
+#pragma once
+
+#include <string>
+
 inline constexpr auto IDS_ERRORS_FIRST = 99;
 
 // This is the list of error strings corresponding to SCERR_DIVIDEZERO..

src/CalcManager/Header Files/History.h

@@ -3,6 +3,7 @@
 
 #pragma once
 
+#include <array>
 #include "ICalcDisplay.h"
 #include "IHistoryDisplay.h"
 #include "Rational.h"

src/CalcManager/Header Files/Number.h

@@ -3,6 +3,7 @@
 
 #pragma once
 
+#include <vector>
 #include "Ratpack/ratpak.h"
 
 namespace CalcEngine

src/CalcManager/Ratpack/basex.cpp

@@ -14,8 +14,8 @@
 //  internal base is a power of 2.
 //
 //-----------------------------------------------------------------------------
-#include "pch.h"
 #include "ratpak.h"
+#include <cstring> // for memmove
 
 void _mulnumx( PNUMBER *pa, PNUMBER b );
 

src/CalcManager/Ratpack/conv.cpp

@@ -17,7 +17,10 @@
 //
 //---------------------------------------------------------------------------
 
-#include "pch.h"
+#include <algorithm>
+#include <winerror.h>
+#include <sstream>
+#include <cstring> // for memmove, memcpy
 #include "ratpak.h"
 
 using namespace std;

src/CalcManager/Ratpack/exp.cpp

@@ -14,7 +14,6 @@
 //
 //
 //-----------------------------------------------------------------------------
-#include "pch.h"
 #include "ratpak.h"
 
 

src/CalcManager/Ratpack/fact.cpp

@@ -13,7 +13,6 @@
 //     Contains fact(orial) and supporting _gamma functions.
 //
 //-----------------------------------------------------------------------------
-#include "pch.h"
 #include "ratpak.h"
 
 

src/CalcManager/Ratpack/itrans.cpp

@@ -15,7 +15,6 @@
 //  Special Information
 //
 //-----------------------------------------------------------------------------
-#include "pch.h"
 #include "ratpak.h"
 
 

src/CalcManager/Ratpack/itransh.cpp

@@ -16,7 +16,6 @@
 //
 //
 //-----------------------------------------------------------------------------
-#include "pch.h"
 #include "ratpak.h"
 
 

src/CalcManager/Ratpack/logic.cpp

@@ -13,7 +13,6 @@
 //     Contains routines for and, or, xor, not and other support
 //
 //---------------------------------------------------------------------------
-#include "pch.h"
 #include "ratpak.h"
 
 using namespace std;

src/CalcManager/Ratpack/num.cpp

@@ -17,7 +17,8 @@
 //
 //
 //-----------------------------------------------------------------------------
-#include "pch.h"
+#include <list>
+#include <cstring> // for memmove
 #include "ratpak.h"
 
 using namespace std;

src/CalcManager/Ratpack/rat.cpp

@@ -16,7 +16,6 @@
 //
 //-----------------------------------------------------------------------------
 
-#include "pch.h"
 #include "ratpak.h"
 
 using namespace std;

src/CalcManager/Ratpack/ratpak.h

@@ -17,7 +17,11 @@
 //
 //-----------------------------------------------------------------------------
 
+#include <algorithm>
+#include <string>
 #include "CalcErr.h"
+#include <cstring> // for memmove
+#include <sal.h> // for SAL
 
 static constexpr uint32_t BASEXPWR = 31L;// Internal log2(BASEX)
 static constexpr uint32_t BASEX = 0x80000000; // Internal radix used in calculations, hope to raise

src/CalcManager/Ratpack/support.cpp

@@ -18,7 +18,9 @@
 //
 //----------------------------------------------------------------------------
 
-#include "pch.h"
+#include <string>
+#include <cstring> // for memmove
+#include <iostream> // for wostream
 #include "ratpak.h"
 
 using namespace std;

src/CalcManager/Ratpack/trans.cpp

@@ -14,7 +14,6 @@
 //
 //----------------------------------------------------------------------------
 
-#include "pch.h"
 #include "ratpak.h"
 
 

src/CalcManager/Ratpack/transh.cpp

@@ -14,7 +14,6 @@
 //
 //
 //-----------------------------------------------------------------------------
-#include "pch.h"
 #include "ratpak.h"
 
 

src/CalcManager/UnitConverter.cpp

@@ -1,7 +1,9 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
-#include "pch.h"
+#include <cassert>
+#include <sstream>
+#include <algorithm> // for std::sort
 #include "Command.h"
 #include "UnitConverter.h"
 

src/CalcManager/UnitConverter.h

@@ -3,6 +3,12 @@
 
 #pragma once
 
+#include <vector>
+#include <unordered_map>
+#include <ppltasks.h>
+#include <sal.h> // for SAL
+#include <memory> // for std::shared_ptr
+
 namespace UnitConversionManager
 {
     enum class Command;

src/CalcManager/pch.cpp

@@ -1,4 +1,6 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
+// Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
-#include "pch.h"
+// Intentionally do not include the pch.h here. For projects that don't
+// use precompiled headers, including the header here would force unnecessary compilation.
+// The pch will be included through forced include.

src/CalcManager/pch.h

@@ -3,27 +3,20 @@
 
 #pragma once
 
-#ifndef WIN32_LEAN_AND_MEAN
+// The CalcManager project should be able to be compiled with or without a precompiled header
-#define WIN32_LEAN_AND_MEAN
+// in - order to support other toolchains besides MSVC. When adding new system headers, make sure
-#endif
+// that the relevant source file includes all headers it needs, but then also add the system headers
+// here so that MSVC users see the performance benefit.
 
-// Windows headers define min/max macros.
+#include <algorithm>
-// Disable it for project code.
-#define NOMINMAX
-
-#include <assert.h>
-#include <windows.h>
-#include <winerror.h>
-#include <sstream>
-#include <iostream>
-#include <iterator>
-#include <string>
-#include <memory>
-#include <vector>
-#include <limits>
-#include <list>
-#include <regex>
-#include <unordered_map>
-#include <intsafe.h>
 #include <array>
+#include <cassert>
+#include <intsafe.h>
+#include <list>
 #include <ppltasks.h>
+#include <regex>
+#include <sstream>
+#include <string>
+#include <unordered_map>
+#include <vector>
+#include <winerror.h>

src/CalcManager/targetver.h

@@ -1,11 +0,0 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
-// Licensed under the MIT License.
-
-#pragma once
-
-// Including SDKDDKVer.h defines the highest available Windows platform.
-
-// If you wish to build your application for a previous Windows platform, include WinSDKVer.h and
-// set the _WIN32_WINNT macro to the platform you wish to support before including SDKDDKVer.h.
-
-#include <SDKDDKVer.h>