Make a distinction between system and local includes

Author: wravery

CMakeLists.txt

@@ -40,11 +40,10 @@ cppgraphqlgen_target_set_cxx_standard(schemagen)
 
 add_custom_command(
   OUTPUT
-    graphqlservice/IntrospectionSchema.cpp
-    graphqlservice/IntrospectionSchema.h
+    IntrospectionSchema.cpp
+    include/graphqlservice/IntrospectionSchema.h
   COMMAND schemagen
-  COMMAND ${CMAKE_COMMAND} -E rename IntrospectionSchema.cpp graphqlservice/IntrospectionSchema.cpp
-  COMMAND ${CMAKE_COMMAND} -E rename IntrospectionSchema.h graphqlservice/IntrospectionSchema.h
+  COMMAND ${CMAKE_COMMAND} -E rename IntrospectionSchema.h include/graphqlservice/IntrospectionSchema.h
   DEPENDS schemagen
   COMMENT "Generating IntrospectionSchema files"
 )
@@ -54,24 +53,30 @@ add_library(graphqlservice
   GraphQLResponse.cpp
   GraphQLService.cpp
   Introspection.cpp
-  ${CMAKE_BINARY_DIR}/graphqlservice/IntrospectionSchema.cpp)
+  IntrospectionSchema.cpp)
 target_link_libraries(graphqlservice PRIVATE taocpp::pegtl)
 target_link_libraries(graphqlservice PUBLIC Threads::Threads)
-target_include_directories(graphqlservice
-  PUBLIC
-    $<BUILD_INTERFACE:${CMAKE_SOURCE_DIR}/include>
-    $<BUILD_INTERFACE:${CMAKE_BINARY_DIR}>
-    $<INSTALL_INTERFACE:include>
-)
+# Make system includes (e.g. <graphqlservice/public.h>) work relative to the build/install generator expressions
+target_include_directories(graphqlservice SYSTEM PUBLIC
+  $<BUILD_INTERFACE:${CMAKE_SOURCE_DIR}/include>
+  $<BUILD_INTERFACE:${CMAKE_BINARY_DIR}/include>
+  $<INSTALL_INTERFACE:include>)
+# Make local includes (e.g. "private.h") work while building graphqlservice, but don't export them
+target_include_directories(graphqlservice PRIVATE
+  ${CMAKE_SOURCE_DIR}/include
+  ${CMAKE_BINARY_DIR}/include)
 cppgraphqlgen_target_set_cxx_standard(graphqlservice)
 
 option(BUILD_TESTS "Build the tests and sample schema library." ON)
 option(UPDATE_SAMPLES "Regenerate the sample schema sources whether or not we're building the tests and the sample library." ON)
 
 if(BUILD_TESTS OR UPDATE_SAMPLES)
   add_custom_command(
-    OUTPUT TodaySchema.cpp TodaySchema.h
+    OUTPUT
+      TodaySchema.cpp
+      include/TodaySchema.h
     COMMAND schemagen ${CMAKE_SOURCE_DIR}/schema.today.graphql Today today
+    COMMAND ${CMAKE_COMMAND} -E rename TodaySchema.h include/TodaySchema.h
     DEPENDS schemagen schema.today.graphql
     COMMENT "Generating mock TodaySchema files"
   )
@@ -85,20 +90,22 @@ if(BUILD_TESTS OR UPDATE_SAMPLES)
     find_package(RapidJSON CONFIG REQUIRED)
 
     add_library(todaygraphql
-       ${CMAKE_BINARY_DIR}/TodaySchema.cpp
        Today.cpp
+       TodaySchema.cpp
        JSONResponse.cpp)
     target_link_libraries(todaygraphql PUBLIC
       graphqlservice)
     target_include_directories(todaygraphql SYSTEM PUBLIC ${RAPIDJSON_INCLUDE_DIRS})
-    target_include_directories(todaygraphql PRIVATE ${CMAKE_SOURCE_DIR} ${CMAKE_BINARY_DIR})
+    target_include_directories(todaygraphql
+      PUBLIC
+        ${CMAKE_SOURCE_DIR}/include
+        ${CMAKE_BINARY_DIR}/include)
     cppgraphqlgen_target_set_cxx_standard(todaygraphql)
 
     add_executable(test_today
       test_today.cpp)
     target_link_libraries(test_today PRIVATE
       todaygraphql)
-    target_include_directories(test_today PRIVATE ${CMAKE_SOURCE_DIR} ${CMAKE_BINARY_DIR})
     cppgraphqlgen_target_set_cxx_standard(test_today)
 
     enable_testing()
@@ -110,7 +117,6 @@ if(BUILD_TESTS OR UPDATE_SAMPLES)
       todaygraphql
       GTest::GTest
       GTest::Main)
-    target_include_directories(tests PRIVATE ${CMAKE_SOURCE_DIR} ${CMAKE_BINARY_DIR})
     cppgraphqlgen_target_set_cxx_standard(tests)
 
     add_test(NAME TodayServiceCase
@@ -126,9 +132,9 @@ if(BUILD_TESTS OR UPDATE_SAMPLES)
 
   if(UPDATE_SAMPLES)
     install(FILES
-      ${CMAKE_BINARY_DIR}/graphqlservice/IntrospectionSchema.h
-      ${CMAKE_BINARY_DIR}/graphqlservice/IntrospectionSchema.cpp
-      ${CMAKE_BINARY_DIR}/TodaySchema.h
+      ${CMAKE_BINARY_DIR}/include/graphqlservice/IntrospectionSchema.h
+      ${CMAKE_BINARY_DIR}/IntrospectionSchema.cpp
+      ${CMAKE_BINARY_DIR}/include/TodaySchema.h
       ${CMAKE_BINARY_DIR}/TodaySchema.cpp
       DESTINATION ${CMAKE_SOURCE_DIR}/samples)
   endif()
@@ -149,9 +155,9 @@ install(FILES
   include/graphqlservice/GraphQLTree.h
   include/graphqlservice/GraphQLResponse.h
   include/graphqlservice/GraphQLService.h
-  include/graphqlservice/Introspection.h
-  ${CMAKE_BINARY_DIR}/graphqlservice/IntrospectionSchema.h
   include/graphqlservice/JSONResponse.h
+  include/graphqlservice/Introspection.h
+  ${CMAKE_BINARY_DIR}/include/graphqlservice/IntrospectionSchema.h
   DESTINATION include/graphqlservice
   CONFIGURATIONS Release)
 

GraphQLResponse.cpp

@@ -1,7 +1,7 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
-#include "graphqlservice/GraphQLResponse.h"
+#include <graphqlservice/GraphQLResponse.h>
 
 #include <stdexcept>
 

GraphQLService.cpp

@@ -1,9 +1,10 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
-#include "graphqlservice/GraphQLService.h"
 #include "GraphQLGrammar.h"
 
+#include <graphqlservice/GraphQLService.h>
+
 #include <iostream>
 #include <algorithm>
 #include <array>

GraphQLTree.cpp

@@ -1,7 +1,6 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
-#include "graphqlservice/GraphQLTree.h"
 #include "GraphQLGrammar.h"
 
 #include <tao/pegtl/contrib/unescape.hpp>

Introspection.cpp

@@ -1,7 +1,7 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
-#include "graphqlservice/Introspection.h"
+#include <graphqlservice/Introspection.h>
 
 namespace facebook {
 namespace graphql {

JSONResponse.cpp

@@ -1,7 +1,7 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
-#include "graphqlservice/JSONResponse.h"
+#include <graphqlservice/JSONResponse.h>
 
 namespace facebook {
 namespace graphql {

SchemaGenerator.cpp

@@ -1164,12 +1164,12 @@ bool Generator::outputHeader() const noexcept
 
 #pragma once
 
+#include <graphqlservice/GraphQLService.h>
+
 #include <memory>
 #include <string>
 #include <vector>
 
-#include <graphqlservice/GraphQLService.h>
-
 namespace facebook {
 namespace graphql {
 namespace introspection {
@@ -1496,8 +1496,15 @@ bool Generator::outputSource() const noexcept
 	sourceFile << R"cpp(// Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
-#include ")cpp" << _filenamePrefix << R"cpp(Schema.h"
-#include <graphqlservice/Introspection.h>
+)cpp";
+	if (!_isIntrospection)
+	{
+		sourceFile << R"cpp(#include ")cpp" << _filenamePrefix << R"cpp(Schema.h"
+
+)cpp";
+	}
+
+	sourceFile << R"cpp(#include <graphqlservice/Introspection.h>
 
 #include <algorithm>
 #include <functional>

include/GraphQLGrammar.h

@@ -6,7 +6,7 @@
 
 #pragma once
 
-#include <tao/pegtl.hpp>
+#include <graphqlservice/GraphQLTree.h>
 
 namespace facebook {
 namespace graphql {

include/SchemaGenerator.h

@@ -6,7 +6,7 @@
 #include <array>
 #include <cstdio>
 
-#include "graphqlservice/GraphQLService.h"
+#include <graphqlservice/GraphQLService.h>
 
 namespace facebook {
 namespace graphql {

include/graphqlservice/GraphQLService.h

@@ -3,8 +3,8 @@
 
 #pragma once
 
-#include "graphqlservice/GraphQLTree.h"
-#include "graphqlservice/GraphQLResponse.h"
+#include <graphqlservice/GraphQLTree.h>
+#include <graphqlservice/GraphQLResponse.h>
 
 #include <memory>
 #include <string>