Move include related classes to matc

Author: trie94

libs/filamat/CMakeLists.txt

@@ -9,8 +9,6 @@ set(PUBLIC_HDR_DIR include)
 # ==================================================================================================
 set(HDRS
         include/filamat/Enums.h
-        include/filamat/Includes.h
-        include/filamat/IncludeCallback.h
         include/filamat/MaterialBuilder.h
         include/filamat/Package.h
 )
@@ -40,7 +38,6 @@ set(COMMON_SRCS
         src/shaders/SibGenerator.cpp
         src/shaders/UibGenerator.cpp
         src/Enums.cpp
-        src/Includes.cpp
         src/MaterialBuilder.cpp
         src/MaterialVariants.cpp
 )
@@ -161,8 +158,7 @@ if (IS_HOST_PLATFORM)
             tests/test_filamat.cpp
             tests/test_argBufferFixup.cpp
             tests/test_clipDistanceFixup.cpp
-            tests/test_line_dictionary.cpp
-            tests/test_includes.cpp)
+            tests/test_line_dictionary.cpp)
 
     add_executable(${TARGET} ${SRCS})
     target_include_directories(${TARGET} PRIVATE src)

libs/filamat/include/filamat/MaterialBuilder.h

@@ -21,7 +21,6 @@
 
 #include <filament/MaterialEnums.h>
 
-#include <filamat/IncludeCallback.h>
 #include <filamat/Package.h>
 
 #include <backend/DriverEnums.h>

libs/filamat/src/MaterialBuilder.cpp

@@ -17,7 +17,6 @@
 #include "filamat/MaterialBuilder.h"
 
 #include <filamat/Enums.h>
-#include <filamat/IncludeCallback.h>
 #include <filamat/Package.h>
 
 #include "GLSLPostProcessor.h"

libs/filamat/tests/test_filamat.cpp

@@ -20,8 +20,6 @@
 #include "sca/GLSLTools.h"
 #include "shaders/ShaderGenerator.h"
 
-#include "MockIncluder.h"
-
 #include <filamat/Enums.h>
 #include <filamat/MaterialBuilder.h>
 
@@ -53,9 +51,7 @@ std::string shaderWithAllProperties(JobSystem& jobSystem, ShaderStage type,
         filamat::MaterialBuilder::Shading shadingModel = filamat::MaterialBuilder::Shading::LIT,
         filamat::MaterialBuilder::RefractionMode refractionMode = filamat::MaterialBuilder::RefractionMode::NONE,
         filamat::MaterialBuilder::VertexDomain vertexDomain = filamat::MaterialBuilder::VertexDomain::OBJECT) {
-    MockIncluder includer;
-    includer
-            .sourceForInclude("modify_normal.h", "material.normal = vec3(0.8);");
+
     filamat::MaterialBuilder builder;
     builder.material(fragmentCode.c_str());
     builder.materialVertex(vertexCode.c_str());
@@ -68,8 +64,7 @@ std::string shaderWithAllProperties(JobSystem& jobSystem, ShaderStage type,
     MaterialBuilder::PropertyList allProperties;
     std::fill_n(allProperties, MaterialBuilder::MATERIAL_PROPERTIES_COUNT, true);
 
-    // We need to "build" the material to resolve any includes in user code.
-    builder.build(jobSystem);
+    // Note: no need to call builder.build as we are only checking the properties.
 
     return builder.peek(type, {
                     ShaderModel::MOBILE,
@@ -735,25 +730,6 @@ TEST_F(MaterialCompiler, StaticCodeAnalyzerOutputFactor) {
     EXPECT_TRUE(PropertyListsMatch(expected, properties));
 }
 
-TEST_F(MaterialCompiler, StaticCodeAnalyzerWithinInclude) {
-    std::string fragmentCode(R"(
-        void material(inout MaterialInputs material) {
-            prepareMaterial(material);
-            #include "modify_normal.h"
-        }
-    )");
-
-    std::string shaderCode = shaderWithAllProperties(*jobSystem, ShaderStage::FRAGMENT,
-            fragmentCode);
-
-    GLSLTools glslTools;
-    MaterialBuilder::PropertyList properties{ false };
-    glslTools.findProperties(ShaderStage::FRAGMENT, shaderCode, properties);
-    MaterialBuilder::PropertyList expected{ false };
-    expected[size_t(filamat::MaterialBuilder::Property::NORMAL)] = true;
-    EXPECT_TRUE(PropertyListsMatch(expected, properties));
-}
-
 TEST_F(MaterialCompiler, EmptyName) {
     std::string shaderCode(R"(
         void material(inout MaterialInputs material) {

tools/matc/CMakeLists.txt

@@ -13,14 +13,17 @@ set(HDRS
         src/matc/CommandlineConfig.h
         src/matc/Compiler.h
         src/matc/DirIncluder.h
+        src/matc/Includes.h
+        src/matc/IncludeCallback.h
         src/matc/MaterialCompiler.h
         )
 
 set(SRCS
         src/matc/Compiler.cpp
-        src/matc/MaterialCompiler.cpp
         src/matc/CommandlineConfig.cpp
         src/matc/DirIncluder.cpp
+        src/matc/Includes.cpp
+        src/matc/MaterialCompiler.cpp
         )
 
 # ==================================================================================================
@@ -70,10 +73,12 @@ install(TARGETS ${TARGET} RUNTIME DESTINATION bin)
 # ==================================================================================================
 project(test_matc)
 set(TARGET test_matc)
-set(SRCS tests/test_includer.cpp)
+set(SRCS tests/test_includer.cpp tests/test_includes.cpp)
 
 add_executable(${TARGET} ${SRCS})
 
 target_link_libraries(${TARGET} matlang gtest)
 
+target_include_directories(${TARGET} PRIVATE ${filamat_SOURCE_DIR}/src)
+
 set_target_properties(test_matc PROPERTIES FOLDER Tests)

tools/matc/src/matc/DirIncluder.cpp

@@ -22,7 +22,7 @@
 
 namespace matc {
 
-bool DirIncluder::operator()(const utils::CString& includedBy, filamat::IncludeResult& result) {
+bool DirIncluder::operator()(const utils::CString& includedBy, IncludeResult& result) {
     auto getHeaderPath = [&result, &includedBy, this]() {
         // includedBy is the path to the file that's including result.includeName.
         // If it's empty, then search from the root include directory.

tools/matc/src/matc/DirIncluder.h

@@ -17,7 +17,7 @@
 #ifndef TNT_DIRINCLUDER_H_
 #define TNT_DIRINCLUDER_H_
 
-#include <filamat/IncludeCallback.h>
+#include "IncludeCallback.h"
 
 #include <utils/Path.h>
 
@@ -31,7 +31,7 @@ class DirIncluder {
         mIncludeDirectory = dir;
     }
 
-    bool operator()(const utils::CString& includedBy, filamat::IncludeResult& result);
+    bool operator()(const utils::CString& includedBy, IncludeResult& result);
 
 private:
     utils::Path mIncludeDirectory;

libs/filamat/include/filamat/IncludeCallback.h renamed to tools/matc/src/matc/IncludeCallback.h

@@ -14,14 +14,14 @@
  * limitations under the License.
  */
 
-#ifndef TNT_FILAMAT_INCLUDER_H
-#define TNT_FILAMAT_INCLUDER_H
+#ifndef TNT_INCLUDER_H
+#define TNT_INCLUDER_H
 
 #include <utils/CString.h>
 
 #include <functional>
 
-namespace filamat {
+namespace matc {
 
 struct IncludeResult {
     // The include name of the root file, as if it were being included.
@@ -64,6 +64,6 @@ using IncludeCallback = std::function<bool(
         const utils::CString& includedBy,
         IncludeResult& result)>;
 
-} // namespace filamat
+} // namespace matc
 
 #endif

libs/filamat/src/Includes.cpp renamed to tools/matc/src/matc/Includes.cpp

@@ -14,15 +14,15 @@
  * limitations under the License.
  */
 
-#include <filamat/Includes.h>
+#include "Includes.h"
 
 #include <utils/Log.h>
 #include <utils/compiler.h>
 #include <utils/sstream.h>
 
 #include <string>
 
-namespace filamat {
+namespace matc {
 
 static bool isWhitespace(char c) {
     return (c == ' ' || c == '\f' || c == '\n' || c == '\r' || c == '\t' || c == '\v');
@@ -308,4 +308,4 @@ std::vector<FoundInclude> parseForIncludes(const utils::CString& source) {
     return results;
 }
 
-} // namespace filamat
+} // namespace matc

libs/filamat/include/filamat/Includes.h renamed to tools/matc/src/matc/Includes.h

@@ -14,16 +14,16 @@
  * limitations under the License.
  */
 
-#ifndef TNT_FILAMAT_INCLUDES_H
-#define TNT_FILAMAT_INCLUDES_H
+#ifndef TNT_INCLUDES_H
+#define TNT_INCLUDES_H
 
-#include <filamat/IncludeCallback.h>
+#include "IncludeCallback.h"
 
-#include <utils/CString.h>
+#include "utils/CString.h"
 
 #include <vector>
 
-namespace filamat {
+namespace matc {
 
 struct ResolveOptions {
     // If true, insert #line directives before / after each include.
@@ -53,6 +53,6 @@ struct FoundInclude {
 
 std::vector<FoundInclude> parseForIncludes(const utils::CString& source);
 
-} // namespace filamat
+} // namespace matc
 
 #endif