Merge pull request #899 from matz-e/better-external-tool-errors

Augment error message when opening files for external tools

Author: pkgw

Cargo.lock

@@ -14,6 +14,8 @@
 //!
 //! [cbindgen]: https://github.com/eqrion/cbindgen
 //!
+//! If you change the interfaces here, rerun cbindgen as described in the README!
+//!
 //! In order to provide access to a C/C++ engine in Rust, you should create some
 //! kind of interface that expects to be given a reference to a
 //! [`CoreBridgeLauncher`] struct. You should use that struct's
@@ -589,7 +591,7 @@ impl<'a> CoreBridgeState<'a> {
         }
     }
 
-    fn input_get_mtime(&mut self, handle: *mut InputHandle) -> libc::time_t {
+    fn input_get_mtime(&mut self, handle: *mut InputHandle) -> i64 {
         let rhandle: &mut InputHandle = unsafe { &mut *handle };
 
         let maybe_time = match rhandle.get_unix_mtime() {
@@ -601,7 +603,7 @@ impl<'a> CoreBridgeState<'a> {
         };
 
         if let Some(t) = maybe_time {
-            t as libc::time_t
+            t
         } else {
             1 // Intentionally make this distinguishable from the error value 0
         }
@@ -1020,10 +1022,7 @@ pub extern "C" fn ttbc_input_get_size(
 
 /// Get the modification time of a Tectonic input file.
 #[no_mangle]
-pub extern "C" fn ttbc_input_get_mtime(
-    es: &mut CoreBridgeState,
-    handle: *mut InputHandle,
-) -> libc::time_t {
+pub extern "C" fn ttbc_input_get_mtime(es: &mut CoreBridgeState, handle: *mut InputHandle) -> i64 {
     es.input_get_mtime(handle)
 }
 

crates/bridge_core/src/lib.rs

@@ -254,7 +254,12 @@ ttstub_input_get_size(rust_input_handle_t handle)
 time_t
 ttstub_input_get_mtime(rust_input_handle_t handle)
 {
-    return ttbc_input_get_mtime(tectonic_global_bridge_core, handle);
+    /* Due to the Musl 1.2 "time64" transition, we can't safely bridge time_t
+     * between Rust and C code. And formally, ISO C provides nearly no
+     * guarantees about what the type time_t actually is. So let's just cast and
+     * hope for the best. */
+    int64_t ti = ttbc_input_get_mtime(tectonic_global_bridge_core, handle);
+    return (time_t) ti;
 }
 
 

crates/bridge_core/support/support.c

@@ -262,7 +262,7 @@ size_t ttbc_input_get_size(ttbc_state_t *es, ttbc_input_handle_t *handle);
 /**
  * Get the modification time of a Tectonic input file.
  */
-time_t ttbc_input_get_mtime(ttbc_state_t *es, ttbc_input_handle_t *handle);
+int64_t ttbc_input_get_mtime(ttbc_state_t *es, ttbc_input_handle_t *handle);
 
 /**
  * Seek in a Tectonic input stream.

crates/bridge_core/support/tectonic_bridge_core_generated.h

@@ -6,6 +6,8 @@
 //! This crate provides a few extern "C" functions that expose the functionality
 //! of the flate2 crate in a C API that can be consumed by other C/C++ code in
 //! the Tectonic codebase.
+//!
+//! If you change the interfaces here, rerun cbindgen as described in the README!
 
 use flate2::{Compress, Compression, Decompress, FlushCompress, FlushDecompress, Status};
 use std::{

crates/bridge_flate/src/lib.rs

@@ -16,6 +16,8 @@
 //!
 //! [Tectonic]: https://tectonic-typesetting.github.io/
 //! [`tectonic`]: https://docs.rs/tectonic/
+//!
+//! If you change the interfaces here, rerun cbindgen as described in the README!
 
 use std::ffi::CString;
 use tectonic_bridge_core::{CoreBridgeLauncher, EngineAbortedError};

crates/engine_bibtex/src/lib.rs

@@ -124,7 +124,7 @@ impl XdvipdfmxEngine {
                 .build_date
                 .duration_since(SystemTime::UNIX_EPOCH)
                 .expect("invalid build date")
-                .as_secs() as libc::time_t,
+                .as_secs(),
         };
 
         let cdvi = CString::new(dvi)?;
@@ -147,6 +147,8 @@ impl XdvipdfmxEngine {
 
 #[doc(hidden)]
 pub mod c_api {
+    // If you change the interfaces here, rerun cbindgen as described in the README!
+
     use tectonic_bridge_core::CoreBridgeState;
 
     #[derive(Debug)]
@@ -155,7 +157,7 @@ pub mod c_api {
         pub paperspec: *const libc::c_char,
         pub enable_compression: libc::c_uchar,
         pub deterministic_tags: libc::c_uchar,
-        pub build_date: libc::time_t,
+        pub build_date: u64,
     }
 
     #[allow(improper_ctypes)] // for CoreBridgeState

crates/engine_xdvipdfmx/src/lib.rs

@@ -499,6 +499,9 @@ tt_engine_xdvipdfmx_main(
     return 99;
   }
 
+  /* See ttstub_input_get_mtime() in tectonic_bridge_core about bridging time_t
+   * over FFI. */
+
   rv = dvipdfmx_main(
     pdfname,
     dviname,
@@ -509,7 +512,7 @@ tt_engine_xdvipdfmx_main(
     (bool) config->deterministic_tags,
     false, /* quiet */
     0, /* verbose */
-    config->build_date,
+    (time_t) config->build_date,
     config->paperspec
   );
 

crates/engine_xdvipdfmx/xdvipdfmx/dvipdfmx.c

@@ -10,7 +10,7 @@ typedef struct {
   const char *paperspec;
   unsigned char enable_compression;
   unsigned char deterministic_tags;
-  time_t build_date;
+  uint64_t build_date;
 } XdvipdfmxConfig;
 
 #ifdef __cplusplus

crates/engine_xdvipdfmx/xdvipdfmx/xdvipdfmx_bindings.h

@@ -228,7 +228,7 @@ impl TexEngine {
                     self.build_date
                         .duration_since(SystemTime::UNIX_EPOCH)
                         .expect("invalid build date")
-                        .as_secs() as libc::time_t,
+                        .as_secs(),
                 )
             };
 
@@ -245,6 +245,8 @@ impl TexEngine {
 
 #[doc(hidden)]
 pub mod c_api {
+    // If you change the interfaces here, rerun cbindgen as described in the README!
+
     use tectonic_bridge_core::CoreBridgeState;
 
     #[allow(improper_ctypes)] // for CoreBridgeState
@@ -258,7 +260,7 @@ pub mod c_api {
             api: &mut CoreBridgeState,
             dump_name: *const libc::c_char,
             input_file_name: *const libc::c_char,
-            build_date: libc::time_t,
+            build_date: u64,
         ) -> libc::c_int;
     }
 }