Page not found
+ + +This project exists thanks to all the people who contribute.
+ + + +You can get started with just a few commands as the demo shows. Let's create a new Cabin project:
+you:~$ cabin new hello_world
+ Created binary (application) `hello_world` package
+Now, you can use the cabin run command to run your application:
you:~$ cd hello_world
+you:~/hello_world$ cabin run
+ Compiling src/main.cc
+ Linking hello_world
+ Finished debug target(s) in 0.45386s
+ Running cabin-out/debug/hello_world
+Hello, world!
+Cabin is a package manager and build system for C++ users, inspired by Cargo for Rust. Cabin is designed as a structure-oriented build system, which means that as long as you follow Cabin's designated project structure, you almost do not need configurations, much less a language to build, unlike CMake. If you do not like writing a bunch of configurations to build your project, Cabin might be best suited. Currently, the supported project structure can be known by looking at this repository since Cabin can build itself.
+ +
cabin lint)cabin fmt)cabin tidy)src/**: contains source files and private header filesinclude/**: contains public header files' + escapeHtml(summary) +'
' + noResultsText + '
'); + } +} + +function doSearch () { + var query = document.getElementById('mkdocs-search-query').value; + if (query.length > min_search_length) { + if (!window.Worker) { + displayResults(search(query)); + } else { + searchWorker.postMessage({query: query}); + } + } else { + // Clear results for short queries + displayResults([]); + } +} + +function initSearch () { + var search_input = document.getElementById('mkdocs-search-query'); + if (search_input) { + search_input.addEventListener("keyup", doSearch); + } + var term = getSearchTermFromLocation(); + if (term) { + search_input.value = term; + doSearch(); + } +} + +function onWorkerMessage (e) { + if (e.data.allowSearch) { + initSearch(); + } else if (e.data.results) { + var results = e.data.results; + displayResults(results); + } else if (e.data.config) { + min_search_length = e.data.config.min_search_length-1; + } +} + +if (!window.Worker) { + console.log('Web Worker API not supported'); + // load index in main thread + $.getScript(joinUrl(base_url, "search/worker.js")).done(function () { + console.log('Loaded worker'); + init(); + window.postMessage = function (msg) { + onWorkerMessage({data: msg}); + }; + }).fail(function (jqxhr, settings, exception) { + console.error('Could not load worker.js'); + }); +} else { + // Wrap search in a web worker + var searchWorker = new Worker(joinUrl(base_url, "search/worker.js")); + searchWorker.postMessage({init: true}); + searchWorker.onmessage = onWorkerMessage; +} diff --git a/search/search_index.json b/search/search_index.json new file mode 100644 index 000000000..46e7a0b54 --- /dev/null +++ b/search/search_index.json @@ -0,0 +1 @@ +{"config":{"indexing":"full","lang":["en"],"min_search_length":3,"prebuild_index":false,"separator":"[\\s\\-]+"},"docs":[{"location":"","text":"Introduction Cabin is a package manager and build system for C++ users, inspired by Cargo for Rust. Cabin is designed as a structure-oriented build system, which means that as long as you follow Cabin's designated project structure, you almost do not need configurations, much less a language to build, unlike CMake. If you do not like writing a bunch of configurations to build your project, Cabin might be best suited. Currently, the supported project structure can be known by looking at this repository since Cabin can build itself.","title":"Introduction"},{"location":"#introduction","text":"Cabin is a package manager and build system for C++ users, inspired by Cargo for Rust. Cabin is designed as a structure-oriented build system, which means that as long as you follow Cabin's designated project structure, you almost do not need configurations, much less a language to build, unlike CMake. If you do not like writing a bunch of configurations to build your project, Cabin might be best suited. Currently, the supported project structure can be known by looking at this repository since Cabin can build itself.","title":"Introduction"},{"location":"acknowledgements/","text":"Acknowledgements This project exists thanks to all the people who contribute.","title":"Acknowledgements"},{"location":"acknowledgements/#acknowledgements","text":"This project exists thanks to all the people who contribute.","title":"Acknowledgements"},{"location":"hello-world/","text":"Hello, World! You can get started with just a few commands as the demo shows. Let's create a new Cabin project: you:~$ cabin new hello_world Created binary (application) `hello_world` package Now, you can use the cabin run command to run your application: you:~$ cd hello_world you:~/hello_world$ cabin run Compiling src/main.cc Linking hello_world Finished debug target(s) in 0.45386s Running cabin-out/debug/hello_world Hello, world!","title":"Hello, World!"},{"location":"hello-world/#hello-world","text":"You can get started with just a few commands as the demo shows. Let's create a new Cabin project: you:~$ cabin new hello_world Created binary (application) `hello_world` package Now, you can use the cabin run command to run your application: you:~$ cd hello_world you:~/hello_world$ cabin run Compiling src/main.cc Linking hello_world Finished debug target(s) in 0.45386s Running cabin-out/debug/hello_world Hello, world!","title":"Hello, World!"},{"location":"installation/","text":"Installation Supported Operating Systems Linux macOS Runtime Requirements C++ compiler GNU Make pkg-config mkdir printf cpplint (for cabin lint ) clang-format (for cabin fmt ) clang-tidy (for cabin tidy )","title":"Installation"},{"location":"installation/#installation","text":"","title":"Installation"},{"location":"installation/#supported-operating-systems","text":"Linux macOS","title":"Supported Operating Systems"},{"location":"installation/#runtime-requirements","text":"C++ compiler GNU Make pkg-config mkdir printf cpplint (for cabin lint ) clang-format (for cabin fmt ) clang-tidy (for cabin tidy )","title":"Runtime Requirements"},{"location":"package-layout/","text":"Package Layout src/** : contains source files and private header files include/** : contains public header files","title":"Package Layout"},{"location":"package-layout/#package-layout","text":"src/** : contains source files and private header files include/** : contains public header files","title":"Package Layout"},{"location":"usage/","text":"Usage Start a new project with Cabin The cabin new command lets you start a new Cabin project: you:~$ cabin new hello_world Created binary (application) `hello_world` package [!TIP] If you want to integrate your existing project with Cabin, use the init command: console you:~/your-pj$ cabin init Created binary (application) `your-pj` package This command just creates a cabin.toml file not to break your project. Build the project In most cases, you want to execute the generated binary as well as build the project. you:~/hello_world$ cabin run Compiling src/main.cc Linking hello_world Finished debug target(s) in 0.45386s Running cabin-out/debug/hello_world Hello, world! If you just want to build it, run the build command: you:~/hello_world$ cabin build Finished debug target(s) in 0.00866317s Cabin uses a cache since we executed the command with no changes. [!TIP] To use a different compiler, you can export a CXX environmental variable: shell export CXX=g++-13 Install dependencies Like Cargo does, Cabin installs dependencies at build time. Cabin currently supports Git, path, and system dependencies. You can use two ways to add dependencies to your project: using the cabin add command and editing cabin.toml directly. [!WARNING] - Cabin currently supports building a project with header-only dependencies. - Building with build-required dependencies will be soon supported. [!NOTE] A header-only library is a type of library where the entire functionality is contained within header files, and no additional compilation steps are required. This means you can directly include the library's headers in your project without needing to link against any compiled binaries. These libraries require the headers to be in the root or include/ directory. This ensures that the library's header files are accessible in a predictable location for easy inclusion in your project. Here are some links that can help you find header-only libraries: - https://github.com/topics/single-header - https://github.com/topics/header-only - https://github.com/p-ranav/awesome-hpp cabin add The cabin add command accepts the following arguments: cabin addThe cabin new command lets you start a new Cabin project:
you:~$ cabin new hello_world
+ Created binary (application) `hello_world` package
+++[!TIP] +If you want to integrate your existing project with Cabin, use the
+initcommand:+
console +you:~/your-pj$ cabin init + Created binary (application) `your-pj` packageThis command just creates a
+cabin.tomlfile not to break your project.
In most cases, you want to execute the generated binary as well as build the project.
+you:~/hello_world$ cabin run
+ Compiling src/main.cc
+ Linking hello_world
+ Finished debug target(s) in 0.45386s
+ Running cabin-out/debug/hello_world
+Hello, world!
+If you just want to build it, run the build command:
you:~/hello_world$ cabin build
+ Finished debug target(s) in 0.00866317s
+Cabin uses a cache since we executed the command with no changes.
+++[!TIP] +To use a different compiler, you can export a
+CXXenvironmental variable:+
shell +export CXX=g++-13
Like Cargo does, Cabin installs dependencies at build time. Cabin currently supports Git, path, and system dependencies. You can use two ways to add dependencies to your project: using the cabin add command and editing cabin.toml directly.
++[!WARNING] +- Cabin currently supports building a project with header-only dependencies. +- Building with build-required dependencies will be soon supported.
+[!NOTE]
+
+A header-only library is a type of library where the entire functionality is contained within header files, and no additional compilation steps are required. This means you can directly include the library's headers in your project without needing to link against any compiled binaries.These libraries require the headers to be in the root or include/ directory. This ensures that the library's header files are accessible in a predictable location for easy inclusion in your project.
+Here are some links that can help you find header-only libraries:
+
+- https://github.com/topics/single-header
+- https://github.com/topics/header-only
+- https://github.com/p-ranav/awesome-hpp
cabin addThe cabin add command accepts the following arguments:
cabin add <package names ....> --<options>
Options:
+- --sys: Marks the packages as system dependency (requires the --version argument)
+- --version: Specify dependency version. Only used with system dependencies
+- --rev: Specify revision for git dependencies
+- --tag: Specify tag for git dependencies
+- --branch: Specify branch for git dependencies
Example
+cabin add libgit2 --sys --version "1.1.0"
+cabin add "ToruNiina/toml11" --rev "846abd9a49082fe51440aa07005c360f13a67bbf"
+cabin.toml directlyThe syntax for cabin.toml is as follows:
[dependencies]
+
+# git dependency
+"ToruNiina/toml11" = { git = "https://github.com/ToruNiina/toml11.git", rev = "846abd9a49082fe51440aa07005c360f13a67bbf" }
+
+# path dependency
+local_lib = { path = "../local_lib" }
+
+# system dependency
+fmt = { version = ">= 9", system = true }
+If tag, branch, or rev is unspecified for git dependencies, Cabin will use the latest revision of the default branch. System dependency names must be acceptable by pkg-config. The version requirement syntax is specified in src/VersionReq.hpp.
After adding dependencies, executing the build command will install the package and its dependencies.
you:~/hello_world$ cabin build
+Downloaded ToruNiina/toml11 846abd9a49082fe51440aa07005c360f13a67bbf
+ Compiling src/main.cc
+ Linking hello_world
+ Finished debug target(s) in 0.70s
+You can write unit tests in any source files within the src directory. Create a new file like:
src/Lib.cc
int add(int a, int b) {
+ return a + b;
+}
+
+#ifdef CABIN_TEST
+
+# include <cassert>
+
+int main() {
+ assert(add(1, 2) == 3); // ok
+ assert(add(1, 2) == 4); // fail
+}
+
+#endif
+Now, with the test command, you can run tests defined within CABIN_TEST:
you:~/hello_world$ cabin test
+ Compiling src/Lib.cc
+ Linking tests/test_Lib
+ Testing Lib
+Assertion failed: (add(1, 2) == 4), function main, file Lib.cc, line 13.
+make: *** [test] Abort trap: 6
+Unit tests with the CABIN_TEST macro are useful when testing private functions. Integration testing with the tests directory has not yet been implemented.
Linting source code is essential to protect its quality. Cabin supports linting your project by the lint command:
you:~/hello_world$ cabin lint
+ Linting hello_world
+src/main.cc:0: No copyright message found. You should have a line: "Copyright [year] <Copyright Owner>" [legal/copyright] [5]
+Done processing src/main.cc
+Total errors found: 1
+Error: `cpplint` exited with status 1
+++[!TIP] +If you do not have
+cpplint, install it with the following command:+
bash +pip install cpplint
The lint command works without configurations, and Cabin would automatically opt out of unwanted lints by adjusting to each project.
+To customize the lint settings, try adding the [lint.cpplint] key in your cabin.toml like this
+or creating a CPPLINT.cfg file in the repository root.
Cabin also supports formatting your source code with clang-format. Ensure having installed clang-format before running this command.
you:~/hello_world$ cabin fmt
+ Formatting hello_world
+++[!NOTE] +This command automatically detects what files we need to format to avoid getting bothered by commands like:
++
console +$ # We need to avoid the `build` dir and such dirs ... +$ clang-format ./src/*.cpp -i +$ clang-format ./include/**/*.hpp -i +$ clang-format ./tests/**/*.cpp -i +$ ...
To customize the format settings, try creating a .clang-format file to the repository root.
clang-tidyCabin also supports running clang-tidy on your source code. Ensure having installed clang-tidy before running this command.
you:~/hello_world$ cabin tidy
+ Running clang-tidy
+You can customize the tidy settings by creating a .clang-tidy file to the repository root.
C++ is often considered a complex language and unconsciously avoided by many. The absence of a definitive package manager and the unfamiliar syntax of build systems like CMake make it seem difficult to set up a C++ environment, leaving people hesitant.
+To simplify the process and allow users to develop applications and libraries without worrying about CMake, I created a package manager and build system with an intuitive interface, similar to Cargo. This allows developers to focus on learning C++ without any hindrances. Additionally, I aim to integrate with other build systems and package managers, providing a seamless transition between development environments.
+ +