Add comments about WIN32 support (#39)

Author: gitbuda

CMakeLists.txt

@@ -1,16 +1,22 @@
 cmake_minimum_required(VERSION 3.10)
 
-find_program(CLANG_FOUND clang)
-find_program(CLANGXX_FOUND clang++)
-if (CLANG_FOUND AND CLANGXX_FOUND)
-  set(CMAKE_C_COMPILER ${CLANG_FOUND})
-  set(CMAKE_CXX_COMPILER ${CLANGXX_FOUND})
-else()
-  message(FATAL_ERROR "Clang and Clang++ are required!")
-endif()
+# NOTES
+#
+# HOW TO CHANGE THE COMPILER?
+# If you want to use specific compiler, consider using -C | --cc | --cxx cmake-js flags.
+#
+# WINDOWS AND MINGW ISSUES?
+# cmake-js doesn't support MinGW Makefiles -> https://github.com/cmake-js/cmake-js/issues/195
+# /DELAYLOAD:NODE.EXE: No such file or directory -> https://github.com/cmake-js/cmake-js/issues/200
+# cmake-js adds /DELAYLOAD:NODE.EXE + there is not an easy solution -> Move to node-gyp
+# I've played with paths + setting the CMAKE_SHARED_LINKER_FLAGS but all that is N/A.
+# The following does not work because CMake changes the string to be Windows path.
+# set(CMAKE_SHARED_LINKER_FLAGS "/DELAYLOAD:/c/Program\\ Files/nodejs/node.exe")
 
 project(nodemgclient VERSION 0.1.0)
 
+find_package(OpenSSL REQUIRED)
+
 set(CMAKE_C_STANDARD 11)
 set(CMAKE_CXX_STANDARD 17)
 set(C_STANDARD_REQUIRED ON)
@@ -27,7 +33,13 @@ set_project_warnings(project_warnings)
 
 include(ExternalProject)
 
-# Add mgclient as a library.
+if (WIN32 AND MINGW)
+    message(FATAL_ERROR "ON WINDOWS BUILD UNDER MINGW NOT YES POSSIBLE")
+elseif (APPLE)
+    message(FATAL_ERROR "ON APPLE BUILD NOT YET POSSIBLE")
+endif()
+
+# Add mgclient as an imported library.
 ExternalProject_Add(mgclient-proj
                     PREFIX         mgclient
                     GIT_REPOSITORY https://github.com/memgraph/mgclient.git
@@ -39,18 +51,27 @@ ExternalProject_Get_Property(mgclient-proj install_dir)
 set(MGCLIENT_ROOT ${install_dir})
 set(MGCLIENT_INCLUDE_DIRS ${MGCLIENT_ROOT}/include
     CACHE INTERNAL "Path to mgclient include directory")
-set(MGCLIENT_LIBRARY_PATH ${MGCLIENT_ROOT}/lib/libmgclient.so)
+if (UNIX AND NOT APPLE)
+    set(MGCLIENT_LIBRARY_PATH ${MGCLIENT_ROOT}/lib/libmgclient.so)
+elseif (WIN32 AND MINGW)
+    set(MGCLIENT_LIBRARY_PATH ${MGCLIENT_ROOT}/lib/libmgclient.dll)
+endif()
+message(STATUS "MGCLIENT_LIBRARY_PATH: ${MGCLIENT_LIBRARY_PATH}")
 set(MGCLIENT_LIBRARY mgclient-lib)
 add_library(${MGCLIENT_LIBRARY} SHARED IMPORTED)
-set_target_properties(${MGCLIENT_LIBRARY} PROPERTIES
-                      IMPORTED_LOCATION ${MGCLIENT_LIBRARY_PATH})
+set_property(TARGET ${MGCLIENT_LIBRARY} PROPERTY IMPORTED_LOCATION ${MGCLIENT_LIBRARY_PATH})
+if (WIN32 AND MINGW)
+    set_property(TARGET ${MGCLIENT_LIBRARY} PROPERTY IMPORTED_IMPLIB ${MGCLIENT_ROOT}/lib/libmgclient.dll.a)
+endif()
 add_dependencies(${MGCLIENT_LIBRARY} mgclient-proj)
+message(STATUS "MGCLIENT_LIBRARY: ${MGCLIENT_LIBRARY}")
 
 # Define the addon.
 include_directories(${CMAKE_JS_INC})
 set(SOURCE_FILES src/addon.cpp src/connection.cpp src/glue.cpp
                  src/record.cpp src/cursor.cpp)
 add_library(${PROJECT_NAME} SHARED ${SOURCE_FILES} ${CMAKE_JS_SRC})
+add_dependencies(${PROJECT_NAME} ${MGCLIENT_LIBRARY})
 set_target_properties(${PROJECT_NAME} PROPERTIES PREFIX "" SUFFIX ".node")
 target_link_libraries(${PROJECT_NAME} PRIVATE
                       ${CMAKE_JS_LIB} ${MGCLIENT_LIBRARY}
@@ -66,7 +87,7 @@ execute_process(COMMAND node -p "require('node-addon-api').include"
                 OUTPUT_VARIABLE NODE_ADDON_API_DIR)
 string(REPLACE "\n" "" NODE_ADDON_API_DIR ${NODE_ADDON_API_DIR})
 string(REPLACE "\"" "" NODE_ADDON_API_DIR ${NODE_ADDON_API_DIR})
-target_include_directories(${PROJECT_NAME} SYSTEM PRIVATE ${NODE_ADDON_API_DIR})
+target_include_directories(${PROJECT_NAME} SYSTEM PRIVATE "${NODE_ADDON_API_DIR}")
 
 # Added because of BigInt support.
 add_definitions(-DNAPI_EXPERIMENTAL)

README.md

@@ -44,3 +44,11 @@ npm run build:release
 ```
 
 To run tests, [Docker](https://docs.docker.com/engine/install) is required.
+
+## Windows
+
+NOTE: Not yet possible under MinGW.
+
+If installing OpenSSL package from
+https://slproweb.com/products/Win32OpenSSL.html, make sure to use the full one
+because of the header files.

package.json

@@ -20,8 +20,8 @@
     "url": "https://github.com/memgraph/nodemgclient.git"
   },
   "scripts": {
-    "build:release": "npx cmake-js configure --debug=false --generator='Unix Makefiles' && npx cmake-js compile",
-    "build:debug": "npx cmake-js configure --debug=true --generator='Unix Makefiles' && npx cmake-js compile",
+    "build:release": "npx cmake-js configure --debug=false && npx cmake-js compile",
+    "build:debug": "npx cmake-js configure --debug=true && npx cmake-js compile",
     "lint": "npx eslint -c .eslintrc.js './{src,test,lib,example}/**/*.js'",
     "lint:fix": "npx eslint -c .eslintrc.js --fix './{src,test,lib,example}/**/*.js'",
     "test": "npx jest",