/*

     This file is part of Combean.

     Combean is free software; you can redistribute it and/or modify

     it under the terms of the GNU General Public License as published by

     the Free Software Foundation; either version 2 of the License, or

     (at your option) any later version.

     Combean is distributed in the hope that it will be useful,

     but WITHOUT ANY WARRANTY; without even the implied warranty of

     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

     GNU General Public License for more details.

     You should have received a copy of the GNU General Public License

     along with Combean; if not, write to the Free Software

     Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA

 */

 /*

  * Created on 20.02.2005

  *

  */

 package net.sourceforge.combean.test.graph.alg.traversal;

 import junit.framework.TestCase;

 import net.sourceforge.combean.graph.NumberNode;

 import net.sourceforge.combean.graph.alg.traversal.DFSNodeStackVisitor;

 import net.sourceforge.combean.graph.alg.traversal.RecursiveDFSImpl;

 import net.sourceforge.combean.interfaces.graph.Graph;

 import net.sourceforge.combean.interfaces.graph.Node;

 import net.sourceforge.combean.interfaces.graph.alg.traverse.DepthFirstSearch;

 import net.sourceforge.combean.interfaces.graph.containers.NodeStack;

 import net.sourceforge.combean.samples.simplegraphs.DirectedCircle;

 /**

  * @author schickin

  *

  */

 public class TestDFSNodeStackVisitor extends TestCase {

     private DFSNodeStackVisitor stackVis = null;

     private DepthFirstSearch dfsAlg = null;

     private static final int CIRCLESIZE = 5;

     private Graph circle = null;

     private class DFSNodeStackVisitorWithPrematureEnd

     extends DFSNodeStackVisitor {

         private int maxIter = 0;

         private int iterCount = 0;

         /**

          * constructor 

          */

         public DFSNodeStackVisitorWithPrematureEnd(int maxIter) {

             super();

             this.maxIter = maxIter;

             this.iterCount = 0;

         }

         /* (non-Javadoc)

          * @see net.sourceforge.combean.interfaces.graph.alg.traverse.TraversalVisitor#visitNode(net.sourceforge.combean.interfaces.graph.Node)

          */

         public void visitNode(Node v) {

              super.visitNode(v);

              this.iterCount++;

         }

         /* (non-Javadoc)

          * @see net.sourceforge.combean.interfaces.graph.alg.traverse.TraversalVisitor#readyToTerminate()

          */

         public boolean readyToTerminate() {

              return this.iterCount == this.maxIter;

         }

     }

     public static void main(String[] args) {

         junit.textui.TestRunner.run(TestDFSNodeStackVisitor.class);

     }

     /*

      * @see TestCase#setUp()

      */

     protected void setUp() throws Exception {

         super.setUp();

         this.circle = new DirectedCircle(CIRCLESIZE);

         this.dfsAlg = new RecursiveDFSImpl();

         this.dfsAlg.setGraph(this.circle);

    }

     /*

      * @see TestCase#tearDown()

      */

     protected void tearDown() throws Exception {

         super.tearDown();

     }

     /**

      * Constructor for TestDFSNodeStackVisitor.

      * @param name

      */

     public TestDFSNodeStackVisitor(String name) {

         super(name);

     }

     public final void testStackVisitorOnCircleGraph() {

         this.stackVis = new DFSNodeStackVisitorWithPrematureEnd(CIRCLESIZE-1);

         this.dfsAlg.setVisitor(this.stackVis);

         this.dfsAlg.setLocalStartNode(new NumberNode(0));

         this.dfsAlg.run();

         NodeStack S = this.stackVis.getStack();

         int nodeCount = CIRCLESIZE-1;

         while (!S.isEmpty()) {

             NumberNode v = (NumberNode) S.pop();

             assertEquals("nodes shall be renumbered in reverse order by stack",

                     nodeCount--, v.getNodeNum());

         }

         assertEquals("the stack shall contain all nodes up to node 0",

                 -1, nodeCount);

     }

 }