Printer.java

/*
 *  Copyright (c) 2001-2024, Jean Tessier
 *  All rights reserved.
 *  
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions
 *  are met:
 *  
 *      * Redistributions of source code must retain the above copyright
 *        notice, this list of conditions and the following disclaimer.
 *  
 *      * Redistributions in binary form must reproduce the above copyright
 *        notice, this list of conditions and the following disclaimer in the
 *        documentation and/or other materials provided with the distribution.
 *  
 *      * Neither the name of Jean Tessier nor the names of his contributors
 *        may be used to endorse or promote products derived from this software
 *        without specific prior written permission.
 *  
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 *  A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR
 *  CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 *  EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 *  PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 *  PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 *  LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 *  NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 *  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

package com.jeantessier.dependency;

import java.io.*;

public abstract class Printer extends VisitorBase {
    public static final String DEFAULT_INDENT_TEXT = "    ";

    private final PrintWriter out;

    private String indentText = DEFAULT_INDENT_TEXT;
    private int indentLevel = 0;
    private boolean showInbounds = true;
    private boolean showOutbounds = true;
    private boolean showEmptyNodes = true;

    public Printer(PrintWriter out) {
        this(getDefaultStrategy(), out);
    }

    public Printer(TraversalStrategy strategy, PrintWriter out) {
        super(new SortedTraversalStrategy(strategy));

        this.out = out;
    }

    public String getIndentText() {
        return indentText;
    }

    public void setIndentText(String indentText) {
        this.indentText = indentText;
    }

    public boolean isShowInbounds() {
        return showInbounds;
    }

    public void setShowInbounds(boolean showInbounds) {
        this.showInbounds = showInbounds;
    }
    
    public boolean isShowOutbounds() {
        return showOutbounds;
    }

    public void setShowOutbounds(boolean showOutbounds) {
        this.showOutbounds = showOutbounds;
    }
    
    public boolean isShowEmptyNodes() {
        return showEmptyNodes;
    }

    public void setShowEmptyNodes(boolean showEmptyNodes) {
        this.showEmptyNodes = showEmptyNodes;
    }

    public void visitPackageNode(PackageNode node) {
        if (shouldShowPackageNode(node)) {
            super.visitPackageNode(node);
        }
    }

    public void visitClassNode(ClassNode node) {
        if (shouldShowClassNode(node)) {
            super.visitClassNode(node);
        }
    }

    public void visitFeatureNode(FeatureNode node) {
        if (shouldShowFeatureNode(node)) {
            super.visitFeatureNode(node);
        }
    }

    protected Printer append(boolean b) {
        out.print(b);
        return this;
    }

    protected Printer append(char c) {
        out.print(c);
        return this;
    }

    protected Printer append(char[] s) {
        out.print(s);
        return this;
    }

    protected Printer append(double d) {
        out.print(d);
        return this;
    }

    protected Printer append(float f) {
        out.print(f);
        return this;
    }

    protected Printer append(int i) {
        out.print(i);
        return this;
    }

    protected Printer append(long l) {
        out.print(l);
        return this;
    }

    protected Printer append(Object obj) {
        out.print(obj);
        return this;
    }

    protected Printer append(String s) {
        out.print(s);
        return this;
    }

    protected Printer indent() {
        append(getIndentText().repeat(indentLevel));
        return this;
    }

    protected Printer eol() {
        out.println();
        return this;
    }

    protected final Printer printScopeNodeName(Node node) {
        return printScopeNodeName(node, node.getName());
    }

    protected Printer printScopeNodeName(Node node, String name) {
        return printNodeName(node, name);
    }

    protected final Printer printDependencyNodeName(Node node) {
        return printDependencyNodeName(node, node.getName());
    }

    protected Printer printDependencyNodeName(Node node, String name) {
        return printNodeName(node, name);
    }

    protected Printer printNodeName(Node node, String name) {
        return append(name);
    }
    
    protected void raiseIndent() {
        indentLevel++;
    }

    protected void lowerIndent() {
        indentLevel--;
    }

    protected boolean shouldShowPackageNode(PackageNode node) {
        return shouldShowNode(node) || hasVisibleClasses(node);
    }

    protected boolean hasVisibleClasses(PackageNode node) {
        return node.getClasses().parallelStream().anyMatch(this::shouldShowClassNode);
    }

    protected boolean shouldShowClassNode(ClassNode node) {
        return shouldShowNode(node) || hasVisibleFeatures(node);
    }

    protected boolean hasVisibleFeatures(ClassNode node) {
        return node.getFeatures().parallelStream().anyMatch(this::shouldShowFeatureNode);
    }

    protected boolean shouldShowFeatureNode(FeatureNode node) {
        return shouldShowNode(node);
    }
    
    protected boolean shouldShowNode(Node node) {
        return isShowEmptyNodes() || (isShowOutbounds() && !node.getOutboundDependencies().isEmpty()) || (isShowInbounds() && !node.getInboundDependencies().isEmpty());
    }
}