update from nextgeniuspro (nextgeniuspro#7)

* Add CloseFile override for ZipFileSystem

add gitignore for out (default for CPM/FetchContent/Visual Studio in-source builds)

* Optional build of examples

added library alias target for conformity
Modified examples for in-lib build

* using binary mode for opening NativeFile

* Update miniz-cpp submodule url

* Update readme

---------

Co-authored-by: Yev <evg1985@gmail.com>

Author: psyinf

.gitignore

@@ -30,3 +30,5 @@
 /build
 /examples/build
 .vscode/settings.json
+
+/out/**

.gitmodules

@@ -1,3 +1,3 @@
 [submodule "vendor/miniz-cpp"]
 	path = vendor/miniz-cpp
-	url = https://github.com/tfussell/miniz-cpp.git
+	url = https://github.com/nextgeniuspro/miniz-cpp.git

CMakeLists.txt

@@ -2,7 +2,7 @@ cmake_minimum_required(VERSION 3.10)
 
 # Project name and version
 project(vfspp VERSION 1.0 LANGUAGES CXX)
-
+option(BUILD_EXAMPLES "Build examples" OFF)
 # Add the miniz-cpp library
 add_subdirectory(vendor/miniz-cpp EXCLUDE_FROM_ALL)
 
@@ -13,6 +13,7 @@ set(CMAKE_CXX_EXTENSIONS OFF)
 
 # Add the include directory as a target
 add_library(vfspp INTERFACE)
+add_library(vfspp::vfspp ALIAS vfspp)
 
 target_include_directories(vfspp
     INTERFACE 
@@ -21,4 +22,8 @@ target_include_directories(vfspp
         $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/vendor/miniz-cpp>
 )
 
-target_compile_features(vfspp INTERFACE cxx_std_17)
+target_compile_features(vfspp INTERFACE cxx_std_17)
+
+if (BUILD_EXAMPLES)
+add_subdirectory(examples)
+endif()

README.md

@@ -142,11 +142,13 @@ See examples/CMakeLists.txt for example of usage
 
 ## How To Build Example #
 
-- Navigate to 'examples' directory
+- Run cmake to generate project windows project files
 ```bash
-cd examples
-```
-- Run cmake to generate project
+cmake -B ./build -G "Visual Studio 17 2022" . -DBUILD_EXAMPLES=1
+``` 
+or to generate Xcode project files
 ```bash
-cmake -B ./build -G "Visual Studio 17 2022" .
+cmake -B ./build -G "Xcode" . -DBUILD_EXAMPLES=1
 ```
+
+- Open generated project files and build the target `vfsppexample`

examples/CMakeLists.txt

@@ -2,21 +2,20 @@ cmake_minimum_required(VERSION 3.10)
 
 project(vfsppexample)
 
-add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/.. vfspp_build)
+#add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/.. vfspp_build)
 
 add_executable(vfsppexample example.cpp)
 
 add_compile_definitions(VFSPP_ENABLE_MULTITHREADING)
 
-target_link_libraries(vfsppexample PRIVATE vfspp)
+target_link_libraries(vfsppexample PRIVATE vfspp::vfspp)
 target_compile_features(vfsppexample PRIVATE cxx_std_17)
 
 # Specify the output directory
+set(COPY_SOURCE ${CMAKE_SOURCE_DIR}/examples/test-data)
 set(COPY_DESTINATION ${CMAKE_CURRENT_BINARY_DIR}/test-data)
 
 # Add a post-build step to copy the whole directory
 add_custom_command(TARGET vfsppexample POST_BUILD
-    COMMAND ${CMAKE_COMMAND} -E copy_directory
-    ${CMAKE_SOURCE_DIR}/test-data
-    ${COPY_DESTINATION}
+    COMMAND ${CMAKE_COMMAND} -E copy_directory ${COPY_SOURCE} ${COPY_DESTINATION}
 )

include/vfspp/NativeFile.hpp

@@ -246,7 +246,7 @@ class NativeFile final : public IFile
         m_Mode = mode;
         m_IsReadOnly = true;
 
-        std::ios_base::openmode open_mode = (std::ios_base::openmode)0x00;
+        std::ios_base::openmode open_mode = std::ios_base::binary;
         if ((mode & FileMode::Read) == FileMode::Read) {
             open_mode |= std::fstream::in;
         }

include/vfspp/ZipFileSystem.hpp

@@ -144,7 +144,13 @@ class ZipFileSystem final : public IFileSystem
     {
         return false;
     }
-
+    /*
+    * Close file 
+    */
+    virtual void CloseFile(IFilePtr file) override
+    {
+        //NO-OP
+    }
     /*
      * Check if file exists on filesystem
      */