////////////////////////////////////////////////////////////////////////////////
   // MillScript: an Open Spice interpreter and batch website creation tool
   // Copyright (C) 2001-2004 Open World Ltd
   // Copyright (C) 2005 Kevin Rogers
   //
   // This file is part of MillScript.
   //
   // MillScript 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.
  //
  // MillScript 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
  // MillScript; if not, write to the Free Software Foundation, Inc., 59 Temple
  // Place, Suite 330, Boston, MA  02111-1307  USA
  ////////////////////////////////////////////////////////////////////////////////
  package org.millscript.millscript;
  
  import org.millscript.commons.alert.Alert;
  import org.millscript.commons.util.Maplet;
  import org.millscript.millscript.expr.ApplyExpr;
  import org.millscript.millscript.expr.NameExpr;
  import org.millscript.millscript.expr.SkipExpr;
  import org.millscript.millscript.vm.CompilerState;
  import org.millscript.millscript.vm.Package;
  
  import junit.framework.Test;
  import junit.framework.TestSuite;
  
  /**
   * Unit test for Millscript for loops.
   *
   * @author  <a href="mailto:moya@users.sourceforge.net">Kevin Rogers</a>
   */
  public class ForLoopTest extends AbstractTestCase {
  
      /**
       * bug53 Package.
       */
      private Package forloopPackage;
  
      /**
       * Create the test case
       *
       * @param   testName    name of the test case
       */
      public ForLoopTest( String testName ) {
          super( testName );
      }
  
      /**
       * @return  the suite of tests being tested
       */
      public static Test suite() {
        return new TestSuite( ForLoopTest.class );
      }
  
      /**
       * Initialize the test fixture. In this instance we require a machine with a
       * standard environment, from which we get the "bug53" and "bug53a" package
       * environments(i.e. we import it). We can then proceed with testing that
       * NameExpr, or at least NameExpr.shareIdent, works properly.
       */
      @Override
      public void setUp() {
  
          super.setUp();
  
          // We want to load packages from here..
          engine.addInventory( getResource( "test/millscript" ) );
  
          // Try to import the test packages
          forloopPackage = engine.getPackage( "forloop" );
  
          // Check the test packages were imported
          assertNotNull( forloopPackage );
  
      }
  
      /**
       * Clean up the test fixture by reseting the millscript machine.
       */
      @Override
      public void tearDown() {
          engine.getMachine().reset();
      }
  
      /**
       * Checks for the <tt>&lt;name&gt; from &lt;expr&gt;</tt> binding. We cannot
       * thoroughly test this binding independantly, as alone it specifies an
       * infinite loop.
       */
      public void testBindingFrom() {
  
         try {
             CompilerState state = forloopPackage.getCompilerState();
 
             state.compileExpr(
                 new ApplyExpr(
                     new NameExpr( "bindingFrom1" ),
                     new SkipExpr()
                 )
             );
 
         } catch ( Alert ex ) {
             // We're expecting to get this exception, as within MillScript the
             // only way to exit an infinite loop is by calling the mishap
             // function at the appropriate moment.
         }
 
     }
 
     /**
      * Checks for the <tt>&lt;name&gt; from &lt;expr&gt; to &lt;expr&gt;</tt>
      * binding.
      */
     public void testBindingFromTo() {
 
         CompilerState state = forloopPackage.getCompilerState();
 
         Object result = state.compileExprToValue(
             new ApplyExpr(
                 new NameExpr( "bindingFromTo1" ),
                 new SkipExpr()
             )
         );
 
         // The sum of all integers from 1 to n is ( n * ( n + 1 ) ) / 2
         assertEquals( new Integer( 500500 ), result );
 
 
         result = state.compileExprToValue(
             new ApplyExpr(
                 new NameExpr( "bindingFromTo2" ),
                 new SkipExpr()
             )
         );
 
         assertTrue( result instanceof Maplet );
 
         Maplet testResult = (Maplet)result;
 
         assertEquals( new Integer( 1000 ), testResult.getValue() );
         assertEquals( new Integer( 1000 ), testResult.getKey() );
 
     }
 
     /**
      * Checks for the <tt>&lt;name&gt; in &lt;expr&gt;</tt> binding.
      */
     public void testBindingInList() {
 
         CompilerState state = forloopPackage.getCompilerState();
 
         Object result = state.compileExprToValue(
             new ApplyExpr(
                 new NameExpr( "bindingInList1" ),
                 new SkipExpr()
             )
         );
 
         // The sum of all integers from 1 to n is ( n * ( n + 1 ) ) / 2
         assertEquals( new Integer( 55 ), result );
 
 
         result = state.compileExprToValue(
             new ApplyExpr(
                 new NameExpr( "bindingInList2" ),
                 new SkipExpr()
             )
         );
 
         assertTrue( result instanceof Maplet );
 
         Maplet testResult = (Maplet)result;
 
         assertEquals( new Integer( 10 ), testResult.getValue() );
         assertEquals( new Integer( 10 ), testResult.getKey() );
 
 
         // As long as this doesn't generate an exception everything should be
         // ok.
         state.compileExpr(
             new ApplyExpr(
                 new NameExpr( "bindingInList3" ),
                 new SkipExpr()
             )
         );
 
 
         // As long as this doesn't generate an exception everything should be
         // ok.
         state.compileExpr(
             new ApplyExpr(
                 new NameExpr( "bindingInList4" ),
                 new SkipExpr()
             )
         );
 
     }
 
     /**
      * Checks for the <tt>&lt;name&gt; &#38; &lt;name&gt; in &lt;expr&gt;</tt>
      * binding.
      */
     public void testBindingInMap() {
 
         CompilerState state = forloopPackage.getCompilerState();
 
         Object result = state.compileExprToValue(
             new ApplyExpr(
                 new NameExpr( "bindingInMap1" ),
                 new SkipExpr()
             )
         );
 
         // The sum of all integers from 1 to n is ( n * ( n + 1 ) ) / 2
         assertEquals( new Integer( 55 ), result );
 
 
         // As long as this doesn't generate an exception everything should be
         // ok.
         state.compileExpr(
             new ApplyExpr(
                 new NameExpr( "bindingInMap2" ),
                 new SkipExpr()
             )
         );
 
 
         // As long as this doesn't generate an exception everything should be
         // ok.
         state.compileExpr(
             new ApplyExpr(
                 new NameExpr( "bindingInMap3" ),
                 new SkipExpr()
             )
         );
 
     }
 
     /**
      * Checks for the <tt>where &lt;expr&gt;</tt> condition.
      */
     public void testConditionWhere() {
 
         CompilerState state = forloopPackage.getCompilerState();
 
         Object result = state.compileExprToValue(
             new ApplyExpr(
                 new NameExpr( "conditionWhere1" ),
                 new SkipExpr()
             )
         );
 
         assertTrue( result instanceof Maplet );
 
         Maplet testResult = (Maplet)result;
 
         assertEquals( new Integer( 15 ), testResult.getValue() );
         assertEquals( new Integer( 25 ), testResult.getKey() );
 
     }
 
     /**
      * Checks for the <tt>while &lt;expr&gt; else &lt;expr&gt;</tt> and
      * <tt>until &lt;expr&gt; then &lt;expr&gt;</tt> conditions.
      */
     public void testConditionWhile() {
 
         CompilerState state = forloopPackage.getCompilerState();
 
         Object result = state.compileExprToValue(
             new ApplyExpr(
                 new NameExpr( "conditionWhile1" ),
                 new SkipExpr()
             )
         );
 
         assertEquals( new Integer( 6 ), result );
 
         result = state.compileExprToValue(
             new ApplyExpr(
                 new NameExpr( "conditionUntil1" ),
                 new SkipExpr()
             )
         );
 
         assertEquals( new Integer( 7 ), result );
 
     }
 
     /**
      * Checks for the for loop body.
      */
     public void testBody() {
     }
 
     /**
      * Checks for the for loop finally statement.
      */
     public void testFinally() {
 
         CompilerState state = forloopPackage.getCompilerState();
 
         Object result = state.compileExprToValue(
             new ApplyExpr(
                 new NameExpr( "finally1" ),
                 new SkipExpr()
             )
         );
 
         assertEquals( "success", result );
 
     }
 
 }