/*
  TEST-SCOPES.cpp  -  builds a test PlacementIndex containing dummy Placements as nested scopes
 
  Copyright (C)         Lumiera.org
    2009,               Hermann Vosseler <Ichthyostega@web.de>
 
  This program 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.
 
  This program 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 this program; if not, write to the Free Software
  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 
* *****************************************************/


#include "proc/mobject/session/test-scopes.hpp"
#include "proc/mobject/session/session-service-mock-index.hpp"
#include "proc/mobject/session/session-service-explore-scope.hpp"
#include "proc/mobject/session/scope-query.hpp"


namespace mobject {
namespace session {
namespace test    {
  
  
  namespace { // deleter function to clean up Test fixture
    void
    remove_testIndex (PlacementIndex* testIdx)
    {
      REQUIRE (testIdx);
      testIdx->clear();
      ASSERT (0 == testIdx->size());
      SessionServiceMockIndex::reset_PlacementIndex();  // restore default Index from Session
      
      delete testIdx;
    }
  }
  
  
  /** @note when this object goes out of scope, the activation of this
   *        test PlacementIndex will be cleared automatically, and the
   *        default Index within the session will be re-activated. 
   */
  PPIdx
  build_testScopes()
  {
    PDum p1(*new TestSubMO21);
    PDum p2(*new TestSubMO21);
    PDum p3(*new TestSubMO21);
    PDum p4(*new TestSubMO21);
    PDum p5(*new TestSubMO21);
    
    PDum ps1(*new DummyMO);
    PDum ps2(*new TestSubMO2);
    PDum ps3(*new TestSubMO1);
    
    // Prepare an (test)Index backing the PlacementRefs
    PPIdx index (PlacementIndex::create().get(), &remove_testIndex); // taking ownership
    SessionServiceMockIndex::reset_PlacementIndex(index);
    PMO& root = index->getRoot();

    index->insert (p1, root);
    index->insert (p2,  p1 );
    index->insert (p3,  p2 );
    index->insert (p4,  p3 );
    index->insert (p5,  p4 );
    
    index->insert (ps1,root);
    index->insert (ps2,root);
    index->insert (ps3, ps2);
    
    return index;
  }
  
  
  /** @note this test helper only works if build_testScopes is invoked
   *  beforehand, and the returned smart-ptr to the created test/dummy index
   *  is retained. Moreover, this function makes assumptions about the actual
   *  objects created by the former test function.
   *  @throw lumiera::error::Invalid if the intended start element doesn't exist (anymore)
   */
  PlacementMO&
  retrieve_startElm()
  {
    return *ContentsQuery<TestSubMO1>(SessionServiceExploreScope::getResolver()
                                     ,SessionServiceExploreScope::getScopeRoot());
  }
  
  
  ScopeQuery<MObject>::iterator
  explore_testScope (PlacementMO const& scopeTop)
  {
    return ScopeQuery<MObject>(SessionServiceExploreScope::getResolver(),
                               scopeTop, CHILDREN);
  }
  
  
}}} // namespace mobject::session::test