https://github.com/mizux/cmake-swig
Modern CMake C++ SWIG Sample
https://github.com/mizux/cmake-swig
c-plus-plus cmake mizux swig
Last synced: 6 months ago
JSON representation
Modern CMake C++ SWIG Sample
- Host: GitHub
- URL: https://github.com/mizux/cmake-swig
- Owner: Mizux
- License: apache-2.0
- Created: 2017-12-22T10:28:08.000Z (almost 8 years ago)
- Default Branch: main
- Last Pushed: 2025-03-19T17:14:04.000Z (7 months ago)
- Last Synced: 2025-04-09T21:12:47.076Z (6 months ago)
- Topics: c-plus-plus, cmake, mizux, swig
- Language: CMake
- Size: 522 KB
- Stars: 182
- Watchers: 8
- Forks: 29
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Authors: AUTHORS
Awesome Lists containing this project
README
| OS | C++ | Python | Java | .NET |
|:-------|-----|--------|------|------|
| Linux | [![Status][cpp_linux_svg]][cpp_linux_link] | [![Status][python_linux_svg]][python_linux_link] | [![Status][java_linux_svg]][java_linux_link] | [![Status][dotnet_linux_svg]][dotnet_linux_link] |
| macOS | [![Status][cpp_macos_svg]][cpp_macos_link] | [![Status][python_macos_svg]][python_macos_link] | [![Status][java_macos_svg]][java_macos_link] | [![Status][dotnet_macos_svg]][dotnet_macos_link] |
| Windows | [![Status][cpp_windows_svg]][cpp_windows_link] | [![Status][python_windows_svg]][python_windows_link] | [![Status][java_windows_svg]][java_windows_link] | [![Status][dotnet_windows_svg]][dotnet_windows_link] |
[cpp_linux_svg]: https://github.com/Mizux/cmake-swig/actions/workflows/amd64_linux_cpp.yml/badge.svg
[cpp_linux_link]: https://github.com/Mizux/cmake-swig/actions/workflows/amd64_linux_cpp.yml
[dotnet_linux_svg]: https://github.com/Mizux/cmake-swig/actions/workflows/amd64_linux_dotnet.yml/badge.svg
[dotnet_linux_link]: https://github.com/Mizux/cmake-swig/actions/workflows/amd64_linux_dotnet.yml
[java_linux_svg]: https://github.com/Mizux/cmake-swig/actions/workflows/amd64_linux_java.yml/badge.svg
[java_linux_link]: https://github.com/Mizux/cmake-swig/actions/workflows/amd64_linux_java.yml
[python_linux_svg]: https://github.com/Mizux/cmake-swig/actions/workflows/amd64_linux_python.yml/badge.svg
[python_linux_link]: https://github.com/Mizux/cmake-swig/actions/workflows/amd64_linux_python.yml
[cpp_macos_svg]: https://github.com/Mizux/cmake-swig/actions/workflows/amd64_macos_cpp.yml/badge.svg
[cpp_macos_link]: https://github.com/Mizux/cmake-swig/actions/workflows/amd64_macos_cpp.yml
[dotnet_macos_svg]: https://github.com/Mizux/cmake-swig/actions/workflows/amd64_macos_dotnet.yml/badge.svg
[dotnet_macos_link]: https://github.com/Mizux/cmake-swig/actions/workflows/amd64_macos_dotnet.yml
[java_macos_svg]: https://github.com/Mizux/cmake-swig/actions/workflows/amd64_macos_java.yml/badge.svg
[java_macos_link]: https://github.com/Mizux/cmake-swig/actions/workflows/amd64_macos_java.yml
[python_macos_svg]: https://github.com/Mizux/cmake-swig/actions/workflows/amd64_macos_python.yml/badge.svg
[python_macos_link]: https://github.com/Mizux/cmake-swig/actions/workflows/amd64_macos_python.yml
[cpp_windows_svg]: https://github.com/Mizux/cmake-swig/actions/workflows/amd64_windows_cpp.yml/badge.svg
[cpp_windows_link]: https://github.com/Mizux/cmake-swig/actions/workflows/amd64_windows_cpp.yml
[dotnet_windows_svg]: https://github.com/Mizux/cmake-swig/actions/workflows/amd64_windows_dotnet.yml/badge.svg
[dotnet_windows_link]: https://github.com/Mizux/cmake-swig/actions/workflows/amd64_windows_dotnet.yml
[java_windows_svg]: https://github.com/Mizux/cmake-swig/actions/workflows/amd64_windows_java.yml/badge.svg
[java_windows_link]: https://github.com/Mizux/cmake-swig/actions/workflows/amd64_windows_java.yml
[python_windows_svg]: https://github.com/Mizux/cmake-swig/actions/workflows/amd64_windows_python.yml/badge.svg
[python_windows_link]: https://github.com/Mizux/cmake-swig/actions/workflows/amd64_windows_python.yml
[![Build Status][amd64_docker_status]][amd64_docker_link]
[amd64_docker_status]: https://github.com/Mizux/cmake-swig/actions/workflows/amd64_docker.yml/badge.svg
[amd64_docker_link]: https://github.com/Mizux/cmake-swig/actions/workflows/amd64_docker.yml
# Introduction
|
Requirement |
Codemap |
Dependencies |
Build |
C++ |
Swig |
Python 3 |
.Net Core |
Java |
CI |
Appendices |
License |
This is a complete example of how to create a Modern [CMake](https://cmake.org/) C++ Project
with the [SWIG](http://www.swig.org) code generator to generate wrapper and package for Python, .Net and Java.
This project should run on GNU/Linux, MacOS and Windows.
You can find detailed documentation for [C++](docs/cpp.md), [Swig](docs/swig.md),
[Python 3](docs/python.md), [.Net Core](docs/dotnet.md) and [Java](docs/java.md).
note: You should read **C++** and **Swig** first since since other languages are
just swig generated wrappers from the C++.
## Requirement
You'll need:
* "CMake >= 3.18".
* "Python >= 3.6" and python module 'pip' (ed "setuptools" and "wheel" will be
auto installed on demand).
## Codemap
The project layout is as follow:
* [CMakeLists.txt](CMakeLists.txt) Top-level for [CMake](https://cmake.org/cmake/help/latest/) based build.
* [cmake](cmake) Subsidiary CMake files.
* [python.cmake](cmake/python.cmake) All internall Python CMake stuff.
* [dotnet.cmake](cmake/dotnet.cmake) All internall .Net CMake stuff.
* [java.cmake](cmake/java.cmake) All internall Java CMake stuff.
* [ci](ci) Root directory for continuous integration.
* [Foo](Foo) Root directory for `Foo` library.
* [CMakeLists.txt](Foo/CMakeLists.txt) for `Foo`.
* [include](Foo/include) public folder.
* [foo](Foo/include/foo)
* [Foo.hpp](Foo/include/foo/Foo.hpp)
* [src](Foo/src) private folder.
* [src/Foo.cpp](Foo/src/Foo.cpp)
* [python](Foo/python)
* [CMakeLists.txt](Foo/python/CMakeLists.txt) for `Foo` Python.
* [foo.i](Foo/python/foo.i) SWIG Python wrapper.
* [dotnet](Foo/dotnet)
* [CMakeLists.txt](Foo/dotnet/CMakeLists.txt) for `Foo` .Net.
* [foo.i](Foo/dotnet/foo.i) SWIG .Net wrapper.
* [java](Foo/java)
* [CMakeLists.txt](Foo/java/CMakeLists.txt) for `Foo` Java.
* [java/foo.i](Foo/java/foo.i) SWIG Java wrapper.
* [Bar](Bar) Root directory for `Bar` library.
* [CMakeLists.txt](Bar/CMakeLists.txt) for `Bar`.
* [include](Bar/include) public folder.
* [bar](Bar/include/bar)
* [Bar.hpp](Bar/include/bar/Bar.hpp)
* [src](Bar/src) private folder.
* [src/Bar.cpp](Bar/src/Bar.cpp)
* [python](Bar/python)
* [CMakeLists.txt](Bar/python/CMakeLists.txt) for `Bar` Python.
* [bar.i](Bar/python/bar.i) SWIG Python wrapper.
* [dotnet](Bar/dotnet)
* [CMakeLists.txt](Bar/dotnet/CMakeLists.txt) for `Bar` .Net.
* [bar.i](Bar/dotnet/bar.i) SWIG .Net wrapper.
* [java](Bar/java)
* [CMakeLists.txt](Bar/java/CMakeLists.txt) for `Bar` Java.
* [java/bar.i](Bar/java/bar.i) SWIG Java wrapper.
* [FooBar](FooBar) Root directory for `FooBar` library.
* [CMakeLists.txt](FooBar/CMakeLists.txt) for `FooBar`.
* [include](FooBar/include) public folder.
* [foobar](FooBar/include/foobar)
* [FooBar.hpp](FooBar/include/foobar/FooBar.hpp)
* [src](FooBar/src) private folder.
* [src/FooBar.cpp](FooBar/src/FooBar.cpp)
* [python](FooBar/python)
* [CMakeLists.txt](FooBar/python/CMakeLists.txt) for `FooBar` Python.
* [foobar.i](FooBar/python/foobar.i) SWIG Python wrapper.
* [dotnet](FooBar/dotnet)
* [CMakeLists.txt](FooBar/dotnet/CMakeLists.txt) for `FooBar` .Net.
* [foobar.i](FooBar/dotnet/foobar.i) SWIG .Net wrapper.
* [java](FooBar/java)
* [CMakeLists.txt](FooBar/java/CMakeLists.txt) for `FooBar` Java.
* [java/foobar.i](FooBar/java/foobar.i) SWIG Java wrapper.
* [FooBarApp](FooBarApp) Root directory for `FooBarApp` executable.
* [CMakeLists.txt](FooBarApp/CMakeLists.txt) for `FooBarApp`.
* [src](FooBarApp/src) private folder.
* [src/main.cpp](FooBarApp/src/main.cpp)
* [python](python) Root directory for Python template files
* [`setup.py.in`](python/setup.py.in) setup.py template for the Python native package.
* [dotnet](dotnet) Root directory for .Net template files
* [java](java) Root directory for Java template files
## Dependencies
To complexify a little, the CMake project is composed of three libraries (Foo, Bar and FooBar)
with the following dependencies:
```sh
Foo:
Bar:
FooBar: PUBLIC Foo PRIVATE Bar
```
## Build
To build the C++ project, as usual:
```sh
cmake -S. -Bbuild
cmake --build build
```
## Appendices
Few links on the subject...
### Resources
Project layout:
* The Pitchfork Layout Revision 1 (cxx-pflR1)
CMake:
* https://llvm.org/docs/CMakePrimer.html
* https://cliutils.gitlab.io/modern-cmake/
* https://cgold.readthedocs.io/en/latest/
Python:
* [Packaging Python Project](https://packaging.python.org/tutorials/packaging-projects/)
* [PEP 600 Future 'manylinux' Platform Tags](https://www.python.org/dev/peps/pep-0600/)
.Net:
* [.NET Core RID Catalog](https://docs.microsoft.com/en-us/dotnet/core/rid-catalog)
* [Creating native packages](https://docs.microsoft.com/en-us/nuget/create-packages/native-packages)
* [Blog on Nuget Rid Graph](https://natemcmaster.com/blog/2016/05/19/nuget3-rid-graph/)
* [Common MSBuild project properties](https://docs.microsoft.com/en-us/visualstudio/msbuild/common-msbuild-project-properties?view=vs-2017)
* [MSBuild well-known item metadata](https://docs.microsoft.com/en-us/visualstudio/msbuild/msbuild-well-known-item-metadata?view=vs-2017)
* [Additions to the csproj format for .NET Core](https://docs.microsoft.com/en-us/dotnet/core/tools/csproj)
### Issues
Some issue related to this process
* [Nuget needs to support dependencies specific to target runtime #1660](https://github.com/NuGet/Home/issues/1660)
* [Improve documentation on creating native packages #238](https://github.com/NuGet/docs.microsoft.com-nuget/issues/238)
* [Guide for packaging C# library using P/Invoke](https://github.com/NuGet/Home/issues/8623)
### Misc
Image has been generated using [plantuml](http://plantuml.com/):
```bash
plantuml -Tsvg docs/{file}.dot
```
So you can find the dot source files in [docs](docs).
## License
Apache 2. See the LICENSE file for details.
## Disclaimer
This is not an official Google product, it is just code that happens to be
owned by Google.