Merge remote-tracking branch 'origin/master' into rename-filename-comments

Author: galanCA

.github/workflows/build-and-test.yml

@@ -34,8 +34,8 @@ jobs:
         uses: actions/checkout@v1
       - name: Configure CMake
         run: cmake -P cmake/configure.cmake
-      - name: Build wcmp
-        run: cmake --build . --config Release --target wcmp
+      - name: Build wcmp and unit test executable
+        run: cmake --build . --config Release --target wcmp cse_tests
         working-directory: msvc/build
       - name: Download executable artifact
         uses: actions/download-artifact@v2

.gitignore

@@ -1,18 +1,5 @@
 ## CSE .gitignore
 
-# CSE generated files
-/src/untab.cpp
-/src/srfd.cpp
-/src/rcdef.sum
-/src/rcdef.err
-/src/rccn.h
-/src/dttab.cpp
-/src/dtypes.h
-/src/csevrsn.h
-
-# RCDEF generated files
-/src/rcdef.err
-
 # test files
 /test/*.rep
 /test/*.csv

.gitmodules

@@ -10,3 +10,6 @@
 [submodule "vendor/btwxt"]
 	path = vendor/btwxt
 	url = https://github.com/bigladder/btwxt.git
+[submodule "vendor/googletest"]
+	path = vendor/googletest
+	url = https://github.com/google/googletest.git

CMakeLists.txt

@@ -15,8 +15,26 @@ set_property(GLOBAL PROPERTY USE_FOLDERS ON)
 find_package(Git QUIET)
 
 add_subdirectory(vendor)
+
+# Common source files TODO: Move to library when dtypes.h circularity is resolved.
+set(cse_common_source
+  "${CSE_SOURCE_DIR}/src/cvpak.cpp"
+  "${CSE_SOURCE_DIR}/src/dmpak.cpp"
+  "${CSE_SOURCE_DIR}/src/envpak.cpp"
+  "${CSE_SOURCE_DIR}/src/lookup.cpp"
+  "${CSE_SOURCE_DIR}/src/messages.cpp"
+  "${CSE_SOURCE_DIR}/src/msgtbl.cpp"
+  "${CSE_SOURCE_DIR}/src/psychro.cpp"
+  "${CSE_SOURCE_DIR}/src/rmkerr.cpp"
+  "${CSE_SOURCE_DIR}/src/strpak.cpp"
+  "${CSE_SOURCE_DIR}/src/tdpak.cpp"
+  "${CSE_SOURCE_DIR}/src/xiopak.cpp"
+)
+
 add_subdirectory(src)
 
+set_directory_properties(PROPERTIES VS_STARTUP_PROJECT CSE)
+
 enable_testing()
 
 add_subdirectory(test)

README.md

@@ -23,7 +23,7 @@ CSE is configured as a CMake project. Currently, CMake is only configured to gen
 
 #### Testing
 
-Automated testing of your build can be executed by running
+Automated testing of your build can be executed by running after building the entire solution
 
 `ctest -C Release`
 

cmake/CSEVersion.cmake

@@ -90,6 +90,6 @@ endif()
 message("Building CSE ${CSEVRSN_MAJOR}.${CSEVRSN_MINOR}.${CSEVRSN_PATCH}${CSEVRSN_PRERELEASE}${CSEVRSN_META}")
 
 configure_file(
-  "${PROJECT_SOURCE_DIR}/src/csevrsn.h.in"
-  "${PROJECT_SOURCE_DIR}/src/csevrsn.h"
+  "${PROJECT_SOURCE_DIR}/src/csevrsn.in.h"
+  "${PROJECT_BINARY_DIR}/src/csevrsn.h"
 )

cmake/build.cmake

@@ -2,6 +2,7 @@ message("Building CSE...")
 execute_process(COMMAND ${CMAKE_COMMAND}
   --build ${CMAKE_CURRENT_SOURCE_DIR}/msvc/build
   --config Release
+  --target CSE
   -- -m
   WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/msvc/build
   RESULT_VARIABLE success

src/CMakeLists.txt

@@ -1,4 +1,14 @@
-# Compile RCDEF
+add_library(cse_libstubs OBJECT libstubs.cpp)
+
+target_include_directories(cse_libstubs PUBLIC
+  "${CMAKE_SOURCE_DIR}/src/RCDEF" # stubs don't need legit dtypes.h
+  "${CMAKE_SOURCE_DIR}/src"
+)
+
+target_compile_features(cse_libstubs PUBLIC cxx_std_17)
+
+
+# Build RCDEF
 add_subdirectory(RCDEF)
 
 # Run C Preprocessor on *.DEF files
@@ -37,20 +47,21 @@ endforeach()
 # Run RCDEF
 add_custom_command(
   OUTPUT
-    "${CMAKE_CURRENT_SOURCE_DIR}/dtypes.h"
-    "${CMAKE_CURRENT_SOURCE_DIR}/rccn.h"
-    "${CMAKE_CURRENT_SOURCE_DIR}/dttab.cpp"
-    "${CMAKE_CURRENT_SOURCE_DIR}/srfd.cpp"
-    "${CMAKE_CURRENT_SOURCE_DIR}/untab.cpp"
-    "${CMAKE_CURRENT_SOURCE_DIR}/rcdef.sum"
+    "${CMAKE_CURRENT_BINARY_DIR}/dtypes.h"
+    "${CMAKE_CURRENT_BINARY_DIR}/rccn.h"
+    "${CMAKE_CURRENT_BINARY_DIR}/dttab.cpp"
+    "${CMAKE_CURRENT_BINARY_DIR}/srfd.cpp"
+    "${CMAKE_CURRENT_BINARY_DIR}/untab.cpp"
+    "${CMAKE_CURRENT_BINARY_DIR}/rcdef.sum"
   COMMAND RCDEF "${CMAKE_CURRENT_BINARY_DIR}/cndtypes.i" "${CMAKE_CURRENT_BINARY_DIR}/cnunits.i" "${CMAKE_CURRENT_BINARY_DIR}/dtlims.i" "${CMAKE_CURRENT_BINARY_DIR}/cnfields.i" "${CMAKE_CURRENT_BINARY_DIR}/cnrecs.i"    . NUL NUL NUL  .
   DEPENDS RCDEF "${CMAKE_CURRENT_BINARY_DIR}/cndtypes.i" "${CMAKE_CURRENT_BINARY_DIR}/cnunits.i" "${CMAKE_CURRENT_BINARY_DIR}/dtlims.i" "${CMAKE_CURRENT_BINARY_DIR}/cnfields.i" "${CMAKE_CURRENT_BINARY_DIR}/cnrecs.i"
-  WORKING_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}"
+  WORKING_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}"
 )
 
 # Set CSE Version
 add_custom_target(version_header
-  DEPENDS ${PROJECT_SOURCE_DIR}/src/csevrsn.h.in
+  DEPENDS "${PROJECT_SOURCE_DIR}/src/csevrsn.in.h"
+  BYPRODUCTS "${PROJECT_BINARY_DIR}/src/csevrsn.h"
   COMMAND ${CMAKE_COMMAND}
    ARGS -DPROJECT_SOURCE_DIR=${PROJECT_SOURCE_DIR}
    -DPROJECT_BINARY_DIR=${PROJECT_BINARY_DIR}
@@ -99,43 +110,34 @@ set(source
   cuparse.cpp
   cuprobe.cpp
   cutok.cpp
-  cvpak.cpp
   datfcns.cpp
   dhwcalc.cpp
   dhwsolar.cpp
-  dmpak.cpp
   dttab.cpp
-  envpak.cpp
   exman.cpp
   foundation.cpp
   gmutil.cpp
   geometry.cpp
   hvac.cpp
   impf.cpp
-  lookup.cpp
-  messages.cpp
-  msgtbl.cpp
   mspak.cpp
   nummeth.cpp
   pgpak.cpp
   pp.cpp
-  psychro.cpp
   pvcalc.cpp
-  rmkerr.cpp
   shading.cpp
   solar.cpp
-  srfd.cpp
-  strpak.cpp
   sytb.cpp
-  tdpak.cpp
   timer.cpp
-  untab.cpp
   vrpak.cpp
   wfpak.cpp
-  xiopak.cpp
   yacam.cpp
+  "${CMAKE_CURRENT_BINARY_DIR}/srfd.cpp"
+  "${CMAKE_CURRENT_BINARY_DIR}/untab.cpp"
 )
 
+list(APPEND source ${cse_common_source})
+
 set(precomp
   StdAfx.cpp
 )
@@ -160,7 +162,6 @@ set(headers
   cprint.h
   cse.h
   cseface.h
-  csevrsn.h
   cueval.h
   cuevf.h
   cul.h
@@ -171,7 +172,6 @@ set(headers
   cvpak.h
   datfcns.h
   dmpak.h
-  dtypes.h
   envpak.h
   exman.h
   foundation.h
@@ -188,7 +188,6 @@ set(headers
   pgpak.h
   pp.h
   psychro.h
-  rccn.h
   rmkerr.h
   solar.h
   srd.h
@@ -201,22 +200,16 @@ set(headers
   wfpak.h
   xiopak.h
   yacam.h
+  "${CMAKE_CURRENT_BINARY_DIR}/csevrsn.h"
+  "${CMAKE_CURRENT_BINARY_DIR}/dtypes.h"
+  "${CMAKE_CURRENT_BINARY_DIR}/rccn.h"
 )
 
 if(USE_XMODULE) # Runtime Share Library interface - Not used since Version 0.899. (Windows only)
   list(APPEND source xmodule.cpp)
   list(APPEND headers xmodule.h)
 endif()
 
-include_directories(
-  "${CMAKE_SOURCE_DIR}/src"
-  "${CMAKE_SOURCE_DIR}/vendor"
-  "${CMAKE_SOURCE_DIR}/vendor/Penumbra/include"
-  "${CMAKE_SOURCE_DIR}/vendor/HPWHsim/src"
-  "${CMAKE_BINARY_DIR}/vendor/HPWHsim/src"
-  "${btwxt_SOURCE_DIR}/src"
-)
-
 # Precompiled Headers
 macro(addMSVCPrecompiledHeader PrecompiledHeader PrecompiledSourceVar SourcesVar)
   if(MSVC)
@@ -240,6 +233,16 @@ addMSVCPrecompiledHeader("cnglob.h" precomp source)
 
 # Final executable/linking
 add_executable(CSE ${source} ${rcFile} ${headers})
+
+target_include_directories(CSE PRIVATE
+  "${CSE_BINARY_DIR}/src"
+  "${CSE_SOURCE_DIR}/src"
+  "${penumbra_SOURCE_DIR}/include"
+  "${HPWHsim_SOURCE_DIR}/src"
+  "${HPWHsim_BINARY_DIR}/src"
+  "${btwxt_SOURCE_DIR}/src"
+)
+
 target_compile_features(CSE PUBLIC cxx_std_17)
 
 if(USE_XMODULE)

src/RCDEF/CMakeLists.txt

@@ -1,17 +1,11 @@
 set(source
-  ../cvpak.cpp
-  ../dmpak.cpp
-  ../envpak.cpp
-  ../lookup.cpp
-  ../messages.cpp
-  ../msgtbl.cpp
-  ../rcdef.cpp
-  ../rmkerr.cpp
-  ../strpak.cpp
-  ../tdpak.cpp
-  ../xiopak.cpp
+  rcdef.cpp
+  $<TARGET_OBJECTS:cse_libstubs>
 )
 
+list(APPEND source ${cse_common_source})
+
+
 set(headers
   ../cnglob.h
   ../dmpak.h
@@ -27,7 +21,7 @@ include_directories(
   .
 )
 
-add_definitions(-DNOVRR)
 
 add_executable(RCDEF ${source} ${headers})
 target_compile_features(RCDEF PRIVATE cxx_std_17)
+target_compile_definitions(RCDEF PRIVATE NOVRR)