tests/org.eclipse.rap.rwt.test/src/org/eclipse/swt/RWTFixture.java

/*******************************************************************************
 * Copyright (c) 2002-2006 Innoopract Informationssysteme GmbH.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 * 
 * Contributors:
 *     Innoopract Informationssysteme GmbH - initial API and implementation
 ******************************************************************************/

package org.eclipse.swt;

import java.io.*;
import java.net.URL;
import java.util.Enumeration;
import javax.servlet.http.HttpSession;
import org.eclipse.swt.graphics.Image;
import org.eclipse.swt.internal.engine.PhaseListenerRegistry;
import org.eclipse.swt.internal.lifecycle.*;
import org.eclipse.swt.internal.widgets.WidgetAdapter;
import org.eclipse.swt.internal.widgets.WidgetAdapterFactory;
import org.eclipse.swt.lifecycle.*;
import org.eclipse.swt.resources.IResourceManagerFactory;
import org.eclipse.swt.resources.ResourceManager;
import org.eclipse.swt.widgets.Display;
import org.eclipse.swt.widgets.Widget;
import com.w4t.*;
import com.w4t.Fixture.TestRequest;
import com.w4t.Fixture.TestResponse;
import com.w4t.engine.lifecycle.*;
import com.w4t.engine.service.*;
import com.w4t.util.browser.Ie6;


public final class RWTFixture {
  
  public static final class TestResourceManagerFactory
    implements IResourceManagerFactory
  {
    public IResourceManager create() {
      return new TestResourceManager();
    }
  }

  public final static class TestResourceManager implements IResourceManager {

    private ClassLoader loader = Thread.currentThread().getContextClassLoader();
    
    public String getCharset( final String name ) {
      return null;
    }

    public ClassLoader getContextLoader() {
      return loader;
    }

    public String getLocation( final String name ) {
      return null;
    }

    public URL getResource( final String name ) {
      URL result = null;
      if( loader != null ) {
        result = loader.getResource( name );
      }
      return result;
    }

    public InputStream getResourceAsStream( final String name ) {
      InputStream result = null;
      if( loader != null ) {
        result = loader.getResourceAsStream( name );
      }
      return result;
    }

    public Enumeration getResources( final String name ) throws IOException {
      Enumeration result = null;
      if( loader != null ) {
        result = loader.getResources( name );
      }
      return result;
    }

    public boolean isRegistered( final String name ) {
      return false;
    }

    public void register( final String name ) {
    }

    public void register( final String name, final InputStream is ) {
    }

    public void register( final String name, final String charset ) {
    }

    public void register( final String name, 
                          final String charset, 
                          final RegisterOptions options )
    {
    }

    public void setContextLoader( final ClassLoader contextLoader ) {
      loader = contextLoader;
    }

  }

  public static class TestEntryPoint implements IEntryPoint {
    public Display createUI() {
      return new Display();
    }
  }

  // 3 images from org.eclipse.rap.w4t.test-project
  public static final String IMAGE1 
    = "resources/images/generated/82f7c683860a85c182.gif";
  public static final String IMAGE2 
    = "resources/images/generated/a2fb9a01c602ae.gif";
  public static final String IMAGE3 
    = "resources/images/generated/dff8c3a4e2b4c79080.gif";
  
  public static final String IMAGE_100x50 
    = "resources/images/test-100x50.png";
  public static final String IMAGE_50x100 
    = "resources/images/test-50x100.png";

  private static LifeCycleAdapterFactory lifeCycleAdapterFactory;
  private static WidgetAdapterFactory widgetAdapterFactory;
  private static PhaseListener currentPhaseListener 
    = new CurrentPhase.Listener();

  private RWTFixture() {
    // prevent instantiation
  }
  
  public static void setUp() {
    // standard setup
    Fixture.setUp();
    
    registerAdapterFactories();
    PhaseListenerRegistry.add( currentPhaseListener );
    
    // registration of mockup resource manager
    registerResourceManager();
  }
  
  public static void setUpWithoutResourceManager() {
    // standard setup
    Fixture.setUp();
    
    // registration of adapter factories
    registerAdapterFactories();
  }

  public static void tearDown() {
    // deregistration of mockup resource manager
    deregisterResourceManager();
    
    // deregistration of adapter factories
    deregisterAdapterFactories();
    
    // standard teardown
    Fixture.tearDown();
  }

  public static void registerAdapterFactories() {
    AdapterManager manager = W4TContext.getAdapterManager();
    lifeCycleAdapterFactory = new LifeCycleAdapterFactory();
    manager.registerAdapters( lifeCycleAdapterFactory, Display.class );
    manager.registerAdapters( lifeCycleAdapterFactory, Widget.class );
    widgetAdapterFactory = new WidgetAdapterFactory();
    manager.registerAdapters( widgetAdapterFactory, Display.class );
    manager.registerAdapters( widgetAdapterFactory, Widget.class );
  }
  
  public static void deregisterAdapterFactories() {
    AdapterManager manager = W4TContext.getAdapterManager();
    manager.deregisterAdapters( widgetAdapterFactory, Display.class );
    manager.deregisterAdapters( widgetAdapterFactory, Widget.class );
    manager.deregisterAdapters( lifeCycleAdapterFactory, Display.class );
    manager.deregisterAdapters( lifeCycleAdapterFactory, Widget.class );
  }

  public static void registerResourceManager() {
    ResourceManager.register( new TestResourceManagerFactory() );
    Image.clear();
  }
  
  public static void deregisterResourceManager() {
    Fixture.setPrivateField( ResourceManager.class, null, "_instance", null );
    Fixture.setPrivateField( ResourceManager.class, null, "factory", null );
  }
  
  public static void preserveWidgets() {
    PreserveWidgetsPhaseListener listener = new PreserveWidgetsPhaseListener();
    PhaseEvent event = new PhaseEvent( new RWTLifeCycle(), PhaseId.READ_DATA );
    listener.afterPhase( event );
  }

  public static void clearPreserved() {
    PreserveWidgetsPhaseListener listener = new PreserveWidgetsPhaseListener();
    PhaseEvent event = new PhaseEvent( new RWTLifeCycle(), PhaseId.RENDER );
    listener.afterPhase( event );
  }
  
  public static void markInitialized( final Widget widget ) {
    Object adapter = widget.getAdapter( IWidgetAdapter.class );
    WidgetAdapter widgetAdapter = ( WidgetAdapter )adapter;
    widgetAdapter.setInitialized( true );
  }
  
  public static void markInitialized( final Display display ) {
    Object adapter = display.getAdapter( IWidgetAdapter.class );
    WidgetAdapter widgetAdapter = ( WidgetAdapter )adapter;
    widgetAdapter.setInitialized( true );
  }

  public static void fakeNewRequest() {
    HttpSession session = ContextProvider.getSession();
    TestRequest request = new TestRequest();
    request.setSession( session );
    TestResponse response = new TestResponse();
    ServiceContext serviceContext = new ServiceContext( request, response );
    serviceContext.setStateInfo( new ServiceStateInfo() );
    ContextProvider.disposeContext();
    ContextProvider.setContext( serviceContext );
    Fixture.fakeResponseWriter();
    Fixture.fakeBrowser( new Ie6( true, true ) );
  }
  
  public static void fakePhase( final PhaseId phase ) {
    IServiceStateInfo stateInfo = ContextProvider.getStateInfo();
    stateInfo.setAttribute( CurrentPhase.class.getName() + "#value", 
                            phase );
  }
  
  public static void readDataAndProcessAction( final Widget widget ) {
    AbstractWidgetLCA widgetLCA = WidgetUtil.getLCA( widget );
    RWTFixture.fakePhase( PhaseId.READ_DATA );
    widgetLCA.readData( widget );
    RWTFixture.fakePhase( PhaseId.PROCESS_ACTION );
    Display display = widget.getDisplay();
    IDisplayLifeCycleAdapter displayLCA = DisplayUtil.getLCA( display ); 
    displayLCA.processAction( display );
  }
  
  public static void readDataAndProcessAction( final Display display ) {
    IDisplayLifeCycleAdapter displayLCA = DisplayUtil.getLCA( display );
    RWTFixture.fakePhase( PhaseId.READ_DATA );
    displayLCA.readData( display );
    preserveWidgets();
    RWTFixture.fakePhase( PhaseId.PROCESS_ACTION );
    displayLCA.processAction( display );
    
  }
  
  
  /**
   *  Simple program that prints the constant definitions of the SWT
   *  class which can be used for updates of the SWT class. Not very
   *  sophisticated, but it works for the moment...
   */
  public static void main( final String[] arx ) throws IOException {
    String rwtDir = System.getProperty( "user.dir" ).replaceAll( ".test", "" );
    String path = SWT.class.getName().replace( '.', '/' );
    String src = rwtDir + "/src/" + path + ".java";
    BufferedReader reader = new BufferedReader( new FileReader( src ) );
    String line = reader.readLine();
    while( line != null ) {
      if( line.startsWith( "  public static final " ) ) {
        System.out.println( line );
      }
      line = reader.readLine();
    }
  }

}