use anyhow::{Context, Result};
use std::fs;
use std::path::Path;
use std::process::Command;
use crate::config::PdflatexConfig;
use crate::file_index::FileIndex;
use crate::graph::{BuildGraph, Product};
use crate::processors::{ProcessorBase, Processor, run_command, check_command_output};
use super::DiscoverParams;
const PDFLATEX_TEMP_EXTENSIONS: &[&str] = &[".log", ".out", ".toc", ".aux", ".nav", ".snm", ".vrb"];
pub struct PdflatexProcessor {
base: ProcessorBase,
config: PdflatexConfig,
}
impl PdflatexProcessor {
pub fn new(config: PdflatexConfig) -> Self {
Self {
base: ProcessorBase::generator(
crate::processors::names::PDFLATEX,
"Compile LaTeX documents using pdflatex",
),
config,
}
}
fn clean_temp_files(&self, stem: &str, dir: &Path) {
for ext in PDFLATEX_TEMP_EXTENSIONS {
let path = dir.join(format!("{}{}", stem, ext));
let _ = fs::remove_file(path);
}
}
}
impl Processor for PdflatexProcessor {
fn scan_config(&self) -> &crate::config::StandardConfig {
&self.config.standard
}
fn standard_config(&self) -> Option<&crate::config::StandardConfig> {
Some(&self.config.standard)
}
fn description(&self) -> &str {
self.base.description()
}
fn processor_type(&self) -> crate::processors::ProcessorType {
self.base.processor_type()
}
fn clean(&self, product: &crate::graph::Product, verbose: bool) -> anyhow::Result<usize> {
crate::processors::ProcessorBase::clean(product, &product.processor, verbose)
}
fn required_tools(&self) -> Vec<String> {
let mut tools = vec![self.config.pdflatex.clone()];
if self.config.qpdf {
tools.push("qpdf".to_string());
}
tools
}
fn discover(&self, graph: &mut BuildGraph, file_index: &FileIndex, instance_name: &str) -> Result<()> {
let params = DiscoverParams {
scan: &self.config.standard,
dep_inputs: &self.config.standard.dep_inputs,
config: &self.config,
output_dir: &self.config.standard.output_dir,
processor_name: instance_name,
};
super::discover_single_format(graph, file_index, ¶ms, "pdf")
}
fn supports_batch(&self) -> bool { false }
fn execute(&self, ctx: &crate::build_context::BuildContext, product: &Product) -> Result<()> {
let input = product.primary_input();
let final_output = product.primary_output();
let input_stem = input.file_stem()
.context("pdflatex input has no file stem")?
.to_string_lossy();
crate::processors::ensure_output_dir(final_output)?;
let build_dir = final_output.parent().unwrap_or(Path::new("."));
for run in 0..self.config.runs {
if run > 0 {
self.clean_temp_files(&input_stem, build_dir);
}
let mut cmd = Command::new(&self.config.pdflatex);
cmd.arg("-shell-escape");
cmd.arg("-interaction=nonstopmode");
cmd.arg("-halt-on-error");
cmd.arg(format!("-output-directory={}", build_dir.display()));
for arg in &self.config.standard.args {
cmd.arg(arg);
}
cmd.arg(input);
let out = run_command(ctx, &mut cmd)?;
check_command_output(&out, format_args!("pdflatex run {} of {}", run + 1, input.display()))?;
}
if self.config.qpdf {
let pdf_in_build = build_dir.join(format!("{}.pdf", input_stem));
let qpdf_tmp = build_dir.join(format!("{}.qpdf.pdf", input_stem));
let mut cmd = Command::new("qpdf");
cmd.arg("--deterministic-id");
cmd.arg("--linearize");
cmd.arg(&pdf_in_build);
cmd.arg(&qpdf_tmp);
let out = run_command(ctx, &mut cmd)?;
check_command_output(&out, format_args!("qpdf {}", pdf_in_build.display()))?;
fs::rename(&qpdf_tmp, &pdf_in_build)
.with_context(|| format!("Failed to rename qpdf output: {}", qpdf_tmp.display()))?;
}
self.clean_temp_files(&input_stem, build_dir);
Ok(())
}
}
fn plugin_create(toml: &toml::Value) -> anyhow::Result<Box<dyn crate::processors::Processor>> {
crate::registries::deserialize_and_create(toml, |cfg| Box::new(PdflatexProcessor::new(cfg)))
}
inventory::submit! {
crate::registries::ProcessorPlugin {
version: 1,
name: "pdflatex",
processor_type: crate::processors::ProcessorType::Generator,
create: plugin_create,
defconfig_json: crate::registries::default_config_json::<crate::config::PdflatexConfig>,
known_fields: crate::registries::typed_known_fields::<crate::config::PdflatexConfig>,
output_fields: crate::registries::typed_output_fields::<crate::config::PdflatexConfig>,
must_fields: crate::registries::typed_must_fields::<crate::config::PdflatexConfig>,
field_descriptions: crate::registries::typed_field_descriptions::<crate::config::PdflatexConfig>,
keywords: &["latex", "tex", "pdf", "generator", "typesetting"],
description: "Compile LaTeX documents using pdflatex",
is_native: false,
can_fix: false,
}
}