tectonic_engine_bibtex 0.3.3

use crate::{
    bibs::BibData,
    buffer::{BufTy, GlobalBuffer},
    char_info::LexClass,
    cite::CiteInfo,
    exec::print_bst_name,
    hash,
    hash::{HashData, HashPointer},
    log::{
        aux_end1_err_print, aux_end2_err_print, aux_err_illegal_another_print,
        aux_err_no_right_brace_print, aux_err_print, aux_err_stuff_after_right_brace_print,
        aux_err_white_space_in_argument_print, hash_cite_confusion, log_pr_aux_name,
        log_pr_bst_name, print_a_pool_str, print_a_token, print_aux_name, print_bib_name,
        print_confusion, print_overflow, AuxTy,
    },
    peekable::PeekableInput,
    pool::{StrNumber, StringPool},
    scan::Scan,
    Bibtex, BibtexError, File, GlobalItems,
};
use std::ffi::CString;
use tectonic_bridge_core::FileFormat;

const AUX_STACK_SIZE: usize = 20;

#[derive(Copy, Clone, Debug)]
pub(crate) enum AuxCommand {
    Data,
    Style,
    Citation,
    Input,
}

pub(crate) struct AuxData {
    aux: Vec<File>,
}

impl AuxData {
    pub fn new() -> AuxData {
        AuxData { aux: Vec::new() }
    }

    pub fn push_file(&mut self, file: File) {
        self.aux.push(file);
    }

    pub fn pop_file(&mut self) -> (File, bool) {
        let out = self.aux.pop().unwrap();
        (out, self.aux.is_empty())
    }

    pub fn top_file(&self) -> &File {
        self.aux.last().unwrap()
    }

    pub fn top_file_mut(&mut self) -> &mut File {
        self.aux.last_mut().unwrap()
    }

    pub fn ptr(&self) -> usize {
        self.aux.len()
    }
}

fn aux_bib_data_command(
    ctx: &mut Bibtex<'_, '_>,
    buffers: &mut GlobalBuffer,
    bibs: &mut BibData,
    aux: &AuxData,
    pool: &mut StringPool,
    hash: &mut HashData,
) -> Result<(), BibtexError> {
    if ctx.bib_seen {
        aux_err_illegal_another_print(ctx, AuxTy::Data)?;
        aux_err_print(ctx, buffers, aux, pool)?;
        return Ok(());
    }
    ctx.bib_seen = true;

    while buffers.at_offset(BufTy::Base, 2) != b'}' {
        buffers.set_offset(BufTy::Base, 2, buffers.offset(BufTy::Base, 2) + 1);
        let init = buffers.init(BufTy::Base);
        if !Scan::new()
            .chars(b"},")
            .class(LexClass::Whitespace)
            .scan_till(buffers, init)
        {
            aux_err_no_right_brace_print(ctx);
            aux_err_print(ctx, buffers, aux, pool)?;
            return Ok(());
        }

        if LexClass::of(buffers.at_offset(BufTy::Base, 2)) == LexClass::Whitespace {
            aux_err_white_space_in_argument_print(ctx);
            aux_err_print(ctx, buffers, aux, pool)?;
            return Ok(());
        }

        if buffers.init(BufTy::Base) > buffers.offset(BufTy::Base, 2) + 1
            && buffers.at_offset(BufTy::Base, 2) == b'}'
        {
            aux_err_stuff_after_right_brace_print(ctx);
            aux_err_print(ctx, buffers, aux, pool)?;
            return Ok(());
        }

        let file = &buffers.buffer(BufTy::Base)
            [buffers.offset(BufTy::Base, 1)..buffers.offset(BufTy::Base, 2)];
        let res = hash.lookup_str_insert::<hash::BibFile>(pool, file, ());
        if res.exists {
            ctx.write_logs("This database file appears more than once: ");
            print_bib_name(ctx, pool, hash.get(res.loc).text())?;
            aux_err_print(ctx, buffers, aux, pool)?;
            return Ok(());
        }

        let name = pool.get_str(hash.get(res.loc).text());
        let fname = CString::new(name).unwrap();
        let bib_in = PeekableInput::open(ctx, &fname, FileFormat::Bib);
        match bib_in {
            Err(_) => {
                ctx.write_logs("I couldn't open database file ");
                print_bib_name(ctx, pool, hash.get(res.loc).text())?;
                aux_err_print(ctx, buffers, aux, pool)?;
                return Ok(());
            }
            Ok(file) => {
                bibs.push_file(File {
                    name: hash.get(res.loc).text(),
                    file,
                    line: 0,
                });
            }
        }
    }

    Ok(())
}

fn aux_bib_style_command(
    ctx: &mut Bibtex<'_, '_>,
    buffers: &mut GlobalBuffer,
    aux: &AuxData,
    pool: &mut StringPool,
    hash: &mut HashData,
) -> Result<(), BibtexError> {
    if ctx.bst_seen {
        aux_err_illegal_another_print(ctx, AuxTy::Style)?;
        aux_err_print(ctx, buffers, aux, pool)?;
        return Ok(());
    }
    ctx.bst_seen = true;

    buffers.set_offset(BufTy::Base, 2, buffers.offset(BufTy::Base, 2) + 1);
    let init = buffers.init(BufTy::Base);
    if !Scan::new()
        .chars(b"}")
        .class(LexClass::Whitespace)
        .scan_till(buffers, init)
    {
        aux_err_no_right_brace_print(ctx);
        aux_err_print(ctx, buffers, aux, pool)?;
        return Ok(());
    }

    if LexClass::of(buffers.at_offset(BufTy::Base, 2)) == LexClass::Whitespace {
        aux_err_white_space_in_argument_print(ctx);
        aux_err_print(ctx, buffers, aux, pool)?;
        return Ok(());
    }

    if buffers.init(BufTy::Base) > buffers.offset(BufTy::Base, 2) + 1 {
        aux_err_stuff_after_right_brace_print(ctx);
        aux_err_print(ctx, buffers, aux, pool)?;
        return Ok(());
    }

    let file = &buffers.buffer(BufTy::Base)
        [buffers.offset(BufTy::Base, 1)..buffers.offset(BufTy::Base, 2)];
    let res = hash.lookup_str_insert::<hash::BstFile>(pool, file, ());
    if res.exists {
        ctx.write_logs("Already encountered style file");
        print_confusion(ctx);
        return Err(BibtexError::Fatal);
    }

    let name = pool.get_str(hash.get(res.loc).text());
    let fname = CString::new(name).unwrap();
    let bst_file = PeekableInput::open(ctx, &fname, FileFormat::Bst);
    match bst_file {
        Err(_) => {
            ctx.write_logs("I couldn't open style file ");
            print_bst_name(ctx, pool, hash.get(res.loc).text())?;
            ctx.bst = None;
            aux_err_print(ctx, buffers, aux, pool)?;
            return Ok(());
        }
        Ok(file) => {
            ctx.bst = Some(File {
                name: hash.get(res.loc).text(),
                file,
                line: 0,
            });
        }
    }

    if ctx.config.verbose {
        ctx.write_logs("The style file: ");
        print_bst_name(ctx, pool, ctx.bst.as_ref().unwrap().name)?;
    } else {
        ctx.write_log_file("The style file: ");
        log_pr_bst_name(ctx, pool)?;
    }

    Ok(())
}

fn aux_citation_command(
    ctx: &mut Bibtex<'_, '_>,
    buffers: &mut GlobalBuffer,
    aux: &AuxData,
    pool: &mut StringPool,
    hash: &mut HashData,
    cites: &mut CiteInfo,
) -> Result<(), BibtexError> {
    ctx.citation_seen = true;

    while buffers.at_offset(BufTy::Base, 2) != b'}' {
        buffers.set_offset(BufTy::Base, 2, buffers.offset(BufTy::Base, 2) + 1);

        let init = buffers.init(BufTy::Base);
        if !Scan::new()
            .chars(b"},")
            .class(LexClass::Whitespace)
            .scan_till(buffers, init)
        {
            aux_err_no_right_brace_print(ctx);
            aux_err_print(ctx, buffers, aux, pool)?;
            return Ok(());
        }
        if LexClass::of(buffers.at_offset(BufTy::Base, 2)) == LexClass::Whitespace {
            aux_err_white_space_in_argument_print(ctx);
            aux_err_print(ctx, buffers, aux, pool)?;
            return Ok(());
        }
        if buffers.init(BufTy::Base) > buffers.offset(BufTy::Base, 2) + 1
            && buffers.at_offset(BufTy::Base, 2) == b'}'
        {
            aux_err_stuff_after_right_brace_print(ctx);
            aux_err_print(ctx, buffers, aux, pool)?;
            return Ok(());
        }

        if buffers.offset(BufTy::Base, 2) - buffers.offset(BufTy::Base, 1) == 1
            && buffers.at_offset(BufTy::Base, 1) == b'*'
        {
            if ctx.all_entries {
                ctx.write_logs("Multiple inclusions of entire database\n");
                aux_err_print(ctx, buffers, aux, pool)?;
                return Ok(());
            } else {
                ctx.all_entries = true;
                cites.set_all_marker(cites.ptr());
                continue;
            }
        }

        let idx = buffers.offset(BufTy::Base, 1);
        buffers.copy_within(
            BufTy::Base,
            BufTy::Ex,
            idx,
            idx,
            buffers.offset(BufTy::Base, 2) - idx,
        );
        let range = buffers.offset(BufTy::Base, 1)..buffers.offset(BufTy::Base, 2);
        let lc_cite = &mut buffers.buffer_mut(BufTy::Ex)[range];
        lc_cite.make_ascii_lowercase();

        let lc_res = hash.lookup_str_insert::<hash::LcCite>(pool, lc_cite, HashPointer::default());
        if lc_res.exists {
            let &cite_loc = hash.get(lc_res.loc).extra();

            let cite = &buffers.buffer(BufTy::Base)
                [buffers.offset(BufTy::Base, 1)..buffers.offset(BufTy::Base, 2)];
            let uc_res = hash.lookup_str::<hash::Cite>(pool, cite);
            if uc_res.is_none() {
                let &cite = hash.get(cite_loc).extra();
                ctx.write_logs("Case mismatch error between cite keys ");
                print_a_token(ctx, buffers);
                ctx.write_logs(" and ");
                print_a_pool_str(ctx, cites.get_cite(cite), pool)?;
                ctx.write_logs("\n");
                aux_err_print(ctx, buffers, aux, pool)?;
                return Ok(());
            }
        } else {
            let cite = &buffers.buffer(BufTy::Base)
                [buffers.offset(BufTy::Base, 1)..buffers.offset(BufTy::Base, 2)];
            let uc_res = hash.lookup_str_insert::<hash::Cite>(pool, cite, 0);
            if uc_res.exists {
                hash_cite_confusion(ctx);
                return Err(BibtexError::Fatal);
            }

            if cites.ptr() == cites.len() {
                cites.grow();
            }

            cites.set_cite(cites.ptr(), hash.get(uc_res.loc).text());
            hash.set_extra(uc_res.loc, cites.ptr());
            hash.set_extra(lc_res.loc, uc_res.loc);
            cites.set_ptr(cites.ptr() + 1);
        }
    }

    Ok(())
}

fn aux_input_command(
    ctx: &mut Bibtex<'_, '_>,
    buffers: &mut GlobalBuffer,
    aux: &mut AuxData,
    pool: &mut StringPool,
    hash: &mut HashData,
) -> Result<(), BibtexError> {
    buffers.set_offset(BufTy::Base, 2, buffers.offset(BufTy::Base, 2) + 1);

    let init = buffers.init(BufTy::Base);
    if !Scan::new()
        .chars(b"}")
        .class(LexClass::Whitespace)
        .scan_till(buffers, init)
    {
        aux_err_no_right_brace_print(ctx);
        aux_err_print(ctx, buffers, aux, pool)?;
        return Ok(());
    }
    if LexClass::of(buffers.at_offset(BufTy::Base, 2)) == LexClass::Whitespace {
        aux_err_white_space_in_argument_print(ctx);
        aux_err_print(ctx, buffers, aux, pool)?;
        return Ok(());
    }
    if buffers.init(BufTy::Base) > buffers.offset(BufTy::Base, 2) + 1 {
        aux_err_stuff_after_right_brace_print(ctx);
        aux_err_print(ctx, buffers, aux, pool)?;
        return Ok(());
    }

    if aux.ptr() == AUX_STACK_SIZE {
        print_a_token(ctx, buffers);
        ctx.write_logs(": ");
        print_overflow(ctx);
        ctx.write_logs(&format!("auxiliary file depth {AUX_STACK_SIZE}\n"));
        return Err(BibtexError::Fatal);
    }

    let aux_ext = pool.get_str(ctx.s_aux_extension);
    let aux_extension_ok = !((buffers.offset(BufTy::Base, 2) - buffers.offset(BufTy::Base, 1)
        < aux_ext.len())
        || aux_ext
            != &buffers.buffer(BufTy::Base)
                [buffers.offset(BufTy::Base, 2) - aux_ext.len()..buffers.offset(BufTy::Base, 2)]);

    if !aux_extension_ok {
        print_a_token(ctx, buffers);
        ctx.write_logs(" has a wrong extension");
        aux_err_print(ctx, buffers, aux, pool)?;
        return Ok(());
    }

    let file = &buffers.buffer(BufTy::Base)
        [buffers.offset(BufTy::Base, 1)..buffers.offset(BufTy::Base, 2)];
    let res = hash.lookup_str_insert::<hash::AuxFile>(pool, file, ());
    if res.exists {
        ctx.write_logs("Already encountered file ");
        print_aux_name(ctx, pool, hash.get(res.loc).text())?;
        aux_err_print(ctx, buffers, aux, pool)?;
        return Ok(());
    }

    let name = pool.get_str(hash.get(res.loc).text());
    let fname = CString::new(name).unwrap();
    let file = PeekableInput::open(ctx, &fname, FileFormat::Tex);
    match file {
        Err(_) => {
            ctx.write_logs("I couldn't open auxiliary file ");
            print_aux_name(ctx, pool, hash.get(res.loc).text())?;
            aux_err_print(ctx, buffers, aux, pool)?;
            return Ok(());
        }
        Ok(file) => {
            aux.push_file(File {
                name: hash.get(res.loc).text(),
                file,
                line: 0,
            });
        }
    }

    ctx.write_logs(&format!("A level-{} auxiliary file: ", aux.ptr() - 1));
    log_pr_aux_name(ctx, aux, pool)?;

    Ok(())
}

pub(crate) fn get_aux_command_and_process(
    ctx: &mut Bibtex<'_, '_>,
    globals: &mut GlobalItems<'_>,
) -> Result<(), BibtexError> {
    globals.buffers.set_offset(BufTy::Base, 2, 0);
    let init = globals.buffers.init(BufTy::Base);
    if !Scan::new().chars(b"{").scan_till(globals.buffers, init) {
        return Ok(());
    }

    let line = &globals.buffers.buffer(BufTy::Base)
        [globals.buffers.offset(BufTy::Base, 1)..globals.buffers.offset(BufTy::Base, 2)];
    let res = globals.hash.lookup_str::<AuxCommand>(globals.pool, line);

    if let Some(loc) = res {
        let &cmd = globals.hash.get(loc).extra();

        match cmd {
            AuxCommand::Data => aux_bib_data_command(
                ctx,
                globals.buffers,
                globals.bibs,
                globals.aux,
                globals.pool,
                globals.hash,
            ),
            AuxCommand::Style => aux_bib_style_command(
                ctx,
                globals.buffers,
                globals.aux,
                globals.pool,
                globals.hash,
            ),
            AuxCommand::Citation => aux_citation_command(
                ctx,
                globals.buffers,
                globals.aux,
                globals.pool,
                globals.hash,
                globals.cites,
            ),
            AuxCommand::Input => aux_input_command(
                ctx,
                globals.buffers,
                globals.aux,
                globals.pool,
                globals.hash,
            ),
        }?
    }
    Ok(())
}

pub(crate) fn pop_the_aux_stack(ctx: &mut Bibtex<'_, '_>, aux: &mut AuxData) -> Option<StrNumber> {
    let (file, last) = aux.pop_file();
    file.file.close(ctx).unwrap();
    if last {
        Some(file.name)
    } else {
        None
    }
}

pub(crate) fn last_check_for_aux_errors(
    ctx: &mut Bibtex<'_, '_>,
    pool: &StringPool,
    cites: &mut CiteInfo,
    bibs: &BibData,
    last_aux: StrNumber,
) -> Result<(), BibtexError> {
    cites.set_num_cites(cites.ptr());
    if !ctx.citation_seen {
        aux_end1_err_print(ctx);
        ctx.write_logs("\\citation commands");
        aux_end2_err_print(ctx, pool, last_aux)?;
    } else if cites.num_cites() == 0 && !ctx.all_entries {
        aux_end1_err_print(ctx);
        ctx.write_logs("cite keys");
        aux_end2_err_print(ctx, pool, last_aux)?;
    }

    if !ctx.bib_seen {
        aux_end1_err_print(ctx);
        ctx.write_logs("\\bibdata command");
        aux_end2_err_print(ctx, pool, last_aux)?;
    } else if bibs.len() == 0 {
        aux_end1_err_print(ctx);
        ctx.write_logs("database files");
        aux_end2_err_print(ctx, pool, last_aux)?;
    }

    if !ctx.bst_seen {
        aux_end1_err_print(ctx);
        ctx.write_logs("\\bibstyle command");
        aux_end2_err_print(ctx, pool, last_aux)?;
    } else if ctx.bst.is_none() {
        aux_end1_err_print(ctx);
        ctx.write_logs("style file");
        aux_end2_err_print(ctx, pool, last_aux)?;
    }

    Ok(())
}