Compare commits

..

1 Commits

Author SHA1 Message Date
Alex
4f2fd75b76
Merge baa5973128 into 4604adb502 2025-05-06 11:38:30 +03:00
11 changed files with 104 additions and 229 deletions

View File

@ -1,7 +0,0 @@
build --features=layering_check
build --enable_bzlmod
build --enable_platform_specific_config
build:linux --cxxopt=-std=c++20
build:macos --cxxopt=-std=c++20
build:windows --cxxopt=-std:c++20

View File

@ -1,36 +1,21 @@
matrix: matrix:
bazel: platform:
- 7.x - centos7
- 8.x - debian10
- rolling - ubuntu2004
unix_platform: - macos
- debian11 - windows
- ubuntu2204 bazel: [6.x, 7.x, 8.x]
- macos
- macos_arm64
win_platform:
- windows
tasks: tasks:
verify_targets:
unix_test: name: Build and test.
name: Verify build targets on Unix platform: ${{ platform }}
platform: ${{ unix_platform }}
bazel: ${{ bazel }} bazel: ${{ bazel }}
build_flags:
- --cxxopt=-std=c++20
build_targets: build_targets:
- '@ftxui//:ftxui'
- '@ftxui//:screen'
- '@ftxui//:dom' - '@ftxui//:dom'
- '@ftxui//:component' - '@ftxui//:component'
- '@ftxui//:screen' test_targets:
- '@ftxui//:tests'
windows_test:
name: Verify build targets
platform: ${{ win_platform }}
bazel: ${{ bazel }}
build_flags:
- --cxxopt=/std:c++20
build_targets:
- '@ftxui//:dom'
- '@ftxui//:component'
- '@ftxui//:screen'

View File

@ -14,30 +14,25 @@ on:
jobs: jobs:
test_bazel: test_bazel:
name: "Bazel, ${{ matrix.cxx }}, ${{ matrix.os }}" name: "Bazel, ${{ matrix.compiler }}, ${{ matrix.os }}"
strategy: strategy:
fail-fast: false fail-fast: false
matrix: matrix:
include: include:
- os: ubuntu-latest - os: ubuntu-latest
cxx: g++ compiler: gcc
cc: gcc
- os: ubuntu-latest - os: ubuntu-latest
cxx: clang++ compiler: llvm
cc: clang
- os: macos-latest - os: macos-latest
cxx: g++ compiler: llvm
cc: gcc
- os: macos-latest - os: macos-latest
cxx: clang++ compiler: gcc
cc: clang
- os: windows-latest - os: windows-latest
cxx: cl compiler: cl
cc: cl
runs-on: ${{ matrix.os }} runs-on: ${{ matrix.os }}
steps: steps:
@ -45,16 +40,10 @@ jobs:
uses: actions/checkout@v3 uses: actions/checkout@v3
- name: "Build with Bazel" - name: "Build with Bazel"
env:
CC: ${{ matrix.cc }}
CXX: ${{ matrix.cxx }}
run: bazel build ... run: bazel build ...
- name: "Tests with Bazel" - name: "Tests with Bazel"
env: run: bazel run tests
CC: ${{ matrix.cc }}
CXX: ${{ matrix.cxx }}
run: bazel test --test_output=all ...
test_cmake: test_cmake:
name: "CMake, ${{ matrix.compiler }}, ${{ matrix.os }}" name: "CMake, ${{ matrix.compiler }}, ${{ matrix.os }}"

View File

@ -12,19 +12,23 @@
load("@rules_cc//cc:defs.bzl", "cc_binary", "cc_library", "cc_test") load("@rules_cc//cc:defs.bzl", "cc_binary", "cc_library", "cc_test")
load(":bazel/ftxui.bzl", "ftxui_cc_library") load(":bazel/ftxui.bzl", "ftxui_cc_library")
load(":bazel/ftxui.bzl", "generate_examples") load(":bazel/ftxui.bzl", "generate_examples")
load(":bazel/ftxui.bzl", "cpp20")
load(":bazel/ftxui.bzl", "windows_copts") load(":bazel/ftxui.bzl", "windows_copts")
load(":bazel/ftxui.bzl", "pthread_linkopts") load(":bazel/ftxui.bzl", "pthread_linkopts")
# A meta target depending on all of the ftxui submodules. package(default_visibility = ["//visibility:public"])
# Note that component depends on dom and screen, so ftxui is just an alias for
# component.
# ┌component──┐
# │┌dom──────┐│
# ││┌screen─┐││
# └┴┴───────┴┴┘
alias(name = "ftxui", actual = ":component")
# @ftxui:screen is a module that provides a screen buffer and color management # A meta target that depends on all the ftxui sub modules.
alias(
name = "ftxui",
# Note that :component depends on :dom, which depends on :screen. Bazel
# doesn't really support "public" and "private" dependencies. They are all
# public. This is equivalent to depending on all the submodules.
actual = ":component",
visibility = ["//visibility:public"],
)
# ftxui:screen is a module that provides a screen buffer and color management
# for terminal applications. A screen is a 2D array of cells, each cell can # for terminal applications. A screen is a 2D array of cells, each cell can
# contain a glyph, a color, and other attributes. The library also provides # contain a glyph, a color, and other attributes. The library also provides
# functions to manipulate the screen. # functions to manipulate the screen.
@ -56,7 +60,7 @@ ftxui_cc_library(
], ],
) )
# @ftxui:dom is a library that provides a way to create and manipulate a # ftxui:dom is a library that provides a way to create and manipulate a
# "document" that can be rendered to a screen. The document is a tree of nodes. # "document" that can be rendered to a screen. The document is a tree of nodes.
# Nodes can be text, layouts, or various decorators. Users needs to compose # Nodes can be text, layouts, or various decorators. Users needs to compose
# nodes to create a document. A document is responsive to the size of the # nodes to create a document. A document is responsive to the size of the
@ -126,7 +130,7 @@ ftxui_cc_library(
deps = [":screen"], deps = [":screen"],
) )
# @ftxui:component is a library to create "dynamic" component renderering and # ftxui:component is a library to create "dynamic" component renderering and
# updating a ftxui::dom document on the screen. It is a higher level API than # updating a ftxui::dom document on the screen. It is a higher level API than
# ftxui:dom. # ftxui:dom.
# #
@ -163,13 +167,6 @@ ftxui_cc_library(
"src/ftxui/component/terminal_input_parser.hpp", "src/ftxui/component/terminal_input_parser.hpp",
"src/ftxui/component/util.cpp", "src/ftxui/component/util.cpp",
"src/ftxui/component/window.cpp", "src/ftxui/component/window.cpp",
# Private header from ftxui:dom.
"src/ftxui/dom/node_decorator.hpp",
# Private header from ftxui:screen.
"src/ftxui/screen/string_internal.hpp",
"src/ftxui/screen/util.hpp",
], ],
hdrs = [ hdrs = [
"include/ftxui/component/animation.hpp", "include/ftxui/component/animation.hpp",
@ -185,10 +182,7 @@ ftxui_cc_library(
"include/ftxui/component/task.hpp", "include/ftxui/component/task.hpp",
], ],
linkopts = pthread_linkopts(), linkopts = pthread_linkopts(),
deps = [ deps = [":dom"],
":dom",
":screen",
],
) )
# FTXUI's tests # FTXUI's tests
@ -211,6 +205,7 @@ cc_test(
"src/ftxui/component/resizable_split_test.cpp", "src/ftxui/component/resizable_split_test.cpp",
"src/ftxui/component/slider_test.cpp", "src/ftxui/component/slider_test.cpp",
"src/ftxui/component/terminal_input_parser_test.cpp", "src/ftxui/component/terminal_input_parser_test.cpp",
"src/ftxui/component/terminal_input_parser_test_fuzzer.cpp",
"src/ftxui/component/toggle_test.cpp", "src/ftxui/component/toggle_test.cpp",
"src/ftxui/dom/blink_test.cpp", "src/ftxui/dom/blink_test.cpp",
"src/ftxui/dom/bold_test.cpp", "src/ftxui/dom/bold_test.cpp",
@ -238,17 +233,6 @@ cc_test(
"src/ftxui/screen/string_test.cpp", "src/ftxui/screen/string_test.cpp",
"src/ftxui/util/ref_test.cpp", "src/ftxui/util/ref_test.cpp",
# Private header from ftxui:screen for string_test.cpp.
"src/ftxui/screen/string_internal.hpp",
# Private header from ftxui::component for
# terminal_input_parser_test.cpp.
"src/ftxui/component/terminal_input_parser.hpp",
# Private header from ftxui::dom for
# flexbox_helper_test.cpp.
"src/ftxui/dom/flexbox_helper.hpp",
# TODO: Enable the two tests timing out with Bazel: # TODO: Enable the two tests timing out with Bazel:
# - "src/ftxui/component/screen_interactive_test.cpp", # - "src/ftxui/component/screen_interactive_test.cpp",
# - "src/ftxui/dom/selection_test.cpp", # - "src/ftxui/dom/selection_test.cpp",
@ -257,12 +241,9 @@ cc_test(
"include", "include",
"src", "src",
], ],
copts = windows_copts(), copts = cpp20() + windows_copts(),
deps = [ deps = [
":screen", "//:ftxui",
":dom",
":component",
"@googletest//:gtest",
"@googletest//:gtest_main", "@googletest//:gtest_main",
], ],
) )

View File

@ -1,20 +1,9 @@
Changelog Changelog
========= =========
6.1.9 (2025-05-07) Future release
------------ ------------
### Build
If all goes well (pending), ftxui should appear in the Bazel central repository.
It can be imported into your project using the following lines:
**MODULE.bazel**
```bazel
bazel_dep(name = "ftxui", version = "6.1.9")
```
Thanks @robinlinden and @kcc for the reviews.
### dom ### dom
- Bugfix: Restore the `dbox` behavior from ftxui 5.0.0. To apply bgcolor - Bugfix: Restore the `dbox` behavior from ftxui 5.0.0. To apply bgcolor
blending between the two layers, a new `dboxBlend` will be added. blending between the two layers, a new `dboxBlend` will be added.
@ -25,6 +14,13 @@ Thanks @robinlinden and @kcc for the reviews.
### Build ### Build
- Feature: Support `bazel` build system. See #1032. - Feature: Support `bazel` build system. See #1032.
Proposed by Kostya Serebryany @kcc Proposed by Kostya Serebryany @kcc
If all goes well (pending), it should appear in the Bazel central repository.
It can be imported into your project using the following lines:
**MODULE.bazel**
```bazel
bazel_dep(name = "ftxui", version = "6.1.8")
```
**BUILD.bazel** **BUILD.bazel**
```bazel ```bazel

View File

@ -2,7 +2,7 @@ cmake_minimum_required(VERSION 3.12)
project(ftxui project(ftxui
LANGUAGES CXX LANGUAGES CXX
VERSION 6.1.9 VERSION 6.1.8
DESCRIPTION "C++ Functional Terminal User Interface." DESCRIPTION "C++ Functional Terminal User Interface."
) )

View File

@ -1,13 +1,9 @@
# FTXUI module. # FTXUI Module.
module( module(name = "ftxui", version = "6.1.8", compatibility_level = 6)
name = "ftxui",
version = "6.1.9",
compatibility_level = 6,
)
# Build dependencies. # Build deps.
bazel_dep(name = "rules_cc", version = "0.1.1") bazel_dep(name = "rules_cc", version = "0.1.1")
bazel_dep(name = "platforms", version = "0.0.10") bazel_dep(name = "platforms", version = "0.0.11")
# Test dependencies. # Test deps.
bazel_dep(name = "googletest", version = "1.14.0.bcr.1", dev_dependency = True) bazel_dep(name = "googletest", version = "1.16.0.bcr.1")

View File

@ -42,24 +42,15 @@ A simple cross-platform C++ library for terminal based user interfaces!
* No dependencies * No dependencies
* **Cross platform**: Linux/MacOS (main target), WebAssembly, Windows (Thanks to contributors!). * **Cross platform**: Linux/MacOS (main target), WebAssembly, Windows (Thanks to contributors!).
* Learn by [examples](#documentation), and [tutorials](#documentation) * Learn by [examples](#documentation), and [tutorials](#documentation)
* Multiple packages: * Multiple packages: CMake [FetchContent]([https://bewagner.net/programming/2020/05/02/cmake-fetchcontent/](https://cmake.org/cmake/help/latest/module/FetchContent.html)) (preferred),Bazel, vcpkg, pkgbuild, conan.
- CMake [FetchContent]([https://bewagner.net/programming/2020/05/02/cmake-fetchcontent/](https://cmake.org/cmake/help/latest/module/FetchContent.html)) (preferred)
- [Bazel](https://registry.bazel.build/modules/ftxui)
- [vcpkg](https://vcpkg.link/ports/ftxui)
- [Conan](https://conan.io/center/recipes/ftxui) [Debian package](https://tracker.debian.org/pkg/ftxui)
- [Ubuntu package](https://launchpad.net/ubuntu/+source/ftxui)
- [Arch Linux](https://aur.archlinux.org/packages/ftxui/)
- [OpenSUSE](https://build.opensuse.org/package/show/devel:libraries:c_c++/ftxui)
* Good practices: documentation, tests, fuzzers, performance tests, automated CI, automated packaging, etc... * Good practices: documentation, tests, fuzzers, performance tests, automated CI, automated packaging, etc...
## Documentation ## Documentation
- [Starter CMake](https://github.com/ArthurSonzogni/ftxui-starter) - [Starter example project](https://github.com/ArthurSonzogni/ftxui-starter)
- [Starter Bazel](https://github.com/ArthurSonzogni/ftxui-bazel)
- [Documentation](https://arthursonzogni.github.io/FTXUI/) - [Documentation](https://arthursonzogni.github.io/FTXUI/)
- [Examples (WebAssembly)](https://arthursonzogni.github.io/FTXUI/examples/) - [Examples (WebAssembly)](https://arthursonzogni.github.io/FTXUI/examples/)
- [Build using CMake](https://arthursonzogni.github.io/FTXUI/#build-cmake) - [Build using CMake](https://arthursonzogni.github.io/FTXUI/#build-cmake)
- [Build using Bazel](https://arthursonzogni.github.io/FTXUI/#build-bazel)
## Example ## Example
~~~cpp ~~~cpp
@ -374,62 +365,33 @@ Several games using the FTXUI have been made during the Game Jam:
- [smoothlife](https://github.com/cpp-best-practices/game_jam/blob/main/Jam1_April_2022/smoothlife.md) - [smoothlife](https://github.com/cpp-best-practices/game_jam/blob/main/Jam1_April_2022/smoothlife.md)
- [Consu](https://github.com/cpp-best-practices/game_jam/blob/main/Jam1_April_2022/consu.md) - [Consu](https://github.com/cpp-best-practices/game_jam/blob/main/Jam1_April_2022/consu.md)
## Build using CMake ## Utilization
It is **highly** recommended to use CMake FetchContent to depend on FTXUI so you may specify which commit you would like to depend on. It is **highly** recommended to use CMake FetchContent to depend on FTXUI so you may specify which commit you would like to depend on.
```cmake ```cmake
include(FetchContent) include(FetchContent)
FetchContent_Declare(ftxui FetchContent_Declare(ftxui
GIT_REPOSITORY https://github.com/ArthurSonzogni/ftxui GIT_REPOSITORY https://github.com/ArthurSonzogni/ftxui
GIT_TAG v6.1.9 GIT_TAG v6.1.8
) )
FetchContent_MakeAvailable(ftxui)
target_link_libraries(your_target PRIVATE FetchContent_GetProperties(ftxui)
# Chose a submodule if(NOT ftxui_POPULATED)
ftxui::component FetchContent_Populate(ftxui)
ftxui::dom add_subdirectory(${ftxui_SOURCE_DIR} ${ftxui_BINARY_DIR} EXCLUDE_FROM_ALL)
ftxui::screen endif()
)
``` ```
# Build using Bazel
**MODULE.bazel**
```starlark
bazel_dep(
name = "ftxui",
version = "v6.1.9",
)
```
**BUILD.bazel**
```starlark
cc_binary(
name = "your_target",
srcs = ["your_source.cc"],
deps = [
"@ftxui//:ftxui_component",
"@ftxui//:ftxui_dom",
"@ftxui//:ftxui_screen",
],
)
```
# Build with something else:
If you don't, FTXUI may be used from the following packages: If you don't, FTXUI may be used from the following packages:
- CMake [FetchContent]([https://bewagner.net/programming/2020/05/02/cmake-fetchcontent/](https://cmake.org/cmake/help/latest/module/FetchContent.html)) (preferred), - [bazel](...)
- [Bazel](https://registry.bazel.build/modules/ftxui), - [vcpkg](https://vcpkgx.com/details.html?package=ftxui)
- [vcpkg](https://vcpkg.link/ports/ftxui), - [Arch Linux PKGBUILD](https://aur.archlinux.org/packages/ftxui-git/).
- [Conan](https://conan.io/center/recipes/ftxui) - [conan.io](https://conan.io/center/ftxui)
- [Debian package](https://tracker.debian.org/pkg/ftxui), - [openSUSE](https://build.opensuse.org/package/show/devel:libraries:c_c++/ftxui)
- [Ubuntu package](https://launchpad.net/ubuntu/+source/ftxui), -
- [Arch Linux](https://aur.archlinux.org/packages/ftxui/),
- [OpenSUSE](https://build.opensuse.org/package/show/devel:libraries:c_c++/ftxui),
[![Packaging status](https://repology.org/badge/vertical-allrepos/libftxui.svg)](https://repology.org/project/libftxui/versions) [![Packaging status](https://repology.org/badge/vertical-allrepos/libftxui.svg)](https://repology.org/project/libftxui/versions)
If you choose to build and link FTXUI yourself, `ftxui-component` must be first in the linking order relative to the other FTXUI libraries, i.e. If you choose to build and link FTXUI yourself, `ftxui-component` must be first in the linking order relative to the other FTXUI libraries, i.e.
```bash ```bash
g++ . . . -lftxui-component -lftxui-dom -lftxui-screen . . . g++ . . . -lftxui-component -lftxui-dom -lftxui-screen . . .

View File

@ -1,7 +1,24 @@
# ftxui_common.bzl # ftxui_common.bzl
load("@rules_cc//cc:defs.bzl", "cc_library") load("@rules_cc//cc:defs.bzl", "cc_library")
load("@rules_cc//cc:defs.bzl", "cc_binary")
def cpp17():
return select({
"@rules_cc//cc/compiler:msvc-cl": ["/std:c++17"],
"@rules_cc//cc/compiler:clang-cl": ["/std:c++17"],
"@rules_cc//cc/compiler:clang": ["-std=c++17"],
"@rules_cc//cc/compiler:gcc": ["-std=c++17"],
"//conditions:default": ["-std=c++17"],
})
def cpp20():
return select({
"@rules_cc//cc/compiler:msvc-cl": ["/std:c++20"],
"@rules_cc//cc/compiler:clang-cl": ["/std:c++20"],
"@rules_cc//cc/compiler:clang": ["-std=c++20"],
"@rules_cc//cc/compiler:gcc": ["-std=c++20"],
"//conditions:default": ["-std=c++20"],
})
# Microsoft terminal is a bit buggy ¯\_(ツ)_/¯ and MSVC uses bad defaults. # Microsoft terminal is a bit buggy ¯\_(ツ)_/¯ and MSVC uses bad defaults.
def windows_copts(): def windows_copts():
@ -28,8 +45,7 @@ def windows_copts():
# This # This
# - Replace missing font symbols by others. # - Replace missing font symbols by others.
# - Reduce screen position pooling frequency to deals against a Microsoft # - Reduce screen position pooling frequency to deals against a Microsoft
# race condition. This was fixed in 2020, but clients are still using # race condition. This was fixed in 2020, but clients never not updated.
# old versions.
# - https://github.com/microsoft/terminal/pull/7583 # - https://github.com/microsoft/terminal/pull/7583
# - https://github.com/ArthurSonzogni/FTXUI/issues/136 # - https://github.com/ArthurSonzogni/FTXUI/issues/136
"-DFTXUI_MICROSOFT_TERMINAL_FALLBACK", "-DFTXUI_MICROSOFT_TERMINAL_FALLBACK",
@ -55,8 +71,8 @@ def pthread_linkopts():
def ftxui_cc_library( def ftxui_cc_library(
name, name,
srcs = [], srcs,
hdrs = [], hdrs,
linkopts = [], linkopts = [],
deps = []): deps = []):
@ -72,13 +88,12 @@ def ftxui_cc_library(
"include", "include",
"src", "src",
], ],
copts = windows_copts(), copts = cpp17() + windows_copts(),
visibility = ["//visibility:public"], visibility = ["//visibility:public"],
) )
# Compile all the examples in the examples/ directory. # Compile all the examples in the examples/ directory.
# This is useful to check the Bazel is always synchronized against CMake # This is useful to check the Bazel is synchronized with CMake definitions.
# definitions.
def generate_examples(): def generate_examples():
cpp_files = native.glob(["examples/**/*.cpp"]) cpp_files = native.glob(["examples/**/*.cpp"])
@ -92,13 +107,9 @@ def generate_examples():
# Turn "examples/component/button.cpp" → "example_component_button" # Turn "examples/component/button.cpp" → "example_component_button"
name = src.replace("/", "_").replace(".cpp", "") name = src.replace("/", "_").replace(".cpp", "")
cc_binary( native.cc_binary(
name = name, name = name,
srcs = [src], srcs = [src],
deps = [ deps = ["//:component"],
":component", copts = cpp20() + windows_copts(),
":dom",
":screen",
],
copts = windows_copts(),
) )

View File

@ -81,7 +81,7 @@ include(FetchContent)
set(FETCHCONTENT_UPDATES_DISCONNECTED TRUE) set(FETCHCONTENT_UPDATES_DISCONNECTED TRUE)
FetchContent_Declare(ftxui FetchContent_Declare(ftxui
GIT_REPOSITORY https://github.com/ArthurSonzogni/ftxui GIT_REPOSITORY https://github.com/ArthurSonzogni/ftxui
GIT_TAG 6.1.9 GIT_TAG main # Important: Specify a version or a commit hash here.
) )
FetchContent_MakeAvailable(ftxui) FetchContent_MakeAvailable(ftxui)
@ -94,33 +94,13 @@ target_link_libraries(ftxui-starter
) )
``` ```
### Using Bazel {#build-bazel} ## Build
See [ftxui module](https://registry.bazel.build/modules/ftxui) from the Bazel ```bash
Central Registry. mkdir build && cd build
cmake ..
See also this [starter](https://github.com/ArthurSonzogni/ftxui-bazel) project. make
./main
**Module.bazel**
```starlark
bazel_dep(
name = "ftxui",
version = "6.1.9",
)
```
**BUILD.bazel**
```starlark
cc_binary(
name = "main",
srcs = ["main.cpp"],
deps = [
# Choose one of the following:
"@ftxui//:dom",
"@ftxui//:screen",
"@ftxui//:component",
],
)
``` ```
# List of modules. {#modules} # List of modules. {#modules}

View File

@ -1,18 +0,0 @@
# This script tests the project with different versions of Bazel and compilers
# locally. This avoids waiting on the CI to run the tests.
for ver in \
"6.0.0" \
"7.0.0" \
"8.0.0"
do
for cc in \
"gcc" \
"clang"
do
echo "=== Testing with Bazel ${ver} with ${cc} ==="
USE_BAZEL_VERSION=${ver} CC=${cc} bazel clean --expunge
USE_BAZEL_VERSION=${ver} CC=${cc} bazel build //...
USE_BAZEL_VERSION=${ver} CC=${cc} bazel test //...
done
done