ProofChecker.java
01 /* This file is part of the project "Hilbert II" - http://www.qedeq.org
02  *
03  * Copyright 2000-2011,  Michael Meyling <mime@qedeq.org>.
04  *
05  * "Hilbert II" is free software; you can redistribute
06  * it and/or modify it under the terms of the GNU General Public
07  * License as published by the Free Software Foundation; either
08  * version 2 of the License, or (at your option) any later version.
09  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13  * GNU General Public License for more details.
14  */
15 
16 package org.qedeq.kernel.bo.logic.common;
17 
18 import org.qedeq.kernel.se.base.list.Element;
19 import org.qedeq.kernel.se.base.module.FormalProofLineList;
20 import org.qedeq.kernel.se.common.ModuleContext;
21 
22 /**
23  * A proof checker can check if a formal proof is correct.
24  *
25  @author  Michael Meyling
26  */
27 public interface ProofChecker {
28 
29     /**
30      * Checks if a formal proof is ok. If there are any errors the returned list
31      * (which is always not <code>null</code>) has a size greater zero.
32      * Precondition is a well formed environment. So every formula must
33      * be well formed, every necessary operator and predicate and function must
34      * exist.
35      *
36      @param   formula             Formula we want to proof.
37      @param   proof               Check this formal proof.
38      @param   context             Location information of formal proof.
39      *                              Important for locating errors.
40      @param   resolver            Resolver for references.
41      @return  Collected errors if there are any. Not <code>null</code>.
42      */
43     public LogicalCheckExceptionList checkProof(final Element formula,
44             final FormalProofLineList proof,
45             final ModuleContext context, final ReferenceResolver resolver);
46 
47 
48 }