994915dbb9
* Add the umbrella module ftxui to the cmake module build. * Update cpp20 modules documentation.
2.9 KiB
@page cpp20-modules C++20 Modules
Warning
This feature is still in development, and the API may change in future releases. Your contribution is needed to help us improve the compatibility and usability of C++20 modules in FTXUI. If you encounter any issues or have suggestions, please open an issue.
FTXUI experimentally supports C++20 modules to reduce compilation times and improve code organization. Each header has a corresponding module.
Use the FTXUI_BUILD_MODULES option to build the FTXUI project itself to provide C++ 20 modules, for example with CMake and Ninja:
cmake \
-DCMAKE_GENERATOR=Ninja \
-DFTXUI_BUILD_MODULES=ON \
..
ninja
Note
To use modules, you need a C++20 compatible compiler, CMake version 3.20 or higher, and use a compatible generator like Ninja. Note that Makefile generators do not support modules.
Then, in your own code you can consume the modules and code as normal:
import ftxui;
int main() {
auto screen = ftxui::ScreenInteractive::TerminalOutput();
auto button = ftxui::Button("Click me", screen.QuitClosure());
screen.Loop(button);
return 0;
}
Note, the ftxui convenience module which simply pulls together all the modules:
export import ftxui.component;
export import ftxui.dom;
export import ftxui.screen;
export import ftxui.util;
You can instead import only the module(s) you need if desired.
To properly find and link the modules with CMake, use target_link_libraries to get the right
compiler, linker, etc. flags.
target_link_libraries(my_executable
#...whatever...
PRIVATE ftxui::modules
)
Module list
The modules directly reference the corresponding header, or a group of related headers to provide a more convenient interface. The following modules are available:
ftxuiftxui.componentftxui.component.Animationftxui.component.CapturedMouseftxui.component.Componentftxui.component.ComponentBaseftxui.component.ComponentOptionsftxui.component.Eventftxui.component.Loopftxui.component.Mouseftxui.component.Receiverftxui.component.ScreenInteractiveftxui.component.Task
ftxui.domftxui.dom.Canvasftxui.dom.Deprecatedftxui.dom.Directionftxui.dom.Elementsftxui.dom.FlexboxConfigftxui.dom.LinearGradientftxui.dom.Nodeftxui.dom.Requirementftxui.dom.Selectionftxui.dom.Table
ftxui.screenftxui.screen.Boxftxui.screen.Colorftxui.screen.ColorInfoftxui.screen.Deprecatedftxui.screen.Imageftxui.screen.Pixelftxui.screen.Screenftxui.screen.Stringftxui.screen.Terminal
ftxui.utilftxui.util.AutoResetftxui.util.Ref