Merge pull request #848 from pkgw/format-decoding

Add `xetex_format` introspection crate

Cargo.toml

@@ -45,6 +45,7 @@ members = [
   "crates/pdf_io",
   "crates/status_base",
   "crates/xdv",
+  "crates/xetex_format",
   "crates/xetex_layout",
 ]
 

crates/docmodel/src/document.rs

@@ -117,7 +117,7 @@ impl Document {
         let outputs = self
             .outputs
             .values()
-            .map(|r| syntax::OutputProfile::from_runtime(r))
+            .map(syntax::OutputProfile::from_runtime)
             .collect();
 
         let doc = syntax::Document {

crates/docmodel/src/workspace.rs

@@ -29,6 +29,7 @@ use crate::document::Document;
 #[derive(Debug)]
 pub struct Workspace {
     /// The root directory of the workspace.
+    #[allow(dead_code)] // We expect to use this eventually.
     root_dir: PathBuf,
 
     /// This workspace's document. In the future, there might be more than one.

crates/engine_xetex/README.md

@@ -22,7 +22,7 @@ This crate provides the following [Cargo features][features]:
   the `tectonic_bridge_harfbuzz` dependency.
 
 
-## Updating the generated header
+## Updating the generated headers
 
 This crate exposes Rust functions to C/C++ code using a header file created by
 [cbindgen]. To update the header, run:
@@ -32,3 +32,15 @@ This crate exposes Rust functions to C/C++ code using a header file created by
 ```sh
 cbindgen --output xetex/xetex_bindings.h
 ```
+
+It also uses definitions generated by the `tectonic_xetex_format` introspection crate. To
+update that header, run:
+
+```sh
+cargo run -p tectonic_xetex_format --example emit >xetex/xetex_format.h
+```
+
+Note that this crate defines the format serial number that it implements (in
+`tectonic_engine_xetex::FORMAT_SERIAL`) separately from the maximum serial
+number supported by the introspection crate (in
+`tectonic_xetex_format::LATEST_VERSION`).