com.thesett.aima.logic.fol.wam.printer.SourceClausePrinter Maven / Gradle / Ivy

Go to download
/*
 * Copyright The Sett Ltd, 2005 to 2014.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.thesett.aima.logic.fol.wam.printer;

import com.thesett.aima.logic.fol.Functor;
import com.thesett.aima.logic.fol.Variable;
import com.thesett.aima.logic.fol.VariableAndFunctorInterner;
import com.thesett.aima.logic.fol.compiler.PositionalTermTraverser;
import com.thesett.common.util.doublemaps.SymbolTable;
import com.thesett.text.api.model.TextTableModel;

/**
 * SourceClausePrinter prints the source of a compiled clause in a vertically spread out way, so that each predicate
 * call and argument appears in its own row. This leaves enough space vertically to print the compiled byte code
 * alongside.
 *
 * 
 * CRC Card Responsibilities  Collaborations
 * 
 Print each predicate call and argument in its own row.
 * 
 *
 * @author Rupert Smith
 */
public class SourceClausePrinter extends BasePrinter
{
    /**
     * Creates a printer.
     *
     * @param interner    The name interner.
     * @param symbolTable The compiler symbol table.
     * @param traverser   The positional context traverser.
     * @param column      The column to print to.
     * @param table       The table to inform of cell sizes and positions.
     */
    public SourceClausePrinter(VariableAndFunctorInterner interner, SymbolTable symbolTable,
        PositionalTermTraverser traverser, int column, TextTableModel table)
    {
        super(interner, symbolTable, traverser, column, table);
    }

    /** {@inheritDoc} */
    protected void enterFunctor(Functor functor)
    {
        String showContextAs = interner.getFunctorName(functor) + (functor.isAtom() ? "" : "(");

        int delta = showContextAs.length();

        addLineToRow(indent + showContextAs);
        nextRow();

        indent = indenter.generateTraceIndent(delta);
    }

    /** {@inheritDoc} */
    protected void leaveFunctor(Functor functor)
    {
        String toAppend = indent;
        boolean addData = false;

        if (functor.isCompound())
        {
            toAppend += ")";
            addData = true;
        }

        if (!traverser.isInHead() && !traverser.isLastBodyFunctor() && traverser.isTopLevel())
        {
            toAppend += ",";
            addData = true;
        }

        if (traverser.isInHead() && traverser.isTopLevel())
        {
            toAppend += " :-";
            addData = true;
        }

        if (addData)
        {
            addLineToRow(toAppend);
            nextRow();
        }

        indent = indenter.generateTraceIndent(-indenter.getLastDelta());
    }

    /** {@inheritDoc} */
    protected void enterVariable(Variable variable)
    {
        String showContextAs = interner.getVariableName(variable);

        int delta = showContextAs.length();

        addLineToRow(indent + showContextAs);
        nextRow();

        indent = indenter.generateTraceIndent(delta);
    }
}