Port xetex_layout to Rust (#1138)

Author: CraftSpider

.github/actions/build-and-test/action.yml

@@ -52,11 +52,11 @@ runs:
     - name: "cargo build for ${{ inputs.target }}"
       shell: bash
       run: |
-        ${{ inputs.executable }} build --all --target ${{ inputs.target }} --release ${{ steps.set-feature-flags.outputs.cargo-features }} $CARGO_VERBOSE
+        ${{ inputs.executable }} build --workspace --target ${{ inputs.target }} --release ${{ steps.set-feature-flags.outputs.cargo-features }} $CARGO_VERBOSE
     - name: "cargo test"
       shell: bash
       run: |
-        ${{ inputs.executable }} test --all --target ${{ inputs.target }} ${{ inputs.test-flags }} --release ${{ steps.set-feature-flags.outputs.cargo-features }} $CARGO_VERBOSE
+        ${{ inputs.executable }} test --workspace --target ${{ inputs.target }} ${{ inputs.test-flags }} --release ${{ steps.set-feature-flags.outputs.cargo-features }} $CARGO_VERBOSE
     - name: "Package test failure files"
       id: package-tests
       if: ${{ failure() }}

.github/workflows/build_and_test.yml

@@ -1,6 +1,6 @@
 name: "Build and Test"
 
-on: [workflow_call]
+on: [ workflow_call ]
 
 jobs:
   clippy:
@@ -68,12 +68,12 @@ jobs:
         run: |
           artifact_dir="appimage"
           mkdir -p "$artifact_dir"
-  
+          
           if [[ $SOURCE_BRANCH == master ]] ; then
             export TECTONIC_APPIMAGE_TAG=continuous
             export UPDATE_INFORMATION="gh-releases-zsync|tectonic-typesetting|tectonic|continuous|tectonic-*.AppImage.zsync"
           fi
-  
+          
           ./dist/appimage/build.sh
           cp dist/appimage/tectonic-*.AppImage* "$artifact_dir"
         env:
@@ -141,7 +141,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        toolchain: ["beta", "nightly"]
+        toolchain: [ "beta", "nightly" ]
       fail-fast: false
     steps:
       - name: Checkout repository
@@ -166,7 +166,7 @@ jobs:
   linux-feature-tests:
     strategy:
       matrix:
-        features: ["_all_", "_none_", "geturl-curl serialization"]
+        features: [ "_all_", "_none_", "geturl-curl serialization" ]
       fail-fast: false
     runs-on: ubuntu-latest
     steps:
@@ -193,8 +193,8 @@ jobs:
   pkg-config:
     strategy:
       matrix:
-        image: [ubuntu-latest, windows-latest, macos-latest]
-        install-all-deps: [true, false]
+        image: [ ubuntu-latest, windows-latest, macos-latest ]
+        install-all-deps: [ true, false ]
         include:
           # By default, all items have toolchain: stable, and don't publish
           - toolchain: stable
@@ -327,12 +327,13 @@ jobs:
           echo "CROSS_ROOTLESS_CONTAINER_ENGINE=1" >> "$GITHUB_ENV"
           echo "DOCKER_OPTS=--privileged -e HOST_UID=${HOST_UID} -e HOST_GID=${HOST_GID}" >> "$GITHUB_ENV"
       # TODO: Add font files to the cross images so we can include fontconfig_bridge in tests
+      # TODO: Figure out why doctests are broken so we can drop all-targets
       - name: "Build and Test"
         uses: ./.github/actions/build-and-test
         with:
           target: ${{ matrix.target }}
           publish: 'true'
           executable: 'cross'
-          test-flags: '--exclude tectonic_bridge_fontconfig'
+          test-flags: '--all-targets --exclude tectonic_bridge_fontconfig'
           package-flags: '--command-name=cross --reroot=.'
 

Cargo.lock

@@ -194,6 +194,8 @@ impl<T: IoProvider> DriverHooks for MinimalDriver<T> {
 // Function defined in the C support code:
 extern "C" {
     fn _ttbc_get_error_message() -> *const libc::c_char;
+    #[allow(improper_ctypes)]
+    fn _ttbc_get_core_state() -> *mut CoreBridgeState<'static>;
 }
 
 lazy_static::lazy_static! {
@@ -377,6 +379,18 @@ impl<'a> CoreBridgeState<'a> {
         }
     }
 
+    /// Get the current global bridge state. Uses a mutex to ensure unique access, and panics
+    /// if no global state is set.
+    pub fn with_global_state<T, F: for<'b> FnOnce(&mut CoreBridgeState<'b>) -> T>(f: F) -> T {
+        /// Ensures we only enter the state once at a time, globally
+        static GLOBAL: Mutex<()> = Mutex::new(());
+        let _lock = GLOBAL.lock().unwrap();
+        // SAFETY: Pointer is either null or valid, set by the engine on entrance
+        let state = unsafe { _ttbc_get_core_state().as_mut() }
+            .expect("Currently within an engine context in C");
+        f(state)
+    }
+
     fn input_open_name_format(
         &mut self,
         name: &str,
@@ -637,7 +651,8 @@ impl<'a> CoreBridgeState<'a> {
         InputId::new(self.input_handles.len())
     }
 
-    fn input_get_size(&mut self, handle: InputId) -> usize {
+    /// Get the size of an input. Prints a warning and returns 0 on error
+    pub fn input_get_size(&mut self, handle: InputId) -> usize {
         let rhandle: &mut InputHandle = self.get_input(handle);
 
         match rhandle.get_size() {
@@ -671,7 +686,8 @@ impl<'a> CoreBridgeState<'a> {
         rhandle.try_seek(pos)
     }
 
-    fn input_read(&mut self, handle: InputId, buf: &mut [u8]) -> Result<()> {
+    /// Read from an input
+    pub fn input_read(&mut self, handle: InputId, buf: &mut [u8]) -> Result<()> {
         let rhandle: &mut InputHandle = self.get_input(handle);
         rhandle.read_exact(buf).map_err(Error::from)
     }

crates/bridge_core/src/lib.rs

@@ -113,6 +113,13 @@ _ttbc_get_error_message(void)
 }
 
 
+ttbc_state_t *
+_ttbc_get_core_state(void)
+{
+	return tectonic_global_bridge_core;
+}
+
+
 jmp_buf *
 ttbc_global_engine_enter(ttbc_state_t *api)
 {

crates/bridge_core/support/support.c

@@ -23,9 +23,11 @@ links = "tectonic_engine_xetex"
 [dependencies]
 libc = "^0.2"
 tectonic_bridge_core = { path = "../bridge_core", version = "0.0.0-dev.0" }
+tectonic_bridge_freetype2 = { path = "../bridge_freetype2", version = "0.0.0-dev.0" }
 tectonic_bridge_flate = { path = "../bridge_flate", version = "0.0.0-dev.0" }
 tectonic_bridge_graphite2 = { path = "../bridge_graphite2", version = "0.0.0-dev.0" }
 tectonic_bridge_harfbuzz = { path = "../bridge_harfbuzz", version = "0.0.0-dev.0" }
+tectonic_bridge_icu = { path = "../bridge_icu", version = "0.0.0-dev.0" }
 tectonic_errors = { path = "../errors", version = "0.0.0-dev.0" }
 tectonic_pdf_io = { path = "../pdf_io", version = "0.0.0-dev.0" }
 tectonic_xetex_layout = { path = "../xetex_layout", version = "0.0.0-dev.0" }
@@ -42,9 +44,11 @@ external-harfbuzz = [
 
 [package.metadata.internal_dep_versions]
 tectonic_bridge_core = "4e16bf963700aae59772a6fb223981ceaa9b5f57"
+tectonic_bridge_freetype2 = "fe112797308ca8aa0478cd31851ab75bc5afd43c"
 tectonic_bridge_flate = "5933308152efb6ba206b4dc01ab6814063b835c0"
 tectonic_bridge_graphite2 = "2c1ffcd702a662c003bd3d7d0ca4d169784cb6ad"
 tectonic_bridge_harfbuzz = "2c1ffcd702a662c003bd3d7d0ca4d169784cb6ad"
+tectonic_bridge_icu = "thiscommit:2023-09-17:6uIZ4lA"
 tectonic_cfg_support = "9d5feb40c7ac6958ee3c50604af9271eb2db2b20"
 tectonic_errors = "317ae79ceaa2593fb56090e37bf1f5cc24213dd9"
 tectonic_pdf_io = "9a8b975e76c7a27f140d0974ec3442f2347e18ad"

crates/engine_xetex/Cargo.toml

@@ -18,7 +18,10 @@ fn main() {
     let flate_include_dir = env::var("DEP_TECTONIC_BRIDGE_FLATE_INCLUDE").unwrap();
     let graphite2_include_path = env::var("DEP_GRAPHITE2_INCLUDE_PATH").unwrap();
     let graphite2_static = !env::var("DEP_GRAPHITE2_DEFINE_STATIC").unwrap().is_empty();
+    let freetype_include_path = env::var("DEP_FREETYPE2_INCLUDE_PATH").unwrap();
     let harfbuzz_include_path = env::var("DEP_HARFBUZZ_INCLUDE_PATH").unwrap();
+    let fontconfig_include_path = env::var("DEP_FONTCONFIG_INCLUDE_PATH");
+    let icu_include_path = env::var("DEP_ICUUC_INCLUDE_PATH").unwrap();
 
     // If we want to profile, the default assumption is that we must force the
     // compiler to include frame pointers. We whitelist platforms that are
@@ -76,11 +79,28 @@ fn main() {
         cxx_cfg.include(item);
     }
 
+    for item in freetype_include_path.split(';') {
+        c_cfg.include(item);
+        cxx_cfg.include(item);
+    }
+
     for item in graphite2_include_path.split(';') {
         c_cfg.include(item);
         cxx_cfg.include(item);
     }
 
+    for item in icu_include_path.split(';') {
+        c_cfg.include(item);
+        cxx_cfg.include(item);
+    }
+
+    if let Ok(fc_includes) = fontconfig_include_path {
+        for item in fc_includes.split(';') {
+            c_cfg.include(item);
+            cxx_cfg.include(item);
+        }
+    }
+
     if graphite2_static {
         c_cfg.define("GRAPHITE2_STATIC", "1");
         cxx_cfg.define("GRAPHITE2_STATIC", "1");

crates/engine_xetex/build.rs

@@ -256,6 +256,9 @@ mod linkage {
 
     #[allow(unused_imports)]
     use tectonic_xetex_layout as clipyrenamehack2;
+
+    #[allow(unused_imports)]
+    use tectonic_bridge_icu as clipyrenamehack3;
 }
 
 /// Does our resulting executable link correctly?