scale_documentation 0.1.2

structured SCALE assembly documentation
Documentation
// Copyright (c) 2021, COSIC-KU Leuven, Kasteelpark Arenberg 10, bus 2452, B-3001 Leuven-Heverlee, Belgium.
// Copyright (c) 2021, Cosmian Tech SAS, 53-55 rue La Boétie, Paris, France.

use eyre::Context;
use std::io::Write;

#[allow(clippy::write_literal)]
fn main() -> eyre::Result<()> {
    let mut file =
        std::fs::File::create("Instructions.tex").context("writing to Instructions.tex")?;
    for group in scale_documentation::INSTRUCTIONS {
        writeln!(file, r"\subsubsection{{{}}}", group.name.trim())?;

        writeln!(file, "{}", r"\begin{longtable}{|l|c|p{1in}|c|p{2.27in}|c|}")?;
        writeln!(file, r"\hline")?;

        writeln!(
            file,
            r"Instr & Code & Operands & Vect & Description & Notes \\"
        )?;
        writeln!(file, r"\hline")?;

        for i in group.instructions {
            let name = i.name.replace("_", "\\_");
            write!(file, "  {} & 0x{:X} & [", name, i.opcode)?;
            let mut first = true;
            for arg in i.args {
                if first {
                    first = false;
                } else {
                    write!(file, ", ")?;
                }
                write!(file, "'{}'", arg.ty)?;
            }
            write!(file, "] & ")?;
            if i.vectorizable {
                write!(file, r"\tick ")?;
            }
            write!(file, " & {} & ", i.comment.trim())?;
            let mut flags = Vec::new();
            if !i.notes.trim().is_empty() {
                flags.push(i.notes.trim());
            }
            if i.terminator {
                flags.push("$\\ddagger$")
            } else if i.barrier {
                flags.push("$\\dagger$");
            }
            if i.thread_0_only {
                flags.push("$\\tau_0$");
            }
            if i.mem_read {
                flags.push("$\\star(r)$");
            }
            if i.mem_write {
                flags.push("$\\star(w)$");
            }
            let notes = flags.join(", ");
            write!(file, "{}", notes)?;

            writeln!(file, " \\\\")?;
        }
        writeln!(file, r"\hline")?;
        writeln!(file, "{}", r"\end{longtable}")?;
    }
    Ok(())
}