Export internal symbols for shared library builds (#1283)

These symbols are internal to FTXUI (located in src/), but they must be
exported when building as shared libraries because of internal
dependencies between the screen, dom, and component libraries.

- SCREEN symbols in string_internal.hpp are used by COMPONENT.
- DOM symbols in node_decorator.hpp are used by COMPONENT.

Also:
- Bump minor version to 6.2.0 due to ABI changes.
- Update tools/abi_fingerprint.txt.
- Fix Meson build for Windows and shared library mode by setting
  necessary export definitions.

Author: ArthurSonzogni

.github/workflows/shared_lib_build.yaml

@@ -0,0 +1,31 @@
+name: Shared Library Build
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  build-shared:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Configure CMake
+        env:
+          CC: clang
+          CXX: clang++
+        run: |
+          cmake -B build \
+            -DBUILD_SHARED_LIBS=ON \
+            -DFTXUI_BUILD_EXAMPLES=ON \
+            -DFTXUI_BUILD_TESTS=OFF \
+            -DFTXUI_BUILD_DOCS=OFF
+
+      - name: Build one example
+        run: |
+          cmake --build build --target ftxui_example_text

CMakeLists.txt

@@ -15,10 +15,9 @@ if (FTXUI_BUILD_MODULES)
 else()
   cmake_minimum_required(VERSION 3.12)
 endif()
-
 project(ftxui
   LANGUAGES CXX
-  VERSION 6.1.9
+  VERSION 6.2.0
   DESCRIPTION "C++ Functional Terminal User Interface."
 )
 

meson.build

@@ -1,5 +1,5 @@
 project('ftxui', 'cpp',
-  version: run_command('python3', '-c', 'import re; print(re.search(r"project\(ftxui\s+.*?VERSION\s+([0-9.]+)", open("CMakeLists.txt").read(), re.DOTALL).group(1))', check: true).stdout().strip(),
+  version: run_command(import('python').find_installation(), '-c', 'import re; print(re.search(r"project\(ftxui\s+.*?VERSION\s+([0-9.]+)", open("CMakeLists.txt").read(), re.DOTALL).group(1))', check: true).stdout().strip(),
   license: 'MIT',
   default_options: [
     'cpp_std=c++17',
@@ -27,6 +27,12 @@ ftxui_build_tests = get_option('tests')
 ftxui_public_inc = include_directories('include')
 ftxui_private_inc = include_directories('src', 'include')
 
+# Export definitions for shared libraries
+ftxui_args = []
+if get_option('default_library') != 'static'
+  ftxui_args += '-DCOMPONENT_BUILD'
+endif
+
 # Subdirectories for sources
 subdir('src/ftxui/screen')
 subdir('src/ftxui/dom')
@@ -36,6 +42,7 @@ subdir('src/ftxui/component')
 ftxui_screen = library('ftxui-screen',
   screen_sources,
   include_directories: ftxui_private_inc,
+  cpp_args: ftxui_args + ['-DIS_FTXUI_SCREEN_IMPL=1'],
   install: true,
 )
 
@@ -48,6 +55,7 @@ ftxui_screen_dep = declare_dependency(
 ftxui_dom = library('ftxui-dom',
   dom_sources,
   include_directories: ftxui_private_inc,
+  cpp_args: ftxui_args + ['-DIS_FTXUI_DOM_IMPL=1'],
   link_with: ftxui_screen,
   install: true,
 )
@@ -61,6 +69,7 @@ ftxui_dom_dep = declare_dependency(
 ftxui_component = library('ftxui-component',
   component_sources,
   include_directories: ftxui_private_inc,
+  cpp_args: ftxui_args + ['-DIS_FTXUI_COMPONENT_IMPL=1'],
   link_with: [ftxui_dom, ftxui_screen],
   install: true,
 )

src/ftxui/dom/node_decorator.hpp

@@ -8,12 +8,14 @@
 
 #include "ftxui/dom/elements.hpp"  // for Element, unpack
 #include "ftxui/dom/node.hpp"      // for Node
+#include "ftxui/util/export.hpp"   // for FTXUI_EXPORT
 
 namespace ftxui {
 struct Box;
 
 // Helper class.
-class NodeDecorator : public Node {
+// Internal class exported for the 'component' library.
+class FTXUI_EXPORT(DOM) NodeDecorator : public Node {
  public:
   explicit NodeDecorator(Element child) : Node(unpack(std::move(child))) {}
   void ComputeRequirement() override;

src/ftxui/screen/string_internal.hpp

@@ -8,30 +8,36 @@
 #include <string>
 #include <vector>
 
+#include "ftxui/util/export.hpp"
+
 namespace ftxui {
 
+// Internal functions exported for the 'component' library.
+FTXUI_EXPORT(SCREEN)
 bool EatCodePoint(std::string_view input,
                   size_t start,
                   size_t* end,
                   uint32_t* ucs);
+FTXUI_EXPORT(SCREEN)
 bool EatCodePoint(std::wstring_view input,
                   size_t start,
                   size_t* end,
                   uint32_t* ucs);
 
-bool IsCombining(uint32_t ucs);
-bool IsFullWidth(uint32_t ucs);
-bool IsControl(uint32_t ucs);
+FTXUI_EXPORT(SCREEN) bool IsCombining(uint32_t ucs);
+FTXUI_EXPORT(SCREEN) bool IsFullWidth(uint32_t ucs);
+FTXUI_EXPORT(SCREEN) bool IsControl(uint32_t ucs);
 
-size_t GlyphPrevious(std::string_view input, size_t start);
-size_t GlyphNext(std::string_view input, size_t start);
+FTXUI_EXPORT(SCREEN) size_t GlyphPrevious(std::string_view input, size_t start);
+FTXUI_EXPORT(SCREEN) size_t GlyphNext(std::string_view input, size_t start);
 
 // Return the index in the |input| string of the glyph at |glyph_offset|,
 // starting at |start|
+FTXUI_EXPORT(SCREEN)
 size_t GlyphIterate(std::string_view input, int glyph_offset, size_t start = 0);
 
 // Returns the number of glyphs in |input|.
-int GlyphCount(std::string_view input);
+FTXUI_EXPORT(SCREEN) int GlyphCount(std::string_view input);
 
 // Properties from:
 // https://www.unicode.org/Public/UCD/latest/ucd/auxiliary/WordBreakProperty.txt
@@ -55,9 +61,12 @@ enum class WordBreakProperty : int8_t {
   WSegSpace,
   ZWJ,
 };
+FTXUI_EXPORT(SCREEN)
 WordBreakProperty CodepointToWordBreakProperty(uint32_t codepoint);
+FTXUI_EXPORT(SCREEN)
 std::vector<WordBreakProperty> Utf8ToWordBreakProperty(std::string_view input);
 
+FTXUI_EXPORT(SCREEN)
 bool IsWordBreakingCharacter(std::string_view input, size_t glyph_index);
 }  // namespace ftxui
 

tools/abi_fingerprint.txt

@@ -1 +1 @@
-396e5a0e8a1982216fe0c4caadecddd7e19ad609aaff274c118c87d385978fad
+62348ac12fb57551cd70e9ef4d96c7418976591f5963ef5d98702eda511ab08b