These are some improvements to SuperLU to try to make it more cross platform and facilitate packaging.

These improvements are:
1) Force the built in blas library to be compiled as static instead of shared.  This is so it can linked into the shared library in Windows and probably other Operating Systems.  The internal cblas library can NOT be built as a a shared library by itself.
2) Remove the assumption that the SuperLU library shared run-time library will be prefixed with lib and have a “.so” or “.a” file extension.  In Windows, the shared run-time library has a .dll extension.  In Windows Visual C, a prefix such as “lib” is not used and the extension is “.lib”, not “.a”  In Cygwin and MSYS2, the run-time .dll prefix is not “lib” at all.  It is “cyg” and “msys-“  respectively.  Making this more complicated is that in Windows, you do not link directly with the shared-library run-time file but rather, an import library.  In MINGW-W64, CygWin, and MSYS, that has the extension, “.dll.a”.
3) Another issue is that in Windows 64, unlike many Unix-like Operating Systems, the int, uint, and long do not expand to 8 bits in the 64-bit version of Windows,  Those  types are still 4 bytes wide which is not wide enough for an 8-byte sized pointer.  To fix this, I had to change int to ptrdiff_t in ExpHeader and LU_stack_t in slu_util.h.  For sizes, the size_t really should be used and for pointers, a pointer should be used.   GCC will rightfully warn you about this issue.
4) I implemented building doxygen documentation into the cmake build process and Cmake can also install the documentation.  You now have the option of building the SuperLU documentation as  .HTML or the traditional man pages as well as both depending upon packaging needs.
5) I tried fixing some doxygen warnings.  I use Doxygen 1.8.14 along with Grapviz to generate diagrams.  I made a Doxyfile.in that generates a Doxyfile in the build directory if enable_docs is on.  I also use Doxygen to create to .HTML and Unix man documentation.
6) The make.inc file generated by cmake is copied to the build directories.  The thing is that sometimes, you might be building several different sets of binaries for i686 (32-bit) and (x86_64) 64-bit as well as a static and shared version for inclusion in packages.  IOW, I am generating 4 sets of SuperLU binary files.  Actually, I think the Makefile build system is not adequate for building stuff on Windows using GCC because you use a command such as “g++ -shared -o example_dll.dll example_dll.o -Wl,--out-implib,libexample_dll.a”
7) In Windows, it’s usually a good idea to embed version information right into the .dll run-time so that if you right click it, you can get information such as the copyright and .DLL version in Windows explorer.
8) I had to fix the library install so that the .dll file is always installed in the bin directory instead of the lib directory.  Windows will search first for .dll’s in the same directory as the executable.  MINGW, Cygwin, and MSYS packages also place the .DLL’s in the appropriate directory to take advantage of this.
9) When building the interal CBLAS library, Cmake will check for the f2c package and fail if that is not located.

Author: JPeterMugaas

CBLAS/CMakeLists.txt

@@ -1,3 +1,7 @@
+find_library(F2C f2c)
+if (NOT F2C)
+message(FATAL_ERROR "f2c required.  It is available at http://www.netlib.org/f2c/index.html ")
+endif()
 set(headers 
     f2c.h
     slu_Cnames.h
@@ -79,4 +83,6 @@ set(sources "")
     )
 #endif()
 
-add_library(blas ${sources} ${HEADERS})
+#This must be compiled as a static library
+add_library(blas STATIC ${sources} ${HEADERS})
+target_link_libraries(blas ${F2C} m)

CMakeLists.txt

@@ -49,15 +49,28 @@ set(CMAKE_INSTALL_RPATH "${CMAKE_INSTALL_PREFIX}/lib")
 SET(CMAKE_INSTALL_RPATH_USE_LINK_PATH TRUE)
 #----
 
+enable_language(C)
+message("CMAKE_SHARED_LIBRARY_PREFIX - ${CMAKE_SHARED_LIBRARY_PREFIX}")
+message("CMAKE_SHARED_LIBRARY_SUFFIX - ${CMAKE_SHARED_LIBRARY_SUFFIX}")
+message("CMAKE_IMPORT_LIBRARY_PREFIX - ${CMAKE_IMPORT_LIBRARY_PREFIX}")
+message("CMAKE_IMPORT_LIBRARY_SUFFIX - ${CMAKE_IMPORT_LIBRARY_SUFFIX}")
+message("CMAKE_STATIC_LIBRARY_PREFIX - ${CMAKE_STATIC_LIBRARY_PREFIX}")
+message("CMAKE_STATIC_LIBRARY_SUFFIX - ${CMAKE_STATIC_LIBRARY_SUFFIX}")
+
 if (BUILD_SHARED_LIBS)
   message("-- SuperLU will be built as a shared library.")
-  set(PROJECT_NAME_LIB_EXPORT libsuperlu.so)
+  if (WIN32 OR CYGWIN OR MSYS)
+    # In Windows, you link to an associated import library, not directly to the shared library runtime (.dll)
+    set(PROJECT_NAME_LIB_EXPORT ${CMAKE_IMPORT_LIBRARY_PREFIX}superlu${CMAKE_IMPORT_LIBRARY_SUFFIX})
+  else()
+    set(PROJECT_NAME_LIB_EXPORT ${CMAKE_SHARED_LIBRARY_PREFIX}superlu${CMAKE_SHARED_LIBRARY_SUFFIX})
+  endif()
 else()
   message("-- SuperLU will be built as a static library.")
-  set(PROJECT_NAME_LIB_EXPORT libsuperlu.a)
+  set(PROJECT_NAME_LIB_EXPORT ${CMAKE_STATIC_LIBRARY_PREFIX}superlu${CMAKE_STATIC_LIBRARY_SUFFIX})
 endif()
 
-enable_language(C)
+
 if (XSDK_ENABLE_Fortran)
   enable_language (Fortran)
   set(NOFORTRAN FALSE)
@@ -77,10 +90,12 @@ if (NOT CMAKE_INSTALL_PREFIX)
 endif()
 
 # setup options
-option(enable_blaslib   "Build the CBLAS library" ${enable_blaslib_DEFAULT})
+option(enable_blaslib   "Build the CBLAS library (requires f2c)" ${enable_blaslib_DEFAULT})
 option(enable_matlabmex "Build the Matlab mex library" OFF)
 option(enable_tests     "Build tests" ON)
 option(enable_doc       "Build doxygen documentation" OFF)
+option(enable_doc_html  "Build HTML documentation"    OFF)
+option(enable_doc_man   "Build Unix man pages"        OFF)
 option(enable_single    "Enable single precision library" ON)
 option(enable_double    "Enable double precision library" ON)
 option(enable_complex   "Enable complex precision library" ON)
@@ -124,12 +139,26 @@ else()
   add_subdirectory(CBLAS)
   set(BLAS_LIB blas)
   if (BUILD_SHARED_LIBS)  # export to be referenced by downstream makefile
-      set(BLAS_LIB_EXPORT ${CMAKE_INSTALL_PREFIX}/CBLAS/libblas.so)
-  else()
-      set(BLAS_LIB_EXPORT ${CMAKE_INSTALL_PREFIX}/CBLAS/libblas.a)
+  #This must always be a static library.
+      set(BLAS_LIB_EXPORT ${CMAKE_INSTALL_PREFIX}/CBLAS/${CMAKE_STATIC_LIBRARY_PREFIX}blas${CMAKE_STATIC_LIBRARY_SUFFIX})
   endif()
 endif()
 
+######################################################################
+#
+# TMGLIB_EXPORT value
+#
+######################################################################
+  if (BUILD_SHARED_LIBS)  # export to be referenced by downstream makefile
+      if (WIN32 OR CYGWIN OR MSYS)
+      # In Windows, you link to an associated import library, not directly to the shared library runtime (.dll)
+         set(TMGLIB_EXPORT ${CMAKE_IMPORT_LIBRARY_PREFIX}tmglib${CMAKE_IMPORT_LIBRARY_SUFFIX})
+      else()
+         set(TMGLIB_EXPORT ${CMAKE_SHARED_LIBRARY_PREFIX}tmglib${CMAKE_SHARED_LIBRARY_SUFFIX})
+      endif()
+  else()
+      set(TMGLIB_EXPORT ${CMAKE_STATIC_LIBRARY_PREFIX}tmglib${CMAKE_STATIC_LIBRARY_SUFFIX})
+  endif()
 
 ######################################################################
 #
@@ -157,14 +186,81 @@ if(enable_tests)
 endif()
 
 if(enable_doc)
-  message(FATAL_ERROR "Documentation build requested but not implemented.")
+#  message(FATAL_ERROR "Documentation build requested but not implemented.")
   #implement doxygen
+
+# check if Doxygen is installed
+  find_package(Doxygen)
+  if (DOXYGEN_FOUND)
+    include(GNUInstallDirs)
+    message(STATUS "doxygen                           ${DOXYGEN_EXECUTABLE}")
+    message(STATUS "doxygen version                   ${DOXYGEN_VERSION}")
+    #based from: https://vicrucann.github.io/tutorials/quick-cmake-doxygen/
+    # set input and output files
+    set(DOXYGEN_IN ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in)
+    if(DOXYGEN_DOT_FOUND)
+      set(HAVE_DOT "YES")
+      set(DOT_EXECUTABLE ${DOXYGEN_DOT_EXECUTABLE})
+      message(STATUS "Graphviz    (dot)                 ${DOXYGEN_DOT_EXECUTABLE}")	
+    else()
+      set(HAVE_DOT "NO")
+      unset(DOT_EXECUTABLE)
+      message(STATUS "Graphviz    (dot)                 Not Found")	
+    endif(DOXYGEN_DOT_FOUND)
+    set(DOXYGEN_OUT ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile)
+
+    # Optional - use mscgen
+    find_program(MSCGEN mscgen)
+    if(MSCGEN)
+       message(STATUS "mscgen                            ${MSCGEN}")		
+       # Doxygen will use this dir to find mscgen   
+       get_filename_component(MSCGEN_PATH ${MSCGEN} DIRECTORY)
+    else()
+       message(STATUS "mscgen                            Not Found")	
+       unset(MSCGEN_PATH)	   
+    endif(MSCGEN)
+    # Optional - use dia
+    find_program(DIA dia)
+    if(DIA)
+       message(STATUS "dia                               ${DIA}")		
+       # Doxygen will use this dir to find mscgen   
+       get_filename_component(DIA_PATH ${DIA} DIRECTORY)
+    else()
+       message(STATUS "dia                               Not Found")		
+       unset(DIA_PATH)
+    endif(DIA)
+    # note the option ALL which allows to build the docs together with the application
+    # We want to set up the docs in HTML format and the option for it in these conditionals
+    if(enable_doc_html)
+	   set(d_enable_doc_html "YES")	   
+           install(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/doc_doxygen/html DESTINATION ${CMAKE_INSTALL_DOCDIR})
+    else()
+           set(d_enable_doc_html "NO")
+    endif(enable_doc_html)
+    if(enable_doc_man)
+	   set(d_enable_doc_man "YES")
+	   install(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/doc_doxygen/man/ DESTINATION ${CMAKE_INSTALL_MANDIR})
+    else()
+	   set(d_enable_doc_man "NO")
+    endif(enable_doc_man)	
+    # request to configure the file
+    configure_file(${DOXYGEN_IN} ${DOXYGEN_OUT} @ONLY) 
+    add_custom_target( doc_doxygen ALL
+        COMMAND ${DOXYGEN_EXECUTABLE} ${DOXYGEN_OUT}
+        WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
+        COMMENT "Generating API documentation with Doxygen"
+        VERBATIM )     
+  else (DOXYGEN_FOUND)
+    message("Doxygen need to be installed to generate the doxygen documentation")
+  endif (DOXYGEN_FOUND)
 endif()
 
 # file(WRITE "make.defs" "# can be exposed to users"
 #  ${CMAKE_C_COMPILER}  )
 # configure_file(${CMAKE_SOURCE_DIR}/make.inc.in ${CMAKE_SOURCE_DIR}/make.inc)
 configure_file(${SuperLU_SOURCE_DIR}/make.inc.in ${SuperLU_SOURCE_DIR}/make.inc)
+# This is just here in case people compile the same code for different sitatuions.
+file(COPY ${SuperLU_SOURCE_DIR}/make.inc DESTINATION ${CMAKE_CURRENT_BINARY_DIR})
 
 configure_file(${CMAKE_CURRENT_SOURCE_DIR}/superlu.pc.in ${CMAKE_CURRENT_BINARY_DIR}/superlu.pc @ONLY)
 install(FILES ${CMAKE_CURRENT_BINARY_DIR}/superlu.pc