Modern cmake #40

simogasp · 2016-11-07T18:23:47Z

This PR upgrades the building system to a modern version of cmake. In particular:

Only a single library is built, libCCTag, whether CUDA is enabled or not
The targets have now the correct visibility wrt the dependencies (PUBLIC, PRIVATE, INTERFACE)
A CCTagConfig.cmake is generated for the installation allowing to better import the built library as third party in other cmake projects
A cctag_config.hpp file is generated containing the definitions used to compile the library. Note that said definition are automatically imported by CCTagConfig.cmake in the cmake host project.
- for now it is not included in any of the source files as cmake add already the definitions.
In the same spirit, a version.hpp file is generate containing the definition for the code version
USE_CUDA has been replaced by WITH_CUDA as cmake option to compile with cuda (it simplifies the generation of the config file)

connected to #38

While at it, this PR also add CUDA to Continuous Integration on Travis (connected to #42)

check the error case first and fail accordingly

#38

…leaning Conflicts: src/CMakeLists.txt

fix #38 * sorry not an atomic commit, too many changes involved * Now only one library is generate, the same whether it is with or without CUDA * A CCTagConfig.cmake is generate to properly import the library * The applications are now a separate project, thus it can be compiled as a bundle or with CCTag as third party (so we can test) * There is a duplicate FindTBB.cmake in order to do the previous point

Conflicts: CMakeLists.txt

#38 Now the behaviour is that if it cannot find cuda it errors instead of falling back to CPU

#38

fix #42

#38

simogasp · 2016-11-09T09:38:56Z

CMakeLists.txt

@@ -4,7 +4,18 @@ cmake_minimum_required(VERSION 3.4)

 include(ExternalProject)

-project( CCTag )
+project(CCTag VERSION 1.0.0 LANGUAGES C CXX)


@fabiencastan @zvrba @griwodz @lcalvet
Two things:

if you agree we can express the lib version with project(), this automatically sets all the variables to recover the major, minor, patch numbers (see https://cmake.org/cmake/help/v3.0/command/project.html)

More importantly I set here 1.0.0 as a first version of the library. It's arbitrary but it seemed to me a good number to start with :-). Anyway, just decide a number if you prefer another, the important thing is that what we decide here will be the minimal version supported in all the other libs, openMVG and other LABO libs.

It's important to have the version in the code, so users of the library can do some #if CCTAG_VERSION_MAJOR > 1.
Usually, I create a "version.hpp" and parse the values of major, minor, micro in cmake from this header.

With this you can do the other way around, cmake can generate the version file with a template like:

[version.hpp.in] #pragma once #define CCTAG_VERSION_MAJOR @PROJECT_VERSION_MAJOR@ #define CCTAG_VERSION_MINOR @PROJECT_VERSION_MINOR@ #define CCTAG_VERSION_PATCH @PROJECT_VERSION_PATCH@ #define CCTAG_VERSION @PROJECT_VERSION@ //etc

which generates (and installs)

[version.hpp] #pragma once #define CCTAG_VERSION_MAJOR 1 #define CCTAG_VERSION_MINOR 0 #define CCTAG_VERSION_PATCH 0 #define CCTAG_VERSION 1.0.0

that can be included by the headers of the lib (if necessary) or by 3rd party code (the same way i did the config.hpp)

I actually did it, i can push it

The only drawback of this approach (it seems to me) is that if for some reason, god forbid, one day we need to switch to a different building system it may be possible that we cannot replicate this and to have to add version.hpp to the source code.

Yes, the code is no more autonomous, just for that. So your IDE or static analysis tools will make an error on #include "cctag/version.hpp" as this file doesn't exist in your source tree.
I prefer to keep the important information in the code instead of cmake. But it's a detail, both works.

So your IDE tools will make an error

Nitpicking, but true only for the IDEs that do not support cmake, the file is generated during the cmake configuration and it is enough to include it among the include directories of the targets with e.g. $<BUILD_INTERFACE:<the place where generated files are>> (so that it only works for in-tree build), at that point the IDE has no problem at retrieving it.

or we can use git tags to determine the version
http://brianmilco.blogspot.fr/2012/11/cmake-automatically-use-git-tags-as.html

:-D

#38

fabiencastan · 2016-11-21T21:44:29Z

BUILD.md

+```cmake
+# Find the package from the CCTagConfig.cmake 
+# in <prefix>/lib/cmake/CCTag/. Under the namespace CCTag::
+# it exposes the target popsift that allows you to compile


fabiencastan · 2016-11-21T21:46:07Z

BUILD.md

+### Using CCTag as third party
+
+When you install CCTag a file `CCTagConfig.cmake` is installed in `$CCTAG_INSTALL/lib/cmake/CCTag/` that allows you to import the library in your CMake project.
+In your `CMakeLists.txt` file just add the dependency


add the dependency like that:

fabiencastan · 2016-11-21T22:32:45Z

src/CMakeLists.txt

+  # set(BUILD_SHARED_LIBS ON)
+
+  if(NOT COMPILE_STATIC_CCTAG_LIBRARY)
+    message( FATAL_ERROR "We must link CCTag library static with CUDA" )


To use CUDA, CCTag library needs to be build in static.
To disable CUDA and generate a dynamic library use: -DWITH_CUDA=OFF.

#38

fabiencastan · 2016-11-22T09:59:46Z

To be consistent with openMVG, but also ceres and opencv, it would be better to install config files in "share/CCTag/".

Both seems to be recognized by cmake as explained here:

CMake constructs a set of possible installation prefixes for the package. Under each prefix several directories are searched for a configuration file. The tables below show the directories searched. Each entry is meant for installation trees following Windows (W), UNIX (U), or Apple (A) conventions:

<prefix>/                                                       (W)
<prefix>/(cmake|CMake)/                                         (W)
<prefix>/<name>*/                                               (W)
<prefix>/<name>*/(cmake|CMake)/                                 (W)
<prefix>/(lib/<arch>|lib|share)/cmake/<name>*/                  (U) <<<<
<prefix>/(lib/<arch>|lib|share)/<name>*/                        (U)
<prefix>/(lib/<arch>|lib|share)/<name>*/(cmake|CMake)/          (U)
<prefix>/<name>*/(lib/<arch>|lib|share)/cmake/<name>*/          (W/U)
<prefix>/<name>*/(lib/<arch>|lib|share)/<name>*/                (W/U)
<prefix>/<name>*/(lib/<arch>|lib|share)/<name>*/(cmake|CMake)/  (W/U)

simogasp · 2016-11-22T13:14:01Z

I just followed this on CMake tutorial https://cmake.org/cmake/help/v3.0/manual/cmake-packages.7.html#package-version-file
Alembic uses the same, for example.

simogasp added 7 commits October 4, 2016 12:34

[cmake] to lower case

f95a34a

[cmake] simplified if

ed17380

check the error case first and fail accordingly

[cmake] split the CMakeLists.txt for applications

77e6325

#38

[cmake] add project version

117ea57

#38

Merge branch 'buildCleaning' of github.com:poparteu/CCTag into buildC…

9b85fb1

…leaning Conflicts: src/CMakeLists.txt

Merge branch 'buildCleaning' into modernCmake

295ba2a

simogasp added the in progress label Nov 7, 2016

simogasp added 4 commits November 7, 2016 19:30

Merge branch 'develop' into modernCmake

ec5f945

Conflicts: CMakeLists.txt

[ci] forcing -DUSE_CUDA=OFF

b252a01

#38 Now the behaviour is that if it cannot find cuda it errors instead of falling back to CPU

[ci] do not install dependencies in same dir as cctag!

f50deb2

[ci] make install

9f827d1

#38

simogasp force-pushed the modernCmake branch 3 times, most recently from febc741 to 49bcd70 Compare November 7, 2016 19:54

simogasp added 3 commits November 7, 2016 20:55

[ci] add test build as 3rd party

49bcd70

#38

[cmake] removed useless code

c412494

#38

[doc] cmake version and opencv

24c225c

simogasp added this to the 2016_11 milestone Nov 7, 2016

simogasp added 2 commits November 8, 2016 10:00

[doc] Using CCTag as third party

6ec86ae

[cmake] removed FindCCTag, not necessary anymore

16cbf4a

simogasp force-pushed the modernCmake branch from 090276b to 16cbf4a Compare November 8, 2016 09:00

simogasp added 2 commits November 8, 2016 11:45

[cmake] cleaning

63f6cfb

#38

[cmake] CCTAG_SM_ARCH and CCTAG_SM

493a471

#38

simogasp force-pushed the modernCmake branch from 5a0faf6 to 4628dcc Compare November 8, 2016 10:53

simogasp added 2 commits November 8, 2016 11:54

[cmake] USE_CUDA --> WITH_CUDA

bae6685

#38

[cmake] added generation of a cctag_config.hpp with definitions

4628dcc

#38

simogasp added type:feature prio:major scope:build labels Nov 8, 2016

simogasp added type:enhancement lead:IRT type:pr review and removed in progress labels Nov 8, 2016

[cmake] added VISUAL_DEBUG

c9416d7

#38

simogasp assigned fabiencastan, zvrba and griwodz Nov 8, 2016

simogasp added 3 commits November 8, 2016 18:47

[ci] added cuda

5aabec3

fix #42

[cmake] disabling CUDA_NVCC_FLAGS_DEBUG to avoid nvcc failure

b44198c

#38

[cmake] just formatting

e2cb6d2

#38

simogasp mentioned this pull request Nov 8, 2016

[cmake] switch to new version of cctag alicevision/AliceVision#250

Closed

6 tasks

simogasp commented Nov 9, 2016

View reviewed changes

simogasp mentioned this pull request Nov 9, 2016

CCTag modern cmake alicevision/AliceVision#251

Merged

simogasp added 4 commits November 9, 2016 16:11

[cmake] local and install include in front

1c04a65

#38

[cmake] definitions in common

b06e716

#38

[cmake] generated files in generate directory

7806c43

#38

[cmake] generated version.hpp

00d37ce

#38

fabiencastan reviewed Nov 21, 2016

View reviewed changes

fabiencastan changed the title ~~[WIP] Modern cmake~~ Modern cmake Nov 21, 2016

simogasp added 2 commits November 22, 2016 08:51

[doc] fixes

fab0dff

#38

[cmake] better error message

f421430

#38

fabiencastan merged commit 9cee7d8 into develop Nov 24, 2016

fabiencastan removed the review label Nov 24, 2016

fabiencastan deleted the modernCmake branch November 24, 2016 09:53

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Modern cmake #40

Modern cmake #40

simogasp commented Nov 7, 2016 •

edited

Loading

simogasp Nov 9, 2016

fabiencastan Nov 9, 2016

simogasp Nov 9, 2016 •

edited

Loading

simogasp Nov 9, 2016

simogasp Nov 9, 2016

fabiencastan Nov 9, 2016

simogasp Nov 9, 2016 •

edited

Loading

simogasp Nov 10, 2016

fabiencastan Nov 21, 2016

simogasp Nov 22, 2016

fabiencastan Nov 21, 2016

fabiencastan Nov 21, 2016 •

edited

Loading

fabiencastan commented Nov 22, 2016 •

edited

Loading

simogasp commented Nov 22, 2016

Modern cmake #40

Modern cmake #40

Conversation

simogasp commented Nov 7, 2016 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

simogasp Nov 9, 2016 • edited Loading

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

simogasp Nov 9, 2016 • edited Loading

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

fabiencastan Nov 21, 2016 • edited Loading

Choose a reason for hiding this comment

fabiencastan commented Nov 22, 2016 • edited Loading

simogasp commented Nov 22, 2016

simogasp commented Nov 7, 2016 •

edited

Loading

simogasp Nov 9, 2016 •

edited

Loading

simogasp Nov 9, 2016 •

edited

Loading

fabiencastan Nov 21, 2016 •

edited

Loading

fabiencastan commented Nov 22, 2016 •

edited

Loading