/*=========================================================================
                                                                                
  Program:   bbtk
  Module:    $RCSfile: bbtkConnection.cxx,v $
  Language:  C++
  Date:      $Date: 2008/04/09 11:16:57 $
  Version:   $Revision: 1.6 $
                                                                                
  Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
  l'Image). All rights reserved. See doc/license.txt or
  http://www.creatis.insa-lyon.fr/Public/bbtk/License.html for details.
                                                                                
     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notices for more information.
                                                                                
=========================================================================*/
/**
 *\file
 *\brief Class bbtk::Connection
 */

#include "bbtkConnection.h"
#include "bbtkFactory.h"
#include "bbtkBlackBox.h"
#include "bbtkMessageManager.h"

namespace bbtk
{
  
  //==================================================================
  /// Ctor with the black box from and to and their input and output.
/// Check the input and output compatibility
  Connection::Connection(BlackBox* from, const std::string& output,
			 BlackBox* to, const std::string& input ,
			 const Factory* f  )
    : mAdaptor(0),
      mFactory(f),
      mFromAny(false),
      mToAny(false)
  {
    bbtkDebugMessageInc("Kernel",7,"Connection::Connection(\""
			<<from->bbGetName()<<"\",\""<<output<<"\",\""
			<<to->bbGetName()<<"\",\""<<input<<"\")"
			<<std::endl);    

    mFrom = mOriginalFrom = from;
    mTo = mOriginalTo = to;
    mInput = mOriginalInput = input;
    mOutput = mOriginalOutput = output;
    

    if (! from->bbHasOutput(output) )
      {
	bbtkError("The box \""<<from->bbGetTypeName()<<
		  "\" has no output \""<<output<<"\"");
      }
    if (! to->bbHasInput(input) )
      {
	bbtkError("The box \""<<to->bbGetTypeName()<<
		  "\" has no input \""<<input<<"\"");
      } 

    if (to->bbGetInputConnectorMap().find(input)->second->IsConnected())
      {
	bbtkError("The input \""<<input<<"\" of the box \""<<to->bbGetName()
		  <<"\" is already connected");
      }
    
    //  std::string t1 ( from->bbGetOutputType(output).name() );
    //   std::string t2 ( to->bbGetInputType(input).name() );
    // if  //( t1 != t2 ) 
    if ( from->bbGetOutputType(output) !=
	 to->bbGetInputType(input) )
      {
	if ( from->bbGetOutputType(output) == typeid(Data) )
	  {
	    bbtkWarning("Connection '"
			<<GetFullName()
			<<"' : '"<<from->bbGetName()<<"."<<output
			<<"' is of type <"
			<<HumanTypeName<Data>()
			<<"> : type compatibility with '"
			<<to->bbGetName()<<"."<<input
			<<"' will be resolved at run time"
			);
	    mFromAny = true;
	  }
	else if (  to->bbGetInputType(input) == typeid(Data) )
	  {   
	    bbtkDebugMessage("Kernel",8," -> '"<<input<<"' type is "
			     <<TypeName<Data>()<<" : can receive any data"
			     <<std::endl);
	    mToAny = true;
	  }
	else 
	  {
	    //   std::cout << "Adaptive connection "<<std::endl;
	    std::string name;
	    name = from->bbGetName() + "." + output + "-" 
	      + to->bbGetName() + "." + input; 
	    mAdaptor = mFactory->NewAdaptor(from->bbGetOutputType(output),
				  to->bbGetInputType(input),
				  name);
	    if (!mAdaptor)  
	      {  
		bbtkError("did not find any <"
			  <<TypeName(from->bbGetOutputType(output))
			  <<"> to <"
			  <<TypeName(to->bbGetInputType(input))
			  <<"> adaptor");
	      } 
	  }
      }

     // 
    from->bbConnectOutput(output,this);
    to->bbConnectInput(input,this);
    
    bbtkDebugDecTab("Kernel",7);
  }

  //==================================================================
  
  void Connection::Clear()
  {
    mFrom = mOriginalFrom = 0;
    mTo = mOriginalTo = 0;
    mAdaptor = 0;
  }

  //==================================================================
  /// Dtor 
  Connection::~Connection()
  {
    bbtkDebugMessageInc("Kernel",7,
			"Connection::~Connection() ["
			<<GetFullName()<<"]"<<std::endl);
    std::cout << "~Connection() " << GetFullName() << std::endl;

    if (mFrom!=0) mFrom->bbDisconnectOutput(mOutput,this);
    if (mTo!=0) mTo->bbDisconnectInput(mInput,this);
    if (mAdaptor!=0) mAdaptor->bbDelete();

    bbtkDebugDecTab("Kernel",7);
  }
  //==================================================================
  
  //==================================================================
  /// Backward Update
  IOStatus Connection::BackwardUpdate()
  {
    bbtkDebugMessageInc("Process",2,
			"Connection::BackwardUpdate() ["
			<<GetFullName()<<"]"<<std::endl);

    IOStatus s = UPTODATE;
    s = mFrom->bbBackwardUpdate(this);

    TransferData();

    if (mAdaptor && (s==MODIFIED)) mAdaptor->bbSetModifiedStatus();

    bbtkDebugDecTab("Process",2);

    return s;
  }
  //==================================================================

  /*
  //==================================================================
  /// Forward Update
  void Connection::ForwardUpdate()
  {
    bbtkDebugMessageInc("Process",2,
			"Connection::ForwardUpdate() ["
			<<GetFullName()<<"]"<<std::endl);

  
    TransferData();

    mTo->bbForwardUpdate(this);

    bbtkDebugDecTab("Process",2);
  }
  //==================================================================
  */

  //==================================================================
  /// Transfers the data from the source output to the target input
  /// doing necessary conversions (adaptation or pointer cast)
  void Connection::TransferData()
  {
    bbtkDebugMessageInc("Process",3,
			"Connection::TransferData() ["
			<<GetFullName()<<"]"<<std::endl);
    
    
    // If an adaptor was created we need to adapt the data
    if (mAdaptor) 
      {
	mAdaptor->bbSetInput("In",mFrom->bbGetOutput(mOutput),false);
	mAdaptor->bbExecute();
	// LG : Connection Update does not set mTo as modified
	mTo->bbSetInput(mInput, mAdaptor->bbGetOutput("Out"),false);
	
      }
    // If no adaptor but source type is an any and target is not an any
    else if ( mFromAny && (! mToAny) )
      {
	bbtkDebugMessage("Data",3,
			 "Connection::TransferData() ["
			 <<GetFullName()<<"]"<<std::endl);
	bbtkDebugMessage("Data",3,
			 " * Source type is an "
			 <<HumanTypeName<Data>()
			 <<" which contains a <"
			 <<HumanTypeName(mFrom->bbGetOutput(mOutput).type())
			 <<">"<<std::endl);
	bbtkDebugMessage("Data",3,
			 " * Target type is <"
			 <<HumanTypeName(mTo->bbGetInputType(mInput))
			 <<">"<<std::endl);
	
	// 1) Test strict type matching between any content and target
	if (mFrom->bbGetOutput(mOutput)
	    .contains( mTo->bbGetInputType(mInput) ) )
	  {
	    bbtkDebugMessage("Data",3,
			     " -> Equal types : transfer ok"<<std::endl);
	    mTo->bbSetInput( mInput, 
			     mFrom->bbGetOutput(mOutput),
			     false);
	  }
	else 
	  {
	    // 2) Look for an adaptor
	    bbtk::BlackBox* adaptor = 0;
	    try 
	      {
		adaptor = mFactory->NewAdaptor(mFrom->bbGetOutput(mOutput).type(),
				     mTo->bbGetInputType(mInput),
				     "");
	      }
	    catch (...)
	      {
	      }
	    if (adaptor)  
	      {
		bbtkDebugMessage("Data",3," -> Adaptor found : using it"
				 <<std::endl);
		  adaptor->bbSetInput("In",mFrom->bbGetOutput(mOutput),false);
		adaptor->bbExecute();
		// LG : Connection Update does not set mTo as modified
		mTo->bbSetInput(mInput, adaptor->bbGetOutput("Out"),false);
		adaptor->bbDelete();
	      }
	    // 3) If no adaptor found but the any content is a pointer
	    //    and target type is also a pointer : we try run-time cast
	    else if ( (mFrom->bbGetOutput(mOutput).contains_pointer()) &&
		      (mTo->bbGetDescriptor()->GetInputDescriptor(mInput)
		       ->IsPointerType()) )
	      {
		bbtkDebugMessage("Data",3,
				 " -> No adaptor found but source and target types are both pointers : trying up or down cast"<<std::endl);
		
		void* nptr = 
		  mFrom->bbGetOutput(mOutput)
		  .get_pointer_to(mTo->bbGetInput(mInput).pointed_type());
		if (!nptr)  
		  {
		    bbtkError("Connection '"
			      <<GetFullName()
			      <<"' : <"
			      <<HumanTypeName(mFrom->bbGetOutput(mOutput).type())
			      <<"> to <"
			      <<HumanTypeName(mTo->bbGetInputType(mInput))
			      <<"> : no adaptor available and run-time up and down cast failed");
		  }
		mTo->bbBruteForceSetInputPointer(mInput, nptr, false);
	      }
	    // 4) Nothing worked : error
	    else 
	      {
		bbtkError("Connection '"<<GetFullName()<<"' "
			  <<"no adaptor found to convert <"
			  <<HumanTypeName(mFrom->bbGetOutput(mOutput).type())
			  <<"> to <"
			  <<HumanTypeName(mTo->bbGetInputType(mInput))<<">");
	      }
	  }
      }
    // EO : mFromAny && ! mToAny
    // Default case : types are the same; we use simple get-set
    else 
      {
	// LG : Connection Update does not set mTo as modified
	mTo->bbSetInput(mInput, mFrom->bbGetOutput(mOutput),false);
      }

    bbtkDebugDecTab("Process",3);
  }
  //==================================================================
  
  //==================================================================
  /// Modified
  void Connection::SetModifiedStatus()
  {
    bbtkDebugMessageInc("Process",5,
			"Connection::SetModifiedStatus() ["
			<<GetFullName()<<"]"<<std::endl);
    
    if (mAdaptor) mAdaptor->bbSetModifiedStatus();
    
    mTo->bbSetModifiedStatus(  mTo->bbGetInputConnectorMap().find(mInput)->second );
    
    bbtkDebugDecTab("Process",5);
  }
  //==================================================================

  
  //==================================================================
  std::string Connection::GetFullName() const {
    if (mFrom && mTo) 
      {
	std::string res = mFrom->bbGetName()+"."+mOutput+"--"
	  +mTo->bbGetName()+"."+mInput;
	if ((mFrom!=mOriginalFrom)||(mTo!=mOriginalTo))
	  {
	    res += "("+mOriginalFrom->bbGetName()+"."+mOriginalOutput+"--"
	      + mOriginalTo->bbGetName()+"."+mOriginalInput+")";
	  }
	return res;
      }
    return "***Invalid Connection***";
  }
  //==================================================================

  //==================================================================
  void Connection::Check() const
  {
    bbtkMessage("Debug",1,"** Checking Connection "<<(void*)this<<" ["<<GetFullName()<<"]"
		<<std::endl);
    if (mFrom==0) 
      {
	bbtkMessage("Debug",2," - From = 0"<<std::endl);
      }
    else
      {
	bbtkMessage("Debug",2," - From : "<<mFrom->bbGetFullName()<<std::endl);
	if (!mFrom->bbHasOutput(mOutput))
	  {
	    bbtkError(mFrom->bbGetFullName()<<" does not have output '"
		      <<mOutput<<"'");
	  }	
	bbtkMessage("Debug",2," - From : Output '"<<mOutput<<"' exists"<<std::endl);
	BlackBox::OutputConnectorMapType::const_iterator i 
	  = mFrom->bbGetOutputConnectorMap().find(mOutput);
	if (i== mFrom->bbGetOutputConnectorMap().end())
	  {
	     bbtkError(mFrom->bbGetFullName()<<" output '"
		       <<mOutput<<"' is not in OutputConnectorMap");
	  }
	bbtkMessage("Debug",2," - From : Output '"<<mOutput
		    <<"' is in OutputConnectorMap"<<std::endl);

        std::vector< Connection * >::const_iterator j;
	j = find(i->second->GetConnectionVector().begin(),
		 i->second->GetConnectionVector().end(),
		 this);
	if (j==i->second->GetConnectionVector().end())
	  {
	    bbtkError("Connection ["<<GetFullName()<<"] : "
		      <<" OutputConnector '"
		      <<mOutput<<"' of "<<mFrom->bbGetFullName()
		      <<" does not point to this connection");
	    
	  }
	bbtkMessage("Debug",2," - From : This connection is in OutputConnector connection vector"<<std::endl);
	bbtkMessage("Debug",1," * Box from : Check successfull"<<std::endl);

      }

    if (mTo==0) 
      {
	bbtkMessage("Debug",2," - To   = 0"<<std::endl);
      }
    else
      {
	bbtkMessage("Debug",2," - To   : "<<mTo->bbGetName()<<std::endl);
	std::cout << mTo << std::endl;
	std::cout << mTo->bbGetDescriptor() << std::endl;
	std::cout << mTo->bbGetDescriptor()->GetTypeName() << std::endl;
	mTo->bbGetFullName();
	bbtkMessage("Debug",2," - To   : "<<mTo->bbGetFullName()<<std::endl);
	if (!mTo->bbHasInput(mInput))
	  {
	    bbtkError(mTo->bbGetFullName()<<" does not have input '"
		      <<mInput<<"'");
	  }	
	bbtkMessage("Debug",2," - To   : Input '"<<mInput<<"' exists"<<std::endl);
	BlackBox::InputConnectorMapType::const_iterator i 
	  = mTo->bbGetInputConnectorMap().find(mInput);
	if (i== mTo->bbGetInputConnectorMap().end())
	  {
	     bbtkError(mTo->bbGetFullName()<<" input '"
		       <<mInput<<"' is not in InputConnectorMap");
	  }
	bbtkMessage("Debug",2," - To   : Input '"<<mInput
		    <<"' is in InputConnectorMap"<<std::endl);

	if (i->second->GetConnection()==0)
	  {
	    bbtkError("Connection "<<GetFullName()<<" : "
		      <<" InputConnector '"
		      <<mInput<<"' of "<<mTo->bbGetFullName()
		      <<" does not point to this connection");
    
	  }
	bbtkMessage("Debug",2," - To   : This connection is in InputConnector connection vector"<<std::endl);
	bbtkMessage("Debug",1," * Box to   : Check successfull"<<std::endl);

      }
  }
  //==================================================================

}// namespace bbtk