Address compiler warnings at code granularity rather than binary-wide (…

…#28) * Re-enable warning 4996 * Fix 4634 * Newline * Remove GLTFSDK Schema.h from includes as it is not used and results in multiply defined errors
microsoft · May 29, 2018 · 21dd0d0 · 21dd0d0
1 parent ee37a89
commit 21dd0d0
Show file tree

Hide file tree

Showing 14 changed files with 48 additions and 47 deletions.
diff --git a/glTF-Toolkit/glTF-Toolkit.vcxproj b/glTF-Toolkit/glTF-Toolkit.vcxproj
@@ -101,7 +101,6 @@
       <AdditionalOptions>/permissive- %(AdditionalOptions)</AdditionalOptions>
       <TreatWarningAsError>true</TreatWarningAsError>
       <GenerateXMLDocumentationFiles>true</GenerateXMLDocumentationFiles>
-      <DisableSpecificWarnings>4634;4996</DisableSpecificWarnings>
       <SDLCheck>true</SDLCheck>
       <PreprocessorDefinitions>_LIB;%(PreprocessorDefinitions)</PreprocessorDefinitions>
       <Optimization>MaxSpeed</Optimization>
@@ -124,13 +123,11 @@
       <RuntimeLibrary Condition="'$(Configuration)'=='Debug Static Runtime'">MultiThreadedDebug</RuntimeLibrary>
     </ClCompile>
   </ItemDefinitionGroup>
-
   <ItemDefinitionGroup Condition="'$(Platform)'=='x86'">
     <ClCompile>
       <PreprocessorDefinitions>WIN32;%(PreprocessorDefinitions)</PreprocessorDefinitions>
     </ClCompile>
   </ItemDefinitionGroup>
-
   <ItemGroup>
     <None Include="packages.config" />
   </ItemGroup>
@@ -139,6 +136,7 @@
     <ClInclude Include="inc\DeviceResources.h" />
     <ClInclude Include="inc\GLBtoGLTF.h" />
     <ClInclude Include="inc\GLTFLODUtils.h" />
+    <ClInclude Include="inc\GLTFSDK.h" />
     <ClInclude Include="inc\GLTFTextureCompressionUtils.h" />
     <ClInclude Include="inc\GLTFTextureLoadingUtils.h" />
     <ClInclude Include="inc\GLTFTexturePackingUtils.h" />

diff --git a/glTF-Toolkit/glTF-Toolkit.vcxproj.filters b/glTF-Toolkit/glTF-Toolkit.vcxproj.filters
@@ -39,6 +39,9 @@
     <ClInclude Include="inc\AccessorUtils.h">
       <Filter>inc</Filter>
     </ClInclude>
+    <ClInclude Include="inc\GLTFSDK.h">
+      <Filter>inc</Filter>
+    </ClInclude>
   </ItemGroup>
   <ItemGroup>
     <ClCompile Include="src\DeviceResources.cpp">

diff --git a/glTF-Toolkit/inc/AccessorUtils.h b/glTF-Toolkit/inc/AccessorUtils.h
@@ -3,7 +3,7 @@
 
 #pragma once
 
-#include <GLTFSDK/GLTFDocument.h>
+#include "GLTFSDK.h"
 #include <functional>
 #include <vector>
 
@@ -15,14 +15,11 @@ namespace Microsoft::glTF::Toolkit
     class AccessorUtils
     {
     public:
-        /// <summary>
-        /// Calculates the min and max values for an accessor according to the glTF 2.0 specification.
-        /// <param name="accessor">The accessor definition for which the min and max values will be calculated.</param>
-        /// <param name="accessorContents">The raw data contained in the accessor.</param>
-        /// <returns>
-        /// A pair containing the min and max vectors for the accessor, in that order.
-        /// </returns>
-        /// </summary>
+        // Note: XML Documentation cannot be applied to templated types per https://docs.microsoft.com/en-us/cpp/ide/xml-documentation-visual-cpp
+        // Calculates the min and max values for an accessor according to the glTF 2.0 specification.
+        // accessor is: The accessor definition for which the min and max values will be calculated.</param>
+        // accessorContents is: The raw data contained in the accessor.
+        // returns: A pair containing the min and max vectors for the accessor, in that order.
         template <typename T>
         static std::pair<std::vector<float>, std::vector<float>> CalculateMinMax(const Accessor& accessor, const std::vector<T>& accessorContents)
         {

diff --git a/glTF-Toolkit/inc/GLBtoGLTF.h b/glTF-Toolkit/inc/GLBtoGLTF.h
@@ -3,10 +3,7 @@
 
 #pragma once
 
-#include <GLTFSDK/Deserialize.h>
-#include <GLTFSDK/Serialize.h>
-#include <GLTFSDK/GLTFResourceWriter.h>
-#include <GLTFSDK/GLBResourceReader.h>
+#include "GLTFSDK.h"
 
 namespace Microsoft::glTF::Toolkit
 {

diff --git a/glTF-Toolkit/inc/GLTFLODUtils.h b/glTF-Toolkit/inc/GLTFLODUtils.h
@@ -3,7 +3,7 @@
 
 #pragma once
 
-#include <GLTFSDK/GLTFDocument.h>
+#include "GLTFSDK.h"
 
 namespace Microsoft::glTF::Toolkit
 {

diff --git a/glTF-Toolkit/inc/GLTFSDK.h b/glTF-Toolkit/inc/GLTFSDK.h
@@ -0,0 +1,22 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License. See LICENSE in the project root for license information.
+
+#pragma once
+
+#pragma warning(push)
+#pragma warning(disable : 4634)
+#pragma warning(disable : 4996)
+
+#include <GLTFSDK/GLTFDocument.h>
+#include <GLTFSDK/Deserialize.h>
+#include <GLTFSDK/Serialize.h>
+#include <GLTFSDK/GLTFResourceWriter.h>
+#include <GLTFSDK/GLBResourceReader.h>
+#include <GLTFSDK/GLTFResourceReader.h>
+#include <GLTFSDK/IStreamReader.h>
+#include <GLTFSDK/IStreamFactory.h>
+#include <GLTFSDK/RapidJsonUtils.h>
+#include <GLTFSDK/GLTF.h>
+#include <GLTFSDK/GLTFConstants.h>
+
+#pragma warning(pop)
diff --git a/glTF-Toolkit/inc/GLTFTextureCompressionUtils.h b/glTF-Toolkit/inc/GLTFTextureCompressionUtils.h
@@ -3,8 +3,7 @@
 
 #pragma once
 
-#include <GLTFSDK/GLTFDocument.h>
-#include <GLTFSDK/IStreamReader.h>
+#include "GLTFSDK.h"
 
 namespace DirectX
 {

diff --git a/glTF-Toolkit/inc/GLTFTextureLoadingUtils.h b/glTF-Toolkit/inc/GLTFTextureLoadingUtils.h
@@ -1,8 +1,7 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License. See LICENSE in the project root for license information.#pragma once
 
-#include <GLTFSDK/GLTFDocument.h>
-#include <GLTFSDK/IStreamReader.h>
+#include "GLTFSDK.h"
 #include <DirectXTex.h>
 
 namespace Microsoft::glTF::Toolkit

diff --git a/glTF-Toolkit/inc/GLTFTexturePackingUtils.h b/glTF-Toolkit/inc/GLTFTexturePackingUtils.h
@@ -3,8 +3,7 @@
 
 #pragma once
 
-#include <GLTFSDK/GLTFDocument.h>
-#include <GLTFSDK/IStreamReader.h>
+#include "GLTFSDK.h"
 
 namespace Microsoft::glTF::Toolkit
 {

diff --git a/glTF-Toolkit/inc/SerializeBinary.h b/glTF-Toolkit/inc/SerializeBinary.h
@@ -1,11 +1,8 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License. See LICENSE in the project root for license information.#pragma once
 
-#include <GLTFSDK/GLTFDocument.h>
-#include <GLTFSDK/GLTFResourceReader.h>
-#include <GLTFSDK/IStreamFactory.h>
-#include <GLTFSDK/IStreamReader.h>
-#include <GLTFSDK/RapidJsonUtils.h>
+#include "GLTFSDK.h"
+
 #include <functional>
 #include <memory>
 #include <vector>

diff --git a/glTF-Toolkit/inc/pch.h b/glTF-Toolkit/inc/pch.h
@@ -32,14 +32,19 @@
 #include <DirectXMath.h>
 #include <DirectXColors.h>
 
+// Silence C4996 for CodeCVT deprecations. CodeCVT is still used for UTF8 conversions in GLTFLODUtils.cpp
+// TODO: Remove
+#define _SILENCE_CXX17_CODECVT_HEADER_DEPRECATION_WARNING
+#include <string>
+#undef _SILENCE_CXX17_CODECVT_HEADER_DEPRECATION_WARNING
+
 #include <algorithm>
 #include <exception>
-#include <memory>
-#include <stdexcept>
 #include <fstream>
 #include <iostream>
-#include <sstream>
+#include <memory>
 #include <set>
-#include <string>
+#include <sstream>
+#include <stdexcept>
 
 #include <stdio.h>
diff --git a/glTF-Toolkit/src/GLTFTextureCompressionUtils.cpp b/glTF-Toolkit/src/GLTFTextureCompressionUtils.cpp
@@ -8,12 +8,6 @@
 #include "GLTFTextureCompressionUtils.h"
 #include "DeviceResources.h"
 
-#include <GLTFSDK/GLTF.h>
-#include <GLTFSDK/GLTFConstants.h>
-#include <GLTFSDK/Deserialize.h>
-#include <GLTFSDK/RapidJsonUtils.h>
-#include <GLTFSDK/Schema.h>
-
 // Usings for ComPtr
 using namespace ABI::Windows::Foundation;
 using namespace Microsoft::WRL;

diff --git a/glTF-Toolkit/src/GLTFTextureLoadingUtils.cpp b/glTF-Toolkit/src/GLTFTextureLoadingUtils.cpp
@@ -3,9 +3,6 @@
 
 #include "pch.h"
 
-#include <GLTFSDK/GLTF.h>
-#include <GLTFSDK/GLTFResourceReader.h>
-
 #include "GLTFTextureLoadingUtils.h"
 
 using namespace Microsoft::glTF;

diff --git a/glTF-Toolkit/src/GLTFTexturePackingUtils.cpp b/glTF-Toolkit/src/GLTFTexturePackingUtils.cpp
@@ -5,12 +5,6 @@
 
 #include <DirectXTex.h>
 
-#include <GLTFSDK/GLTF.h>
-#include <GLTFSDK/GLTFConstants.h>
-#include <GLTFSDK/GLTFResourceReader.h>
-#include <GLTFSDK/IStreamReader.h>
-#include <GLTFSDK/RapidJsonUtils.h>
-
 #include "GLTFTextureLoadingUtils.h"
 #include "GLTFTexturePackingUtils.h"