Tymii/17 inconsistent file naming (#19)

* Fix inconsistent file & namespace naming

* Fix clang format

* fix casing uwu

* gh checks

* casing

* casing

* fix chmod for scripts

* fix cmakelists

* meow

* cmakelists

* github

* owo

* fix namespace Detail references

* FormatCheckDiff.sh

* format code

* Fix builds

* Fix shaders

---------

Co-authored-by: Karn Kaul <karnkaul@gmail.com>

Author: TymianekPL

.github/format_check_diff.sh renamed to .github/FormatCheckDiff.sh

@@ -6,9 +6,9 @@ jobs:
     steps:
       - uses: actions/checkout@v4
       - name: format code
-        run: scripts/format_code.sh
+        run: chmod a+x Scripts/FormatCode.sh; Scripts/FormatCode.sh
       - name: check diff
-        run: .github/format_check_diff.sh
+        run: chmod a+x .github/FormatCheckDiff.sh; .github/FormatCheckDiff.sh
   linux-gcc:
     runs-on: ubuntu-latest
     steps:

.github/workflows/ci.yml

@@ -1,14 +1,14 @@
-project(${project_name}-app)
+project(${project_name}-App)
 
 add_executable(${PROJECT_NAME})
 
 target_link_libraries(${PROJECT_NAME} PRIVATE
-  ${project_name}::lib
+  ${project_name}::Lib
 )
 
-target_precompile_headers(${PROJECT_NAME} REUSE_FROM ${project_name}-lib)
+target_precompile_headers(${PROJECT_NAME} REUSE_FROM ${project_name}-Lib)
 
-file(GLOB_RECURSE sources LIST_DIRECTORIES false "src/*.[hc]pp")
+file(GLOB_RECURSE sources LIST_DIRECTORIES false "Src/*.[hc]pp")
 target_sources(${PROJECT_NAME} PRIVATE
   ${sources}
 )

app/CMakeLists.txt renamed to App/CMakeLists.txt

@@ -1,11 +1,11 @@
 #include <imgui.h>
+#include <Tkge/Engine.hpp>
+#include <Tkge/Graphics/Shader.hpp>
 #include <klib/assert.hpp>
-#include <tkge/engine.hpp>
 #include <exception>
 #include <print>
 
-// temporary, until we have shader assets.
-#include <tkge/graphics/shader.hpp>
+// temporary, until we have shader Assets.
 #include <filesystem>
 #include <fstream>
 #include <vector>
@@ -41,27 +41,27 @@ namespace
 
 	void Run(const fs::path& assets_path)
 	{
-		static constexpr tkge::WindowSurface surface{.size = {1280, 720}};
-		tkge::Engine engine{surface};
+		static constexpr Tkge::WindowSurface surface{.size = {1280, 720}};
+		Tkge::Engine engine{surface};
 
-		auto shader = tkge::graphics::Shader{};
-		const auto vertexSpirV = LoadSpirV((assets_path / "shaders/default.vert").string().c_str());
-		const auto fragmentSpirV = LoadSpirV((assets_path / "shaders/default.frag").string().c_str());
+		auto shader = Tkge::Graphics::Shader{};
+		const auto vertexSpirV = LoadSpirV((assets_path / "Shaders/Default.vert").string().c_str());
+		const auto fragmentSpirV = LoadSpirV((assets_path / "Shaders/Default.frag").string().c_str());
 		const auto& renderDevice = engine.RenderDevice();
 		if (!shader.Load(renderDevice.get_device(), vertexSpirV, fragmentSpirV)) { throw std::runtime_error{"Failed to load shaders"}; }
 
 		constexpr auto vertices = std::array{
-			tkge::graphics::Vertex{.position = {-0.5f, -0.5f}, .colour = kvf::red_v.to_vec4()},
-			tkge::graphics::Vertex{.position = {0.5f, -0.5f}, .colour = kvf::green_v.to_vec4()},
-			tkge::graphics::Vertex{.position = {0.5f, 0.5f}, .colour = kvf::blue_v.to_vec4()},
-			tkge::graphics::Vertex{.position = {-0.5f, 0.5f}, .colour = kvf::yellow_v.to_vec4()},
+			Tkge::Graphics::Vertex{.position = {-0.5f, -0.5f}, .colour = kvf::red_v.to_vec4()},
+			Tkge::Graphics::Vertex{.position = {0.5f, -0.5f}, .colour = kvf::green_v.to_vec4()},
+			Tkge::Graphics::Vertex{.position = {0.5f, 0.5f}, .colour = kvf::blue_v.to_vec4()},
+			Tkge::Graphics::Vertex{.position = {-0.5f, 0.5f}, .colour = kvf::yellow_v.to_vec4()},
 		};
 
 		constexpr auto indices = std::array{
 			0u, 1u, 2u, 2u, 3u, 0u,
 		};
 
-		const auto primitive = tkge::graphics::Primitive{
+		const auto primitive = Tkge::Graphics::Primitive{
 			.vertices = vertices,
 			.indices = indices,
 		};
@@ -100,7 +100,7 @@ int main([[maybe_unused]] int argc, char** argv)
 	try
 	{
 		KLIB_ASSERT(argc > 0);
-		const auto assets_path = Upfind(*argv, "assets");
+		const auto assets_path = Upfind(*argv, "Assets");
 		Run(assets_path);
 	}
 	catch (const std::exception& e)

app/src/main.cpp renamed to App/Src/Main.cpp

@@ -1,14 +1,14 @@
 cmake_minimum_required(VERSION 3.24)
 
-set(project_name tkge)
+set(project_name Tkge)
 project(${project_name})
 
 set(CMAKE_CXX_STANDARD 23)
 set(CMAKE_CXX_STANDARD_REQUIRED ON)
 set(CMAKE_CXX_EXTENSIONS OFF)
 set(CMAKE_DEBUG_POSTFIX "-d")
 
-add_subdirectory(ext)
+add_subdirectory(Ext)
 
-add_subdirectory(lib)
-add_subdirectory(app)
+add_subdirectory(Lib)
+add_subdirectory(App)

assets/shaders/default.frag renamed to Assets/Shaders/Default.frag

@@ -1,14 +1,14 @@
-project(${project_name}-lib)
+project(${project_name}-Lib)
 
 add_library(${PROJECT_NAME})
-add_library(${project_name}::lib ALIAS ${PROJECT_NAME})
+add_library(${project_name}::Lib ALIAS ${PROJECT_NAME})
 
 target_include_directories(${PROJECT_NAME} PUBLIC
-  include
+  Include
 )
 
 target_include_directories(${PROJECT_NAME} PRIVATE
-  src
+  Src
 )
 
 target_link_libraries(${PROJECT_NAME} PUBLIC
@@ -23,6 +23,6 @@ target_precompile_headers(${PROJECT_NAME} PRIVATE
   <vulkan/vulkan.hpp>
 )
 
-file(GLOB_RECURSE sources LIST_DIRECTORIES false "src/*.[hc]pp")
+file(GLOB_RECURSE sources LIST_DIRECTORIES false "Src/*.[hc]pp")
 target_sources(${PROJECT_NAME} PRIVATE
   ${sources})

assets/shaders/default.vert renamed to Assets/Shaders/Default.vert

@@ -1,11 +1,11 @@
 #pragma once
 
-#include <tkge/Assets/IAsset.hpp>
+#include <Tkge/Assets/IAsset.hpp>
 #include <filesystem>
 #include <string>
 #include <type_traits>
 
-namespace tkge
+namespace Tkge
 {
 	class AssetLoader
 	{
@@ -39,4 +39,4 @@ namespace tkge
 	  private:
 		std::vector<std::filesystem::path> _paths;
 	};
-} // namespace tkge
+} // namespace Tkge

CMakeLists.txt

@@ -1,14 +1,14 @@
 #pragma once
 
+#include <klib/polymorphic.hpp>
 #include <cstddef>
-#include <fstream>
 #include <memory>
 #include <span>
 #include <string>
 
-namespace tkge::Assets
+namespace Tkge::Assets
 {
-	namespace detail
+	namespace Detail
 	{
 		enum struct MemoryFileCapabilities : std::uint8_t
 		{
@@ -67,7 +67,7 @@ namespace tkge::Assets
 			/// <returns>Capabilities of the implementation</returns>
 			[[nodiscard]] virtual MemoryFileCapabilities Capabilities() const noexcept = 0;
 		};
-	} // namespace detail
+	} // namespace Detail
 
 	class ReadonlyByteStream
 	{
@@ -128,13 +128,12 @@ namespace tkge::Assets
 		std::span<std::byte> ReadChunk(std::size_t offset, std::size_t size, bool prefetchMemory);
 		std::span<const std::byte> ReadChunk(std::size_t offset, std::size_t size, bool prefetchMemory) const;
 
-		std::unique_ptr<detail::MemoryMappedFile> _file;
+		std::unique_ptr<Detail::MemoryMappedFile> _file;
 	};
 
-	class IAsset
+	class IAsset : public klib::Polymorphic
 	{
 	  public:
-		virtual ~IAsset() = default;
 		virtual bool Load(ReadonlyByteStream) = 0;
 	};
-} // namespace tkge::Assets
+} // namespace Tkge::Assets

ext/.gitignore renamed to Ext/.gitignore

@@ -2,7 +2,7 @@
 
 #include "IAsset.hpp"
 
-namespace tkge::Assets
+namespace Tkge::Assets
 {
 	class TextAsset final : public IAsset
 	{
@@ -15,4 +15,4 @@ namespace tkge::Assets
 	  private:
 		std::string _text;
 	};
-} // namespace tkge::Assets
+} // namespace Tkge::Assets

ext/CMakeLists.txt renamed to Ext/CMakeLists.txt

@@ -1,14 +1,14 @@
 #pragma once
+#include <Tkge/AssetLoader.hpp>
+#include <Tkge/Graphics/Renderer.hpp>
 #include <glm/vec2.hpp>
 #include <klib/c_string.hpp>
 #include <kvf/color.hpp>
 #include <kvf/render_device.hpp>
 #include <kvf/render_pass.hpp>
 #include <kvf/window.hpp>
-#include <tkge/assetLoader.hpp>
-#include <tkge/graphics/renderer.hpp>
 
-namespace tkge
+namespace Tkge
 {
 	struct WindowSurface
 	{
@@ -32,7 +32,7 @@ namespace tkge
 
 		[[nodiscard]] bool IsRunning() const;
 		vk::CommandBuffer NextFrame();
-		[[nodiscard]] graphics::Renderer BeginRender(kvf::Color clear = kvf::black_v);
+		[[nodiscard]] Graphics::Renderer BeginRender(kvf::Color clear = kvf::black_v);
 		void Present();
 
 		[[nodiscard]] AssetLoader& GetAssetLoader() noexcept { return this->_assetLoader; }
@@ -45,9 +45,9 @@ namespace tkge
 		kvf::RenderDevice _renderDevice;
 		kvf::RenderPass _renderPass;
 
-		std::unique_ptr<graphics::IResourcePool> _resourcePool{};
+		std::unique_ptr<Graphics::IResourcePool> _resourcePool{};
 
 		vk::CommandBuffer _cmd{};
 		AssetLoader _assetLoader;
 	};
-} // namespace tkge
+} // namespace Tkge

ext/src.zip renamed to Ext/src.zip

@@ -1,7 +1,7 @@
 #pragma once
 #include <vulkan/vulkan.hpp>
 
-namespace tkge::graphics
+namespace Tkge::Graphics
 {
 	/// \brief Description of a unique Pipeline's fixed state.
 	struct PipelineFixedState
@@ -12,4 +12,4 @@ namespace tkge::graphics
 		vk::PrimitiveTopology topology{vk::PrimitiveTopology::eTriangleList};
 		vk::PolygonMode polygonMode{vk::PolygonMode::eFill};
 	};
-} // namespace tkge::graphics
+} // namespace Tkge::Graphics

lib/CMakeLists.txt renamed to Lib/CMakeLists.txt

@@ -1,8 +1,8 @@
 #pragma once
-#include <tkge/graphics/vertex.hpp>
+#include <Tkge/Graphics/Vertex.hpp>
 #include <span>
 
-namespace tkge::graphics
+namespace Tkge::Graphics
 {
 	struct Primitive
 	{
@@ -11,4 +11,4 @@ namespace tkge::graphics
 
 		vk::PrimitiveTopology topology{vk::PrimitiveTopology::eTriangleList};
 	};
-} // namespace tkge::graphics
+} // namespace Tkge::Graphics

lib/include/tkge/assetLoader.hpp renamed to Lib/Include/Tkge/AssetLoader.hpp

@@ -1,9 +1,9 @@
 #pragma once
+#include <Tkge/Graphics/Primitive.hpp>
+#include <Tkge/Graphics/ResourcePool.hpp>
 #include <kvf/render_pass.hpp>
-#include <tkge/graphics/primitive.hpp>
-#include <tkge/graphics/resource_pool.hpp>
 
-namespace tkge::graphics
+namespace Tkge::Graphics
 {
 	class Renderer
 	{
@@ -40,4 +40,4 @@ namespace tkge::graphics
 		vk::PolygonMode _polygonMode{vk::PolygonMode::eFill};
 		float _lineWidth{1.0f};
 	};
-} // namespace tkge::graphics
+} // namespace Tkge::Graphics

lib/include/tkge/Assets/IAsset.hpp renamed to Lib/Include/Tkge/Assets/IAsset.hpp

@@ -1,9 +1,9 @@
 #pragma once
+#include <Tkge/Graphics/PipelineFixedState.hpp>
+#include <Tkge/Graphics/Shader.hpp>
 #include <kvf/vma.hpp>
-#include <tkge/graphics/pipeline_fixed_state.hpp>
-#include <tkge/graphics/shader.hpp>
 
-namespace tkge::graphics
+namespace Tkge::Graphics
 {
 	using Buffer = kvf::vma::Buffer;
 
@@ -21,4 +21,4 @@ namespace tkge::graphics
 		/// \brief Allocate a Buffer for given usage and of given size.
 		[[nodiscard]] virtual Buffer& AllocateBuffer(vk::BufferUsageFlags usage, vk::DeviceSize size) = 0;
 	};
-} // namespace tkge::graphics
+} // namespace Tkge::Graphics

lib/include/tkge/Assets/TextAsset.hpp renamed to Lib/Include/Tkge/Assets/TextAsset.hpp

@@ -3,7 +3,7 @@
 #include <cstdint>
 #include <span>
 
-namespace tkge::graphics
+namespace Tkge::Graphics
 {
 	class Shader
 	{
@@ -20,4 +20,4 @@ namespace tkge::graphics
 		vk::UniqueShaderModule _fragment{};
 		std::size_t _hash{};
 	};
-} // namespace tkge::graphics
+} // namespace Tkge::Graphics

lib/include/tkge/engine.hpp renamed to Lib/Include/Tkge/Engine.hpp

@@ -2,12 +2,12 @@
 #include <glm/vec2.hpp>
 #include <glm/vec4.hpp>
 
-namespace tkge::graphics
+namespace Tkge::Graphics
 {
 	struct Vertex
 	{
 		glm::vec2 position{};
 		glm::vec4 colour{1.0f};
 		glm::vec2 uv{};
 	};
-} // namespace tkge::graphics
+} // namespace Tkge::Graphics

lib/include/tkge/graphics/pipeline_fixed_state.hpp renamed to Lib/Include/Tkge/Graphics/PipelineFixedState.hpp

@@ -1,10 +1,10 @@
 #pragma once
-#include <tkge/graphics/vertex.hpp>
+#include <Tkge/Graphics/Vertex.hpp>
 #include <cstdint>
 #include <span>
 #include <vector>
 
-namespace tkge::graphics
+namespace Tkge::Graphics
 {
 	struct VertexArray
 	{
@@ -15,4 +15,4 @@ namespace tkge::graphics
 		void Clear();
 		auto Append(std::span<const Vertex> vertices, std::span<const std::uint32_t> indices) -> VertexArray&;
 	};
-} // namespace tkge::graphics
+} // namespace Tkge::Graphics

lib/include/tkge/graphics/primitive.hpp renamed to Lib/Include/Tkge/Graphics/Primitive.hpp

@@ -1,4 +1,4 @@
-#include <tkge/assetLoader.hpp>
+#include <Tkge/AssetLoader.hpp>
 #include <filesystem>
 
 #ifdef _WIN32
@@ -10,7 +10,7 @@
 #include <minwindef.h>
 #endif
 
-std::vector<std::filesystem::path> tkge::AssetLoader::GetSearchPaths() const
+std::vector<std::filesystem::path> Tkge::AssetLoader::GetSearchPaths() const
 {
 	std::vector<std::filesystem::path> paths{};
 
@@ -21,7 +21,7 @@ std::vector<std::filesystem::path> tkge::AssetLoader::GetSearchPaths() const
 	GetModuleFileNameA(nullptr, buffer, MAX_PATH);
 
 	paths.push_back(std::filesystem::path{buffer}.parent_path());
-	paths.push_back(paths.back() / "assets");
+	paths.push_back(paths.back() / "Assets");
 #else
 #endif