Add CMake build system #220

Youw · 2020-12-11T19:03:41Z

~~This is still work-in-progress. A draft PR, so can be reviewed by community.~~

See: #288.

- general build infrastructure, build options; - libusb/hidraw backends; - (optionally) hidtest;

refactor build system a bit

Qix-

Going to keep it at what I have now so it's not too overwhelming. Let me know if you'd like me to keep going or not :)

CMakeLists.txt

Qix- · 2020-12-11T19:50:34Z

CMakeLists.txt

+if(NOT DEFINED CMAKE_BUILD_TYPE OR CMAKE_BUILD_TYPE STREQUAL "")
+    set(CMAKE_BUILD_TYPE "Release" CACHE STRING "Debug;Release;MinSizeRel;RelWithDebInfo" FORCE)
+endif()
+set_property(CACHE CMAKE_BUILD_TYPE PROPERTY STRINGS "Debug" "Release" "MinSizeRel" "RelWithDebInfo")
+


Don't modify this; it isn't idiomatic CMake and isn't necessary. If anything, give a warning about it not being set. In almost all cases, the user invoking cmake should specify it - e.g. the following is muscle memory for me personally:

mkdir build && cd build cmake .. -GNinja -DCMAKE_BUILD_TYPE=Debug -DBUILD_TESTING=ON

Suggested change

if(NOT DEFINED CMAKE_BUILD_TYPE OR CMAKE_BUILD_TYPE STREQUAL "")

set(CMAKE_BUILD_TYPE "Release" CACHE STRING "Debug;Release;MinSizeRel;RelWithDebInfo" FORCE)

endif()

set_property(CACHE CMAKE_BUILD_TYPE PROPERTY STRINGS "Debug" "Release" "MinSizeRel" "RelWithDebInfo")

if(NOT DEFINED CMAKE_BUILD_TYPE OR CMAKE_BUILD_TYPE STREQUAL "")

message(WARNING "CMAKE_BUILD_TYPE not specified; HIDAPI might get mis-configured.")

endif()

so instead of type less, you suggest always type more (and possible type more errors)
I vote for user-friendly

muscle memory for me personally

and it makes it harder to use for those, who don't have such muscle memory

even more: I use cmake-gui even more often then a command-line. It saves me much time. And it saves me time to pick a selection from a combo-box, instead of typing it manually each time.

so instead of type less, you suggest always type more

In this case, yes. It's not about typing less/more. It's about not dictating how users use your package.

Further, most people that will be using this will be either installing from a package manager or using it as a submodule - and only the latter would require someone typing it once to configure it.

and it makes it harder to use for those, who don't have such muscle memory

The point wasn't that I'm better. The point is that it's a pretty standard way to use CMake.

even more: I use cmake-gui even more often then a command-line

That is not the majority case.

or using it as a submodule - and only the latter would require someone typing it once to configure it.

And what problem does it make? Does it limit the users?

The point wasn't that I'm better.

Neither was mine.

The point is that it's a pretty standard way to use CMake.

For all my "small" project I have a different muscle memory: cmake .. && make -j. Pretty standard to me (and I didn't invented it).

The point here is that this is not common. Another user now has asked about it; you generally don't set these things, because debug/release isn't binary. I've rarely, hardly ever actually, seen a config that does this. It's the general case yo specify the config type you want to build for.

CMakeLists.txt

hidtest/CMakeLists.txt

libusb/CMakeLists.txt

Qix- · 2020-12-11T20:13:45Z

By the way, Travis removed support for open source projects as of this last November. You might want to consider moving entirely to sourcehut (since I see you're already using it and it's a fine option!) or to Github Actions/Circle/etc.

The travis jobs will probably never complete and thus stay yellow :)

Youw · 2020-12-11T21:55:26Z

Travis removed support for open source projects as of this last November

Fortunately, that is not true.
They are just migrating all Open Source projects from travis-ci.org to travis-ci.com. Check out their open letter. And of course, it remains free for Open Source as it was before.

Youw · 2020-12-11T22:06:29Z

Let me know if you'd like me to keep going or not :)

I guess I'd rather finish with the documentation first, so we can avoid my answers like "this is by current design".
This whole implementation is designed to make the usage simple, not the implementation simple.

Youw · 2020-12-11T22:08:30Z

The travis jobs will probably never complete and thus stay yellow :)

This is a good one, thanks. I'll switch to travis-ci.com. I though I already did it.

Qix- · 2020-12-11T22:36:28Z

They are just migrating

Huh, I read something entirely different on HN. I guess that's good news, then.

Be-ing · 2021-01-14T19:38:53Z

CMakeLists.txt

+if(NOT DEFINED CMAKE_BUILD_TYPE OR CMAKE_BUILD_TYPE STREQUAL "")
+    set(CMAKE_BUILD_TYPE "Release" CACHE STRING "Debug;Release;MinSizeRel;RelWithDebInfo" FORCE)
+endif()
+set_property(CACHE CMAKE_BUILD_TYPE PROPERTY STRINGS "Debug" "Release" "MinSizeRel" "RelWithDebInfo")


What is the point of this? Why don't you leave it to CMake to set the default?

What is the point of this?

It is for convenience of those, who are building hidapi as a standalone package/library. Try cmake-gui and you'll see.

Why don't you leave it to CMake to set the default?

Because by default CMake doesn't set it at all. Maybe it does makes sence somtime, but I haven't seen a single real project where it would.

As for the convenience part: see my other comment #220 (comment)

I still don't get the point of overriding CMake's default behavior, but I guess it doesn't hurt? 🤷 It'll just be a bit of confusing code for people reading this in the future.

but I guess it doesn't hurt?

That's my point.

CMake's default behavior

Humor me. Can you tell what's CMake's default behavior if you don't specify CMAKE_BUILD_TYPE at all?

@Youw
There are multi-config generators (like MSVC) that ignores CMAKE_BUILD_TYPE. The value of this variable is also not limited to the ones you've listed - for example I use also TSan and ASan build type for sanitizers. I agree this part of code isn't necessary here but I don't think it will break something on the other hand.

ignores CMAKE_BUILD_TYPE

The problem that it is not exactly ignored. It is still available in the CMake scripts, and what bothers me the most: CMake doesn't default it to empty value when MSVC generator is used, but rather to "Debug" (gcc + make - it is defaulted to empy value).
I find such behavior way more confusing, but I guess CMake's developers must have had their reasons for that.

I use also TSan and ASan build type for sanitizers

I must admit - I haven't seen any custom CMAKE_BUILD_TYPE usage/implementation, so I guess that is a good point too.
Can you point to me a reference how your/typical usage look like?

As I mentioned earlier, a standalone build likely not to be used with a non-standard build types but I agree that prohibiting it wouldn't be a good thing, so there is that.

CMakeLists.txt

sleiner · 2021-06-10T19:42:02Z

I just tested this in two setups and it works great 👍🏻 Is anything holding back the merge? Is there anything I could do to help? 😊

mcuee · 2021-06-16T02:55:33Z

I like this CMake improvement as well. Thanks.

mcuee · 2021-06-18T14:14:44Z

It seems to work fine under my Mac Mini M1 (macOS Big Sur ARM64).

hidapi_cmake/build on  cmake-support ❯ cmake ..
-- The C compiler identification is AppleClang 12.0.5.12050022
-- Detecting C compiler ABI info
-- Detecting C compiler ABI info - done
-- Check for working C compiler: /Library/Developer/CommandLineTools/usr/bin/cc - skipped
-- Detecting C compile features
-- Detecting C compile features - done
-- Looking for pthread.h
-- Looking for pthread.h - found
-- Performing Test CMAKE_HAVE_LIBC_PTHREAD
-- Performing Test CMAKE_HAVE_LIBC_PTHREAD - Success
-- Found Threads: TRUE  
-- Configuring done
-- Generating done
-- Build files have been written to: /Users/mcuee/build/hidapi/hidapi_cmake/build

hidapi_cmake/build on  cmake-support [?] via △ v3.20.3 ❯ vim CMakeCache.txt 
(to enable hidtest and framwork build, proper way is to define in the command line).

hidapi_cmake/build on  cmake-support [?] via △ v3.20.3 took 1m27s ❯ cmake ..
-- Configuring done
-- Generating done
-- Build files have been written to: /Users/mcuee/build/hidapi/hidapi_cmake/build

hidapi_cmake/build on  cmake-support [?] via △ v3.20.3 ❯ make
-- Configuring done
-- Generating done
-- Build files have been written to: /Users/mcuee/build/hidapi/hidapi_cmake/build
[ 25%] Building C object src/mac/CMakeFiles/hidapi_darwin.dir/hid.c.o
[ 50%] Linking C shared library hidapi.framework/hidapi
Copying OS X content src/mac/hidapi.framework/Versions/0/Headers/hidapi.h
[ 50%] Built target hidapi_darwin
[ 75%] Building C object hidtest/CMakeFiles/hidtest.dir/test.c.o
[100%] Linking C executable hidtest
[100%] Built target hidtest

Be-ing · 2021-06-19T16:46:58Z

What is left to do here?

Youw · 2021-06-19T16:59:02Z

https://github.com/libusb/hidapi/pull/220/files#diff-0bc78e3e3203f9abc8d4db2b1e58170a5948f03e807325064aead14f8b310cc2R8

Working on it right now. Will finish today/tomorrow.
When I do - I'll squash all changes into two commits (one for CMake and one for Documentation update) and will open a new PR. Simply not to break this branch if someone is already using it.

Youw · 2021-06-19T17:52:35Z

It seems to work fine under my Mac Mini M1 (macOS Big Sur ARM64)

Thanks for testing it. I don't have M1 mac to check it myself. Even though there is nothing platform/architecture-specific that could suggest that the build could have failed, having a confirmation is always a good thing.

Signed-off-by: Ihor Dutchak <[email protected]>

BUILD.cmake.md

CMakeLists.txt

Co-authored-by: Be <[email protected]>

Be-ing · 2021-06-21T23:57:57Z

BUILD.cmake.md

 ```sh
 cd <build dir>
 # configure the build
-cmake -GNinja <HIDAPI source dir>
+cmake <HIDAPI source dir>
 # build it!
+cmake --build .
+# install library; by default installs into /usr/local/
+cmake --build . --target install
+# NOTE: you need to run install command as root, to be able to install into /usr/local/


This would use the source tree as the build directory.

cmake -S . -B build

creates the directory build if it does not exist, then

cmake --build build cmake --install build

This would use the source tree as the build directory.

Of course it wouldn't. It will create a build tree under current directory, which by cd <build dir> is any directory on the filesystem.

cmake -S . -B build

This creates a build directory inside the source tree, which by my experience is almost as bad as using source tree for build tree.

I'm using a software that scans all files under the source tree to index symbols (automatically) and if the build directory is under source tree - it scans it too, during the build as the build goes... So I prefer (and always recommend) to move build directorry somewhere outside the source tree completely.

Youw and others added 15 commits May 26, 2020 17:51

add CMake build system

bf64499

- general build infrastructure, build options; - libusb/hidraw backends; - (optionally) hidtest;

CMake: add Windows build

1bfcadc

CMake: add Darwin build

095831f

refactor build system a bit

add .pc generation for CMake build

a7e4285

add CMake export package installation

7246840

hidapi::hidapi as INTERFACE IMPORTED instead of ALIAS

5e2436c

handle static lib build exports

1046923

install export order matters

d1bef57

CMake package: support older version syntax

88b253c

Merge branch 'master' into cmake-support

053597e

Merge branch 'master' into cmake-support

a2a51cd

Merge branch 'master' into cmake-support

7260981

fix macOS build

fd64175

Sync with v0.10.1 (master)

443ea8f

don't search pkg-config libusb, if CMake target usb-1.0 exists

0c0f3b8

Youw marked this pull request as draft December 11, 2020 19:03

Youw added the build system/CI Anything related to building the project or running on CI label Dec 11, 2020

This was referenced Dec 11, 2020

Add CMake to build HIDAPI #165

Closed

CMake build system #12

Closed

Qix- suggested changes Dec 11, 2020

View reviewed changes

Youw added 2 commits December 12, 2020 21:21

Update README.md

7b53333

Merge remote-tracking branch 'origin/master' into cmake-support

ad7cc64

Be-ing reviewed Jan 14, 2021

View reviewed changes

CMakeLists.txt Show resolved Hide resolved

Be-ing reviewed Jan 14, 2021

View reviewed changes

CMakeLists.txt Outdated Show resolved Hide resolved

Youw added 2 commits May 18, 2021 03:16

documentation refactoring

fe48fa0

Merge remote-tracking branch 'origin/master' into cmake-support

a323c29

Youw added 3 commits June 19, 2021 07:50

explicitly check for valid VERSION file

3235566

compatibility target aliases

9801eb4

Merge branch 'master' into cmake-support

c7dfdb9

Youw added 4 commits June 20, 2021 16:20

optional CMAKE_FRAMEWORK variable

ba9983f

Signed-off-by: Ihor Dutchak <[email protected]>

MSVC support update

9b3afa1

another piece of documentation drop

aca4bd9

fix doc link

23f1bbe

Youw force-pushed the cmake-support branch from 40dcca0 to 23f1bbe Compare June 20, 2021 15:11

CMake build documentation done

4c1824e

Youw mentioned this pull request Jun 21, 2021

add CMake build system #288

Merged

Be-ing reviewed Jun 21, 2021

View reviewed changes

BUILD.cmake.md Outdated Show resolved Hide resolved

Be-ing reviewed Jun 21, 2021

View reviewed changes

BUILD.cmake.md Show resolved Hide resolved

Be-ing reviewed Jun 21, 2021

View reviewed changes

BUILD.cmake.md Outdated Show resolved Hide resolved

Be-ing reviewed Jun 21, 2021

View reviewed changes

CMakeLists.txt Outdated Show resolved Hide resolved

Youw and others added 4 commits June 21, 2021 23:47

save

a2c963c

save doc

4579257

Update CMakeLists.txt

609098e

Co-authored-by: Be <[email protected]>

non-ninja example

0487a8c

Be-ing reviewed Jun 21, 2021

View reviewed changes

add "build dir" description

227ad87

Youw closed this in #288 Jul 3, 2021

Youw deleted the cmake-support branch July 3, 2021 17:40

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add CMake build system #220

Add CMake build system #220

Youw commented Dec 11, 2020 •

edited

Loading

Qix- left a comment

Qix- Dec 11, 2020

Youw Dec 11, 2020

Qix- Dec 11, 2020 •

edited

Loading

Youw Dec 11, 2020

Qix- Jan 15, 2021

Qix- commented Dec 11, 2020 •

edited

Loading

Youw commented Dec 11, 2020

Youw commented Dec 11, 2020

Youw commented Dec 11, 2020

Qix- commented Dec 11, 2020

Be-ing Jan 14, 2021

Youw Jan 14, 2021

Be-ing Jan 15, 2021

Youw Jan 15, 2021

jm4R Jan 15, 2021

Youw Jan 15, 2021

sleiner commented Jun 10, 2021

mcuee commented Jun 16, 2021

mcuee commented Jun 18, 2021 •

edited

Loading

Be-ing commented Jun 19, 2021

Youw commented Jun 19, 2021

Youw commented Jun 19, 2021

Be-ing Jun 21, 2021 •

edited

Loading

Youw Jun 22, 2021

Add CMake build system #220

Add CMake build system #220

Conversation

Youw commented Dec 11, 2020 • edited Loading

Qix- left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Qix- Dec 11, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Qix- commented Dec 11, 2020 • edited Loading

Youw commented Dec 11, 2020

Youw commented Dec 11, 2020

Youw commented Dec 11, 2020

Qix- commented Dec 11, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sleiner commented Jun 10, 2021

mcuee commented Jun 16, 2021

mcuee commented Jun 18, 2021 • edited Loading

Be-ing commented Jun 19, 2021

Youw commented Jun 19, 2021

Youw commented Jun 19, 2021

Be-ing Jun 21, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Youw commented Dec 11, 2020 •

edited

Loading

Qix- Dec 11, 2020 •

edited

Loading

Qix- commented Dec 11, 2020 •

edited

Loading

mcuee commented Jun 18, 2021 •

edited

Loading

Be-ing Jun 21, 2021 •

edited

Loading