litex-lang 0.9.86-beta

A simple formal proof language and verifier, learnable in 2 hours
Documentation
use crate::prelude::*;

impl Runtime {
    pub fn parse_by_induc_stmt(&mut self, tb: &mut TokenBlock) -> Result<Stmt, RuntimeError> {
        tb.skip_token(INDUC)?;
        self.parse_induc_stmt_after_keyword(tb, false)
    }

    pub fn parse_strong_induc_stmt(&mut self, tb: &mut TokenBlock) -> Result<Stmt, RuntimeError> {
        tb.skip_token(STRONG_INDUC)?;
        self.parse_induc_stmt_after_keyword(tb, true)
    }

    fn parse_induc_stmt_after_keyword(
        &mut self,
        tb: &mut TokenBlock,
        strong: bool,
    ) -> Result<Stmt, RuntimeError> {
        let param = tb.advance()?;

        tb.skip_token(FROM)?;
        let induc_from = self.parse_obj(tb)?;
        tb.skip_token(COLON)?;
        if !tb.exceed_end_of_head() {
            return Err(RuntimeError::from(ParseRuntimeError(
                RuntimeErrorStruct::new_with_msg_and_line_file(
                    "induc: expected end of head".to_string(),
                    tb.line_file.clone(),
                ),
            )));
        }

        if tb.body.is_empty() {
            return Err(RuntimeError::from(ParseRuntimeError(
                RuntimeErrorStruct::new_with_msg_and_line_file(
                    "induc: expects prove: block".to_string(),
                    tb.line_file.clone(),
                ),
            )));
        }

        tb.body[0].skip_token_and_colon_and_exceed_end_of_head(PROVE)?;

        if tb.body[0].body.is_empty() {
            return Err(RuntimeError::from(ParseRuntimeError(
                RuntimeErrorStruct::new_with_msg_and_line_file(
                    "induc prove: expects at least one fact to prove".to_string(),
                    tb.body[0].line_file.clone(),
                ),
            )));
        }

        let prove_line = tb.body[0].line_file.clone();
        let induc_param = [param.clone()];
        let mut to_prove: Vec<ExistOrAndChainAtomicFact> = Vec::new();
        self.parse_in_local_free_param_scope(
            ParamObjType::Induc,
            &induc_param,
            prove_line,
            |this| {
                for block in tb.body[0].body.iter_mut() {
                    to_prove.push(this.parse_exist_or_and_chain_atomic_fact(block)?);
                }
                Ok(())
            },
        )?;

        let proof_line = tb.line_file.clone();
        let (proof, base_proof, step_proof) = self.with_optional_free_param_scope(
            ParamObjType::Induc,
            &induc_param,
            proof_line,
            |this| this.parse_induc_proof_blocks(tb, &param, &induc_from, strong),
        )?;

        Ok(ByInducStmt::new(
            to_prove,
            param,
            induc_from,
            proof,
            base_proof,
            step_proof,
            tb.line_file.clone(),
            strong,
        )
        .into())
    }

    fn parse_induc_proof_blocks(
        &mut self,
        tb: &mut TokenBlock,
        param: &str,
        induc_from: &Obj,
        strong: bool,
    ) -> Result<(Vec<Stmt>, Option<Vec<Stmt>>, Option<Vec<Stmt>>), RuntimeError> {
        let mut proof: Vec<Stmt> = Vec::new();
        let mut base_proof: Option<Vec<Stmt>> = None;
        let mut step_proof: Option<Vec<Stmt>> = None;
        let mut structured_proof_seen = false;
        let step_keyword = Self::induc_step_proof_keyword(strong);

        for block in tb.body.iter_mut().skip(1) {
            if Self::is_induc_base_proof_block(block) {
                structured_proof_seen = true;
                if !proof.is_empty() {
                    return Err(Self::induc_parse_error(
                        format!(
                            "induc: old proof statements cannot be mixed with `prove from` / `prove {}` blocks",
                            step_keyword
                        ),
                        block.line_file.clone(),
                    ));
                }
                if base_proof.is_some() {
                    return Err(Self::induc_parse_error(
                        "induc: duplicated `prove from` block".to_string(),
                        block.line_file.clone(),
                    ));
                }
                self.verify_induc_base_proof_header(block, param, induc_from)?;
                base_proof = Some(self.parse_induc_structured_proof_body(block)?);
            } else if Self::is_induc_step_proof_block(block) {
                structured_proof_seen = true;
                Self::verify_induc_step_proof_keyword(block, step_keyword)?;
                if !proof.is_empty() {
                    return Err(Self::induc_parse_error(
                        format!(
                            "induc: old proof statements cannot be mixed with `prove from` / `prove {}` blocks",
                            step_keyword
                        ),
                        block.line_file.clone(),
                    ));
                }
                if step_proof.is_some() {
                    return Err(Self::induc_parse_error(
                        format!("induc: duplicated `prove {}` block", step_keyword),
                        block.line_file.clone(),
                    ));
                }
                block.skip_token(PROVE)?;
                block.skip_token(step_keyword)?;
                block.skip_token(COLON)?;
                if !block.exceed_end_of_head() {
                    return Err(Self::induc_parse_error(
                        format!("induc: expected end of `prove {}` head", step_keyword),
                        block.line_file.clone(),
                    ));
                }
                step_proof = Some(self.parse_induc_structured_proof_body(block)?);
            } else {
                if structured_proof_seen {
                    return Err(Self::induc_parse_error(
                        format!(
                            "induc: old proof statements cannot be mixed with `prove from` / `prove {}` blocks",
                            step_keyword
                        ),
                        block.line_file.clone(),
                    ));
                }
                proof.push(self.parse_stmt(block)?);
            }
        }

        if structured_proof_seen && (base_proof.is_none() || step_proof.is_none()) {
            return Err(Self::induc_parse_error(
                format!(
                    "induc: structured proof expects both `prove from param = base:` and `prove {}:` blocks",
                    step_keyword
                ),
                tb.line_file.clone(),
            ));
        }

        Ok((proof, base_proof, step_proof))
    }

    fn parse_induc_structured_proof_body(
        &mut self,
        block: &mut TokenBlock,
    ) -> Result<Vec<Stmt>, RuntimeError> {
        let mut proof = Vec::with_capacity(block.body.len());
        for body_block in block.body.iter_mut() {
            proof.push(self.parse_stmt(body_block)?);
        }
        Ok(proof)
    }

    fn verify_induc_base_proof_header(
        &mut self,
        block: &mut TokenBlock,
        param: &str,
        induc_from: &Obj,
    ) -> Result<(), RuntimeError> {
        block.skip_token(PROVE)?;
        block.skip_token(FROM)?;
        let header_fact =
            self.parse_header_fact_before_trailing_colon(block, "induc prove from", "", "")?;
        let Fact::AtomicFact(AtomicFact::EqualFact(equal_fact)) = header_fact else {
            return Err(Self::induc_parse_error(
                "induc: `prove from` expects an equality fact".to_string(),
                block.line_file.clone(),
            ));
        };
        let expected_param = obj_for_bound_param_in_scope(param.to_string(), ParamObjType::Induc);
        if equal_fact.left.to_string() != expected_param.to_string()
            || equal_fact.right.to_string() != induc_from.to_string()
        {
            return Err(Self::induc_parse_error(
                format!("induc: `prove from` must be `{} = {}`", param, induc_from),
                block.line_file.clone(),
            ));
        }
        Ok(())
    }

    fn is_induc_base_proof_block(block: &TokenBlock) -> bool {
        block.token_at_add_index(0) == PROVE && block.token_at_add_index(1) == FROM
    }

    fn is_induc_step_proof_block(block: &TokenBlock) -> bool {
        block.token_at_add_index(0) == PROVE
            && (block.token_at_add_index(1) == INDUC || block.token_at_add_index(1) == STRONG_INDUC)
    }

    fn induc_step_proof_keyword(strong: bool) -> &'static str {
        if strong {
            STRONG_INDUC
        } else {
            INDUC
        }
    }

    fn verify_induc_step_proof_keyword(
        block: &TokenBlock,
        expected: &str,
    ) -> Result<(), RuntimeError> {
        if block.token_at_add_index(1) == expected {
            return Ok(());
        }
        Err(Self::induc_parse_error(
            format!("induc: expected `prove {}:` here", expected),
            block.line_file.clone(),
        ))
    }

    fn induc_parse_error(message: String, line_file: LineFile) -> RuntimeError {
        RuntimeError::from(ParseRuntimeError(
            RuntimeErrorStruct::new_with_msg_and_line_file(message, line_file),
        ))
    }
}