Many C/C++ GIS libraries are usually built via autoconf/make/nmake/VC. While this is valid approach, we believe there is a better new alternative - CMake. NextGIS Borsch (http://nextgis.com/borsch) is a new build system that is
- a) easier to use,
- b) better solves dependencies and
- c) provides more uniform way of building packages.
Needed dependencies are automatically fetched from repositories. We’ve built an early prototype of such system and tested if on GDAL build process (over 50 core dependent libraries). Now a developer with only three lines of code in CMakeLists.txt for any project he is working on can add dependent GIS library. If needed library exists in the system the build system will use it, if not - it will be downloaded from Github. Our new build system works for both Windows, Linux and MacOS.
These are common cmake scripts for building system. Now two main files created FindAnyProject.cmake and FindExtProject.cmake.
FindAnyProject.cmake - have two main functions: find_anyproject and target_link_extlibraries.
The first one tries to find_package locally. If no package found user can opt to use external project. The FindExtProject.cmake is used for this.
The second one is used to link target libraries from both local or external packages.
Finally, there are sets of FindExtxxx.cmake files for external repositories details and additional logic.
Two additional files are mandatory for Borsch v2 functionality: JSONParser.cmake and util.cmake:
JSONParser.cmake - functions needed for parse github REST API request results.
util.cmake - function need for form binary artifacts names and for use in toolchains.
To use this scripts need to add cmake folder to the sources. Then the folder needs to be added to modules path:
# set path to additional CMake modules
set(CMAKE_MODULE_PATH ${CMAKE_SOURCE_DIR}/cmake ${CMAKE_MODULE_PATH})Add external project with few lines of code:
include(FindAnyProject)
# TIFF support - required, default=ON
find_anyproject(TIFF REQUIRED)Some additional parameters are supported. From find_project support:
- EXACT
- QUIET
- MODULE
- REQUIRED
- COMPONENTS
Version can be specified via VERSION <version>
Any other parameters will be forwarded to the external project. The important parameter is CMAKE_ARGS. Note: do not pass WITH_X options with CMAKE_ARGS, use set(WITH_X ...) instead.
find_anyproject(CURL REQUIRED CMAKE_ARGS
-DBUILD_CURL_EXE=OFF
-DCURL_DISABLE_FTP=ON
-DCURL_DISABLE_LDAP=ON
-DCURL_DISABLE_TELNET=ON
-DCURL_DISABLE_DICT=ON
-DCURL_DISABLE_FILE=ON
-DCURL_DISABLE_TFTP=ON
-DCURL_DISABLE_LDAPS=ON
-DCURL_DISABLE_RTSP=ON
-DCURL_DISABLE_PROXY=ON
-DCURL_DISABLE_POP3=ON
-DCURL_DISABLE_IMAP=ON
-DCURL_DISABLE_SMTP=ON
-DCURL_DISABLE_GOPHER=ON
-DCURL_DISABLE_CRYPTO_AUTH=OFF
-DENABLE_IPV6=OFF
-DENABLE_MANUAL=OFF
-DCMAKE_USE_OPENSSL=OFF
-DCMAKE_USE_LIBSSH2=OFF)The final step is to link target libraries:
target_link_extlibraries(${LIB_NAME})This is a table of currently available libraries.
| # | Repository | Cmaked | OS tested | Notes |
|---|---|---|---|---|
| 1 | lib_z | yes | Windows, Mac OS X |  |
| 2 | lib_lzma | yes | Windows, Mac OS X | |
| 3 | lib_xml2 | yes | Windows, Mac OS X | |
| 4 | lib_curl | yes | Windows, Mac OS X | |
| 5 | lib_geotiff | yes | Windows, Mac OS X | |
| 6 | lib_tiff | yes | Windows, Mac OS X | |
| 7 | lib_jpeg | yes | Windows, Mac OS X | |
| 8 | lib_jbig | yes | Windows, Mac OS X | |
| 9 | lib_iconv | yes | Windows | not needed on Mac OS, |
| 10 | lib_gdal | yes | Windows, Mac OS X | tests present |
| 11 | lib_openssl | yes | Windows, Mac OS X | |
| 12 | lib_jsonc | yes | Windows, Mac OS X | |
| 13 | lib_expat | yes | Windows, Mac OS X | |
| 14 | lib_proj | yes | Windows, Mac OS X | |
| 15 | lib_png | yes | Windows, Mac OS X | tests present |
| 16 | lib_hdf4 | yes | Windows, Mac OS X | |
| 17 | lib_hdf5 | no | For GDAL Hierarchical Data Format Release 5 (HDF5) driver | |
| 18 | lib_szip | yes | Windows, Mac OS X | |
| 19 | lib_hdfeos2 | yes | Windows | tests present, 7 failed |
| 20 | lib_geos | yes | Windows, Mac OS X | |
| 21 | lib_hdfeos5 | no | ||
| 22 | lib_bpg | no | For GDAL BPG (Better Portable Graphics) driver | |
| 23 | lib_dap | no | For GDAL DODS / OPeNDAP driver | |
| 24 | lib_epsilon | no | For GDAL Epsilon - Wavelet compressed images driver | |
| 25 | lib_cfitsio | no | For GDAL FITS (.fits) driver | |
| 26 | lib_sqlite3 | yes | Windows, Mac OS X | For GDAL GeoPackage and other drivers, |
| 27 | lib_gif | yes | Windows, Mac OS X | For GDAL GIF driver, |
| 28 | lib_netcdf | no | For GDAL GMT Compatible netCDF driver | |
| 29 | lib_grass | no | For GDAL GRASS driver | |
| 30 | lib_gta | no | For GDAL Generic Tagged Arrays (.gta) driver | |
| 31 | lib_jasper | no | For GDAL JPEG2000 (.jp2, .j2k) driver | |
| 32 | lib_openjpeg | yes | Windows, Mac OS X | For GDAL GeoPackage and other drivers, |
| 33 | lib_csf | no | For GDAL PCRaster driver | |
| 34 | lib_pdfium | no | For GDAL Geospatial PDF driver | |
| 35 | lib_pq | yes | Windows, Mac OS X | For GDAL PostGIS Raster driver. libpq CMakeLists.txt |
| 36 | lib_ras | no | For GDAL Rasdaman driver | |
| 37 | lib_webp | no | For GDAL WEBP driver | |
| 38 | lib_xerces | no | For GDAL INTERLIS driver | |
| 39 | lib_kml | yes | Windows, Mac OS X | For GDAL LIBKML driver. |
| 40 | lib_mongo | no | For GDAL MongoDB driver | |
| 41 | lib_mysql | no | For GDAL MySQL driver | |
| 42 | lib_pcidsk | no | For GDAL PCI Geomatics Database File driver | |
| 43 | lib_podofo | no | For GDAL Geospatial PDF driver | |
| 44 | lib_freexl | yes | Windows | For GDAL MS Excel format driver |
| 45 | lib_spatialite | yes | Windows, Mac OS X | |
| 46 | lib_spatialindex | yes | Windows, Mac OS X | |
| 47 | googletest | yes | Linux, Windows, Mac OS X | |
| 48 | lib_boost | yes | Make only copies of headers from "boost/" without building libs | |
| 49 | lib_zip | yes | ||
| 50 | lib_uv | yes | ||
| 51 | lib_jpegturbo | no | ||
| 52 | lib_variant | yes | ||
| 53 | lib_rapidjson | yes | ||
| 54 | lib_nunicode | yes | cmaked within the requirements of the mapbox | |
| 55 | lib_geojsonvt | yes | ||
| 56 | postgis | yes | Linux | partially cmaked (except tiger and cgal) |
| 57 | lib_opencad | yes | Linux, Windows, Mac OS X | From GSoC2016, |
| 58 | lib_uriparser | yes | Linux, Windows, Mac OS X | For lib_kml, |
| 59 | numpy | yes | Windows, Mac OS X | Not a package but used for python dependency modules. |
| 60 | lib_ecw | yes | Windows | Prebuild libraries for specific compiler and OS |
| 61 | lib_mrsid | yes | Windows | Prebuild libraries for specific compiler and OS |
| 62 | lib_gsl | yes | Mac OS X | |
| 63 | lib_qt4 | yes | Windows, Mac OS X | Sources received from Qt download site and build using their own build system. |
| 64 | lib_qt5 | yes | Windows, Mac OS X | Sources received from Qt download site and build using their own build system. |
| 65 | lib_qca | yes | Windows, Mac OS X | |
| 66 | lib_qwt | yes | Windows, Mac OS X | |
| 67 | lib_qscintilla | yes | Windows, Mac OS X | |
| 68 | lib_cgal | yes | ||
| 69 | lib_agg | yes | Windows, Mac OS X | |
| 70 | lib_freetype | yes | Windows, Mac OS X | |
| 71 | lib_qhull | yes | Windows, Mac OS X | |
| 72 | py_qt4 | yes | Windows, Mac OS X | Sources received from Riverbank download site and build using their own build system. |
| 73 | py_sip | yes | Windows, Mac OS X | Sources received from Riverbank download site and build using their own build system. |
| 74 | py_psycopg | yes | Windows, Mac OS X | Sources received from pip download site and build using their own build system. |
| 75 | py_dateutil | yes | Windows, Mac OS X | Sources received from pip download site and build using their own build system. |
| 76 | py_pygments | yes | Windows, Mac OS X | Sources received from pip download site and build using their own build system. |
| 77 | py_ows | yes | Windows, Mac OS X | Sources received from pip download site and build using their own build system. |
| 78 | py_httplib | yes | Windows, Mac OS X | Sources received from pip download site and build using their own build system. |
| 79 | py_jinja | yes | Windows, Mac OS X | Sources received from pip download site and build using their own build system. |
| 80 | py_markupsafe | yes | Windows, Mac OS X | Sources received from pip download site and build using their own build system. |
| 81 | py_nose | yes | Windows, Mac OS X | Sources received from pip download site and build using their own build system. |
| 82 | py_pytz | yes | Windows, Mac OS X | Sources received from pip download site and build using their own build system. |
| 83 | py_six | yes | Windows, Mac OS X | Sources received from pip download site and build using their own build system. |
| 84 | py_spatialite | yes | Windows, Mac OS X | Sources received from pip download site and build using their own build system. |
| 85 | py_requests | yes | Windows, Mac OS X | Sources received from pip download site and build using their own build system. |
| 86 | py_yaml | yes | Windows, Mac OS X | Sources received from pip download site and build using their own build system. |
| 87 | lib_yaml | yes | Windows, Mac OS X | |
| 88 | py_functools_lru_cache | yes | Windows, Mac OS X | Sources received from pip download site and build using their own build system. |
| 89 | py_subprocess32 | yes | Windows, Mac OS X | Sources received from pip download site and build using their own build system. |
| 90 | py_cycler | yes | Windows, Mac OS X | Sources received from pip download site and build using their own build system. |
| 91 | py_parsing | yes | Windows, Mac OS X | Sources received from pip download site and build using their own build system. |
| 92 | py_markupsafe | yes | Windows, Mac OS X | Sources received from pip download site and build using their own build system. |
| 93 | py_matplotlib | yes | Windows, Mac OS X | Sources received from pip download site and build using their own build system. |
| 94 | py_contextlib | yes | Windows, Mac OS X | Sources received from pip download site and build using their own build system. |
| 95 | py_raven | yes | Windows, Mac OS X | Sources received from pip download site and build using their own build system. |
| 96 | py_future | yes | Windows, Mac OS X | Sources received from pip download site and build using their own build system. |
| 97 | py_exifread | yes | Windows, Mac OS X | Sources received from pip download site and build using their own build system. |
| 98 | tests | Deprecated. Tests should moved to their repositories |
- Make install instructions according to the GNU standard installation directories. Use
include(GNUInstallDirs). For Mac OS X use option key OSX_FRAMEWORK=ON. Installation directories should be for frameworks:<CMAKE_INSTALL_PREFIX>/Library/Frameworks/<lib name in lower case without lib prefix>.frameworkand for applications:<CMAKE_INSTALL_PREFIX>/Applications/<app name>.app - Add export instructions:
# Add path to includes to build-tree export
target_include_directories(${TARGETS} PUBLIC
$<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}>
$<BUILD_INTERFACE:${CMAKE_CURRENT_BINARY_DIR}>
)
# Add all targets to the build-tree export set
export(TARGETS ${TARGETS}
FILE ${PROJECT_BINARY_DIR}/${PACKAGE_UPPER_NAME}Targets.cmake)
if(REGISTER_PACKAGE)
# Export the package for use from the build-tree
# (this registers the build-tree with a global CMake-registry)
export(PACKAGE ${PACKAGE_UPPER_NAME})
endif()
# Create the ZLIBConfig.cmake file
configure_file(cmake/PackageConfig.cmake.in
${PROJECT_BINARY_DIR}/${PACKAGE_UPPER_NAME}Config.cmake @ONLY)
if(NOT SKIP_INSTALL_LIBRARIES AND NOT SKIP_INSTALL_ALL)
# Install the <Package>Config.cmake
install(FILES
${PROJECT_BINARY_DIR}/${PACKAGE_UPPER_NAME}Config.cmake
DESTINATION ${INSTALL_CMAKECONF_DIR} COMPONENT dev)
# Install the export set for use with the install-tree
install(EXPORT ${PACKAGE_UPPER_NAME}Targets DESTINATION ${INSTALL_CMAKECONF_DIR} COMPONENT dev)
endif()Also check install instruction has EXPORT and INCLUDES tags:
install(TARGETS ${TARGETS}
EXPORT ${PACKAGE_UPPER_NAME}Targets
RUNTIME DESTINATION ${INSTALL_BIN_DIR}
LIBRARY DESTINATION ${INSTALL_LIB_DIR}
ARCHIVE DESTINATION ${INSTALL_LIB_DIR}
INCLUDES DESTINATION ${INSTALL_INC_DIR}
FRAMEWORK DESTINATION ${INSTALL_LIB_DIR} )This will export targets for build-tree use and for install-tree use.
- All dependencies must be connected via find_anyproject (see "Borsch scripts").
3.1. You need to add the relevant scripts from borsch to 'cmake' directory
3.2. Add cmake instruction (if it is not present):
set(CMAKE_MODULE_PATH ${CMAKE_SOURCE_DIR}/cmake ${CMAKE_MODULE_PATH})- Preferably cmake via include(util) should extract version from header file or another files and report it colored
- Preferably add Findxxx.cmake with version check (see. FindGEOS and FindPROJ4)
- Create FindExtxxx.cmake with library repository name and some optional variables
Then new version of a library released, borsch need to be updated too.
- Create tag for current version in repository and send it to server:
git tag -a v1.0.2.1 -m 'version 1.0.2a from 22 Jan 2015'
git push origin --tagsAlso see github_release.py script to upload zip archive from CPack generator
to the release marked by tag. This prebuild files will use in building process.
- Copy sources from original to borsch repository (don't copy build scripts).
One can use some diff utility to check changes (i.e. meld).
If
opt/folders.csvexist use following command line utility:
python tools.py organize --src <path to sources> --dst_name <borsch repository name>- Check if everything build successfully
Use special badge to mark repository supported NextGIS Borsch building system.
[](https://github.com/nextgis-borsch/borsch)All scripts are licensed under GNU GPL v.2.
- There is additional util.cmake file for pretty print of version information to the console.
- MSVC 2015 and later have enough C99 support to build under Windows.
#Links: