Add cmake support #528

mrpelotazo · 2022-02-21T08:51:35Z

Adds cmake support

build static/shared lib (configurable via BUILD_SHARED_LIBS)
cmake package generation to be used by other projects via find_package
project sources update via helper.pl
possibility to generate deb/rpm packages

Fixes #468,

Related to: #70, #480, #518, #523, #524,

sjaeckel · 2022-02-21T09:53:14Z

@czurnieden I took the liberty to cherry-pick what you already added to this branch and ~~apply my opinion to it~~ clean it up according to what I understand is "current cmake style"

helper.pl

CMakeLists.txt

czurnieden · 2022-03-02T21:38:33Z

The pkg-config file libtommath.pc should be included, too. See my fork of this branch where I also added an uninstall target because CMake adds several other files than just the lib and the header. But now that I did it I'm unsure if it makes sense.

CMakeLists.txt

fixes cmake (v3.10.2) error under ubuntu 18.04 due to reserved target name

in addition to be able to pass it on cmake invokation tools like ccmake et al. will show it as a configurable option

Signed-off-by: Steffen Jaeckel <[email protected]>

The test sources must be compiled with a special define and require optimisation in order to be able to run. Signed-off-by: Steffen Jaeckel <[email protected]>

Signed-off-by: Steffen Jaeckel <[email protected]>

…bles for CFLAGS

* remove some of the complicated logic. The additional warnings always make sense. CMake uses the state of `BUILD_SHARED_LIBS` to determine the library target type. Also remove the comment regarding building shared and static at the same time, as usually that's done as necessary by the user. * append user-defined {C,LD}FLAGS instead of preprending - we expect them to know what they do, so they can override our defaults * use target_{compile,link}_options() instead of setting variables Signed-off-by: Steffen Jaeckel <[email protected]>

Signed-off-by: Steffen Jaeckel <[email protected]>

libtommath.pc.in

sjaeckel · 2022-03-15T13:39:03Z

where I also added an uninstall target because CMake adds several other files than just the lib and the header. But now that I did it I'm unsure if it makes sense.

I'm also not sure if that really makes sense in the CMake context ... I've read through https://gitlab.kitware.com/cmake/community/-/wikis/FAQ#can-i-do-make-uninstall-with-cmake and maybe they are right ... I think a user who wants to install the library on their system should use cpack to package the build and then install it via their package manager.

Also there's the package registry which allows all CMake users to use find_package without the necessity to install the library.

* bump to CMake 3.10 * only support the CMake standard way to define variables via `-DFOO=On` and not via the environment * clean-up switches only used for unit tests * mingw's ID is "GNU", so we match on the full compiler name instead * use CMake variables instead of environment variables via `$ENV{<stuff>}` * unconditionally set {C,LD}FLAGS passed by user * clean-up duplicate CPack keys + add FreeBSD config * store pack files in distro-specific paths * use default names where possible * use `CMAKE_BUILD_TYPE`-style variables instead of our own flags * set default `CMAKE_BUILD_TYPE` to "Release" Signed-off-by: Steffen Jaeckel <[email protected]>

czurnieden · 2022-03-15T16:59:25Z

I'm also not sure if that [uninstall] really makes sense in the CMake context

So skip it. And we are installing, what, three files (binary, config, header) only, and not 1356 distributed over 11 different directories (yes, a real example *sigh*), so, yes, no need for an uninstall.

sjaeckel · 2022-03-15T17:44:33Z

@madebr do you maybe have something to add? I've seen that you applied some fundamental changes [0] to an older version of this branch in your local fork ...

[0] madebr@db4a0f4

CMakeLists.txt

Signed-off-by: Steffen Jaeckel <[email protected]>

one for the library, one for the demo Signed-off-by: Steffen Jaeckel <[email protected]>

.github/workflows/main.yml

CMakeLists.txt

* split up build and test process * build and run tests twice - once from regular build folder - once from demo Signed-off-by: Steffen Jaeckel <[email protected]>

sjaeckel · 2022-03-22T20:18:37Z

I'm going to leave this PR open until tomorrow afternoon and merge by then if there are no major issues... Maybe there are still some more things that have to be fixed or could be improved!? CC @madebr @mrpelotazo @czurnieden

If someone has the passion for it, they're free to add CMake testruns on Windows, either via AppVeyor or GH actions :) but please in a fresh PR.

If you're using GH actions and if that's even possible, it would maybe make sense to morph the existing CMake build matrix into something that supports both Windows and Linux.

czurnieden · 2022-03-23T02:40:13Z

Maybe there are still some more things that have to be fixed or could be improved!?

I am pretty sure of it but I found none (yet), seems to work as intended.
Where "Intended" is understood as: CMake for the basics and the makefiles for specialties.

Or does anybody want to port e.g.: #525 to CMake? >;->

* protect GCC-specific stuff * use `list(APPEND...)` * use CMake-style way to choose whether LTO should/can be done or not * only install public header, not all * add correct `install` option for DLL's on Windows * use correct folder for .pc files * check if `uname` exists & add support for FreeBSD Signed-off-by: Steffen Jaeckel <[email protected]>

Instead of prepending multiple times 'lib', change the target-properties `OUTPUT_NAME` once. This also improves cpack package names to be more distro-style. Signed-off-by: Steffen Jaeckel <[email protected]>

sjaeckel · 2022-03-28T07:54:49Z

@cntrump can you please update the SPM part to use the CMake way instead of the plain makefiles?

sjaeckel · 2022-03-28T08:55:09Z

and thanks to all contributors of this PR :)

sjaeckel force-pushed the add-cmake-support branch from 096aec2 to bafc708 Compare February 21, 2022 10:19

sjaeckel reviewed Feb 21, 2022

View reviewed changes

helper.pl Outdated Show resolved Hide resolved

CMakeLists.txt Outdated Show resolved Hide resolved

CMakeLists.txt Outdated Show resolved Hide resolved

czurnieden reviewed Feb 21, 2022

View reviewed changes

CMakeLists.txt Show resolved Hide resolved

czurnieden reviewed Feb 21, 2022

View reviewed changes

CMakeLists.txt Show resolved Hide resolved

sjaeckel force-pushed the add-cmake-support branch 2 times, most recently from ee3cdbf to 302d541 Compare February 28, 2022 13:42

mrpelotazo commented Mar 4, 2022

View reviewed changes

CMakeLists.txt Outdated Show resolved Hide resolved

mrpelotazo and others added 17 commits March 14, 2022 10:44

git: ignore cmake build directories

f993147

git: ignore kdevelop generated files

44b6517

cmake: add cmake lists file

019c3dc

cmake: have the sources/headers variables defined in a separated file

8fd791d

cmake: rename test target

6da9d1a

fixes cmake (v3.10.2) error under ubuntu 18.04 due to reserved target name

cmake: add cpack for generating packages

3c94017

helper.pl: add support to update sources.cmake

7f9fbb6

cmake: update cmake sources file

97ba3e1

cmake: define BUILD_SHARED_LIBS option...

cc8614a

in addition to be able to pass it on cmake invokation tools like ccmake et al. will show it as a configurable option

cmake: add missing LIBRARY DESTINATION in install targets

0a37084

update README

9412d1a

Signed-off-by: Steffen Jaeckel <[email protected]>

allow unit tests in shared library builds

e1788a8

The test sources must be compiled with a special define and require optimisation in order to be able to run. Signed-off-by: Steffen Jaeckel <[email protected]>

add cmake tests to CI

7cacded

Signed-off-by: Steffen Jaeckel <[email protected]>

Made "test" work with shared lib, started gathering environment varia…

391e47d

…bles for CFLAGS

add SPDX identifiers

cb8f212

Signed-off-by: Steffen Jaeckel <[email protected]>

Build and install libtommath.pc

ba74457

sjaeckel force-pushed the add-cmake-support branch from 302d541 to 50678c1 Compare March 15, 2022 13:12

sjaeckel reviewed Mar 15, 2022

View reviewed changes

libtommath.pc.in Show resolved Hide resolved

sjaeckel force-pushed the add-cmake-support branch from 50678c1 to ed6ad7d Compare March 15, 2022 15:02

madebr reviewed Mar 15, 2022

View reviewed changes