build: unify source lists

- introduce `src/crypto.c` as an umbrella source that does nothing else
  than include the selected crypto backend source. Moving this job from
  the built-tool to the C preprocessor.

- this allows dropping the various techniques to pick the correct crypto
  backend sources in autotools, CMake and other build method. Including
  the per-backend `Makefile.<crypto-backend>.inc` makefiles.

- copy a trick from curl and instead of maintaining duplicate source
  lists for CMake, convert the GNU Makefile kept for autotools
  automatically. Do this in `docs`, `examples` and `src`.

  Ref: https://github.com/curl/curl/blob/dfabe8bca218d2524af052bd551aa87e13b8a10b/CMakeLists.txt#L1399-L1413

  Also fixes missing `libssh2_setup.h` from `src/CMakeFiles.txt` after
  59666e0.

- move `Makefile.inc` from root to `src`.

- reformat `src/Makefile.inc` to list each source in separate lines,
  re-align the continuation character and sort the lists alphabetically.

- update `docs/HACKING-CRYPTO` accordingly.

- autotools: update the way we add crypto-backends to `LIBS`.

- delete old CSV headers, indent, and merge two lines in
  `docs/Makefile.am` and `src/Makefile.am`.

- add `libssh2.pc` to `.gitignore`, while there.

Closes #941

CMakeLists.txt

@@ -212,7 +212,6 @@ if(CRYPTO_BACKEND STREQUAL "OpenSSL" OR NOT CRYPTO_BACKEND)
 
   if(OPENSSL_FOUND)
     set(CRYPTO_BACKEND "OpenSSL")
-    set(CRYPTO_SOURCES openssl.c openssl.h)
     set(CRYPTO_BACKEND_DEFINE "LIBSSH2_OPENSSL")
     set(CRYPTO_BACKEND_INCLUDE_DIR ${OPENSSL_INCLUDE_DIR})
     list(APPEND LIBRARIES ${OPENSSL_LIBRARIES})
@@ -274,7 +273,6 @@ if(CRYPTO_BACKEND STREQUAL "wolfSSL" OR NOT CRYPTO_BACKEND)
 
   if(WOLFSSL_FOUND)
     set(CRYPTO_BACKEND "wolfSSL")
-    set(CRYPTO_SOURCES openssl.c openssl.h)
     set(CRYPTO_BACKEND_DEFINE "LIBSSH2_WOLFSSL")
     set(CRYPTO_BACKEND_INCLUDE_DIR ${WOLFSSL_INCLUDE_DIR} ${WOLFSSL_INCLUDE_DIR}/wolfssl)
     list(APPEND LIBRARIES ${WOLFSSL_LIBRARIES})
@@ -302,7 +300,6 @@ if(CRYPTO_BACKEND STREQUAL "Libgcrypt" OR NOT CRYPTO_BACKEND)
 
   if(LIBGCRYPT_FOUND)
     set(CRYPTO_BACKEND "Libgcrypt")
-    set(CRYPTO_SOURCES libgcrypt.c libgcrypt.h)
     set(CRYPTO_BACKEND_DEFINE "LIBSSH2_LIBGCRYPT")
     set(CRYPTO_BACKEND_INCLUDE_DIR ${LIBGCRYPT_INCLUDE_DIRS})
     list(APPEND LIBRARIES ${LIBGCRYPT_LIBRARIES})
@@ -316,7 +313,6 @@ if(CRYPTO_BACKEND STREQUAL "mbedTLS" OR NOT CRYPTO_BACKEND)
 
   if(MBEDTLS_FOUND)
     set(CRYPTO_BACKEND "mbedTLS")
-    set(CRYPTO_SOURCES mbedtls.c mbedtls.h)
     set(CRYPTO_BACKEND_DEFINE "LIBSSH2_MBEDTLS")
     set(CRYPTO_BACKEND_INCLUDE_DIR ${MBEDTLS_INCLUDE_DIR})
     list(APPEND LIBRARIES ${MBEDTLS_LIBRARIES})
@@ -335,7 +331,6 @@ if(CRYPTO_BACKEND STREQUAL "WinCNG" OR NOT CRYPTO_BACKEND)
 
   if(HAVE_BCRYPT_H)
     set(CRYPTO_BACKEND "WinCNG")
-    set(CRYPTO_SOURCES wincng.c wincng.h)
     set(CRYPTO_BACKEND_DEFINE "LIBSSH2_WINCNG")
     set(CRYPTO_BACKEND_INCLUDE_DIR "")
 
@@ -346,6 +341,19 @@ if(CRYPTO_BACKEND STREQUAL "WinCNG" OR NOT CRYPTO_BACKEND)
   endif()
 endif()
 
+# Global functions
+
+# Convert GNU Make assignments into CMake ones.
+function(transform_makefile_inc INPUT_FILE OUTPUT_FILE)
+  file(READ ${INPUT_FILE} MAKEFILE_INC_CMAKE)
+
+  string(REGEX REPLACE "\\\\\n" "" MAKEFILE_INC_CMAKE ${MAKEFILE_INC_CMAKE})
+  string(REGEX REPLACE "([A-Za-z_]+) *= *([^\n]*)" "set(\\1 \\2)" MAKEFILE_INC_CMAKE ${MAKEFILE_INC_CMAKE})
+
+  file(WRITE ${OUTPUT_FILE} ${MAKEFILE_INC_CMAKE})
+  set_property(DIRECTORY APPEND PROPERTY CMAKE_CONFIGURE_DEPENDS "${INPUT_FILE}")
+endfunction()
+
 #
 
 add_subdirectory(src)

Makefile.am

@@ -33,8 +33,7 @@ OS400FILES = os400/README400 os400/initscript.sh os400/make.sh \
   os400/libssh2rpg/libssh2.rpgle.in \
   os400/libssh2rpg/libssh2_ccsid.rpgle.in \
   os400/libssh2rpg/libssh2_publickey.rpgle \
-  os400/libssh2rpg/libssh2_sftp.rpgle \
-  Makefile.os400qc3.inc
+  os400/libssh2rpg/libssh2_sftp.rpgle
 
 EXTRA_DIST = $(WIN32FILES) get_ver.awk \
   maketgz RELEASE-NOTES libssh2.pc.in $(VMSFILES) config.rpath \

Makefile.mk

@@ -105,29 +105,24 @@ ifdef OPENSSL_PATH
   _LDFLAGS += -L"$(OPENSSL_LIBPATH)"
   OPENSSL_LIBS ?= -lssl -lcrypto
   _LIBS += $(OPENSSL_LIBS)
-  include Makefile.OpenSSL.inc
 else ifdef WOLFSSL_PATH
   CPPFLAGS += -DLIBSSH2_WOLFSSL
   CPPFLAGS += -I"$(WOLFSSL_PATH)/include"
   CPPFLAGS += -I"$(WOLFSSL_PATH)/include/wolfssl"
   _LDFLAGS += -L"$(WOLFSSL_PATH)/lib"
   _LIBS += -lwolfssl
-  include Makefile.wolfSSL.inc
 else ifdef LIBGCRYPT_PATH
   CPPFLAGS += -DLIBSSH2_LIBGCRYPT
   CPPFLAGS += -I"$(LIBGCRYPT_PATH)/include"
   _LDFLAGS += -L"$(LIBGCRYPT_PATH)/lib"
   _LIBS += -lgcrypt
-  include Makefile.libgcrypt.inc
 else ifdef MBEDTLS_PATH
   CPPFLAGS += -DLIBSSH2_MBEDTLS
   CPPFLAGS += -I"$(MBEDTLS_PATH)/include"
   _LDFLAGS += -L"$(MBEDTLS_PATH)/lib"
   _LIBS += -lmbedtls -lmbedx509 -lmbedcrypto
-  include Makefile.mbedTLS.inc
 else ifdef WIN32
   CPPFLAGS += -DLIBSSH2_WINCNG
-  include Makefile.WinCNG.inc
 else
   $(error No suitable cryptography backend found)
 endif
@@ -177,8 +172,8 @@ ifdef WIN32
 vpath %.rc src
 endif
 
-# include Makefile.inc to get CSOURCES define
-include Makefile.inc
+# Get CSOURCES define
+include src/Makefile.inc
 
 OBJS := $(addprefix $(OBJ_DIR)/,$(patsubst %.c,%.o,$(CSOURCES)))
 

NMakefile

@@ -16,11 +16,9 @@ CFLAGS=/nologo /GL /Zi /EHsc $(CFLAGS) /Iinclude
 !if "$(OPENSSL_PATH)" != ""
 CFLAGS=$(CFLAGS) /DLIBSSH2_OPENSSL /I$(OPENSSL_PATH)\include
 LIBS=$(LIBS) $(OPENSSL_PATH)\lib\crypto.lib $(OPENSSL_PATH)\lib\ssl.lib
-!include "Makefile.OpenSSL.inc"
 !else
 CFLAGS=$(CFLAGS) /DLIBSSH2_WINCNG
 LIBS=crypt32.lib bcrypt.lib
-!include "Makefile.WinCNG.inc"
 !endif
 
 !if "$(ZLIB_PATH)" != ""
@@ -34,7 +32,7 @@ INTDIR=$(TARGET)
 
 SUBDIR=src
 
-!include "Makefile.inc"
+!include "src/Makefile.inc"
 
 OBJECTS=$(CSOURCES:.c=.obj)
 

configure.ac

@@ -120,9 +120,17 @@ else
   test "$found_crypto_str" = "" && found_crypto_str="$found_crypto"
 fi
 
-m4_set_foreach([crypto_backends], [backend],
-  [AM_CONDITIONAL(m4_toupper(backend), test "$found_crypto" = "backend")]
-)
+if   test "$found_crypto" = "openssl"; then
+  LIBS="${LIBS} ${LTLIBSSL}"
+elif test "$found_crypto" = "wolfssl"; then
+  LIBS="${LIBS} ${LTLIBWOLFSSL}"
+elif test "$found_crypto" = "libgcrypt"; then
+  LIBS="${LIBS} ${LTLIBGCRYPT}"
+elif test "$found_crypto" = "wincng"; then
+  LIBS="${LIBS} ${LTLIBBCRYPT}"
+elif test "$found_crypto" = "mbedtls"; then
+  LIBS="${LIBS} ${LTLIBMBEDCRYPTO}"
+fi
 
 # libz
 

docs/.gitignore

@@ -1,3 +1,4 @@
 Makefile
 Makefile.in
+Makefile.am.cmake
 coverage

docs/CMakeLists.txt

@@ -33,185 +33,9 @@
 # USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
 # OF SUCH DAMAGE.
 
-set(MAN_PAGES
-  libssh2_agent_connect.3
-  libssh2_agent_disconnect.3
-  libssh2_agent_free.3
-  libssh2_agent_get_identity.3
-  libssh2_agent_get_identity_path.3
-  libssh2_agent_init.3
-  libssh2_agent_list_identities.3
-  libssh2_agent_set_identity_path.3
-  libssh2_agent_userauth.3
-  libssh2_banner_set.3
-  libssh2_base64_decode.3
-  libssh2_channel_close.3
-  libssh2_channel_direct_tcpip.3
-  libssh2_channel_direct_tcpip_ex.3
-  libssh2_channel_eof.3
-  libssh2_channel_exec.3
-  libssh2_channel_flush.3
-  libssh2_channel_flush_ex.3
-  libssh2_channel_flush_stderr.3
-  libssh2_channel_forward_accept.3
-  libssh2_channel_forward_cancel.3
-  libssh2_channel_forward_listen.3
-  libssh2_channel_forward_listen_ex.3
-  libssh2_channel_free.3
-  libssh2_channel_get_exit_signal.3
-  libssh2_channel_get_exit_status.3
-  libssh2_channel_handle_extended_data.3
-  libssh2_channel_handle_extended_data2.3
-  libssh2_channel_ignore_extended_data.3
-  libssh2_channel_open_ex.3
-  libssh2_channel_open_session.3
-  libssh2_channel_process_startup.3
-  libssh2_channel_read.3
-  libssh2_channel_read_ex.3
-  libssh2_channel_read_stderr.3
-  libssh2_channel_receive_window_adjust.3
-  libssh2_channel_receive_window_adjust2.3
-  libssh2_channel_request_auth_agent.3
-  libssh2_channel_request_pty.3
-  libssh2_channel_request_pty_ex.3
-  libssh2_channel_request_pty_size.3
-  libssh2_channel_request_pty_size_ex.3
-  libssh2_channel_send_eof.3
-  libssh2_channel_set_blocking.3
-  libssh2_channel_setenv.3
-  libssh2_channel_setenv_ex.3
-  libssh2_channel_shell.3
-  libssh2_channel_subsystem.3
-  libssh2_channel_wait_closed.3
-  libssh2_channel_wait_eof.3
-  libssh2_channel_window_read.3
-  libssh2_channel_window_read_ex.3
-  libssh2_channel_window_write.3
-  libssh2_channel_window_write_ex.3
-  libssh2_channel_write.3
-  libssh2_channel_write_ex.3
-  libssh2_channel_write_stderr.3
-  libssh2_channel_x11_req.3
-  libssh2_channel_x11_req_ex.3
-  libssh2_crypto_engine.3
-  libssh2_exit.3
-  libssh2_free.3
-  libssh2_hostkey_hash.3
-  libssh2_init.3
-  libssh2_keepalive_config.3
-  libssh2_keepalive_send.3
-  libssh2_knownhost_add.3
-  libssh2_knownhost_addc.3
-  libssh2_knownhost_check.3
-  libssh2_knownhost_checkp.3
-  libssh2_knownhost_del.3
-  libssh2_knownhost_free.3
-  libssh2_knownhost_get.3
-  libssh2_knownhost_init.3
-  libssh2_knownhost_readfile.3
-  libssh2_knownhost_readline.3
-  libssh2_knownhost_writefile.3
-  libssh2_knownhost_writeline.3
-  libssh2_poll.3
-  libssh2_poll_channel_read.3
-  libssh2_publickey_add.3
-  libssh2_publickey_add_ex.3
-  libssh2_publickey_init.3
-  libssh2_publickey_list_fetch.3
-  libssh2_publickey_list_free.3
-  libssh2_publickey_remove.3
-  libssh2_publickey_remove_ex.3
-  libssh2_publickey_shutdown.3
-  libssh2_scp_recv.3
-  libssh2_scp_recv2.3
-  libssh2_scp_send.3
-  libssh2_scp_send64.3
-  libssh2_scp_send_ex.3
-  libssh2_session_abstract.3
-  libssh2_session_banner_get.3
-  libssh2_session_banner_set.3
-  libssh2_session_block_directions.3
-  libssh2_session_callback_set.3
-  libssh2_session_disconnect.3
-  libssh2_session_disconnect_ex.3
-  libssh2_session_flag.3
-  libssh2_session_free.3
-  libssh2_session_get_blocking.3
-  libssh2_session_get_read_timeout.3
-  libssh2_session_get_timeout.3
-  libssh2_session_handshake.3
-  libssh2_session_hostkey.3
-  libssh2_session_init.3
-  libssh2_session_init_ex.3
-  libssh2_session_last_errno.3
-  libssh2_session_last_error.3
-  libssh2_session_method_pref.3
-  libssh2_session_methods.3
-  libssh2_session_set_blocking.3
-  libssh2_session_set_last_error.3
-  libssh2_session_set_read_timeout.3
-  libssh2_session_set_timeout.3
-  libssh2_session_startup.3
-  libssh2_session_supported_algs.3
-  libssh2_sftp_close.3
-  libssh2_sftp_close_handle.3
-  libssh2_sftp_closedir.3
-  libssh2_sftp_fsetstat.3
-  libssh2_sftp_fstat.3
-  libssh2_sftp_fstat_ex.3
-  libssh2_sftp_fstatvfs.3
-  libssh2_sftp_fsync.3
-  libssh2_sftp_get_channel.3
-  libssh2_sftp_init.3
-  libssh2_sftp_last_error.3
-  libssh2_sftp_lstat.3
-  libssh2_sftp_mkdir.3
-  libssh2_sftp_mkdir_ex.3
-  libssh2_sftp_open.3
-  libssh2_sftp_open_ex.3
-  libssh2_sftp_opendir.3
-  libssh2_sftp_read.3
-  libssh2_sftp_readdir.3
-  libssh2_sftp_readdir_ex.3
-  libssh2_sftp_readlink.3
-  libssh2_sftp_realpath.3
-  libssh2_sftp_rename.3
-  libssh2_sftp_rename_ex.3
-  libssh2_sftp_rewind.3
-  libssh2_sftp_rmdir.3
-  libssh2_sftp_rmdir_ex.3
-  libssh2_sftp_seek.3
-  libssh2_sftp_seek64.3
-  libssh2_sftp_setstat.3
-  libssh2_sftp_shutdown.3
-  libssh2_sftp_stat.3
-  libssh2_sftp_stat_ex.3
-  libssh2_sftp_statvfs.3
-  libssh2_sftp_symlink.3
-  libssh2_sftp_symlink_ex.3
-  libssh2_sftp_tell.3
-  libssh2_sftp_tell64.3
-  libssh2_sftp_unlink.3
-  libssh2_sftp_unlink_ex.3
-  libssh2_sftp_write.3
-  libssh2_sign_sk.3
-  libssh2_trace.3
-  libssh2_trace_sethandler.3
-  libssh2_userauth_authenticated.3
-  libssh2_userauth_banner.3
-  libssh2_userauth_hostbased_fromfile.3
-  libssh2_userauth_hostbased_fromfile_ex.3
-  libssh2_userauth_keyboard_interactive.3
-  libssh2_userauth_keyboard_interactive_ex.3
-  libssh2_userauth_list.3
-  libssh2_userauth_password.3
-  libssh2_userauth_password_ex.3
-  libssh2_userauth_publickey.3
-  libssh2_userauth_publickey_fromfile.3
-  libssh2_userauth_publickey_fromfile_ex.3
-  libssh2_userauth_publickey_frommemory.3
-  libssh2_userauth_publickey_sk.3
-  libssh2_version.3)
+transform_makefile_inc("Makefile.am" "${CMAKE_CURRENT_BINARY_DIR}/Makefile.am.cmake")
+# Get 'dist_man_MANS' variable
+include(${CMAKE_CURRENT_BINARY_DIR}/Makefile.am.cmake)
 
 include(GNUInstallDirs)
-install(FILES ${MAN_PAGES} DESTINATION ${CMAKE_INSTALL_MANDIR}/man3)
+install(FILES ${dist_man_MANS} DESTINATION ${CMAKE_INSTALL_MANDIR}/man3)