Standardize project linting using Cargo lint table (#1305)

Author: CraftSpider

Cargo.toml

@@ -2,6 +2,8 @@
 # Copyright 2016-2023 the Tectonic Project
 # Licensed under the MIT License.
 
+lints.workspace = true
+
 [package]
 name = "tectonic"
 version = "0.0.0-dev.0" # assigned with cranko (see README)
@@ -27,10 +29,6 @@ license = "MIT"
 edition = "2021"
 exclude = ["/dist/", "/reference_sources/"]
 
-[lints.rust]
-# FIXME(CraftSpider): Switch from error-chain to a newer package, as it's a deprecated project
-unexpected_cfgs = { level = "warn", check-cfg = ['cfg(backtrace)', 'cfg(has_error_description_deprecated)'] }
-
 [badges]
 travis-ci = { repository = "tectonic-typesetting/tectonic" }
 codecov = { repository = "tectonic-typesetting/tectonic", service = "github" }
@@ -63,6 +61,14 @@ members = [
     "tests/bundle_env_overrides_test",
 ]
 
+[workspace.lints.rust]
+# FIXME(CraftSpider): Switch from error-chain to a newer package, as it's a deprecated project
+unexpected_cfgs = { level = "warn", check-cfg = ['cfg(has_error_description_deprecated)'] }
+missing_docs = "deny"
+
+[workspace.lints.clippy]
+undocumented_unsafe_blocks = "deny"
+
 [lib]
 name = "tectonic"
 crate-type = ["rlib"]

build.rs

@@ -1,6 +1,8 @@
 // Copyright 2016-2021 the Tectonic Project
 // Licensed under the MIT License.
 
+//! Build script for tectonic binary. Handles some simple environment setup.
+
 use std::env;
 
 fn main() {

crates/bridge_core/Cargo.toml

@@ -3,6 +3,8 @@
 
 # See README.md for discussion of features (or lack thereof) in this crate.
 
+lints.workspace = true
+
 [package]
 name = "tectonic_bridge_core"
 version = "0.0.0-dev.0"  # assigned with cranko (see README)

crates/bridge_core/build.rs

@@ -1,6 +1,8 @@
 // Copyright 2020-2021 the Tectonic Project
 // Licensed under the MIT License.
 
+//! Build script for bridging Tectonic core engine functionality into C code
+
 use std::{env, path::PathBuf};
 
 fn main() {

crates/bridge_core/src/lib.rs

@@ -1,8 +1,6 @@
 // Copyright 2016-2022 the Tectonic Project
 // Licensed under the MIT License.
 
-#![deny(missing_docs)]
-
 //! Core APIs for bridging the C and Rust portions of Tectonic’s processing
 //! backends.
 //!
@@ -223,9 +221,13 @@ impl EngineAbortedError {
         }
     }
 
-    unsafe fn new_with_details() -> Self {
-        let ptr = _ttbc_get_error_message();
-        let message = CStr::from_ptr(ptr).to_string_lossy().into_owned();
+    fn new_with_details() -> Self {
+        // SAFETY: This is always safe to call
+        let ptr = unsafe { _ttbc_get_error_message() };
+        // SAFETY: The pointer returned above will always have a null-terminated C-string in it
+        let message = unsafe { CStr::from_ptr(ptr) }
+            .to_string_lossy()
+            .into_owned();
         EngineAbortedError { message }
     }
 }
@@ -314,7 +316,7 @@ impl<'a> CoreBridgeLauncher<'a> {
 
         if let Err(ref e) = result {
             if e.downcast_ref::<EngineAbortedError>().is_some() {
-                return Err(unsafe { EngineAbortedError::new_with_details() }.into());
+                return Err(EngineAbortedError::new_with_details().into());
             }
         }
 

crates/bridge_flate/Cargo.toml

@@ -3,6 +3,8 @@
 
 # See README.md for discussion of features (or lack thereof) in this crate.
 
+lints.workspace = true
+
 [package]
 name = "tectonic_bridge_flate"
 version = "0.0.0-dev.0"  # assigned with cranko (see README)

crates/bridge_flate/build.rs

@@ -1,6 +1,8 @@
 // Copyright 2020-2021 the Tectonic Project
 // Licensed under the MIT License.
 
+//! Build script for bridging flate2 into C code
+
 use std::{env, path::PathBuf};
 
 fn main() {

crates/bridge_flate/src/lib.rs

@@ -1,8 +1,6 @@
 // Copyright 2020 the Tectonic Project
 // Licensed under the MIT License.
 
-#![deny(missing_docs)]
-
 //! 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.
@@ -156,7 +154,7 @@ pub unsafe extern "C" fn tectonic_flate_new_decompressor(
         done: false,
     };
 
-    Box::leak(Box::new(dc)) as *mut Decompressor as *mut _
+    Box::into_raw(Box::new(dc)).cast::<libc::c_void>()
 }
 
 /// Decompress some DEFLATEd data.
@@ -177,7 +175,7 @@ pub unsafe extern "C" fn tectonic_flate_decompress_chunk(
     output_ptr: *mut u8,
     output_len: *mut u64,
 ) -> libc::c_int {
-    let mut dc = Box::from_raw(handle as *mut Decompressor);
+    let mut dc = Box::from_raw(handle.cast::<Decompressor>());
     let output = slice::from_raw_parts_mut(output_ptr, *output_len as usize);
 
     let (amount, flag) = match dc.decompress_chunk(output) {
@@ -197,6 +195,6 @@ pub unsafe extern "C" fn tectonic_flate_decompress_chunk(
 /// This is a C API function, so it is unsafe.
 #[no_mangle]
 pub unsafe extern "C" fn tectonic_flate_free_decompressor(handle: *mut libc::c_void) {
-    let _dc = Box::from_raw(handle as *mut Decompressor);
+    let _dc = Box::from_raw(handle.cast::<Decompressor>());
     // The box will be freed as we exit.
 }

crates/bridge_fontconfig/Cargo.toml

@@ -1,3 +1,5 @@
+lints.workspace = true
+
 [package]
 name = "tectonic_bridge_fontconfig"
 version = "0.0.0-dev.0"

crates/bridge_fontconfig/build.rs

@@ -1,3 +1,5 @@
+//! fontconfig build script. For now, we always find it externally.
+
 use tectonic_dep_support::{Configuration, Dependency, Spec};
 
 struct FontconfigSpec;