103 migrate the build system to build master (#104)

* VSC: Migrated build system to build master

* [VSC] [No Functional Change] Removed stray files and some more tiny changes

* [SGE] Migrated build system to build master (meson)

* Updated README.md

* [VSC] Removed unncessary headers and fixed build issues

* [VSC] Added SC_RELEASE and SC_DEBUG defines in their respective build type

* [VSC] Potential build fix, added defines for build and use of the library

* [SGE] Fixed potential build issue, added library build and use defines.

* [DISASM] Migrated build system to build master (meson)

* [SGE] Added build_shaders.makefile, README.md improve, and other minor things

Author: ravi688

README.md

@@ -76,11 +76,20 @@ There are only C and C++ interface headers for now. <br>
    $ pacman -S git
    ```
 
-6. **glslc**, glslc can be installed as follows, run the following in MSYS2 MinGW shell <br>
+6. **glslc** and **shaderc**, glslc can be installed as follows, run the following in MSYS2 MinGW shell <br>
 
    ```
    $ pacman -S mingw-w64-x86_64-shaderc
    ```
+7. **Freetype2**, run the following in MSYS2 MinGW shell <br>
+   ```
+   $ pacman -S mingw-w64-x86_64-freetype
+   ```
+8. **Vulkan Headers**
+   ```
+   meson wrap install vulkan-headers
+   meson wrap install glfw
+   ```
 
 ### Requirements for building on Linux (Debian)
 
@@ -153,11 +162,17 @@ There are only C and C++ interface headers for now. <br>
    $ sudo apt-get install libz-dev
    $ sudo apt-get install libpng-dev
    $ sudo apt-get install libbrotli-dev
+   $ sudo apt-get install libfreetype-dev
    ```
 7. On wayland you would need the following package:
    ```
    $ sudo apt-get install libwayland-dev
    ```
+8. **Vulkan Headers**
+   ```
+   meson wrap install vulkan-headers
+   meson wrap install glfw
+   ```
 
 ### Requirements for building on FreeBSD
 Currently you can't build the codebase in FreeBSD environment. There are many issues right now.
@@ -194,63 +209,62 @@ For now, you would need to do the following:
 4. Disk space - No data as of now
 5. Better to have Vulkan LunarG SDK installed for additional debugging and vulkan configuration (validation layers), but it is not a requirement because the static library and headers are already included in the repository and would be updated as new updates will come in future.
 
-### Building steps
+### Building Shaders
+```
+$ make -f build_shaders.makefile all
+```
+
+### Building and Installing SGE
 
 1. Clone the repository by running the following command <br>
 
    ```
    $git clone https://github.com/ravi688/VulkanRenderer.git
    ```
 
-2. Change the working directory to `VulkanRenderer` and setup all the dependency git submodules by running the following command
+2. Change the working directory to `VulkanRenderer`
+3. Start building by running the following commands
 
    ```
-   $cd VulkanRenderer
-   $make -s setup
+   $ meson setup build --buildtype=debug
+   $ meson compile -C build
    ```
-
-3. Start building by running the following command
-   
+4. Install SGE as a Library (Usable via pkg-conf)
    ```
-   $make -s build
+   $ meson install -C build
    ```
-   
-   OR
-   
+5. Verify Installation by running pkg-config as follows
    ```
-   $make -s build-debug
+   pkg-config sge_static --cflags --libs
    ```
-   
-   For release mode
-   
+   OR
    ```
-   $make -s build-release
+   pkg-config sge_shared --cflags --libs
    ```
+   It must print include header and link libraries directories which you can pass into your gcc or clang compiler/linker.
 
-### Building executable manually (Optional)
+### Using SGE as a meson dependency wrap
+Create a wrap file `sge_static.wrap` (for static library) in your meson project's `subprojects` directory.
+Populate it with the following content:
+```yaml
+[wrap-git]
+url = https://github.com/ravi688/VulkanRenderer.git
+revision = head
+depth = 1
 
-1. Change the working directory to `VulkanRenderer` and build the `main` executable by running the following command
-   
-   ```
-   $make -s debug
-   ```
-
-2. Now run the `main` executable by running the following command
-   
-   ```
-   $./main
-   ```
+[provide]
+sge_static = sge_static_dep
+```
 
 ### Test Run (Optional)
 There are several tests which you can try running by just passing arguments:
 ```
-$cd <build directory>
-$./main CUBE
+$./build/main_test CUBE
 ```
 The above set of commands would launch a window in which a white cube will be spinning.
 If you want to see all the possible test cases, you may launch the execution without any arguments and it would just print the list of possible test cases:
 ```
-$./main
+$./build/main
 supported tests:
         DEPTH_RENDER_TEXTURE
         DEPTH_RENDER_TEXTURE_LOAD
@@ -286,13 +300,15 @@ supported tests:
         TID_48_CASE_5
 ```
 
-### Cleaning everything  (Optional)
-
-1. Change the working directory to `VulkanRenderer` and run the following command
-   
-   ```
-   $make -s clean
-   ```
+### Cleaning SGE
+Change the working directory to `VulkanRenderer` and run the following command
+```
+$ meson setup build --wipe
+```
+### Cleaning Shaders
+```
+make -f build_shaders.makefile clean
+```
 
 ### Building SUTK (Spectrum UI Toolkit)
 #### On Windows (MSYS)

add_notice.makefile

@@ -0,0 +1,11 @@
+#-----------------------------------------
+# 		Legal
+#-----------------------------------------
+
+PYTHON:=python
+LEGAL_NOTICE_PYTHON_SCRIPT:=source/legal/legal_notice.py
+
+.PHONY: legal
+
+legal:
+	$(PYTHON) $(LEGAL_NOTICE_PYTHON_SCRIPT)

build_master.json

@@ -0,0 +1,77 @@
+{
+    "project_name": "SGE",
+    "description" : "Low level 2D and 3D Rendering Framework",
+    "canonical_name": "sge",
+    "dependencies" : [
+        "shader_compiler",
+        "common",
+        "glslcommon",
+        "hpml", 
+        "meshlib",
+        "vulkanheaders",
+        "freetype2",
+        "glfw3",
+        "ttf2mesh",
+        "shaderc"
+    ],
+    "install_header_dirs" : ["include/sge", "include/sge-cpp"],
+    "include_dirs": "include",
+    "defines" : [
+        "-DSGE_VULKAN_DRIVER"
+    ],
+    "debug_defines" : [
+        "-DGLOBAL_DEBUG",
+        "-DDEBUG",
+        "-DSGE_DEBUG",
+        "-DLOG_DEBUG"
+    ],
+    "release_defines" : [
+        "-DGLOBAL_RELEASE",
+        "-DRELEASE",
+        "-DSGE_RELEASE",
+        "-DLOG_RELEASE"
+    ],
+    "vars" :
+    {
+        "test_sources" : "run_command('find', 'source/tests', '-maxdepth', '1', '-type', 'f', check : false).stdout().strip().split()",
+        "sge_sources" : "run_command('find', 'source/sge', '-maxdepth', '3', '-type', 'f', check : false).stdout().strip().split()",
+        "sge_cpp_sources" : "run_command('find', 'source/sge-cpp', '-maxdepth', '3', '-type', 'f', check : false).stdout().strip().split()",
+        "stb_sources" : "run_command('find', 'source/stb', '-maxdepth', '1', '-type', 'f', check : false).stdout().strip().split()",
+        "vulkan_sdk_path" : "run_command(find_program('python'), '-c', 'import os; print(os.environ[\"VK_SDK_PATH\"])', check : false).stdout().strip()",
+        "vulkan_libs_path" : "vulkan_sdk_path + '/Lib/'"
+    },
+    "windows_link_args" : ["link_dir: $vulkan_libs_path", "-lvulkan-1"],
+    "linux_link_args" : ["link_dir: $vulkan_libs_path", "-lvulkan-1"],
+    "targets": [
+        {
+            "name": "main_test",
+            "description" : "Test Executable for SGE",
+            "is_executable": true,
+            "sources": [
+                "source/main.c",
+                "source/test.c",
+                "source/legal/legal.c",
+                "$test_sources"
+            ]
+        },
+        {
+            "name" : "sge_static",
+            "description" : "Static Library for SGE",
+            "is_static_library" : true,
+            "build_defines" : [ "-DSGE_BUILD_STATIC_LIBRARY" ],
+            "use_defines" : [ "-DSGE_USE_STATIC_LIBRARY" ]
+        },
+        {
+            "name" : "sge_shared",
+            "description" : "Shared Library for SGE",
+            "is_shared_library" : true,
+            "build_defines" : [ "-DSGE_BUILD_DYNAMIC_LIBRARY" ],
+            "use_defines" : [ "-DSGE_USE_DYNAMIC_LIBRARY" ]
+        }
+    ],
+    "sources" : [
+        "$sge_sources",
+        "$sge_cpp_sources",
+        "$stb_sources"
+    ]
+}

build_shaders.makefile

@@ -0,0 +1,96 @@
+# Platform Detection
+include platform.Makefile
+
+#-------------------------------------------
+#		Shader Compilation
+#-------------------------------------------
+SHADER_INCLUDES = -I$(wildcard shaders/include/)
+
+VSC_BUILD_DIR := ./.shader_compiler.build
+VSC_SOURCE_DIR := ./toolchain/shader_compiler
+SHADER_COMPILER = $(VSC_BUILD_DIR)/vsc
+# toolchain/shader_compiler/makefile creates vsc.exe executable, while the targets 'shader-release' and 'shader-debug' check for 'vsc'
+# this leads to unconditionally compiling the .v3dshader files everytime 'make -s build' is triggered
+ifeq (Windows,$(PLATFORM))
+	SHADER_COMPILER := $(addsuffix .exe,$(SHADER_COMPILER))
+endif
+SHADER_SOURCES = $(wildcard ./shaders/*/*.v3dshader ./shaders/*/*/*.v3dshader)
+SHADER_BINARIES = $(subst .v3dshader,.sb, $(SHADER_SOURCES))
+
+SHADER_COMPILER_COMPILATION_MODE =
+
+# Meson build system
+MESON := meson
+
+$(SHADER_COMPILER):
+	$(MESON) setup $(VSC_BUILD_DIR) $(VSC_SOURCE_DIR) --reconfigure --buildtype=$(SHADER_COMPILER_COMPILATION_MODE)
+	$(MESON) compile -C $(VSC_BUILD_DIR)
+
+%.sb: %.v3dshader $(SHADER_COMPILER)
+	$(SHADER_COMPILER) $(SHADER_INCLUDES) $< $@
+
+
+.PHONY: vsc
+.PHONY: vsc-debug
+.PHONY: vsc-release
+.PHONY: vsc-clean
+
+vsc: vsc-debug
+vsc-debug: SHADER_COMPILER_COMPILATION_MODE += debug
+vsc-debug: $(SHADER_COMPILER)
+vsc-release: SHADER_COMPILER_COMPILATION_MODE += release
+vsc-release: $(SHADER_COMPILER)
+
+vsc-clean:
+	$(RM) -rf $(VSC_BUILD_DIR)
+
+.PHONY: shader-debug
+.PHONY: shader-release
+.PHONY: shader
+.PHONY: shader-clean
+
+shader-debug: vsc-debug
+shader-debug: $(SHADER_BINARIES)
+shader-release: vsc-release
+shader-release: $(SHADER_BINARIES)
+shader: shader-debug
+
+shader-clean:
+ifeq (Windows,$(PLATFORM))
+	$(RM) $(subst /,\, $(SHADER_BINARIES))
+endif
+ifeq (Linux,$(PLATFORM))
+	$(RM) $(SHADER_BINARIES)
+endif
+
+
+GLSL_SHADERS = $(wildcard shaders/*.frag shaders/*.vert shaders/*/*.frag shaders/*/*.vert shaders/*/*/*.frag shaders/*/*/*.vert shaders/*/*/*/*.frag shaders/*/*/*/*.vert)
+SPIRV_SHADERS = $(addsuffix .spv, $(GLSL_SHADERS))
+SPIRV_COMPILER = glslc
+
+%.vert.spv: %.vert
+	$(SPIRV_COMPILER) $(SHADER_INCLUDES) $< -o $@
+%.frag.spv: %.frag
+	$(SPIRV_COMPILER) $(SHADER_INCLUDES) $< -o $@
+
+.PHONY: glsl-shader
+.PHONY: glsl-shader-clean
+
+glsl-shader: $(SPIRV_SHADERS)
+
+glsl-shader-clean:
+ifeq (Windows,$(PLATFORM))
+	$(RM) $(subst /,\, $(SPIRV_SHADERS))
+endif
+ifeq (Linux,$(PLATFORM))
+	$(RM) $(SPIRV_SHADERS)
+endif
+
+.PHONY: all
+all : glsl-shader shader-debug
+
+.PHONY: clean
+
+clean : glsl-shader-clean shader-clean vsc-clean
+
+#-------------------------------------------