package cz.cuni.amis.pogamut.udk.factory.guice.remoteagent;
   
   import com.google.inject.AbstractModule;
   import com.google.inject.name.Names;
   
   import cz.cuni.amis.pogamut.base.agent.IAgent;
   import cz.cuni.amis.pogamut.base.communication.messages.InfoMessage;
   import cz.cuni.amis.pogamut.base.communication.translator.IWorldMessageTranslator;
   import cz.cuni.amis.pogamut.base.communication.worldview.ILockableWorldView;
  import cz.cuni.amis.pogamut.base.communication.worldview.IWorldView;
  import cz.cuni.amis.pogamut.base.component.controller.ComponentDependencies;
  import cz.cuni.amis.pogamut.base.component.controller.ComponentDependencyType;
  import cz.cuni.amis.pogamut.base.factory.guice.GuiceAgentModule;
  import cz.cuni.amis.pogamut.base.factory.guice.GuiceRemoteAgentModule;
  import cz.cuni.amis.pogamut.base.utils.guice.AdaptableProvider;
  import cz.cuni.amis.pogamut.base3d.ILockableVisionWorldView;
  import cz.cuni.amis.pogamut.base3d.agent.IAgent3D;
  import cz.cuni.amis.pogamut.base3d.worldview.IVisionWorldView;
  import cz.cuni.amis.pogamut.udk.agent.params.UDKAgentParameters;
  import cz.cuni.amis.pogamut.udk.bot.IUDKBot;
  import cz.cuni.amis.pogamut.udk.bot.IUDKBotController;
  import cz.cuni.amis.pogamut.udk.bot.impl.UDKBot;
  import cz.cuni.amis.pogamut.udk.communication.translator.bot.BotFSM;
  import cz.cuni.amis.pogamut.udk.communication.worldview.UDKSyncLockableWorldView;
  
  /**
   * Module extending {@link UDKCommunicationModule} for the purpose of {@link UDKBot} instantiation.
   * <p><p>
   * Introduces {@link UDKBotModule#worldViewDependenciesProvider}.
   * <p><p>
   * Newly binded classes:
   * <table>
   * <tr><th>Mapped class</th>                    <th>  </th> <th>Target</th>                          <th>Description</th></tr>
   * 
   * <tr><td>{@link IWorldMessageTranslator}</td>	<td>-></td>	<td>{@link BotFSM}</td>					 <td>Protocol-validating translator of {@link InfoMessage}s of GameBots2004.</td></tr>
   * <tr><td>{@link IWorldView}</td>				<td>-></td> <td>{@link IVisionWorldView}</td>        <td>Binds world view as vision world view.</td></tr>
   * <tr><td>{@link IVisionWorldView}</td>		<td>-></td> <td>{@link ILockableVisionWorldView}</td><td>Binds vision world view as lockable one.</td></tr>
   * <tr><td>{@link ILockableWorldView}</td>		<td>-></td> <td>{@link ILockableVisionWorldView}</td><td>Binds lockable world view as vision world view.</td></tr>
   * <tr><td>{@link ILockableVisionWorldView}</td><td>-></td> <td>{@link UDKSyncLockableWorldView}</td> <td>Binds world view with concrete implementation.</td></tr>
   * <tr><td>{@link UDKSyncLockableWorldView} dependencies</td>
   *                                              <td>-></td> <td>{@link UDKBotModule#worldViewDependenciesProvider}</td></tr>
   * <tr><td>{@link IAgent}</td>                  <td>-></td> <td>{@link IAgent3D}</td>                <td></td></tr>
   * <tr><td>{@link IAgent3D}</td>                <td>-></td> <td>{@link IUDKBot}</td>            <td></td></tr>
   * <tr><td>{@link IUDKBot}</td>            <td>-></td> <td>{@link UDKBot}</td>               <td>Binds concrete implementation of the agent.</td></tr>
   * 
   * </table>
   * To have <b>successful module</b> the descendant <b>must specify</b> these <b>missing bindings</b>:
   * <table>
   * <tr><th>Mapped class</th>                    <th>Description</th></tr>
   * 
   * <tr><td>{@link IUDKBotController}</td>    <td>Controller of the bot.</td></tr>
   * </table>
   * ... plus all newly introduced dependencies (by various implementors of mentioned interfaces).<p>
   * ... <b>don't forget to call super.configureModules()</b> in the subclasses ;-)
   * 
   * @see UDKCommunicationModule
   * @see GuiceRemoteAgentModule
   * @see GuiceAgentModule
   * @author Jimmy
   */
  public class UDKBotModule<PARAMS extends UDKAgentParameters> extends UDKCommunicationModule<PARAMS> {
  
  	/**
  	 * Dependency provider for the world view, so the world view know when to start.
  	 */
  	protected AdaptableProvider<ComponentDependencies> worldViewDependenciesProvider = new AdaptableProvider<ComponentDependencies>(null);
  	
  	private Class<? extends IUDKBotController> botControllerClass;
  	
  	protected UDKBotModule() {
  	}
  	
  	public UDKBotModule(Class<? extends IUDKBotController> botControllerClass) {
  		this.botControllerClass = botControllerClass;
  	}
  
  	@Override
  	public void prepareNewAgent(PARAMS agentParameters) {
  		super.prepareNewAgent(agentParameters);
  		worldViewDependenciesProvider.set(new ComponentDependencies(ComponentDependencyType.STARTS_WITH).add(agentParameters.getAgentId()));
  	}
  	
  	@Override
  	protected void configureModules() {
  		super.configureModules();
  		addModule(new AbstractModule() {
  
  			@Override
  			public void configure() {
  				bind(IWorldMessageTranslator.class).to(BotFSM.class);
  				bind(IWorldView.class).to(IVisionWorldView.class);
  				bind(IVisionWorldView.class).to(ILockableVisionWorldView.class);
  				bind(ILockableWorldView.class).to(ILockableVisionWorldView.class);
  				bind(ILockableVisionWorldView.class).to(UDKSyncLockableWorldView.class);
  				bind(ComponentDependencies.class).annotatedWith(Names.named(UDKSyncLockableWorldView.WORLDVIEW_DEPENDENCY)).toProvider(worldViewDependenciesProvider);
  				bind(IAgent.class).to(IAgent3D.class);
  				bind(IAgent3D.class).to(IUDKBot.class);
  				bind(IUDKBot.class).to(UDKBot.class);
  				if (botControllerClass != null) {
 					bind(IUDKBotController.class).to(botControllerClass);
 				}
 			}
 			
 		});
 	}
 
 }